add manpage to package

Author: sumpfralle

Makefile

@@ -13,6 +13,7 @@ RELEASE_ARCHIVE_FILE = $(RELEASE_DIR)/$(RELEASE_PREFIX)$(VERSION).tar.gz
 RELEASE_SIGNATURE_FILE = $(RELEASE_ARCHIVE_FILE).sig
 UPLOAD_TARGET = $(UPLOAD_USER)@dl.sv.nongnu.org:/releases/bdsync-manager
 PYTHON_BUILD_DIRS = bdsync_manager.egg-info build dist
+MANPAGE = $(DIR_BUILD)/bdsync-manager.1
 
 SETUPTOOLS ?= python3 setup.py
 
@@ -36,6 +37,15 @@ sign: $(RELEASE_SIGNATURE_FILE)
 
 release: $(RELEASE_ARCHIVE_FILE)
 
+build: manpages
+
+.PHONY: manpages
+manpages: $(MANPAGE)
+
+$(MANPAGE): Makefile bdsync-manager.help2man.include
+	help2man --no-info --include bdsync-manager.help2man.include ./bdsync-manager >"$@.new"
+	mv "$@.new" "$@"
+
 upload: sign release
 	@[ -z "$(UPLOAD_USER)" ] && { echo >&2 "ERROR: Missing savannah user name for upload:\n	make upload UPLOAD_USER=foobar"; exit 1; } || true
 	rsync -a "$(RELEASE_ARCHIVE_FILE)" "$(UPLOAD_TARGET)/"

TODO

@@ -2,7 +2,7 @@
 
 * add a man page
 * add tests
-* seaparate "bsync_args" for local and remote execution
+* seaparate "bdsync_args" for local and remote execution
 ** e.g. "--blocksize" is allowed only for the local client
 * synchronize all volumes of an LVM volume group
 * use a template syntax for simplifiying repetitive source/target definitions

bdsync-manager.help2man.include

@@ -0,0 +1,13 @@
+[FILES]
+.TP
+\fB/etc/bdsync-manager.conf\fR
+default location of the configuration file describing one or more tasks to be executed
+
+[AUTHOR]
+Written by Lars Kruse <[email protected]>
+
+[REPORTING BUGS]
+Report bugs via https://savannah.nongnu.org/support/?group=bdsync-manager&func=additem
+
+[SEE ALSO]
+bdsync-manager uses bdsync (https://github.com/TargetHolding/bdsync) for all low-level operations.

bdsync_manager/cmdline.py

@@ -35,13 +35,17 @@
 
 
 def parse_arguments():
-    parser = argparse.ArgumentParser(description="Manage one or more bdsync transfers.")
+    parser = argparse.ArgumentParser(description="Manage one or more blockdevice transfers.")
     parser.add_argument("--log-level", dest="log_level", default="warning",
                         choices=("debug", "info", "warning", "error"), help="Output verbosity")
+    parser.add_argument("--version", action="version",
+                        version="%(prog)s {}".format(bdsync_manager.VERSION))
     parser.add_argument("--config", metavar="CONFIG_FILE", dest="config_file",
                         default="/etc/bdsync-manager.conf", type=argparse.FileType('r'),
                         help="Location of the config file")
-    parser.add_argument("--task", metavar="TASK_NAME", dest="tasks", action="append")
+    parser.add_argument("--task", metavar="TASK_NAME", dest="tasks", action="append",
+                        help="Optionally execute only one of the tasks described in the "
+                             "configuration")
     args = parser.parse_args()
     log_levels = {"debug": logging.DEBUG,
                   "info": logging.INFO,

debian/bdsync-manager.manpages

@@ -0,0 +1 @@
+build/bdsync-manager.1

debian/control

@@ -2,7 +2,8 @@ Source: bdsync-manager
 Section: utils
 Priority: optional
 Maintainer: Lars Kruse <[email protected]>
-Build-Depends: debhelper (>= 9), dh-python, python3-all, python3-setuptools
+Build-Depends: debhelper (>= 9), help2man, dh-python, python3-all,
+ python3-plumbum, python3-setuptools
 Standards-Version: 4.1.1
 Homepage: https://savannah.nongnu.org/projects/bdsync-manager/
 

debian/rules

@@ -4,3 +4,7 @@ export PYBUILD_NAME=bdsync-manager
 
 %:
 	dh $@ --with python3 --buildsystem=pybuild
+
+override_dh_auto_build:
+	$(MAKE) manpages
+	dh_auto_build