4 Ant commands

If you've retrieved JOTM from a source package or CVS, you'll have to build it and create a distribution before using it.
JOTM relies on Ant for its build process.
All Ant commands are to be typed in the jotm/ directory (i.e. in the same directory than the build.xml file).
To have a list and descriptions of all Ant available targets for JOTM, type:

$ ant -projecthelp

4.1 Compile and build JOTM

This step is necessary only if you have modified JOTM source code or you've retrieved source files only (e.g. with CVS or from a source package).
You just have to type:

$ ant dist

This will compile all JOTM source files and create all the jar files.
A working version of JOTM is now available in the output/dist/ subdirectory (the so-called distribution directory of JOTM).

4.2 Generate Javadoc

To generate JOTM Javadoc, simply type:

$ ant jdoc

Javadoc pages are now browsable from the output/dist/jdoc/ subdirectory.

4.3 Generate Documentation

JOTM documentation is written in LaTeX.
We use pdflatex tool to generate PDF files and latex2html to generate HTML files. Since these two tools may not be installed on your system, it's up to you to inform Ant that it'll have the tools to perform document generation.
PDF (resp. HTML) generation is triggered by pdlatex (resp. latex2html) property on the command line. What's more, for HTML generation a shell script, doc2html, is used. So for the moment, you can generate HTML documentation only from Linux. Sorry... (Anyway, documentation is still available online at http://www.objectweb.org/jotm/doc/ in both PDF and HTML format).

• If you've pdflatex on your system, you can ask Ant to generate PDF documentation by typing

  $ ant doc -Dpdflatex=1
  

• If you've latex2html and you're on Linux, you can ask Ant to generate HTML documentation by typing

  $ and doc -Dlatex2html=1
  

Of course, you can also do both

$ and doc -Dpdflatex=1 -Dlatex2html=1

Generated document is put in the output/dist/doc directory.

4.4 Clean JOTM

To remove files generated during compilation or build process, type:

$ ant clean

You'll start from a clean working directory again.