Updated
[gnupg.git] / README
diff --git a/README b/README
index 8e78f46..3c068fd 100644 (file)
--- a/README
+++ b/README
------BEGIN PGP SIGNED MESSAGE-----
+                       The GNU Privacy Guard 2
+                      =========================
+                             Version 2.0
 
-                 GnuPG - The GNU Privacy Guard
-                -------------------------------
-                         Version 0.4
+         Copyright 1998, 1999, 2000, 2001, 2002, 2003, 2004,
+           2005, 2006, 2007 Free Software Foundation, Inc.
 
-    As you can see from the version number, the program may have some
-    bugs and some features may not work at all - please report this to
-    the mailing list.
 
-    On a Linux box (version 2.x.x, alpha or x86 CPU) it should
-    work reliably.  You may create your key on such a machine and
-    use it.  Please verify the tar file; there is a PGP and a GnuPG
-    signature available. My PGP 2 key is well known and published in
-    the "Global Trust Register for 1998", ISBN 0-9532397-0-5.
+INTRODUCTION
+============
 
-    I have included my pubring as "g10/pubring.asc", which contains
-    the key used to make GnuPG signatures:
-    "pub  1024D/57548DCD 1998-07-07 Werner Koch (gnupg sig) <dd9jn@gnu.org>"
-    "Key fingerprint = 6BD9 050F D8FC 941B 4341  2DCC 68B7 AB89 5754 8DCD"
+GnuPG is GNU's tool for secure communication and data storage.  It can
+be used to encrypt data and to create digital signatures.  It includes
+an advanced key management facility and is compliant with the proposed
+OpenPGP Internet standard as described in RFC2440 and the S/MIME
+standard as described by several RFCs.
 
-    Old version of gnupg are signed with this key:
-    "pub  1312G/FF3EAA0B 1998-02-09 Werner Koch <wk@isil.d.shuttle.de>"
-    "Key fingerprint = 8489 6CD0 1851 0E33 45DA  CD67 036F 11B8 FF3E AA0B"
+GnuPG is distributed under the terms of the GNU General Public
+License.  See the file COPYING for details.  GnuPG works best on
+GNU/Linux or *BSD systems.  Most other Unices are also supported but
+are not as well tested as the Free Unices.
 
-    My usual key is now:
-    "pub  1024D/621CC013 1998-07-07 Werner Koch <werner.koch@guug.de>"
-    "Key fingerprint = ECAF 7590 EB34 43B5 C7CF  3ACB 6C7E E1B8 621C C013"
+GnuPG 2.0 is the stable version of GnuPG integrating support for
+OpenPGP and S/MIME.  It does not conflict with an installed 1.4
+OpenPGP-only version.
 
-    You may add it to your GnuPG pubring and use it in the future to
-    verify new releases.  Because you verified this README file and
-    _checked_that_it_is_really_my PGP2 key 0C9857A5, you can be sure
-    that the above fingerprints are correct.
 
-    Please subscribe to g10@net.lut.ac.uk by sending a mail with
-    the word "subscribe" in the body to "g10-request@net.lut.ac.uk".
-    This mailing is closed (only subscribers can post) to avoid spam.
 
-    See the file COPYING for copyright and warranty information.
+BUILD INSTRUCTIONS
+==================
 
-    Due to the fact that GnuPG does not use use any patented algorithm,
-    it cannot be compatible with old PGP versions, because those use
-    IDEA (which is patented worldwide) and RSA (which is patented in
-    the United States until Sep 20, 2000).
+GnuPG 2.0 depends on the following packages:
 
