gpg: Allow predefined names as answer to the keygen.algo prompt.
[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 By default it uses a keyring named @file{trustedkeys.gpg} which is
66 assumed to be in the home directory as defined by GnuPG or set by an
67 option or an environment variable. An option may be used to specify
68 another keyring or even multiple keyrings.
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 @end table
114
115 @mansect return value
116
117 The program returns 0 if everything is fine, 1 if at least
118 one signature was bad, and other error codes for fatal errors.
119
120 @mansect examples
121 @subsection Examples
122
123 @table @asis
124
125 @item @gpgvname @code{pgpfile}
126 @itemx @gpgvname @code{sigfile} [@code{datafile}]
127 Verify the signature of the file. The second form is used for detached
128 signatures, where @code{sigfile} is the detached signature (either
129 ASCII-armored or binary) and @code{datafile} contains the signed data;
130 if @code{datafile} is "-" the signed data is expected on
131 @code{stdin}; if @code{datafile} is not given the name of the file
132 holding the signed data is constructed by cutting off the extension
133 (".asc", ".sig" or ".sign") from @code{sigfile}.
134
135 @end table
136
137 @mansect environment
138 @subsection Environment
139
140 @table @asis
141
142 @item HOME
143 Used to locate the default home directory.
144
145 @item GNUPGHOME
146 If set directory used instead of "~/.gnupg".
147
148 @end table
149
150 @mansect files
151 @subsection FILES
152
153 @table @asis
154
155 @item ~/.gnupg/trustedkeys.gpg
156 The default keyring with the allowed keys.
157
158 @end table
159
160 @mansect see also
161 @command{gpg2}(1)
162 @include see-also-note.texi
163