Using the Tutorial

The tutorial is designed to be read sequentially. Later chapters and sections assume that you are familiar with the preceding material, and earlier exercises create files and database entities that are used by later exercises. If you plan to work through the tutorial exercises, make sure that you create the ProxWebKB database (see Exercise 3.1) used in most of the remaining tutorial exercises. We suggest that you work through the chapters in order. To get the most benefit from the tutorial, complete the exercises using your local installation of Proximity.

The examples in this chapter demonstrate how to use Proximity for both Linux/Mac OS X and Windows systems. The rest of the Tutorial provides only the Linux/Mac OS X commands. In most cases, the only differences are using a .bat file instead of .sh file for Proximity applications, substituting appropriate paths to files, and using the appropriate syntax for the operating system. Windows users should refer back to this chapter if they have questions about specific Proximity applications and commands.

Tutorial conventions

This tutorial uses the following typographic conventions:

Constant width, bold

Text you type on the command line or in the Proximity Database Browser

Constant width, italics

Text you replace with the appropriate value

Constant width

Output from the application or code fragments

Code fragments, application output, and text you type on the command line are usually shown with a gray background. In some cases, the tutorial may include additional line breaks not present in actual application output so that the output fits within a standard page width.

The tutorial uses UNIX-style paths as a generic path syntax. You may need to make appropriate syntax substitutions if you are running Proximity on a Windows platform. Windows-specific examples are included only when users must enter different information or perform different actions to use Proximity on Windows platforms. Long command lines use continuation characters (\) to indicate that the following line is part of the same command. Enter such text on a single line, without the continuation character.