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