source: general/graphlib/poppler.xml@ 34165e6b

12.1 ken/TL2024 ken/tuningfonts lazarus plabs/newcss python3.11 rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18
Last change on this file since 34165e6b was a923f8df, checked in by Bruce Dubbs <bdubbs@…>, 7 months ago

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