d74a76ca96d7ab4a1d92cb5c94b0536543f2380a
[gnupg.git] / doc / gnupg.texi
1 \input texinfo                      @c -*-texinfo-*-
2 @c %**start of header
3 @setfilename gnupg.info
4
5 @include version.texi
6
7 @macro copyrightnotice
8 Copyright @copyright{} 2002, 2004 Free Software Foundation, Inc.
9 @end macro
10 @macro permissionnotice
11 Permission is granted to copy, distribute and/or modify this document
12 under the terms of the GNU General Public License as published by the
13 Free Software Foundation; either version 2 of the License, or (at your
14 option) any later version. The text of the license can be found in the
15 section entitled ``Copying''.
16 @end macro
17
18
19 @settitle Using the GNU Privacy Guard
20
21 @c Create a separate index for command line options.
22 @defcodeindex op
23 @c Merge the standard indexes into a single one.
24 @syncodeindex fn cp
25 @syncodeindex vr cp
26 @syncodeindex ky cp
27 @syncodeindex pg cp
28 @syncodeindex tp cp
29
30 @c printing stuff taken from gcc.
31 @macro gnupgtabopt{body}
32 @code{\body\}
33 @end macro
34 @macro gnupgoptlist{body}
35 @smallexample
36 \body\
37 @end smallexample
38 @end macro
39 @c Makeinfo handles the above macro OK, TeX needs manual line breaks;
40 @c they get lost at some point in handling the macro.  But if @macro is
41 @c used here rather than @alias, it produces double line breaks.
42 @iftex
43 @alias gol = *
44 @end iftex
45 @ifnottex
46 @macro gol
47 @end macro
48 @end ifnottex
49
50
51 @c Change the font used for @def... commands, since the default
52 @c proportional one used is bad for names starting __.
53 @tex
54 \global\setfont\defbf\ttbshape{10}{\magstep1}
55 @end tex
56
57 @c %**end of header
58
59 @ifnottex
60 @dircategory GNU Utilities
61 @direntry
62 * gpg: (gnupg).            OpenPGP encryption and signing tool.
63 * gpgsm: (gnupg).          S/MIME encryption and signing tool.
64 @end direntry
65 This file documents the use and the internals of the GNU Privacy Guard.
66
67 This is Edition @value{EDITION}, last updated @value{UPDATED}, of
68 @cite{The `GNU Privacy Guard' Manual}, for Version @value{VERSION}.
69 @sp 1
70 Published by the Free Software Foundation@*
71 59 Temple Place - Suite 330@*
72 Boston, MA 02111-1307 USA
73 @sp 1
74 @copyrightnotice{}
75 @sp 1
76 @permissionnotice{}
77 @end ifnottex
78
79 @setchapternewpage odd
80
81 @titlepage
82 @title Using the GNU Privacy Guard
83 @subtitle Version @value{VERSION}
84 @subtitle @value{UPDATED}
85
86 @sp 6
87
88 @image{gnupg-badge-openpgp,8cm,,The GnuPG Logo}
89
90 @sp 6
91
92 @author Werner Koch @code{(wk@@gnupg.org)}
93
94
95 @page
96 @vskip 0pt plus 1filll
97 @copyrightnotice{}
98 @sp 2
99 @permissionnotice{}
100 @end titlepage
101 @summarycontents
102 @contents
103 @page
104
105
106 @node Top
107 @top Introduction
108 @cindex introduction
109
110 This manual documents how to use the GNU Privay Guard system as well as
111 the administration and the architecture.
112
113 @menu
114 * Invoking GPG::        Using the OpenPGP protocol.
115 * Invoking GPGSM::      Using the S/MIME protocol.
116 * Invoking GPG-AGENT::  How to launch the secret key daemon.
117 * Invoking SCDAEMON::   How to handle Smartcards.
118
119 Developer information
120
121 * Assuan::              Description of the Assuan protocol.
122 * System Notes::        Notes pertaining to certain OSes.
123
124 Miscellaneous
125
126 * Helper Tools::        Description of small helper tools
127 * Debugging::           How to solve problems
128 * Copying::             GNU General Public License says
129                         how you can copy and share GnuPG
130 * Contributors::        People who have contributed to GnuPG.
131
132 Indices
133
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
138
139 @include gpg.texi
140 @include gpgsm.texi
141 @include gpg-agent.texi
142 @include scdaemon.texi
143
144 @include assuan.texi
145 @include sysnotes.texi
146
147 @include tools.texi
148 @include debugging.texi
149
150 @include gpl.texi
151
152 @include contrib.texi
153
154 @c ---------------------------------------------------------------------
155 @c Indexes
156 @c ---------------------------------------------------------------------
157
158 @include glossary.texi
159
160 @node Option Index
161 @unnumbered Option Index
162
163 @printindex op
164
165 @node Index
166 @unnumbered Index
167
168 @printindex cp
169
170 @c ---------------------------------------------------------------------
171 @c Epilogue
172 @c ---------------------------------------------------------------------
173
174 @bye
175
176