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