* README.W32: Adjusted some descriptions. Fixed the regsitry
[gnupg.git] / README
diff --git a/README b/README
index 2d02f52..de3093e 100644 (file)
--- a/README
+++ b/README
@@ -1,62 +1,43 @@
-Please note that this is only a bug fix release and some things
-do not yet work - see TODO for parts which are problematic
 
+                   GnuPG - The GNU Privacy Guard
+                  -------------------------------
+                           Version 1.0
 
+    Copyright 1998, 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
 
------BEGIN PGP SIGNED MESSAGE-----
+    This file is free software; as a special exception the author gives
+    unlimited permission to copy and/or distribute it, with or without
+    modifications, as long as this notice is preserved.
 
-                   GnuPG - The GNU Privacy Guard
-                  -------------------------------
-                           Version 0.9
-
-    GnuPG is now in Beta test and you should report all bugs to the
-    mailing list (see below).  The 0.9.x versions are released mainly
-    to fix all remaining serious bugs. As soon as version 1.0 is out,
-    development will continue with a 1.1 series and bug fixes for the
-    1.0 version as needed.
-
-    GnuPG works best on GNU/Linux or *BSD.  Other Unices are
-    also supported but are not as well tested as the Free Unices.
-    Please verify the tar file with the PGP2 or GnuPG/PGP5
-    signatures provided.  My PGP2 key is well known and published in
-    the "Global Trust Register for 1998", ISBN 0-9532397-0-5.
-
-    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"
-
-    My new DSA key is:
-    "pub  1024D/621CC013 1998-07-07 Werner Koch <werner.koch@guug.de>"
-    "Key fingerprint = ECAF 7590 EB34 43B5 C7CF  3ACB 6C7E E1B8 621C C013"
-
-    You may want add my new DSA key 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 list is closed (only subscribers are allowed to post)
-    to avoid misuse by folks who don't know the Netiquette and trash
-    your mailspool with commercial junk.
+    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.
 
-    See the file COPYING for copyright and warranty information.
+    Intro
+    -----
+
+    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.
 
-    GnuPG is in compliance with RFC2440 (OpenPGP), see doc/OpenPGP 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.
+    See http://www.gnupg.org/gnupg.html#supsys for a list of systems
+    which are known to work.
+
+    See the file COPYING for copyright and warranty information.
 
     Because GnuPG does not use use any patented algorithm it cannot be
-    compatible with PGP2 versions.  PGP 2.x uses only IDEA (which is
-    patented worldwide) and RSA (which is patented in the United States
-    until Sep 20, 2000).
+    compatible with PGP2 versions.  PGP 2.x uses IDEA (which is patented
+    worldwide).
 
-    The default algorithms are now DSA and ElGamal.  ElGamal for signing
+    The default algorithms are DSA and ElGamal.  ElGamal for signing
     is still available, but because of the larger size of such
     signatures it is deprecated (Please note that the GnuPG
     implementation of ElGamal signatures is *not* insecure).  Symmetric
-    algorithms are: 3DES, Blowfish, and CAST5 (Twofish will come soon).
-    Digest algorithms available are MD5, RIPEMD160, SHA1, and TIGER/192.
+    algorithms are: AES, 3DES, Blowfish, CAST5 and Twofish 
+    Digest algorithms available are MD5, RIPEMD160 and SHA1.
 
 
     Installation
@@ -66,25 +47,107 @@ do not yet work - see TODO for parts which are problematic
 
     Here is a quick summary:
 
