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 "b35df68881a5ae432b0391b73773c698">
|
---|
10 | <!ENTITY gnupg2-size "4.2 MB">
|
---|
11 | <!ENTITY gnupg2-buildsize "86 MB (including html documentation)">
|
---|
12 | <!ENTITY gnupg2-time "0.5 SBU (additional 0.7 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;
|
---|
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"><xref linkend="pth"/>,
|
---|
68 | <xref linkend="libassuan"/>,
|
---|
69 | <xref linkend="libgcrypt"/>, and
|
---|
70 | <xref linkend="libksba"/></para>
|
---|
71 |
|
---|
72 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
73 | <para role="recommended"><xref linkend="pinentry"/> (Run-time requirement for most of
|
---|
74 | the package's functionality)</para>
|
---|
75 |
|
---|
76 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
77 | <para role="optional"><xref linkend="openldap"/>,
|
---|
78 | <xref linkend="libusb-compat"/>,
|
---|
79 | <xref linkend="curl"/>,
|
---|
80 | <ulink url="http://www.chiark.greenend.org.uk/~ian/adns/">GNU
|
---|
81 | adns</ulink>, an
|
---|
82 | <xref linkend="server-mail"/>, and
|
---|
83 | <xref linkend="texlive"/> (or <xref linkend="tl-installer"/>)</para>
|
---|
84 |
|
---|
85 | <para condition="html" role="usernotes">User Notes:
|
---|
86 | <ulink url="&blfs-wiki;/gnupg2"/></para>
|
---|
87 |
|
---|
88 | </sect2>
|
---|
89 |
|
---|
90 | <sect2 role="installation">
|
---|
91 | <title>Installation of GnuPG</title>
|
---|
92 |
|
---|
93 | <para>Install <application>GnuPG</application> by running the following
|
---|
94 | commands:</para>
|
---|
95 |
|
---|
96 | <screen><userinput>./configure --prefix=/usr \
|
---|
97 | --enable-symcryptrun \
|
---|
98 | --docdir=/usr/share/doc/gnupg-&gnupg2-version; &&
|
---|
99 | make &&
|
---|
100 |
|
---|
101 | makeinfo --html --no-split -o doc/gnupg_nochunks.html doc/gnupg.texi &&
|
---|
102 | makeinfo --plaintext -o doc/gnupg.txt doc/gnupg.texi</userinput></screen>
|
---|
103 |
|
---|
104 | <para>If you have <xref linkend="texlive"/>
|
---|
105 | installed and you wish to create documentation in alternate formats,
|
---|
106 | issue the following commands:</para>
|
---|
107 |
|
---|
108 | <screen><userinput>make -C doc pdf ps html</userinput></screen>
|
---|
109 |
|
---|
110 | <para>To test the results, issue: <command>make check</command>.</para>
|
---|
111 |
|
---|
112 | <para>Note that if you have already installed
|
---|
113 | <application>GnuPG</application>, the instructions below will overwrite
|
---|
114 | <filename>/usr/share/man/man1/gpg-zip.1</filename>. Now, as the
|
---|
115 | <systemitem class="username">root</systemitem> user:</para>
|
---|
116 |
|
---|
117 | <screen role="root"><userinput>make install &&
|
---|
118 |
|
---|
119 | install -v -m755 -d /usr/share/doc/gnupg-&gnupg2-version;/html &&
|
---|
120 | install -v -m644 doc/gnupg_nochunks.html \
|
---|
121 | /usr/share/doc/gnupg-&gnupg2-version;/html/gnupg.html &&
|
---|
122 | install -v -m644 doc/*.texi doc/gnupg.txt \
|
---|
123 | /usr/share/doc/gnupg-&gnupg2-version;</userinput></screen>
|
---|
124 |
|
---|
125 | <para>We recommend the creation of symlinks for compatibility with the first
|
---|
126 | version of GnuPG, because some programs or scripts need them. Issue, as
|
---|
127 | <systemitem class="username">root</systemitem> user:</para>
|
---|
128 |
|
---|
129 | <screen role="root"><userinput>for f in gpg gpgv
|
---|
130 | do
|
---|
131 | ln -svf ${f}2.1 /usr/share/man/man1/$f.1 &&
|
---|
132 | ln -svf ${f}2 /usr/bin/$f
|
---|
133 | done
|
---|
134 | unset f</userinput></screen>
|
---|
135 |
|
---|
136 | <para>If you created alternate formats of the documentation, install it
|
---|
137 | using the following command as the
|
---|
138 | <systemitem class="username">root</systemitem> user:</para>
|
---|
139 |
|
---|
140 | <screen role="root"><userinput>install -v -m644 doc/gnupg.html/* \
|
---|
141 | /usr/share/doc/gnupg-&gnupg2-version;/html &&
|
---|
142 | install -v -m644 doc/gnupg.{pdf,dvi,ps} \
|
---|
143 | /usr/share/doc/gnupg-&gnupg2-version;</userinput></screen>
|
---|
144 |
|
---|
145 | </sect2>
|
---|
146 |
|
---|
147 | <sect2 role="commands">
|
---|
148 | <title>Command Explanations</title>
|
---|
149 |
|
---|
150 | <para><parameter>--docdir=/usr/share/doc/gnupg-&gnupg2-version;</parameter>:
|
---|
151 | This switch changes the default docdir to <filename
|
---|
152 | class="directory">/usr/share/doc/gnupg-&gnupg2-version;</filename>.</para>
|
---|
153 |
|
---|
154 | <para><parameter>--enable-symcryptrun</parameter>: This switch enables
|
---|
155 | building the symcryptrun program.</para>
|
---|
156 |
|
---|
157 | </sect2>
|
---|
158 |
|
---|
159 | <sect2 role="content">
|
---|
160 | <title>Contents</title>
|
---|
161 |
|
---|
162 | <segmentedlist>
|
---|
163 | <segtitle>Installed Programs</segtitle>
|
---|
164 | <segtitle>Installed Libraries</segtitle>
|
---|
165 | <segtitle>Installed Directories</segtitle>
|
---|
166 |
|
---|
167 | <seglistitem>
|
---|
168 | <seg>addgnupghome, applygnupgdefaults, gpg-agent, gpg-connect-agent,
|
---|
169 | gpg, gpg2, gpgconf, gpgkey2ssh, gpgparsemail, gpgsm,
|
---|
170 | gpgsm-gencert.sh, gpgv, gpgv2, kbxutil, symcryptrun, and watchgnupg</seg>
|
---|
171 | <seg>None</seg>
|
---|
172 | <seg>/usr/share/doc/gnupg-&gnupg2-version; and
|
---|
173 | /usr/share/gnupg</seg>
|
---|
174 | </seglistitem>
|
---|
175 | </segmentedlist>
|
---|
176 |
|
---|
177 | <variablelist>
|
---|
178 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
179 | <?dbfo list-presentation="list"?>
|
---|
180 | <?dbhtml list-presentation="table"?>
|
---|
181 |
|
---|
182 | <varlistentry id="addgnupghome">
|
---|
183 | <term><command>addgnupghome</command></term>
|
---|
184 | <listitem>
|
---|
185 | <para>is used to create and populate user's
|
---|
186 | <filename class='directory'>~/.gnupg</filename> directories</para>
|
---|
187 | <indexterm zone="gnupg2 addgnupghome">
|
---|
188 | <primary sortas="b-addgnupghome">addgnupghome</primary>
|
---|
189 | </indexterm>
|
---|
190 | </listitem>
|
---|
191 | </varlistentry>
|
---|
192 |
|
---|
193 | <varlistentry id="applygnupgdefaults">
|
---|
194 | <term><command>applygnupgdefaults</command></term>
|
---|
195 | <listitem>
|
---|
196 | <para>is a wrapper script used to run <command>gpgconf</command>
|
---|
197 | with the <parameter>--apply-defaults</parameter> parameter on all
|
---|
198 | user's GnuPG home directories.</para>
|
---|
199 | <indexterm zone="gnupg2 applygnupgdefaults">
|
---|
200 | <primary sortas="b-applygnupgdefaults">applygnupgdefaults</primary>
|
---|
201 | </indexterm>
|
---|
202 | </listitem>
|
---|
203 | </varlistentry>
|
---|
204 |
|
---|
205 | <varlistentry id="gpg-agent">
|
---|
206 | <term><command>gpg-agent</command></term>
|
---|
207 | <listitem>
|
---|
208 | <para>is a daemon used to manage secret (private) keys independently
|
---|
209 | from any protocol. It is used as a backend for <command>gpg2</command>
|
---|
210 | and <command>gpgsm</command> as well as for a couple of other
|
---|
211 | utilities.</para>
|
---|
212 | <indexterm zone="gnupg2 gpg-agent">
|
---|
213 | <primary sortas="b-gpg-agent">gpg-agent</primary>
|
---|
214 | </indexterm>
|
---|
215 | </listitem>
|
---|
216 | </varlistentry>
|
---|
217 |
|
---|
218 | <varlistentry id="gpg-connect-agent">
|
---|
219 | <term><command>gpg-connect-agent</command></term>
|
---|
220 | <listitem>
|
---|
221 | <para>is a utility used to communicate with a running
|
---|
222 | <command>gpg-agent</command>.</para>
|
---|
223 | <indexterm zone="gnupg2 gpg-connect-agent">
|
---|
224 | <primary sortas="b-gpg-connect-agent">gpg-connect-agent</primary>
|
---|
225 | </indexterm>
|
---|
226 | </listitem>
|
---|
227 | </varlistentry>
|
---|
228 |
|
---|
229 | <varlistentry id="gpg">
|
---|
230 | <term><command>gpg</command></term>
|
---|
231 | <listitem>
|
---|
232 | <para>(optional) is a symlink to <command>gpg2</command> for
|
---|
233 | compatibility with the first version of GnuPG.</para>
|
---|
234 | <indexterm zone="gnupg2 gpg">
|
---|
235 | <primary sortas="b-gpg">gpg</primary>
|
---|
236 | </indexterm>
|
---|
237 | </listitem>
|
---|
238 | </varlistentry>
|
---|
239 |
|
---|
240 | <varlistentry id="gpg2">
|
---|
241 | <term><command>gpg2</command></term>
|
---|
242 | <listitem>
|
---|
243 | <para>is the OpenPGP part of the GNU Privacy Guard (GnuPG). It is a
|
---|
244 | tool used to provide digital encryption and signing services using
|
---|
245 | the OpenPGP standard.</para>
|
---|
246 | <indexterm zone="gnupg2 gpg2">
|
---|
247 | <primary sortas="b-gpg2">gpg2</primary>
|
---|
248 | </indexterm>
|
---|
249 | </listitem>
|
---|
250 | </varlistentry>
|
---|
251 |
|
---|
252 | <varlistentry id="gpgconf">
|
---|
253 | <term><command>gpgconf</command></term>
|
---|
254 | <listitem>
|
---|
255 | <para>is a utility used to automatically and reasonably safely
|
---|
256 | query and modify configuration files in the
|
---|
257 | <filename class='directory'>~/.gnupg</filename> home directory. It is
|
---|
258 | designed not to be invoked manually by the user, but automatically by
|
---|
259 | graphical user interfaces.</para>
|
---|
260 | <indexterm zone="gnupg2 gpgconf">
|
---|
261 | <primary sortas="b-gpgconf">gpgconf</primary>
|
---|
262 | </indexterm>
|
---|
263 | </listitem>
|
---|
264 | </varlistentry>
|
---|
265 |
|
---|
266 | <varlistentry id="gpgparsemail">
|
---|
267 | <term><command>gpgparsemail</command></term>
|
---|
268 | <listitem>
|
---|
269 | <para>is a utility currently only useful for debugging. Run it with
|
---|
270 | <parameter>--help</parameter> for usage information.</para>
|
---|
271 | <indexterm zone="gnupg2 gpgparsemail">
|
---|
272 | <primary sortas="b-gpgparsemail">gpgparsemail</primary>
|
---|
273 | </indexterm>
|
---|
274 | </listitem>
|
---|
275 | </varlistentry>
|
---|
276 |
|
---|
277 | <varlistentry id="gpgsm">
|
---|
278 | <term><command>gpgsm</command></term>
|
---|
279 | <listitem>
|
---|
280 | <para>is a tool similar to <command>gpg2</command> used to provide
|
---|
281 | digital encryption and signing services on X.509 certificates and the
|
---|
282 | CMS protocol. It is mainly used as a backend for S/MIME mail
|
---|
283 | processing.</para>
|
---|
284 | <indexterm zone="gnupg2 gpgsm">
|
---|
285 | <primary sortas="b-gpgsm">gpgsm</primary>
|
---|
286 | </indexterm>
|
---|
287 | </listitem>
|
---|
288 | </varlistentry>
|
---|
289 |
|
---|
290 | <varlistentry id="gpgsm-gencert.sh">
|
---|
291 | <term><command>gpgsm-gencert.sh</command></term>
|
---|
292 | <listitem>
|
---|
293 | <para>is a simple tool used to interactively generate a certificate
|
---|
294 | request which will be printed to stdout.</para>
|
---|
295 | <indexterm zone="gnupg2 gpgsm-gencert.sh">
|
---|
296 | <primary sortas="b-gpgsm-gencert.sh">gpgsm-gencert.sh</primary>
|
---|
297 | </indexterm>
|
---|
298 | </listitem>
|
---|
299 | </varlistentry>
|
---|
300 |
|
---|
301 | <varlistentry id="gpgv">
|
---|
302 | <term><command>gpgv</command></term>
|
---|
303 | <listitem>
|
---|
304 | <para>(optional) is a symlink to <command>gpgv2</command> for
|
---|
305 | compatibility with the first version of GnuPG.</para>
|
---|
306 | <indexterm zone="gnupg2 gpgv">
|
---|
307 | <primary sortas="b-gpgv">gpgv</primary>
|
---|
308 | </indexterm>
|
---|
309 | </listitem>
|
---|
310 | </varlistentry>
|
---|
311 |
|
---|
312 | <varlistentry id="gpgv2">
|
---|
313 | <term><command>gpgv2</command></term>
|
---|
314 | <listitem>
|
---|
315 | <para>is a verify only version of <command>gpg2</command>.</para>
|
---|
316 | <indexterm zone="gnupg2 gpgv2">
|
---|
317 | <primary sortas="b-gpgv2">gpgv2</primary>
|
---|
318 | </indexterm>
|
---|
319 | </listitem>
|
---|
320 | </varlistentry>
|
---|
321 |
|
---|
322 | <varlistentry id="kbxutil">
|
---|
323 | <term><command>kbxutil</command></term>
|
---|
324 | <listitem>
|
---|
325 | <para>is used to list, export and import Keybox data.</para>
|
---|
326 | <indexterm zone="gnupg2 kbxutil">
|
---|
327 | <primary sortas="b-kbxutil">kbxutil</primary>
|
---|
328 | </indexterm>
|
---|
329 | </listitem>
|
---|
330 | </varlistentry>
|
---|
331 |
|
---|
332 | <varlistentry id="symcryptrun">
|
---|
333 | <term><command>symcryptrun</command></term>
|
---|
334 | <listitem>
|
---|
335 | <para>is a simple symmetric encryption tool.</para>
|
---|
336 | <indexterm zone="gnupg2 symcryptrun">
|
---|
337 | <primary sortas="b-symcryptrun">symcryptrun</primary>
|
---|
338 | </indexterm>
|
---|
339 | </listitem>
|
---|
340 | </varlistentry>
|
---|
341 |
|
---|
342 | <varlistentry id="watchgnupg">
|
---|
343 | <term><command>watchgnupg</command></term>
|
---|
344 | <listitem>
|
---|
345 | <para>is used to listen to a Unix Domain socket created by any of
|
---|
346 | the GnuPG tools.</para>
|
---|
347 | <indexterm zone="gnupg2 watchgnupg">
|
---|
348 | <primary sortas="b-watchgnupg">watchgnupg</primary>
|
---|
349 | </indexterm>
|
---|
350 | </listitem>
|
---|
351 | </varlistentry>
|
---|
352 |
|
---|
353 | </variablelist>
|
---|
354 |
|
---|
355 | </sect2>
|
---|
356 |
|
---|
357 | </sect1>
|
---|