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