[Python-modules-commits] [txwinrm] 09/09: Add man pages

Christopher Stuart Hoskin mans0954 at moszumanska.debian.org
Sat Feb 25 15:24:45 UTC 2017


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

mans0954 pushed a commit to branch master
in repository txwinrm.

commit 8ac9215c343c9d4f1ae8b911b7021bda9df384a5
Author: Christopher Hoskin <mans0954 at debian.org>
Date:   Sat Feb 25 15:24:28 2017 +0000

    Add man pages
---
 debian/changelog               |  1 +
 debian/h2m/genkrb5conf.h2m     |  2 ++
 debian/h2m/typeperf.h2m        |  2 ++
 debian/h2m/winrm.h2m           |  2 ++
 debian/h2m/winrs.h2m           |  2 ++
 debian/man/genkrb5conf.1       | 20 ++++++++++++++++
 debian/man/typeperf.1          | 52 ++++++++++++++++++++++++++++++++++++++++++
 debian/man/winrm.1             | 43 ++++++++++++++++++++++++++++++++++
 debian/man/winrs.1             | 47 ++++++++++++++++++++++++++++++++++++++
 debian/python-txwinrm.manpages |  1 +
 debian/rules                   | 12 ++++++++++
 11 files changed, 184 insertions(+)

diff --git a/debian/changelog b/debian/changelog
index 3bdec7f..44db2a8 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -2,6 +2,7 @@ txwinrm (1.2.7-1) UNRELEASED; urgency=medium
 
   * New upstream release (1.2.7) 
   * Make DPMT the maintainer, me the uploader 
+  * Add man pages 
 
  -- Christopher Hoskin <mans0954 at debian.org>  Sat, 25 Feb 2017 13:35:40 +0000
 
