Installation Instructions
Thank you for downloading the LexCheck APIs PackageJava, UTF-8. This package includes one compressed file -- lexCheck${YEAR}.tgz
Download the lexCheck${YEAR}.tgz file from LexCheck web site
Uncompress and unarchive this file into the location where you intend to have it installed. On a Unix machine, this would look like:
> gtar -xzvf lexCheck${YEAR}.tgz
If you are on a windows platform, pkzip and winzip may be used to uncompress and unarchive this file. Please make sure the file you download has the right extension (tgz) before you unzip it. Winzip looks into the file to check if there is tar file within it, and it asks if it should create a temporary file with the tar file in it. The proper response is to allow this to happen. Once the temporary file has been created, winzip reads it and displays the archive as it would any other zip'ed file. Unzip the resulting contents to the location you want to install to. Make sure that you preserve the directory structures when unarchiving.
Once the files are in place, change directories to the top level. This should be lexCheck${YEAR}. If you are on a windows platform, this will involve opening up a DOS command window, and changing directories to where you have put these files. We will henceforth refer to this top level directory as the ${LC_DIR} directory.
From the ${LC_DIR}, invoke the appropriate installation command. These are installation scripts appropriate to the platforms we know about:
| Platforms | Installation Scripts |
| Linux | ./install_linux.sh |
| Windows | .\install_win.bat |
The scripts shown above will proceed:
If the installation was successful, there will be a congratulation message that finishes off this process.
If the installation is not successful, there will be a message indicating so. Please refer to the ${LC_DIR}/logs/ directory for a complete transcript of the process. It is likely that there were error messages indicating the source of the failure.
After a successful installation
The lexCheck tools are now ready to be used. They can be found in the ${LC_DIR}/bin/ directory. On the Linux platforms, they include the following shell scripts:
On the Windows platform, they include the following batch files:
Each may be used from any location on the machine. If you put the ${LC_DIR} bin path in your $PATH environment variable they do not have to be referenced with the whole path.
Altering your environment to use the lexCheck tools, once they have been installed
You may invoke these tools from a command line. These tools are found in the __LC_DIR__/bin directory. You can add this __LC_DIR__/bin path to your $PATH environment variable. This would enable you to find and run these tools from any location.
In Linux, this would be done by adding this path to your ~/.cshrc or ~/.profile startup script.
In Windows, this would be done by appending this path to the PATH variable from the "control panel\System\Advanced\Environment variable\Edit" menus.