69ff99b5aab9d1c4914753d256e65a97434cc570
[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       rndw32    - Entropy gatherer for MS Windows
57       gcryptrnd - The random number daemon.
58       getrandom - A client for that daemon.
59       camellia  - The Camellia cipher.
60
61     The documentation is available under the terms of the GPL.
62
63     This library used to be available under the GPL - this was changed
64     with version 1.1.7 with the rationale that there are now many free
65     crypto libraries available and many of them come with capabilities
66     similar to Libcrypt.  We decided that to foster the use of
67     cryptography in Free Software an LGPLed library would make more
68     sense because it avoids problems due to license incompatibilities
69     between some Free Software licenses and the GPL.
70
71     Please note that in many cases it is better for a library to be
72     licensed under the GPL, so that it provides an advantage for free
73     software projects.  The Lesser GPL is so named because it does
74     less to protect the freedom of the users of the code that it
75     covers.  See http://www.gnu.org/philosophy/why-not-lgpl.html for
76     more explanation.
77
78
79     Configure options 
80     -----------------
81     Here is a list of configure options which are sometimes useful 
82     for installation.
83
84      --enable-m-guard
85                      Enable the integrated malloc checking code. Please
86                      note that this feature does not work on all CPUs
87                      (e.g. SunOS 5.7 on UltraSparc-2) and might give
88                      you a bus error.
89
90      --disable-asm
91                      Do not use assembler modules.  It is not possible 
92                      to use this on some CPU types.
93                     
94      --enable-ld-version-script
95                      Libgcrypt tries to build a library where internal
96                      symbols are not exported.  This requires support
97                      from ld and is currently enabled for a few OSes.
98                      If you know that your ld supports the so called
99                      ELF version scripts, you can use this option to
100                      force its use.  OTOH, if you get error message
101                      from the linker, you probably want to use this
102                      option to disable the use of version scripts.
103                      Note, that you should never ever use an
104                      undocumented symbol or one which is prefixed with
105                      an underscore. 
106
107      --enable-ciphers=list
108      --enable-pubkey-ciphers=list
109      --enable-digests=list
110                      If not otherwise specified, all algorithms
111                      included in the libgcrypt source tree are built.
112                      An exception are algorithms, which depend on
113                      features not provided by the system, like 64bit
114                      data types.  With these switches it is possible
115                      to select exactly those algorithm modules, which
116                      should be built.  The algorithms are to be
117                      separated by spaces, commas or colons.  To view
118                      the list used with the current build the program
119                      tests/version may be used.
120
121      --disable-endian-check
122                      Don't let configure test for the endianness but
123                      try to use the OS provided macros at compile
124                      time.  This is helpful to create OS X fat binaries.
125
126      --enable-random-daemon
127                      Include support for a global random damon and
128                      build the daemon.  This is an experimental feature.
129
130      --enable-mpi-path=EXTRA_PATH
131                      Prepend EXTRA_PATH to list of CPU specific
132                      optimizations.  For example, if you want to add
133                      optimizations forn a Intel Pentium 4 compatible
134                      CPU, you may use
135                         --enable-mpi-path="pentium4/sse2 pentium4/mmx"
136                      Take care: The generated library may crash on
137                      non-compatible CPUs
138
139      --enable-random=NAME 
140                      Force the use of the random gathering module
141                      NAME.  Default is either to use /dev/random or
142                      the auto mode.  Possible values for NAME are:
143                        egd - Use the module which accesses the
144                              Entropy Gathering Daemon. See the webpages
145                              for more information about it.
146                       unix - Use the standard Unix module which does not
147                              have a very good performance.
148                      linux - Use the module which accesses /dev/random.
149                              This is the first choice and the default one
150                              for GNU/Linux or *BSD.
151                       auto - Compile linux, egd and unix in and 
152                              automagically select at runtime.
153   
154
155
156
157     Contact
158     -------
159
160     See the file AUTHORS.
161