updated addresses and URLs. Reported by Nico R.
[gnutls:gnutls.git] / doc / gnutls.texi
1 \input texinfo   @c -*-texinfo-*-
2 @comment %**start of header
3 @setfilename gnutls.info
4 @include version.texi
5 @settitle GnuTLS @value{VERSION}
6 @c don't indent the paragraphs.
7 @paragraphindent 0
8
9 @c Unify some of the indices.
10 @syncodeindex tp fn
11 @syncodeindex pg cp
12
13 @comment %**end of header
14 @finalout
15 @copying
16 This manual is last updated @value{UPDATED} for version
17 @value{VERSION} of GnuTLS.
18
19 Copyright @copyright{} 2001-2013 Free Software Foundation, Inc.\\
20 Copyright @copyright{} 2001-2013 Nikos Mavrogiannopoulos
21
22 @quotation
23 Permission is granted to copy, distribute and/or modify this document
24 under the terms of the GNU Free Documentation License, Version 1.3 or
25 any later version published by the Free Software Foundation; with no
26 Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.  A
27 copy of the license is included in the section entitled ``GNU Free
28 Documentation License''.
29 @end quotation
30 @end copying
31
32 @dircategory Software libraries
33 @direntry
34 * GnuTLS: (gnutls).             GNU Transport Layer Security Library.
35 @end direntry
36
37 @dircategory System Administration
38 @direntry
39 * certtool: (gnutls)Invoking certtool.  Manipulate certificates and keys.
40 * gnutls-serv: (gnutls)Invoking gnutls-serv.    GnuTLS test server.
41 * gnutls-cli: (gnutls)Invoking gnutls-cli.      GnuTLS test client.
42 * gnutls-cli-debug: (gnutls)Invoking gnutls-cli-debug.  GnuTLS debug client.
43 * psktool: (gnutls)Invoking psktool.    Simple TLS-Pre-Shared-Keys manager.
44 * srptool: (gnutls)Invoking srptool.    Simple SRP password tool.
45 @end direntry
46
47 @titlepage
48 @title GnuTLS
49 @subtitle Transport Layer Security Library for the GNU system
50 @subtitle for version @value{VERSION}, @value{UPDATED}
51 @sp 7
52 @center @image{gnutls-logo,6cm,6cm}
53 @author Nikos Mavrogiannopoulos
54 @author Simon Josefsson (@email{bugs@@gnutls.org})
55 @page
56 @vskip 0pt plus 1filll
57 @insertcopying
58 @end titlepage
59
60 @c reference to an internal function.
61 @macro refint {func}
62 @code{\func\}
63 @end macro
64
65 @macro xcite{ref}
66 [@emph{\ref\}]
67 @end macro
68
69 @macro funcref{ref}
70 @ref{\ref\}
71 @end macro
72
73 @macro funcintref{ref}
74 @code{\ref\}
75 @end macro
76
77 @macro showfuncA{ref}
78 @table @code
79 @include functions/\ref\.short
80 @end table
81 @end macro
82
83 @macro showfuncB{ref1,ref2}
84 @table @code
85 @include functions/\ref1\.short
86 @include functions/\ref2\.short
87 @end table
88 @end macro
89
90 @macro showfuncC{ref1,ref2,ref3}
91 @table @code
92 @include functions/\ref1\.short
93 @include functions/\ref2\.short
94 @include functions/\ref3\.short
95 @end table
96 @end macro
97
98 @macro showfuncD{ref1,ref2,ref3,ref4}
99 @table @code
100 @include functions/\ref1\.short
101 @include functions/\ref2\.short
102 @include functions/\ref3\.short
103 @include functions/\ref4\.short
104 @end table
105 @end macro
106
107 @macro showfuncE{ref1,ref2,ref3,ref4,ref5}
108 @table @code
109 @include functions/\ref1\.short
110 @include functions/\ref2\.short
111 @include functions/\ref3\.short
112 @include functions/\ref4\.short
113 @include functions/\ref5\.short
114 @end table
115 @end macro
116
117 @macro showfuncF{ref1,ref2,ref3,ref4,ref5,ref6}
118 @table @code
119 @include functions/\ref1\.short
120 @include functions/\ref2\.short
121 @include functions/\ref3\.short
122 @include functions/\ref4\.short
123 @include functions/\ref5\.short
124 @include functions/\ref6\.short
125 @end table
126 @end macro
127
128 @macro showfuncdesc{ref}
129 @include functions/\ref\
130 @end macro
131
132 @macro showenumdesc{ref,cap}
133 @float Figure,\ref\
134 @include enums/\ref\
135 @caption{\cap\}
136 @end float
137 @end macro
138
139 @contents
140
141 @ifnottex
142 @node Top
143 @top GnuTLS
144
145 @insertcopying
146 @end ifnottex
147
148 @menu
149 * Preface::
150 * Introduction to GnuTLS::
151 * Introduction to TLS::
152 * Authentication methods::
153 * Hardware security modules and abstract key types::
154 * How to use GnuTLS in applications::
155 * GnuTLS application examples::
156 * Using GnuTLS as a cryptographic library::
157 * Other included programs::
158 * Internal architecture of GnuTLS::
159 * Upgrading from previous versions::
160 * Support::
161 * Error codes::
162 * Supported ciphersuites::
163 * API reference::
164 * Copying Information::
165 * Bibliography::
166 * Function and Data Index::
167 * Concept Index::
168 @c * @mybibnode{}::
169 @end menu
170
171 @include cha-preface.texi
172
173 @include cha-library.texi
174
175 @include cha-intro-tls.texi
176
177 @include cha-auth.texi
178
179 @include cha-tokens.texi
180
181 @include cha-gtls-app.texi
182
183 @include cha-gtls-examples.texi
184
185 @include cha-crypto.texi
186
187 @include cha-programs.texi
188
189 @include cha-internals.texi
190
191 @c appendices
192
193 @include cha-upgrade.texi
194
195 @include cha-support.texi
196
197 @include cha-errors.texi
198
199 @include cha-ciphersuites.texi
200
201 @include cha-functions.texi
202
203 @include cha-copying.texi
204
205 @include cha-bib.texi
206
207 @node Function and Data Index
208 @unnumbered Function and Data Index
209
210 @printindex fn
211
212 @node Concept Index
213 @unnumbered Concept Index
214
215 @printindex cp
216
217 @bye