Add unfinished gpgtar.
[gnupg.git] / doc / gpgv.texi
index 3bd1863..b6047f4 100644 (file)
-\input texinfo
-@setfilename untitled.info
-@documentencoding us-ascii
-@direntry
-* gpgv: .                       signature verification tool
-@end direntry
+@c Copyright (C) 2004 Free Software Foundation, Inc.
+@c This is part of the GnuPG manual.
+@c For copying conditions, see the file GnuPG.texi.
 
-@node Top, , , (dir)
-@top gpgv
-@chapheading Name
+@c
+@c This is included by tools.texi.
+@c
 
-gpgv --- signature verification tool
-@chapheading Synopsis
-
-@example
+@c Begin GnuPG 1.x specific stuff
+@ifset gpgone
+@macro gpgvname
 gpgv
- options
- signed files
-  
-@end example
-@chapheading DESCRIPTION
-
-@code{gpgv} is the OpenPGP signature checking tool.
-
-This program is a stripped down version of @code{gpg} which is only
-able
-to check signatures. It is somewhat smaller than the full blown
-@code{gpg} and uses a different (and more simple way) to check that
-the public keys used to made the signature are trustworth. There is
-no options files and only very few options are implemented.
-
-@code{gpgv} assumes that all keys in the keyring are trustworty.
-It uses by default a keyring named @file{trustedkeys.gpg} which is
+@end macro
+@manpage gpgv.1
+@node gpgv
+@section Verify OpenPGP signatures
+@ifset manverb
+.B gpgv
+\- Verify OpenPGP signatures
+@end ifset
+
+@mansect synopsis
+@ifset manverb
+.B  gpgv
+.RI [ options ]
+.I signed_files
+@end ifset
+@end ifset
+@c End GnuPG 1.x specific stuff
+
+@c Begin GnuPG 2 specific stuff
+@ifclear gpgone
+@macro gpgvname
+gpgv2
+@end macro
+@manpage gpgv2.1
+@node gpgv
+@section Verify OpenPGP signatures
+@ifset manverb
+.B gpgv2
+\- Verify OpenPGP signatures
+@end ifset
+
+@mansect synopsis
+@ifset manverb
+.B  gpgv2
+.RI [ options ]
+.I signed_files
+@end ifset
+@end ifclear
+@c End GnuPG 2 specific stuff
+
+
+
+@mansect description
+@code{@gpgvname} is an OpenPGP signature verification tool.
+
+This program is actually a stripped-down version of @code{gpg} which is
+only able to check signatures. It is somewhat smaller than the fully-blown
+@code{gpg} and uses a different (and simpler) way to check that
+the public keys used to make the signature are valid. There are
+no configuration files and only a few options are implemented.
+
+@code{@gpgvname} assumes that all keys in the keyring are trustworthy.
+By default it uses a keyring named @file{trustedkeys.gpg} which is
 assumed to be in the home directory as defined by GnuPG or set by an
 option or an environment variable. An option may be used to specify
 another keyring or even multiple keyrings.
-@chapheading OPTIONS
 
-@code{gpgv} recognizes these options:
+@noindent
+@mansect options
+@code{@gpgvname} recognizes these options:
 
-@table @asis
+@table @gnupgtabopt
 
-@item -v, --verbose
-Give more information during processing. If used
+@item --verbose
+@itemx -v
+@opindex verbose
+Gives more information during processing. If used
 twice, the input data is listed in detail.
 
-@item -q, --quiet
+@item --quiet
+@itemx -q
+@opindex quiet
 Try to be as quiet as possible.
 
-@item --keyring @code{file}
-Add @code{file} to the list of keyrings.
-If @code{file} begins with a tilde and a slash, these
+@item --keyring @var{file}
+@opindex keyring
+Add @var{file} to the list of keyrings.
+If @var{file} begins with a tilde and a slash, these
 are replaced by the HOME directory. If the filename
 does not contain a slash, it is assumed to be in the
 home-directory ("~/.gnupg" if --homedir is not used).
-The filename may be prefixed with a scheme:
-
-"gnupg-ring:" is the default one.
-
-@item --homedir @code{directory}
-Set the name of the home directory to @code{directory} If this
-option is not used it defaults to "~/.gnupg". It does
-not make sense to use this in a options file. This
-also overrides the environment variable "GNUPGHOME".
 
-@item --status-fd @code{n}
-Write special status strings to the file descriptor @code{n}.
-See the file DETAILS in the documentation for a listing of them.
+@item --status-fd @var{n}
+@opindex status-fd
+Write special status strings to the file descriptor @var{n}.  See the
+file DETAILS in the documentation for a listing of them.
 
 @item --logger-fd @code{n}
+@opindex logger-fd
 Write log output to file descriptor @code{n} and not to stderr.
 
 @item --ignore-time-conflict
+@opindex ignore-time-conflict
 GnuPG normally checks that the timestamps associated with keys and
 signatures have plausible values. However, sometimes a signature seems to
-be older than the key due to clock problems. This option makes these
-checks just a warning.
+be older than the key due to clock problems. This option turns these
+checks into warnings.
+
+@include opt-homedir.texi
+
 @end table
-@chapheading RETURN VALUE
 
-The program returns 0 if everything was fine, 1 if at least
+@mansect return value
+
+The program returns 0 if everything is fine, 1 if at least
 one signature was bad, and other error codes for fatal errors.
-@chapheading EXAMPLES
+
+@mansect examples
+@subsection Examples
 
 @table @asis
 
-@item gpgv @code{pgpfile}
-@itemx gpgv @code{sigfile} 
-Verify the signature of the file. The second form
-is used for detached signatures, where @code{sigfile} is the detached
-signature (either ASCII armored or binary) and are the signed
-data; if this is not given the name of the file holding the signed data is
-constructed by cutting off the extension (".asc", ".sig" or ".sign") from
-@code{sigfile}.
+@item @gpgvname @code{pgpfile}
+@itemx @gpgvname @code{sigfile} [@code{datafile}]
+Verify the signature of the file. The second form is used for detached
+signatures, where @code{sigfile} is the detached signature (either
+ASCII-armored or binary) and @code{datafile} contains the signed data;
+if @code{datafile} is "-" the signed data is expected on
+@code{stdin}; if @code{datafile} is not given the name of the file
+holding the signed data is constructed by cutting off the extension
+(".asc", ".sig" or ".sign") from @code{sigfile}.
+
 @end table
-@chapheading ENVIRONMENT
+
+@mansect environment
+@subsection Environment
 
 @table @asis
 
@@ -102,13 +144,20 @@ Used to locate the default home directory.
 
 @item GNUPGHOME
 If set directory used instead of "~/.gnupg".
+
 @end table
-@chapheading FILES
+
+@mansect files
+@subsection FILES
 
 @table @asis
 
 @item ~/.gnupg/trustedkeys.gpg
-The default keyring with the allowed keys
+The default keyring with the allowed keys.
+
 @end table
 
-@bye
+@mansect see also
+@command{gpg2}(1)
+@include see-also-note.texi
+