How to Install CorpusSearch

• First steps:
  1. Download the latest version of "CS.jar" from this site.
  2. Put the file in a convenient place; for example, the "Applications" folder under Mac OS X or the "Program Files" folder under Windows.
  3. If you are using Windows, we recommend downloading a copy of the Java Virtual Machine from Sun (version 1.4 or later) rather than running Microsoft's Java. Here's how to check which virtual machine you are running under Windows XP:
     1. Search for the Command Prompt by clicking on the "Run" icon on the Start menu.
     2. Type "cmd" into the dialog box that comes up.
     3. Type "C:\Documents and Settings\username>java -version" in the Command Prompt dialog box that comes up.
     The web address of the Sun java site is:

          http://www.java.com/

• Unix/Linux users (including Mac OS X):
  We assume that you have put "CS.jar" into the top-level directory (folder) "FOO".
  1. Open a window that allows you run commands - the Terminal program under Mac OS X, an xterm window under Unix or Linux. Adjust the path in the example to fit the location you are using for the program.
  2. Type the following line (minus the prompt "%") at the prompt in the terminal window:

     % java  -classpath  /FOO/CS.jar  csearch/CorpusSearch

     The classpath must give the full path to the jar file, using appropriate syntax.

  3. Once you are sure that the program runs, you can put an alias to the above command into your shell initialization file (usually, .cshrc for the tshell or .bashrc for the bash shell). For example, the following line will create such an alias in a .cshrc file:

     alias CS 'java  -classpath  /FOO/CS.jar  csearch/CorpusSearch'

• Windows users:
  We assume that you have put "CS.jar" into the "Program Files" folder.
  1. Launch the Command Prompt via Start -> Run and type "cmd" in the box ("command" under Windows 98).
  2. Type in the following command (without the quotes) into the Command Prompt dialog box: "cd C:\>"
  3. Type the following line (without the prompt itself) at the resulting prompt:

     C:\>  java  -classpath  "C:\Program Files\CS.jar"  csearch/CorpusSearch

     Note that the direction of the slashes is different in the two arguments after "-classpath". Also note the quotation marks around the directory path.

How to run CorpusSearch

CorpusSearch runs when invoked in a terminal window or cmd box as indicated above. If it is invoked without arguments, it will prompt the user to give a command file name and a source file name. These files can also be specified as arguments of the program on the command line. For example, if the command file is "foo.q" and the source (data) file is "bar.psd," then the following command will execute a search:

%CS foo.q bar.psd

The results of the search will be placed in a file called "foo.out." The name can be changed by adding a third argument on the command line, prefaced by "-o," as in:

%CS foo.q bar.psd -o goo.out

We are assuming here that "CS" has been defined as an alias for CorpusSearch as indicated above.

For details on what command files and source files may and must contain and what result files look like, see the body of this manual.