-    GnuPG is in compliance with RFC2440 (OpenPGP), see doc/OpenPGP for
-    deatils.
+  libgpg-error (ftp://ftp.gnupg.org/gcrypt/libgpg-error/)
+  libgcrypt    (ftp://ftp.gnupg.org/gcrypt/libgcrypt/)
+  libksba      (ftp://ftp.gnupg.org/gcrypt/libksba/)
+  libassuan    (ftp://ftp.gnupg.org/gcrypt/libassuan/)
+  
+You also need the Pinentry package for most function of GnuPG; however
+it is not a build requirement.  Pinentry is available at
+ftp://ftp.gnupg.org/gcrypt/pinentry/ .
 
-    The default algorithms are now DSA and ELGamal.  ELGamal for signing
-    is still available, but due to the larger size of such signatures it
-    is depreciated (Please note that the GnuPG implementation of ElGamal
-    signatures is *not* insecure).  Symmetric algorithms are: 3DES, Blowfish
-    and CAST5, Digest algorithms are MD5, RIPEMD160, SHA1 and TIGER/192.
+You should get the latest versions of course, the GnuPG configure
+script complains if a version is not sufficient.
 
+After building and installing the above packages in the order as given
+above, you may now continue with GnuPG installation (you may also just
+try to build GnuPG to see whether your already installed versions are
+sufficient).
 
+As with all packages, you just have to do
 
-    Installation
-    ------------
+ ./configure
+ make
+ make install
 
-    Please read the file INSTALL!
+(Before doing install you might need to become root.)
 
-    Here is a quick summary:
+If everything succeeds, you have a working GnuPG with support for
+S/MIME and smartcards.  Note that there is no binary gpg but a gpg2 so
+that this package won't conflict with a GnuPG 1.4 installation. gpg2
+behaves just like gpg.
 
-    1) "./configure"
+In case of problem please ask on gnupg-users@gnupg.org for advise.  Note
+that this release is only expected to build on GNU and *BSD systems.
 
-    2) "make"
 
-    3) "make install"
 
-    4) You end up with a binary "gpg" in /usr/local/bin
+DOCUMENTATION
+=============
 
