Improve.
[libgcrypt.git] / README
diff --git a/README b/README
index 9e1d44a..9a40149 100644 (file)
--- a/README
+++ b/README
@@ -1,8 +1,8 @@
                    libgcrypt - The GNU crypto library
                   ------------------------------------
-                           Version 1.1
+                           Version 1.1.13-cvs
 
-    Copyright 2000, 2002 Free Software Foundation, Inc.
+    Copyright 2000, 2002, 2003 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
     stay as it is, except that new functions may be added in the
     future.
 
+    Libgcrypt depends on the library `libgpg-error', which must be
+    installed correctly before Libgcrypt is to be built.
+
 
     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.
+    latest GNU build tools installed and run ./autogen.sh before
+    trying to build the library.  Instead of running autogen.sh,
+    something like `autoreconf -i --symlink' can be used to prepare
+    the tree for building as well.
+
+    You also need to enable maintainer mode at configure time with the
+    `--enable-maintainer-mode' configure switch; without this switch,
+    the documentation can not be build, since the file `version.texi',
+    which is needed for building the documentation, will only be
+    generated, if maintainer mode is enabled.
 
 
     Mailing List
     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.