next up previous contents
Next: 5 BTP Demonstration Up: JOTM-BTP: a BTP extension Previous: 3 Installing JOTM-BTP   Contents

Subsections


4 Ant commands

If you've retrieved JOTM-BTP from CVS, you'll have to build it and create a distribution before using it.
JOTM-BTP relies on Ant for its build process.
All Ant commands are to be typed in the jotm-btp/ 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

Before executing any Ant commands, be sure that:

Ant messages will warn you if one of these 3 conditions is not met.


4.1 Compile and build JOTM-BTP

This step is necessary only if you have modified JOTM-BTP source code or you've retrieved source files from CVS.
You just have to type:
$ ant dist
This will compile all JOTM-BTP source files and create all the jar files.
A working version of JOTM-BTP is now available in the output/dist/ subdirectory (the so-called distribution directory of JOTM-BTP).


4.2 Generate Javadoc

To generate JOTM-BTP Javadoc, simply type:
$ ant jdoc
Javadoc pages are now browsable from the output/dist/jdoc/ subdirectory.


4.3 Generate Documentation

JOTM-BTP 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).

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-BTP

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

$ ant clean
You'll start from a clean working directory again.


4.5 Source Structure

When you retrieve JOTM-BTP source, the structure of your jotm-btp/ directory is the following one:


4.6 Distribution Structure

Once you've built JOTM-BTP (i.e. in the output/dist/ subdirectory) or if you retrieved it from its package, the ditribution structure of JOTM-BTP is the following:


next up previous contents
Next: 5 BTP Demonstration Up: JOTM-BTP: a BTP extension Previous: 3 Installing JOTM-BTP   Contents
Jeff Mesnil 2003-05-15