* w32installer.nsi: New.
[gnupg.git] / README
diff --git a/README b/README
index 051b350..047dcab 100644 (file)
--- a/README
+++ b/README
@@ -1,18 +1,19 @@
 
                    GnuPG - The GNU Privacy Guard
                   -------------------------------
-                           Version 1.3.3
+                           Version 1.4.0
 
-            Copyright 1998, 1999, 2000, 2001, 2002, 2003
-                   Free Software Foundation, Inc.
+           Copyright 1998, 1999, 2000, 2001, 2002, 2003,
+                2004 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
     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 strongly 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, RIPEMD/160,
-    SHA-1, SHA-256, SHA-384, and SHA-512.  Compression algorithms
-    available are ZIP and ZLIB.
+    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
        "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:
 
                       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 libary
+                     even if it is available.  The default is to check
+                     whether the readline libarry is a availbale 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
+                   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
+                   "updpref" 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.
+
+     --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.
+
+     --enable-selinux-support
+                    This prevents access to certain files and won't
+                    allow import or export of secret keys. 
+
+     --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 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.
 
 
     Installation Problems
     ---------------------
     If you get unresolved externals "gettext" you should run configure
     again with the option "--with-included-gettext"; this is version
-    0.10.40 which is available at ftp.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
     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.