fix for bug 537 and documentation fixes.
[gnupg.git] / README
diff --git a/README b/README
index 00d25a9..bd7b473 100644 (file)
--- a/README
+++ b/README
@@ -1,18 +1,19 @@
 
                    GnuPG - The GNU Privacy Guard
                   -------------------------------
-                           Version 1.3.2
+                           Version 1.4.6
 
-            Copyright 1998, 1999, 2000, 2001, 2002, 2003
-                   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 without
-    modifications, as long as this notice is preserved.
+    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.
 
     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.
+    WITHOUT ANY WARRANTY, to the extent permitted by law; without even
+    the implied warranty of MERCHANTABILITY or FITNESS FOR A
+    PARTICULAR PURPOSE.
 
 
     Intro
 
     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 http://www.gnupg.org/download/supported_systems.html 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 IDEA (which is patented
-    worldwide).
+    Because GnuPG does not use use any patented algorithms it is not
+    by default fully compatible with PGP 2.x, which uses the patented
+    IDEA algorithm.  See http://www.gnupg.org/why-not-idea.html for
+    more information on this subject, including what to do if you are
+    legally entitled to use IDEA.
 
-    The default algorithms are DSA and ElGamal, but RSA is also
-    supported.  ElGamal for signing is 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: AES, 3DES, Blowfish, CAST5 and Twofish.
-    Digest algorithms available are MD5, RIPEMD160 and SHA1.
+    The default public key algorithms are DSA and Elgamal, but RSA is
+    also supported.  Symmetric algorithms available are AES (with 128,
+    192, and 256 bit keys), 3DES, Blowfish, CAST5 and Twofish.  Digest
+    algorithms available are MD5, RIPEMD/160, SHA-1, SHA-256, SHA-384,
+    and SHA-512.  Compression algorithms available are ZIP, ZLIB, and
+    BZIP2 (with libbz2 installed).
 
 
     Installation
     ------------
+
     Please read the file INSTALL and the sections in this file
     related to the installation.  Here is a quick summary:
 
     1) Check that you have unmodified sources.  See 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"
+    2) Unpack the tarball.  With GNU tar you can do it this way:
+       "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"
 
-    4) "./configure"
+    4) "./configure"
 
     5) "make"
 
 
     7) You end up with a "gpg" binary in /usr/local/bin.
 
-    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/gpg.conf
+    8) To avoid swapping out of sensitive data, you can install "gpg"
+       setuid root.  If you don't do so, you may want to add the
+       option "no-secmem-warning" to ~/.gnupg/gpg.conf
 
 
     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"
@@ -91,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.
 
 
-
     Documentation
     -------------
-    The manual will be distributed separate under the name "gph".
+
+    The manual will be distributed separately under the name "gph".
     An online version of the latest manual draft is available at the
     GnuPG web pages:
 
-       http://www.gnupg.org/gph/
+       http://www.gnupg.org/documentation/
 
-    A list of frequently asked questions is available in GnuPG's
-    distibution in the file doc/FAQ and online as:
+    A list of frequently asked questions is available in the GnuPG
+    distribution in the file doc/FAQ and online as:
 
-       http://www.gnupg.org/faq.html
+       http://www.gnupg.org/documentation/faqs.html
 
     A couple of HOWTO documents are available online; for a listing see:
 
-       http://www.gnupg.org/docs.html#howtos
+       http://www.gnupg.org/documentation/howtos.html
 
     A man page with a description of all commands and options gets installed
     along with the program. 
 
     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
     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
-    running gpg once to create the correct directory.
+    The first time you run gpg, it will create a .gnupg directory in
+    your home directory and populate it with a default configuration
+    file.  Once this is done, you may create a new key, or if you
+    already have keyrings from PGP, you can import them into GnuPG
+    with:
+
+        gpg --import path/to/pgp/keyring/pubring.pkr
+    and
+        gpg --import path/to/pgp/keyring/secring.skr
 
     The normal way to create a key is
 
     good random numbers for the key parameters, GnuPG needs to gather
     enough noise (entropy) from your system.  If you see no progress
     during key generation you should start some other activities such
-    as mouse moves or hitting on the CTRL and SHIFT keys.
+    as moving the mouse or hitting the CTRL and SHIFT keys.
 
     Generate a key ONLY on a machine where you have direct physical
-    access - don't do it over the network or on a machine used also
-    by others - especially if you have no access to the root account.
+    access - don't do it over the network or on a machine also used
+    by others, especially if you have no access to the root account.
 
     When you are asked for a passphrase use a good one which you can
-    easy remember.  Don't make the passphrase too long because you have
-    to type it for every decryption or signing; but, - AND THIS IS VERY
-    IMPORTANT - use a good one that is not easily to guess because the
-    security of the whole system relies on your secret key and the
-    passphrase that protects it when someone gains access to your secret
-    keyring.  A good way to select a passphrase is to figure out a short
-    nonsense sentence which makes some sense for you and modify it by
-    inserting extra spaces, non-letters and changing the case of some
-    characters - this is really easy to remember especially if you
-    associate some pictures with it.
+    easily remember.  Don't make the passphrase too long because you
+    have to type it for every decryption or signing; but, - AND THIS
+    IS VERY IMPORTANT - use a good one that is not easily to guess
+    because the security of the whole system relies on your secret key
+    and the passphrase that protects it when someone gains access to
+    your secret keyring.  One good way to select a passphrase is to
+    figure out a short nonsense sentence which makes some sense for
+    you and modify it by inserting extra spaces, non-letters and
+    changing the case of some characters - this is really easy to
+    remember especially if you associate some pictures with it.
 
     Next, you should create a revocation certificate in case someone
     gets knowledge of your secret key or you forgot your passphrase
     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):
        "123434343434343C3434343434343734349A3434"
        "0E12343434343434343434EAB3484343434343434"
 
