source: general/graphlib/poppler.xml@ 14891a90

12.0 12.1 kea ken/TL2024 ken/tuningfonts lazarus lxqt plabs/newcss python3.11 rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/xf86-video-removal
Last change on this file since 14891a90 was 14891a90, checked in by Xi Ruoyao <xry111@…>, 11 months ago

treewide: More "User Notes" clean up

Remove links to pages w/o real contents.
  • Property mode set to 100644
File size: 16.5 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 "088f9f2c6730f93a62aa6b46a6f0a6bf">
10 <!ENTITY poppler-size "1.8 MB">
11 <!ENTITY poppler-buildsize "91 MB (with Qt5 library and tests)">
12 <!ENTITY poppler-time "0.7 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 &lfs113_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="lcms2"/>,
132 <xref linkend="libjpeg"/>,
133 <xref linkend="libpng"/>,
134 <xref linkend="nss"/>, and
135 <xref linkend="openjpeg2"/>
136 </para>
137
138 <bridgehead renderas="sect4">Optional</bridgehead>
139 <para role="optional">
140 <xref linkend="curl"/>,
141 <xref linkend="gdk-pixbuf"/>,
142 <xref linkend="git"/> (for downloading test files),
143 <xref linkend="gpgme"/>,
144 <xref linkend="gtk-doc"/>,
145 <xref linkend="gtk3"/>,
146 <xref linkend="libtiff"/>,
147 <xref linkend="qt5"/>
148 (required for PDF support in <xref role="nodep" linkend="okular5"/>), and
149 <ulink url="https://download.qt.io/archive/qt/">Qt-6.1 or later</ulink>.
150
151 </para>
152
153 </sect2>
154
155 <sect2 role="installation">
156 <title>Installation of Poppler</title>
157
158 <!-- remove when version is gtr 23.06.0 -->
159 <!-- missing incl is fixed upstream already -->
160 <para>
161 First add a missing include statement which will break compilation
162 on 32-bit systems:
163 </para>
164
165<screen><userinput>sed -e '/#include "GPGMECryptoSignBackend.h"/i#include &lt;config.h&gt;' \
166 -i poppler/GPGMECryptoSignBackend.cc</userinput></screen>
167 <!-- /remove -->
168
169 <para>
170 Install <application>Poppler</application> by running the following
171 commands:
172 </para>
173
174<screen><userinput>mkdir build &amp;&amp;
175cd build &amp;&amp;
176
177cmake -DCMAKE_BUILD_TYPE=Release \
178 -DCMAKE_INSTALL_PREFIX=/usr \
179 -DTESTDATADIR=$PWD/testfiles \
180 -DENABLE_UNSTABLE_API_ABI_HEADERS=ON \
181 .. &amp;&amp;
182make</userinput></screen>
183
184 <para>
185 In order to run the test suite, some testcases are needed and can
186 be obtained only from a git repository. The command to download
187 them is:
188<command>git clone --depth 1 https://gitlab.freedesktop.org/poppler/test.git testfiles</command>.
189 Then issue: <command>LC_ALL=en_US.UTF-8 make test</command>.
190 </para>
191
192 <para>
193 Now, as the <systemitem class="username">root</systemitem> user:
194 </para>
195
196<screen role="root"><userinput>make install</userinput></screen>
197<!-- Seems makeinstall does the job now:
198 <para>
199 If you have Qt installed, again as the
200 <systemitem class="username">root</systemitem> user:
201 </para>
202
203<screen role="root"><userinput>make -C qt5 install &amp;&amp;
204install -m644 poppler-qt5.pc /usr/lib/pkgconfig</userinput></screen>
205-->
206 <para>
207 To install the documentation, run the following commands as
208 <systemitem class="username">root</systemitem>:
209 </para>
210
211<screen role="root"><userinput>install -v -m755 -d /usr/share/doc/poppler-&poppler-version; &amp;&amp;
212cp -vr ../glib/reference/html /usr/share/doc/poppler-&poppler-version;</userinput></screen>
213
214<!-- ==== Poppler Data ====== -->
215 <bridgehead renderas="sect3">Poppler Data</bridgehead>
216
217 <para>
218 If you downloaded the additional encoding data package, install it by
219 issuing the following commands:
220 </para>
221
222<screen><userinput>tar -xf ../../poppler-data-&poppler-data-version;.tar.gz &amp;&amp;
223cd poppler-data-&poppler-data-version;</userinput></screen>
224
225 <para>
226 Now, as the <systemitem class="username">root</systemitem> user:
227 </para>
228
229<screen role="root"><userinput>make prefix=/usr install</userinput></screen>
230
231 </sect2>
232
233 <sect2 role="commands">
234 <title>Command Explanations</title>
235
236 <para>
237 <parameter>-DCMAKE_BUILD_TYPE=Release</parameter>: This switch is used
238 to apply a higher level of compiler optimizations.
239 </para>
240
241 <para>
242 <parameter>-DTESTDATADIR=$PWD/testfiles</parameter>: Tells the test
243 programs where the auxiliary files are located.
244 </para>
245
246 <para>
247 <parameter>-DENABLE_UNSTABLE_API_ABI_HEADERS=ON</parameter>: Installs some old
248 <application>Xpdf</application> headers required by certain programs.
249 <!--(e.g. <application>Inkscape</application>).-->
250 </para>
251
252<!-- This was broken for me - Bruce
253 Still broken with 0.69.0 - Doug
254 Seems to work with 0.73.0 - Pierre
255 Works with 20.09.0 but without the
256 sed -i '1s/python/&3/' make-glib-api-docs
257 and pygments is required - Thomas
258-->
259 <para>
260 <option>-DENABLE_GTK_DOC=ON</option>: Use this parameter if
261 GTK-Doc <!--and Pygments--> is installed and you wish to rebuild and
262 install the API documentation.
263 </para>
264
265 <para>
266 <option>-DENABLE_BOOST=OFF</option>: Use this parameter if you have
267 not installed <application>boost</application> (the Splash backend for
268 Qt5 recommends boost).
269 </para>
270
271 <para>
272 <command>LC_ALL=en_US.UTF-8 make test</command>: Runs the test suite.
273 The environment variable LC_ALL=en_US.UTF-8 is only needed if the
274 default locale does not include UTF-8.
275 </para>
276
277 </sect2>
278
279 <sect2 role="content">
280 <title>Contents</title>
281
282 <segmentedlist>
283 <segtitle>Installed Programs</segtitle>
284 <segtitle>Installed Libraries</segtitle>
285 <segtitle>Installed Directories</segtitle>
286
287 <seglistitem>
288 <seg>
289 pdfattach, pdfdetach, pdffonts, pdfimages, pdfinfo, pdfseparate,
290 pdfsig, pdftocairo, pdftohtml, pdftoppm, pdftops, pdftotext, and
291 pdfunite
292 </seg>
293 <seg>
294 libpoppler.so,
295 libpoppler-cpp.so,
296 libpoppler-glib.so, and
297 libpoppler-qt5.so
298 </seg>
299 <seg>
300 /usr/include/poppler,
301 /usr/share/poppler, and
302 /usr/share/doc/poppler-&poppler-version;
303 </seg>
304 </seglistitem>
305 </segmentedlist>
306
307 <variablelist>
308 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
309 <?dbfo list-presentation="list"?>
310 <?dbhtml list-presentation="table"?>
311
312 <varlistentry id="pdfattach">
313 <term><command>pdfattach</command></term>
314 <listitem>
315 <para>
316 adds a new embedded file to an existing PDF file
317 </para>
318 <indexterm zone="poppler pdfattach">
319 <primary sortas="b-pdfattach">pdfattach</primary>
320 </indexterm>
321 </listitem>
322 </varlistentry>
323
324 <varlistentry id="pdfdetach">
325 <term><command>pdfdetach</command></term>
326 <listitem>
327 <para>
328 lists or extracts embedded files from PDF files
329 </para>
330 <indexterm zone="poppler pdfdetach">
331 <primary sortas="b-pdfdetach">pdfdetach</primary>
332 </indexterm>
333 </listitem>
334 </varlistentry>
335
336 <varlistentry id="pdffonts">
337 <term><command>pdffonts</command></term>
338 <listitem>
339 <para>
340 lists the fonts used in a PDF file along with various information
341 for each font
342 </para>
343 <indexterm zone="poppler pdffonts">
344 <primary sortas="b-pdffonts">pdffonts</primary>
345 </indexterm>
346 </listitem>
347 </varlistentry>
348
349 <varlistentry id="pdfimages">
350 <term><command>pdfimages</command></term>
351 <listitem>
352 <para>
353 saves images from a PDF file as PPM, PBM, or JPEG files
354 </para>
355 <indexterm zone="poppler pdfimages">
356 <primary sortas="b-pdfimages">pdfimages</primary>
357 </indexterm>
358 </listitem>
359 </varlistentry>
360
361 <varlistentry id="pdfinfo">
362 <term><command>pdfinfo</command></term>
363 <listitem>
364 <para>
365 prints the contents of the 'Info' dictionary (plus some other useful
366 information) from a PDF file
367 </para>
368 <indexterm zone="poppler pdfinfo">
369 <primary sortas="b-pdfinfo">pdfinfo</primary>
370 </indexterm>
371 </listitem>
372 </varlistentry>
373
374 <varlistentry id="pdfseparate">
375 <term><command>pdfseparate</command></term>
376 <listitem>
377 <para>
378 extracts single pages from a PDF file
379 </para>
380 <indexterm zone="poppler pdfseparate">
381 <primary sortas="b-pdseparate">pdfseparate</primary>
382 </indexterm>
383 </listitem>
384 </varlistentry>
385
386 <varlistentry id="pdfsig">
387 <term><command>pdfsig</command></term>
388 <listitem>
389 <para>
390 verifies the digital signatures in a PDF document
391 </para>
392 <indexterm zone="poppler pdfsig">
393 <primary sortas="b-pdseparate">pdfsig</primary>
394 </indexterm>
395 </listitem>
396 </varlistentry>
397
398 <varlistentry id="pdftocairo">
399 <term><command>pdftocairo</command></term>
400 <listitem>
401 <para>
402 converts a PDF file to one of several formats (PNG, JPEG, PDF, PS,
403 EPS, SVG) using the cairo output device of the poppler library
404 </para>
405 <indexterm zone="poppler pdftocairo">
406 <primary sortas="b-pdftocairo">pdftocairo</primary>
407 </indexterm>
408 </listitem>
409 </varlistentry>
410
411 <varlistentry id="pdftohtml">
412 <term><command>pdftohtml</command></term>
413 <listitem>
414 <para>
415 converts a PDF file to HTML
416 </para>
417 <indexterm zone="poppler pdftohtml">
418 <primary sortas="b-pdftohtml">pdftohtml</primary>
419 </indexterm>
420 </listitem>
421 </varlistentry>
422
423 <varlistentry id="pdftoppm">
424 <term><command>pdftoppm</command></term>
425 <listitem>
426 <para>
427 converts PDF files to PBM, PGM and PPM formats
428 </para>
429 <indexterm zone="poppler pdftoppm">
430 <primary sortas="b-pdftoppm">pdftoppm</primary>
431 </indexterm>
432 </listitem>
433 </varlistentry>
434
435 <varlistentry id="pdftops">
436 <term><command>pdftops</command></term>
437 <listitem>
438 <para>
439 converts PDF files to Postscript format
440 </para>
441 <indexterm zone="poppler pdftops">
442 <primary sortas="b-pdftops">pdftops</primary>
443 </indexterm>
444 </listitem>
445 </varlistentry>
446
447 <varlistentry id="pdftotext">
448 <term><command>pdftotext</command></term>
449 <listitem>
450 <para>
451 converts PDF files to plain text
452 </para>
453 <indexterm zone="poppler pdftotext">
454 <primary sortas="b-pdftotext">pdftotext</primary>
455 </indexterm>
456 </listitem>
457 </varlistentry>
458
459 <varlistentry id="pdfunite">
460 <term><command>pdfunite</command></term>
461 <listitem>
462 <para>
463 merges several PDF files, in the order of their occurrence on the
464 command line, to one PDF output file
465 </para>
466 <indexterm zone="poppler pdfunite">
467 <primary sortas="b-pdfunite">pdfunite</primary>
468 </indexterm>
469 </listitem>
470 </varlistentry>
471
472 <varlistentry id="libpoppler">
473 <term><filename class="libraryfile">libpoppler.so</filename></term>
474 <listitem>
475 <para>
476 contains the API functions to render PDF files
477 </para>
478 <indexterm zone="poppler libpoppler">
479 <primary sortas="c-libpoppler">libpoppler.so</primary>
480 </indexterm>
481 </listitem>
482 </varlistentry>
483
484 <varlistentry id="libpoppler-cpp">
485 <term><filename class="libraryfile">libpoppler-cpp.so</filename></term>
486 <listitem>
487 <para>
488 is a C++ backend for rendering PDF files
489 </para>
490 <indexterm zone="poppler libpoppler-cpp">
491 <primary sortas="c-libpoppler-cpp">libpoppler-cpp.so</primary>
492 </indexterm>
493 </listitem>
494 </varlistentry>
495
496 <varlistentry id="libpoppler-glib">
497 <term><filename class="libraryfile">libpoppler-glib.so</filename></term>
498 <listitem>
499 <para>
500 is a wrapper library used to interface the PDF rendering functions
501 with <application>GTK+</application>
502 </para>
503 <indexterm zone="poppler libpoppler-glib">
504 <primary sortas="c-libpoppler-glib">libpoppler-glib.so</primary>
505 </indexterm>
506 </listitem>
507 </varlistentry>
508
509 <varlistentry id="libpoppler-qt5">
510 <term><filename class="libraryfile">libpoppler-qt5.so</filename></term>
511 <listitem>
512 <para>
513 is a wrapper library used to interface the PDF rendering functions
514 with <application>Qt</application>5
515 </para>
516 <indexterm zone="poppler libpoppler-qt5">
517 <primary sortas="c-libpoppler-qt5">libpoppler-qt5.so</primary>
518 </indexterm>
519 </listitem>
520 </varlistentry>
521
522 </variablelist>
523
524 </sect2>
525
526</sect1>
Note: See TracBrowser for help on using the repository browser.