source: general/graphlib/poppler.xml@ dd26d4d

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

Add role="nodep"

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

  • Property mode set to 100644
File size: 15.3 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 role="nodep" 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</userinput></screen>
191
192 <para>
193 If you have Qt installed, again as the
194 <systemitem class="username">root</systemitem> user:
195 </para>
196
197<screen role="root"><userinput>make -C qt5 install &amp;&amp;
198install -m644 poppler-qt5.pc usr/lib/pkgconfig</userinput></screen>
199
200 <para>
201 To install the documentation, run the following commands as
202 <systemitem class="username">root</systemitem>:
203 </para>
204
205<screen role="root"><userinput>install -v -m755 -d /usr/share/doc/poppler-&poppler-version; &amp;&amp;
206cp -vr glib/reference/html /usr/share/doc/poppler-&poppler-version;</userinput></screen>
207
208<!-- ==== Poppler Data ====== -->
209 <bridgehead renderas="sect3">Poppler Data</bridgehead>
210
211 <para>
212 If you downloaded the additional encoding data package, install it by
213 issuing the following commands:
214 </para>
215
216<screen><userinput>tar -xf ../poppler-data-&poppler-data-version;.tar.gz &amp;&amp;
217cd poppler-data-&poppler-data-version;</userinput></screen>
218
219 <para>
220 Now, as the <systemitem class="username">root</systemitem> user:
221 </para>
222
223<screen role="root"><userinput>make prefix=/usr install</userinput></screen>
224
225 </sect2>
226
227 <sect2 role="commands">
228 <title>Command Explanations</title>
229
230 <para>
231 <parameter>-DCMAKE_BUILD_TYPE=Release</parameter>: This switch is used
232 to apply a higher level of compiler optimizations.
233 </para>
234
235 <para>
236 <parameter>-DTESTDATADIR=$PWD/testfiles</parameter>: Tell the test
237 programs where the auxiliary files are located.
238 </para>
239
240 <para>
241 <parameter>-DENABLE_XPDF_HEADERS=ON</parameter>: Install some old
242 <application>Xpdf</application> headers required by certain programs (e.g.
243 <application>Okular</application>, <application>LibreOffice</application>
244 and <application>Inkscape</application>).
245 </para>
246
247 <para>
248 <option>-DENABLE_GTK_DOC=ON</option>: Use this parameter if
249 GTK-Doc is installed and you wish to rebuild and install
250 the API documentation.
251 </para>
252
253 <para>
254 <command>LC_ALL=en_US.UTF-8 make check</command>: Run the test suite.
255 The environment variable LC_ALL=en_US.UTF-8 is only needed if the
256 default locale does not include UTF-8.
257 </para>
258
259 </sect2>
260
261 <sect2 role="content">
262 <title>Contents</title>
263
264 <segmentedlist>
265 <segtitle>Installed Programs</segtitle>
266 <segtitle>Installed Libraries</segtitle>
267 <segtitle>Installed Directories</segtitle>
268
269 <seglistitem>
270 <seg>
271 pdfdetach, pdffonts, pdfimages, pdfinfo, pdfseparate, pdfsig,
272 pdftocairo, pdftohtml, pdftoppm, pdftops, pdftotext, and
273 pdfunite
274 </seg>
275 <seg>
276 libpoppler.so,
277 libpoppler-cpp.so,
278 libpoppler-glib.so, and
279 libpoppler-qt5.so
280 </seg>
281 <seg>
282 /usr/include/poppler and
283 /usr/share/gtk-doc/poppler
284 </seg>
285 </seglistitem>
286 </segmentedlist>
287
288 <variablelist>
289 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
290 <?dbfo list-presentation="list"?>
291 <?dbhtml list-presentation="table"?>
292
293 <varlistentry id="pdfdetach">
294 <term><command>pdfdetach</command></term>
295 <listitem>
296 <para>
297 lists or extracts embedded files from PDF files.
298 </para>
299 <indexterm zone="poppler pdfdetach">
300 <primary sortas="b-pdfdetach">pdfdetach</primary>
301 </indexterm>
302 </listitem>
303 </varlistentry>
304
305 <varlistentry id="pdffonts">
306 <term><command>pdffonts</command></term>
307 <listitem>
308 <para>
309 lists the fonts used in a PDF file along with various information
310 for each font.
311 </para>
312 <indexterm zone="poppler pdffonts">
313 <primary sortas="b-pdffonts">pdffonts</primary>
314 </indexterm>
315 </listitem>
316 </varlistentry>
317
318 <varlistentry id="pdfimages">
319 <term><command>pdfimages</command></term>
320 <listitem>
321 <para>
322 saves images from a PDF file as PPM, PBM, or JPEG files.
323 </para>
324 <indexterm zone="poppler pdfimages">
325 <primary sortas="b-pdfimages">pdfimages</primary>
326 </indexterm>
327 </listitem>
328 </varlistentry>
329
330 <varlistentry id="pdfinfo">
331 <term><command>pdfinfo</command></term>
332 <listitem>
333 <para>
334 prints the contents of the 'Info' dictionary (plus some other useful
335 information) from a PDF file.
336 </para>
337 <indexterm zone="poppler pdfinfo">
338 <primary sortas="b-pdfinfo">pdfinfo</primary>
339 </indexterm>
340 </listitem>
341 </varlistentry>
342
343 <varlistentry id="pdfseparate">
344 <term><command>pdfseparate</command></term>
345 <listitem>
346 <para>
347 extracts single pages from a PDF file.
348 </para>
349 <indexterm zone="poppler pdfseparate">
350 <primary sortas="b-pdseparate">pdfseparate</primary>
351 </indexterm>
352 </listitem>
353 </varlistentry>
354
355 <varlistentry id="pdfsig">
356 <term><command>pdfsig</command></term>
357 <listitem>
358 <para>
359 verifies the digital signatures in a PDF document.
360 </para>
361 <indexterm zone="poppler pdfsig">
362 <primary sortas="b-pdseparate">pdfsig</primary>
363 </indexterm>
364 </listitem>
365 </varlistentry>
366
367 <varlistentry id="pdftocairo">
368 <term><command>pdftocairo</command></term>
369 <listitem>
370 <para>
371 converts a PDF file to one of several formats (PNG, JPEG, PDF, PS,
372 EPS, SVG) using the cairo output device of the poppler library.
373 </para>
374 <indexterm zone="poppler pdftocairo">
375 <primary sortas="b-pdftocairo">pdftocairo</primary>
376 </indexterm>
377 </listitem>
378 </varlistentry>
379
380 <varlistentry id="pdftohtml">
381 <term><command>pdftohtml</command></term>
382 <listitem>
383 <para>
384 converts a PDF file to HTML.
385 </para>
386 <indexterm zone="poppler pdftohtml">
387 <primary sortas="b-pdftohtml">pdftohtml</primary>
388 </indexterm>
389 </listitem>
390 </varlistentry>
391
392 <varlistentry id="pdftoppm">
393 <term><command>pdftoppm</command></term>
394 <listitem>
395 <para>
396 converts PDF files to PBM, PGM and PPM formats.
397 </para>
398 <indexterm zone="poppler pdftoppm">
399 <primary sortas="b-pdftoppm">pdftoppm</primary>
400 </indexterm>
401 </listitem>
402 </varlistentry>
403
404 <varlistentry id="pdftops">
405 <term><command>pdftops</command></term>
406 <listitem>
407 <para>
408 converts PDF files to Postscript format.
409 </para>
410 <indexterm zone="poppler pdftops">
411 <primary sortas="b-pdftops">pdftops</primary>
412 </indexterm>
413 </listitem>
414 </varlistentry>
415
416 <varlistentry id="pdftotext">
417 <term><command>pdftotext</command></term>
418 <listitem>
419 <para>
420 converts PDF files to plain text.
421 </para>
422 <indexterm zone="poppler pdftotext">
423 <primary sortas="b-pdftotext">pdftotext</primary>
424 </indexterm>
425 </listitem>
426 </varlistentry>
427
428 <varlistentry id="pdfunite">
429 <term><command>pdfunite</command></term>
430 <listitem>
431 <para>
432 merges several PDF files, in the order of their occurrence on the
433 command line, to one PDF output file.
434 </para>
435 <indexterm zone="poppler pdfunite">
436 <primary sortas="b-pdfunite">pdfunite</primary>
437 </indexterm>
438 </listitem>
439 </varlistentry>
440
441 <varlistentry id="libpoppler">
442 <term><filename class="libraryfile">libpoppler.so</filename></term>
443 <listitem>
444 <para>
445 contains the API functions to render PDF files.
446 </para>
447 <indexterm zone="poppler libpoppler">
448 <primary sortas="c-libpoppler">libpoppler.so</primary>
449 </indexterm>
450 </listitem>
451 </varlistentry>
452
453 <varlistentry id="libpoppler-cpp">
454 <term><filename class="libraryfile">libpoppler-cpp.so</filename></term>
455 <listitem>
456 <para>
457 is a C++ backend for rendering PDF files.
458 </para>
459 <indexterm zone="poppler libpoppler-cpp">
460 <primary sortas="c-libpoppler-cpp">libpoppler-cpp.so</primary>
461 </indexterm>
462 </listitem>
463 </varlistentry>
464
465 <varlistentry id="libpoppler-glib">
466 <term><filename class="libraryfile">libpoppler-glib.so</filename></term>
467 <listitem>
468 <para>
469 is a wrapper library used to interface the PDF rendering functions
470 with <application>GTK+</application>.
471 </para>
472 <indexterm zone="poppler libpoppler-glib">
473 <primary sortas="c-libpoppler-glib">libpoppler-glib.so</primary>
474 </indexterm>
475 </listitem>
476 </varlistentry>
477
478 <varlistentry id="libpoppler-qt5">
479 <term><filename class="libraryfile">libpoppler-qt5.so</filename></term>
480 <listitem>
481 <para>
482 is a wrapper library used to interface the PDF rendering functions
483 with <application>Qt</application>5.
484 </para>
485 <indexterm zone="poppler libpoppler-qt5">
486 <primary sortas="c-libpoppler-qt5">libpoppler-qt5.so</primary>
487 </indexterm>
488 </listitem>
489 </varlistentry>
490
491 </variablelist>
492
493 </sect2>
494
495</sect1>
Note: See TracBrowser for help on using the repository browser.