1
0
mirror of git://git.gnupg.org/gnupg.git synced 2024-11-04 20:38:50 +01:00

Changing the way man pages are build.

This commit is contained in:
Werner Koch 2006-12-04 13:51:18 +00:00
parent ede66f6fb5
commit 68629647f3
7 changed files with 1366 additions and 5957 deletions

View File

@ -1,3 +1,7 @@
2006-12-04 Werner Koch <wk@g10code.com>
* yat2m.c: New.
2006-06-22 David Shaw <dshaw@jabberwocky.com>
* gpg.sgml: Document --enable-dsa2, --disable-dsa2, and

View File

@ -20,13 +20,19 @@
AUTOMAKE_OPTIONS = no-texinfo.tex
EXTRA_DIST = DETAILS gpg.sgml gpg.1 gpgv.sgml gpgv.1 faq.raw FAQ faq.html \
EXTRA_DIST = DETAILS gpg.1 gpgv.1 faq.raw FAQ faq.html \
HACKING OpenPGP README.W32 samplekeys.asc gnupg.7 \
TRANSLATE gpg.ru.sgml gpg.ru.1 highlights-1.4.txt
man_MANS = gpg.1 gpgv.1 gnupg.7 gpg.ru.1
noinst_PROGRAMS = yat2m
myman_sources = gpg.texi
myman_pages = gpg.1
info_TEXINFOS = gpg.texi
man_MANS = $(myman_pages) gnupg.7 gpg.ru.1
info_TEXINFOS = gpg.texi gpgv.texi
# Need this to avoid building of dvis with automake 1.4
DVIS =
@ -38,26 +44,36 @@ BUILT_SOURCES = FAQ faq.html
# be built files.
CLEANFILES = faq.raw.xref gpg.xml gpgv.xml gpg.ru.xml
DISTCLEANFILES = yat2m-stamp.tmp yat2m-stamp $(myman_pages)
YAT2M_OPTIONS = -I $(srcdir) -D gpgone \
--release "GnuPG @PACKAGE_VERSION@" --source "GNU Privacy Guard"
yat2m_SOURCES = yat2m.c
yat2m-stamp: $(myman_sources)
@rm -f yat2m-stamp.tmp
@touch yat2m-stamp.tmp
for file in $(myman_sources) ; do \
./yat2m $(YAT2M_OPTIONS) --store \
`test -f '$$file' || echo '$(srcdir)/'`$$file ; done
@mv -f yat2m-stamp.tmp $@
yat2m-stamp: yat2m
$(myman_pages) : yat2m-stamp
@if test -f $@; then :; else \
trap 'rm -rf yat2m-stamp yat2m-lock' 1 2 13 15; \
if mkdir yat2m-lock 2>/dev/null; then \
rm -f yat2m-stamp; \
$(MAKE) $(AM_MAKEFLAGS) yat2m-stamp; \
rmdir yat2m-lock; \
else \
while test -d yat2m-lock; do sleep 1; done; \
test -f yat2m-stamp; exit $$?; \
fi; \
fi
# We better build the texi versions manually.
#%.texi : %.xml
#if HAVE_DOCBOOK_TO_TEXI
# docbook2texi $< | sed 's,--,---,' \
# | $(top_srcdir)/scripts/fix-db-texi $@ >$@
#else
# : Warning: missing docbook to texinfo tools, cannot make $@
# touch $@
#endif
#
#%.xml : %.sgml
#if HAVE_DOCBOOK_TO_TEXI
# sgml2xml -x lower $< >$@
#else
# : Warning: missing docbook to texinfo tools, cannot make $@
# touch $@
#endif
#
%.1 : %.sgml
if HAVE_DOCBOOK_TO_MAN

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -1,225 +0,0 @@
<!-- gpgv.sgml - the man page for GnuPG
Copyright (C) 2000, 2001 Free Software Foundation, Inc.
This file is part of GnuPG.
GnuPG is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
GnuPG is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA.
-->
<!-- This file should be processed by docbook-to-man to
create a manual page. This program has currently the bug
not to remove leading white space. So this source file does
not look very pretty
FIXME: generated a file with entity (e.g. pathnames) from the
configure scripts and include it here
-->
<!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
<!entity ParmDir "<parameter>directory</parameter>">
<!entity ParmFile "<parameter>file</parameter>">
<!entity OptParmFile "<optional>&ParmFile;</optional>">
<!entity ParmFiles "<parameter>files</parameter>">
<!entity OptParmFiles "<optional>&ParmFiles;</optional>">
<!entity ParmNames "<parameter>names</parameter>">
<!entity OptParmNames "<optional>&ParmNames;</optional>">
<!entity ParmName "<parameter>name</parameter>">
<!entity OptParmName "<optional>&ParmName;</optional>">
<!entity ParmKeyIDs "<parameter>key IDs</parameter>">
<!entity ParmN "<parameter>n</parameter>">
<!entity ParmFlags "<parameter>flags</parameter>">
<!entity ParmString "<parameter>string</parameter>">
<!entity ParmValue "<parameter>value</parameter>">
<!entity ParmNameValue "<parameter>name=value</parameter>">
]>
<refentry id="gpgv">
<refmeta>
<refentrytitle>gpgv</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class="gnu">GNU Tools</refmiscinfo>
</refmeta>
<refnamediv>
<refname/gpgv/
<refpurpose>signature verification tool</>
</refnamediv>
<refsynopsisdiv>
<synopsis>
<command>gpgv</command>
<optional><parameter/options/</optional>
<optional><parameter/signed files/</optional>
</synopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>
<command/gpgv/ is the OpenPGP signature checking tool.
</para>
<para>
This program is a stripped down version of <command/gpg/ which is able
only
to check signatures. It is somewhat smaller than the fully blown
<command/gpg/ and uses a different (and simpler) way to check that
the public keys used to make the signature are trustworthy. There are
no options files and only very few options are implemented.
</para>
<para>
<command/gpgv/ assumes that all keys in the keyring are trustworthy.
By default it uses a keyring named <filename/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.
</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<para>
<command/gpgv/ recognizes these options:
</para>
<variablelist>
<varlistentry>
<term>-v, --verbose</term>
<listitem><para>
Gives more information during processing. If used
twice, the input data is listed in detail.
</para></listitem></varlistentry>
<varlistentry>
<term>-q, --quiet</term>
<listitem><para>
Try to be as quiet as possible.
</para></listitem></varlistentry>
<varlistentry>
<term>--keyring &ParmFile;</term>
<listitem><para>
Add &ParmFile to the list of keyrings.
If &ParmFile 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:</para>
<para>"gnupg-ring:" is the default one.</para>
</listitem></varlistentry>
<varlistentry>
<term>--homedir &ParmDir;</term>
<listitem><para>
Set the name of the home directory to &ParmDir; If this
option is not used, it defaults to "~/.gnupg". It does
not make sense to use this in an options file. This
also overrides the environment variable "GNUPGHOME".
</para></listitem></varlistentry>
<varlistentry>
<term>--status-fd &ParmN;</term>
<listitem><para>
Write special status strings to the file descriptor &ParmN;.
See the file DETAILS in the documentation for a listing of them.
</para></listitem></varlistentry>
<varlistentry>
<term>--logger-fd &ParmN;</term>
<listitem><para>
Write log output to file descriptor &ParmN; and not to stderr.
</para></listitem></varlistentry>
<varlistentry>
<term>--ignore-time-conflict</term>
<listitem><para>
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 warnings.
</para></listitem></varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>RETURN VALUE</title>
<para>
The program returns 0 if everything was fine, 1 if at least
one signature was bad, and other error codes for fatal errors.
</para>
</refsect1>
<refsect1>
<title>EXAMPLES</title>
<variablelist>
<varlistentry>
<term>gpgv <parameter/pgpfile/</term>
<term>gpgv <parameter/sigfile/ &OptParmFiles;</term>
<listitem><para>
Verify the signature of the file. The second form
is used for detached signatures, where <parameter/sigfile/ is the detached
signature (either ASCII armored or binary) and &OptParmFiles 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
<parameter/sigfile/.
</para></listitem></varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>ENVIRONMENT</title>
<variablelist>
<varlistentry>
<term>HOME</term>
<listitem><para>Used to locate the default home directory.</para></listitem>
</varlistentry>
<varlistentry>
<term>GNUPGHOME</term>
<listitem><para>If set directory used instead of "~/.gnupg".</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>FILES</title>
<variablelist>
<varlistentry>
<term>~/.gnupg/trustedkeys.gpg</term>
<listitem><para>The default keyring with the allowed keys</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<!-- SEE ALSO not yet needed-->
</refentry>

View File

@ -1,114 +0,0 @@
\input texinfo
@setfilename gpgv.info
@dircategory GnuPG
@direntry
* gpgv: (gpgv). GnuPG signature verification tool.
@end direntry
@node Top, , , (dir)
@top gpgv
@chapheading Name
gpgv --- signature verification tool
@chapheading Synopsis
@example
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 able
only
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 trustworthy. There are
no options files and only very few options are implemented.
@code{gpgv} 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:
@table @asis
@item -v, --verbose
Gives more information during processing. If used
twice, the input data is listed in detail.
@item -q, --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
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 an 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 --logger-fd @code{n}
Write log output to file descriptor @code{n} and not to stderr.
@item --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 warnings.
@end table
@chapheading 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.
@chapheading 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}.
@end table
@chapheading ENVIRONMENT
@table @asis
@item HOME
Used to locate the default home directory.
@item GNUPGHOME
If set directory used instead of "~/.gnupg".
@end table
@chapheading FILES
@table @asis
@item ~/.gnupg/trustedkeys.gpg
The default keyring with the allowed keys
@end table
@bye

1325
doc/yat2m.c Normal file

File diff suppressed because it is too large Load Diff