[Pkg-gnupg-commit] [gpgme] 403/412: hand-write gpg-tool(1) rather than relying on help2man

[Daniel Kahn Gillmor]

This is an automated email from the git hooks/post-receive script.

dkg pushed a commit to branch master
in repository gpgme.

commit 9c4c0a6a915afa53d93543d98e4884fd819e528c
Author: Daniel Kahn Gillmor <dkg at fifthhorseman.net>
Date:   Thu Sep 22 14:38:32 2016 -0400

    hand-write gpg-tool(1) rather than relying on help2man
---
 debian/clean        |   1 -
 debian/control      |   1 -
 debian/gpgme-tool.1 | 110 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 debian/rules        |  10 -----
 4 files changed, 110 insertions(+), 12 deletions(-)

diff --git a/debian/clean b/debian/clean
index 4764362..ba0ee53 100644
--- a/debian/clean
+++ b/debian/clean
@@ -1,7 +1,6 @@
 tests/gpg/*.gpg
 tests/gpg/S.gpg-agent
 tests/gpgsm/S.gpg-agent
-debian/gpgme-tool.1
 lang/python/tests/support.pyc
 lang/python/tests/__pycache__/
 doc/gpgme.info*
diff --git a/debian/control b/debian/control
index fee8feb..6263c62 100644
--- a/debian/control
+++ b/debian/control
@@ -12,7 +12,6 @@ Build-Depends:
  gnupg-agent,
  gnupg2 | gnupg (>= 2),
  gpgsm,
- help2man,
  libassuan-dev (>> 2.0.2),
  libgpg-error-dev (>> 1.8),
  scdaemon,
diff --git a/debian/gpgme-tool.1 b/debian/gpgme-tool.1
new file mode 100644
index 0000000..26515db
--- /dev/null
+++ b/debian/gpgme-tool.1
@@ -0,0 +1,110 @@
+.TH GPGME\-TOOL "1" "September 2016" "gpgme-tool 1.7.0" "User Commands"
+.SH NAME
+gpgme\-tool \- Assuan server exposing GnuPG Made Easy operations
+
+.SH SYNOPSIS
+.B  gpgme\-tool
+.RB [ \-\-server | \-s ]
+.RB [ \-\-gpgme\-binary =\fIFILE\fR]
+.RB [ \-\-lib\-version ]
+.RB [ \-\-usage ]
+.RB [ \-\-version | \-V ]
+.RB [ \-\-help | \-? ]
+
+.SH DESCRIPTION
+.PP
+\fBgpgme\-tool\fP is a test interface that can exercise the library
+functionality of \fIGPGME\fP. It is not currently intended for
+production use, but it can be a useful way to dynamically understand
+and experiment with the functionality available from the library.
+
+Running this tool in Server mode (the default mode) results in a
+text-based, command-driven session.  When the tool produces (on its
+standard output) a line beginning with
+.BR OK " or " ERR ,
+you can provide it with a command on its standard input.  Try the
+command
+.B HELP
+to see a list of available commands.  Commands are case-insensitive.
+
+Status lines begin with an
+.BR S ,
+and data lines begin with a
+.BR D .
+
+.SH OPTIONS
+.PP
+\fBgpgme\-tool\fP accepts the following options on the command line:
+.TP
+.SH OPTIONS
+.TP
+.BR \-s , \-\-server
+Server mode (default)
+.TP
+.BR \-\-gpg\-binary =FILE
+Use FILE for the GPG backend
+.TP
+.B \-\-lib\-version
+Show library version and terminate
+.TP
+.BR \-V , \-\-version
+Print the currently installed version of \fIGPGME\fP to standard output.
+.TP
+.BR \-? , \-\-help
+Print a list of command\-line options.
+.TP
+.B \-\-usage
+Print a synopsis of \fBgpgme\-tool\fR's command line.
+
+.SH EXAMPLE
+.PP
+Below is an example interaction from a POSIX shell, with user-typed
+lines in \fIitalics\fR, and data returned by \fBgpgme\-tool\fR in
+\fBbold\fR:
+
+.nf
+user at host:~$ \fIgpgme\-tool
+.B OK GPGME\-Tool 1.7.0 ready
+.I strerror 20
+.B D Unknown compression algorithm <Unspecified source>
+.B OK
+.I version
+.B D 1.7.0
+.B OK
+.I armor
+.B S ARMOR false
+.B OK
+.I armor true
+.B OK
+.I armor
+.B S ARMOR true
+.B OK
+.I bye
+.B OK closing connection
+user at host:~$
+.ad
+
+.SH AUTHORS
+.PP
+The
+.I GPGME
+library is written by many contributors, including Werner Koch, Marcus
+Brinkmann, Andre Heinecke, Justus Winter, and Karl-Heinz Zimmer.
+.PP
+This manual page page was written by Daniel Kahn Gillmor for the
+Debian distribution (but may be used by others).
+
+.SH BUGS
+.PP
+Please report bugs to <https://bugs.gnupg.org>.
+
+.SH COPYRIGHT
+\fBgpgme\-tool\fP is Copyright \(co 2015-2016 g10 Code GmbH License
+GPLv2+: GNU GPL version 2 or later <https://www.gnu.org/licenses/>
+.PP
+This is free software: you are free to change and redistribute it.
+There is NO WARRANTY, to the extent permitted by law.
+
+.SH "SEE ALSO"
+.BR gpgme\-config (1),
+.B /usr/include/gpgme.h
diff --git a/debian/rules b/debian/rules
index 7aff2cb..1080482 100755
--- a/debian/rules
+++ b/debian/rules
@@ -1,11 +1,5 @@
 #!/usr/bin/make -f
 
-#export DH_VERBOSE=1
-
-export CPPFLAGS := $(shell dpkg-buildflags --get CPPFLAGS)
-export CFLAGS   := $(shell dpkg-buildflags --get CFLAGS)
-export LDFLAGS  := $(shell dpkg-buildflags --get LDFLAGS)
-
 %:
 	dh $@ --with autoreconf --parallel
 
@@ -18,9 +12,5 @@ override_dh_auto_configure:
 override_dh_install:
 	dh_install --list-missing -X.la -Xinfo/dir
 
-override_dh_installdocs:
-	help2man -o debian/gpgme-tool.1 -n 'Assuan server exposing GnuPG Made Easy operations' src/gpgme-tool
-	dh_installdocs -A
-
 override_dh_makeshlibs:
 	dh_makeshlibs -V

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-gnupg/gpgme.git