--- name: "fop" section: "1" platform: "linux" package: "fop" version: "1:2.10+dfsg-2" release: "Debian 13 (Trixie)" platforms: ["linux"] url: "https://new.carta.tech/fop" --- # fop(1) Command line wrapper for the java version of fop. ## NAME fop - Command line wrapper for the java version of fop. ## DESCRIPTION Apache FOP (Formatting Objects Processor) is a print formatter driven by XSL formatting objects (XSL-FO) and an output independent formatter. It is a Java application that reads a formatting object (FO) tree and renders the resulting pages to a specified output. Output formats currently supported include PDF, PS, PCL, AFP, XML (area tree representation), Print, AWT and PNG, and to a lesser extent, RTF and TXT. The primary output target is PDF. ## SYNOPSIS fop \[options\] \[-fo\|-xml\] infile \[-xsl file\] \[-awt\|-pdf\|-mif\|-rtf\|-tiff\|-png\|-pcl\|-ps\|-txt\|-at \[mime\]\|-print\] \ - ## OPTIONS - **-version** print FOP version and exit - **-x** dump configuration settings - **-c** cfg.xml use additional configuration file cfg.xml - **-l** lang the language to use for user information - **-nocs** disable complex script features - **-r** relaxed/less strict validation (where available) - **-dpi** xxx target resolution in dots per inch (dpi) where xxx is a number - **-s** for area tree XML, down to block areas only - **-v** run in verbose mode (currently simply print FOP version and continue) - **-o** \[password\] PDF file will be encrypted with option owner password - **-u** \[password\] PDF file will be encrypted with option user password - **-noprint** PDF file will be encrypted without printing permission - **-nocopy** PDF file will be encrypted without copy content permission - **-noedit** PDF file will be encrypted without edit content permission - **-noannotations** PDF file will be encrypted without edit annotation permission - **-nofillinforms** PDF file will be encrypted without fill in interactive form fields permission - **-noaccesscontent** PDF file will be encrypted without extract text and graphics permission - **-noassembledoc** PDF file will be encrypted without assemble the document permission - **-noprinthq** PDF file will be encrypted without print high quality permission - **-a** enables accessibility features (Tagged PDF etc., default off) - **-pdfprofile** prof PDF file will be generated with the specified profile (Examples for prof: PDF/A-1b or PDF/X-3:2003) - **-conserve** enable memory-conservation policy (trades memory-consumption for disk I/O) (Note: currently only influences whether the area tree is serialized.) - **-cache** specifies a file/directory path location for the font cache file - **-flush** flushes the current font cache file - ## INPUT - infile xsl:fo input file (the same as the next) (use '-' for infile to pipe input from stdin) - **-fo** infile xsl:fo input file - **-xml** infile xml input file, must be used together with **-xsl** - **-atin** infile area tree input file - **-ifin** infile intermediate format input file - **-imagein** infile image input file (piping through stdin not supported) - **-xsl** stylesheet xslt stylesheet - **-param** name value \ to use for parameter \ in xslt stylesheet (repeat '-param name value' for each parameter) - **-catalog** use catalog resolver for input XML and XSLT files - ## OUTPUT - outfile input will be rendered as PDF into outfile (use '-' for outfile to pipe output to stdout) - **-pdf** outfile input will be rendered as PDF (outfile req'd) - **-pdfa1b** outfile input will be rendered as PDF/A-1b compliant PDF (outfile req'd, same as "-pdf outfile **-pdfprofile** PDF/A-1b") - **-awt** input will be displayed on screen - **-rtf** outfile input will be rendered as RTF (outfile req'd) - **-pcl** outfile input will be rendered as PCL (outfile req'd) - **-ps** outfile input will be rendered as PostScript (outfile req'd) - **-afp** outfile input will be rendered as AFP (outfile req'd) - **-tiff** outfile input will be rendered as TIFF (outfile req'd) - **-png** outfile input will be rendered as PNG (outfile req'd) - **-txt** outfile input will be rendered as plain text (outfile req'd) - **-at** \[mime\] out representation of area tree as XML (outfile req'd) specify optional mime output to allow the AT to be converted to final format later - **-if** \[mime\] out representation of document in intermediate format XML (outfile req'd) specify optional mime output to allow the IF to be converted to final format later - **-print** input file will be rendered and sent to the printer see options with "-print help" - **-out** mime outfile input will be rendered using the given MIME type (outfile req'd) Example: "-out application/pdf D:\\out.pdf" (Tip: "-out list" prints the list of supported MIME types and exits) - **-svg** outfile input will be rendered as an SVG slides file (outfile req'd) Experimental feature - requires additional fop-sandbox.jar. - **-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) - ## EXAMPLES - fop foo.fo foo.pdf fop **-fo** foo.fo **-pdf** foo.pdf (does the same as the previous line) fop **-xml** foo.xml **-xsl** foo.xsl **-pdf** foo.pdf fop **-xml** foo.xml **-xsl** foo.xsl **-foout** foo.fo fop **-xml** - **-xsl** foo.xsl **-pdf** - fop foo.fo **-mif** foo.mif fop foo.fo **-rtf** foo.rtf fop foo.fo **-print** fop foo.fo **-awt** ## HYPHENATION fop can make use of external hyphenation rules that can be supplied in the form of a **hyphenation jar**. You can find such a one at *http://offo.sourceforge.net/*. To actually use that, set the **FOP\_HYPHENATION\_PATH** environment variable to the full path of this file, or use configuration files, see below. ## CONFIGURATION FILES fop reads two configuration files on startup: */etc/fop.conf* and *$HOME/.foprc*. These are plain shell script files where you can define for instance the **FOP\_HYPHENATION\_PATH** variable. Another way to extend is *conf.d/* files. Simply add a configuration file into */etc/fop.conf.d/my.conf*. ## JAVA-WRAPPERS NOTE This program is a shell script wrapper based on **[java-wrappers(7)](/java-wrappers/7.md)**. You therefore benefit from several features; please see the **[java-wrappers(7)](/java-wrappers/7.md)** manual page for more information about them. ## AUTHOR Wrapper author: Ola Lundqvist \ This manual page was written by Mathieu Malaterre \, for the Debian project (and may be used by others). ## SEE ALSO **[fop-ttfreader(1)](/fop-ttfreader/1.md),** **[java-wrappers(7)](/java-wrappers/7.md).**