Update head to match stable 1.0
[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
11 @node top
12 @top gpgv
13 @menu
14 @end menu
15
16 @majorheading Name
17 gpgv ---- signature verification tool
18
19 @majorheading Synopsis
20
21 @majorheading DESCRIPTION
22 @code{gpgv} is the OpenPGP signature checking tool.
23
24 This program is a stripped down version of @code{gpg} which is only
25 able
26 to check signatures. It is somewhat smaller than the full blown
27 @code{gpg} and uses a different (and more simple way) to check that
28 the public keys used to made the signature are trustworth. There is
29 no options files and only very few options are implemented.
30
31 @code{gpgv} assumes that all keys in the keyring are trustworty.
32 It uses by default a keyring named @file{trustedkeys.gpg} which is
33 assumed to be in the home directory as defined by GnuPG or set by an
34 option or an environment variable. An option may be used to specify
35 another keyring or even multiple keyrings.
36
37 @majorheading OPTIONS
38 @code{gpgv} recognizes these options:
39
40 @table @asis
41 @item -v, ---verbose
42 Give more information during processing. If used
43 twice, the input data is listed in detail.
44
45 @item -q, ---quiet
46 Try to be as quiet as possible.
47
48 @item ---keyring @code{file}
49 Add @code{file} to the list of keyrings.
50 If @code{file} begins with a tilde and a slash, these
51 are replaced by the HOME directory. If the filename
52 does not contain a slash, it is assumed to be in the
53 home-directory ("~/.gnupg" if ---homedir is not used).
54 The filename may be prefixed with a scheme:
55
56 "gnupg-ring:" is the default one.
57
58 It might make sense to use it together with ---no-default-keyring.
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
79 @end table
80
81 @majorheading RETURN VALUE
82 The program returns 0 if everything was fine, 1 if at least
83 one signature was bad, and other error codes for fatal errors.
84
85 @majorheading EXAMPLES
86 @table @asis
87 @item gpgv @code{pgpfile}
88 @itemx gpgv @code{sigfile} @code{files}
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 @code{files} 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
96 @end table
97
98 @majorheading ENVIRONMENT
99 @table @asis
100 @item HOME
101 Used to locate the default home directory.
102
103 @item GNUPGHOME
104 If set directory used instead of "~/.gnupg".
105
106 @end table
107
108 @majorheading FILES
109 @table @asis
110 @item ~/.gnupg/trustedkeys.gpg
111 The default keyring with the allowed keys
112
113 @end table
114
115 @bye