* configure.ac: New option --disable-gnupg-iconv, define
[gnupg.git] / doc / gpgv.texi
1 \input texinfo
2 @setfilename gpgv.info
3 @dircategory GnuPG
4 @direntry
5 * gpgv: (gpgv).                       GnuPG signature verification tool.
6 @end direntry
7
8 @node Top, , , (dir)
9 @top gpgv
10 @chapheading Name
11
12 gpgv --- signature verification tool
13 @chapheading Synopsis
14
15 @example
16 gpgv
17  options
18  signed files
19   
20 @end example
21 @chapheading DESCRIPTION
22
23 @code{gpgv} is the OpenPGP signature checking tool.
24
25 This program is a stripped down version of @code{gpg} which is only
26 able
27 to check signatures. It is somewhat smaller than the full blown
28 @code{gpg} and uses a different (and more simple way) to check that
29 the public keys used to made the signature are trustworth. There is
30 no options files and only very few options are implemented.
31
32 @code{gpgv} assumes that all keys in the keyring are trustworty.
33 It uses by default a keyring named @file{trustedkeys.gpg} which is
34 assumed to be in the home directory as defined by GnuPG or set by an
35 option or an environment variable. An option may be used to specify
36 another keyring or even multiple keyrings.
37 @chapheading OPTIONS
38
39 @code{gpgv} recognizes these options:
40
41 @table @asis
42
43 @item -v, --verbose
44 Give more information during processing. If used
45 twice, the input data is listed in detail.
46
47 @item -q, --quiet
48 Try to be as quiet as possible.
49
50 @item --keyring @code{file}
51 Add @code{file} to the list of keyrings.
52 If @code{file} begins with a tilde and a slash, these
53 are replaced by the HOME directory. If the filename
54 does not contain a slash, it is assumed to be in the
55 home-directory ("~/.gnupg" if --homedir is not used).
56 The filename may be prefixed with a scheme:
57
58 "gnupg-ring:" is the default one.
59
60 @item --homedir @code{directory}
61 Set the name of the home directory to @code{directory} If this
62 option is not used it defaults to "~/.gnupg". It does
63 not make sense to use this in a options file. This
64 also overrides the environment variable "GNUPGHOME".
65
66 @item --status-fd @code{n}
67 Write special status strings to the file descriptor @code{n}.
68 See the file DETAILS in the documentation for a listing of them.
69
70 @item --logger-fd @code{n}
71 Write log output to file descriptor @code{n} and not to stderr.
72
73 @item --ignore-time-conflict
74 GnuPG normally checks that the timestamps associated with keys and
75 signatures have plausible values. However, sometimes a signature seems to
76 be older than the key due to clock problems. This option makes these
77 checks just a warning.
78 @end table
79 @chapheading RETURN VALUE
80
81 The program returns 0 if everything was fine, 1 if at least
82 one signature was bad, and other error codes for fatal errors.
83 @chapheading EXAMPLES
84
85 @table @asis
86
87 @item gpgv @code{pgpfile}
88 @itemx gpgv @code{sigfile} 
89 Verify the signature of the file. The second form
90 is used for detached signatures, where @code{sigfile} is the detached
91 signature (either ASCII armored or binary) and are the signed
92 data; if this is not given the name of the file holding the signed data is
93 constructed by cutting off the extension (".asc", ".sig" or ".sign") from
94 @code{sigfile}.
95 @end table
96 @chapheading ENVIRONMENT
97
98 @table @asis
99
100 @item HOME
101 Used to locate the default home directory.
102
103 @item GNUPGHOME
104 If set directory used instead of "~/.gnupg".
105 @end table
106 @chapheading FILES
107
108 @table @asis
109
110 @item ~/.gnupg/trustedkeys.gpg
111 The default keyring with the allowed keys
112 @end table
113
114 @bye