More enum docs.
[gnutls.git] / README
bloba6e059920930bcb415fb554cec67c006629b4061
1 GNU TLS README -- Important introductory notes.
2 Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005,
3               2006, 2007, 2008, 2009, 2010  Free Software Foundation, Inc.
4 See the end for copying conditions.
6 This is the GNUTLS library.  GNUTLS implements the TLS/SSL (Transport
7 Layer Security aka Secure Sockets Layer) protocol.  GnuTLS is a GNU
8 project.  More up to date information can be found at
9 <http://www.gnu.org/software/gnutls/> and <http://www.gnutls.org/>.
11 See the documentation in doc/ and examples in doc/examples/.
13 COMPILATION ISSUES
14 ------------------
16 The library needs libgcrypt. You can find libgcrypt at
17 <ftp://ftp.gnupg.org/pub/gcrypt/libgcrypt/>.  Note that by
18 compiling libgcrypt with CPU optimizations gnutls' speed will
19 increase.
21 In case you are compiling for embedded systems you should check the
22 configure options (that is run: 'configure --help'), and disable
23 unneeded features of gnutls.
25 LICENSE ISSUES
26 --------------
28 Since the 0.4.2 version the gnutls library is covered under the GNU
29 Lesser GPL. Previously released versions were licensed under the GNU
30 GPL.
32 We changed the license for most of GNUTLS because other free libraries
33 already exist that do the same jobs and have lax licenses.  We want
34 GNUTLS to be usable in all the same places as those other libraries.
35 We kept some parts of GNUTLS under the GPL because they are unique,
36 and with the GPL they provide free software projects (which deserve
37 our help) an advantage over non-free projects (which do not deserve
38 our help, since they refuse to share with us).  For more explanation,
39 see http://www.gnu.org/philosophy/why-not-lgpl.html.
41 The GNU Lesser GPL license applies to the main gnutls library, while
42 the gnutls-extra library is under the GPL. The gnutls-extra library
43 contains the code for "GnuTLS Inner Application" support and the
44 OpenSSL compatibility layer.  The gnutls library is located in the
45 lib/ directory, while the gnutls-extra library is at libextra/.
48 BUGS
49 ----
51 Currently GnuTLS needs testing.  By notifying the developers about a
52 possible bug you may help a lot, since testing is really important and
53 expensive.  If you think you found a bug, report it to
54 bug-gnutls@gnu.org together with the needed information, in order for
55 developers to reproduce it.
57 ----------------------------------------------------------------------
58 Copying and distribution of this file, with or without modification,
59 are permitted in any medium without royalty provided the copyright
60 notice and this notice are preserved.