From dcc7f73a7837ce091fff84fca7a67e7ef7e8f9ec Mon Sep 17 00:00:00 2001 From: William Victor Mote Date: Tue, 10 Dec 2002 20:18:42 +0000 Subject: [PATCH] Add "Installation" section. Add comments specific to Mac OSX file truncation issue and $JAVA_HOME issue. git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@195763 13f79535-47bb-0310-9956-ffa450edef68 --- src/documentation/content/xdocs/running.xml | 56 ++++++++++++--------- 1 file changed, 31 insertions(+), 25 deletions(-) diff --git a/src/documentation/content/xdocs/running.xml b/src/documentation/content/xdocs/running.xml index f9e03a2c6..8cb80aa1d 100644 --- a/src/documentation/content/xdocs/running.xml +++ b/src/documentation/content/xdocs/running.xml @@ -3,35 +3,41 @@ "http://cvs.apache.org/viewcvs.cgi/*checkout*/xml-forrest/src/resources/schema/dtd/document-v11.dtd"> -
- Running FOP -
- - -
+
Running FOP +
+ +
- Prerequisites -

Following software must be installed:

-

a) Java 1.2.x or later

-

b) All libraries you need are part of the Fop distribution and - can be found in the xml-fop/lib directory. Look at the batch/shell script fop.bat/fop.sh - to see, how Fop can be invoked easily. These libraries are included: -

-
    -
  • An XML parser which supports SAX and DOM like - Xerces-J. - (Xerces is the default xml parser) -
    • -
  • An XSLT processor (Xalan is included) -
    • -
  • The SVG library batik.jar is the library from the batik project at xml.apache.org. -
    • -
+ Installation +
+ Overview +

The following software must be installed:

+
    +
  • Java 1.2.x or later.
    • +
  • FOP. The FOP distribution includes all libraries that you will need to run a basic FOP installation. These can be found in the xml-fop/lib directory. These libraries include the following:
    • +
      +
    • Apache Xerces-J for XML parsing. You can use other XML parsers which support SAX and DOM.
      • +
    • Apache Xalan, an XSLT processor.
      • +
    • Apache Batik, an SVG library.
      • +
    +
  • Optional Libraries
    • +
+
+
+ Instructions +

Basic FOP installation consists of first unzipping the .gz file that is the distribution medium, then unarchiving the resulting .tar file in a directory/folder that is convenient on your system. Please consult your operating system documentation or Zip application software documentation for instructions specific to your site.

+
+
+ Problems +

Some Mac OSX users have experienced filename truncation problems using Stuffit to unzip and unarchive their distribution media. This is a legacy of older Mac operating systems, which had a 31-character pathname limit. Several Mac OSX users have recommended that Mac OSX users use the shell command tar -xzf instead.

+
- Starting FOP as an standalone application + Starting FOP as a standalone application +

Review the batch file fop.bat or the shell script fop.sh to see how FOP is invoked.

+

The standard scripts for starting FOP require that the environment variable JAVA_HOME be set to a path pointing to the appropriate Java installation on your system. Macintosh OSX includes a Java environment as part of its distribution. We are told by Mac OSX users that the path to use in this case is /Library/Java/Home. Caveat: We suspect that, as Apple releases new Java environments and as FOP upgrades the minimum Java requirements, the two will inevitably not match on some systems. Please see Java on Mac OSX FAQ for information as it becomes available.

Fop [options] [-fo|-xml] infile [-xsl file] [-awt|-pdf|-mif|-pcl|-txt|-svg|-at|-print] <outfile>

[OPTIONS]

@@ -72,6 +78,6 @@ Problems

If you have problems running FOP, please have a look at the "How to get Help" page.

-
+ -- 2.39.5