2006-09-24 Marcus Brinkmann <marcus@g10code.de>
[gnupg.git] / doc / gnupg.texi
blob48151f764693c02683c8d17c58d1569eeddb5404
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
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
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}).
31 @iftex
32 Published by the Free Software Foundation@*
33 51 Franklin St, Fifth Floor@*
34 Boston, MA 02110-1301 USA
35 @end iftex
37 Copyright @copyright{} 2002, 2004, 2005, 2006 Free Software Foundation, Inc.
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 2 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
49 @dircategory GNU Utilities
50 @direntry
51 * gpg: (gnupg).            OpenPGP encryption and signing tool.
52 * gpgsm: (gnupg).          S/MIME encryption and signing tool.
53 @end direntry
57 @c Printing stuff taken from gcc.
59 @macro gnupgtabopt{body}
60 @code{\body\}
61 @end macro
62 @macro gnupgoptlist{body}
63 @smallexample
64 \body\
65 @end smallexample
66 @end macro
67 @c Makeinfo handles the above macro OK, TeX needs manual line breaks;
68 @c they get lost at some point in handling the macro.  But if @macro is
69 @c used here rather than @alias, it produces double line breaks.
70 @iftex
71 @alias gol = *
72 @end iftex
73 @ifnottex
74 @macro gol
75 @end macro
76 @end ifnottex
80 @c Titlepage
82 @setchapternewpage odd
83 @titlepage
84 @title Using the GNU Privacy Guard
85 @subtitle Version @value{VERSION}
86 @subtitle @value{UPDATED}
88 @sp 3
90 @image{gnupg-badge-openpgp,8cm,,The GnuPG Logo}
92 @sp 3
94 @author Werner Koch (@email{wk@@gnupg.org})
96 @page
97 @vskip 0pt plus 1filll
98 @insertcopying
99 @end titlepage
101 @ifnothtml
102 @summarycontents
103 @contents
104 @page
105 @end ifnothtml
107 @ifnottex
108 @node Top
109 @top 
110 @insertcopying
112 This manual documents how to use the GNU Privacy Guard system as well as
113 the administration and the architecture.
114 @end ifnottex
116 @menu
117 * Installation::        A short installation guide.
119 * Invoking GPG::        Using the OpenPGP protocol.
120 * Invoking GPGSM::      Using the S/MIME protocol.
121 * Invoking GPG-AGENT::  How to launch the secret key daemon.
122 * Invoking SCDAEMON::   How to handle Smartcards.
123 * Specify a User ID::   How to Specify a User Id.
125 * Helper Tools::        Description of small helper tools
127 * System Notes::        Notes pertaining to certain OSes.
128 * Debugging::           How to solve problems
130 * Copying::             GNU General Public License says
131                         how you can copy and share GnuPG
132 * Contributors::        People who have contributed to GnuPG.
134 * Glossary::            Short descrition of used terms.
135 * Option Index::        Index to command line options.
136 * Index::               Index of concepts and symbol names.
137 @end menu
139 @ifhtml
141 @center @image{gnupg-badge-openpgp,6cm,,The GnuPG Logo}
143 @end ifhtml
146 @ifhtml
147 @page
148 @summarycontents
149 @contents
150 @end ifhtml
153 @include instguide.texi
155 @include gpg.texi
156 @include gpgsm.texi
157 @include gpg-agent.texi
158 @include scdaemon.texi
160 @node Specify a User ID
161 @chapter How to Specify a User Id
162 @anchor{how-to-specify-a-user-id}
163 @include specify-user-id.texi
166 @include tools.texi
168 @include sysnotes.texi
170 @include debugging.texi
172 @include gpl.texi
174 @include contrib.texi
176 @c ---------------------------------------------------------------------
177 @c Indexes
178 @c ---------------------------------------------------------------------
180 @include glossary.texi
182 @node Option Index
183 @unnumbered Option Index
185 @printindex op
187 @node Index
188 @unnumbered Index
190 @printindex cp
192 @c ---------------------------------------------------------------------
193 @c Epilogue
194 @c ---------------------------------------------------------------------
196 @bye