source: general/graphlib/poppler.xml@ 7c796f6

12.1 ken/TL2024 lazarus rahul/power-profiles-daemon trunk xry111/llvm18
Last change on this file since 7c796f6 was ab4fdfc, checked in by Pierre Labastie <pierre.labastie@…>, 5 months ago

Change all xml decl to encoding=utf-8
  • Property mode set to 100644
File size: 16.9 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 "dfbd19dc807ca0155f39009de4ffc044">
10 <!ENTITY poppler-size "1.8 MB">
11 <!ENTITY poppler-buildsize "92 MB (with Qt5 library; add 13 MB for tests)">
12 <!ENTITY poppler-time "0.8 SBU (with parallelism=4 and Qt5 library; add 3.8 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 &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 <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 </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 <xref linkend="qt6" role="nodep"/>.
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,
298 libpoppler-qt5.so, and
299 (optionally) libpoppler-qt6.so
300 </seg>
301 <seg>
302 /usr/include/poppler,
303 /usr/share/poppler, and
304 /usr/share/doc/poppler-&poppler-version;
305 </seg>
306 </seglistitem>
307 </segmentedlist>
308
309 <variablelist>
310 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
311 <?dbfo list-presentation="list"?>
312 <?dbhtml list-presentation="table"?>
313
314 <varlistentry id="pdfattach">
315 <term><command>pdfattach</command></term>
316 <listitem>
317 <para>
318 adds a new embedded file to an existing PDF file
319 </para>
320 <indexterm zone="poppler pdfattach">
321 <primary sortas="b-pdfattach">pdfattach</primary>
322 </indexterm>
323 </listitem>
324 </varlistentry>
325
326 <varlistentry id="pdfdetach">
327 <term><command>pdfdetach</command></term>
328 <listitem>
329 <para>
330 lists or extracts embedded files from PDF files
331 </para>
332 <indexterm zone="poppler pdfdetach">
333 <primary sortas="b-pdfdetach">pdfdetach</primary>
334 </indexterm>
335 </listitem>
336 </varlistentry>
337
338 <varlistentry id="pdffonts">
339 <term><command>pdffonts</command></term>
340 <listitem>
341 <para>
342 lists the fonts used in a PDF file along with various information
343 for each font
344 </para>
345 <indexterm zone="poppler pdffonts">
346 <primary sortas="b-pdffonts">pdffonts</primary>
347 </indexterm>
348 </listitem>
349 </varlistentry>
350
351 <varlistentry id="pdfimages">
352 <term><command>pdfimages</command></term>
353 <listitem>
354 <para>
355 saves images from a PDF file as PPM, PBM, or JPEG files
356 </para>
357 <indexterm zone="poppler pdfimages">
358 <primary sortas="b-pdfimages">pdfimages</primary>
359 </indexterm>
360 </listitem>
361 </varlistentry>
362
363 <varlistentry id="pdfinfo">
364 <term><command>pdfinfo</command></term>
365 <listitem>
366 <para>
367 prints the contents of the 'Info' dictionary (plus some other useful
368 information) from a PDF file
369 </para>
370 <indexterm zone="poppler pdfinfo">
371 <primary sortas="b-pdfinfo">pdfinfo</primary>
372 </indexterm>
373 </listitem>
374 </varlistentry>
375
376 <varlistentry id="pdfseparate">
377 <term><command>pdfseparate</command></term>
378 <listitem>
379 <para>
380 extracts single pages from a PDF file
381 </para>
382 <indexterm zone="poppler pdfseparate">
383 <primary sortas="b-pdseparate">pdfseparate</primary>
384 </indexterm>
385 </listitem>
386 </varlistentry>
387
388 <varlistentry id="pdfsig">
389 <term><command>pdfsig</command></term>
390 <listitem>
391 <para>
392 verifies the digital signatures in a PDF document
393 </para>
394 <indexterm zone="poppler pdfsig">
395 <primary sortas="b-pdseparate">pdfsig</primary>
396 </indexterm>
397 </listitem>
398 </varlistentry>
399
400 <varlistentry id="pdftocairo">
401 <term><command>pdftocairo</command></term>
402 <listitem>
403 <para>
404 converts a PDF file to one of several formats (PNG, JPEG, PDF, PS,
405 EPS, SVG) using the cairo output device of the poppler library
406 </para>
407 <indexterm zone="poppler pdftocairo">
408 <primary sortas="b-pdftocairo">pdftocairo</primary>
409 </indexterm>
410 </listitem>
411 </varlistentry>
412
413 <varlistentry id="pdftohtml">
414 <term><command>pdftohtml</command></term>
415 <listitem>
416 <para>
417 converts a PDF file to HTML
418 </para>
419 <indexterm zone="poppler pdftohtml">
420 <primary sortas="b-pdftohtml">pdftohtml</primary>
421 </indexterm>
422 </listitem>
423 </varlistentry>
424
425 <varlistentry id="pdftoppm">
426 <term><command>pdftoppm</command></term>
427 <listitem>
428 <para>
429 converts PDF files to PBM, PGM and PPM formats
430 </para>
431 <indexterm zone="poppler pdftoppm">
432 <primary sortas="b-pdftoppm">pdftoppm</primary>
433 </indexterm>
434 </listitem>
435 </varlistentry>
436
437 <varlistentry id="pdftops">
438 <term><command>pdftops</command></term>
439 <listitem>
440 <para>
441 converts PDF files to Postscript format
442 </para>
443 <indexterm zone="poppler pdftops">
444 <primary sortas="b-pdftops">pdftops</primary>
445 </indexterm>
446 </listitem>
447 </varlistentry>
448
449 <varlistentry id="pdftotext">
450 <term><command>pdftotext</command></term>
451 <listitem>
452 <para>
453 converts PDF files to plain text
454 </para>
455 <indexterm zone="poppler pdftotext">
456 <primary sortas="b-pdftotext">pdftotext</primary>
457 </indexterm>
458 </listitem>
459 </varlistentry>
460
461 <varlistentry id="pdfunite">
462 <term><command>pdfunite</command></term>
463 <listitem>
464 <para>
465 merges several PDF files, in the order of their occurrence on the
466 command line, to one PDF output file
467 </para>
468 <indexterm zone="poppler pdfunite">
469 <primary sortas="b-pdfunite">pdfunite</primary>
470 </indexterm>
471 </listitem>
472 </varlistentry>
473
474 <varlistentry id="libpoppler">
475 <term><filename class="libraryfile">libpoppler.so</filename></term>
476 <listitem>
477 <para>
478 contains the API functions to render PDF files
479 </para>
480 <indexterm zone="poppler libpoppler">
481 <primary sortas="c-libpoppler">libpoppler.so</primary>
482 </indexterm>
483 </listitem>
484 </varlistentry>
485
486 <varlistentry id="libpoppler-cpp">
487 <term><filename class="libraryfile">libpoppler-cpp.so</filename></term>
488 <listitem>
489 <para>
490 is a C++ backend for rendering PDF files
491 </para>
492 <indexterm zone="poppler libpoppler-cpp">
493 <primary sortas="c-libpoppler-cpp">libpoppler-cpp.so</primary>
494 </indexterm>
495 </listitem>
496 </varlistentry>
497
498 <varlistentry id="libpoppler-glib">
499 <term><filename class="libraryfile">libpoppler-glib.so</filename></term>
500 <listitem>
501 <para>
502 is a wrapper library used to interface the PDF rendering functions
503 with <application>GTK+</application>
504 </para>
505 <indexterm zone="poppler libpoppler-glib">
506 <primary sortas="c-libpoppler-glib">libpoppler-glib.so</primary>
507 </indexterm>
508 </listitem>
509 </varlistentry>
510
511 <varlistentry id="libpoppler-qt5">
512 <term><filename class="libraryfile">libpoppler-qt5.so</filename></term>
513 <listitem>
514 <para>
515 is a wrapper library used to interface the PDF rendering functions
516 with <application>Qt</application>5
517 </para>
518 <indexterm zone="poppler libpoppler-qt5">
519 <primary sortas="c-libpoppler-qt5">libpoppler-qt5.so</primary>
520 </indexterm>
521 </listitem>
522 </varlistentry>
523
524 <varlistentry id="libpoppler-qt6">
525 <term><filename class="libraryfile">libpoppler-qt6.so</filename></term>
526 <listitem>
527 <para>
528 is a wrapper library used to interface the PDF rendering functions
529 with <application>Qt</application>6
530 </para>
531 <indexterm zone="poppler libpoppler-qt6">
532 <primary sortas="c-libpoppler-qt6">libpoppler-qt6.so</primary>
533 </indexterm>
534 </listitem>
535 </varlistentry>
536
537 </variablelist>
538
539 </sect2>
540
541</sect1>
Note: See TracBrowser for help on using the repository browser.