-      The first one is MD5 the others are ripemd160 or sha1.
+      The first one is a short fingerprint for PGP 2.x style keys.
+      The others are long fingerprints for OpenPGP keys.
 
     * By an exact string:
 
 
     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.
 
                       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
                      socket name can be changed.  You may use any filename
                      here with 2 exceptions:  a filename starting with
-                     "~/" uses the socket in the homedirectory of the user
+                     "~/" uses the socket in the home directory of the user
                      and one starting with a "=" uses a socket in the
-                     GnuPG homedirectory which is bye default "~/.gnupg".
-   
+                     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.
 
+     --with-zlib=<DIR>
+                    Look for the system zlib in DIR.
+
+     --with-bzip2=<DIR>
+                    Look for the system libbz2 in DIR.
+
+     --without-bzip2
+                    Disable the BZIP2 compression algorithm.
+
      --with-included-gettext
                      Forces usage of the local gettext sources instead of
                     the one provided by your system.
      --disable-exec
                     Disable all remote program execution.  This
                    disables photo ID viewing as well as all keyserver
-                   types aside from HKP.
+                   access.
 
      --disable-photo-viewers
                     Disable only photo ID viewing.
 
      --disable-keyserver-helpers
-                    Disable only keyserver helpers (not including
-                   HKP).
+                    Disable only keyserver helpers.
 
      --disable-keyserver-path
                     Disables the user's ability to use the exec-path
                    disable any ability for the user to change it in
                    their options file.
 
+     --disable-rsa
+                   Removes support for the RSA public key algorithm.
+                    This can give a smaller gpg binary for places
+                    where space is tight.
+
      --disable-idea
      --disable-cast5
      --disable-blowfish
      --disable-twofish
      --disable-sha256
      --disable-sha512
-                   Removes support for the selected algorithm.  This
-                   can give a smaller gpg binary for places where
-                   space is tight.
+                   Removes support for the selected symmetric or hash
+                   algorithm.  This can give a smaller gpg binary for
+                   places where space is tight.
 
-                   *** Note, that if there are existing keys that
+                   **** Note that if there are existing keys that
                    have one of these algorithms as a preference,
                    messages may be received that use one of these
                    algorithms and you will not be able to decrypt the
-                   message! ***
+                   message! ****
 
-                   A public key preference list can be updated to
+                   The public key preference list can be updated to
                    match the list of available algorithms by using
-                   'gpg --edit (thekey)', and running the "updpref"
-                   command.
+                   "gpg --edit-key (thekey)", and running the
+                   "setpref" command.
+
+     --enable-minimal
+                   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
+                    a significant impact on performance with large
+                    keyrings.  The default is 4096, but for use on
+                    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.  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
+                    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.
 
 
     Installation Problems
     ---------------------
+
     If you get unresolved externals "gettext" you should run configure
     again with the option "--with-included-gettext"; this is version
-    0.10.35 which is available at alpha.gnu.org.
+    0.12.1 which is available at ftp.gnu.org.
 
     If you have other compile problems, try the configure options
     "--with-included-zlib" or "--disable-nls" (See ABOUT-NLS) or
 
     We can't check all assembler files, so if you have problems
     assembling them (or the program crashes) use --disable-asm with
-    ./configure.  The configure scripts may consider several
-    subdirectories to get all available assembler files; be sure to
-    delete the correct ones. The assembler replacements are in C and
-    in mpi/generic; never delete udiv-qrnnd.S in any CPU directory,
-    because there may be no C substitute.  Don't forget to delete
-    "config.cache" and run "./config.status --recheck".
+    ./configure.  If you opt to delete individual replacement files in
+    hopes of using the remaining ones, be aware that the configure
+    scripts may consider several subdirectories to get all available
+    assembler files; be sure to delete the correct ones. The assembler
+    replacements are in C and in mpi/generic; never delete
+    udiv-qrnnd.S in any CPU directory, because there may be no C
+    substitute.  Don't forget to delete "config.cache" and run
+    "./config.status --recheck".  We have also heard reports of
+    problems when using versions of gcc earlier than 2.96 along with a
+    non-GNU assembler (as).  If this applies to your platform, you can
+    either upgrade gcc to a more recent version, or use the GNU
+    assembler.
 
     Some make tools are broken - the best solution is to use GNU's
     make.  Try gmake or grab the sources from a GNU archive and
 
         ./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
         Due to problems with the ESIX as, you probably want to do
             CFLAGS="-O -K pentium" ./configure --disable-asm
 
+    * SunOS 4.1.4
+
+         ./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
     ---------------------------
 
     The primary WWW page is "http://www.gnupg.org"
     The primary FTP site is "ftp://ftp.gnupg.org/gcrypt/"
 
-    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.
+    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.
 
     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.
+                                   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.
 
     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 .
+    the mailing lists are available at
+    http://www.gnupg.org/documentation/mailing-lists.html
 
-    Please direct bug reports to <bug-gnupg@gnu.org> or post
+    Please direct bug reports to http://bugs.gnupg.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; 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.
-
+    http://www.gnupg.org/service.html .