mirror of
https://github.com/Zeckmathederg/glfs.git
synced 2025-01-26 08:42:12 +08:00
6634def275
git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@17032 af4574ff-66df-0310-9fd7-8a98e5e911e0
411 lines
14 KiB
XML
411 lines
14 KiB
XML
<?xml version="1.0" encoding="ISO-8859-1"?>
|
|
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
|
<!ENTITY % general-entities SYSTEM "../../general.ent">
|
|
%general-entities;
|
|
|
|
<!ENTITY fop-download-http "https://archive.apache.org/dist/xmlgraphics/fop/source/fop-&fop-version;-src.tar.gz">
|
|
<!ENTITY fop-download-ftp " ">
|
|
<!ENTITY fop-md5sum "13b5b497dfb0ba8a01093dfc1a89d106">
|
|
<!ENTITY fop-size "23 MB">
|
|
<!ENTITY fop-buildsize "342 MB">
|
|
<!ENTITY fop-time "0.3 SBU">
|
|
|
|
<!ENTITY jai-version "1_1_3">
|
|
<!ENTITY jai-download "http://download.java.net/media/jai/builds/release/&jai-version;/jai-&jai-version;-lib-linux-i586.tar.gz">
|
|
<!ENTITY jai-md5sum "a2cbc155ef3899bcde9c74a8035764b3">
|
|
<!ENTITY jai-size "3.4 MB">
|
|
|
|
<!ENTITY jai64-download "http://download.java.net/media/jai/builds/release/&jai-version;/jai-&jai-version;-lib-linux-amd64.tar.gz">
|
|
<!ENTITY jai64-md5sum "4a906db35612f668aeef2c0606d7075b">
|
|
<!ENTITY jai64-size "3.4 MB">
|
|
<!--
|
|
<!ENTITY offo-download "&sourceforge-repo;/offo/offo-hyphenation_v2.0.zip">
|
|
<!ENTITY offo-md5sum "a78171d47c9af223c51bbd42df36f26d">
|
|
<!ENTITY offo-size "858 KB">
|
|
-->
|
|
]>
|
|
|
|
<sect1 id="fop" xreflabel="fop-&fop-version;">
|
|
<?dbhtml filename="fop.html"?>
|
|
|
|
<sect1info>
|
|
<othername>$LastChangedBy$</othername>
|
|
<date>$Date$</date>
|
|
</sect1info>
|
|
|
|
<title>fop-&fop-version;</title>
|
|
|
|
<indexterm zone="fop">
|
|
<primary sortas="a-fop">fop</primary>
|
|
</indexterm>
|
|
|
|
<sect2 role="package">
|
|
<title>Introduction to fop</title>
|
|
|
|
<para>
|
|
The <application>FOP</application> (Formatting Objects Processor)
|
|
package contains a print formatter driven by XSL formatting objects
|
|
(XSL-FO). It is a <application>Java</application> application that reads
|
|
a formatting object tree and renders the resulting pages to a specified
|
|
output. Output formats currently supported include PDF, PCL, PostScript,
|
|
SVG, XML (area tree representation), print, AWT, MIF and ASCII text. The
|
|
primary output target is PDF.
|
|
</para>
|
|
|
|
&lfs79_checked;
|
|
|
|
<bridgehead renderas="sect3">Package Information</bridgehead>
|
|
<itemizedlist spacing="compact">
|
|
<listitem>
|
|
<para>Download (HTTP): <ulink url="&fop-download-http;"/></para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Download (FTP): <ulink url="&fop-download-ftp;"/></para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Download MD5 sum: &fop-md5sum;</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Download size: &fop-size;</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Estimated disk space required: &fop-buildsize;</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Estimated build time: &fop-time;</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
|
|
<bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
|
<itemizedlist spacing="compact">
|
|
<title>Recommended packages</title>
|
|
|
|
<!--
|
|
<listitem>
|
|
<para>Objects for Formatting Objects (OFFO) hyphenation patterns:
|
|
<simplelist>
|
|
<member><ulink url="&offo-download;"/></member>
|
|
<member>&offo-md5sum;</member>
|
|
<member>&offo-size;</member>
|
|
</simplelist>
|
|
</para>
|
|
</listitem>
|
|
-->
|
|
<listitem>
|
|
<para>Java Advanced Imaging (JAI) API components (architecture dependent):
|
|
<simplelist>
|
|
<member><ulink url="&jai-download;"/></member>
|
|
<member>&jai-md5sum;</member>
|
|
<member>&jai-size;</member>
|
|
</simplelist>
|
|
<literallayout>or</literallayout> <!-- Force some space -->
|
|
<simplelist>
|
|
<member><ulink url="&jai64-download;"/></member>
|
|
<member>&jai64-md5sum;</member>
|
|
<member>&jai64-size;</member>
|
|
</simplelist>
|
|
</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
<itemizedlist spacing="compact">
|
|
<title>Required patch</title>
|
|
<listitem>
|
|
<para>
|
|
<ulink url="&patch-root;/fop-&fop-version;-listNPE-1.patch"/>
|
|
</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
|
|
<bridgehead renderas="sect3">fop Dependencies</bridgehead>
|
|
|
|
<bridgehead renderas="sect4">Required</bridgehead>
|
|
<para role="required">
|
|
<xref linkend="apache-ant"/>
|
|
</para>
|
|
|
|
<bridgehead renderas="sect4">Optional</bridgehead>
|
|
<para role="optional">
|
|
<xref linkend="junit"/> (to run tests),
|
|
<xref linkend="x-window-system"/> (to run tests),
|
|
<ulink url="http://www.oracle.com/technetwork/java/javasebusiness/downloads/java-archive-downloads-java-client-419417.html">JIMI SDK</ulink>,
|
|
<ulink url="http://www.xmlunit.org/">XMLUnit</ulink>,
|
|
<ulink url="https://java.net/projects/jai-imageio">JAI Image I/O Tools</ulink>,
|
|
<ulink url="http://jeuclid.sourceforge.net/">JEuclid</ulink>,
|
|
<ulink url="https://pmd.github.io/">PMD</ulink>
|
|
(requires <ulink url="http://jaxen.org/">Jaxen</ulink>), and
|
|
<ulink url="http://forrest.apache.org/">Forrest</ulink> (Forrest used only
|
|
to build the documentation)
|
|
</para>
|
|
|
|
<para condition="html" role="usernotes">User Notes:
|
|
<ulink url="&blfs-wiki;/fop"/></para>
|
|
|
|
</sect2>
|
|
|
|
<sect2 role="installation">
|
|
<title>Installation of fop</title>
|
|
|
|
<para>
|
|
Ensure <envar>$JAVA_HOME</envar> is set correctly before beginning
|
|
the build. To build the <application>JIMI SDK</application> and/or
|
|
<application>XMLUnit</application> extension classes, ensure the
|
|
corresponding <filename class='extension'>.jar</filename> files can be
|
|
found via the <envar>CLASSPATH</envar> environment variable.
|
|
</para>
|
|
<!--
|
|
<sect3>
|
|
<title>Installing OFFO Hyphenation Patterns</title>
|
|
|
|
<para>
|
|
First, unpack the <application>fop</application> source tarball and
|
|
the hyphenation zipfile from the same directory, then change directories
|
|
into the root of the <application>fop</application> source tree. Copy
|
|
the XML hyphenation patterns into the <application>fop</application>
|
|
source tree by running the following commands:
|
|
</para>
|
|
|
|
<screen><userinput>cp ../offo-hyphenation/hyph/* hyph &&
|
|
rm -rf ../offo-hyphenation</userinput></screen>
|
|
|
|
</sect3>
|
|
-->
|
|
<sect3>
|
|
<title>Installing Java Advanced Imaging (JAI) API components</title>
|
|
|
|
<para>
|
|
Install the JAI API components. As the <systemitem
|
|
class="username">root</systemitem> user:
|
|
</para>
|
|
|
|
<screen role="root"><userinput>case `uname -m` in
|
|
i?86)
|
|
tar -xf ../jai-&jai-version;-lib-linux-i586.tar.gz
|
|
cp -v jai-&jai-version;/lib/{jai*,mlibwrapper_jai.jar} $JAVA_HOME/jre/lib/ext/
|
|
cp -v jai-&jai-version;/lib/libmlib_jai.so $JAVA_HOME/jre/lib/i386/
|
|
;;
|
|
|
|
x86_64)
|
|
tar -xf ../jai-&jai-version;-lib-linux-amd64.tar.gz
|
|
cp -v jai-&jai-version;/lib/{jai*,mlibwrapper_jai.jar} $JAVA_HOME/jre/lib/ext/
|
|
cp -v jai-&jai-version;/lib/libmlib_jai.so $JAVA_HOME/jre/lib/amd64/
|
|
;;
|
|
esac</userinput></screen>
|
|
</sect3>
|
|
|
|
<sect3>
|
|
<title>Installing fop Components</title>
|
|
|
|
<para>
|
|
The <command>javadoc</command> command coming with OpenJDK 8 has
|
|
become much stricter than before regarding the conformance of the
|
|
Javadoc comments in source code to HTML. The FOP documentation does
|
|
not meet those standard, so the conformance checks have to be
|
|
disabled. This can be done with the following command:
|
|
</para>
|
|
|
|
<screen><userinput>sed -i '\@</javad@i<arg value="-Xdoclint:none"/>' build.xml</userinput></screen>
|
|
|
|
<para>
|
|
Then, compile <application>fop</application> by running the
|
|
following commands:
|
|
</para>
|
|
|
|
<screen><userinput>patch -Np1 -i ../fop-&fop-version;-listNPE-1.patch &&
|
|
|
|
ant compile &&
|
|
ant jar-main &&
|
|
ant javadocs &&
|
|
mv build/javadocs .</userinput></screen>
|
|
|
|
<!-- ant docs target is not present anymore in fop-2.0
|
|
<para>
|
|
If <application>Forrest</application> is installed,
|
|
build the full set of documentation:
|
|
</para>
|
|
|
|
<screen><userinput>ant docs</userinput></screen>
|
|
-->
|
|
<para>
|
|
To test the application, run <command>ant junit-all</command>. The
|
|
hyphenation tests will fail. To see a list of other test targets, use
|
|
<command>ant -p</command>. You must run the tests from an X-window using
|
|
a GL-aware <application>Xorg</application> server or some of the
|
|
<application>JUnit</application> tests will hang.
|
|
</para>
|
|
|
|
<para>
|
|
Now, as the <systemitem class="username">root</systemitem> user:
|
|
</para>
|
|
|
|
<screen role="root"><userinput>install -v -d -m755 /opt/fop-&fop-version; &&
|
|
cp -v KEYS LICENSE NOTICE README /opt/fop-&fop-version; &&
|
|
cp -va build conf examples fop* javadocs lib /opt/fop-&fop-version; &&
|
|
|
|
ln -v -sf fop-&fop-version; /opt/fop</userinput></screen>
|
|
|
|
</sect3>
|
|
|
|
</sect2>
|
|
|
|
<sect2 role="commands">
|
|
<title>Command Explanations</title>
|
|
|
|
<para>
|
|
<command>ant <option>target</option></command>: This reads the file
|
|
<filename>build.xml</filename> and builds the target files.
|
|
</para>
|
|
|
|
<para>
|
|
<command>ln -v -sf fop-&fop-version; /opt/fop</command>: This is
|
|
optional and creates a convenience symlink so that
|
|
<envar>$FOP_HOME</envar> doesn't have to be changed each time there's a
|
|
package version change.
|
|
</para>
|
|
|
|
</sect2>
|
|
|
|
<sect2 role="configuration">
|
|
<title>Configuring fop</title>
|
|
|
|
<sect3 id="fop-config">
|
|
<title>Config Files</title>
|
|
|
|
<para>
|
|
<filename>~/.foprc</filename>
|
|
</para>
|
|
|
|
<indexterm zone="fop fop-config">
|
|
<primary sortas="e-AA.foprc">~/.foprc</primary>
|
|
</indexterm>
|
|
|
|
</sect3>
|
|
|
|
<sect3>
|
|
<title>Configuration Information</title>
|
|
|
|
<para>
|
|
Using <application>fop</application> to process some large FO's
|
|
(including the FO derived from the BLFS XML sources), can lead to
|
|
memory errors. Unless you add a parameter to the
|
|
<command>java</command> command used in the <command>fop</command>
|
|
script you may receive messages similar to the one shown below:
|
|
</para>
|
|
|
|
<para>
|
|
<computeroutput>
|
|
Exception in thread "main" java.lang.OutOfMemoryError: Java heap
|
|
space
|
|
</computeroutput>
|
|
</para>
|
|
|
|
<para>
|
|
To avoid errors like this, you need to pass an extra parameter to
|
|
the <command>java</command> command used in the <command>fop</command>
|
|
script. This can be accomplished by creating a
|
|
<filename>~/.foprc</filename> (which is sourced by the
|
|
<command>fop</command> script) and adding the parameter to the
|
|
<envar>FOP_OPTS</envar> environment variable.
|
|
</para>
|
|
|
|
<para>
|
|
The <command>fop</command> script looks for a
|
|
<envar>FOP_HOME</envar> environment variable to locate the
|
|
<application>fop</application> class libraries. You can create this
|
|
variable using the <filename>~/.foprc</filename> file as well. Create
|
|
a <filename>~/.foprc</filename> file using the following commands:
|
|
</para>
|
|
|
|
<screen><userinput>cat > ~/.foprc << "EOF"
|
|
<literal>FOP_OPTS="-Xmx<replaceable><RAM_Installed></replaceable>m"
|
|
FOP_HOME="/opt/fop"</literal>
|
|
EOF</userinput></screen>
|
|
|
|
<para>
|
|
Replace <replaceable><RAM_Installed></replaceable> with a
|
|
number representing the amount of RAM installed in your computer (in
|
|
megabytes). An example would be
|
|
<userinput>FOP_OPTS="-Xmx768m"</userinput>.
|
|
<!-- the URL is broken
|
|
For more information about
|
|
memory issues running <application>fop</application>, see
|
|
<ulink url="http://xml.apache.org/fop/running.html#memory"/>.
|
|
-->
|
|
</para>
|
|
|
|
<para>
|
|
To include the <command>fop</command> script in your path,
|
|
update your personal or system-wide profile with the following:
|
|
</para>
|
|
|
|
<screen><literal>PATH=$PATH:/opt/fop</literal></screen>
|
|
|
|
<note>
|
|
<para>
|
|
Running <command>fop</command> can be somewhat verbose.
|
|
The default logging level can be changed from INFO to any of
|
|
FINEST, FINER, FINE, CONFIG, INFO, WARNING, SEVERE, ALL, or OFF.
|
|
To do this, edit
|
|
<filename>$JAVA_HOME/jre/lib/logging.properties</filename> and change
|
|
the entries for <option>.leval</option> and
|
|
<option>java.util.logging.ConsoleHandler.level</option> to
|
|
the desired value.
|
|
</para>
|
|
</note>
|
|
|
|
</sect3>
|
|
|
|
</sect2>
|
|
|
|
<sect2 role="content">
|
|
<title>Contents</title>
|
|
|
|
<segmentedlist>
|
|
<segtitle>Installed Programs</segtitle>
|
|
<segtitle>Installed Libraries</segtitle>
|
|
<segtitle>Installed Directory</segtitle>
|
|
|
|
<seglistitem>
|
|
<seg>fop</seg>
|
|
<seg>fop.jar and numerous support library classes located in
|
|
<filename class='directory'>/opt/fop/{build,lib}</filename>; JAI
|
|
components include libmlib_jai.so, jai_codec.jar, jai_core.jar, and
|
|
mlibwrapper_jai.jar</seg>
|
|
<seg>/opt/fop-&fop-version;</seg>
|
|
</seglistitem>
|
|
</segmentedlist>
|
|
|
|
<variablelist>
|
|
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
|
<?dbfo list-presentation="list"?>
|
|
<?dbhtml list-presentation="table"?>
|
|
|
|
<varlistentry id="fop-prog">
|
|
<term><command>fop</command></term>
|
|
<listitem>
|
|
<para>is a wrapper script to the <command>java</command> command
|
|
which sets up the <application>fop</application>
|
|
environment and passes the required parameters.</para>
|
|
<indexterm zone="fop fop-prog">
|
|
<primary sortas="b-fop">fop</primary>
|
|
</indexterm>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry id="fop.jar">
|
|
<term><filename class='libraryfile'>fop.jar</filename></term>
|
|
<listitem>
|
|
<para>contains all the <application>fop</application>
|
|
<application>Java</application> classes.</para>
|
|
<indexterm zone="fop fop.jar">
|
|
<primary sortas="c-fop.jar">fop.jar</primary>
|
|
</indexterm>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
</sect2>
|
|
|
|
</sect1>
|