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 " ">
|
---|
8 | <!ENTITY gnupg2-download-ftp "ftp://ftp.gnupg.org/gcrypt/gnupg/gnupg-&gnupg2-version;.tar.bz2">
|
---|
9 | <!ENTITY gnupg2-md5sum "c36f1a4c261ecc81fa5df551356c33f1">
|
---|
10 | <!ENTITY gnupg2-size "4.7 MB">
|
---|
11 | <!ENTITY gnupg2-buildsize "102 MB (including html documentation)">
|
---|
12 | <!ENTITY gnupg2-time "0.6 SBU (additional 0.1 SBU for the 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>The <application>GnuPG</application> package is GNU's tool for
|
---|
33 | secure communication and data storage. It can be used to encrypt data and
|
---|
34 | to create digital signatures. It includes an advanced key management
|
---|
35 | facility and is compliant with the proposed OpenPGP Internet standard as
|
---|
36 | described in RFC2440 and the S/MIME standard as described by several RFCs.
|
---|
37 | GnuPG 2 is the stable version of GnuPG integrating support for OpenPGP and
|
---|
38 | S/MIME.</para>
|
---|
39 |
|
---|
40 | &lfs77_checked; &gcc5_checked;
|
---|
41 |
|
---|
42 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
43 | <itemizedlist spacing="compact">
|
---|
44 | <listitem>
|
---|
45 | <para>Download (HTTP): <ulink url="&gnupg2-download-http;"/></para>
|
---|
46 | </listitem>
|
---|
47 | <listitem>
|
---|
48 | <para>Download (FTP): <ulink url="&gnupg2-download-ftp;"/></para>
|
---|
49 | </listitem>
|
---|
50 | <listitem>
|
---|
51 | <para>Download MD5 sum: &gnupg2-md5sum;</para>
|
---|
52 | </listitem>
|
---|
53 | <listitem>
|
---|
54 | <para>Download size: &gnupg2-size;</para>
|
---|
55 | </listitem>
|
---|
56 | <listitem>
|
---|
57 | <para>Estimated disk space required: &gnupg2-buildsize;</para>
|
---|
58 | </listitem>
|
---|
59 | <listitem>
|
---|
60 | <para>Estimated build time: &gnupg2-time;</para>
|
---|
61 | </listitem>
|
---|
62 | </itemizedlist>
|
---|
63 |
|
---|
64 | <bridgehead renderas="sect3">GnuPG 2 Dependencies</bridgehead>
|
---|
65 |
|
---|
66 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
67 | <para role="required">
|
---|
68 | <xref linkend="libassuan"/>,
|
---|
69 | <xref linkend="libgcrypt"/>,
|
---|
70 | <xref linkend="libksba"/>, and
|
---|
71 | <xref linkend="npth"/>
|
---|
72 | </para>
|
---|
73 |
|
---|
74 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
75 | <para role="recommended">
|
---|
76 | <xref linkend="pinentry"/> (Run-time requirement for most of
|
---|
77 | the package's functionality)
|
---|
78 | </para>
|
---|
79 |
|
---|
80 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
81 | <para role="optional">
|
---|
82 | <xref linkend="curl"/>,
|
---|
83 | <xref linkend="libusb-compat"/>,
|
---|
84 | <xref linkend="openldap"/>,
|
---|
85 | an <xref linkend="server-mail"/>,
|
---|
86 | <xref linkend="texlive"/> (or <xref linkend="tl-installer"/>), and
|
---|
87 | <ulink url="http://www.chiark.greenend.org.uk/~ian/adns/">GNU
|
---|
88 | adns</ulink>
|
---|
89 | </para>
|
---|
90 |
|
---|
91 | <para condition="html" role="usernotes">User Notes:
|
---|
92 | <ulink url="&blfs-wiki;/gnupg2"/></para>
|
---|
93 |
|
---|
94 | </sect2>
|
---|
95 |
|
---|
96 | <sect2 role="installation">
|
---|
97 | <title>Installation of GnuPG</title>
|
---|
98 |
|
---|
99 | <warning>
|
---|
100 | <para>
|
---|
101 | If you are upgrading from gnupg prior to version 2.1, upstream
|
---|
102 | developers recommend to backup
|
---|
103 | <filename class="directory">~/.gnupg</filename>, because some additional
|
---|
104 | configuration will probably be necessary, and you could lose your keys.
|
---|
105 | You can find instructions at
|
---|
106 | <ulink url="http://jo-ke.name/wp/?p=111"></ulink> and
|
---|
107 | <ulink url="https://wiki.archlinux.org/index.php/GnuPG#.22Lost.22_keys.2C_upgrading_to_gnupg_version_2.1"></ulink>.
|
---|
108 | </para>
|
---|
109 | </warning>
|
---|
110 |
|
---|
111 | <para>If the top directory path where the source is unpacked contains
|
---|
112 | symbolic links, the openpgp tests might fail. If this is your case and
|
---|
113 | you wish to run the test suite, fix that with:</para>
|
---|
114 |
|
---|
115 | <screen><userinput>sed -e 's|\(GNUPGHOME\)=\$(abs_builddir)|\1=`/bin/pwd`|' \
|
---|
116 | -i tests/openpgp/Makefile.in</userinput></screen>
|
---|
117 |
|
---|
118 | <para>Install <application>GnuPG</application> by running the following
|
---|
119 | commands:</para>
|
---|
120 |
|
---|
121 | <screen><userinput>./configure --prefix=/usr \
|
---|
122 | --enable-symcryptrun \
|
---|
123 | --docdir=/usr/share/doc/gnupg-&gnupg2-version; &&
|
---|
124 | make &&
|
---|
125 |
|
---|
126 | makeinfo --html --no-split -o doc/gnupg_nochunks.html doc/gnupg.texi &&
|
---|
127 | makeinfo --plaintext -o doc/gnupg.txt doc/gnupg.texi</userinput></screen>
|
---|
128 |
|
---|
129 | <para>If you have <xref linkend="texlive"/>
|
---|
130 | installed and you wish to create documentation in alternate formats,
|
---|
131 | issue the following commands:</para>
|
---|
132 |
|
---|
133 | <screen><userinput>make -C doc pdf ps html</userinput></screen>
|
---|
134 |
|
---|
135 | <para>To test the results, issue: <command>make check</command>.</para>
|
---|
136 |
|
---|
137 | <para>Note that if you have already installed
|
---|
138 | <application>GnuPG</application>, the instructions below will overwrite
|
---|
139 | <filename>/usr/share/man/man1/gpg-zip.1</filename>. Now, as the
|
---|
140 | <systemitem class="username">root</systemitem> user:</para>
|
---|
141 |
|
---|
142 | <screen role="root"><userinput>make install &&
|
---|
143 |
|
---|
144 | install -v -m755 -d /usr/share/doc/gnupg-&gnupg2-version;/html &&
|
---|
145 | install -v -m644 doc/gnupg_nochunks.html \
|
---|
146 | /usr/share/doc/gnupg-&gnupg2-version;/html/gnupg.html &&
|
---|
147 | install -v -m644 doc/*.texi doc/gnupg.txt \
|
---|
148 | /usr/share/doc/gnupg-&gnupg2-version;</userinput></screen>
|
---|
149 |
|
---|
150 | <para>We recommend the creation of symlinks for compatibility with the first
|
---|
151 | version of GnuPG, because some programs or scripts need them. Issue, as
|
---|
152 | <systemitem class="username">root</systemitem> user:</para>
|
---|
153 |
|
---|
154 | <screen role="root"><userinput>for f in gpg gpgv
|
---|
155 | do
|
---|
156 | ln -svf ${f}2.1 /usr/share/man/man1/$f.1 &&
|
---|
157 | ln -svf ${f}2 /usr/bin/$f
|
---|
158 | done
|
---|
159 | unset f</userinput></screen>
|
---|
160 |
|
---|
161 | <para>If you created alternate formats of the documentation, install it
|
---|
162 | using the following command as the
|
---|
163 | <systemitem class="username">root</systemitem> user:</para>
|
---|
164 |
|
---|
165 | <screen role="root"><userinput>install -v -m644 doc/gnupg.html/* \
|
---|
166 | /usr/share/doc/gnupg-&gnupg2-version;/html &&
|
---|
167 | install -v -m644 doc/gnupg.{pdf,dvi,ps} \
|
---|
168 | /usr/share/doc/gnupg-&gnupg2-version;</userinput></screen>
|
---|
169 |
|
---|
170 | </sect2>
|
---|
171 |
|
---|
172 | <sect2 role="commands">
|
---|
173 | <title>Command Explanations</title>
|
---|
174 |
|
---|
175 | <para><parameter>--docdir=/usr/share/doc/gnupg-&gnupg2-version;</parameter>:
|
---|
176 | This switch changes the default docdir to <filename
|
---|
177 | class="directory">/usr/share/doc/gnupg-&gnupg2-version;</filename>.</para>
|
---|
178 |
|
---|
179 | <para><parameter>--enable-symcryptrun</parameter>: This switch enables
|
---|
180 | building the symcryptrun program.</para>
|
---|
181 |
|
---|
182 | </sect2>
|
---|
183 |
|
---|
184 | <sect2 role="content">
|
---|
185 | <title>Contents</title>
|
---|
186 |
|
---|
187 | <segmentedlist>
|
---|
188 | <segtitle>Installed Programs</segtitle>
|
---|
189 | <segtitle>Installed Libraries</segtitle>
|
---|
190 | <segtitle>Installed Directories</segtitle>
|
---|
191 |
|
---|
192 | <seglistitem>
|
---|
193 | <seg>addgnupghome, applygnupgdefaults, dirmngr, dirmngr-client, g13,
|
---|
194 | gpg-agent, gpg-connect-agent, gpg, gpg2, gpgconf, gpgkey2ssh,
|
---|
195 | gpgparsemail, gpgsm, gpgsm-gencert.sh, gpgtar, gpgv, gpgv2, kbxutil,
|
---|
196 | symcryptrun, and watchgnupg</seg>
|
---|
197 | <seg>None</seg>
|
---|
198 | <seg>/usr/share/doc/gnupg-&gnupg2-version; and
|
---|
199 | /usr/share/gnupg</seg>
|
---|
200 | </seglistitem>
|
---|
201 | </segmentedlist>
|
---|
202 |
|
---|
203 | <variablelist>
|
---|
204 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
205 | <?dbfo list-presentation="list"?>
|
---|
206 | <?dbhtml list-presentation="table"?>
|
---|
207 |
|
---|
208 | <varlistentry id="addgnupghome">
|
---|
209 | <term><command>addgnupghome</command></term>
|
---|
210 | <listitem>
|
---|
211 | <para>is used to create and populate user's
|
---|
212 | <filename class='directory'>~/.gnupg</filename> directories</para>
|
---|
213 | <indexterm zone="gnupg2 addgnupghome">
|
---|
214 | <primary sortas="b-addgnupghome">addgnupghome</primary>
|
---|
215 | </indexterm>
|
---|
216 | </listitem>
|
---|
217 | </varlistentry>
|
---|
218 |
|
---|
219 | <varlistentry id="applygnupgdefaults">
|
---|
220 | <term><command>applygnupgdefaults</command></term>
|
---|
221 | <listitem>
|
---|
222 | <para>is a wrapper script used to run <command>gpgconf</command>
|
---|
223 | with the <parameter>--apply-defaults</parameter> parameter on all
|
---|
224 | user's GnuPG home directories.</para>
|
---|
225 | <indexterm zone="gnupg2 applygnupgdefaults">
|
---|
226 | <primary sortas="b-applygnupgdefaults">applygnupgdefaults</primary>
|
---|
227 | </indexterm>
|
---|
228 | </listitem>
|
---|
229 | </varlistentry>
|
---|
230 |
|
---|
231 | <varlistentry id="dirmngr">
|
---|
232 | <term><command>dirmngr</command></term>
|
---|
233 | <listitem>
|
---|
234 | <para> is a tool that takes care of accessing the OpenPGP keyservers.
|
---|
235 | </para>
|
---|
236 | <indexterm zone="gnupg2 dirmngr">
|
---|
237 | <primary sortas="b-dirmngr">dirmngr</primary>
|
---|
238 | </indexterm>
|
---|
239 | </listitem>
|
---|
240 | </varlistentry>
|
---|
241 |
|
---|
242 | <varlistentry id="dirmngr-client">
|
---|
243 | <term><command>dirmngr-client</command></term>
|
---|
244 | <listitem>
|
---|
245 | <para> is a tool to contact a running dirmngr and test whether a
|
---|
246 | certificate has been revoked. </para>
|
---|
247 | <indexterm zone="gnupg2 dirmngr-client">
|
---|
248 | <primary sortas="b-dirmngr-client">dirmngr-client</primary>
|
---|
249 | </indexterm>
|
---|
250 | </listitem>
|
---|
251 | </varlistentry>
|
---|
252 |
|
---|
253 | <varlistentry id="g13">
|
---|
254 | <term><command>g13</command></term>
|
---|
255 | <listitem>
|
---|
256 | <para>is a tool to create, mount or unmount an encrypted file system
|
---|
257 | container.</para>
|
---|
258 | <indexterm zone="gnupg2 g13">
|
---|
259 | <primary sortas="b-g13">g13</primary>
|
---|
260 | </indexterm>
|
---|
261 | </listitem>
|
---|
262 | </varlistentry>
|
---|
263 |
|
---|
264 | <varlistentry id="gpg-agent">
|
---|
265 | <term><command>gpg-agent</command></term>
|
---|
266 | <listitem>
|
---|
267 | <para>is a daemon used to manage secret (private) keys independently
|
---|
268 | from any protocol. It is used as a backend for <command>gpg2</command>
|
---|
269 | and <command>gpgsm</command> as well as for a couple of other
|
---|
270 | utilities.</para>
|
---|
271 | <indexterm zone="gnupg2 gpg-agent">
|
---|
272 | <primary sortas="b-gpg-agent">gpg-agent</primary>
|
---|
273 | </indexterm>
|
---|
274 | </listitem>
|
---|
275 | </varlistentry>
|
---|
276 |
|
---|
277 | <varlistentry id="gpg-connect-agent">
|
---|
278 | <term><command>gpg-connect-agent</command></term>
|
---|
279 | <listitem>
|
---|
280 | <para>is a utility used to communicate with a running
|
---|
281 | <command>gpg-agent</command>.</para>
|
---|
282 | <indexterm zone="gnupg2 gpg-connect-agent">
|
---|
283 | <primary sortas="b-gpg-connect-agent">gpg-connect-agent</primary>
|
---|
284 | </indexterm>
|
---|
285 | </listitem>
|
---|
286 | </varlistentry>
|
---|
287 |
|
---|
288 | <varlistentry id="gpg">
|
---|
289 | <term><command>gpg</command></term>
|
---|
290 | <listitem>
|
---|
291 | <para>(optional) is a symlink to <command>gpg2</command> for
|
---|
292 | compatibility with the first version of GnuPG.</para>
|
---|
293 | <indexterm zone="gnupg2 gpg">
|
---|
294 | <primary sortas="b-gpg">gpg</primary>
|
---|
295 | </indexterm>
|
---|
296 | </listitem>
|
---|
297 | </varlistentry>
|
---|
298 |
|
---|
299 | <varlistentry id="gpg2">
|
---|
300 | <term><command>gpg2</command></term>
|
---|
301 | <listitem>
|
---|
302 | <para>is the OpenPGP part of the GNU Privacy Guard (GnuPG). It is a
|
---|
303 | tool used to provide digital encryption and signing services using
|
---|
304 | the OpenPGP standard.</para>
|
---|
305 | <indexterm zone="gnupg2 gpg2">
|
---|
306 | <primary sortas="b-gpg2">gpg2</primary>
|
---|
307 | </indexterm>
|
---|
308 | </listitem>
|
---|
309 | </varlistentry>
|
---|
310 |
|
---|
311 | <varlistentry id="gpgconf">
|
---|
312 | <term><command>gpgconf</command></term>
|
---|
313 | <listitem>
|
---|
314 | <para>is a utility used to automatically and reasonably safely
|
---|
315 | query and modify configuration files in the
|
---|
316 | <filename class='directory'>~/.gnupg</filename> home directory. It is
|
---|
317 | designed not to be invoked manually by the user, but automatically by
|
---|
318 | graphical user interfaces.</para>
|
---|
319 | <indexterm zone="gnupg2 gpgconf">
|
---|
320 | <primary sortas="b-gpgconf">gpgconf</primary>
|
---|
321 | </indexterm>
|
---|
322 | </listitem>
|
---|
323 | </varlistentry>
|
---|
324 |
|
---|
325 | <varlistentry id="gpgparsemail">
|
---|
326 | <term><command>gpgparsemail</command></term>
|
---|
327 | <listitem>
|
---|
328 | <para>is a utility currently only useful for debugging. Run it with
|
---|
329 | <parameter>--help</parameter> for usage information.</para>
|
---|
330 | <indexterm zone="gnupg2 gpgparsemail">
|
---|
331 | <primary sortas="b-gpgparsemail">gpgparsemail</primary>
|
---|
332 | </indexterm>
|
---|
333 | </listitem>
|
---|
334 | </varlistentry>
|
---|
335 |
|
---|
336 | <varlistentry id="gpgsm">
|
---|
337 | <term><command>gpgsm</command></term>
|
---|
338 | <listitem>
|
---|
339 | <para>is a tool similar to <command>gpg2</command> used to provide
|
---|
340 | digital encryption and signing services on X.509 certificates and the
|
---|
341 | CMS protocol. It is mainly used as a backend for S/MIME mail
|
---|
342 | processing.</para>
|
---|
343 | <indexterm zone="gnupg2 gpgsm">
|
---|
344 | <primary sortas="b-gpgsm">gpgsm</primary>
|
---|
345 | </indexterm>
|
---|
346 | </listitem>
|
---|
347 | </varlistentry>
|
---|
348 |
|
---|
349 | <varlistentry id="gpgtar">
|
---|
350 | <term><command>gpgtar</command></term>
|
---|
351 | <listitem>
|
---|
352 | <para> is a tool to encrypt or sign files into an archive.</para>
|
---|
353 | <indexterm zone="gnupg2 gpgtar">
|
---|
354 | <primary sortas="b-gpgtar">gpgtar</primary>
|
---|
355 | </indexterm>
|
---|
356 | </listitem>
|
---|
357 | </varlistentry>
|
---|
358 |
|
---|
359 | <varlistentry id="gpgsm-gencert.sh">
|
---|
360 | <term><command>gpgsm-gencert.sh</command></term>
|
---|
361 | <listitem>
|
---|
362 | <para>is a simple tool used to interactively generate a certificate
|
---|
363 | request which will be printed to stdout.</para>
|
---|
364 | <indexterm zone="gnupg2 gpgsm-gencert.sh">
|
---|
365 | <primary sortas="b-gpgsm-gencert.sh">gpgsm-gencert.sh</primary>
|
---|
366 | </indexterm>
|
---|
367 | </listitem>
|
---|
368 | </varlistentry>
|
---|
369 |
|
---|
370 | <varlistentry id="gpgv">
|
---|
371 | <term><command>gpgv</command></term>
|
---|
372 | <listitem>
|
---|
373 | <para>(optional) is a symlink to <command>gpgv2</command> for
|
---|
374 | compatibility with the first version of GnuPG.</para>
|
---|
375 | <indexterm zone="gnupg2 gpgv">
|
---|
376 | <primary sortas="b-gpgv">gpgv</primary>
|
---|
377 | </indexterm>
|
---|
378 | </listitem>
|
---|
379 | </varlistentry>
|
---|
380 |
|
---|
381 | <varlistentry id="gpgv2">
|
---|
382 | <term><command>gpgv2</command></term>
|
---|
383 | <listitem>
|
---|
384 | <para>is a verify only version of <command>gpg2</command>.</para>
|
---|
385 | <indexterm zone="gnupg2 gpgv2">
|
---|
386 | <primary sortas="b-gpgv2">gpgv2</primary>
|
---|
387 | </indexterm>
|
---|
388 | </listitem>
|
---|
389 | </varlistentry>
|
---|
390 |
|
---|
391 | <varlistentry id="kbxutil">
|
---|
392 | <term><command>kbxutil</command></term>
|
---|
393 | <listitem>
|
---|
394 | <para>is used to list, export and import Keybox data.</para>
|
---|
395 | <indexterm zone="gnupg2 kbxutil">
|
---|
396 | <primary sortas="b-kbxutil">kbxutil</primary>
|
---|
397 | </indexterm>
|
---|
398 | </listitem>
|
---|
399 | </varlistentry>
|
---|
400 |
|
---|
401 | <varlistentry id="symcryptrun">
|
---|
402 | <term><command>symcryptrun</command></term>
|
---|
403 | <listitem>
|
---|
404 | <para>is a simple symmetric encryption tool.</para>
|
---|
405 | <indexterm zone="gnupg2 symcryptrun">
|
---|
406 | <primary sortas="b-symcryptrun">symcryptrun</primary>
|
---|
407 | </indexterm>
|
---|
408 | </listitem>
|
---|
409 | </varlistentry>
|
---|
410 |
|
---|
411 | <varlistentry id="watchgnupg">
|
---|
412 | <term><command>watchgnupg</command></term>
|
---|
413 | <listitem>
|
---|
414 | <para>is used to listen to a Unix Domain socket created by any of
|
---|
415 | the GnuPG tools.</para>
|
---|
416 | <indexterm zone="gnupg2 watchgnupg">
|
---|
417 | <primary sortas="b-watchgnupg">watchgnupg</primary>
|
---|
418 | </indexterm>
|
---|
419 | </listitem>
|
---|
420 | </varlistentry>
|
---|
421 |
|
---|
422 | </variablelist>
|
---|
423 |
|
---|
424 | </sect2>
|
---|
425 |
|
---|
426 | </sect1>
|
---|