123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475 |
- <?xml version="1.0" standalone="no"?>
- <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN"
- "http://cvs.apache.org/viewcvs.cgi/*checkout*/xml-forrest/src/resources/schema/dtd/document-v11.dtd">
-
- <document>
- <header>
- <title>FOP: Building from Source Code</title>
- </header>
- <body>
- <section id="build-needed">
- <title>Do You Need To Build?</title>
- <p>FOP distributions are either pre-compiled binary or source.
- If you are using a binary distribution, it is already built and there is no need to build it again. See the <link href="download.html">Download Instructions</link> for information about whether a binary or source distribution is best for your needs.
- </p>
- </section>
- <section id="env">
- <title>Set Up Your Environment</title>
- <section id="env-jdk">
- <title>JDK</title>
- <p>
- Building FOP requires a minimum Java Development Kit (JDK/SDK) of 1.3
- (A Java Runtime Environment ist not sufficient)
- </p>
- </section>
- <section id="env-classpath">
- <title>CLASSPATH</title>
- <p>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.</p>
- </section>
- <section id="env-java-home">
- <title>JAVA_HOME</title>
- <p>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.</p>
- </section>
- </section>
- <section id="build-script">
- <title>Run the "build" Script</title>
- <p>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 examples below are for running the shell script, but except for the build file extension, the syntax is identical.</p>
- <p>The build script uses <link href="http://jakarta.apache.org/ant/">Ant</link>, a popular java-based build tool.
- The file build.xml in the FOP root directory is the blueprint that Ant uses for the build.
- 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:</p>
- <source>build.sh -projecthelp</source>
- <p>The most useful targets are:</p>
- <ul>
- <li><strong>package</strong>: Generates the jar files (default). This is the normal build that produces a jar file usable for running FOP.</li>
- <li><strong>clean </strong>: 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.</li>
- <li><strong>javadocs</strong>: Generates javadocs. This creates the FOP API documentation.</li>
- </ul>
- <p>To run the build:</p>
- <source>build.sh [target ...]</source>
- <p>For example to do a normal build for the package target (which is the default):</p>
- <source>build.sh</source>
- <p>OR</p>
- <source>build.sh package</source>
- <p>To clean the build directory first:</p>
- <source>build.sh clean package</source>
- </section>
- <section id="problems">
- <title id="Troubleshooting">Troubleshooting</title>
- <p>If you have problems building FOP, please try the following:</p>
- <ul>
- <li>Run the build with the target of "clean", then rerun the build.</li>
- <li>Delete the build directory completely, then rerun the build.</li>
- <li>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.</li>
- <li>If the build still fails, see the <link href="gethelp.html">Getting Help</link> page for further help.</li>
- </ul>
- </section>
- </body>
- </document>
|