[svn] GnuPG - r4227 - trunk/doc
svn author wk
cvs at cvs.gnupg.org
Tue Aug 22 16:26:36 CEST 2006
Author: wk
Date: 2006-08-22 16:26:35 +0200 (Tue, 22 Aug 2006)
New Revision: 4227
Modified:
trunk/doc/ChangeLog
trunk/doc/Makefile.am
trunk/doc/tools.texi
trunk/doc/yat2m.c
Log:
added missing gpgv man page
Modified: trunk/doc/ChangeLog
===================================================================
--- trunk/doc/ChangeLog 2006-08-21 20:20:23 UTC (rev 4226)
+++ trunk/doc/ChangeLog 2006-08-22 14:26:35 UTC (rev 4227)
@@ -1,3 +1,9 @@
+2006-08-22 Werner Koch <wk at g10code.com>
+
+ * yat2m.c (parse_file): Added code to skip a line after @mansect.
+
+ * gnupg7.texi: New.
+
2006-08-21 Werner Koch <wk at g10code.com>
* Makefile.am: Added other doc files from gpg 1.4.
Modified: trunk/doc/Makefile.am
===================================================================
--- trunk/doc/Makefile.am 2006-08-21 20:20:23 UTC (rev 4226)
+++ trunk/doc/Makefile.am 2006-08-22 14:26:35 UTC (rev 4227)
@@ -24,8 +24,8 @@
gnupg-badge-openpgp.pdf \
gnupg-card-architecture.eps gnupg-card-architecture.png \
gnupg-card-architecture.pdf \
- faq.raw FAQ faq.html \
- opt-homedir.texi see-also-note.texi
+ faq.raw FAQ faq.html gnupg7.texi \
+ opt-homedir.texi see-also-note.texi
BUILT_SOURCES = gnupg-card-architecture.eps gnupg-card-architecture.png \
gnupg-card-architecture.pdf FAQ faq.html
@@ -46,8 +46,9 @@
YAT2M_OPTIONS = -I $(srcdir) \
--release "GnuPG @PACKAGE_VERSION@" --source "GNU Privacy Guard"
-myman_sources = gpg.texi gpgsm.texi gpg-agent.texi scdaemon.texi tools.texi
-myman_pages = gpg2.1 gpgsm.1 gpg-agent.1 scdaemon.1 \
+myman_sources = gnupg7.texi gpg.texi gpgsm.texi gpg-agent.texi \
+ scdaemon.texi tools.texi
+myman_pages = gnupg.7 gpg2.1 gpgsm.1 gpg-agent.1 scdaemon.1 gpgv2.1 \
watchgnupg.1 gpgconf.1 addgnupghome.8 gpg-preset-passphrase.1 \
gpg-connect-agent.1 gpgparsemail.1 symcryptrun.1 \
gpgsm-gencert.sh.1
Modified: trunk/doc/tools.texi
===================================================================
--- trunk/doc/tools.texi 2006-08-21 20:20:23 UTC (rev 4226)
+++ trunk/doc/tools.texi 2006-08-22 14:26:35 UTC (rev 4227)
@@ -9,6 +9,7 @@
@menu
* watchgnupg:: Read logs from a socket.
+* gpgv:: Verify OpenPGP signatures.
* addgnupghome:: Create .gnupg home directories.
* gpgconf:: Modify .gnupg home directories.
* gpgsm-gencert.sh:: Generate an X.509 certificate request.
@@ -89,6 +90,135 @@
@c
+ at c GPGV
+ at c
+ at manpage gpgv2.1
+ at node gpgv
+ at section Verify OpenPGP signatures
+ at ifset manverb
+.B gpgv
+\- Verify OpenPGP signatures
+ at end ifset
+
+ at mansect synopsis
+ at ifset manverb
+.B gpgv2
+.RI [ options ]
+.I signed_files
+ at end ifset
+
+ at mansect description
+ at code{gpgv2} 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
+ at 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.
+
+ at code{gpgv2} 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.
+
+ at noindent
+ at mansect options
+ at code{gpgv2} recognizes these options:
+
+ at table @gnupgtabopt
+
+ at item --verbose
+ at itemx -v
+ at opindex verbose
+Gives more information during processing. If used
+twice, the input data is listed in detail.
+
+ at item --quiet
+ at itemx -q
+ at opindex quiet
+Try to be as quiet as possible.
+
+ at item --keyring @var{file}
+ at 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).
+
+ at item --status-fd @var{n}
+ at 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.
+
+ at item --logger-fd @code{n}
+ at opindex logger-fd
+Write log output to file descriptor @code{n} and not to stderr.
+
+ at item --ignore-time-conflict
+ at 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 turns these
+checks into warnings.
+
+ at include opt-homedir.texi
+
+ at end table
+
+ at mansect return value
+
+The program returns 0 if everything was fine, 1 if at least
+one signature was bad, and other error codes for fatal errors.
+
+ at mansect examples
+ at subsection Examples
+
+ at table @asis
+
+ at item gpgv2 @code{pgpfile}
+ at itemx gpgv2 @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
+ at code{sigfile}.
+
+ at end table
+
+ at mansect environment
+ at subsection Environment
+
+ at table @asis
+
+ at item HOME
+Used to locate the default home directory.
+
+ at item GNUPGHOME
+If set directory used instead of "~/.gnupg".
+
+ at end table
+
+ at mansect files
+ at subsection FILES
+
+ at table @asis
+
+ at item ~/.gnupg/trustedkeys.gpg
+The default keyring with the allowed keys
+
+ at end table
+
+ at mansect see also
+ at command{gpg2}(1)
+ at include see-also-note.texi
+
+
+
+
+ at c
@c ADDGNUPGHOME
@c
@manpage addgnupghome.8
Modified: trunk/doc/yat2m.c
===================================================================
--- trunk/doc/yat2m.c 2006-08-21 20:20:23 UTC (rev 4226)
+++ trunk/doc/yat2m.c 2006-08-22 14:26:35 UTC (rev 4227)
@@ -40,9 +40,13 @@
go into the man page. These macros need to be used without leading
left space. Processing starts after a "manpage" macro has been
seen. "mansect" identifies the section and yat2m make sure to
- emit the sections in the proper order. To insert verbatim troff
- markup, the follwing texinfo code may be used:
+ emit the sections in the proper order. Note that @mansect skips
+ the next input line if that line begins with @subsection or
+ @chapheading.
+ To insert verbatim troff markup, the follwing texinfo code may be
+ used:
+
@ifset manverb
.B whateever you want
@end ifset
@@ -51,13 +55,26 @@
@c man:.B whatever you want
- This is useful in case you need just one line. @section is
- ignored, however @subsection gets rendered as ".SS". @menu is
- completely skipped. Several man pages may be extracted from one
- file, either using the --store or the --select option.
- Makefile snippet from GnuPG:
+ This is useful in case you need just one line. If you want to
+ include parts only in the man page but keep the texinfo
+ translation you may use:
+ @ifset isman
+ stuff to be rendered only on man pages
+ @end ifset
+ or to exclude stuff from man pages:
+
+ @ifclear isman
+ stuff not to be rendered on man pages
+ @end ifclear
+
+ the keyword @section is ignored, however @subsection gets rendered
+ as ".SS". @menu is completely skipped. Several man pages may be
+ extracted from one file, either using the --store or the --select
+ option.
+
+
*/
#include <stdio.h>
@@ -794,6 +811,7 @@
int in_verbatim = 0;
int in_pause = 0;
int skip_to_end = 0; /* Used to skip over menu entries. */
+ int skip_sect_line = 0; /* Skip after @mansect. */
line = xmalloc (LINESIZE);
while (fgets (line, LINESIZE, fp))
@@ -810,6 +828,15 @@
break;
}
line[--n] = 0;
+
+ if (skip_sect_line)
+ {
+ skip_sect_line = 0;
+ if (!strncmp (line, "@subsection", 11)
+ || !strncmp (line, "@chapheading", 12))
+ continue;
+ }
+
/* We only parse lines we need and ignore the rest. There are a
few macros used to control this as well as one @ifset
command. Parts we know about are saved away into containers
@@ -862,6 +889,7 @@
free (*section_name);
*section_name = ascii_strupr (xstrdup (p));
in_pause = 0;
+ skip_sect_line = 1;
}
}
else if (n == 9 && !memcmp (line, "@manpause", 9))
More information about the Gnupg-commits
mailing list