doc: Update for modern makeinfo.
[gnupg.git] / doc / gnupg.texi
1 \input texinfo                      @c -*-texinfo-*-
2 @c %**start of header
3 @setfilename gnupg.info
4 @include version.texi
5 @settitle Using the GNU Privacy Guard
6
7 @c A couple of macros with no effect on texinfo
8 @c but used by the yat2m processor.
9 @macro manpage {a}
10 @end macro
11 @macro mansect {a}
12 @end macro
13 @macro manpause
14 @end macro
15 @macro mancont
16 @end macro
17
18 @c Create a separate index for command line options.
19 @defcodeindex op
20 @c Merge the standard indexes into a single one.
21 @syncodeindex fn cp
22 @syncodeindex vr cp
23 @syncodeindex ky cp
24 @syncodeindex pg cp
25 @syncodeindex tp cp
26 @c %**end of header
27 @copying
28 This is the @cite{The GNU Privacy Guard Manual} (version
29 @value{VERSION}, @value{UPDATED-MONTH}).
30
31 @iftex
32 Published by the Free Software Foundation@*
33 51 Franklin St, Fifth Floor@*
34 Boston, MA 02110-1301 USA
35 @end iftex
36
37 Copyright @copyright{} 2002, 2004, 2005, 2006, 2007, 2010 Free Software Foundation, Inc.
38
39 @quotation
40 Permission is granted to copy, distribute and/or modify this document
41 under the terms of the GNU General Public License as published by the
42 Free Software Foundation; either version 3 of the License, or (at your
43 option) any later version. The text of the license can be found in the
44 section entitled ``Copying''.
45 @end quotation
46 @end copying
47
48
49 @dircategory GNU Utilities
50 @direntry
51 * gpg2: (gnupg).           OpenPGP encryption and signing tool.
52 * gpgsm: (gnupg).          S/MIME encryption and signing tool.
53 * gpg-agent: (gnupg).      The secret key daemon.
54 @ifset gpgtwoone
55 * dirmngr: (gnupg).        X.509 CRL and OCSP server.
56 * dirmngr-client: (gnupg). X.509 CRL and OCSP client.
57 @end ifset
58 @end direntry
59
60
61 @c
62 @c Printing stuff taken from gcc.
63 @c
64 @macro gnupgtabopt{body}
65 @code{\body\}
66 @end macro
67 @macro gnupgoptlist{body}
68 @smallexample
69 \body\
70 @end smallexample
71 @end macro
72 @c Makeinfo handles the above macro OK, TeX needs manual line breaks;
73 @c they get lost at some point in handling the macro.  But if @macro is
74 @c used here rather than @alias, it produces double line breaks.
75 @iftex
76 @alias gol = *
77 @end iftex
78 @ifnottex
79 @macro gol
80 @end macro
81 @end ifnottex
82
83
84 @c
85 @c Titlepage
86 @c
87 @setchapternewpage odd
88 @titlepage
89 @title Using the GNU Privacy Guard
90 @subtitle Version @value{VERSION}
91 @subtitle @value{UPDATED-MONTH}
92
93 @sp 3
94
95 @image{gnupg-logo,16cm,,The GnuPG Logo}
96
97 @sp 3
98
99 @author Werner Koch (@email{wk@@gnupg.org})
100
101 @page
102 @vskip 0pt plus 1filll
103 @insertcopying
104 @end titlepage
105
106 @ifnothtml
107 @summarycontents
108 @contents
109 @page
110 @end ifnothtml
111
112 @ifhtml
113 @center @image{gnupg-logo-tr,6cm,,The GnuPG Logo}
114 @end ifhtml
115
116 @ifnottex
117 @node Top
118 @top
119 @insertcopying
120
121 This manual documents how to use the GNU Privacy Guard system as well as
122 the administration and the architecture.
123 @end ifnottex
124
125 @menu
126 * Installation::        A short installation guide.
127
128 * Invoking GPG-AGENT::  How to launch the secret key daemon.
129 @ifset gpgtwoone
130 * Invoking DIRMNGR::    How to launch the CRL and OCSP daemon.
131 @end ifset
132 * Invoking GPG::        Using the OpenPGP protocol.
133 * Invoking GPGSM::      Using the S/MIME protocol.
134 * Invoking SCDAEMON::   How to handle Smartcards.
135 * Specify a User ID::   How to Specify a User Id.
136
137 * Helper Tools::        Description of small helper tools
138
139 * Howtos::              How to do certain things.
140 * System Notes::        Notes pertaining to certain OSes.
141 * Debugging::           How to solve problems
142
143 * Copying::             GNU General Public License says
144                         how you can copy and share GnuPG
145 * Contributors::        People who have contributed to GnuPG.
146
147 * Glossary::            Short description of terms used.
148 * Option Index::        Index to command line options.
149 * Index::               Index of concepts and symbol names.
150 @end menu
151
152
153 @ifhtml
154 @page
155 @summarycontents
156 @contents
157 @end ifhtml
158
159
160 @include instguide.texi
161
162 @include gpg-agent.texi
163 @ifset gpgtwoone
164 @include dirmngr.texi
165 @end ifset
166 @include gpg.texi
167 @include gpgsm.texi
168 @include scdaemon.texi
169
170 @node Specify a User ID
171 @chapter How to Specify a User Id
172 @anchor{how-to-specify-a-user-id}
173 @include specify-user-id.texi
174
175
176 @include tools.texi
177
178 @include howtos.texi
179
180 @include sysnotes.texi
181
182 @include debugging.texi
183
184 @include gpl.texi
185
186 @include contrib.texi
187
188 @c ---------------------------------------------------------------------
189 @c Indexes
190 @c ---------------------------------------------------------------------
191
192 @include glossary.texi
193
194 @node Option Index
195 @unnumbered Option Index
196
197 @printindex op
198
199 @node Index
200 @unnumbered Index
201
202 @printindex cp
203
204 @c ---------------------------------------------------------------------
205 @c Epilogue
206 @c ---------------------------------------------------------------------
207
208 @c @node History
209 @c @unnumbered History
210 @c
211 @c Here are the notices from the old dirmngr manual:
212 @c
213 @c @itemize
214 @c @item Using DirMngr, 2002, Steffen Hansen, Klar"alvdalens Datakonsult AB.
215 @c @item Using DirMngr, 2004, 2005, 2006, 2008 Werner Koch, g10 Code GmbH.
216 @c @end itemize
217 @c
218
219
220 @bye
221
222