source: general/graphlib/poppler.xml

trunk
Last change on this file was f403a76a, checked in by Thomas Trepl <thomas@…>, 3 weeks ago

Upgrade poppler-24.04.0

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