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