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 standard stuff
  12 @ifclear gpgtwohack
  13 @manpage gpgv.1
  14 @node gpgv
  15 @section Verify OpenPGP signatures
  16 @ifset manverb
  17 .B gpgv
  18 \- Verify OpenPGP signatures
  19 @end ifset
  20
  21 @mansect synopsis
  22 @ifset manverb
  23 .B  gpgv
  24 .RI [ options ]
  25 .I signed_files
  26 @end ifset
  27 @end ifclear
  28 @c End standard stuff
  29
  30 @c Begin gpg2 hack stuff
  31 @ifset gpgtwohack
  32 @manpage gpgv2.1
  33 @node gpgv
  34 @section Verify OpenPGP signatures
  35 @ifset manverb
  36 .B gpgv2
  37 \- Verify OpenPGP signatures
  38 @end ifset
  39
  40 @mansect synopsis
  41 @ifset manverb
  42 .B  gpgv2
  43 .RI [ options ]
  44 .I signed_files
  45 @end ifset
  46 @end ifset
  47 @c End gpg2 hack stuff
  48
  49 @mansect description
  50 @code{@gpgvname} is an OpenPGP signature verification tool.
  51
  52 This program is actually a stripped-down version of @code{gpg} which is
  53 only able to check signatures. It is somewhat smaller than the fully-blown
  54 @code{gpg} and uses a different (and simpler) way to check that
  55 the public keys used to make the signature are valid. There are
  56 no configuration files and only a few options are implemented.
  57
  58 @code{@gpgvname} assumes that all keys in the keyring are trustworthy.
  59 That does also mean that it does not check for expired or revoked
  60 keys.
  61
  62 By default a keyring named @file{trustedkeys.kbx} is used; if that
  63 does not exist a keyring named @file{trustedkeys.gpg} is used.  The
  64 default keyring is assumed to be in the home directory of GnuPG,
  65 either the default home directory or the one set by an option or an
  66 environment variable.  The option @code{--keyring} may be used to
  67 specify a different keyring or even multiple keyrings.
  68
  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 --output @var{file}
  96 @itemx -o @var{file}
  97 @opindex output
  98 Write output to @var{file}; to write to stdout use @code{-}.  This
  99 option can be used to get the signed text from a cleartext or binary
 100 signature; it also works for detached signatures, but in that case
 101 this option is in general not useful.  Note that an existing file will
 102 be overwritten.
 103
 104
 105 @item --status-fd @var{n}
 106 @opindex status-fd
 107 Write special status strings to the file descriptor @var{n}.  See the
 108 file DETAILS in the documentation for a listing of them.
 109
 110 @item --logger-fd @code{n}
 111 @opindex logger-fd
 112 Write log output to file descriptor @code{n} and not to stderr.
 113
 114 @item --ignore-time-conflict
 115 @opindex ignore-time-conflict
 116 GnuPG normally checks that the timestamps associated with keys and
 117 signatures have plausible values. However, sometimes a signature seems to
 118 be older than the key due to clock problems. This option turns these
 119 checks into warnings.
 120
 121 @include opt-homedir.texi
 122
 123 @item --weak-digest @code{name}
 124 @opindex weak-digest
 125 Treat the specified digest algorithm as weak.  Signatures made over
 126 weak digests algorithms are normally rejected. This option can be
 127 supplied multiple times if multiple algorithms should be considered
 128 weak.  MD5 is always considered weak, and does not need to be listed
 129 explicitly.
 130
 131 @item --enable-special-filenames
 132 @opindex enable-special-filenames
 133 This option enables a mode in which filenames of the form
 134 @file{-&n}, where n is a non-negative decimal number,
 135 refer to the file descriptor n and not to a file with that name.
 136
 137 @end table
 138
 139 @mansect return value
 140
 141 The program returns 0 if everything is fine, 1 if at least
 142 one signature was bad, and other error codes for fatal errors.
 143
 144 @mansect examples
 145 @subsection Examples
 146
 147 @table @asis
 148
 149 @item @gpgvname @code{pgpfile}
 150 @itemx @gpgvname @code{sigfile} [@code{datafile}]
 151 Verify the signature of the file. The second form is used for detached
 152 signatures, where @code{sigfile} is the detached signature (either
 153 ASCII-armored or binary) and @code{datafile} contains the signed data;
 154 if @code{datafile} is "-" the signed data is expected on
 155 @code{stdin}; if @code{datafile} is not given the name of the file
 156 holding the signed data is constructed by cutting off the extension
 157 (".asc", ".sig" or ".sign") from @code{sigfile}.
 158
 159 @end table
 160
 161 @mansect environment
 162 @subsection Environment
 163
 164 @table @asis
 165
 166 @item HOME
 167 Used to locate the default home directory.
 168
 169 @item GNUPGHOME
 170 If set directory used instead of "~/.gnupg".
 171
 172 @end table
 173
 174 @mansect files
 175 @subsection FILES
 176
 177 @table @asis
 178
 179 @item ~/.gnupg/trustedkeys.gpg
 180 The default keyring with the allowed keys.
 181
 182 @end table
 183
 184 @mansect see also
 185 @command{gpg2}(1)
 186 @include see-also-note.texi
 187