~ubuntu-branches/ubuntu/maverick/libgcrypt11/maverick

1.1.1 by Matthias Urlichs
Import upstream version 1.2.1
1
		    libgcrypt - The GNU crypto library
2
		   ------------------------------------
1.1.4 by Andreas Metzler
Import upstream version 1.2.4
3
  			    Version 1.2.4
1.1.1 by Matthias Urlichs
Import upstream version 1.2.1
4
1.1.4 by Andreas Metzler
Import upstream version 1.2.4
5
    Copyright 2000, 2002, 2003, 2004, 2005, 2006, 
6
              2007 Free Software Foundation, Inc.
1.1.1 by Matthias Urlichs
Import upstream version 1.2.1
7
8
    This file is free software; as a special exception the author gives
9
    unlimited permission to copy and/or distribute it, with or without
10
    modifications, as long as this notice is preserved.
11
12
    This file is distributed in the hope that it will be useful, but
13
    WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
14
    implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
15
16
17
18
    Overview
19
    --------
20
21
    Libgcrypt is a general purpose crypto library based on the code
22
    used in GnuPG.  We can't start with a new version number because
23
    libgcrypt was part of gnupg 1.1 and some applications already used
24
    it and tested for the version number. We believe that the API can
25
    stay as it is, except that new functions may be added in the
26
    future.
27
28
    Libgcrypt depends on the library `libgpg-error', which must be
29
    installed correctly before Libgcrypt is to be built.
30
31
32
    Mailing List
33
    ------------
34
35
    You may want to join the developer's mailing list
36
    gcrypt-devel@gnupg.org by sending mail with a subject of
37
    "subscribe" to gcrypt-devel-request@gnupg.org.  An archive of this
38
    list is available at http://lists.gnupg.org .
39
40
41
    License
42
    -------
43
    
44
    Most of this library is distributed under the terms of the GNU
45
    Lesser General Public License (LGPL); see the file COPYING.LIB for
46
    the actual terms.  However some parts are distributed under the
47
    GNU General Public License (GPL) so if you configure Libgcrypt to
48
    include these modules, you have to comply with the conditions of
49
    the GPL as found in the file COPYING.  The modules under the GPL
50
    are:
51
52
      rndunix - Entropy gatherer for Unices without a /dev/random
53
      rndw32  - Entropy gatherer for MS Windows
54
55
    The documentation is available under the terms of the GNU Free
56
    Documentation License; see the file COPYING.DOC for the terms.
57
58
    This library used to be available under the GPL - this was changed
59
    with version 1.1.7 with the rationale that there are now many free
60
    crypto libraries available and many of them come with capabilities
61
    similar to Libcrypt.  We decided that to foster the use of
62
    cryptography in Free Software an LGPLed library would make more
63
    sense because it avoids problems due to license incompatibilities
64
    between some Free Software licenses and the GPL. 
65
66
    Please note that in many cases it is better for a library to be
67
    licensed under the GPL, so that it provides an advantage for free
68
    software projects.  The Lesser GPL is so named because it does
69
    less to protect the freedom of the users of the code that it
70
    covers.  See http://www.gnu.org/philosophy/why-not-lgpl.html for
71
    more explanation.
72
73
74
    Configure options 
75
    -----------------
76
    Here is a list of configure options which are sometimes useful 
77
    for installation.
78
79
     --enable-m-guard
80
                     Enable the integrated malloc checking code. Please
81
                     note that this feature does not work on all CPUs
82
                     (e.g. SunOS 5.7 on UltraSparc-2) and might give
83
                     you a bus error.
84
85
     --disable-asm
86
                     Do not use assembler modules.  It is not possible 
87
                     to use this on some CPU types.
88
                    
89
     --enable-ld-version-script
90
                     Libgcrypt tries to build a library where internal
91
                     symbols are not exported.  This requires support
92
                     from ld and is currently enabled for a few OSes.
93
                     If you know that your ld supports the so called
94
                     ELF version scripts, you can use this option to
95
                     force its use.  OTOH, if you get error message
96
                     from the linker, you probably want to use this
97
                     option to disable the use of version scripts.
98
                     Note, that you should never ever use an
99
                     undocumented symbol or one which is prefixed with
100
                     an underscore. 
101
102
     --enable-ciphers=list
103
     --enable-pubkey-ciphers=list
104
     --enable-digests=list
105
                     If not otherwise specified, all algorithms
106
                     included in the libgcrypt source tree are built.
107
		     An exception are algorithms, which depend on
108
		     features not provided by the system, like 64bit
109
		     data types.  With these switches it is possible
110
                     to select exactly those algorithm modules, which
111
		     should be built.
112
113
    Contact
114
    -------
115
116
    See the file AUTHORS.
117