Zelix KlassMaster - Documentation

Installation

Zelix KlassMaster™ 8.0 is distributed in either a zip archive or tar.gz.
  • The evaluation version is distributed as ZKMEval.zip or ZKMEval.tar.gz.
  • The commercial version is distributed as ZKM.zip or ZKM.tar.gz.
  • The full documentation is distributed separately as ZKMDocs.zip and ZKMDocs.tar.gz.
To expand the tar.gz archive in Unix use the tar then the gzip utilities. The syntax is gzip -d ZKMEval.tar.gz then tar vxf ZKMEval.tar. In Windows both the tar.gz and zip files can be expanded using WinZip.

When you expand the distribution archive, you should get
  • the file ZKM.jar
  • the file ZKM.class
  • the file readme.txt
  • the file license.html
  • the file install.html (this file)
  • the file defaultExclude.txt
  • the file defaultTrimExclude.txt

Note that Zelix KlassMaster™ requires Java 7 (ie. JDK 1.7 or better). The cleanest way to run Zelix KlassMaster™ is use the -jar parameter. Alternatively, you can put ZKM.jar into the classpath. Note that it is not enough just to put the directory containing ZKM.jar into the classpath. (The file ZKM.class exists as a separate file and as a file within ZKM.jar. The separate file exists purely to catch classpath errors and can be safely ignored.)

You run Zelix KlassMaster™ by telling Java to run the com.zelix.ZKM class. Typically you should give the JVM more than the default amount of memory to work with. If you use the -Xmx512m parameter then you will give the JVM 512MB of memory which should be adequate for most purposes. However, you should be sure not to give the JVM more memory than is physically available. Otherwise performance will deteriorate dramatically as the JVM starts to use virtual memory.

If you have Start Zelix KlassMaster™ GUI in this way
NOT added ZKM.jar to the system classpath type java -Xmx512m -jar ZKM.jar at a command prompt
added ZKM.jar to the system classpath type java -Xmx512m com.zelix.ZKM at a command prompt

To execute a ZKM Script, you specify the path to the ZKM Script file as the last option on the command line. The basic usage is:

java -jar ZKM.jar [[-options] <scriptFileName>]

After Installation

Once you have Zelix KlassMaster™ installed successfully, it is recommended that you read the Getting Started document.