gpg: Split a utility function out of a large function.
[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 @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 @copyright{} 2015 g10code Gmbh.
40
41 @quotation
42 Permission is granted to copy, distribute and/or modify this document
43 under the terms of the GNU General Public License as published by the
44 Free Software Foundation; either version 3 of the License, or (at your
45 option) any later version. The text of the license can be found in the
46 section entitled ``Copying''.
47 @end quotation
48 @end copying
49
50
51 @dircategory GNU Utilities
52 @direntry
53 * gpg2: (gnupg).           OpenPGP encryption and signing tool.
54 * gpgsm: (gnupg).          S/MIME encryption and signing tool.
55 * gpg-agent: (gnupg).      The secret key daemon.
56 * dirmngr: (gnupg).        X.509 CRL and OCSP server.
57 * dirmngr-client: (gnupg). X.509 CRL and OCSP client.
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,,,The GnuPG Logo}
96
97 @sp 3
98
99 @author The GnuPG Project (@url{https://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 * Invoking DIRMNGR::    How to launch the CRL and OCSP daemon.
130 * Invoking GPG::        Using the OpenPGP protocol.
131 * Invoking GPGSM::      Using the S/MIME protocol.
132 * Invoking SCDAEMON::   How to handle Smartcards.
133 * Specify a User ID::   How to Specify a User Id.
134
135 * Helper Tools::        Description of small helper tools
136
137 * Howtos::              How to do certain things.
138 * System Notes::        Notes pertaining to certain OSes.
139 * Debugging::           How to solve problems
140
141 * Copying::             GNU General Public License says
142                         how you can copy and share GnuPG
143 * Contributors::        People who have contributed to GnuPG.
144
145 * Glossary::            Short description of terms used.
146 * Option Index::        Index to command line options.
147 * Index::               Index of concepts and symbol names.
148 @end menu
149
150
151 @ifhtml
152 @page
153 @summarycontents
154 @contents
155 @end ifhtml
156
157
158 @include instguide.texi
159
160 @include gpg-agent.texi
161 @include dirmngr.texi
162 @include gpg.texi
163 @include gpgsm.texi
164 @include scdaemon.texi
165
166 @node Specify a User ID
167 @chapter How to Specify a User Id
168 @anchor{how-to-specify-a-user-id}
169 @include specify-user-id.texi
170
171
172 @include tools.texi
173
174 @include howtos.texi
175
176 @include sysnotes.texi
177
178 @include debugging.texi
179
180 @include gpl.texi
181
182 @include contrib.texi
183
184 @c ---------------------------------------------------------------------
185 @c Indexes
186 @c ---------------------------------------------------------------------
187
188 @include glossary.texi
189
190 @node Option Index
191 @unnumbered Option Index
192
193 @printindex op
194
195 @node Index
196 @unnumbered Index
197
198 @printindex cp
199
200 @c ---------------------------------------------------------------------
201 @c Epilogue
202 @c ---------------------------------------------------------------------
203
204 @c @node History
205 @c @unnumbered History
206 @c
207 @c Here are the notices from the old dirmngr manual:
208 @c
209 @c @itemize
210 @c @item Using DirMngr, 2002, Steffen Hansen, Klar"alvdalens Datakonsult AB.
211 @c @item Using DirMngr, 2004, 2005, 2006, 2008 Werner Koch, g10 Code GmbH.
212 @c @end itemize
213 @c
214
215
216 @bye
217
218