[634c636c] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[6732c094] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[634c636c] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[4634c7a] | 7 | <!ENTITY fop-download-http "https://archive.apache.org/dist/xmlgraphics/fop/source/fop-&fop-version;-src.tar.gz">
|
---|
[75d53372] | 8 | <!ENTITY fop-download-ftp " ">
|
---|
[42d51c6] | 9 | <!ENTITY fop-md5sum "610bfd7797755d744b2c4f61422478cf">
|
---|
| 10 | <!ENTITY fop-size "22 MB">
|
---|
| 11 | <!ENTITY fop-buildsize "517 MB (including files downloaded to the user directory)">
|
---|
| 12 | <!ENTITY fop-time "0.6 SBU">
|
---|
[460e986] | 13 |
|
---|
[42d51c6] | 14 | <!ENTITY pdfbox-version "2.0.27">
|
---|
[75b1a338] | 15 | <!ENTITY pdfbox-download "https://archive.apache.org/dist/pdfbox/&pdfbox-version;/pdfbox-&pdfbox-version;.jar">
|
---|
[42d51c6] | 16 | <!ENTITY pdfbox-md5sum "ddd46402b1692eed9e5c73b4a94c45d8">
|
---|
| 17 | <!ENTITY pdfbox-size "2.7 MB">
|
---|
[492000e] | 18 |
|
---|
[75b1a338] | 19 | <!ENTITY fontbox-download "https://archive.apache.org/dist/pdfbox/&pdfbox-version;/fontbox-&pdfbox-version;.jar">
|
---|
[42d51c6] | 20 | <!ENTITY fontbox-md5sum "587744efe2a82d3584c2f3969fa4dca0">
|
---|
[bba3fd3] | 21 | <!ENTITY fontbox-size "1.5 MB">
|
---|
[8dfc5c3] | 22 |
|
---|
[6f6f731] | 23 | <!ENTITY maven-major "3">
|
---|
[42d51c6] | 24 | <!ENTITY maven-version "3.8.6">
|
---|
[75b1a338] | 25 | <!ENTITY maven-download "https://archive.apache.org/dist/maven/maven-&maven-major;/&maven-version;/binaries/apache-maven-&maven-version;-bin.tar.gz">
|
---|
[42d51c6] | 26 | <!ENTITY maven-md5sum "0e07de4a7b5c84ebed737a2002f52019">
|
---|
| 27 | <!ENTITY maven-size "8.3 MB (additionally, about 90 MB are downloaded to the building user's directory)">
|
---|
[6f6f731] | 28 |
|
---|
[8dfc5c3] | 29 | <!ENTITY offo-download "&sourceforge-dl;/offo/2.2/offo-hyphenation.zip">
|
---|
[bf7a1821] | 30 | <!ENTITY offo-md5sum "bf9c09bf05108ef9661b8f08d91c2336">
|
---|
| 31 | <!ENTITY offo-size "862 KB">
|
---|
[634c636c] | 32 | ]>
|
---|
| 33 |
|
---|
[75d53372] | 34 | <sect1 id="fop" xreflabel="fop-&fop-version;">
|
---|
[f570280] | 35 | <?dbhtml filename="fop.html"?>
|
---|
| 36 |
|
---|
| 37 |
|
---|
[75d53372] | 38 | <title>fop-&fop-version;</title>
|
---|
[f570280] | 39 |
|
---|
| 40 | <indexterm zone="fop">
|
---|
[75d53372] | 41 | <primary sortas="a-fop">fop</primary>
|
---|
[f570280] | 42 | </indexterm>
|
---|
| 43 |
|
---|
| 44 | <sect2 role="package">
|
---|
[75d53372] | 45 | <title>Introduction to fop</title>
|
---|
[f570280] | 46 |
|
---|
[6fe6db6] | 47 | <para>
|
---|
| 48 | The <application>FOP</application> (Formatting Objects Processor)
|
---|
| 49 | package contains a print formatter driven by XSL formatting objects
|
---|
| 50 | (XSL-FO). It is a <application>Java</application> application that reads
|
---|
| 51 | a formatting object tree and renders the resulting pages to a specified
|
---|
| 52 | output. Output formats currently supported include PDF, PCL, PostScript,
|
---|
| 53 | SVG, XML (area tree representation), print, AWT, MIF and ASCII text. The
|
---|
| 54 | primary output target is PDF.
|
---|
| 55 | </para>
|
---|
[f570280] | 56 |
|
---|
[d0caf17a] | 57 | &lfs113_checked;
|
---|
[50929e8] | 58 |
|
---|
[f570280] | 59 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 60 | <itemizedlist spacing="compact">
|
---|
| 61 | <listitem>
|
---|
[fa3edfef] | 62 | <para>
|
---|
| 63 | Download (HTTP): <ulink url="&fop-download-http;"/>
|
---|
| 64 | </para>
|
---|
[f570280] | 65 | </listitem>
|
---|
| 66 | <listitem>
|
---|
[fa3edfef] | 67 | <para>
|
---|
| 68 | Download (FTP): <ulink url="&fop-download-ftp;"/>
|
---|
| 69 | </para>
|
---|
[f570280] | 70 | </listitem>
|
---|
| 71 | <listitem>
|
---|
[fa3edfef] | 72 | <para>
|
---|
| 73 | Download MD5 sum: &fop-md5sum;
|
---|
| 74 | </para>
|
---|
[f570280] | 75 | </listitem>
|
---|
| 76 | <listitem>
|
---|
[fa3edfef] | 77 | <para>
|
---|
| 78 | Download size: &fop-size;
|
---|
| 79 | </para>
|
---|
[f570280] | 80 | </listitem>
|
---|
| 81 | <listitem>
|
---|
[fa3edfef] | 82 | <para>
|
---|
| 83 | Estimated disk space required: &fop-buildsize;
|
---|
| 84 | </para>
|
---|
[f570280] | 85 | </listitem>
|
---|
| 86 | <listitem>
|
---|
[fa3edfef] | 87 | <para>
|
---|
| 88 | Estimated build time: &fop-time;
|
---|
| 89 | </para>
|
---|
[f570280] | 90 | </listitem>
|
---|
| 91 | </itemizedlist>
|
---|
| 92 |
|
---|
| 93 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
| 94 | <itemizedlist spacing="compact">
|
---|
[a288a10] | 95 | <title>Required Additional Downloads:</title>
|
---|
[bba3fd3] | 96 | <listitem>
|
---|
[fa3edfef] | 97 | <para>
|
---|
| 98 | PDFBox:
|
---|
[bba3fd3] | 99 | <simplelist>
|
---|
| 100 | <member><ulink url="&pdfbox-download;"/></member>
|
---|
| 101 | <member>&pdfbox-md5sum;</member>
|
---|
| 102 | <member>&pdfbox-size;</member>
|
---|
| 103 | </simplelist>
|
---|
| 104 | </para>
|
---|
| 105 | </listitem>
|
---|
| 106 | <listitem>
|
---|
[fa3edfef] | 107 | <para>
|
---|
| 108 | PDFBox Fonts:
|
---|
[bba3fd3] | 109 | <simplelist>
|
---|
| 110 | <member><ulink url="&fontbox-download;"/></member>
|
---|
| 111 | <member>&fontbox-md5sum;</member>
|
---|
| 112 | <member>&fontbox-size;</member>
|
---|
| 113 | </simplelist>
|
---|
| 114 | </para>
|
---|
| 115 | </listitem>
|
---|
[6f6f731] | 116 | <listitem>
|
---|
| 117 | <para>
|
---|
| 118 | Maven build system:
|
---|
| 119 | <simplelist>
|
---|
| 120 | <member><ulink url="&maven-download;"/></member>
|
---|
| 121 | <member>&maven-md5sum;</member>
|
---|
| 122 | <member>&maven-size;</member>
|
---|
| 123 | </simplelist>
|
---|
| 124 | </para>
|
---|
| 125 | </listitem>
|
---|
[bba3fd3] | 126 | </itemizedlist>
|
---|
[5b5d604] | 127 | <!-- Using the archive above allows finding all versions
|
---|
[b786b70] | 128 | <note><para>
|
---|
[8558044] | 129 | The pdfbox and fontbox packages may not be available at the above
|
---|
[b786b70] | 130 | location. If not, they can be found at the BLFS files mirror sites.
|
---|
| 131 | </para></note>
|
---|
[5b5d604] | 132 | -->
|
---|
[bba3fd3] | 133 | <itemizedlist spacing="compact">
|
---|
| 134 | <title>Recommended packages</title>
|
---|
[f570280] | 135 | <listitem>
|
---|
[fa3edfef] | 136 | <para>
|
---|
| 137 | Objects for Formatting Objects (OFFO) hyphenation patterns:
|
---|
[492000e] | 138 | <simplelist>
|
---|
| 139 | <member><ulink url="&offo-download;"/></member>
|
---|
| 140 | <member>&offo-md5sum;</member>
|
---|
| 141 | <member>&offo-size;</member>
|
---|
| 142 | </simplelist>
|
---|
[f570280] | 143 | </para>
|
---|
| 144 | </listitem>
|
---|
| 145 | </itemizedlist>
|
---|
| 146 |
|
---|
[75d53372] | 147 | <bridgehead renderas="sect3">fop Dependencies</bridgehead>
|
---|
[f570280] | 148 |
|
---|
| 149 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[75d53372] | 150 | <para role="required">
|
---|
| 151 | <xref linkend="apache-ant"/>
|
---|
| 152 | </para>
|
---|
[f570280] | 153 |
|
---|
| 154 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[75d53372] | 155 | <para role="optional">
|
---|
[c084a2a] | 156 | <!-- Included into ant <xref linkend="junit"/> (to run tests),-->
|
---|
[adf80ef] | 157 | <xref linkend="x-window-system"/> (to run tests),
|
---|
[6f6f731] | 158 | <!-- <xref linkend="maven"/> (an alternate build system), not functional
|
---|
[c084a2a] | 159 | with fop-2.3 -->
|
---|
[75b1a338] | 160 | <ulink url="https://jai-tools.blogspot.com/">JAI Image I/O Tools</ulink>, and
|
---|
[17aa21c] | 161 | <ulink url="https://jeuclid.sourceforge.net/">JEuclid</ulink>
|
---|
[bf7a1821] | 162 | <!-- [pierre 2017-04-29] Note to devs: there are a lot of bundled dependencies.
|
---|
| 163 | Some were listed here, but not all. I am not sure it is possible to
|
---|
[6f6f731] | 164 | use system ones. So, I have removed them, and kept only those which
|
---|
[bf7a1821] | 165 | are not bundled. -->
|
---|
[75d53372] | 166 | </para>
|
---|
[f570280] | 167 |
|
---|
[977061b0] | 168 | <para condition="html" role="usernotes">User Notes:
|
---|
| 169 | <ulink url="&blfs-wiki;/fop"/></para>
|
---|
| 170 |
|
---|
[f570280] | 171 | </sect2>
|
---|
| 172 |
|
---|
| 173 | <sect2 role="installation">
|
---|
[75d53372] | 174 | <title>Installation of fop</title>
|
---|
[f570280] | 175 |
|
---|
[6fe6db6] | 176 | <para>
|
---|
| 177 | Ensure <envar>$JAVA_HOME</envar> is set correctly before beginning
|
---|
| 178 | the build. To build the <application>JIMI SDK</application> and/or
|
---|
| 179 | <application>XMLUnit</application> extension classes, ensure the
|
---|
| 180 | corresponding <filename class='extension'>.jar</filename> files can be
|
---|
| 181 | found via the <envar>CLASSPATH</envar> environment variable.
|
---|
| 182 | </para>
|
---|
[bf7a1821] | 183 |
|
---|
[492000e] | 184 | <sect3>
|
---|
| 185 | <title>Installing OFFO Hyphenation Patterns</title>
|
---|
| 186 |
|
---|
[6fe6db6] | 187 | <para>
|
---|
[bf7a1821] | 188 | Copy the XML hyphenation patterns into the fop source tree by running
|
---|
| 189 | the following commands:
|
---|
[6fe6db6] | 190 | </para>
|
---|
[492000e] | 191 |
|
---|
[bf7a1821] | 192 | <screen><userinput>unzip ../offo-hyphenation.zip &&
|
---|
| 193 | cp offo-hyphenation/hyph/* fop/hyph &&
|
---|
| 194 | rm -rf offo-hyphenation</userinput></screen>
|
---|
[492000e] | 195 |
|
---|
| 196 | </sect3>
|
---|
[bf7a1821] | 197 |
|
---|
[6f6f731] | 198 | <sect3>
|
---|
| 199 | <title>Installing a temporary Maven binary</title>
|
---|
| 200 |
|
---|
| 201 | <para>
|
---|
| 202 | Starting with fop-2.5, the Maven build system is required. We use
|
---|
| 203 | the binary provided by apache, that we install in a temporary location:
|
---|
| 204 | </para>
|
---|
| 205 |
|
---|
| 206 | <screen><userinput>tar -xf ../apache-maven-&maven-version;-bin.tar.gz -C /tmp</userinput></screen>
|
---|
| 207 |
|
---|
| 208 | </sect3>
|
---|
| 209 |
|
---|
[f570280] | 210 | <sect3>
|
---|
[75d53372] | 211 | <title>Installing fop Components</title>
|
---|
[f570280] | 212 |
|
---|
[6fe6db6] | 213 | <para>
|
---|
[2a8af5f] | 214 | The <command>javadoc</command> command that ships with OpenJDK 10 and
|
---|
| 215 | later has
|
---|
| 216 | become much stricter than previous versions regarding conformance of
|
---|
[bba3fd3] | 217 | the Javadoc comments in source code to HTML. The FOP documentation does
|
---|
| 218 | not meet those standards, so the conformance checks have to be
|
---|
[6fe6db6] | 219 | disabled. This can be done with the following command:
|
---|
| 220 | </para>
|
---|
| 221 |
|
---|
[ba7be716] | 222 | <screen><userinput>sed -i '\@</javad@i\
|
---|
| 223 | <arg value="-Xdoclint:none"/>\
|
---|
[d61ead0a] | 224 | <arg value="--allow-script-in-comments"/>\
|
---|
| 225 | <arg value="--ignore-source-errors"/>' \
|
---|
| 226 | fop/build.xml</userinput></screen>
|
---|
[5b5d604] | 227 | <!-- Seems to have been fixed in 2.6
|
---|
[bf7a1821] | 228 | <para>
|
---|
| 229 | The stack size set in <filename>build.xml</filename> for building the
|
---|
[bba3fd3] | 230 | hyphenation patterns is not large enough. Change it by running:
|
---|
[bf7a1821] | 231 | </para>
|
---|
[6fe6db6] | 232 |
|
---|
[bf7a1821] | 233 | <screen><userinput>sed -e '/hyph\.stack/s/512k/1M/' \
|
---|
| 234 | -i fop/build.xml</userinput></screen>
|
---|
[61f5b628] | 235 | fixed with maven-3.8.4
|
---|
[d53d455] | 236 | <para>
|
---|
| 237 | Fix building with JDK-16 due to an outdated Apache Maven plugin:
|
---|
| 238 | </para>
|
---|
| 239 |
|
---|
| 240 | <screen><userinput remap="pre">sed -i 's/<war.plugin.version>2.2/<war.plugin.version>3.3.1/' pom.xml</userinput></screen>
|
---|
[61f5b628] | 241 | -->
|
---|
[bba3fd3] | 242 | <para>
|
---|
| 243 | The <filename>build.xml</filename> file calls for an old version of
|
---|
| 244 | <application>PDFBox</application> components that are no longer
|
---|
| 245 | available. Copy the updated PDFBox components into the source tree:
|
---|
| 246 | </para>
|
---|
| 247 |
|
---|
| 248 | <screen><userinput>cp ../{pdf,font}box-&pdfbox-version;.jar fop/lib</userinput></screen>
|
---|
| 249 |
|
---|
[6fe6db6] | 250 | <para>
|
---|
[bba3fd3] | 251 | Compile <application>fop</application> by running the following
|
---|
| 252 | commands:
|
---|
[6fe6db6] | 253 | </para>
|
---|
[f570280] | 254 |
|
---|
[6f6f731] | 255 | <screen><userinput>cd fop &&
|
---|
| 256 |
|
---|
| 257 | LC_ALL=en_US.UTF-8 \
|
---|
| 258 | PATH=$PATH:/tmp/apache-maven-&maven-version;/bin \
|
---|
| 259 | ant all javadocs &&
|
---|
| 260 |
|
---|
[cbfc7b61] | 261 | mv build/javadocs .</userinput></screen>
|
---|
| 262 |
|
---|
[6fe6db6] | 263 | <para>
|
---|
[48771ae] | 264 | This package comes with a test suite, but the java infrastructure
|
---|
[6f6f731] | 265 | installed in this book does not allow running it.
|
---|
[6fe6db6] | 266 | </para>
|
---|
[8558044] | 267 |
|
---|
[6fe6db6] | 268 | <para>
|
---|
[bba3fd3] | 269 | Now, install <application>Fop</application> as the
|
---|
| 270 | <systemitem class="username">root</systemitem> user:
|
---|
[6fe6db6] | 271 | </para>
|
---|
[d260aaf4] | 272 |
|
---|
[2612183a] | 273 | <screen role="root"><userinput>install -v -d -m755 -o root -g root /opt/fop-&fop-version; &&
|
---|
| 274 | cp -vR build conf examples fop* javadocs lib /opt/fop-&fop-version; &&
|
---|
[bf7a1821] | 275 | chmod a+x /opt/fop-&fop-version;/fop &&
|
---|
| 276 | ln -v -sfn fop-&fop-version; /opt/fop</userinput></screen>
|
---|
[f570280] | 277 |
|
---|
[6f6f731] | 278 | <para>
|
---|
| 279 | The last thing to do is to clean what we have done:
|
---|
| 280 | </para>
|
---|
| 281 |
|
---|
| 282 | <screen><userinput>rm -rf /tmp/apache-maven-&maven-version;</userinput></screen>
|
---|
| 283 |
|
---|
[f570280] | 284 | </sect3>
|
---|
| 285 |
|
---|
| 286 | </sect2>
|
---|
[634c636c] | 287 |
|
---|
[f570280] | 288 | <sect2 role="commands">
|
---|
| 289 | <title>Command Explanations</title>
|
---|
| 290 |
|
---|
[ba7be716] | 291 | <para>
|
---|
[61f5b628] | 292 | <command>sed -i ... build.xml</command>: This adds three switches to the
|
---|
[2c87187] | 293 | <command>javadoc</command> command, preventing some errors from occurring
|
---|
[e3b75e18] | 294 | when building the documentation.
|
---|
[ba7be716] | 295 | </para>
|
---|
| 296 |
|
---|
| 297 | <para>
|
---|
[bf7a1821] | 298 | <command>export LC_ALL=en_US.UTF-8</command>: the compiler fails if using
|
---|
| 299 | an ASCII locale.
|
---|
[ba7be716] | 300 | </para>
|
---|
| 301 |
|
---|
[6fe6db6] | 302 | <para>
|
---|
| 303 | <command>ant <option>target</option></command>: This reads the file
|
---|
[ba7be716] | 304 | <filename>build.xml</filename> and builds the target: <option>compile
|
---|
| 305 | </option> compiles the java sources, <option>jar-main</option> generates
|
---|
[bf7a1821] | 306 | jar archives, <option>jar-hyphenation</option> generates the hyphenation
|
---|
[bba3fd3] | 307 | patterns for FOP, <option>junit</option> runs the
|
---|
| 308 | <application>junit</application> tests, and <option>javadocs</option>
|
---|
| 309 | builds the documentation. The <option>all</option> target runs all of the
|
---|
| 310 | above.
|
---|
[6fe6db6] | 311 | </para>
|
---|
[f570280] | 312 |
|
---|
[6fe6db6] | 313 | <para>
|
---|
| 314 | <command>ln -v -sf fop-&fop-version; /opt/fop</command>: This is
|
---|
| 315 | optional and creates a convenience symlink so that
|
---|
| 316 | <envar>$FOP_HOME</envar> doesn't have to be changed each time there's a
|
---|
| 317 | package version change.
|
---|
| 318 | </para>
|
---|
[f570280] | 319 |
|
---|
| 320 | </sect2>
|
---|
| 321 |
|
---|
| 322 | <sect2 role="configuration">
|
---|
[75d53372] | 323 | <title>Configuring fop</title>
|
---|
[f570280] | 324 |
|
---|
| 325 | <sect3 id="fop-config">
|
---|
| 326 | <title>Config Files</title>
|
---|
| 327 |
|
---|
[6fe6db6] | 328 | <para>
|
---|
| 329 | <filename>~/.foprc</filename>
|
---|
| 330 | </para>
|
---|
[f570280] | 331 |
|
---|
| 332 | <indexterm zone="fop fop-config">
|
---|
| 333 | <primary sortas="e-AA.foprc">~/.foprc</primary>
|
---|
| 334 | </indexterm>
|
---|
| 335 |
|
---|
| 336 | </sect3>
|
---|
| 337 |
|
---|
| 338 | <sect3>
|
---|
| 339 | <title>Configuration Information</title>
|
---|
| 340 |
|
---|
[6fe6db6] | 341 | <para>
|
---|
| 342 | Using <application>fop</application> to process some large FO's
|
---|
| 343 | (including the FO derived from the BLFS XML sources), can lead to
|
---|
| 344 | memory errors. Unless you add a parameter to the
|
---|
| 345 | <command>java</command> command used in the <command>fop</command>
|
---|
| 346 | script you may receive messages similar to the one shown below:
|
---|
| 347 | </para>
|
---|
[f570280] | 348 |
|
---|
[6fe6db6] | 349 | <para>
|
---|
| 350 | <computeroutput>
|
---|
| 351 | Exception in thread "main" java.lang.OutOfMemoryError: Java heap
|
---|
| 352 | space
|
---|
| 353 | </computeroutput>
|
---|
| 354 | </para>
|
---|
[f570280] | 355 |
|
---|
[6fe6db6] | 356 | <para>
|
---|
| 357 | To avoid errors like this, you need to pass an extra parameter to
|
---|
| 358 | the <command>java</command> command used in the <command>fop</command>
|
---|
| 359 | script. This can be accomplished by creating a
|
---|
| 360 | <filename>~/.foprc</filename> (which is sourced by the
|
---|
| 361 | <command>fop</command> script) and adding the parameter to the
|
---|
| 362 | <envar>FOP_OPTS</envar> environment variable.
|
---|
| 363 | </para>
|
---|
[f570280] | 364 |
|
---|
[6fe6db6] | 365 | <para>
|
---|
| 366 | The <command>fop</command> script looks for a
|
---|
| 367 | <envar>FOP_HOME</envar> environment variable to locate the
|
---|
| 368 | <application>fop</application> class libraries. You can create this
|
---|
| 369 | variable using the <filename>~/.foprc</filename> file as well. Create
|
---|
| 370 | a <filename>~/.foprc</filename> file using the following commands:
|
---|
| 371 | </para>
|
---|
[f570280] | 372 |
|
---|
| 373 | <screen><userinput>cat > ~/.foprc << "EOF"
|
---|
[977061b0] | 374 | <literal>FOP_OPTS="-Xmx<replaceable><RAM_Installed></replaceable>m"
|
---|
[f570280] | 375 | FOP_HOME="/opt/fop"</literal>
|
---|
| 376 | EOF</userinput></screen>
|
---|
| 377 |
|
---|
[6fe6db6] | 378 | <para>
|
---|
| 379 | Replace <replaceable><RAM_Installed></replaceable> with a
|
---|
| 380 | number representing the amount of RAM installed in your computer (in
|
---|
| 381 | megabytes). An example would be
|
---|
| 382 | <userinput>FOP_OPTS="-Xmx768m"</userinput>.
|
---|
| 383 | <!-- the URL is broken
|
---|
| 384 | For more information about
|
---|
| 385 | memory issues running <application>fop</application>, see
|
---|
| 386 | <ulink url="http://xml.apache.org/fop/running.html#memory"/>.
|
---|
| 387 | -->
|
---|
[a754ee2b] | 388 | </para>
|
---|
[f570280] | 389 |
|
---|
[6fe6db6] | 390 | <para>
|
---|
| 391 | To include the <command>fop</command> script in your path,
|
---|
[d61ead0a] | 392 | update the system-wide profile with the following command as the
|
---|
| 393 | <systemitem class="username">root</systemitem> user:
|
---|
[6fe6db6] | 394 | </para>
|
---|
[f570280] | 395 |
|
---|
[866f38b] | 396 | <screen role="root"><userinput>cat > /etc/profile.d/fop.sh << "EOF"
|
---|
| 397 | <literal># Begin /etc/profile.d/fop.sh
|
---|
[d61ead0a] | 398 |
|
---|
| 399 | pathappend /opt/fop
|
---|
| 400 |
|
---|
[866f38b] | 401 | # End /etc/profile.d/fop.sh</literal>
|
---|
| 402 | EOF</userinput></screen>
|
---|
[f570280] | 403 |
|
---|
[6fe6db6] | 404 | <note>
|
---|
| 405 | <para>
|
---|
| 406 | Running <command>fop</command> can be somewhat verbose.
|
---|
| 407 | The default logging level can be changed from INFO to any of
|
---|
| 408 | FINEST, FINER, FINE, CONFIG, INFO, WARNING, SEVERE, ALL, or OFF.
|
---|
| 409 | To do this, edit
|
---|
| 410 | <filename>$JAVA_HOME/jre/lib/logging.properties</filename> and change
|
---|
[ba7be716] | 411 | the entries for <option>.level</option> and
|
---|
[6fe6db6] | 412 | <option>java.util.logging.ConsoleHandler.level</option> to
|
---|
| 413 | the desired value.
|
---|
| 414 | </para>
|
---|
| 415 | </note>
|
---|
[cbfc7b61] | 416 |
|
---|
[f570280] | 417 | </sect3>
|
---|
| 418 |
|
---|
| 419 | </sect2>
|
---|
| 420 |
|
---|
| 421 | <sect2 role="content">
|
---|
| 422 | <title>Contents</title>
|
---|
| 423 |
|
---|
| 424 | <segmentedlist>
|
---|
| 425 | <segtitle>Installed Programs</segtitle>
|
---|
| 426 | <segtitle>Installed Libraries</segtitle>
|
---|
| 427 | <segtitle>Installed Directory</segtitle>
|
---|
| 428 |
|
---|
| 429 | <seglistitem>
|
---|
[492000e] | 430 | <seg>fop</seg>
|
---|
| 431 | <seg>fop.jar and numerous support library classes located in
|
---|
[4c24eb0a] | 432 | <filename class="directory">/opt/fop/{build,lib}</filename>; JAI
|
---|
[492000e] | 433 | components include libmlib_jai.so, jai_codec.jar, jai_core.jar, and
|
---|
[f570280] | 434 | mlibwrapper_jai.jar</seg>
|
---|
| 435 | <seg>/opt/fop-&fop-version;</seg>
|
---|
| 436 | </seglistitem>
|
---|
| 437 | </segmentedlist>
|
---|
| 438 |
|
---|
| 439 | <variablelist>
|
---|
| 440 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 441 | <?dbfo list-presentation="list"?>
|
---|
| 442 | <?dbhtml list-presentation="table"?>
|
---|
| 443 |
|
---|
[492000e] | 444 | <varlistentry id="fop-prog">
|
---|
| 445 | <term><command>fop</command></term>
|
---|
[f570280] | 446 | <listitem>
|
---|
[fa3edfef] | 447 | <para>
|
---|
| 448 | is a wrapper script to the <command>java</command> command
|
---|
[6f6f731] | 449 | which sets up the <application>fop</application>
|
---|
[4c24eb0a] | 450 | environment and passes the required parameters
|
---|
[fa3edfef] | 451 | </para>
|
---|
[492000e] | 452 | <indexterm zone="fop fop-prog">
|
---|
| 453 | <primary sortas="b-fop">fop</primary>
|
---|
[f570280] | 454 | </indexterm>
|
---|
| 455 | </listitem>
|
---|
| 456 | </varlistentry>
|
---|
| 457 |
|
---|
| 458 | <varlistentry id="fop.jar">
|
---|
[4c24eb0a] | 459 | <term><filename class="libraryfile">fop.jar</filename></term>
|
---|
[f570280] | 460 | <listitem>
|
---|
[fa3edfef] | 461 | <para>
|
---|
| 462 | contains all the <application>fop</application>
|
---|
[e3b75e18] | 463 | <application>Java</application> classes
|
---|
[fa3edfef] | 464 | </para>
|
---|
[f570280] | 465 | <indexterm zone="fop fop.jar">
|
---|
| 466 | <primary sortas="c-fop.jar">fop.jar</primary>
|
---|
| 467 | </indexterm>
|
---|
| 468 | </listitem>
|
---|
| 469 | </varlistentry>
|
---|
| 470 |
|
---|
| 471 | </variablelist>
|
---|
| 472 |
|
---|
| 473 | </sect2>
|
---|
| 474 |
|
---|
| 475 | </sect1>
|
---|