Linux Installation Instructions
Thank you for downloading the CSpell Java. This package includes one compressed file -- cSpell2018.tgz.
Download the cSpell2018.tgz file from
CSpell web site.
Uncompress and unarchive this file into the location where
you intend to have it installed. On a Linux machine, this would look like:
shell> gtar -xzvf cSpell2018.tgz
Once the files are in place, change directories to the top - ${CSPELL_DIR}
From the ${CSPELL_DIR}, invoke the appropriate installation scripts:
| Platforms | Installation Scripts |
| Linux | ./install_linux.sh |
The script shown above will first install a copy of the JRE to ensure a compatible version of JRE for running the CSpell. The JRE is installed under the ${CSPELL_DIR}/bin directory on Linux platform. Please notes that only 64-bit JRE is supported.
The script will create a shell file in the ${CSPELL_DIR} bin directory for CSpell, with the proper environment set up. Also, it creates CSpell configuration file under ${CSPELL_DIR}/data/config/cSpell.properties.
Once done, the script will attempt to verify that the installation was successful.
If the installation was successful, there will be a congratulation message that finishes off this process. The installation process should take less than 1 minute.
If the installation is not successful, there will be a message indicating so. Please refer to the ${CSPELL_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 CSpell are now ready to be used. They can be found in the ${CSPELL_DIR}/bin directory. On the Linux platforms, they include the following shell script:
The script may be used from any location on the machine. If you put the ${CSPELL_DIR}/bin path in your ${PATH} environment variable they do not have to be referenced with the whole path.
> CSpell -p - Please input a term (type "Ctl-d" to quit) > He was dianosed early on set deminita 3year ago. He was diagnosed early onset dementia 3 year ago.
Other Platform - Manual Installation
The installation script does not provide options to install the CSpell on platform other than Linux and Windows. Users may follow instructions on manual installation instructions to install CSpell on different platforms. The manual installation page shows details of how the installation script configures and installs CSpell. Users may skip this section if they use installation script to install CSpell.
Altering your environment to use the CSpell, once they have been installed
You may invoke CSpell from a command line. CSpell is found in the ${CSPELL_DIR}/bin directory. You can add this ${CSPELL_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.