source: general/graphlib/poppler.xml@ 8bb50b80

plabs/python-mods qt5new trunk
Last change on this file since 8bb50b80 was 8bb50b80, checked in by Xi Ruoyao <xry111@…>, 4 months ago

poppler: use https for testfile

Using https can avoid MIM attack (though I don't think a MIM attack
against test files is really useful), and ease the set up of proxy if
one is needed.

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