simplified README
[gnutls:gnutls.git] / README
1 GnuTLS README -- Important introductory notes.
2 Copyright (C) 2000-2011  Free Software Foundation, Inc.
3 See the end of this document for copying conditions.
4
5 GnuTLS implements the TLS/SSL (Transport Layer Security aka Secure
6 Sockets Layer) protocol.  GnuTLS is a GNU project.  Additional
7 information can be found at <http://www.gnu.org/software/gnutls/>
8 and <http://www.gnutls.org/>.
9
10
11 README
12 ------
13 This README is targeted for users of the library who build from
14 sources but do not necessarily develop.  If you are interested
15 in developing and contributing to the GnuTLS project, please
16 see README-alpha and visit
17 http://www.gnu.org/software/gnutls/manual/html_node/Contributing.html.
18
19
20 COMPILATION
21 -----------
22 A typical command sequence for building the library is shown below.
23 A complete list of options available for configure can be found
24 by running './configure --help'.
25
26     cd gnutls-2.10.3
27     ./configure --prefix=/usr
28     make
29     sudo make install
30
31 The commands above build and install the static archives (libgnutls.a
32 and libgnutls-extra.a), the shared object (libgnutls.so  and
33 libgnutls-extra.so), and additional binaries such as certtool and
34 gnutls-cli.
35
36 The library depends on libnettle and p11-kit. Versions
37 2.10.3 and prior used libgcrypt as the default cryptographic library.
38 Nettle can be found at http://www.gnu.org/software/nettle/, while
39 p11-kit can be found at <http://p11-glue.freedesktop.org/p11-kit.html>.
40
41 To configure libnettle for installation and use by GnuTLS, a typical
42 command sequence would be:
43
44     cd nettle-2.2
45     ./configure --prefix=/usr --disable-openssl --enable-shared
46     make
47     sudo make install
48
49 For the Nettle project, --enable-shared will instruct automake and
50 friends to build and install both the static archive (libnettle.a)
51 and the shared object (libnettle.so).
52
53 In case you are compiling for an embedded system, you can disable
54 unneeded features of GnuTLS.  In general, it is usually best not to
55 disable anything (for future mailing list questions and possible bugs).
56
57 Depending on your installation, additional libraries, such as libtasn1
58 and zlib, may be required.
59
60
61 DOCUMENTATION
62 -------------
63 See the documentation in doc/ and online at
64 http://www.gnu.org/software/gnutls/manual/html_node/index.htm.
65
66
67 EXAMPLES
68 --------
69 See the examples in doc/examples/ and online at 'How To Use GnuTLS in
70 Applications' at http://www.gnu.org/software/gnutls/manual/html_node/How-
71 to-use-GnuTLS-in-applications.html#How-to-use-GnuTLS-in-applications.
72 The examples include client, server, and multi-threaded examples.
73
74
75 SECURITY ADVISORIES
76 -------------------
77 The project collects and publishes information on past security
78 incidents and vulnerabilities.  Open information exchange, including
79 information which is [sometimes] suppressed in non-open or non-free
80 projects, is one of the goals of the GnuTLS project.  Please visit
81 http://www.gnu.org/software/gnutls/security.html.
82
83
84 MAILING LISTS
85 -------------
86 The GnuTLS project maintains mailing lists for users, developers, and
87 commits.  Please see http://www.gnu.org/software/gnutls/lists.html.
88
89
90 LICENSING
91 ---------
92 Since GnuTLS version 3.0.0, the core library has been released under
93 the GNU Lesser General Public License (LGPL) version 3 or later.
94
95 The GNU LGPL applies to the main GnuTLS library, while the
96 included applications as well as gnutls-extra and gnutls-openssl 
97 libraries are under the GNU GPL version 3.  The gnutls library is 
98 located in the lib/ directory, while the applications in src/ and
99 gnutls-extra and gnutls-openssl library are at libextra/.
100
101 For any copyright year range specified as YYYY-ZZZZ in this package
102 note that the range specifies every single year in that closed interval.
103
104
105 BUGS
106 ----
107 Thorough testing is very important and expensive.  Often, the 
108 developers do not have access to a particular piece of hardware or 
109 configuration to reproduce a scenario.  Notifying the developers about a 
110 possible bug will greatly help the project.  
111
112 If you believe you have found a bug, please report it to bug-gnutls@gnu.org
113 together with any applicable information.  A web interface for the system
114 is available at http://savannah.gnu.org/support/?group=gnutls.
115
116 Applicable information would include why the issue is a GnuTLS bug (if
117 not readily apparent), output from 'uname -a', the version of the library or
118 tool being used, a stack trace if available ('bt full' if under gdb or
119 valgrind output), and perhaps a network trace.  Vague queries or piecemeal 
120 messages are difficult to act upon and don't help the development effort.
121
122 Additional information can be found at the project's manual at:
123 http://www.gnu.org/software/gnutls/documentation.html.
124
125
126 PATCHES
127 -------
128 Patches are welcome and encouraged. Patches can be submitted through the 
129 bug tracking system or the mailing list.  When submitting patches, please 
130 be sure to use sources from the git repository, and preferrably from the 
131 master branch.  To create a patch for the project from a local git repository, 
132 please use the following commands. 'gnutls' should be the local directory 
133 of a previous git clone.
134
135     cd gnutls
136     git add the-file-you-modified.c another-file.c
137     git commit the-file-you-modified.c another-file.c
138     git format-patch
139
140 For more information on use of Git, visit http://git-scm.com/
141
142 ----------------------------------------------------------------------
143 Copying and distribution of this file, with or without modification,
144 are permitted in any medium without royalty provided the copyright
145 notice and this notice are preserved.