* tr.po, el.po: Updated.
[gnupg.git] / README
diff --git a/README b/README
index 1d9c9ac..0ef4341 100644 (file)
--- a/README
+++ b/README
@@ -1,8 +1,21 @@
------BEGIN PGP SIGNED MESSAGE-----
 
                    GnuPG - The GNU Privacy Guard
                   -------------------------------
-                           Version 1.0
+                           Version 1.2
+
+    Copyright 1998, 1999, 2000, 2001, 2002 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 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.
+
+
+    Intro
+    -----
 
     GnuPG is GNU's tool for secure communication and data storage.
     It can be used to encrypt data and to create digital signatures.
     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
-    patented worldwide) and RSA (which is patented in the United States
-    until Sep 20, 2000).
+    compatible with PGP2 versions.  PGP 2.x uses IDEA (which is patented
+    worldwide).
 
     The default algorithms are DSA and ElGamal.  ElGamal for signing
     is still 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: 3DES, Blowfish, CAST5 and Twofish (GnuPG does not
-    yet create Twofish encrypted messages because there is no agreement
-    in the OpenPGP WG on how to use it together with a MDC algorithm)
+    algorithms are: AES, 3DES, Blowfish, CAST5 and Twofish 
     Digest algorithms available are MD5, RIPEMD160 and SHA1.
 
 
     Installation
     ------------
+    Please read the file INSTALL and the sections in this file
+    related to the installation.  Here is a quick summary:
 
-    Please read the file INSTALL!
-
-    Here is a quick summary:
-
-    1) Check that you have unmodified sources. The below on how to do this.
-       Don't skip it - this is an important step!
+    1) Check that you have unmodified sources. The 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"
     6) "make install"
 
     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" (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
-       "no-secmem-warning" to ~/.gnupg/options
+       "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:
        "pub  1024D/57548DCD 1998-07-07 Werner Koch (gnupg sig) <dd9jn@gnu.org>"
 
        If you do not have this key, you can get it from the source in
-       the file g10/pubring.asc (use "gpg --import g10/pubring.gpg" to
-       add it to the keyring) or from any keyserver.  You have to make
-       sure that this is really the key and not a faked one. You can do
-       this by comparing the output of:
+       the file doc/samplekeys.asc (use "gpg --import  doc/samplekeys.asc"
+       to add it to the keyring) or from any keyserver.  You have to
+       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
 
-       with the elsewhere published fingerprint, or - if you are able to
-       _positively_ verify the signature of this README file - with
-       this fingerprint: "6BD9 050F D8FC 941B 4341  2DCC 68B7 AB89 5754 8DCD"
+       with the elsewhere published fingerprint
 
        Please note, that you have to use an old version of GnuPG to
        do all this stuff.  *Never* use the version which you are going
        to check!
 
 
-    b) If you have a trusted Version of PGP 2 or 5 installed, you
-       can check the supplied PGP 2 signature:
-
-       $ pgp gnupg-x.y.z.tar.gz.sig gnupg-x.y.z.tar.gz
-
-       This checks that the detached signature gnupg-x.y.z.tar.gz.sig
-       is indeed a a signature of gnupg-x.y.z.tar.gz.  Please note,
-       that this signature has been created with a RSA signature and
-       you probably can't use this method (due to legal reasons) when
-       you are in the U.S.  The key used to create this signature is
-       the same as the one used to sign this README file.  It should be
-       available at the keyservers and is also included in the source
-       of GnuPG in g10/pubring.asc.
-
-       "pub   768R/0C9857A5 1995-09-30 Werner Koch <werner.koch@guug.de>"
-
-       The fingerprint of this key is published in printed form in the
-         "Global Trust Register for 1998", ISBN 0-9532397-0-5.
-
-
-    c) If you don't have any of the above programs, you have to verify
+    b) If you don't have any of the above programs, you have to verify
        the MD5 checksum:
 
-       $ md5sum gnupg-x.y.z.tar.gz.sig
+       $ md5sum gnupg-x.y.z.tar.gz
 
-       This should yield an output similar_to this:
+       This should yield an output _similar_ to this:
 
        fd9351b26b3189c1d577f0970f9dcadc  gnupg-x.y.z.tar.gz
 
 
     Documentation
     -------------
+    The manual will be distributed separate under the name "gph".
+    An online version of the latest manual draft is available at the
+    GnuPG web pages:
+
+       http://www.gnupg.org/gph/
 
-    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 list of frequently asked questions is available in GnuPG's
+    distibution in the file doc/FAQ and online as:
+
+       http://www.gnupg.org/faq.html
 
     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.
+    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
       any order in the user ID.  Words are any sequences of letters,
       digits, the underscore and characters with bit 7 set.
 
-    * By the Local ID (from the trust DB):
-
-       "#34"
-
-      This may be used by a MUA to specify an exact key after selecting
-      a key from GnuPG (by using a special option or an extra utility)
-
     * Or by the usual substring:
 
        "Heine"
     detailed information about the errors.
 
 