-    5) Optional, but suggested: install the program "gpg" as suid root.
+The complete documentation is in the texinfo manual named
+`gnupg.info'.  Run "info gnupg" to read it.  If you want a a printable
+copy of the manual, change to the "doc" directory and enter "make pdf"
+For a HTML version enter "make html" and point your browser to
+gnupg.html/index.html.  Standard man pages for all components are
+provided as well.  An online version of the manual is available at
+http://www.gnupg.org/documentation/manuals/gnupg/ .  A version of the
+manual pertaining to the current development snapshot is at
+http://www.gnupg.org/documentation/manuals/gnupg-devel/ .
 
 
 
-    Key Generation
-    --------------
+GNUPG 1.4 AND GNUPG 2.0
+=======================
 
-       gpg --gen-key
+GnuPG 2.0 is a newer version of GnuPG with additional support for
+S/MIME.  It has a different design philosophy that splits
+functionality up into several modules.  Both versions may be installed
+simultaneously without any conflict (gpg is called gpg2 in GnuPG 2).
+In fact, the gpg version from GnuPG 1.4 is able to make use of the
+gpg-agent as included in GnuPG 2 and allows for seamless passphrase
+caching.  The advantage of GnuPG 1.4 is its smaller size and no
+dependency on other modules at run and build time.
 
-    This asks some questions and then starts key generation. To create
-    good random numbers for prime number generation, it uses a /dev/random
-    which will only emit bytes if the kernel can gather enough entropy.
-    If you see no progress, you should start some other activities such
-    as mouse moves, "find /" or using the keyboard (in another window).
-    Because we have no hardware device to generate randomness we have to
-    use this method.
 
-    You should make a revocation certificate in case someone gets
-    knowledge of your secret key or you forgot your passphrase:
+HOW TO GET MORE INFORMATION
+===========================
 
-       gpg --gen-revoke your_user_id
+The primary WWW page is "http://www.gnupg.org"
+The primary FTP site is "ftp://ftp.gnupg.org/gcrypt/"
 
-    Run this command and store it away; output is always ASCII armored,
-    so that you can print it and (hopefully never) re-create it if
-    your electronic media fails.
+See http://www.gnupg.org/download/mirrors.html for a list of mirrors
+and use them if possible.  You may also find GnuPG mirrored on some of
+the regular GNU mirrors.
 
-    If you decided to create a DSA key, you should add an ElGamal
-    for encryption:
+We have some mailing lists dedicated to GnuPG:
+   
+   gnupg-announce@gnupg.org   For important announcements like new
+                              versions and such stuff.  This is a
+                              moderated list and has very low traffic.
+                              Do not post to this list.
 
-       gpg --add-key user_id_of_your_key
+   gnupg-users@gnupg.org      For general user discussion and
+                              help (English).
 
-    and follow the displayed instructions (select "ElGamal using v4 packets").
+   gnupg-de@gnupg.org         German speaking counterpart of
+                              gnupg-users.
 
+   gnupg-ru@gnupg.org         Russian speaking counterpart of
+                              gnupg-users.
 
-    You can sign a key with this command:
+   gnupg-devel@gnupg.org      GnuPG developers main forum.
 
-       gpg --sign-key Donald
+You subscribe to one of the list by sending mail with a subject of
+"subscribe" to x-request@gnupg.org, where x is the name of the mailing
+list (gnupg-announce, gnupg-users, etc.).  An archive of the mailing
+lists are available at http://www.gnupg.org/documentation/mailing-lists.html
 
-    This let you sign the key of "Donald" with your default userid.
+Please direct bug reports to http://bugs.gnupg.org or post them direct
+to the mailing list <gnupg-devel@gnupg.org>.
 
-       gpg --sign-key -u Karl -u Joe Donald
+Please direct questions about GnuPG to the users mailing list or one
+of the pgp newsgroups; please do not direct questions to one of the
+authors directly as we are busy working on improvements and bug fixes.
+The English and German mailing lists are watched by the authors and we
+try to answer questions when time allows us to do so.
 
-    This let you sign the key of of "Donald" with the userids of "Karl"
-    and "Joe".
-    All existing signatures are checked; if some are invalid, a menu is
-    offered to delete some of them, and then you are asked for every user
-    whether you want to sign this key.
+Commercial grade support for GnuPG is available; please see
+http://www.gnupg.org/service.html .
 
-    You may remove a signature at any time using the option "--edit-sig",
-    which asks for the sigs to remove. Self-signatures are not removable.
 
+  This file is Free Software; as a special exception the authors gives
+  unlimited permission to copy and/or distribute it, with or without
+  modifications, as long as this notice is preserved. For conditions
+  of the whole package, please see the file COPYING.  This file is
+  distributed in the hope that it will be useful, but WITHOUT ANY
+  WARRANTY, to the extent permitted by law; without even the implied
+  warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 
-
-
-    Sign
-    ----
-
-       gpg -s file
-
-    This creates a file file.gpg which is compressed and has a signature
-    attached.
-
-       gpg -sa file
-
-    Same as above, but file.gpg is ascii armored.
-
-       gpg -s -o out file
-
-    Creates a signature of file, but writes the output to the file "out".
-
-    If you use the option "--rfc1991", gnupg tries to me more compatible
-    to RFC1991 (pgp 2.x).
-
-
-    Encrypt
-    -------
-
-       gpg -e -r heine file
-
-    This encrypts files with the public key of "heine" and writes it
-    to "file.gpg"
-
-       echo "hallo" | gpg -ea -r heine | mail heine
-
-    Ditto, but encrypts "hallo\n" and mails it as ascii armored message.
-
-
-    Sign and Encrypt
-    ----------------
-
-       gpg -se -r heine file
-
-    This encrypts files with the public key of "heine" and writes it
-    to "file.gpg" after signing it with the default user id.
-
-
-       gpg -se -r heine -u Suttner file
-
-    Ditto, but sign the file with the user id "Suttner"
-
-
-    Keyring Management
-    ------------------
-    To export your complete keyring(s) do this:
-
-       gpg --export
-
-    To export only some user ids do this:
-
-       gpg --export userids
-
-    Use "-a" or "--armor" to create ASCII armored output.
-
-    Importing keys is done with the option, you guessed it, "--import":
-
-       gpg --import [filenames]
-
-    New keys are appended to the default keyring and already existing
-    keys are merged.  Keys without a self-signature are ignored.
-
-
-    How to Specify a UserID
-    -----------------------
-    There are several ways to specify a userID, here are some examples:
-
-    * Only by the short keyid (prepend a zero if it begins with A..F):
-
-       "234567C4"
-       "0F34E556E"
-       "01347A56A"
-       "0xAB123456
-
-    * By a complete keyid:
-
-       "234AABBCC34567C4"
-       "0F323456784E56EAB"
-       "01AB3FED1347A5612"
-       "0x234AABBCC34567C4"
-
-    * By a fingerprint:
-
-       "1234343434343434C434343434343434"
-       "123434343434343C3434343434343734349A3434"
-       "0E12343434343434343434EAB3484343434343434"
-
-      The first one is MD5 the others are ripemd160 or sha1.
-
-    * By an exact string (not yet implemented):
-
-       "=Heinrich Heine <heinrichh@uni-duesseldorf.de>"
-
-    * By an email address:
-
-       "<heinrichh@uni-duesseldorf.de>"
-
-      This can be used by a keyserver instead of a substring to
-      find this key faster.
-
-    * By the Local ID (from the trustdb):
-
-       "#34"
-
-      This can be used by a MUA to specify an exact key after selecting
-      a key from GnuPG (by the use of a special option or an extra utility)
-
-
-    * Or by the usual substring:
-
-       "Heine"
-       "*Heine"
-
-      The '*' indicates substring search explicitly.
-
-
-
-
-    Batch mode
-    ----------
-    If you use the option "--batch", GnuPG runs in non-interactive mode and
-    never prompts for input data.  This does not even allow entering the
-    passphrase; until we have a better solution (something like ssh-agent),
-    you can use the option "--passhrase-fd n", which works like PGPs
-    PGPPASSFD.
-
-    Batch mode also causes GnuPG to terminate as soon as a BAD signature is
-    detected.
-
-
-    Exit status
-    -----------
-    GnuPG returns with an exit status of 1 if in batch mode and a bad signature
-    has been detected or 2 or higher for all other errors.  You should parse
-    stderr or the output of the fd specified with --status-fd to get detailed
-    information about the errors.
-
-
-    Esoteric commands
-    -----------------
-
-       gpg --list-packets datafile
-
-    Use this to list the contents of a data file. If the file is encrypted
-    you are asked for the passphrase, so that GnuPG is able to look at the
-    inner structure of a encrypted packet.
-
-       gpgm --list-trustdb
-
-    List the contents of the trustdb in a human readable format
-
-       gpgm --list-trustdb  <usernames>
-
-    List the tree of certificates for the given usernames
-
-       gpgm --list-trust-path  depth  username
-
-    List the possible trust paths for the given username, up to the specified
-    depth.  If depth is negative, duplicate introducers are not listed,
-    because those would increase the trust probability only minimally.
-    (you must use the special option "--" to stop option parsing when
-     using a negative number). This option may create new entries in the
-    trustdb.
-
-       gpgm --print-mds  filenames
-
-    List all available message digest values for the fiven filenames
-
-    For more options/commands see the file g10/OPTIONS, or use "gpg --help"
-
-
-    Debug Flags
-    -----------
-    Use the option "--debug n" to output debug information. This option
-    can be used multiple times, all values are ORed; n maybe prefixed with
-    0x to use hex-values.
-
-        value  used for
-        -----  ----------------------------------------------
-         1     packet reading/writing
-         2     MPI details
-         4     ciphers and primes (may reveal sensitive data)
-         8     iobuf filter functions
-         16    iobuf stuff
-         32    memory allocation stuff
-         64    caching
-         128   show memory statistics at exit
-         256   trust verification stuff
-
-
-    Other Notes
-    -----------
-    This is work in progress, so you may find duplicated code fragments,
-    ugly data structures, weird usage of filenames and other things.
-
-    The primary FTP site is "ftp://ftp.gnupg.org/pub/gcrypt/"
-    The primary WWW page is "http://www.gnupg.org"
-
-    If you like, send your keys to <gnupg-keys@isil.d.shuttle.de>; use
-    "gpg --export --armor | mail gnupg-keys@isil.d.shuttle.de" to do this.
-
-    Please direct bug reports to <gnupg-bugs@gnu.org> or better
-    post them to the mailing list <g10@net.lut.ac.uk> (this is a closed list,
-    please subscribe before posting, see above (~line 33)).
-
-
------BEGIN PGP SIGNATURE-----
-Version: GnuPG v0.4.4 (GNU/Linux)
-Comment: For info finger gcrypt@ftp.guug.de
-
-iQB1AwUBNlXAUh0Z9MEMmFelAQFmhwL/RfW9WxAMTh/edDy0yGTJjDgo7d/Kfmtq
-8C0LJ4b2M0py1ctW6jZyiQsYtvkrttKiTYXGtRoIzVFWX2hqABKPCTHzOeXQEOSu
-ro5fnRwsuj9cRxhH8lpN+diY+m1E5Fu3
-=sciv
------END PGP SIGNATURE-----