* configure.ac: Add --disable-optimization. This is handy for debugging
[gnupg.git] / doc / gpgv.sgml
1 <!-- gpgv.sgml - the man page for GnuPG
2     Copyright (C) 2000, 2001 Free Software Foundation, Inc.
3
4     This file is part of GnuPG.
5
6     GnuPG is free software; you can redistribute it and/or modify
7     it under the terms of the GNU General Public License as published by
8     the Free Software Foundation; either version 2 of the License, or
9     (at your option) any later version.
10
11     GnuPG is distributed in the hope that it will be useful,
12     but WITHOUT ANY WARRANTY; without even the implied warranty of
13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14     GNU General Public License for more details.
15
16     You should have received a copy of the GNU General Public License
17     along with this program; if not, write to the Free Software
18     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
19     02110-1301, USA.
20 -->
21 <!-- This file should be processed by docbook-to-man to
22      create a manual page.  This program has currently the bug
23      not to remove leading white space. So this source file does
24      not look very pretty
25
26     FIXME: generated a file with entity (e.g. pathnames) from the
27     configure scripts and include it here
28 -->
29
30
31 <!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
32 <!entity ParmDir "<parameter>directory</parameter>">
33 <!entity ParmFile "<parameter>file</parameter>">
34 <!entity OptParmFile "<optional>&ParmFile;</optional>">
35 <!entity ParmFiles "<parameter>files</parameter>">
36 <!entity OptParmFiles "<optional>&ParmFiles;</optional>">
37 <!entity ParmNames "<parameter>names</parameter>">
38 <!entity OptParmNames "<optional>&ParmNames;</optional>">
39 <!entity ParmName  "<parameter>name</parameter>">
40 <!entity OptParmName  "<optional>&ParmName;</optional>">
41 <!entity ParmKeyIDs "<parameter>key IDs</parameter>">
42 <!entity ParmN      "<parameter>n</parameter>">
43 <!entity ParmFlags  "<parameter>flags</parameter>">
44 <!entity ParmString "<parameter>string</parameter>">
45 <!entity ParmValue  "<parameter>value</parameter>">
46 <!entity ParmNameValue  "<parameter>name=value</parameter>">
47 ]>
48
49 <refentry id="gpgv">
50 <refmeta>
51   <refentrytitle>gpgv</refentrytitle>
52   <manvolnum>1</manvolnum>
53   <refmiscinfo class="gnu">GNU Tools</refmiscinfo>
54 </refmeta>
55 <refnamediv>
56   <refname/gpgv/
57   <refpurpose>signature verification tool</>
58 </refnamediv>
59 <refsynopsisdiv>
60   <synopsis>
61 <command>gpgv</command>
62  <optional><parameter/options/</optional>
63  <optional><parameter/signed files/</optional>
64   </synopsis>
65 </refsynopsisdiv>
66
67 <refsect1>
68     <title>DESCRIPTION</title>
69     <para>
70 <command/gpgv/ is the OpenPGP signature checking tool.
71     </para>
72     <para>
73 This program is a stripped down version of <command/gpg/ which is able
74 only
75 to check signatures.  It is somewhat smaller than the fully blown
76 <command/gpg/ and uses a different (and simpler) way to check that
77 the public keys used to make the signature are trustworthy.  There are
78 no options files and only very few options are implemented.
79 </para>
80 <para>
81 <command/gpgv/ assumes that all keys in the keyring are trustworthy.
82 By default it uses a keyring named <filename/trustedkeys.gpg/ which is
83 assumed to be in the home directory as defined by GnuPG or set by an
84 option or an environment variable.  An option may be used to specify
85 another keyring or even multiple keyrings.
86 </para>
87 </refsect1>
88
89 <refsect1>
90 <title>OPTIONS</title>
91 <para>
92 <command/gpgv/ recognizes these options:
93 </para>
94
95 <variablelist>
96
97
98 <varlistentry>
99 <term>-v, --verbose</term>
100 <listitem><para>
101 Gives more information during processing. If used
102 twice, the input data is listed in detail.
103 </para></listitem></varlistentry>
104
105
106 <varlistentry>
107 <term>-q, --quiet</term>
108 <listitem><para>
109 Try to be as quiet as possible.
110 </para></listitem></varlistentry>
111
112
113 <varlistentry>
114 <term>--keyring &ParmFile;</term>
115 <listitem><para>
116 Add &ParmFile to the list of keyrings.
117 If &ParmFile begins with a tilde and a slash, these
118 are replaced by the HOME directory. If the filename
119 does not contain a slash, it is assumed to be in the
120 home-directory ("~/.gnupg" if --homedir is not used).
121 The filename may be prefixed with a scheme:</para>
122 <para>"gnupg-ring:" is the default one.</para>
123 </listitem></varlistentry>
124
125
126 <varlistentry>
127 <term>--homedir &ParmDir;</term>
128 <listitem><para>
129 Set the name of the home directory to &ParmDir; If this
130 option is not used, it defaults to "~/.gnupg". It does
131 not make sense to use this in an options file. This
132 also overrides the environment variable "GNUPGHOME".
133 </para></listitem></varlistentry>
134
135
136 <varlistentry>
137 <term>--status-fd &ParmN;</term>
138 <listitem><para>
139 Write special status strings to the file descriptor &ParmN;.
140 See the file DETAILS in the documentation for a listing of them.
141 </para></listitem></varlistentry>
142
143
144 <varlistentry>
145 <term>--logger-fd &ParmN;</term>
146 <listitem><para>
147 Write log output to file descriptor &ParmN; and not to stderr.
148 </para></listitem></varlistentry>
149
150
151 <varlistentry>
152 <term>--ignore-time-conflict</term>
153 <listitem><para>
154 GnuPG normally checks that the timestamps associated with keys and
155 signatures have plausible values.  However, sometimes a signature seems to
156 be older than the key due to clock problems.  This option makes these
157 checks just warnings.
158 </para></listitem></varlistentry>
159
160
161 </variablelist>
162 </refsect1>
163
164
165 <refsect1>
166     <title>RETURN VALUE</title>
167     <para>
168 The program returns 0 if everything was fine, 1 if at least
169 one signature was bad, and other error codes for fatal errors.
170     </para>
171 </refsect1>
172
173 <refsect1>
174     <title>EXAMPLES</title>
175     <variablelist>
176
177 <varlistentry>
178 <term>gpgv <parameter/pgpfile/</term>
179 <term>gpgv <parameter/sigfile/ &OptParmFiles;</term>
180 <listitem><para>
181 Verify the signature of the file. The second form
182 is used for detached signatures, where <parameter/sigfile/ is the detached
183 signature (either ASCII armored or binary) and &OptParmFiles are the signed
184 data; if this is not given the name of the file holding the signed data is
185 constructed by cutting off the extension (".asc", ".sig" or ".sign") from
186 <parameter/sigfile/.
187 </para></listitem></varlistentry>
188
189     </variablelist>
190 </refsect1>
191
192
193 <refsect1>
194     <title>ENVIRONMENT</title>
195
196     <variablelist>
197 <varlistentry>
198 <term>HOME</term>
199 <listitem><para>Used to locate the default home directory.</para></listitem>
200 </varlistentry>
201 <varlistentry>
202 <term>GNUPGHOME</term>
203 <listitem><para>If set directory used instead of "~/.gnupg".</para></listitem>
204 </varlistentry>
205
206     </variablelist>
207
208 </refsect1>
209
210 <refsect1>
211     <title>FILES</title>
212     <variablelist>
213
214 <varlistentry>
215 <term>~/.gnupg/trustedkeys.gpg</term>
216 <listitem><para>The default keyring with the allowed keys</para></listitem>
217 </varlistentry>
218
219     </variablelist>
220 </refsect1>
221
222 <!-- SEE ALSO  not yet needed-->
223
224 </refentry>
225