-    1) "./configure"
+    1) Check that you have unmodified sources. The below on how to do this.
+       Don't skip it - this is an important step!
+
+    2) Unpack the TAR.  With GNU tar you can do it this way:
+       "tar xzvf gnupg-x.y.z.tar.gz"
+
+    3) "cd gnupg-x.y.z"
+
+    4) "./configure"
+
+    5) "make"
+
+    6) "make install"
+
+    7) You end up with a "gpg" binary in /usr/local/bin.
+       Note: Because some old programs rely on the existence of a
+       binary named "gpgm" (which was build by some Beta versions
+       of GnuPG); you may want to install a symbolic link to it:
+       "cd /usr/local/bin; ln -s gpg gpgm"
+
+    8) To avoid swapping out of sensitive data, you can install "gpg" as
+       suid root.  If you don't do so, you may want to add the option
+       "no-secmem-warning" to ~/.gnupg/options
+
+
+    How to Verify the Source
+    ------------------------
+
+    In order to check that the version of GnuPG which you are going to
+    install is an original and unmodified one, you can do it in one of
+    the following ways:
+
+    a) If you already have a trusted Version of GnuPG installed, you
+       can simply check the supplied signature:
+
+       $ gpg --verify gnupg-x.y.z.tar.gz.asc
+
+       This checks that the detached signature gnupg-x.y.z.tar.gz.asc
+       is indeed a a signature of gnupg-x.y.z.tar.gz.  The key used to
+       create this signature is:
+
+       "pub  1024D/57548DCD 1998-07-07 Werner Koch (gnupg sig) <dd9jn@gnu.org>"
+
+       If you do not have this key, you can get it from the source in
+       the file doc/samplekeys.asc (use "gpg --import  doc/samplekeys.asc"
+       to add it to the keyring) or from any keyserver.  You have to
+       make sure that this is really the key and not a faked one. You
+       can do this by comparing the output of:
+
+               $ gpg --fingerprint 0x57548DCD
 
-    2) "make"
+       with the elsewhere published fingerprint
 
-    3) "make install"
+       Please note, that you have to use an old version of GnuPG to
+       do all this stuff.  *Never* use the version which you are going
+       to check!
 
-    4) You end up with the binaries "gpg" and "gpgm" in /usr/local/bin.
 
-    5) Optional, but suggested, install the binary "gpg" as suid root.
+    b) If you don't have any of the above programs, you have to verify
+       the MD5 checksum:
 
+       $ md5sum gnupg-x.y.z.tar.gz
+
+       This should yield an output _similar_ to this:
+
+       fd9351b26b3189c1d577f0970f9dcadc  gnupg-x.y.z.tar.gz
+
+       Now check that this checksum is _exactly_ the same as the one
+       published via the announcement list and probably via Usenet.
+
+
+
+    Documentation
+    -------------
+
+    The manual will be distributed separate under the name "gph".
+    An online version of the latest manual draft is available at the
+    GnuPG web pages:
+
+       http://www.gnupg.org/gph/
+
+    A list of frequently asked questions is available in GnuPG's
+    distibution in the file doc/FAQ and online as:
+
+       http://www.gnupg.org/faq.html
+
+    A couple of HOWTO documents are available online; for a listing see:
+
+       http://www.gnupg.org/docs.html#howtos
+
+    A man page with a description of all commands and options gets installed
+    along with the program. 
 
 
     Introduction
     ------------
 
-    This is a brief overview how to use GnuPG - it is strongly suggested
-    that you read the manual^H^H^H more information about the use of
-    cryptography.  GnuPG is only a tool, secure results require that YOU
-    KNOW WHAT YOU ARE DOING.
+    Here is a brief overview on how to use GnuPG - it is strongly suggested
+    that you read the manual and other information about the use of
+    cryptography.  GnuPG is only a tool, secure usage requires that
+    YOU KNOW WHAT YOU ARE DOING.
 
     If you already have a DSA key from PGP 5 (they call them DH/ElGamal)
     you can simply copy the pgp keyrings over the GnuPG keyrings after
@@ -230,7 +293,8 @@ do not yet work - see TODO for parts which are problematic
     key - different keys will always have different fingerprints.
     It is easy to compare fingerprints by phone and I suggest
     that you print your fingerprint on the back of your business
-    card.
+    card.  To see the fingerprints of the secondary keys, you can
+    give the command twice; but this is normally not needed.
 
     If you don't know the owner of the public key you are in trouble.
     Suppose however that friend of yours knows someone who knows someone
