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