diff --git a/debian/h2m/genkrb5conf.h2m b/debian/h2m/genkrb5conf.h2m
new file mode 100644
index 0000000..dddff65
--- /dev/null
+++ b/debian/h2m/genkrb5conf.h2m
@@ -0,0 +1,2 @@
+[NAME]
+genkrb5conf \- Generates a krb5.conf file
diff --git a/debian/h2m/typeperf.h2m b/debian/h2m/typeperf.h2m
new file mode 100644
index 0000000..1c9cd11
--- /dev/null
+++ b/debian/h2m/typeperf.h2m
@@ -0,0 +1,2 @@
+[NAME]
+typeperf \- Run a remote typeperf command, check the output periodically, parse it, and print it to stdout
diff --git a/debian/h2m/winrm.h2m b/debian/h2m/winrm.h2m
new file mode 100644
index 0000000..c417ca1
--- /dev/null
+++ b/debian/h2m/winrm.h2m
@@ -0,0 +1,2 @@
+[NAME]
+winrm \- Run WQL queries on remote hosts
diff --git a/debian/h2m/winrs.h2m b/debian/h2m/winrs.h2m
new file mode 100644
index 0000000..c8582a2
--- /dev/null
+++ b/debian/h2m/winrs.h2m
@@ -0,0 +1,2 @@
+[NAME]
+winrs \- Run commands on a remote Microsoft Windows host
diff --git a/debian/man/genkrb5conf.1 b/debian/man/genkrb5conf.1
new file mode 100644
index 0000000..6734fd3
--- /dev/null
+++ b/debian/man/genkrb5conf.1
@@ -0,0 +1,20 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.4.
+.TH GENKRB5CONF "1" "February 2017" "genkrb5conf 1.2.7" "txwinrm"
+.SH NAME
+genkrb5conf \- Generates a krb5.conf file
+.SH DESCRIPTION
+usage: genkrb5conf.py [\-h] [\-\-output OUTPUT] domain domain_controller_ip
+.SS "positional arguments:"
+.TP
+domain
+The name of the Windows domain
+.TP
+domain_controller_ip
+The IP address of the Domain Controller
+.SS "optional arguments:"
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+show this help message and exit
+.TP
+\fB\-\-output\fR OUTPUT, \fB\-o\fR OUTPUT
+Path to the krb5.conf file
diff --git a/debian/man/typeperf.1 b/debian/man/typeperf.1
new file mode 100644
index 0000000..b2069b2
--- /dev/null
+++ b/debian/man/typeperf.1
@@ -0,0 +1,52 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.4.
+.TH TYPEPERF "1" "February 2017" "typeperf 1.2.7" "txwinrm"
+.SH NAME
+typeperf \- Run a remote typeperf command, check the output periodically, parse it, and print it to stdout
+.SH DESCRIPTION
+usage: typeperf.py [\-h] [\-\-debug] [\-\-config CONFIG] [\-\-remote REMOTE]
+.IP
+[\-\-authentication {basic,kerberos}] [\-\-username USERNAME]
+[\-\-dcip DCIP] [\-\-keytab KEYTAB] [\-\-password PASSWORD]
+[\-\-ipaddress IPADDRESS] [\-\-service SERVICE]
+[\-\-includedir INCLUDEDIR] [\-\-si SI] [\-\-sc SC]
+counters [counters ...]
+.SS "positional arguments:"
+.TP
+counters
+performance counter paths to log
+.SS "optional arguments:"
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+show this help message and exit
+.HP
+\fB\-\-debug\fR, \fB\-d\fR
+.HP
+\fB\-\-config\fR CONFIG, \fB\-c\fR CONFIG
+.TP
+\fB\-\-remote\fR REMOTE, \fB\-r\fR REMOTE
+hostname
+.HP
+\fB\-\-authentication\fR {basic,kerberos}, \fB\-a\fR {basic,kerberos}
+.HP
+\fB\-\-username\fR USERNAME, \fB\-u\fR USERNAME
+.TP
+\fB\-\-dcip\fR DCIP, \fB\-i\fR DCIP
+address of kdc
+.HP
+\fB\-\-keytab\fR KEYTAB, \fB\-k\fR KEYTAB
+.HP
+\fB\-\-password\fR PASSWORD, \fB\-p\fR PASSWORD
+.HP
+\fB\-\-ipaddress\fR IPADDRESS, \fB\-s\fR IPADDRESS
+.TP
+\fB\-\-service\fR SERVICE, \fB\-e\fR SERVICE
+http/https/wsman
+.TP
+\fB\-\-includedir\fR INCLUDEDIR
+valid includedir
+.TP
+\fB\-\-si\fR SI
+time between samples in seconds
+.TP
+\fB\-\-sc\fR SC
+number of samples to collect
diff --git a/debian/man/winrm.1 b/debian/man/winrm.1
new file mode 100644
index 0000000..1d00386
--- /dev/null
+++ b/debian/man/winrm.1
@@ -0,0 +1,43 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.4.
+.TH WINRM "1" "February 2017" "winrm 1.2.7" "txwinrm"
+.SH NAME
+winrm \- Run WQL queries on remote hosts
+.SH DESCRIPTION
+usage: winrm.py [\-h] [\-\-debug] [\-\-config CONFIG] [\-\-remote REMOTE]
+.IP
+[\-\-authentication {basic,kerberos}] [\-\-username USERNAME]
+[\-\-dcip DCIP] [\-\-keytab KEYTAB] [\-\-password PASSWORD]
+[\-\-ipaddress IPADDRESS] [\-\-service SERVICE]
+[\-\-includedir INCLUDEDIR] [\-\-filter FILTER]
+.SS "optional arguments:"
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+show this help message and exit
+.HP
+\fB\-\-debug\fR, \fB\-d\fR
+.HP
+\fB\-\-config\fR CONFIG, \fB\-c\fR CONFIG
+.TP
+\fB\-\-remote\fR REMOTE, \fB\-r\fR REMOTE
+hostname
+.HP
+\fB\-\-authentication\fR {basic,kerberos}, \fB\-a\fR {basic,kerberos}
+.HP
+\fB\-\-username\fR USERNAME, \fB\-u\fR USERNAME
+.TP
+\fB\-\-dcip\fR DCIP, \fB\-i\fR DCIP
+address of kdc
+.HP
+\fB\-\-keytab\fR KEYTAB, \fB\-k\fR KEYTAB
+.HP
+\fB\-\-password\fR PASSWORD, \fB\-p\fR PASSWORD
+.HP
+\fB\-\-ipaddress\fR IPADDRESS, \fB\-s\fR IPADDRESS
+.TP
+\fB\-\-service\fR SERVICE, \fB\-e\fR SERVICE
+http/https/wsman
+.TP
+\fB\-\-includedir\fR INCLUDEDIR
+valid includedir
+.HP
+\fB\-\-filter\fR FILTER, \fB\-f\fR FILTER
diff --git a/debian/man/winrs.1 b/debian/man/winrs.1
new file mode 100644
index 0000000..7cccc68
--- /dev/null
+++ b/debian/man/winrs.1
@@ -0,0 +1,47 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.4.
+.TH WINRS "1" "February 2017" "winrs 1.2.7" "txwinrm"
+.SH NAME
+winrs \- Run commands on a remote Microsoft Windows host
+.SH DESCRIPTION
+usage: winrs.py [\-h] [\-\-debug] [\-\-config CONFIG] [\-\-remote REMOTE]
+.IP
+[\-\-authentication {basic,kerberos}] [\-\-username USERNAME]
+[\-\-dcip DCIP] [\-\-keytab KEYTAB] [\-\-password PASSWORD]
+[\-\-ipaddress IPADDRESS] [\-\-service SERVICE]
+[\-\-includedir INCLUDEDIR] [\-\-command COMMAND]
+[{interactive,single,batch,long,multiple}]
+.SS "positional arguments:"
+.IP
+{interactive,single,batch,long,multiple}
+.SS "optional arguments:"
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+show this help message and exit
+.HP
+\fB\-\-debug\fR, \fB\-d\fR
+.HP
+\fB\-\-config\fR CONFIG, \fB\-c\fR CONFIG
+.TP
+\fB\-\-remote\fR REMOTE, \fB\-r\fR REMOTE
+hostname
+.HP
+\fB\-\-authentication\fR {basic,kerberos}, \fB\-a\fR {basic,kerberos}
+.HP
+\fB\-\-username\fR USERNAME, \fB\-u\fR USERNAME
+.TP
+\fB\-\-dcip\fR DCIP, \fB\-i\fR DCIP
+address of kdc
+.HP
+\fB\-\-keytab\fR KEYTAB, \fB\-k\fR KEYTAB
+.HP
+\fB\-\-password\fR PASSWORD, \fB\-p\fR PASSWORD
+.HP
+\fB\-\-ipaddress\fR IPADDRESS, \fB\-s\fR IPADDRESS
+.TP
+\fB\-\-service\fR SERVICE, \fB\-e\fR SERVICE
+http/https/wsman
+.TP
+\fB\-\-includedir\fR INCLUDEDIR
+valid includedir
+.HP
+\fB\-\-command\fR COMMAND, \fB\-x\fR COMMAND
diff --git a/debian/python-txwinrm.manpages b/debian/python-txwinrm.manpages
new file mode 100644
index 0000000..19f429f
--- /dev/null
+++ b/debian/python-txwinrm.manpages
@@ -0,0 +1 @@
+debian/man/*
diff --git a/debian/rules b/debian/rules
index cf09f6b..0f22092 100755
--- a/debian/rules
+++ b/debian/rules
@@ -9,3 +9,15 @@
 override_dh_fixperms:
 	dh_fixperms -O--buildsystem=pybuild
 	chmod 644 debian/python-txwinrm/usr/lib/python2.7/dist-packages/txwinrm/request/*.xml
+
+#Custom target to generate man pages
+VER=1.2.7
+BIN_DIR=build/scripts-2.7/
+MAN_DIR=debian/man/
+
+$(MAN_DIR)%.1 : $(BIN_DIR)%
+	help2man --output=$@ --no-info --manual=txwinrm --include=debian/h2m/$(*F).h2m --version-string=$(VER) $<
+
+.PHONY: man_pages
+man_pages: $(MAN_DIR)genkrb5conf.1 $(MAN_DIR)typeperf.1 $(MAN_DIR)winrm.1 $(MAN_DIR)winrs.1
+

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/txwinrm.git



More information about the Python-modules-commits mailing list