fix for bug 537 and documentation fixes.
[gnupg.git] / README
diff --git a/README b/README
index 047dcab..bd7b473 100644 (file)
--- a/README
+++ b/README
@@ -1,10 +1,10 @@
 
                    GnuPG - The GNU Privacy Guard
                   -------------------------------
-                           Version 1.4.0
+                           Version 1.4.6
 
-           Copyright 1998, 1999, 2000, 2001, 2002, 2003,
-                2004 Free Software Foundation, Inc.
+        Copyright 1998, 1999, 2000, 2001, 2002, 2003, 2004,
+                2005, 2006 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
@@ -47,6 +47,7 @@
 
     Installation
     ------------
+
     Please read the file INSTALL and the sections in this file
     related to the installation.  Here is a quick summary:
 
@@ -54,7 +55,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"
 
@@ -73,6 +75,7 @@
 
     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
+       $ 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 a signature of gnupg-x.y.z.tar.gz.  The key used to
-       create this signature is:
+       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 currently
+       used to create this signature is:
 
-       "pub  1024D/57548DCD 1998-07-07 Werner Koch (gnupg sig) <dd9jn@gnu.org>"
+       "pub  1024R/1CE0C630 2006-01-01 Werner Koch (dist 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"
@@ -94,7 +97,7 @@
        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
+               $ gpg --fingerprint 0x1CE0C630
 
        with the fingerprint published elsewhere.
 
 
 
     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.
 
     Introduction
     ------------
+
     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
     certify that they know the owner of the keys they sign.  If you then
     trust all the introducers to have correctly signed other keys, you
     can be be sure that the other key really belongs to the one who
-    claims to own it..
+    claims to own it.
 
     There are 2 steps to validate a key:
        1. First check that there is a complete chain
 
 
     8 Ways to Specify a User ID
-    --------------------------
+    ---------=-----------------
+
     There are several ways to specify a user ID, here are some examples.
 
     * Only by the short keyid (prepend a zero if it begins with A..F):
 
     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),
 
     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, better, the output of the fd specified with --status-fd to get
 
     Configure options 
     -----------------
+
     Here is a list of configure options which are sometime useful 
     for installation.
 
                      GnuPG home directory which is "~/.gnupg" by default.
  
      --without-readline
-                     Do not include support for the readline libary
+                     Do not include support for the readline library
                      even if it is available.  The default is to check
-                     whether the readline libarry is a availbale and
+                     whether the readline library is a available and
                      use it to allow fancy command line editing.
   
      --with-included-zlib
      --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
                     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.  Autdetect wether
+                    the tool chain actually support this.
+
      --disable-gnupg-iconv
                     If iconv is available it is used to convert
                     between utf-8 and the system character set.  This
                     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 getext 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.
+                    disabled if gettext has been disabled.
 
 
     Installation Problems
     ---------------------
+
     If you get unresolved externals "gettext" you should run configure
     again with the option "--with-included-gettext"; this is version
     0.12.1 which is available at ftp.gnu.org.
 
         ./configure --with-libiconv-prefix=/sw
 
-    * Compaq C V6.2 for alpha:
-
-        You may want to use the option "-msg-disable ptrmismatch1"
-        to get rid of the sign/unsigned char mismatch warnings.
-
     * IBM RS/6000 running AIX:
 
        Due to a change in gcc (since version 2.8) the MPI stuff may
 
          ./configure ac_cv_sys_symbol_underscore=yes
 
+
     The Random Device
     -----------------
 
 
     Creating an RPM package
     -----------------------
+
     The file scripts/gnupg.spec is used to build a RPM package (both
     binary and src):
       1. copy the spec file into /usr/src/redhat/SPECS
     rpm in /usr/src/redhat/SRPMS
 
 
+    Building Universal Binaries on Apple OS X
+    -----------------------------------------
+
+    You can build a universal ("fat") binary that will work on both
+    PPC and Intel Macs with something like:
+
+    ./configure CFLAGS="-arch ppc -arch i386" --disable-endian-check \
+               --disable-dependency-tracking --disable-asm
+
+    If you are doing the build on a OS X 10.4 (Tiger) PPC machine you
+    may need to add "-isysroot /Developer/SDKs/MacOSX10.4u.sdk" to
+    those CFLAGS.  Note that any third-party libraries you may link
+    with need to be universal as well.  All Apple-supplied libraries
+    (even libraries not originally written by Apple like curl, zip,
+    and BZ2) are universal.
+
+
+    GnuPG 1.4 and GnuPG 2.0
+    -----------------------
+
+    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.
+
+
     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 check out http://g10code.com.
+    http://www.gnupg.org/service.html .