Tools Overview

SemanticHacker Tools


Overview

We have provided some simple tools that serve as a demonstration on how you can access the API and use the resulting signature. Written in the Java programming language, these tools illustrate the following operations:

The sample tools as well as dependent libraries can be obtained from the tools download page.

Usage

The SemanticHacker Tools are contained within a executable JAR file. Help for how to run a specific tool contained within the JAR file can be found be running the following command.

	$ java -jar sh-tools.jar 

Usage: java -jar sh-tools.jar TOOL [OPTION]...  

Run an example tool.

Available tools:
        signature       Get a signature from the API
        similarity      Compute the similarity of two Semantic Signatures
--help, -h, or /? or no arguments will display this help.

Version: 1.1
This software is licensed under the GPL version 2 or later.
A copy of the GPL is included in the COPYING file inside this jar.
Homepage: http://www.semantichacker.com

Some Conventions Used

  • All provided tools recognize both long (--word) and short (-w) options.
  • Help can be accessed by specifying no parameters, -h or --help.
  • Anywhere that a file can be specified, - can be specified to mean stdin.
  • The first argument that consists solely of -- turns off argument parsing, this allows file names to be passed to the similarity and category tools. However, a file name that is part of an argument cannot be passed this way.
  • Long parameters which take arguments (such as --labels FILE) can also be passed using an equals sign (e.g. --labels=FILE).
$

 Semantic Signature is a registered trademark - © 2010 TextWise, LLC. All rights reserved. Privacy Policy