source: general/graphlib/poppler.xml@ 3f2db3a6

11.3 12.0 12.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/xf86-video-removal
Last change on this file since 3f2db3a6 was 3f2db3a6, checked in by Pierre Labastie <pierre.labastie@…>, 17 months ago

Remove sect1info tags

They only contain a date tag that is nowhere used.

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