+    Configure options 
+    -----------------
+    Here is a list of configure options which are sometime useful 
+    for installation.
+
+    --enable-static-rnd=<name> 
+                     Force the use of the random byte gathering
+                    module <name>.  Default is either to use /dev/random
+                    or the auto mode.  Value for name:
+                      egd - Use the module which accesses the
+                            Entropy Gathering Daemon. See the webpages
+                            for more information about it.
+                     unix - Use the standard Unix module which does not
+                            have a very good performance.
+                    linux - Use the module which accesses /dev/random.
+                            This is the first choice and the default one
+                            for GNU/Linux or *BSD.
+                      auto - Compile linux, egd and unix in and 
+                             automagically select at runtime.
+  
+    --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
+                     and one starting with a "=" uses a socket in the
+                     GnuPG homedirectory which is bye default "~/.gnupg".
+   
+     --with-included-zlib
+                     Forces usage of the local zlib sources. Default is
+                    to use the (shared) library of the system.
+
+     --with-included-gettext
+                     Forces usage of the local gettext sources instead of
+                    the one provided by your system.
+
+     --disable-nls
+                     Disable NLS support (See the file ABOUT-NLS)
+
+     --enable-m-guard
+                     Enable the integrated malloc checking code. Please
+                     note that this feature does not work on all CPUs
+                     (e.g. SunOS 5.7 on UltraSparc-2) and might give
+                     you a bus error.
+
+     --disable-dynload 
+                    If you have problems with dynamic loading, this
+                    option disables all dynamic loading stuff.  Note
+                    that the use of dynamic linking is very limited.
+
+     --disable-asm
+                    Do not use assembler modules.  It is not possible 
+                    to use this on some CPU types.
+                    
+     --disable-exec
+                    Disable all remote program execution.  This
+                   disables photo ID viewing as well as all keyserver
+                   types aside from HKP.
+
+     --disable-photo-viewers
+                    Disable only photo ID viewing.
+
+     --disable-keyserver-helpers
+                    Disable only keyserver helpers (not including
+                   HKP).
+
+     --disable-keyserver-path
+                    Disables the user's ability to use the exec-path
+                   feature to add additional search directories when
+                   executing a keyserver helper.
+
+     --with-photo-viewer=FIXED_VIEWER
+                    Force the photo viewer to be FIXED_VIEWER and
+                   disable any ability for the user to change it in
+                   their options file.
+
+
+    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.
+
+    If you have other compile problems, try the configure options
+    "--with-included-zlib" or "--disable-nls" (See ABOUT-NLS) or
+    --disable-dynload.
+
+    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".
+
+    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
+    install them.
+
+    On some OSF you may get unresolved externals.  This is a libtool
+    problem and the workaround is to manually remove all the "-lc -lz"
+    but the last one from the linker line and execute them manually.
+
+    On some architectures you see warnings like:
+      longlong.h:175: warning: function declaration isn't a prototype
+    or
+      http.c:647: warning: cast increases required alignment of target type
+    This doesn't matter and we know about it (actually it is due to
+    some warning options which we have enabled for gcc)
+
+
+    Specific problems on some machines
+    ----------------------------------
+
+    * IBM RS/6000 running AIX:
+
+       Due to a change in gcc (since version 2.8) the MPI stuff may
+       not build. In this case try to run configure using:
+           CFLAGS="-g -O2 -mcpu=powerpc" ./configure
+
+    * 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.
+
+    * SVR4.2 (ESIX V4.2 cc)
+
+        Due to problems with the ESIX as, you probably want to do
+            CFLAGS="-O -K pentium" ./configure --disable-asm
+        Reported by Reinhard Wobst.
+
+
+
+    The Random Device
+    -----------------
+
+    Random devices are available in Linux, FreeBSD and OpenBSD.
+    Operating systems without a random devices must use another
+    entropy collector. 
+
+    This collector works by running a lot of commands that yield more
+    or less unpredictable output and feds this as entropy into the
+    random generator - It should work reliably but you should check
+    whether it produces good output for your version of Unix. There
+    are some debug options to help you (see cipher/rndunix.c).
+
+
+    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
+      2. copy the tar file into /usr/src/redhat/SOURCES
+      3. type: rpm -ba SPECS/gnupg.spec
+
+    Or use the -t (--tarbuild) option of rpm:
+      1. rpm -ta gnupg-x.x.x.tar.gz
+
+    The binary rpm file can now be found in /usr/src/redhat/RPMS, source
+    rpm in /usr/src/redhat/SRPMS
+
+
     How to Get More Information
     ---------------------------
 
     The primary WWW page is "http://www.gnupg.org"
-    The primary FTP site is "ftp://ftp.gnupg.org/pub/gcrypt/"
+    The primary FTP site is "ftp://ftp.gnupg.org/gcrypt/"
 
-    See http://www.gnupg.org/mirrors.html for a list of FTP mirrors
+    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.
 
     We have some mailing lists dedicated to GnuPG:
 
        gnupg-announce@gnupg.org    For important announcements like
-                                   new versions and  such stuff.
+                                   new versions and such stuff.
                                    This is a moderated list and has
                                    very low traffic.
+
        gnupg-users@gnupg.org       For general user discussion and
                                    help.
+
        gnupg-devel@gnupg.org       GnuPG developers main forum.
 
     You subscribe to one of the list by sending mail with a subject
     mailing list (gnupg-announce, gnupg-users, etc.).  An archive of
     the mailing lists is available at http://lists.gnupg.org .
 
-    The gnupg.org domain is hosted in Germany to avoid possible legal
-    problems (technical advices may count as a violation of ITAR).
-
-    Please direct bug reports to <gnupg-bugs@gnu.org> or post
+    Please direct bug reports to <bug-gnupg@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
     Commercial grade support for GnuPG is available; please see
     the GNU service directory or search other resources.
 
------BEGIN PGP SIGNATURE-----
-Version: GnuPG v0.9.11 (GNU/Linux)
-Comment: For info see http://www.gnupg.org
-
-iQB1AwUBN9QAwB0Z9MEMmFelAQG0XwMAqyH3UR0Jk+dm2ZkVoTqckGqmMMt5IdBN
-MlG4g3dau5De8XXHvbQ45cUpU4CC0MOlEuKDp+CKOc+xbzczdH35qYt/5XKmVWS8
-JwTvuKKCZ/95JRMk0ZMRueQduH7tSijZ
-=MefQ
------END PGP SIGNATURE-----