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