../images/jonathan.gif

Installation Guide

Installation Guide

Jonathan 2.0

PDF version

To work through the examples supplied with Jonathan, read sections 1 and 2 of this file, and refer to section 5 if you encounter problems.

To link the Jonathan javadoc documentation with your copy of the JDK API javadoc documentation, read sections 1, 2 and 3, and refer to section 5 if you encounter problems.

To compile Jonathan source code (not normally necessary since Jonathan is delivered with its classes), read sections 1, 2 and 4, and refer to section 5 if you encounter problems.

1  Prerequisites: JDK, JNDI and a Make utility

2  Instructions for configuring Jonathan

This phase is obligatory if you want to run the examples using the provided Makefiles, or recompile Jonathan. It is done in the config directory.

  1. You first need to compile the file Configure.java by typing e.g., javac tools\Configure.java from a DOS shell or javac tools/Configure.java from a Unix or Cygwin shell.
  2. Do "./configure" from a unix shell, "./cygwin-configure" from a Cygwin shell, or "configure" from a DOS shell. This script requires that a java interpreter named "java" is available in your path. If not, you should either add such an interpreter to your path, or modify the script you're using.

    Important: the java interpreter used must be the java interpreter you intend to use to run the examples and your applications.

    The configure utility will ask you a few questions to create a file named "jonathan.config", that contains informations about the various directories, paths and parameters needed for (re)building Jonathan or running the examples.

    Amongst other things, it specifies the locations of any other classes and jar files (such as jndi.jar) that you want added to the classpath when doing the examples, when building Jonathan, and when regenerating the javadoc documentation. It also sets a number of other parameters depending on what you are going to do with Jonathan: for example, the version of JDK that you are using is needed for some examples.

    You may edit the "jonathan.config" file to change some settings. It is normally self-documenting. Note that all directories, jar files, etc., must be specified with absolute names.

    If you have problems, first look at section 5.1.

  3. Configure Jonathan makefiles. This step takes into account your make utility (GNU Make or NMAKE).

    In the config directory:

    This step generates a file called Make.rules in the src and examples directories and recursively copies it through their subdirectories. It also generates a file called LASTCONFIG in the config directory, indicating the current configuration of Jonathan.

3  Instructions for (re)generating the Jonathan Javadoc documentation

This phase is necessary if you wish to link the Jonathan javadoc documentation with your copy of the JDK API javadoc documentation (available from http://java.sun.com/docs), or if you modify Jonathan source code and wish to regenerate the documentation. The following instructions except for step 1 are carried out in the doc/src directory.

Note that you re-generating the documentation requires javadoc 1.2.

  1. You must have already configured Jonathan as described in section 1.
  2. Generate the documentation.

    In the doc/src directory:

    This regenerates the Jonathan javadoc documentation in the doc/apis directory, with links to your copy of the JDK API documentation if you specified it during the Jonathan confirguration phase.

    Due to limitations imposed by javadoc, this make is not incremental and will regenerate the documentation from scratch every time you run the make.

4  Instructions for (re)building Jonathan

This phase is necessary only if you wish to modify Jonathan source code. It is not needed if you only wish to work through the examples since Jonathan is normally delivered with its classes. Note also that re-compiling all the distribution may take quite a long time. The following instructions except for step 1 are carried out in the src directory.

  1. You must have already configured Jonathan as described in section 1.
  2. Recompile the source code. To recompile all the sources, do the following:

    In the src directory:

    If you are rebuilding Jonathan from scratch, the build will take a while. It is also fairly verbose; you may wish to redirect output to a file, e.g., make > log with GNU Make or nmake > log with Nmake.

To independently recompile a particular package, proceed as follows: in the src subdirectory corresponding to the package (or any parent src subdirectory), simply run the make. This will recompile only the modified source files of that package. If several packages are to be recompiled, do the make in a parent directory of those packages.

To remove generated classes, run the make with target "clean". This will remove classes (and most derived source files) of the current package and its subpackages.

Note that make without a target is equivalent to making the target recall.

5  Hints and common problems

5.1  Running the configuration tool

5.2  Running the Makefiles




File translated from TEX by TTH, version 3.06.
On 12 Apr 2002, 09:23.