Compiling FOP

Date: Mon, 7 Apr 2003 01:33:11 +0000 Subject: [PATCH] Reorganize for clarity. git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@196217 13f79535-47bb-0310-9956-ffa450edef68 --- src/documentation/content/xdocs/compiling.xml | 64 ++++++++++--------- 1 file changed, 34 insertions(+), 30 deletions(-) diff --git a/src/documentation/content/xdocs/compiling.xml b/src/documentation/content/xdocs/compiling.xml index 693a2f9c1..da38a0cef 100644 --- a/src/documentation/content/xdocs/compiling.xml +++ b/src/documentation/content/xdocs/compiling.xml @@ -8,40 +8,44 @@

- Compiling FOP -

Compilation is started by executing build, either as a batch file on win32 (build.bat) or as a shell script on unix. Before you - can start one of these scripts, you have to setup your classpath and the environment variable JAVA_HOME (see below).

The compilation uses Ant, - a replacement of make (you can find more information about Ant at - jakarta.apache.org). - build.xml is the replacement of makefile. Look there for detailed information on the build - process and different targets.

A help screen is shown by calling "build usage".

If you only want to use FOP, you don't need to build it. A fop.jar comes with the distribution.

- Setting up your classpath - You don't have to setup your classpath; all libraries needed to compile FOP are coming with - the distribution and are referenced by the build script, so you only need to care about them, - if you build FOP in any other way. See build.bat/build.sh for details. + Do You Need To Compile? +

FOP distributions are either pre-compiled binary or source. +If you are using a binary distribution, it is already compiled and there is no need to compile it again. See the Download Instructions for information about whether a binary or source distribution is best for your needs. +

- Setting of JAVA_HOME -

You have to set the enviroment variable JAVA_HOME. It must point to your local JDK - root directory. This is true, even if you use JDK 1.2 or above, which normally don't need this - setting. It is used by Ant, the compilation software.

+ Set Up Your Environment +

+ CLASSPATH +

There is no generally no need to setup a classpath. +All libraries needed to compile FOP are included in the source distribution and are referenced by the build script. +You will only need to adjust the classpath if you build FOP in some other way. See the build scripts (build.bat for Windows, and build.sh for Unix) for details.

+ JAVA_HOME +

Ant, which is used by the build script, requires that the enviroment variable JAVA_HOME point to your local JDK root directory. +This is true even if you use JDK 1.2 or above, which normally don't need this setting.

+ Run the "build" Script +

Build FOP by executing the "build" script, which is located in the FOP root directory. +The Windows batch file is build.bat, and the Unix shell script is build.sh.

The build script uses Ant, a popular java-based build tool. +The file build.xml in the FOP root directory is the blueprint that Ant uses for the build. +Consult its contents for detailed information on the build process and the various build targets.

A help screen is shown by calling "build usage".

- Problems -

If you have problems compiling FOP, please try this first:

+ Troubleshooting +

If you have problems building FOP, please try the following:

delete the build directory completely and try a new build from scratch
check, whether you have an older version of xerces.jar, xalan.jar, batik.jar somewhere in - you classpath.

If you still have problems, please look at the - page bugs, for further help.

Run the build with the target of "clean", then rerun the build.

Delete the build directory completely, then rerun the build.

Make sure you do not have a non-FOP version of xerces.jar, xalan.jar, batik.jar, or another dependency product somewhere in your CLASSPATH.

If the build still fails, see the Getting Help page for further help.

- - + -- 2.39.5