source: pst/ps/fop.xml@ d260aaf4

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 12.2 6.0 6.1 6.2 6.2.0 6.2.0-rc1 6.2.0-rc2 6.3 6.3-rc1 6.3-rc2 6.3-rc3 7.10 7.4 7.5 7.6 7.6-blfs 7.6-systemd 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind gimp3 gnome kde5-13430 kde5-14269 kde5-14686 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts krejzi/svn lazarus lxqt nosym perl-modules plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition systemd-11177 systemd-13485 trunk upgradedb xry111/for-12.3 xry111/intltool xry111/llvm18 xry111/soup3 xry111/spidermonkey128 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since d260aaf4 was d260aaf4, checked in by Randy McMurchy <randy@…>, 20 years ago

Separated root installation commands in packages already indexed (first pass)

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@3363 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 13.9 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
3 "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY fop-download-http "http://www.apache.org/dist/xml/fop/fop-&fop-version;-src.tar.gz">
8 <!ENTITY fop-download-ftp "ftp://apache.mirrors.pair.com/xml/fop/source/fop-&fop-version;-src.tar.gz">
9 <!ENTITY fop-md5sum "1a31eb1357e5d4b8d32d4cb3edae2da2">
10 <!ENTITY fop-size "7.8 MB">
11 <!ENTITY fop-buildsize "45.3 MB">
12 <!ENTITY fop-time "0.25 SBU">
13]>
14
15<sect1 id="fop" xreflabel="FOP-&fop-version;">
16<sect1info>
17<othername>$LastChangedBy$</othername>
18<date>$Date$</date>
19</sect1info>
20<?dbhtml filename="fop.html"?>
21<title><application><acronym>FOP</acronym></application>-&fop-version;</title>
22<indexterm zone="fop">
23<primary sortas="a-FOP">FOP</primary></indexterm>
24
25<sect2>
26<title>Introduction to <application><acronym>FOP</acronym></application></title>
27
28<para>The <application><acronym>FOP</acronym></application> (Formatting
29Objects Processor) package contains a print formatter driven by
30<acronym>XSL</acronym> formatting objects
31(<acronym>XSL</acronym>-<acronym>FO</acronym>). It is a
32<application>Java</application> application that reads a formatting object
33tree and renders the resulting pages to a specified output. Output formats
34currently supported include <acronym>PDF</acronym>, <acronym>PCL</acronym>,
35PostScript, <acronym>SVG</acronym>, <acronym>XML</acronym> (area tree
36representation), print, <acronym>AWT</acronym>, <acronym>MIF</acronym> and
37<acronym>ASCII</acronym> text. The primary output target is
38<acronym>PDF</acronym>.</para>
39
40<sect3><title>Package information</title>
41<itemizedlist spacing="compact">
42<listitem><para>Download (HTTP):
43<ulink url="&fop-download-http;"/></para></listitem>
44<listitem><para>Download (FTP):
45<ulink url="&fop-download-ftp;"/></para></listitem>
46<listitem><para>Download MD5 sum:
47&fop-md5sum;</para></listitem>
48<listitem><para>Download size:
49&fop-size;</para></listitem>
50<listitem><para>Estimated disk space required:
51&fop-buildsize;</para></listitem>
52<listitem><para>Estimated build time:
53&fop-time;</para></listitem></itemizedlist>
54</sect3>
55
56<sect3><title>Additional downloads</title>
57<itemizedlist spacing="compact">
58<listitem><para><application>Java</application> Advanced Imaging
59(<acronym>JAI</acronym>) <acronym>API</acronym> components: <ulink
60url="http://javashoplm.sun.com/ECom/docs/Welcome.jsp?StoreId=22&amp;PartDetailId=jai-1_1_2_01-oth-JPR&amp;SiteId=JSC&amp;TransactionId=noreg">
61http://javashoplm.sun.com/ECom/docs/Welcome.jsp?StoreId=22&amp;</ulink>
62<ulink
63url="http://javashoplm.sun.com/ECom/docs/Welcome.jsp?StoreId=22&amp;PartDetailId=jai-1_1_2_01-oth-JPR&amp;SiteId=JSC&amp;TransactionId=noreg">
64PartDetailId=jai-1_1_2_01-oth-JPR&amp;SiteId=JSC&amp;TransactionId=noreg
65</ulink></para>
66</listitem></itemizedlist>
67<para>Choose the <quote><application>Linux</application>
68<application><acronym>JDK</acronym></application> Install</quote> file after
69accepting the license agreement.</para>
70</sect3>
71
72<sect3><title><application>FOP</application> dependencies</title>
73<sect4><title>Required</title>
74<para><xref linkend="j2sdk"/></para>
75</sect4>
76
77<sect4><title>Optional</title>
78<para><xref linkend="libxslt"/>,
79<ulink url="http://java.sun.com/products/jimi/">JIMI SDK</ulink>,
80<ulink url="http://xml.apache.org/batik/">Batik</ulink> and
81<ulink url="http://forrest.apache.org/">Forrest</ulink> (only used to rebuild
82the documentation)</para>
83</sect4>
84</sect3>
85
86</sect2>
87
88<sect2>
89<title>Installation of <application>FOP</application></title>
90
91<note><para>Ensure <envar>$JAVA_HOME</envar> is set correctly before beginning
92the build. Additionally, the build will fail if your version of the
93<acronym>JDK</acronym> is higher than 1.4.2_x.</para></note>
94
95<para>Some versions of tar will display a message similar to
96<quote><computeroutput>tar: A lone zero block at 33476</computeroutput></quote>
97when unpacking the source tarball. You may safely ignore this message.</para>
98
99<sect3><title>Installing <acronym>JAI</acronym></title>
100<para>Install the <acronym>JAI</acronym> components by running the following
101commands as the root user while in the root of the
102<application><acronym>FOP</acronym></application> source tree:</para>
103
104<screen><userinput role='root'><command>chmod 755 ../jai-1_1_2_01-lib-linux-i586-jdk.bin &amp;&amp;
105FOP_BUILD_DIR=$(pwd) &amp;&amp;
106cd $JAVA_HOME &amp;&amp;
107yes | $FOP_BUILD_DIR/../jai-1_1_2_01-lib-linux-i586-jdk.bin &amp;&amp;
108cd $FOP_BUILD_DIR</command></userinput></screen>
109</sect3>
110
111<sect3><title>Installing <application><acronym>FOP</acronym></application>
112required components</title>
113<para>Install <application><acronym>FOP</acronym></application> by running the
114following commands:</para>
115
116<screen><userinput><command>./build.sh &amp;&amp;
117sed -i -e "s/build/lib/" fop.sh</command></userinput></screen>
118
119<para>Now, as the root user:</para>
120
121<screen><userinput role='root'><command>install -v -d -m755 \
122 /opt/fop-&fop-version;/{bin,lib,docs/{general,lib,site}} &amp;&amp;
123install -v -m755 fop.sh /opt/fop-&fop-version;/bin &amp;&amp;
124install -v -m644 build/fop.jar lib/avalon-framework-cvs-20020806.jar \
125 /opt/fop-&fop-version;/lib &amp;&amp;
126install -v -m644 docs/* /opt/fop-&fop-version;/docs &amp;&amp;
127install -v -m644 CHANGES LICENSE README ReleaseNotes.html STATUS \
128 /opt/fop-&fop-version;/docs/general &amp;&amp;
129install -v -m644 lib/{avalon.LICENSE.txt,readme} \
130 /opt/fop-&fop-version;/docs/lib &amp;&amp;
131cp -v -R build/site/* /opt/fop-&fop-version;/docs/site &amp;&amp;
132ln -svf fop-&fop-version; /opt/fop</command></userinput></screen>
133</sect3>
134
135<sect3><title>Installing the <application>Batik</application>
136<acronym>JAR</acronym></title>
137<para>You'll need to install one additional <application>Java</application>
138class library to process <acronym>SVG</acronym> objects. This library is part
139of the <ulink url="http://xml.apache.org/batik/">Batik</ulink> package, but is
140also included with the <application><acronym>FOP</acronym></application>
141package. If you have <application>Batik</application> installed, ensure the
142<filename>batik.jar</filename> library is included in your
143<envar>$CLASSPATH</envar> environment variable. Alternatively, create a
144symbolic link from <filename>/opt/fop-&fop-version;/lib/batik.jar</filename>
145pointing to the full path of the installed <filename>batik.jar</filename>
146file so that the <command>fop.sh</command> script will automatically pick it
147up.</para>
148
149<para>If you don't have the <application>Batik</application> package installed,
150run the following commands as the root user:</para>
151
152<screen><userinput role='root'><command>install -v -m644 lib/batik.jar /opt/fop-&fop-version;/lib &amp;&amp;
153install -v -m644 lib/batik.LICENSE.txt \
154 /opt/fop-&fop-version;/docs/lib</command></userinput></screen>
155</sect3>
156
157<sect3><title>Installing the <application>Xalan-Java</application>
158components</title>
159<para>The components of <application><acronym>FOP</acronym></application>
160required to process <acronym>FO</acronym> files created by an
161<acronym>XSL</acronym> transformation engine (also known as an
162<acronym>XSLT</acronym> processor) is now complete. An
163<acronym>XSL</acronym> transformation engine (<command>xsltproc</command>)
164is included with the <xref linkend="libxslt"/> package in
165<acronym>BLFS</acronym>. The <application><acronym>FOP</acronym></application>
166package includes components of
167<ulink url="http://xml.apache.org/xalan-j/">Xalan-Java</ulink> to accomplish
168<acronym>XSL</acronym> transformations. If you have the
169<application>Xalan-Java</application> package installed, skip to the next
170section.</para>
171
172<para>If you wish to install the <application>Xalan-Java</application>
173components provided by the <application><acronym>FOP</acronym></application>
174package, run the following commands as the root user:</para>
175
176<screen><userinput role='root'><command>sed -i -e "s/build/lib/" xalan.sh &amp;&amp;
177install -v -m755 xalan.sh /opt/fop-&fop-version;/bin &amp;&amp;
178install -v -m644 lib/xml-apis.jar \
179 lib/xercesImpl-2.2.1.jar \
180 lib/xalan-2.4.1.jar \
181 /opt/fop-&fop-version;/lib &amp;&amp;
182install -v -m644 lib/{xml-apis,xerces,xalan}.LICENSE.txt \
183 lib/xml-apis.README.txt \
184 /opt/fop-&fop-version;/docs/lib</command></userinput></screen>
185</sect3>
186
187<sect3><title>Installing the
188<application>Jimi <acronym>SDK</acronym></application>
189<acronym>JAR</acronym></title>
190<para>If you installed the Java Image I/O class library
191(<application>Jimi <acronym>SDK</acronym></application>) into the
192<application><acronym>FOP</acronym></application> source tree
193<filename class='directory'>lib</filename> directory before building
194<application><acronym>FOP</acronym></application> (this will enable Jimi
195support), ensure you also install this <acronym>JAR</acronym> file into
196<filename class='directory'>/opt/fop-&fop-version;/lib</filename>.</para>
197</sect3>
198
199</sect2>
200
201<sect2>
202<title>Command explanations</title>
203
204<para><command>yes | $FOP_BUILD_DIR/../jai-...-jdk.bin</command>: This command
205installs the <application><acronym>JAI</acronym></application> components
206into the <application><acronym>JDK</acronym></application> file structure. The
207<command>yes</command> command is piped through so that you don't have to
208scroll through four pages of the license agreement and automatically responds
209<quote>yes</quote> to the agreement. <envar>$FOP_BUILD_DIR</envar> is used as
210a reference point to the source executable and as a method to return back to
211the <application><acronym>FOP</acronym></application> source tree.</para>
212
213<para><command>sed -i -e "s/build/lib/" ...</command>: These commands modify
214the installed shell scripts so that the location of the installed
215<filename>fop.jar</filename> file is correctly identified.</para>
216
217<para><command>install -v ...; cp -v ...</command>: There is no installation
218script provided by the <application><acronym>FOP</acronym></application>
219package. These commands install the package.</para>
220
221<para><command>ln -svf fop-&fop-version; /opt/fop</command>: This creates a
222convenience symlink so that <envar>$FOP_HOME</envar> doesn't have to be
223changed each time there's a package version change.</para>
224</sect2>
225
226<sect2>
227<title>Configuring <application>FOP</application></title>
228
229<sect3 id="fop-config"><title>Config files</title>
230<para><filename>~/.foprc</filename></para>
231<indexterm zone="fop fop-config">
232<primary sortas="e-AA.foprc">~/.foprc</primary></indexterm>
233</sect3>
234
235<sect3><title>Configuration Information</title>
236
237<para>Using <application><acronym>FOP</acronym></application> to process some
238large <acronym>FO</acronym>'s (including the <acronym>FO</acronym> derived from
239the <acronym>BLFS</acronym> <acronym>XML</acronym> sources), can lead to memory
240errors. Unless you add a parameter to the <command>java</command> command used
241in the <command>fop.sh</command> script you may receive messages similar to the
242one shown below:</para>
243
244<para><computeroutput>Exception in thread "main" java.lang.OutOfMemoryError:
245Java heap space</computeroutput></para>
246
247<para>To avoid errors like this, you need to pass an extra parameter to the
248<command>java</command> command used in the <command>fop.sh</command> script.
249This can be accomplished by creating a <filename>~/.foprc</filename> (which
250is sourced by the <command>fop.sh</command> script) and adding the parameter
251to the <envar>FOP_OPTS</envar> environment variable.</para>
252
253<para>The <command>fop.sh</command> script looks for a <envar>FOP_HOME</envar>
254environment variable to locate the
255<application><acronym>FOP</acronym></application> class libraries. You can
256create this variable using the <filename>~/.foprc</filename> file as
257well. Create a <filename>~/.foprc</filename> file using the following
258commands:</para>
259
260<screen><userinput><command>cat &gt; ~/.foprc &lt;&lt; "EOF"</command>
261FOP_OPTS="-Xmx<replaceable>[RAM_Installed]</replaceable>m"
262FOP_HOME="/opt/fop"
263
264<command>EOF</command></userinput></screen>
265
266<para>Replace <replaceable>[RAM_Installed]</replaceable> with a number
267representing the amount of RAM installed in your computer. An example would
268be <userinput>FOP_OPTS="-Xmx768m"</userinput>. For more information about
269memory issues running <application><acronym>FOP</acronym></application>, see
270<ulink url="http://xml.apache.org/fop/running.html#memory"/>.</para>
271
272<para>To include the <command>fop.sh</command> script in your path, update
273your personal or system-wide profile with the following:</para>
274
275<screen><userinput>PATH=$PATH:/opt/fop/bin</userinput></screen>
276</sect3>
277
278</sect2>
279
280<sect2>
281<title>Contents</title>
282
283<segmentedlist>
284<segtitle>Installed Programs</segtitle>
285<segtitle>Installed Libraries</segtitle>
286<segtitle>Installed Directory</segtitle>
287<seglistitem>
288<seg>fop.sh and xalan.sh</seg>
289<seg>avalon-framework-cvs-20020806.jar, batik.jar, fop.jar, xalan-2.4.1.jar,
290xercesImpl-2.2.1.jar and xml-apis.jar. <acronym>JAI</acronym> components
291include libmlib_jai.so, jai_codec.jar, jai_core.jar and
292mlibwrapper_jai.jar</seg>
293<seg>/opt/fop-&fop-version;</seg>
294</seglistitem>
295</segmentedlist>
296
297<variablelist>
298<bridgehead renderas="sect3">Short Descriptions</bridgehead>
299<?dbfo list-presentation="list"?>
300
301<varlistentry id="fop.sh">
302<term><command>fop.sh</command></term>
303<listitem><para>is a wrapper script to the <command>java</command> command
304which sets up the <application><acronym>FOP</acronym></application>
305environment and passes the required parameters.</para>
306<indexterm zone="fop fop.sh">
307<primary sortas="b-fop.sh">fop.sh</primary></indexterm>
308</listitem>
309</varlistentry>
310
311<varlistentry id="fop.jar">
312<term><filename class='libraryfile'>fop.jar</filename></term>
313<listitem><para>contains all the
314<application><acronym>FOP</acronym></application>
315<application>Java</application> classes.</para>
316<indexterm zone="fop fop.jar">
317<primary sortas="c-fop.jar">fop.jar</primary></indexterm>
318</listitem>
319</varlistentry>
320</variablelist>
321
322</sect2>
323
324</sect1>
325
Note: See TracBrowser for help on using the repository browser.