*** empty log message ***
[gnutls:gnutls.git] / README
1 This is the GNU TLS library. More up to date information can be found
2 at http://www.gnu.org/software/gnutls/ and http://www.gnutls.org/
3
4 This is a TLS (Transport Layer Security) 1.0 and SSL (Secure Sockets Layer) 3.0
5 implementation for the GNU project. 
6
7 - The library needs libgcrypt. You can find libgcrypt at
8  ftp://ftp.gnupg.org/pub/gcrypt/alpha/libgcrypt/
9
10  Note that by compiling libgcrypt with CPU optimizations gnutls' speed
11  will increase.
12
13 - For OpenPGP key support the OpenCDK library is required. You can find
14  libopencdk at:
15  ftp://ftp.gnutls.org/pub/gnutls/opencdk/
16
17 - Documentation:
18  view the doc/ directory and the examples in the doc/examples directory.
19
20
21 ****************************
22 COMPILATION ISSUES:
23
24 Nothing special here. In case you are compiling for embedded systems
25 you should check the configure options (that is run: 'configure --help'),
26 and disable unneeded features of gnutls.
27
28
29 ****************************
30 LICENSE ISSUES:
31
32 Since the 0.4.2 version the gnutls library is covered under the GNU 
33 Lesser GPL. Previously released versions were licensed under the GNU GPL.
34
35 We changed the license for most of GNUTLS because other free libraries
36 already exist that do the same jobs and have lax licenses.  We want
37 GNUTLS to be usable in all the same places as those other libraries.
38 We kept some parts of GNUTLS under the GPL because they are unique,
39 and with the GPL they provide free software projects (which deserve
40 our help) an advantage over non-free projects (which do not deserve
41 our help, since they refuse to share with us).  For more explanation,
42 see http://www.gnu.org/philosophy/why-not-lgpl.html.
43
44 The GNU Lesser GPL license applies to the main gnutls library, while the
45 gnutls-extra library is under the GPL. The gnutls-extra library contains
46 the code for the "OpenPGP key" support and the OpenSSL compatibility layer. 
47 The gnutls library is located in the lib/ directory, while the gnutls-extra 
48 library is at libextra/.
49
50
51 ****************************
52 BUGS:
53
54 Currently gnuTLS needs a lot of testing. By notifying the developers
55 about a possible bug you may help a lot, since testing is really
56 important and expensive. If you think you found a bug,
57 report it to bug-gnutls@gnu.org, together with the needed information,
58 in order for developers to reproduce it. 
59