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