better doc output
[gnutls.git] / doc / gnutls.texi
blob076536bd9d5332bdecb7a24eddded3205e999d40
1 \input texinfo   @c -*-texinfo-*-
2 @comment %**start of header
3 @setfilename gnutls.info
4 @include version.texi
5 @settitle GnuTLS @value{VERSION}
7 @c don't indent the paragraphs.
8 @paragraphindent 0
10 @c Unify some of the indices.
11 @syncodeindex tp fn
12 @syncodeindex pg cp
14 @comment %**end of header
15 @finalout
16 @copying
17 This manual is last updated @value{UPDATED} for version
18 @value{VERSION} of GnuTLS.
20 Copyright @copyright{} 2001-2012 Free Software Foundation, Inc.
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
32 @dircategory Software libraries
33 @direntry
34 * GnuTLS: (gnutls).             GNU Transport Layer Security Library.
35 @end direntry
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
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{bug-gnutls@@gnu.org})
55 @page
56 @vskip 0pt plus 1filll
57 @insertcopying
58 @end titlepage
60 @c reference to an internal function.
61 @macro refint {func}
62 @code{\func\}
63 @end macro
65 @macro xcite{ref}
66 [@emph{\ref\}]
67 @end macro
69 @macro funcref{ref}
70 @ref{\ref\}
71 @end macro
73 @macro funcintref{ref}
74 @code{\ref\}
75 @end macro
77 @macro showfuncA{ref}
78 @table @code
79 @include functions.short/\ref\
80 @end table
81 @end macro
83 @macro showfuncB{ref1,ref2}
84 @table @code
85 @include functions.short/\ref1\
86 @include functions.short/\ref2\
87 @end table
88 @end macro
90 @macro showfuncC{ref1,ref2,ref3}
91 @table @code
92 @include functions.short/\ref1\
93 @include functions.short/\ref2\
94 @include functions.short/\ref3\
95 @end table
96 @end macro
98 @macro showfuncD{ref1,ref2,ref3,ref4}
99 @table @code
100 @include functions.short/\ref1\
101 @include functions.short/\ref2\
102 @include functions.short/\ref3\
103 @include functions.short/\ref4\
104 @end table
105 @end macro
107 @macro showfuncE{ref1,ref2,ref3,ref4,ref5}
108 @table @code
109 @include functions.short/\ref1\
110 @include functions.short/\ref2\
111 @include functions.short/\ref3\
112 @include functions.short/\ref4\
113 @include functions.short/\ref5\
114 @end table
115 @end macro
117 @macro showfuncF{ref1,ref2,ref3,ref4,ref5,ref6}
118 @table @code
119 @include functions.short/\ref1\
120 @include functions.short/\ref2\
121 @include functions.short/\ref3\
122 @include functions.short/\ref4\
123 @include functions.short/\ref5\
124 @include functions.short/\ref6\
125 @end table
126 @end macro
128 @macro showfuncdesc{ref}
129 @include functions/\ref\
130 @end macro
132 @macro showenumdesc{ref,cap}
133 @float Figure,\ref\
134 @include enums/\ref\
135 @caption{\cap\}
136 @end float
137 @end macro
139 @contents
141 @ifnottex
142 @node Top
143 @top GnuTLS
145 @insertcopying
146 @end ifnottex
148 @menu
149 * Preface::
150 * Introduction to GnuTLS::
151 * Introduction to TLS::
152 * Certificate authentication::
153 * Shared-key and anonymous authentication::
154 * More on certificate authentication::
155 * How to use GnuTLS in applications::
156 * GnuTLS application examples::
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
171 @include cha-preface.texi
173 @include cha-library.texi
175 @include cha-intro-tls.texi
177 @include cha-cert-auth.texi
179 @include cha-shared-key.texi
181 @include cha-cert-auth2.texi
183 @include cha-gtls-app.texi
185 @include cha-gtls-examples.texi
187 @include cha-programs.texi
189 @include cha-internals.texi
191 @c appendices
193 @include cha-upgrade.texi
195 @include cha-support.texi
197 @include cha-errors.texi
199 @include cha-ciphersuites.texi
201 @include cha-functions.texi
203 @include cha-copying.texi
205 @include cha-bib.texi
207 @node Function and Data Index
208 @unnumbered Function and Data Index
210 @printindex fn
212 @node Concept Index
213 @unnumbered Concept Index
215 @printindex cp
217 @bye