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