@@ -357,17 +421,10 @@ do not yet work - see TODO for parts which are problematic
 
        "+Heinrich Heine duesseldorf"
 
-      All words must match excatly (not case sensitive) and appear in
+      All words must match exactly (not case sensitive) and appear in
       any order in the user ID.  Words are any sequences of letters,
       digits, the underscore and characters with bit 7 set.
 
-    * By the Local ID (from the trust DB):
-
-       "#34"
-
-      This may be used by a MUA to specify an exact key after selecting
-      a key from GnuPG (by using a special option or an extra utility)
-
     * Or by the usual substring:
 
        "Heine"
@@ -381,7 +438,7 @@ do not yet work - see TODO for parts which are problematic
     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 "--passphrase-fd n", which works like PGPs
+    you can use the option "--passphrase-fd n", which works like PGP's
     PGPPASSFD.
 
     Batch mode also causes GnuPG to terminate as soon as a BAD signature is
@@ -396,57 +453,45 @@ do not yet work - see TODO for parts which are problematic
     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.  This command should list all
-    kinds of rfc2440 messages.
+    How to Get More Information
+    ---------------------------
 
-       gpgm --list-trustdb
-
-    List the contents of the trust DB in a human readable format
-
-       gpgm --list-trustdb  <usernames>
-
-    List the tree of certificates for the given usernames
+    The primary WWW page is "http://www.gnupg.org"
+    The primary FTP site is "ftp://ftp.gnupg.org/gcrypt/"
 
-       gpgm --list-trust-path  username
+    See http://www.gnupg.org/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.
 
-    List the possible trust paths for the given username. The length
-    of such a trust path is limited by the option --max-cert-depth
-    which defaults to 5.
+    We have some mailing lists dedicated to GnuPG:
 
-    For more options/commands see the man page or use "gpg --help".
+       gnupg-announce@gnupg.org    For important announcements like
+                                   new versions and such stuff.
+                                   This is a moderated list and has
+                                   very low traffic.
 
+       gnupg-users@gnupg.org       For general user discussion and
+                                   help.
 
-    Other Notes
-    -----------
+       gnupg-devel@gnupg.org       GnuPG developers main forum.
 
-    The primary FTP site is "ftp://ftp.gnupg.org/pub/gcrypt/"
-    The primary WWW page is "http://www.gnupg.org"
+    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 is available at http://lists.gnupg.org .
 
-    See http://www.gnupg.org/mirrors.html for a list of FTP mirrors
-    and use them if possible.
+    The gnupg.org domain is hosted in Germany to avoid possible legal
+    problems (technical advices may count as a violation of ITAR).
 
-    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 - subscribe before posting, see above (~line 33)).
-    Please direct questions about GnuPG to the mailing list or
-    one of the pgp newsgroups and give me more time to improve
-    GnuPG.  Commercial support for GnuPG will be available soon.
+    Please direct bug reports to <gnupg-bugs@gnu.org> or post
+    them direct to the mailing list <gnupg-devel@gnupg.org>.
 
-    Have fun and remember: Echelon is looking at you kid.
+    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.  Both mailing lists are watched by the authors
+    and we try to answer questions when time allows us to do so.
 
------BEGIN PGP SIGNATURE-----
-Version: GnuPG v0.9.2 (GNU/Linux)
-Comment: For info see http://www.gnupg.org
+    Commercial grade support for GnuPG is available; please see
+    the GNU service directory or search other resources.
 
-iQB1AwUBNr2fPh0Z9MEMmFelAQHqNAL/e7pApR0CGUJ/zuIsjaVhNGPEgKAglcEd
-YuVdB+RCN0wq7ZfI0AHU2FdVISRACmSN3xituTTgeiOUsczM40EZ4l1XNfyRF768
-fglui6XxEeYHFY7mSQMgzzFWDG0Squx0
-=enRo
------END PGP SIGNATURE-----