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