Added --modules option to libgnutls-config. This option prints the extra modules...
[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 It is a TLS implementation for the GNU project. 
5 It is currently under heavy development. (and still not ready for 
6 real world programs)
7
8 * The library needs libgcrypt. Libgcrypt is part of gnupg (ftp.gnupg.org)
9
10 * Documentation:
11  view the doc/ directory and the examples in the src/ directory.
12
13
14 LICENSE ISSUES:
15
16 The latest release of the gnutls library is covered under the GNU Lesser 
17 GPL License, unlike previously released versions which were licensed under 
18 the GPL. 
19
20 The LGPL license (found in COPYING.LIB) applies to all parts of the gnutls 
21 library except for the "OPENPGP authentication" part, and the "SRP 
22 authentication" part, which stay GPL (see the COPYING file).  Both of these 
23 parts can be disabled at compile time.
24
25 In order to create a library under the LGPL run the configure script with 
26 the following parameters:
27     --disable-srp-authentication
28     --disable-openpgp-authentication
29
30 or the library will be under the GPL. In both cases the libraries are
31 binary compatible. In the LGPL case the functions are replaced with
32 stubs that always fail.
33
34 The rationale behind this license change is that given the fact that other 
35 free libraries with similar functionality exist, keeping the gnutls library 
36 GPL would not give any practical advantage to Free software developers.
37
38 Please note that in many cases it is better for a library to be licensed 
39 under the GPL, so that it provides an advantage for free software projects.
40 The Lesser GPL is so named because it does less to protect the freedom of 
41 the users of the code that it covers.  
42 See http://www.gnu.org/philosophy/why-not-lgpl.html for more explanation.
43
44
45 BUGS:
46
47 Currently gnuTLS needs a lot of testing. By notifying the developers
48 about a possible bug you may help a lot, since testing is really
49 important and expensive. If you think you found a bug,
50 report it to bug-gnutls@gnu.org, together with the needed information,
51 in order for developers to reproduce it. 
52
53