| 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 "fa7e704aad33eb114d1840164455aec1">
|
|---|
| 10 | <!ENTITY gnupg2-size "4.2 MB">
|
|---|
| 11 | <!ENTITY gnupg2-buildsize "68 MB">
|
|---|
| 12 | <!ENTITY gnupg2-time "0.6 SBU (additional 0.5 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 | &lfs76_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 | --enable-symcryptrun \
|
|---|
| 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>We recommend the creation of symlinks for compatibility with the first
|
|---|
| 125 | version of GnuPG, because some programs or scripts need them. Issue, as
|
|---|
| 126 | <systemitem class="username">root</systemitem> user:</para>
|
|---|
| 127 |
|
|---|
| 128 | <screen role="root"><userinput>for f in gpg gpgv
|
|---|
| 129 | do
|
|---|
| 130 | ln -svf ${f}2.1 /usr/share/man/man1/$f.1 &&
|
|---|
| 131 | ln -svf ${f}2 /usr/bin/$f
|
|---|
| 132 | done
|
|---|
| 133 | unset f</userinput></screen>
|
|---|
| 134 |
|
|---|
| 135 | <para>If you created alternate formats of the documentation, install it
|
|---|
| 136 | using the following command as the
|
|---|
| 137 | <systemitem class="username">root</systemitem> user:</para>
|
|---|
| 138 |
|
|---|
| 139 | <screen role="root"><userinput>install -v -m644 doc/gnupg.html/* \
|
|---|
| 140 | /usr/share/doc/gnupg-&gnupg2-version;/html &&
|
|---|
| 141 | install -v -m644 doc/gnupg.{pdf,dvi,ps} \
|
|---|
| 142 | /usr/share/doc/gnupg-&gnupg2-version;</userinput></screen>
|
|---|
| 143 |
|
|---|
| 144 | </sect2>
|
|---|
| 145 |
|
|---|
| 146 | <sect2 role="commands">
|
|---|
| 147 | <title>Command Explanations</title>
|
|---|
| 148 |
|
|---|
| 149 | <para><parameter>--docdir=/usr/share/doc/gnupg-&gnupg2-version;</parameter>:
|
|---|
| 150 | This switch changes the default docdir to <filename
|
|---|
| 151 | class="directory">/usr/share/doc/gnupg-&gnupg2-version;</filename>.</para>
|
|---|
| 152 |
|
|---|
| 153 | <para><parameter>--enable-symcryptrun</parameter>: This switch enables
|
|---|
| 154 | building the symcryptrun program.</para>
|
|---|
| 155 |
|
|---|
| 156 | </sect2>
|
|---|
| 157 |
|
|---|
| 158 | <sect2 role="content">
|
|---|
| 159 | <title>Contents</title>
|
|---|
| 160 |
|
|---|
| 161 | <segmentedlist>
|
|---|
| 162 | <segtitle>Installed Programs</segtitle>
|
|---|
| 163 | <segtitle>Installed Libraries</segtitle>
|
|---|
| 164 | <segtitle>Installed Directories</segtitle>
|
|---|
| 165 |
|
|---|
| 166 | <seglistitem>
|
|---|
| 167 | <seg>addgnupghome, applygnupgdefaults, gnupg-pcsc-wrapper, gpg,
|
|---|
| 168 | gpg-agent, gpg-check-pattern, gpg-connect-agent, gpg-preset-passphrase,
|
|---|
| 169 | gpg-protect-tool, gpg2, gpg2keys_curl, gpg2keys_finger, gpg2keys_hkp,
|
|---|
| 170 | gpg2keys_ldap, gpgconf, gpgkey2ssh, gpgparsemail, gpgsm,
|
|---|
| 171 | gpgsm-gencert.sh, gpgv, gpgv2, kbxutil, scdaemon, symcryptrun,
|
|---|
| 172 | and watchgnupg</seg>
|
|---|
| 173 | <seg>None</seg>
|
|---|
| 174 | <seg>/usr/share/doc/gnupg-&gnupg2-version; and
|
|---|
| 175 | /usr/share/gnupg</seg>
|
|---|
| 176 | </seglistitem>
|
|---|
| 177 | </segmentedlist>
|
|---|
| 178 |
|
|---|
| 179 | <variablelist>
|
|---|
| 180 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
|---|
| 181 | <?dbfo list-presentation="list"?>
|
|---|
| 182 | <?dbhtml list-presentation="table"?>
|
|---|
| 183 |
|
|---|
| 184 | <varlistentry id="addgnupghome">
|
|---|
| 185 | <term><command>addgnupghome</command></term>
|
|---|
| 186 | <listitem>
|
|---|
| 187 | <para>is used to create and populate user's
|
|---|
| 188 | <filename class='directory'>~/.gnupg</filename> directories</para>
|
|---|
| 189 | <indexterm zone="gnupg2 addgnupghome">
|
|---|
| 190 | <primary sortas="b-addgnupghome">addgnupghome</primary>
|
|---|
| 191 | </indexterm>
|
|---|
| 192 | </listitem>
|
|---|
| 193 | </varlistentry>
|
|---|
| 194 |
|
|---|
| 195 | <varlistentry id="applygnupgdefaults">
|
|---|
| 196 | <term><command>applygnupgdefaults</command></term>
|
|---|
| 197 | <listitem>
|
|---|
| 198 | <para>is a wrapper script used to run <command>gpgconf</command>
|
|---|
| 199 | with the <parameter>--apply-defaults</parameter> parameter on all
|
|---|
| 200 | user's GnuPG home directories.</para>
|
|---|
| 201 | <indexterm zone="gnupg2 applygnupgdefaults">
|
|---|
| 202 | <primary sortas="b-applygnupgdefaults">applygnupgdefaults</primary>
|
|---|
| 203 | </indexterm>
|
|---|
| 204 | </listitem>
|
|---|
| 205 | </varlistentry>
|
|---|
| 206 |
|
|---|
| 207 | <varlistentry id="gpg-agent">
|
|---|
| 208 | <term><command>gpg-agent</command></term>
|
|---|
| 209 | <listitem>
|
|---|
| 210 | <para>is a daemon used to manage secret (private) keys independently
|
|---|
| 211 | from any protocol. It is used as a backend for <command>gpg2</command>
|
|---|
| 212 | and <command>gpgsm</command> as well as for a couple of other
|
|---|
| 213 | utilities.</para>
|
|---|
| 214 | <indexterm zone="gnupg2 gpg-agent">
|
|---|
| 215 | <primary sortas="b-gpg-agent">gpg-agent</primary>
|
|---|
| 216 | </indexterm>
|
|---|
| 217 | </listitem>
|
|---|
| 218 | </varlistentry>
|
|---|
| 219 |
|
|---|
| 220 | <varlistentry id="gpg-connect-agent">
|
|---|
| 221 | <term><command>gpg-connect-agent</command></term>
|
|---|
| 222 | <listitem>
|
|---|
| 223 | <para>is a utility used to communicate with a running
|
|---|
| 224 | <command>gpg-agent</command>.</para>
|
|---|
| 225 | <indexterm zone="gnupg2 gpg-connect-agent">
|
|---|
| 226 | <primary sortas="b-gpg-connect-agent">gpg-connect-agent</primary>
|
|---|
| 227 | </indexterm>
|
|---|
| 228 | </listitem>
|
|---|
| 229 | </varlistentry>
|
|---|
| 230 |
|
|---|
| 231 | <varlistentry id="gpg">
|
|---|
| 232 | <term><command>gpg</command></term>
|
|---|
| 233 | <listitem>
|
|---|
| 234 | <para>(optional) is a symlink to <command>gpg2</command> for
|
|---|
| 235 | compatibility with the first version of GnuPG.</para>
|
|---|
| 236 | <indexterm zone="gnupg2 gpg">
|
|---|
| 237 | <primary sortas="b-gpg">gpg</primary>
|
|---|
| 238 | </indexterm>
|
|---|
| 239 | </listitem>
|
|---|
| 240 | </varlistentry>
|
|---|
| 241 |
|
|---|
| 242 | <varlistentry id="gpg2">
|
|---|
| 243 | <term><command>gpg2</command></term>
|
|---|
| 244 | <listitem>
|
|---|
| 245 | <para>is the OpenPGP part of the GNU Privacy Guard (GnuPG). It is a
|
|---|
| 246 | tool used to provide digital encryption and signing services using
|
|---|
| 247 | the OpenPGP standard.</para>
|
|---|
| 248 | <indexterm zone="gnupg2 gpg2">
|
|---|
| 249 | <primary sortas="b-gpg2">gpg2</primary>
|
|---|
| 250 | </indexterm>
|
|---|
| 251 | </listitem>
|
|---|
| 252 | </varlistentry>
|
|---|
| 253 |
|
|---|
| 254 | <varlistentry id="gpgconf">
|
|---|
| 255 | <term><command>gpgconf</command></term>
|
|---|
| 256 | <listitem>
|
|---|
| 257 | <para>is a utility used to automatically and reasonable safely
|
|---|
| 258 | query and modify configuration files in the
|
|---|
| 259 | <filename class='directory'>~/.gnupg</filename> home directory. It is
|
|---|
| 260 | designed not to be invoked manually by the user, but automatically by
|
|---|
| 261 | graphical user interfaces.</para>
|
|---|
| 262 | <indexterm zone="gnupg2 gpgconf">
|
|---|
| 263 | <primary sortas="b-gpgconf">gpgconf</primary>
|
|---|
| 264 | </indexterm>
|
|---|
| 265 | </listitem>
|
|---|
| 266 | </varlistentry>
|
|---|
| 267 |
|
|---|
| 268 | <varlistentry id="gpgparsemail">
|
|---|
| 269 | <term><command>gpgparsemail</command></term>
|
|---|
| 270 | <listitem>
|
|---|
| 271 | <para>is a utility currently only useful for debugging. Run it with
|
|---|
| 272 | <parameter>--help</parameter> for usage information.</para>
|
|---|
| 273 | <indexterm zone="gnupg2 gpgparsemail">
|
|---|
| 274 | <primary sortas="b-gpgparsemail">gpgparsemail</primary>
|
|---|
| 275 | </indexterm>
|
|---|
| 276 | </listitem>
|
|---|
| 277 | </varlistentry>
|
|---|
| 278 |
|
|---|
| 279 | <varlistentry id="gpgsm">
|
|---|
| 280 | <term><command>gpgsm</command></term>
|
|---|
| 281 | <listitem>
|
|---|
| 282 | <para>is a tool similar to <command>gpg2</command> used to provide
|
|---|
| 283 | digital encryption and signing services on X.509 certificates and the
|
|---|
| 284 | CMS protocol. It is mainly used as a backend for S/MIME mail
|
|---|
| 285 | processing.</para>
|
|---|
| 286 | <indexterm zone="gnupg2 gpgsm">
|
|---|
| 287 | <primary sortas="b-gpgsm">gpgsm</primary>
|
|---|
| 288 | </indexterm>
|
|---|
| 289 | </listitem>
|
|---|
| 290 | </varlistentry>
|
|---|
| 291 |
|
|---|
| 292 | <varlistentry id="gpgsm-gencert.sh">
|
|---|
| 293 | <term><command>gpgsm-gencert.sh</command></term>
|
|---|
| 294 | <listitem>
|
|---|
| 295 | <para>is a simple tool used to interactively generate a certificate
|
|---|
| 296 | request which will be printed to stdout.</para>
|
|---|
| 297 | <indexterm zone="gnupg2 gpgsm-gencert.sh">
|
|---|
| 298 | <primary sortas="b-gpgsm-gencert.sh">gpgsm-gencert.sh</primary>
|
|---|
| 299 | </indexterm>
|
|---|
| 300 | </listitem>
|
|---|
| 301 | </varlistentry>
|
|---|
| 302 |
|
|---|
| 303 | <varlistentry id="gpgv">
|
|---|
| 304 | <term><command>gpgv</command></term>
|
|---|
| 305 | <listitem>
|
|---|
| 306 | <para>(optional) is a symlink to <command>gpgv2</command> for
|
|---|
| 307 | compatibility with the first version of GnuPG.</para>
|
|---|
| 308 | <indexterm zone="gnupg2 gpgv">
|
|---|
| 309 | <primary sortas="b-gpgv">gpgv</primary>
|
|---|
| 310 | </indexterm>
|
|---|
| 311 | </listitem>
|
|---|
| 312 | </varlistentry>
|
|---|
| 313 |
|
|---|
| 314 | <varlistentry id="gpgv2">
|
|---|
| 315 | <term><command>gpgv2</command></term>
|
|---|
| 316 | <listitem>
|
|---|
| 317 | <para>is a verify only version of <command>gpg2</command>.</para>
|
|---|
| 318 | <indexterm zone="gnupg2 gpgv2">
|
|---|
| 319 | <primary sortas="b-gpgv2">gpgv2</primary>
|
|---|
| 320 | </indexterm>
|
|---|
| 321 | </listitem>
|
|---|
| 322 | </varlistentry>
|
|---|
| 323 |
|
|---|
| 324 | <varlistentry id="kbxutil">
|
|---|
| 325 | <term><command>kbxutil</command></term>
|
|---|
| 326 | <listitem>
|
|---|
| 327 | <para>is used to list, export and import Keybox data.</para>
|
|---|
| 328 | <indexterm zone="gnupg2 kbxutil">
|
|---|
| 329 | <primary sortas="b-kbxutil">kbxutil</primary>
|
|---|
| 330 | </indexterm>
|
|---|
| 331 | </listitem>
|
|---|
| 332 | </varlistentry>
|
|---|
| 333 |
|
|---|
| 334 | <varlistentry id="scdaemon">
|
|---|
| 335 | <term><command>scdaemon</command></term>
|
|---|
| 336 | <listitem>
|
|---|
| 337 | <para>is a daemon used to manage smartcards. It is usually invoked by
|
|---|
| 338 | <command>gpg-agent</command> and in general not used directly.</para>
|
|---|
| 339 | <indexterm zone="gnupg2 scdaemon">
|
|---|
| 340 | <primary sortas="b-scdaemon">scdaemon</primary>
|
|---|
| 341 | </indexterm>
|
|---|
| 342 | </listitem>
|
|---|
| 343 | </varlistentry>
|
|---|
| 344 |
|
|---|
| 345 | <varlistentry id="symcryptrun">
|
|---|
| 346 | <term><command>symcryptrun</command></term>
|
|---|
| 347 | <listitem>
|
|---|
| 348 | <para>is a simple symmetric encryption tool.</para>
|
|---|
| 349 | <indexterm zone="gnupg2 symcryptrun">
|
|---|
| 350 | <primary sortas="b-symcryptrun">symcryptrun</primary>
|
|---|
| 351 | </indexterm>
|
|---|
| 352 | </listitem>
|
|---|
| 353 | </varlistentry>
|
|---|
| 354 |
|
|---|
| 355 | <varlistentry id="watchgnupg">
|
|---|
| 356 | <term><command>watchgnupg</command></term>
|
|---|
| 357 | <listitem>
|
|---|
| 358 | <para>is used to listen to a Unix Domain socket created by any of
|
|---|
| 359 | the GnuPG tools.</para>
|
|---|
| 360 | <indexterm zone="gnupg2 watchgnupg">
|
|---|
| 361 | <primary sortas="b-watchgnupg">watchgnupg</primary>
|
|---|
| 362 | </indexterm>
|
|---|
| 363 | </listitem>
|
|---|
| 364 | </varlistentry>
|
|---|
| 365 |
|
|---|
| 366 | </variablelist>
|
|---|
| 367 |
|
|---|
| 368 | </sect2>
|
|---|
| 369 |
|
|---|
| 370 | </sect1>
|
|---|
