http://xml.apache.org/http://www.apache.org/http://www.w3.org/

Home

About FOP
News
Status
Download
Release Notes
How to get Help

Running FOP
Embedding
Output Formats
Features
TODO
Limitations
Examples

SVG
Extensions
Fonts
Configuration

NEW DESIGN
Getting involved
Compiling
Testing

FAQ
Bugs
Resources
License


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.


Starting FOP as an standalone application

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

[OPTIONS]

      -d          debug mode
-x dump configuration settings
-q quiet mode
-c cfg.xml use additional configuration file cfg.xml
-l lang the language to use for user information

[INPUT]

      infile            xsl:fo input file (the same as the next)
-fo infile xsl:fo input file
-xml infile xml input file, must be used together with -xsl
-xsl stylesheet xslt stylesheet

[OUTPUT]

      outfile           input will be rendered as pdf file into outfile
-pdf outfile input will be rendered as pdf file (outfile req'd)
-awt input will be displayed on screen
-mif outfile input will be rendered as mif file (outfile req'd)
-pcl outfile input will be rendered as pcl file (outfile req'd)
-txt outfile input will be rendered as text file (outfile req'd)
-svg outfile input will be rendered as an svg slides file (outfile req'd) -at outfile representation of area tree as XML (outfile req'd) -print input file will be rendered and sent to the printer
see options with "-print help"

[Examples]

      Fop foo.fo foo.pdf
Fop -fo foo.fo -pdf foo.pdf (does the same as the previous line)
Fop -xsl foo.xsl -xml foo.xml -pdf foo.pdf
Fop foo.fo -mif foo.mif
Fop foo.fo -print or Fop -print foo.fo
Fop foo.fo -awt


Problems

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




Copyright © 1999-2002 The Apache Software Foundation. All Rights Reserved.