source: postlfs/security/gnupg2.xml@ b238fd9c

12.2 gimp3 lazarus trunk xry111/for-12.3 xry111/spidermonkey128
Last change on this file since b238fd9c was 8087ca44, checked in by Xi Ruoyao <xry111@…>, 3 months ago

gnupg2: Remove ps and dvi doc

They need non-BLFS packages and we don't keep such instructions in the
book.

  • Property mode set to 100644
File size: 17.4 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 gnupg2-download-http "&gnupg-http;/gnupg/gnupg-&gnupg2-version;.tar.bz2">
8 <!ENTITY gnupg2-download-ftp " ">
9 <!ENTITY gnupg2-md5sum "49c3534e87744e994250d37c1b43f928">
10 <!ENTITY gnupg2-size "7.6 MB">
11 <!ENTITY gnupg2-buildsize "164 MB (with tests)">
12 <!ENTITY gnupg2-time "1.2 SBU (with tests; using parallelism=4)">
13]>
14
15<sect1 id="gnupg2" xreflabel="GnuPG-&gnupg2-version;">
16 <?dbhtml filename="gnupg.html"?>
17
18
19 <title>GnuPG-&gnupg2-version;</title>
20
21 <indexterm zone="gnupg2">
22 <primary sortas="a-GnuPG">GnuPG</primary>
23 </indexterm>
24
25 <sect2 role="package">
26 <title>Introduction to GnuPG</title>
27
28 <para>
29 The <application>GnuPG</application> package is GNU's tool for
30 secure communication and data storage. It can be used to encrypt data and
31 to create digital signatures. It includes an advanced key management
32 facility and is compliant with the proposed OpenPGP Internet standard as
33 described in RFC2440 and the S/MIME standard as described by several RFCs.
34 GnuPG 2 is the stable version of GnuPG integrating support for OpenPGP and
35 S/MIME.
36 </para>
37
38 &lfs121_checked;
39
40 <bridgehead renderas="sect3">Package Information</bridgehead>
41 <itemizedlist spacing="compact">
42 <listitem>
43 <para>
44 Download (HTTP): <ulink url="&gnupg2-download-http;"/>
45 </para>
46 </listitem>
47 <listitem>
48 <para>
49 Download (FTP): <ulink url="&gnupg2-download-ftp;"/>
50 </para>
51 </listitem>
52 <listitem>
53 <para>
54 Download MD5 sum: &gnupg2-md5sum;
55 </para>
56 </listitem>
57 <listitem>
58 <para>
59 Download size: &gnupg2-size;
60 </para>
61 </listitem>
62 <listitem>
63 <para>
64 Estimated disk space required: &gnupg2-buildsize;
65 </para>
66 </listitem>
67 <listitem>
68 <para>
69 Estimated build time: &gnupg2-time;
70 </para>
71 </listitem>
72 </itemizedlist>
73
74<!--
75 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
76 <itemizedlist spacing="compact">
77 <listitem>
78 <para>
79 Required patch:
80 <ulink url="&patch-root;/gnupg-&gnupg2-version;-emacs-1.patch"/>
81 </para>
82 </listitem>
83 </itemizedlist>
84-->
85
86 <bridgehead renderas="sect3">GnuPG 2 Dependencies</bridgehead>
87
88 <bridgehead renderas="sect4">Required</bridgehead>
89 <para role="required">
90 <xref linkend="libassuan"/>,
91 <xref linkend="libgcrypt"/>,
92 <xref linkend="libksba"/>,
93 <xref linkend="npth"/>, and
94 <xref linkend="openldap"/>
95 </para>
96
97 <bridgehead renderas="sect4">Recommended</bridgehead>
98 <para role="recommended">
99 <xref linkend="gnutls"/> (required to communicate with keyservers
100 using https or hkps protocol) and
101 <xref linkend="pinentry"/> (Run-time requirement for most of
102 the package's functionality)
103 </para>
104
105 <bridgehead renderas="sect4">Optional</bridgehead>
106 <para role="optional">
107 <xref linkend="curl"/>,
108 <xref linkend="fuse3"/>,
109 <xref linkend="imagemagick"/> (for the <command>convert</command> utility,
110 used for generating the documentation),
111 <xref linkend="libusb"/>,
112 an <xref linkend="server-mail"/>,
113 <xref linkend="sqlite"/>,
114 <xref linkend="texlive"/> (or <xref linkend="tl-installer"/>),
115 <ulink url="https://mcj.sourceforge.net/">fig2dev</ulink> (for
116 generating documentation),
117 and <ulink url="https://www.chiark.greenend.org.uk/~ian/adns/">GNU
118 adns</ulink>
119 </para>
120
121
122 </sect2>
123
124 <sect2 role="installation">
125 <title>Installation of GnuPG</title>
126
127<!--
128 <para>
129 First, fix a compatibility issue with emacs:
130 </para>
131
132<screen><userinput>patch -Np1 -i ../gnupg-2.4.3-emacs-1.patch</userinput></screen>
133-->
134
135 <para>
136 Install <application>GnuPG</application> by running the following
137 commands:
138 </para>
139
140<screen><userinput>mkdir build &amp;&amp;
141cd build &amp;&amp;
142
143../configure --prefix=/usr \
144 --localstatedir=/var \
145 --sysconfdir=/etc \
146 --docdir=/usr/share/doc/gnupg-&gnupg2-version; &amp;&amp;
147make &amp;&amp;
148
149makeinfo --html --no-split -I doc -o doc/gnupg_nochunks.html ../doc/gnupg.texi &amp;&amp;
150makeinfo --plaintext -I doc -o doc/gnupg.txt ../doc/gnupg.texi &amp;&amp;
151make -C doc html</userinput></screen>
152
153 <para>
154 If you have <xref linkend="texlive"/>
155 installed and you wish to create documentation in the pdf format,
156 issue the following command:
157 </para>
158
159<screen remap="doc"><userinput>make -C doc pdf</userinput></screen>
160
161 <para>
162 To test the results, issue: <command>make check</command>.
163 </para>
164
165 <para>
166 <!--
167 Note that if you have already installed
168 <application>GnuPG</application>, the instructions below will overwrite
169 <filename>/usr/share/man/man1/gpg-zip.1</filename>.
170 -->
171 Now, as the <systemitem class="username">root</systemitem> user:
172 </para>
173
174<screen role="root"><userinput>make install &amp;&amp;
175
176install -v -m755 -d /usr/share/doc/gnupg-&gnupg2-version;/html &amp;&amp;
177install -v -m644 doc/gnupg_nochunks.html \
178 /usr/share/doc/gnupg-&gnupg2-version;/html/gnupg.html &amp;&amp;
179install -v -m644 ../doc/*.texi doc/gnupg.txt \
180 /usr/share/doc/gnupg-&gnupg2-version; &amp;&amp;
181install -v -m644 doc/gnupg.html/* \
182 /usr/share/doc/gnupg-&gnupg2-version;/html</userinput></screen>
183 <para>
184 If you created the pdf format of the documentation, install them
185 using the following command as the
186 <systemitem class="username">root</systemitem> user:
187 </para>
188
189<screen role="root"
190 remap="doc"><userinput>install -v -m644 doc/gnupg.pdf \
191 /usr/share/doc/gnupg-&gnupg2-version;</userinput></screen>
192
193 </sect2>
194
195 <sect2 role="commands">
196 <title>Command Explanations</title>
197<!--
198 <para>
199 <command>sed ... tools/Makefile.in</command>:
200 This command is needed to build the gpg-zip program.
201 </para>
202-->
203 <para>
204 <command>mkdir build &amp;&amp; cd build</command>: the Gnupg2
205 developers recommend to build the package in a dedicated directory.
206 </para>
207
208 <para>
209 <parameter>--docdir=/usr/share/doc/gnupg-&gnupg2-version;</parameter>:
210 This switch changes the default docdir to <filename
211 class="directory">/usr/share/doc/gnupg-&gnupg2-version;</filename>.
212 </para>
213
214<!-- Unrecognized in 2.2.26, seems to get built automatically now.
215 <para>
216 <parameter>- -enable-symcryptrun</parameter>: This switch enables
217 building the symcryptrun program.
218 </para>
219-->
220 <para>
221 <option>--enable-all-tests</option>: This switch allows more tests to be
222 run with <command>make check</command>.
223 </para>
224
225 <para>
226 <option>--enable-g13</option>: This switch enables building the
227 g13 program.
228 </para>
229
230 </sect2>
231
232 <sect2 role="content">
233 <title>Contents</title>
234
235 <segmentedlist>
236 <segtitle>Installed Programs</segtitle>
237 <segtitle>Installed Libraries</segtitle>
238 <segtitle>Installed Directories</segtitle>
239
240 <seglistitem>
241 <seg>addgnupghome, applygnupgdefaults, dirmngr, dirmngr-client, g13
242 (optional), gpg-agent, gpg-card, gpg-connect-agent, gpg, gpgconf,
243 gpgparsemail, gpgscm, gpgsm, gpgsplit, gpgtar, gpgv, gpg-wks-client,
244 gpg-wks-server, kbxutil,
245 <!--symcryptrun,--> and watchgnupg</seg>
246 <seg>None</seg>
247 <seg>/usr/share/doc/gnupg-&gnupg2-version; and
248 /usr/share/gnupg</seg>
249 </seglistitem>
250 </segmentedlist>
251
252 <variablelist>
253 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
254 <?dbfo list-presentation="list"?>
255 <?dbhtml list-presentation="table"?>
256
257 <varlistentry id="addgnupghome">
258 <term><command>addgnupghome</command></term>
259 <listitem>
260 <para>
261 is used to create and populate a user's
262 <filename class="directory">~/.gnupg</filename> directories
263 </para>
264 <indexterm zone="gnupg2 addgnupghome">
265 <primary sortas="b-addgnupghome">addgnupghome</primary>
266 </indexterm>
267 </listitem>
268 </varlistentry>
269
270 <varlistentry id="applygnupgdefaults">
271 <term><command>applygnupgdefaults</command></term>
272 <listitem>
273 <para>
274 is a wrapper script used to run <command>gpgconf</command>
275 with the <parameter>--apply-defaults</parameter> parameter on all
276 user's GnuPG home directories
277 </para>
278 <indexterm zone="gnupg2 applygnupgdefaults">
279 <primary sortas="b-applygnupgdefaults">applygnupgdefaults</primary>
280 </indexterm>
281 </listitem>
282 </varlistentry>
283
284 <varlistentry id="dirmngr">
285 <term><command>dirmngr</command></term>
286 <listitem>
287 <para>
288 is a tool that takes care of accessing the OpenPGP keyservers
289 </para>
290 <indexterm zone="gnupg2 dirmngr">
291 <primary sortas="b-dirmngr">dirmngr</primary>
292 </indexterm>
293 </listitem>
294 </varlistentry>
295
296 <varlistentry id="dirmngr-client">
297 <term><command>dirmngr-client</command></term>
298 <listitem>
299 <para>
300 is a tool to contact a running dirmngr and test whether a
301 certificate has been revoked
302 </para>
303 <indexterm zone="gnupg2 dirmngr-client">
304 <primary sortas="b-dirmngr-client">dirmngr-client</primary>
305 </indexterm>
306 </listitem>
307 </varlistentry>
308
309 <varlistentry id="g13">
310 <term><command>g13</command></term>
311 <listitem>
312 <para>
313 is a tool to create, mount or unmount an encrypted file system
314 container (optional)
315 </para>
316 <indexterm zone="gnupg2 g13">
317 <primary sortas="b-g13">g13</primary>
318 </indexterm>
319 </listitem>
320 </varlistentry>
321
322 <varlistentry id="gpg-agent">
323 <term><command>gpg-agent</command></term>
324 <listitem>
325 <para>
326 is a daemon used to manage secret (private) keys independently
327 from any protocol. It is used as a backend for
328 <command>gpg</command> and <command>gpgsm</command> as well as
329 for a couple of other utilities
330 </para>
331 <indexterm zone="gnupg2 gpg-agent">
332 <primary sortas="b-gpg-agent">gpg-agent</primary>
333 </indexterm>
334 </listitem>
335 </varlistentry>
336
337 <varlistentry id="gpg-card">
338 <term><command>gpg-card</command></term>
339 <listitem>
340 <para>
341 is a tool to manage smart cards and tokens
342 </para>
343 <indexterm zone="gnupg2 gpg-card">
344 <primary sortas="b-gpg-card">gpg-card</primary>
345 </indexterm>
346 </listitem>
347 </varlistentry>
348
349 <varlistentry id="gpg-connect-agent">
350 <term><command>gpg-connect-agent</command></term>
351 <listitem>
352 <para>
353 is a utility used to communicate with a running
354 <command>gpg-agent</command>
355 </para>
356 <indexterm zone="gnupg2 gpg-connect-agent">
357 <primary sortas="b-gpg-connect-agent">gpg-connect-agent</primary>
358 </indexterm>
359 </listitem>
360 </varlistentry>
361
362 <varlistentry id="gpg">
363 <term><command>gpg</command></term>
364 <listitem>
365 <para>
366 is the OpenPGP part of the GNU Privacy Guard (GnuPG). It is a
367 tool used to provide digital encryption and signing services using
368 the OpenPGP standard
369 </para>
370 <indexterm zone="gnupg2 gpg">
371 <primary sortas="b-gpg">gpg</primary>
372 </indexterm>
373 </listitem>
374 </varlistentry>
375
376 <varlistentry id="gpgconf">
377 <term><command>gpgconf</command></term>
378 <listitem>
379 <para>
380 is a utility used to automatically and reasonably safely
381 query and modify configuration files in the
382 <filename class="directory">~/.gnupg</filename> home directory. It
383 is designed not to be invoked manually by the user, but
384 automatically by graphical user interfaces
385 </para>
386 <indexterm zone="gnupg2 gpgconf">
387 <primary sortas="b-gpgconf">gpgconf</primary>
388 </indexterm>
389 </listitem>
390 </varlistentry>
391
392 <varlistentry id="gpgparsemail">
393 <term><command>gpgparsemail</command></term>
394 <listitem>
395 <para>
396 is a utility currently only useful for debugging. Run it with
397 <parameter>--help</parameter> for usage information
398 </para>
399 <indexterm zone="gnupg2 gpgparsemail">
400 <primary sortas="b-gpgparsemail">gpgparsemail</primary>
401 </indexterm>
402 </listitem>
403 </varlistentry>
404
405 <varlistentry id="gpgscm">
406 <term><command>gpgscm</command></term>
407 <listitem>
408 <para>
409 executes the given scheme program or spawns an interactive shell
410 </para>
411 <indexterm zone="gnupg2 gpgscm">
412 <primary sortas="b-gpgscm">gpgscm</primary>
413 </indexterm>
414 </listitem>
415 </varlistentry>
416
417 <varlistentry id="gpgsm">
418 <term><command>gpgsm</command></term>
419 <listitem>
420 <para>
421 is a tool similar to <command>gpg</command> used to provide
422 digital encryption and signing services on X.509 certificates and
423 the CMS protocol. It is mainly used as a backend for S/MIME mail
424 processing
425 </para>
426 <indexterm zone="gnupg2 gpgsm">
427 <primary sortas="b-gpgsm">gpgsm</primary>
428 </indexterm>
429 </listitem>
430 </varlistentry>
431
432 <varlistentry id="gpgsplit">
433 <term><command>gpgsplit</command></term>
434 <listitem>
435 <para>
436 splits an OpenPGP message into packets
437 </para>
438 <indexterm zone="gnupg2 gpgsplit">
439 <primary sortas="b-gpgsplit">gpgsplit</primary>
440 </indexterm>
441 </listitem>
442 </varlistentry>
443
444 <varlistentry id="gpgtar">
445 <term><command>gpgtar</command></term>
446 <listitem>
447 <para>
448 is a tool to encrypt or sign files into an archive
449 </para>
450 <indexterm zone="gnupg2 gpgtar">
451 <primary sortas="b-gpgtar">gpgtar</primary>
452 </indexterm>
453 </listitem>
454 </varlistentry>
455
456 <varlistentry id="gpgv">
457 <term><command>gpgv</command></term>
458 <listitem>
459 <para>
460 is a verify only version of <command>gpg</command>
461 </para>
462 <indexterm zone="gnupg2 gpgv">
463 <primary sortas="b-gpgv">gpgv</primary>
464 </indexterm>
465 </listitem>
466 </varlistentry>
467
468 <varlistentry id="gpg-wks-client">
469 <term><command>gpg-wks-client</command></term>
470 <listitem>
471 <para>
472 is a client for the
473 <application>Web Key Service</application> protocol
474 </para>
475 <indexterm zone="gnupg2 gpg-wks-client">
476 <primary sortas="b-gpg-wks-client">gpg-wks-client</primary>
477 </indexterm>
478 </listitem>
479 </varlistentry>
480
481 <varlistentry id="gpg-wks-server">
482 <term><command>gpg-wks-server</command></term>
483 <listitem>
484 <para>
485 provides a server for the
486 <application>Web Key Service</application> protocol
487 </para>
488 <indexterm zone="gnupg2 gpg-wks-server">
489 <primary sortas="b-gpg-wks-server">gpg-wks-server</primary>
490 </indexterm>
491 </listitem>
492 </varlistentry>
493<!--
494 <varlistentry id="gpg-zip">
495 <term><command>gpg-zip</command></term>
496 <listitem>
497 <para>
498 encrypts or signs files into an archive
499 </para>
500 <indexterm zone="gnupg2 gpg-zip">
501 <primary sortas="b-gpg-zip">gpg-zip</primary>
502 </indexterm>
503 </listitem>
504 </varlistentry>
505-->
506 <varlistentry id="kbxutil">
507 <term><command>kbxutil</command></term>
508 <listitem>
509 <para>
510 is used to list, export and import Keybox data
511 </para>
512 <indexterm zone="gnupg2 kbxutil">
513 <primary sortas="b-kbxutil">kbxutil</primary>
514 </indexterm>
515 </listitem>
516 </varlistentry>
517
518 <!--
519 <varlistentry id="symcryptrun">
520 <term><command>symcryptrun</command></term>
521 <listitem>
522 <para>
523 is a simple symmetric encryption tool.
524 </para>
525 <indexterm zone="gnupg2 symcryptrun">
526 <primary sortas="b-symcryptrun">symcryptrun</primary>
527 </indexterm>
528 </listitem>
529 </varlistentry>
530-->
531 <varlistentry id="watchgnupg">
532 <term><command>watchgnupg</command></term>
533 <listitem>
534 <para>
535 is used to listen to a Unix Domain socket created by any of
536 the GnuPG tools
537 </para>
538 <indexterm zone="gnupg2 watchgnupg">
539 <primary sortas="b-watchgnupg">watchgnupg</primary>
540 </indexterm>
541 </listitem>
542 </varlistentry>
543
544 </variablelist>
545
546 </sect2>
547
548</sect1>
Note: See TracBrowser for help on using the repository browser.