Chapter 5. Console Application

Describes the installation and usage of the Console Plug-in.

The Console application provides a powerful command line interface for Jalopy.

Installation

Explains the steps involved to install the Console Plug-in.

System requirements

See the section called "System requirements" for the basic requirements to run Jalopy.

Installation

The Plug-in comes as an executable Jar Archive (Jar) that contains a graphical setup wizard to let you easily install the software. Wizard installation is recommended and explained in detail in the section called "Wizard Installation".

If you would rather install the Plug-in manually, you have to decompress and copy the appropriate files into the different application folders. To decompress the contents of the installer Jar, you can either use the Jar tool that ships with your Java distribution or any other software that can handle the ZIP compression format (e.g. 7Zip or WinZip).

If you're upgrading from a prior version and want to keep your settings, first copy or rename the current Jalopy settings directory to match the version number of the new release. For instance, if your current settings directory is "C:\Documents and Settings\John Doo\.jalopy\1.0.4" and you're about to install Jalopy Help, either copy the directory contents or rename it to "C:\Documents and Settings\.jalopy\John Doo\Help". Wizard installation can perform this step automatically.

Decompress the contents of the Jar file into a temporary directory. Afterwards create the actual installation directory, e.g. "C:\Program Files\Jalopy" or "/usr/local/java/jalopy" whatever. Create a new subfolder "/lib" and copy the file "jalopy-Help.jar" from the temporary directory into the "/lib" folder. Copy the "/bin" folder from the temporary directory into the installation directory.

To invoke Jalopy, you can find wrapper scripts for the common platforms in the "/bin" folder. You may want to add this folder to your path.

If your platform is not covered, you should make use of the -jar or -cp options of the Java application launcher (the java command), since this requires no classpath manipulation (see the section called "Synopsis" below). But if you don't want to use any of these options, you have to add "jalopy-Help.jar" as usual to your classpath.

For the Unix Bash shell, this means can be achieved using

export CLASSPATH=${CLASSPATH}:<JALOPY_HOME>/lib/jalopy-Help.jar

For Windows, use something like

set CLASSPATH=%CLASSPATH%;<JALOPY_HOME>\lib\jalopy-Help.jar

Refer to your system documentation on how to apply these changes more permanently.