Changed rndw32 to LGPL.
[libgcrypt.git] / README
1                     libgcrypt - The GNU crypto library
2                    ------------------------------------
3                             Version 1.3.x
4
5     WARNING:  This is the development branch of Libgcrypt.  The stable
6     version is 1.2.x.
7     
8
9     Copyright 2000, 2002, 2003, 2004, 2007 Free Software Foundation, Inc.
10
11     This file is free software; as a special exception the author gives
12     unlimited permission to copy and/or distribute it, with or without
13     modifications, as long as this notice is preserved.
14
15     This file is distributed in the hope that it will be useful, but
16     WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
17     implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
18
19
20
21     Overview
22     --------
23
24     Libgcrypt is a general purpose crypto library based on the code
25     used in GnuPG.  We can't start with a new version number because
26     libgcrypt was part of GnuPG 1.1 and some applications already used
27     it and tested for the version number. We believe that the API can
28     stay as it is, except that new functions may be added in the
29     future.
30
31     Libgcrypt depends on the library `libgpg-error', which must be
32     installed correctly before Libgcrypt is to be built.
33
34
35     Mailing List
36     ------------
37
38     You may want to join the developer's mailing list
39     gcrypt-devel@gnupg.org by sending mail with a subject of
40     "subscribe" to gcrypt-devel-request@gnupg.org.  An archive of this
41     list is available at http://lists.gnupg.org .
42
43
44     License
45     -------
46     
47     Most of this library is distributed under the terms of the GNU
48     Lesser General Public License (LGPL); see the file COPYING.LIB for
49     the actual terms.  However some parts are distributed under the
50     GNU General Public License (GPL) so if you configure Libgcrypt to
51     include these modules, you have to comply with the conditions of
52     the GPL as found in the file COPYING.  The modules under the GPL
53     are:
54
55       rndunix   - Entropy gatherer for Unices without a /dev/random
56       gcryptrnd - The random number daemon.
57       getrandom - A client for that daemon.
58
59     The documentation is available under the terms of the GPL.
60
61     This library used to be available under the GPL - this was changed
62     with version 1.1.7 with the rationale that there are now many free
63     crypto libraries available and many of them come with capabilities
64     similar to Libcrypt.  We decided that to foster the use of
65     cryptography in Free Software an LGPLed library would make more
66     sense because it avoids problems due to license incompatibilities
67     between some Free Software licenses and the GPL.
68
69     Please note that in many cases it is better for a library to be
70     licensed under the GPL, so that it provides an advantage for free
71     software projects.  The Lesser GPL is so named because it does
72     less to protect the freedom of the users of the code that it
73     covers.  See http://www.gnu.org/philosophy/why-not-lgpl.html for
74     more explanation.
75
76
77     Configure options 
78     -----------------
79     Here is a list of configure options which are sometimes useful 
80     for installation.
81
82      --enable-m-guard
83                      Enable the integrated malloc checking code. Please
84                      note that this feature does not work on all CPUs
85                      (e.g. SunOS 5.7 on UltraSparc-2) and might give
86                      you a bus error.
87
88      --disable-asm
89                      Do not use assembler modules.  It is not possible 
90                      to use this on some CPU types.
91                     
92      --enable-ld-version-script
93                      Libgcrypt tries to build a library where internal
94                      symbols are not exported.  This requires support
95                      from ld and is currently enabled for a few OSes.
96                      If you know that your ld supports the so called
97                      ELF version scripts, you can use this option to
98                      force its use.  OTOH, if you get error message
99                      from the linker, you probably want to use this
100                      option to disable the use of version scripts.
101                      Note, that you should never ever use an
102                      undocumented symbol or one which is prefixed with
103                      an underscore. 
104
105      --enable-ciphers=list
106      --enable-pubkey-ciphers=list
107      --enable-digests=list
108                      If not otherwise specified, all algorithms
109                      included in the libgcrypt source tree are built.
110                      An exception are algorithms, which depend on
111                      features not provided by the system, like 64bit
112                      data types.  With these switches it is possible
113                      to select exactly those algorithm modules, which
114                      should be built.  The algorithms are to be
115                      separated by spaces, commas or colons.  To view
116                      the list used with the current build the program
117                      tests/version may be used.
118
119      --disable-endian-check
120                      Don't let configure test for the endianness but
121                      try to use the OS provided macros at compile
122                      time.  This is helpful to create OS X fat binaries.
123
124      --enable-random-daemon
125                      Include support for a global random damon and
126                      build the daemon.  This is an experimental feature.
127
128      --enable-mpi-path=EXTRA_PATH
129                      Prepend EXTRA_PATH to list of CPU specific
130                      optimizations.  For example, if you want to add
131                      optimizations forn a Intel Pentium 4 compatible
132                      CPU, you may use
133                         --enable-mpi-path=pentium4/sse2:pentium4/mmx
134                      Take care: The generated library may crash on
135                      non-compatible CPUs.
136
137      --enable-random=NAME 
138                      Force the use of the random gathering module
139                      NAME.  Default is either to use /dev/random or
140                      the auto mode.  Possible values for NAME are:
141                        egd - Use the module which accesses the
142                              Entropy Gathering Daemon. See the webpages
143                              for more information about it.
144                       unix - Use the standard Unix module which does not
145                              have a very good performance.
146                      linux - Use the module which accesses /dev/random.
147                              This is the first choice and the default one
148                              for GNU/Linux or *BSD.
149                       auto - Compile linux, egd and unix in and 
150                              automagically select at runtime.
151   
152
153
154
155     Contact
156     -------
157
158     See the file AUTHORS.
159