gpg: Fix the TOFU_STATS_LONG status.
[gnupg.git] / doc / gpgv.texi
1 @c Copyright (C) 2004 Free Software Foundation, Inc.
2 @c This is part of the GnuPG manual.
3 @c For copying conditions, see the file GnuPG.texi.
4
5 @c
6 @c This is included by tools.texi.
7 @c
8
9 @include defs.inc
10
11 @c Begin standard stuff
12 @ifclear gpgtwohack
13 @manpage gpgv.1
14 @node gpgv
15 @section Verify OpenPGP signatures
16 @ifset manverb
17 .B gpgv
18 \- Verify OpenPGP signatures
19 @end ifset
20
21 @mansect synopsis
22 @ifset manverb
23 .B  gpgv
24 .RI [ options ]
25 .I signed_files
26 @end ifset
27 @end ifclear
28 @c End standard stuff
29
30 @c Begin gpg2 hack stuff
31 @ifset gpgtwohack
32 @manpage gpgv2.1
33 @node gpgv
34 @section Verify OpenPGP signatures
35 @ifset manverb
36 .B gpgv2
37 \- Verify OpenPGP signatures
38 @end ifset
39
40 @mansect synopsis
41 @ifset manverb
42 .B  gpgv2
43 .RI [ options ]
44 .I signed_files
45 @end ifset
46 @end ifset
47 @c End gpg2 hack stuff
48
49 @mansect description
50 @code{@gpgvname} is an OpenPGP signature verification tool.
51
52 This program is actually a stripped-down version of @code{gpg} which is
53 only able to check signatures. It is somewhat smaller than the fully-blown
54 @code{gpg} and uses a different (and simpler) way to check that
55 the public keys used to make the signature are valid. There are
56 no configuration files and only a few options are implemented.
57
58 @code{@gpgvname} assumes that all keys in the keyring are trustworthy.
59 That does also mean that it does not check for expired or revoked
60 keys.
61
62 By default a keyring named @file{trustedkeys.kbx} is used; if that
63 does not exist a keyring named @file{trustedkeys.gpg} is used.  The
64 default keyring is assumed to be in the home directory of GnuPG,
65 either the default home directory or the one set by an option or an
66 environment variable.  The option @code{--keyring} may be used to
67 specify a different keyring or even multiple keyrings.
68
69
70 @noindent
71 @mansect options
72 @code{@gpgvname} recognizes these options:
73
74 @table @gnupgtabopt
75
76 @item --verbose
77 @itemx -v
78 @opindex verbose
79 Gives more information during processing. If used
80 twice, the input data is listed in detail.
81
82 @item --quiet
83 @itemx -q
84 @opindex quiet
85 Try to be as quiet as possible.
86
87 @item --keyring @var{file}
88 @opindex keyring
89 Add @var{file} to the list of keyrings.
90 If @var{file} begins with a tilde and a slash, these
91 are replaced by the HOME directory. If the filename
92 does not contain a slash, it is assumed to be in the
93 home-directory ("~/.gnupg" if --homedir is not used).
94
95 @item --status-fd @var{n}
96 @opindex status-fd
97 Write special status strings to the file descriptor @var{n}.  See the
98 file DETAILS in the documentation for a listing of them.
99
100 @item --logger-fd @code{n}
101 @opindex logger-fd
102 Write log output to file descriptor @code{n} and not to stderr.
103
104 @item --ignore-time-conflict
105 @opindex ignore-time-conflict
106 GnuPG normally checks that the timestamps associated with keys and
107 signatures have plausible values. However, sometimes a signature seems to
108 be older than the key due to clock problems. This option turns these
109 checks into warnings.
110
111 @include opt-homedir.texi
112
113 @item --weak-digest @code{name}
114 @opindex weak-digest
115 Treat the specified digest algorithm as weak.  Signatures made over
116 weak digests algorithms are normally rejected. This option can be
117 supplied multiple times if multiple algorithms should be considered
118 weak.  MD5 is always considered weak, and does not need to be listed
119 explicitly.
120
121 @end table
122
123 @mansect return value
124
125 The program returns 0 if everything is fine, 1 if at least
126 one signature was bad, and other error codes for fatal errors.
127
128 @mansect examples
129 @subsection Examples
130
131 @table @asis
132
133 @item @gpgvname @code{pgpfile}
134 @itemx @gpgvname @code{sigfile} [@code{datafile}]
135 Verify the signature of the file. The second form is used for detached
136 signatures, where @code{sigfile} is the detached signature (either
137 ASCII-armored or binary) and @code{datafile} contains the signed data;
138 if @code{datafile} is "-" the signed data is expected on
139 @code{stdin}; if @code{datafile} is not given the name of the file
140 holding the signed data is constructed by cutting off the extension
141 (".asc", ".sig" or ".sign") from @code{sigfile}.
142
143 @end table
144
145 @mansect environment
146 @subsection Environment
147
148 @table @asis
149
150 @item HOME
151 Used to locate the default home directory.
152
153 @item GNUPGHOME
154 If set directory used instead of "~/.gnupg".
155
156 @end table
157
158 @mansect files
159 @subsection FILES
160
161 @table @asis
162
163 @item ~/.gnupg/trustedkeys.gpg
164 The default keyring with the allowed keys.
165
166 @end table
167
168 @mansect see also
169 @command{gpg2}(1)
170 @include see-also-note.texi
171