2006-07-04 Marcus Brinkmann <marcus@g10code.de>
[libgcrypt.git] / README
diff --git a/README b/README
index 9e1d44a..2f74ce4 100644 (file)
--- a/README
+++ b/README
@@ -1,8 +1,12 @@
                    libgcrypt - The GNU crypto library
                   ------------------------------------
-                           Version 1.1
+                           Version 1.3.x
 
-    Copyright 2000, 2002 Free Software Foundation, Inc.
+    WARNING:  This is the development branch of Libgcrypt.  The stable
+    version is 1.2.x.
+    
+
+    Copyright 2000, 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
@@ -13,8 +17,6 @@
     implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 
 
-    THIS IS A DEVELOPMENT VERSION, THE FIRST STABLE VERSION WILL BE 1.2.0.
-
 
     Overview
     --------
     stay as it is, except that new functions may be added in the
     future.
 
-
-    CVS
-    ---
-
-    If you are using the CVS version, make sure that you have the
-    latest automake (I am using Debian Sid) and run ./autogen.sh to
-    create configure.
+    Libgcrypt depends on the library `libgpg-error', which must be
+    installed correctly before Libgcrypt is to be built.
 
 
     Mailing List
     the GPL as found in the file COPYING.  The modules under the GPL
     are:
 
-      rndunix - Entropy gatherer for Unices without a /dev/random
-      rndw32  - Entropy gatherer for MS Windows
+      rndunix   - Entropy gatherer for Unices without a /dev/random
+      rndw32    - Entropy gatherer for MS Windows
+      gcryptrnd - The random number daemon.
+      getrandom - A client for that daemon.
 
-    The documentation is available under the terms of the GNU Free
-    Documentation License; see the file COPYING.DOC for the terms.
+    The documentation is available under the terms of the GPL.
 
     This library used to be available under the GPL - this was changed
     with version 1.1.7 with the rationale that there are now many free
@@ -67,7 +65,7 @@
     similar to Libcrypt.  We decided that to foster the use of
     cryptography in Free Software an LGPLed library would make more
     sense because it avoids problems due to license incompatibilities
-    between some Free Software licenses and the GPL. 
+    between some Free Software licenses and the GPL.
 
     Please note that in many cases it is better for a library to be
     licensed under the GPL, so that it provides an advantage for free
     more explanation.
 
 
+    Configure options 
+    -----------------
+    Here is a list of configure options which are sometimes useful 
+    for installation.
+
+     --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-asm
+                     Do not use assembler modules.  It is not possible 
+                     to use this on some CPU types.
+                    
+     --enable-ld-version-script
+                     Libgcrypt tries to build a library where internal
+                     symbols are not exported.  This requires support
+                     from ld and is currently enabled for a few OSes.
+                     If you know that your ld supports the so called
+                     ELF version scripts, you can use this option to
+                     force its use.  OTOH, if you get error message
+                     from the linker, you probably want to use this
+                     option to disable the use of version scripts.
+                     Note, that you should never ever use an
+                     undocumented symbol or one which is prefixed with
+                     an underscore. 
+
+     --enable-ciphers=list
+     --enable-pubkey-ciphers=list
+     --enable-digests=list
+                     If not otherwise specified, all algorithms
+                     included in the libgcrypt source tree are built.
+                    An exception are algorithms, which depend on
+                    features not provided by the system, like 64bit
+                    data types.  With these switches it is possible
+                     to select exactly those algorithm modules, which
+                    should be built.
+
+    Contact
+    -------
 
-
-
-
-
-
-
+    See the file AUTHORS.