Manual Installation Instructions



Introduction

This page shows what the CSpell installation script does. A manual installation can be performed to replace the installation script when needed (such as installing CSpell in Mac). It is not recommended for general end users to install the CSpell manually. Please refer to installation instructions for installing the CSpell.

Prerequisites

  • Archive program:
    • Unix: gtar
    • Windows: WINZIP
  • JRE V 1.8.0_171
  • 500 MB ram
  • 1 GB disk space

Install

  1. Create a new directory for the CSpell on your machine.
  2. Download the zip archive: cSpell${YEAR}.tgz, and place it in the newly created directory. "${YEAR}" is the version identification (year).
  3. Uncompress or Unzip the archive. Be careful to use a version of unzip that allows long filenames and that will recreate the full directory structure.

    You should now have 6 files and 8 sub-directories under cSpell${YEAR}, as shown in follows:

    • build.xml
    • install_linux.sh
    • install_win.bat
    • overview.html
    • ReadMe.txt
    • SPECIALIST_NLP_TOOLS_TERMS_AND_CONDITIONS.TXT

    • /bin
    • /data
    • /docs
    • /examples
    • /install
    • /lib
    • /logs
    • /sources

Please refer to Repository Lists for details.

Setup

I. JRE/Java

  • The default installation script install java under ${CSPELL_DIR}/bin/jre1.8.0_171/bin/java for Linux
  • Users should upgrade Java to 1.8+ themselves
  • Users may use existing Java in their computer if the version is 1.8+
  • Only 64-bit JRE is supported.
  • 32-bit JRE (jre-8u171-linux-i586.tar.gz) needs to be installed if a 32-bit computer is used to run CSpell (not tested, not supported, not recommended!)

II. Command Line scripts:
Manually modify shell script, CSpell, under ${CSPELL_DIR}/bin/ as follows:

VariableValueExample
JAVAThe JRE/bin/java you will use
  • JAVA=/Projects/cSpell2018/bin/jre1.8.0_171/bin/java
  • JAVA=java
ROOT_DIRThe full path of the top directory of cSpell2018 ROOT_DIR=/Projects/cSpell2018
CLASSPATHIncludes:
  • lib/cSpell2018dist.jar
    => cSpell2018dist.jar includes classes of CSpell and all cSpell API classes and Apache commons-codec-1.10.jar library
  • ${ROOT_DIR}
    => the full path of the top directory of cSpell2018, this allows CSpell to find the default configuration file, data/config/cSpell.properties
CLASSPATH=${ROOT_DIR}:${ROOT_DIR}/lib/cSpell2018dist.jar

III. Configuration file:
Manually modify configuration file, ${CSPELL_DIR}/data/Config/cSpell.properties, as follows:

VariableValueExample
CS_DIRThe full path of the top directory of cSpell2018 CS_DIR=/Projects/cSpell2018

Make sure values of database variables are setup appropriately in the configuration file, see configuration setup for details

Now you are ready for running CSpell