diff options
Diffstat (limited to 'src/documentation/content/xdocs')
| -rw-r--r-- | src/documentation/content/xdocs/trunk/running.xml | 57 |
1 files changed, 35 insertions, 22 deletions
diff --git a/src/documentation/content/xdocs/trunk/running.xml b/src/documentation/content/xdocs/trunk/running.xml index 4b488ef12..5ab36f4a2 100644 --- a/src/documentation/content/xdocs/trunk/running.xml +++ b/src/documentation/content/xdocs/trunk/running.xml @@ -184,7 +184,7 @@ Fop [options] [-fo|-xml] infile [-xsl file] [-awt|-pdf|-mif|-rtf|-tiff|-png|-pcl <p>FOP's entry point for your own scripts is the class <code>org.apache.fop.cli.Main</code>. The general pattern for the command line is: <code>java -classpath <CLASSPATH> - org.apache.fop.cli.Main <arguments></code>. The arguments + org.apache.fop.cli.Main <arguments></code>. The arguments consist of the options and infile and outfile specifications as shown above for the standard scripts. You may wish to review the standard scripts to make sure that @@ -195,35 +195,48 @@ Fop [options] [-fo|-xml] infile [-xsl file] [-awt|-pdf|-mif|-rtf|-tiff|-png|-pcl <title>Running with java's <code>-jar</code> option</title> <p> As an alternative to the start scripts you can run <code>java - -jar build/fop.jar</code> from the FOP_HOME directory. In this - case FOP tries to build the classpath for running FOP - dynamically, see <a href="#dynamical-classpath">below</a>. If - you use hyphenation, you must put <code>fop-hyph.jar</code> in - the <code>lib</code> directory. + -jar path/to/build/fop.jar <arguments></code>, relying on + FOP to build the classpath for running FOP dynamically, see <a + href="#dynamical-classpath">below</a>. If you use hyphenation, + you must put <code>fop-hyph.jar</code> in the <code>lib</code> + directory. </p> - <p>You can also run <code>java -jar fop.jar</code> from any - other working directory. This only works if you put + + <p>You can also run <code>java -jar path/to/fop.jar + <arguments></code>, relying on the <code>Class-Path</code> + entry in the manifest file. This works if you put <code>fop.jar</code> and all jar files from the <code>lib</code> - directory in a single directory. See the <code>Class-Path</code> - entry in the manifest file. If you use hyphenation, you + directory in a single directory. If you use hyphenation, you must also put <code>fop-hyph.jar</code> in that directory.</p> + + <p>In both cases the arguments consist of the options and + infile and outfile specifications as shown above for the + standard scripts.</p> </section> <section id="dynamical-classpath"> <title>FOP's dynamical classpath construction</title> <p>If FOP is started without a proper classpath, it tries to - add its dependencies dynamically. FOP expects to find - <code>fop.jar</code> in the <code>build</code> directory, - which is either the current working directory or one of its - subdirectories. Then FOP adds all <code>jar</code> files in - the <code>lib</code> directory to the classpath. The - <code>lib</code> directory is a sibling directory of the - <code>build</code> directory, or, if that does not exist, the - parent directory of the <code>build</code> directory. If the - system property <code>fop.optional.lib</code> contains the - name of a directory, then all <code>jar</code> files in that - directory are also added to the classpath. See the methods - <code>getJARList</code> and <code>checkDependencies</code> in + add its dependencies dynamically. If the system property + <code>fop.home</code> contains the name of a directory, then + FOP uses that directory as the base directory for its + search. Otherwise the current working directory is the base + directory. If the base directory is called <code>build</code>, + then its parent directory becomes the base directory.</p> + + <p>FOP expects to find <code>fop.jar</code> in the + <code>build</code> subdirectory of the base directory, and + adds it to the classpath. Subsequently FOP adds all + <code>jar</code> files in the lib directory to the + classpath. The lib directory is either the <code>lib</code> + subdirectory of the base directory, or, if that does not + exist, the base directory itself.</p> + + <p>If the system property <code>fop.optional.lib</code> + contains the name of a directory, then all <code>jar</code> + files in that directory are also added to the classpath. See + the methods <code>getJARList</code> and + <code>checkDependencies</code> in <code>org.apache.fop.cli.Main</code>.</p> </section> |