source: general/graphlib/poppler.xml@ 538d8db

10.0 10.1 11.0 11.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind lazarus perl-modules qt5new trunk upgradedb xry111/intltool xry111/test-20220226
Last change on this file since 538d8db was 538d8db, checked in by Pierre Labastie <pieere@…>, 5 years ago

-DENABLE-GTK-DOC=ON should be optional in poppler, + cosmetic changes

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

  • Property mode set to 100644
File size: 15.1 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY poppler-download-http "https://poppler.freedesktop.org/poppler-&poppler-version;.tar.xz">
8 <!ENTITY poppler-download-ftp " ">
9 <!ENTITY poppler-md5sum "7648416d51a6e9fbc4a75b6f8b53dd7c">
10 <!ENTITY poppler-size "1.4 MB">
11 <!ENTITY poppler-buildsize "58 MB (with Qt5 library and tests)">
12 <!ENTITY poppler-time "0.5 SBU (with parallelism=4, Qt5 library, and tests)">
13
14
15 <!ENTITY poppler-data-version "0.4.8">
16
17 <!ENTITY poppler-data-download-http "https://poppler.freedesktop.org/poppler-data-&poppler-data-version;.tar.gz">
18 <!ENTITY poppler-data-md5sum "00f8989c804de84af0ba2ea629949980">
19 <!ENTITY poppler-data-size "4.1 MB">
20 <!ENTITY poppler-data-buildsize "24 MB">
21 <!ENTITY poppler-data-time "less than 0.1 SBU">
22]>
23
24<sect1 id="poppler" xreflabel="Poppler-&poppler-version;">
25 <?dbhtml filename="poppler.html"?>
26
27 <sect1info>
28 <othername>$LastChangedBy$</othername>
29 <date>$Date$</date>
30 </sect1info>
31
32 <title>Poppler-&poppler-version;</title>
33
34 <indexterm zone="poppler">
35 <primary sortas="a-Poppler">Poppler</primary>
36 </indexterm>
37
38 <sect2 role="package">
39 <title>Introduction to Poppler</title>
40
41 <para>
42 The <application>Poppler</application> package contains a PDF rendering
43 library and command line tools used to manipulate PDF files. This is
44 useful for providing PDF rendering functionality as a shared library.
45 </para>
46
47 &lfs81_checked;
48
49 <bridgehead renderas="sect3">Package Information</bridgehead>
50 <itemizedlist spacing="compact">
51 <listitem>
52 <para>
53 Download (HTTP): <ulink url="&poppler-download-http;"/>
54 </para>
55 </listitem>
56 <listitem>
57 <para>
58 Download (FTP): <ulink url="&poppler-download-ftp;"/>
59 </para>
60 </listitem>
61 <listitem>
62 <para>
63 Download MD5 sum: &poppler-md5sum;
64 </para>
65 </listitem>
66 <listitem>
67 <para>
68 Download size: &poppler-size;
69 </para>
70 </listitem>
71 <listitem>
72 <para>
73 Estimated disk space required: &poppler-buildsize;
74 </para>
75 </listitem>
76 <listitem>
77 <para>
78 Estimated build time: &poppler-time;
79 </para>
80 </listitem>
81 </itemizedlist>
82
83 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
84
85 <itemizedlist spacing="compact">
86 <title>Poppler Encoding Data</title>
87 <listitem>
88 <para>
89 Download (HTTP): <ulink url="&poppler-data-download-http;"/>
90 </para>
91 </listitem>
92 <listitem>
93 <para>
94 Download MD5 sum: &poppler-data-md5sum;
95 </para>
96 </listitem>
97 <listitem>
98 <para>
99 Download size: &poppler-data-size;
100 </para>
101 </listitem>
102 <listitem>
103 <para>
104 Estimated disk space required: &poppler-data-buildsize;
105 </para>
106 </listitem>
107 <listitem>
108 <para>
109 Estimated build time: &poppler-data-time;
110 </para>
111 </listitem>
112 </itemizedlist>
113
114 <para>
115 The additional package consists of encoding files for use with
116 <application>Poppler</application>. The encoding files are optional and
117 <application>Poppler</application> will automatically read them if they
118 are present. When installed, they enable
119 <application>Poppler</application> to render CJK and Cyrillic properly.
120 </para>
121
122 <bridgehead renderas="sect3">Poppler Dependencies</bridgehead>
123
124 <bridgehead renderas="sect4">Required</bridgehead>
125 <para role="required">
126 <xref linkend="cmake"/> and
127 <xref linkend="fontconfig"/>
128 </para>
129
130 <bridgehead renderas="sect4">Recommended</bridgehead>
131 <para role="recommended">
132 <xref linkend="cairo"/>,
133 <xref linkend="libjpeg"/>,
134 <xref linkend="libpng"/>,
135 <xref linkend="nss"/>, and
136 <xref linkend="openjpeg2"/>
137 </para>
138
139 <bridgehead renderas="sect4">Optional</bridgehead>
140 <para role="optional">
141 <xref linkend="curl"/>,
142 <xref linkend="gdk-pixbuf"/>,
143 <xref linkend="git"/> (for downloading test files),
144 <xref linkend="gobject-introspection"/>,
145 <xref linkend="gtk-doc"/>,
146 <xref linkend="gtk3"/>,
147 <xref linkend="lcms2"/>,
148 <xref linkend="libtiff"/>,
149 <xref linkend="qt5"/>
150 (required for PDF support in <xref linkend="okular5"/>)
151 </para>
152
153 <para condition="html" role="usernotes">
154 User Notes: <ulink url="&blfs-wiki;/poppler"/>
155 </para>
156 </sect2>
157
158 <sect2 role="installation">
159 <title>Installation of Poppler</title>
160
161 <para>
162 Install <application>Poppler</application> by running the following
163 commands:
164 </para>
165
166<screen><userinput>mkdir build &amp;&amp;
167cd build &amp;&amp;
168
169cmake -DCMAKE_BUILD_TYPE=Release \
170 -DCMAKE_INSTALL_PREFIX=/usr \
171 -DTESTDATADIR=$PWD/testfiles \
172 -DENABLE_XPDF_HEADERS=ON \
173<!-- -DENABLE_GTK_DOC=ON \
174--> .. &amp;&amp;
175make</userinput></screen>
176
177 <para>
178 In order to run the test suite, some testcases are needed and can
179 be obtained only from a git repository. The command to download
180 them is:
181<command>git clone git://git.freedesktop.org/git/poppler/test testfiles</command>.
182 Then issue: <command>LC_ALL=en_US.UTF-8 make check</command>.
183 Only the Qt5 libraries are tested.
184 </para>
185
186 <para>
187 Now, as the <systemitem class="username">root</systemitem> user:
188 </para>
189
190<screen role="root"><userinput>make install &amp;&amp;
191make -C qt5 install &amp;&amp;
192
193install -m644 poppler-qt5.pc usr/lib/pkgconfig</userinput></screen>
194
195 <para>
196 To install the documentation, run the following commands as
197 <systemitem class="username">root</systemitem>:
198 </para>
199
200<screen role="root"><userinput>install -v -m755 -d /usr/share/doc/poppler-&poppler-version; &amp;&amp;
201cp -vr glib/reference/html /usr/share/doc/poppler-&poppler-version;</userinput></screen>
202
203<!-- ==== Poppler Data ====== -->
204 <bridgehead renderas="sect3">Poppler Data</bridgehead>
205
206 <para>
207 If you downloaded the additional encoding data package, install it by
208 issuing the following commands:
209 </para>
210
211<screen><userinput>tar -xf ../poppler-data-&poppler-data-version;.tar.gz &amp;&amp;
212cd poppler-data-&poppler-data-version;</userinput></screen>
213
214 <para>
215 Now, as the <systemitem class="username">root</systemitem> user:
216 </para>
217
218<screen role="root"><userinput>make prefix=/usr install</userinput></screen>
219
220 </sect2>
221
222 <sect2 role="commands">
223 <title>Command Explanations</title>
224
225 <para>
226 <parameter>-DCMAKE_BUILD_TYPE=Release</parameter>: This switch is used
227 to apply a higher level of compiler optimizations.
228 </para>
229
230 <para>
231 <parameter>-DTESTDATADIR=$PWD/testfiles</parameter>: Tell the test
232 programs where the auxiliary files are located.
233 </para>
234
235 <para>
236 <parameter>-DENABLE_XPDF_HEADERS=ON</parameter>: Install some old
237 <application>Xpdf</application> headers required by certain programs (e.g.
238 <application>Okular</application>, <application>LibreOffice</application>
239 and <application>Inkscape</application>).
240 </para>
241
242 <para>
243 <option>-DENABLE_GTK_DOC=ON</option>: Use this parameter if
244 GTK-Doc is installed and you wish to rebuild and install
245 the API documentation.
246 </para>
247
248 <para>
249 <command>LC_ALL=en_US.UTF-8 make check</command>: Run the test suite.
250 The environment variable LC_ALL=en_US.UTF-8 is only needed if the
251 default locale does not include UTF-8.
252 </para>
253
254 </sect2>
255
256 <sect2 role="content">
257 <title>Contents</title>
258
259 <segmentedlist>
260 <segtitle>Installed Programs</segtitle>
261 <segtitle>Installed Libraries</segtitle>
262 <segtitle>Installed Directories</segtitle>
263
264 <seglistitem>
265 <seg>
266 pdfdetach, pdffonts, pdfimages, pdfinfo, pdfseparate, pdfsig,
267 pdftocairo, pdftohtml, pdftoppm, pdftops, pdftotext, and
268 pdfunite
269 </seg>
270 <seg>
271 libpoppler.so,
272 libpoppler-cpp.so,
273 libpoppler-glib.so, and
274 libpoppler-qt5.so
275 </seg>
276 <seg>
277 /usr/include/poppler and
278 /usr/share/gtk-doc/poppler
279 </seg>
280 </seglistitem>
281 </segmentedlist>
282
283 <variablelist>
284 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
285 <?dbfo list-presentation="list"?>
286 <?dbhtml list-presentation="table"?>
287
288 <varlistentry id="pdfdetach">
289 <term><command>pdfdetach</command></term>
290 <listitem>
291 <para>
292 lists or extracts embedded files from PDF files.
293 </para>
294 <indexterm zone="poppler pdfdetach">
295 <primary sortas="b-pdfdetach">pdfdetach</primary>
296 </indexterm>
297 </listitem>
298 </varlistentry>
299
300 <varlistentry id="pdffonts">
301 <term><command>pdffonts</command></term>
302 <listitem>
303 <para>
304 lists the fonts used in a PDF file along with various information
305 for each font.
306 </para>
307 <indexterm zone="poppler pdffonts">
308 <primary sortas="b-pdffonts">pdffonts</primary>
309 </indexterm>
310 </listitem>
311 </varlistentry>
312
313 <varlistentry id="pdfimages">
314 <term><command>pdfimages</command></term>
315 <listitem>
316 <para>
317 saves images from a PDF file as PPM, PBM, or JPEG files.
318 </para>
319 <indexterm zone="poppler pdfimages">
320 <primary sortas="b-pdfimages">pdfimages</primary>
321 </indexterm>
322 </listitem>
323 </varlistentry>
324
325 <varlistentry id="pdfinfo">
326 <term><command>pdfinfo</command></term>
327 <listitem>
328 <para>
329 prints the contents of the 'Info' dictionary (plus some other useful
330 information) from a PDF file.
331 </para>
332 <indexterm zone="poppler pdfinfo">
333 <primary sortas="b-pdfinfo">pdfinfo</primary>
334 </indexterm>
335 </listitem>
336 </varlistentry>
337
338 <varlistentry id="pdfseparate">
339 <term><command>pdfseparate</command></term>
340 <listitem>
341 <para>
342 extracts single pages from a PDF file.
343 </para>
344 <indexterm zone="poppler pdfseparate">
345 <primary sortas="b-pdseparate">pdfseparate</primary>
346 </indexterm>
347 </listitem>
348 </varlistentry>
349
350 <varlistentry id="pdfsig">
351 <term><command>pdfsig</command></term>
352 <listitem>
353 <para>
354 verifies the digital signatures in a PDF document.
355 </para>
356 <indexterm zone="poppler pdfsig">
357 <primary sortas="b-pdseparate">pdfsig</primary>
358 </indexterm>
359 </listitem>
360 </varlistentry>
361
362 <varlistentry id="pdftocairo">
363 <term><command>pdftocairo</command></term>
364 <listitem>
365 <para>
366 converts a PDF file to one of several formats (PNG, JPEG, PDF, PS,
367 EPS, SVG) using the cairo output device of the poppler library.
368 </para>
369 <indexterm zone="poppler pdftocairo">
370 <primary sortas="b-pdftocairo">pdftocairo</primary>
371 </indexterm>
372 </listitem>
373 </varlistentry>
374
375 <varlistentry id="pdftohtml">
376 <term><command>pdftohtml</command></term>
377 <listitem>
378 <para>
379 converts a PDF file to HTML.
380 </para>
381 <indexterm zone="poppler pdftohtml">
382 <primary sortas="b-pdftohtml">pdftohtml</primary>
383 </indexterm>
384 </listitem>
385 </varlistentry>
386
387 <varlistentry id="pdftoppm">
388 <term><command>pdftoppm</command></term>
389 <listitem>
390 <para>
391 converts PDF files to PBM, PGM and PPM formats.
392 </para>
393 <indexterm zone="poppler pdftoppm">
394 <primary sortas="b-pdftoppm">pdftoppm</primary>
395 </indexterm>
396 </listitem>
397 </varlistentry>
398
399 <varlistentry id="pdftops">
400 <term><command>pdftops</command></term>
401 <listitem>
402 <para>
403 converts PDF files to Postscript format.
404 </para>
405 <indexterm zone="poppler pdftops">
406 <primary sortas="b-pdftops">pdftops</primary>
407 </indexterm>
408 </listitem>
409 </varlistentry>
410
411 <varlistentry id="pdftotext">
412 <term><command>pdftotext</command></term>
413 <listitem>
414 <para>
415 converts PDF files to plain text.
416 </para>
417 <indexterm zone="poppler pdftotext">
418 <primary sortas="b-pdftotext">pdftotext</primary>
419 </indexterm>
420 </listitem>
421 </varlistentry>
422
423 <varlistentry id="pdfunite">
424 <term><command>pdfunite</command></term>
425 <listitem>
426 <para>
427 merges several PDF files, in the order of their occurrence on the
428 command line, to one PDF output file.
429 </para>
430 <indexterm zone="poppler pdfunite">
431 <primary sortas="b-pdfunite">pdfunite</primary>
432 </indexterm>
433 </listitem>
434 </varlistentry>
435
436 <varlistentry id="libpoppler">
437 <term><filename class="libraryfile">libpoppler.so</filename></term>
438 <listitem>
439 <para>
440 contains the API functions to render PDF files.
441 </para>
442 <indexterm zone="poppler libpoppler">
443 <primary sortas="c-libpoppler">libpoppler.so</primary>
444 </indexterm>
445 </listitem>
446 </varlistentry>
447
448 <varlistentry id="libpoppler-cpp">
449 <term><filename class="libraryfile">libpoppler-cpp.so</filename></term>
450 <listitem>
451 <para>
452 is a C++ backend for rendering PDF files.
453 </para>
454 <indexterm zone="poppler libpoppler-cpp">
455 <primary sortas="c-libpoppler-cpp">libpoppler-cpp.so</primary>
456 </indexterm>
457 </listitem>
458 </varlistentry>
459
460 <varlistentry id="libpoppler-glib">
461 <term><filename class="libraryfile">libpoppler-glib.so</filename></term>
462 <listitem>
463 <para>
464 is a wrapper library used to interface the PDF rendering functions
465 with <application>GTK+</application>.
466 </para>
467 <indexterm zone="poppler libpoppler-glib">
468 <primary sortas="c-libpoppler-glib">libpoppler-glib.so</primary>
469 </indexterm>
470 </listitem>
471 </varlistentry>
472
473 <varlistentry id="libpoppler-qt5">
474 <term><filename class="libraryfile">libpoppler-qt5.so</filename></term>
475 <listitem>
476 <para>
477 is a wrapper library used to interface the PDF rendering functions
478 with <application>Qt</application>5.
479 </para>
480 <indexterm zone="poppler libpoppler-qt5">
481 <primary sortas="c-libpoppler-qt5">libpoppler-qt5.so</primary>
482 </indexterm>
483 </listitem>
484 </varlistentry>
485
486 </variablelist>
487
488 </sect2>
489
490</sect1>
Note: See TracBrowser for help on using the repository browser.