* NEWS, configure.ac: Switch over to using curl or fake-curl by
[gnupg.git] / README
diff --git a/README b/README
index 22d1ad0..967b258 100644 (file)
--- a/README
+++ b/README
@@ -1,10 +1,10 @@
 
                    GnuPG - The GNU Privacy Guard
                   -------------------------------
-                           Version 1.3.6
+                           Version 1.4.2
 
-           Copyright 1998, 1999, 2000, 2001, 2002, 2003,
-                2004 Free Software Foundation, Inc.
+        Copyright 1998, 1999, 2000, 2001, 2002, 2003, 2004,
+                2005 Free Software Foundation, Inc.
 
     This file is free software; as a special exception the author
     gives unlimited permission to copy and/or distribute it, with or
@@ -54,7 +54,8 @@
        this.  Don't skip it - this is an important step!
 
     2) Unpack the tarball.  With GNU tar you can do it this way:
-       "tar xzvf gnupg-x.y.z.tar.gz"
+       "tar xzvf gnupg-x.y.z.tar.gz".  If got a bzip2 compressed
+       tarball you need to use: "tar xjvf gnupg-x.y.z.tar.bz2".
 
     3) "cd gnupg-x.y.z"
 
     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
+       $ gpg --verify gnupg-x.y.z.tar.gz.sig
 
-       This checks that the detached signature gnupg-x.y.z.tar.gz.asc
-       is indeed a signature of gnupg-x.y.z.tar.gz.  The key used to
+       This checks that the detached signature gnupg-x.y.z.tar.gz.sig
+       is indeed 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>"
 
 
     b) If you don't have any of the above programs, you have to verify
-       the MD5 checksum:
+       the SHA1 checksum:
 
-       $ md5sum gnupg-x.y.z.tar.gz
+       $ sha1sum gnupg-x.y.z.tar.gz
 
        This should yield an output _similar_ to this:
 
-       fd9351b26b3189c1d577f0970f9dcadc  gnupg-x.y.z.tar.gz
+       fd9351b26b3189c1d577f0970f9dcadc1234abcd  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.
                       auto - Compile linux, egd and unix in and 
                              automagically select at runtime.
   
-    --with-egd-socket=<name>
+     --with-egd-socket=<name>
                      This is only used when EGD is used as random
                      gatherer. GnuPG uses by default "~/.gnupg/entropy"
                      as the socket to connect EGD.  Using this option the
                      "~/" uses the socket in the home directory of the user
                      and one starting with a "=" uses a socket in the
                      GnuPG home directory which is "~/.gnupg" by default.
-   
+     --without-readline
+                     Do not include support for the readline library
+                     even if it is available.  The default is to check
+                     whether the readline library is a available and
+                     use it to allow fancy command line editing.
+  
      --with-included-zlib
                      Forces usage of the local zlib sources. Default is
                     to use the (shared) library of the system.
      --disable-twofish
      --disable-sha256
      --disable-sha512
-                   Removes support for the selected symmetric
+                   Removes support for the selected symmetric or hash
                    algorithm.  This can give a smaller gpg binary for
                    places where space is tight.
 
                    The public key preference list can be updated to
                    match the list of available algorithms by using
                    "gpg --edit-key (thekey)", and running the
-                   "updpref" command.
+                   "setpref" command.
 
      --enable-minimal
-                   Build the smallest gpg possible (disables all
-                   optional algorithms, disables keyserver access,
-                   and disables photo IDs).  Specifically, this means
-                   --disable-rsa --disable-idea, --disable-cast5,
-                   --disable-blowfish, --disable-aes,
-                   --disable-twofish, --disable-sha256,
-                   --disable-sha512, --without-bzip2, and
-                   --disable-exec.  Configure command lines are read
-                   from left to right, so if you want to have an
-                   "almost minimal" configuration, you can do (for
-                   example) "--enable-minimal --enable-rsa" to have
-                   RSA added to the minimal build.
+                   Build the smallest gpg binary possible (disables
+                   all optional algorithms, disables keyserver
+                   access, and disables photo IDs).  Specifically,
+                   this means --disable-rsa --disable-idea,
+                   --disable-cast5, --disable-blowfish,
+                   --disable-aes, --disable-twofish,
+                   --disable-sha256, --disable-sha512,
+                   --without-bzip2, --disable-exec, 
+                    --disable-card-support and
+                   --disable-agent-support.
+                    Configure command lines are read from left to
+                   right, so if you want to have an "almost minimal"
+                   configuration, you can do (for example)
+                   "--enable-minimal --enable-rsa" to have RSA added
+                   to the minimal build.
 
      --enable-key-cache=SIZE
                     Set the internal key and UID cache size.  This has
                     platforms where memory is an issue, it can be set
                     as low as 5.
 
+     --disable-card-support
+                    Do not include smartcard support.  The default is
+                    to include support if all required libraries are
+                    available.
+
+     --disable-agent-support
+                    Do not include support for the gpg-agent.  The
+                    default is to include support.
+
+     --enable-selinux-support
+                    This prevents access to certain files and won't
+                    allow import or export of secret keys. 
+
+     --enable-noexecstack
+                    Pass option --noexecstack to as.  Works only when
+                    using gcc.
+
+     --disable-gnupg-iconv
+                    If iconv is available it is used to convert
+                    between utf-8 and the system character set.  This
+                    is in general the preferable solution.  However
+                    the code is new and under some cirumstances it may
+                    give different output than with the limited old
+                    support.  This option allows to explicity disable
+                    the use of iconv.  Note, that iconv is also
+                    disabled if gettext has been disabled.
+
+     --enable-backsigs
+                    Enables "backsigs" support.  This is a currently
+                   experimental solution to a subtle OpenPGP protocol
+                   problem involving signing subkeys.  It is
+                   specified in the 2440bis drafts that will become
+                   the new OpenPGP standard, but is not finalized yet
+                   and has not had interoperability testing.  Use at
+                   your own risk.
+
 
     Installation Problems
     ---------------------
     rpm in /usr/src/redhat/SRPMS
 
 
+
+    GnuPG 1.4 and GnuPG 1.9
+    -----------------------
+    GnuPG 1.4 is the stable version of GnuPG; GnuPG 1.9 is the
+    development branch.  However, large parts of GnuPG 1.9 are also
+    considered to be stable and useful.  In particular the tools
+    "gpg-agent" (private key operations and passphrase caching) and
+    "gpgsm" (S/MIME cousin of "gpg") are considered stable.  Both
+    packages (1.4.x and 1.9.x) may be installed at the same time and
+    it is actually suggested to do this if you need S/MIME support or
+    want to make use of gpg-agent.
+
+
+
     How to Get More Information
     ---------------------------
 
        gnupg-announce@gnupg.org    For important announcements like
                                    new versions and such stuff.
                                    This is a moderated list and has
-                                   very low traffic.
+                                   very low traffic.  Do not post to
+                                   this list.
 
        gnupg-users@gnupg.org       For general user discussion and
-                                   help.
+                                   help (English).
+
+        gnupg-de@gnupg.org          German speaking counterpart of
+                                    gnupg-users.
+
+        gnupg-ru@gnupg.org          Russian speaking counterpart of
+                                    gnupg-users.
 
        gnupg-devel@gnupg.org       GnuPG developers main forum.
 
 
     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.
+    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.
 
     Commercial grade support for GnuPG is available; please see
-    the GNU service directory or search other resources.
+    the GNU service directory or check out http://g10code.com.