See ChangeLog: Fri Mar 24 11:25:45 CET 2000 Werner Koch
[libgcrypt.git] / README
diff --git a/README b/README
index 5d934b2..9292d36 100644 (file)
--- a/README
+++ b/README
@@ -2,21 +2,28 @@
 
                    GnuPG - The GNU Privacy Guard
                   -------------------------------
-                          Version 0.9.10
+                           Version 1.1
 
-    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.
+       WARNING:  This is the current development branch
+                 of GnuPG.  THIS SHOULD NOT BE USED IN
+                 A PRODUCTION ENVIRONMENT.  It will
+                 change quite often and may have serious
+                 problems.  Use the GnuPG from the stable
+                 Branch 1.0.x  for real work.  The next
+                 stable release will be 1.2
 
-    GnuPG works best on GNU/Linux or *BSD.  Other Unices are
-    also supported but are not as well tested as the Free Unices.
 
-    See the file COPYING for copyright and warranty information.
+    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 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.
 
-    GnuPG is in compliance with RFC2440 (OpenPGP), see doc/OpenPGP for
-    details.
+    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
@@ -28,9 +35,9 @@
     signatures it is deprecated (Please note that the GnuPG
     implementation of ElGamal signatures is *not* insecure).  Symmetric
     algorithms are: 3DES, Blowfish, CAST5 and Twofish (GnuPG does not
-    yet create Twofish encrypted messages because there no agreement
+    yet create Twofish encrypted messages because there is no agreement
     in the OpenPGP WG on how to use it together with a MDC algorithm)
-    Digest algorithms available are MD5, RIPEMD160, SHA1, and TIGER/192.
+    Digest algorithms available are MD5, RIPEMD160 and SHA1.
 
 
     Installation
@@ -56,9 +63,9 @@
 
     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"; you should install a symbolic link
-       from gpgm to gpg:
-       "cd /usr/local/bin; ln -s gpg gpgm"
+       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
 
        $ md5sum gnupg-x.y.z.tar.gz.sig
 
-       This should yield an output similar to this:
+       This should yield an output similar_to this:
 
        fd9351b26b3189c1d577f0970f9dcadc  gnupg-x.y.z.tar.gz
 
 
 
 
+    Documentation
+    -------------
+
+    A draft version of the manual is included in the subdirectory doc/gph.
+    The supplied version is rendered in HTML and you may access it with any
+    browser (e.g.: lynx doc/gpg/index.html).  The GnuPG webpages have a link
+    to the latest development version and you may want to read those instead.
+
+    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
     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.
-
-       gpg --list-trustdb
+    How to Get More Information
+    ---------------------------
 
-    List the contents of the trust DB in a human readable format
-
-       gpg --list-trustdb  <usernames>
-
-    List the tree of certificates for the given usernames
-
-       gpg --list-trust-path  username
-
-    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.
-
-    For more options/commands see the man page or use "gpg --help".
-
-
-    Other Notes
-    -----------
-
-    The primary FTP site is "ftp://ftp.gnupg.org/pub/gcrypt/"
     The primary WWW page is "http://www.gnupg.org"
+    The primary FTP site is "ftp://ftp.gnupg.org/pub/gcrypt/"
 
     See http://www.gnupg.org/mirrors.html for a list of FTP mirrors
-    and use them if possible.
+    and use them if possible.  You may also find GnuPG mirrored on
+    some of the regular GNU mirrors.
 
     We have some mailing lists dedicated to GnuPG:
 
 
     Please direct bug reports to <gnupg-bugs@gnu.org> or post
     them direct to the mailing list <gnupg-devel@gnupg.org>.
+
     Please direct questions about GnuPG to the users mailing list or
-    one of the pgp newsgroups and give me more time to improve
-    GnuPG.  Commercial support for GnuPG is also available; please
-    see the GNU service directory or search other resources.
+    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.
 
-    Have fun and remember: Echelon is looking at you kid.
+    Commercial grade support for GnuPG is available; please see
+    the GNU service directory or search other resources.
 
-- -----END PGP SIGNATURE-----
 -----BEGIN PGP SIGNATURE-----
-Version: GnuPG v0.9.9 (GNU/Linux)
+Version: GnuPG v1.0.0 (GNU/Linux)
 Comment: For info see http://www.gnupg.org
 
-iQB1AwUBN6figR0Z9MEMmFelAQHydwL+LuKC3W6kRkm0clwab3v8I7zlX0bagxzA
-RStlHXdO6ln1Mo3s3nBuCfrS6LogiUgNRFhNJQ5+rjrTydz00nzcorbyTalqvMlq
-Gnsu9Pd/pTPzvk6kP79yDdoBxfaQGcgw
-=W8uz
+iQB1AwUBN+M8CB0Z9MEMmFelAQFmggMAuwHxMcQPsS1r2pD1KVZ67qTUeZnSM+wP
+daX3wnBgZzxYhzZiuciaFYky6ERC0Er4HVKtSlLBPhY1N1y2d98Se7TTUaUsVY8F
+uvGJkK/7ykaHfWgcIbKFb6hlnpy29+mO
+=1oCH
 -----END PGP SIGNATURE-----