HOME

XMLGRAPHICS−FOP

NAME
SYNOPSIS
OPTIONS
FOP CONFIGURATION FILE
FILES
EXAMPLES
AUTHORS

---

NAME

xmlgraphics-fop − Formatter for Printing XSLT Processed XML Files

SYNOPSIS

Classname: org.apache.fop.cli.Main

xmlgraphics−fop [−fo | −xml] infile [−xsl file] [−awt | −pdf | −mif | −rtf | −tiff | −png | −pcl | −ps | −txt | −at [mime] | −print] outfile

OPTIONS

The following options in alphabetical order are available:

−a

enables accessibility features (Tagged PDF etc., default off)

−afp OUTFILE

input will be rendered as AFP

−at [mime] OUTFILE

representation of area tree as XML specify optional mime output to allow the AT to be converted to final format later

−atin INFILE

area tree input file

−awt

input will be displayed on screen

−c cfg.xml

use additional configuration file cfg.xml

−catalog

use XML catalog resolver for input XML and XSLT files

−conserve

enable memory−conservation policy (trades memory−consumption for disk I/O) (Note: currently only influences whether the area tree is serialized.)

−d

debug mode

−dpi XXX

target resolution in dots per inch (dpi) where XXX is a number

−fo INFILE

XSL−FO input file

−foout OUTFILE

input will only be XSL transformed. The intermediate XSL−FO file is saved and no rendering is performed. (Only available if you use −xml and −xsl parameters)

−if [mime] OUTFILE

representation of document in intermediate format XML specify optional mime output to allow the IF to be converted to final format later

−ifin INFILE

intermediate format input file

−imagein INFILE

image input file (piping through stdin not supported)

infile

XSL−FO input file (use − for infile to pipe input from stdin); same as −fo

−l LANG

use the language for user information

−noannotations

encrypt PDF file without edit annotation permission

−nocopy

encrypt PDF file without copy content permission

−noedit

encrypt PDF file without edit content permission

−noprint

encrypt PDF file without printing permission

−o PASSWORD

encrypt PDF file with option owner password

−out mime OUTFILE

input will be rendered using the given MIME type. Example: −out application/pdf D:\out.pdf (Tip: −out list prints the list of supported MIME types)

outfile

input will be rendered as PDF into outfile (use − for outfile to pipe output to stdout)

−param NAME VALUE

NAME to use for parameter NAME in XSLT stylesheet (repeat this option for each parameter)

−pcl OUTFILE

input will be rendered as PCL

−pdf OUTFILE

input will be rendered as PDF (outfile required)

−pdfa1b OUTFILE

input will be rendered as PDF/A−1b compliant PDF (outfile required, same as −pdf outfile −pdfprofile PDF/A−1b)

−pdfprofile PROF

PDF file will be generated with the specified profile (Examples for PROF: PDF/A−1b or PDF/X−3:2003)

−png OUTFILE

input will be rendered as PNG

−print

input file will be rendered and sent to the printer see options with −print help

−ps OUTFILE

input will be rendered as PostScript

−q

quiet mode

−r

relaxed/less strict validation (where available)

−rtf OUTFILE

input will be rendered as RTF

−s

for area tree XML, down to block areas only

−svg OUTFILE

input will be rendered as an SVG slides file. Experimental feature; requires additional fop−sandbox.jar

−tiff OUTFILE

input will be rendered as TIFF

−txt OUTFILE

input will be rendered as plain text

−u PASSWORD

encrypt PDF file with option user password

−v

run in verbose mode (currently simply print FOP version and continue)

−version

print FOP version and exit

−x

dump configuration settings

−xml INFILE

XML input file, must be used together with −xsl

−xsl STYLESHEET

XSLT stylesheet

FOP CONFIGURATION FILE

This is a small overview. More details can be found in http://xmlgraphics.apache.org/fop/trunk/configuration.html#renderers.

Example 1. Excerpt FOP Configuration File

<fop version="1.0">

<!−− Strict user configuration −−>
<strict−configuration>true</strict−configuration>

<!−− Strict FO validation −−>
<strict−validation>true</strict−validation>

<!−− Base URL for resolving relative URLs −−>
<base>./</base>

<!−− Font Base URL for resolving relative font URLs −−>
<font−base>./</font−base>

<!−− Source resolution in dpi (dots/pixels per inch) for determining the size of pixels in SVG and bitmap images, default: 72dpi −−>
<source−resolution>72</source−resolution>
<!−− Target resolution in dpi (dots/pixels per inch) for specifying the target resolution for generated bitmaps, default: 72dpi −−>
<target−resolution>72</target−resolution>

<!−− default page−height and page−width, in case
value is specified as auto −−>
<default−page−settings height="11in" width="8.26in"/>

<!−− Use file name nl_Bel instead of the default nl_BE −−>
<hyphenation−pattern lang="nl" country="BE">nl_Bel</hyphenation−pattern>

<!−− etc. etc..... −−>
</fop>

Table 1. Summary of the General Configuration Options

FILES

/etc/fop.conf

System−wide configuration

~/.foprc

User configuration

fop.xconf

Example configuration file; can be handed over with −c option. See the section called “FOP CONFIGURATION FILE” for details.

EXAMPLES

• Transforms the foo.fo FO file into PDF:

fop foo.fo foo.pdf

• Does the same as the previous line:

fop −xml foo.xml −xsl foo.xsl −pdf foo.pdf

• Transforms and formats foo.xml with the help of the XSLT stylesheet foo.xsl into the PDF file foo.pdf:

fop −xml foo.xml −xsl foo.xsl −pdf foo.pdf

• Only transforms, but don't format:

fop −xml foo.xml −xsl foo.xsl −foout foo.fo

• Formats foo.fo into FRTF:

fop foo.fo −mif foo.rtf

• Input file is send to the printer:

fop foo.fo −print

AUTHORS

Apache Foundation

Thomas Schraitle

Manpage

---

More Linux Commands

---