Compiling FOP

- Compiling FOP + FOP: Building from Source Code

- Do You Need To Compile? + Do You Need To Build?

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. +If you are using a binary distribution, it is already built and there is no need to build it again. See the Download Instructions for information about whether a binary or source distribution is best for your needs.

@@ -29,18 +29,35 @@ You will only need to adjust the classpath if you build FOP in some other way. S

JAVA_HOME -

Ant, which is used by the build script, requires that the enviroment variable JAVA_HOME point to your local JDK root directory. +

Ant, which is used by the build script, requires that the environment 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 Windows batch file is build.bat, and the Unix shell script is build.sh. +The examples below are for running the shell script, but except for the build file extension, the syntax is identical.

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".

+It contains information for numerous build targets, many of which are building blocks to more useful target, and others which are primarily used by the FOP developers. +You may benefit from looking through this file to learn more about the various build targets. +To obtain a complete list of useful build targets:

+ build.sh -projecthelp +

The most useful targets are:

package: Generates the jar files (default). This is the normal build that produces a jar file usable for running FOP.
clean : Cleans the build directory. This is useful for making sure that any build errors are cleaned up before starting a new build. It should not ordinarily be needed, but may be helpful if you are having problems with the build process itself.
javadocs: Generates javadocs. This creates the FOP API documentation.

To run the build:

+ build.sh [target ...] +

For example to do a normal build for the package target (which is the default):

+ build.sh +

+ build.sh package +

To clean the build directory first:

+ build.sh clean package

Troubleshooting diff --git a/src/documentation/content/xdocs/download.xml b/src/documentation/content/xdocs/download.xml index 18c13f2b6..765155e75 100644 --- a/src/documentation/content/xdocs/download.xml +++ b/src/documentation/content/xdocs/download.xml @@ -4,7 +4,7 @@

- Downloading FOP + FOP: Downloading A Distribution

@@ -14,6 +14,7 @@ However, a source distribution will be preferable if you fall into one of the fo

You wish to modify FOP.
You wish to use a version more recent than the latest release. For example, if you have read on the user mailing list that a bug has been fixed or a feature added that you are eager to try, you might download a source distribution from the CVS repository so that you don't have to wait for the next release.
You wish to build a local copy of the API documentation (javadocs).

-- 2.39.5