[Pkg-gnupg-commit] [gnupg2] 120/205: doc: Install gpg and gpgv man pages under the correct name.
Daniel Kahn Gillmor
dkg at fifthhorseman.net
Wed May 11 08:38:26 UTC 2016
This is an automated email from the git hooks/post-receive script.
dkg pushed a commit to branch experimental
in repository gnupg2.
commit 4dc4fb1c14b3096bb1cdc5923c0d1eb419036805
Author: Werner Koch <wk at gnupg.org>
Date: Tue Apr 5 15:15:28 2016 +0200
doc: Install gpg and gpgv man pages under the correct name.
* doc/mkdefsinc.c (main): Add double include guard. Set variable
gpgtwohack. Define macros gpgname and gpgvname.
* doc/gpg.texi: Remove macro definition for gpgname. Use Texinfo var
gpgtwohack to prepare the man pages. Use @gpgname everywhere.
* doc/gpgv.texi: Likewise.
* doc/Makefile.am (myman_pages): Remove gpg2.1 and gpgv2.1 but add
them depending on USE_GPG2_HACK.
Signed-off-by: Werner Koch <wk at gnupg.org>
---
doc/Makefile.am | 7 ++++++-
doc/gpg.texi | 54 +++++++++++++++++++++++++++++++++++++++++-------------
doc/gpgv.texi | 24 ++++++++----------------
doc/mkdefsinc.c | 27 ++++++++++++++++++++++++++-
4 files changed, 81 insertions(+), 31 deletions(-)
diff --git a/doc/Makefile.am b/doc/Makefile.am
index c270283..bc06cd5 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -78,11 +78,16 @@ YAT2M_OPTIONS = -I $(srcdir) \
myman_sources = gnupg7.texi gpg.texi gpgsm.texi gpg-agent.texi \
dirmngr.texi scdaemon.texi tools.texi
-myman_pages = gpg2.1 gpgsm.1 gpg-agent.1 dirmngr.8 scdaemon.1 gpgv2.1 \
+myman_pages = gpgsm.1 gpg-agent.1 dirmngr.8 scdaemon.1 \
watchgnupg.1 gpgconf.1 addgnupghome.8 gpg-preset-passphrase.1 \
gpg-connect-agent.1 gpgparsemail.1 symcryptrun.1 \
applygnupgdefaults.8 \
dirmngr-client.1
+if USE_GPG2_HACK
+myman_pages += gpg2.1 gpgv2.1
+else
+myman_pages += gpg.1 gpgv.1
+endif
man_MANS = $(myman_pages) gnupg.7
diff --git a/doc/gpg.texi b/doc/gpg.texi
index 89e098d..0e91d8c 100644
--- a/doc/gpg.texi
+++ b/doc/gpg.texi
@@ -11,9 +11,31 @@
@cindex command options
@cindex options, GPG command
- at macro gpgname
-gpg2
- at end macro
+
+ at c Begin standard stuff
+ at ifclear gpgtwohack
+ at manpage gpg.1
+ at ifset manverb
+.B gpg
+\- OpenPGP encryption and signing tool
+ at end ifset
+
+ at mansect synopsis
+ at ifset manverb
+.B gpg
+.RB [ \-\-homedir
+.IR dir ]
+.RB [ \-\-options
+.IR file ]
+.RI [ options ]
+.I command
+.RI [ args ]
+ at end ifset
+ at end ifclear
+ at c End standard stuff
+
+ at c Begin gpg2 hack stuff
+ at ifset gpgtwohack
@manpage gpg2.1
@ifset manverb
.B gpg2
@@ -31,6 +53,8 @@ gpg2
.I command
.RI [ args ]
@end ifset
+ at end ifset
+ at c End gpg2 hack stuff
@mansect description
@@ -40,17 +64,21 @@ OpenPGP standard. @command{@gpgname} features complete key management and
all bells and whistles you can expect from a decent OpenPGP
implementation.
+ at ifclear gpgtwohack
+Note that this version of GnuPG features all modern algorithms and
+should thus be preferred over older GnuPG versions. If you are
+looking for version 1 of GnuPG, you may find that version installed
+under the name @command{gpg1}.
+ at end ifclear
+ at ifset gpgtwohack
In contrast to the standalone command gpg from GnuPG 1.x, which
might be better suited for server and embedded platforms, the 2.x
-version is commonly installed under the name @command{gpg2} and
+version is commonly installed under the name @command{@gpgname} and
targeted to the desktop as it requires several other modules to be
installed.
+ at end ifset
@manpause
-The old 1.x version will be kept maintained and it is possible to
-install both versions on the same system. Documentation for the old
-GnuPG 1.x command is available as a man page and at
- at inforef{Top,GnuPG 1,gpg}.
@xref{Option Index}, for an index to @command{@gpgname}'s commands and options.
@mancont
@@ -1777,7 +1805,7 @@ This is dummy option. @command{@gpgname} always requires the agent.
@item --gpg-agent-info
@opindex gpg-agent-info
-This is dummy option. It has no effect when used with @command{gpg2}.
+This is dummy option. It has no effect when used with @command{@gpgname}.
@item --agent-program @var{file}
@@ -3394,7 +3422,7 @@ for @samp{Subkey-Type}.
@item Key-Length: @var{nbits}
The requested length of the generated key in bits. The default is
-returned by running the command @samp{gpg2 --gpgconf-list}.
+returned by running the command @samp{@gpgname --gpgconf-list}.
@item Key-Grip: @var{hexstring}
This is optional and used to generate a CSR or certificate for an
@@ -3417,7 +3445,7 @@ can be handled. See also @samp{Key-Type} above.
@item Subkey-Length: @var{nbits}
Length of the secondary key (subkey) in bits. The default is returned
-by running the command @samp{gpg2 --gpgconf-list}".
+by running the command @samp{@gpgname --gpgconf-list}".
@item Subkey-Usage: @var{usage-list}
Key usage lists for a subkey; similar to @samp{Key-Usage}.
@@ -3496,9 +3524,9 @@ $ cat >foo <<EOF
%commit
%echo done
EOF
-$ gpg2 --batch --gen-key foo
+$ @gpgname --batch --gen-key foo
[...]
-$ gpg2 --no-default-keyring --secret-keyring ./foo.sec \
+$ @gpgname --no-default-keyring --secret-keyring ./foo.sec \
--keyring ./foo.pub --list-secret-keys
/home/wk/work/gnupg-stable/scratch/foo.sec
------------------------------------------
diff --git a/doc/gpgv.texi b/doc/gpgv.texi
index fcaffbc..214fb99 100644
--- a/doc/gpgv.texi
+++ b/doc/gpgv.texi
@@ -8,11 +8,8 @@
@include defs.inc
- at c Begin GnuPG 1.x specific stuff
- at ifset gpgone
- at macro gpgvname
-gpgv
- at end macro
+ at c Begin standard stuff
+ at ifclear gpgtwohack
@manpage gpgv.1
@node gpgv
@section Verify OpenPGP signatures
@@ -27,14 +24,11 @@ gpgv
.RI [ options ]
.I signed_files
@end ifset
- at end ifset
- at c End GnuPG 1.x specific stuff
+ at end ifclear
+ at c End standard stuff
- at c Begin GnuPG 2 specific stuff
- at ifclear gpgone
- at macro gpgvname
-gpgv2
- at end macro
+ at c Begin gpg2 hack stuff
+ at ifset gpgtwohack
@manpage gpgv2.1
@node gpgv
@section Verify OpenPGP signatures
@@ -49,10 +43,8 @@ gpgv2
.RI [ options ]
.I signed_files
@end ifset
- at end ifclear
- at c End GnuPG 2 specific stuff
-
-
+ at end ifset
+ at c End gpg2 hack stuff
@mansect description
@code{@gpgvname} is an OpenPGP signature verification tool.
diff --git a/doc/mkdefsinc.c b/doc/mkdefsinc.c
index 6495585..f3e2f35 100644
--- a/doc/mkdefsinc.c
+++ b/doc/mkdefsinc.c
@@ -49,6 +49,13 @@
#endif /*HAVE_W32_SYSTEM*/
+#if USE_GPG2_HACK
+# define gpg2_suffix "2"
+#else
+# define gpg2_suffix ""
+#endif
+
+
static int verbose;
@@ -267,7 +274,17 @@ main (int argc, char **argv)
fputs ("@c defs.inc -*- texinfo -*-\n"
"@c Common and build specific constants for the manuals.\n"
- "@c This file has been created by " PGM ".\n", stdout);
+ "@c This file has been created by " PGM ".\n\n", stdout);
+
+ fputs ("@ifclear defsincincluded\n"
+ "@set defsincincluded 1\n\n", stdout);
+
+
+ fputs ("\n at c Flags\n\n", stdout);
+
+#if USE_GPG2_HACK
+ fputs ("@set gpgtwohack 1\n\n", stdout);
+#endif
fputs ("\n at c Directories\n\n", stdout);
@@ -306,8 +323,16 @@ main (int argc, char **argv)
/* Fixme: Use a config.h macro here: */
fputs ("@set GPGSYMENCALGO AES-128\n", stdout);
+ fputs ("\n at c Macros\n\n", stdout);
+
+ printf ("@macro gpgname\n%s%s\n at end macro\n", GPG_NAME, gpg2_suffix);
+ printf ("@macro gpgvname\n%sv%s\n at end macro\n", GPG_NAME, gpg2_suffix);
+
+ /* Trailer. */
fputs ("\n"
+ "@end ifclear\n"
+ "\n"
"@c Loc" "al Variables:\n"
"@c buffer-read-only: t\n"
"@c End:\n", stdout);
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-gnupg/gnupg2.git
More information about the Pkg-gnupg-commit
mailing list