[med-svn] [khmer] 01/02: New manpage added for the khmer wrapper script

[Timothy Booth]

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

tbooth-guest pushed a commit to branch master
in repository khmer.

commit 43335e39d46a4c833f204ecf64919d2265db5d69
Author: Tim Booth <tbooth at ceh.ac.uk>
Date:   Sat Jan 31 14:30:59 2015 +0000

    New manpage added for the khmer wrapper script
---
 debian/control        |  3 ++-
 debian/khmer.1.ronn   | 33 +++++++++++++++++++++++++++++++++
 debian/khmer.manpages |  1 +
 debian/rules          |  2 ++
 4 files changed, 38 insertions(+), 1 deletion(-)

diff --git a/debian/control b/debian/control
index f708b33..546f4fd 100644
--- a/debian/control
+++ b/debian/control
@@ -13,7 +13,8 @@ Build-Depends: python-screed,
                python-setuptools (>= 3.3),
                zlib1g-dev,
                libbz2-dev,
-               python-nose
+               python-nose,
+               ruby-ronn
 Standards-Version: 3.9.5
 Vcs-Browser: http://anonscm.debian.org/gitweb/?p=debian-med/khmer.git
 Vcs-Git: git://anonscm.debian.org/debian-med/khmer.git
diff --git a/debian/khmer.1.ronn b/debian/khmer.1.ronn
new file mode 100644
index 0000000..18c282f
--- /dev/null
+++ b/debian/khmer.1.ronn
@@ -0,0 +1,33 @@
+khmer(1) -- k-mer counting, filtering and graph traversal FTW!
+==========
+
+khmer is a library and toolkit for doing k-mer-based dataset analysis
+and transformations
+
+## SYNOPSIS
+
+ khmer `<prog_name>` [options] <args>
+
+eg.
+
+ khmer `load-into-counting` -x 1e8 -k 20 reads.kh reads.fa.gz
+
+## USAGE
+
+This manpage only describes the `khmer` wrapper script.  To find out about
+the software and how to use it please see /usr/share/doc/khmer or else
+http://khmer.readthedocs.org/.
+
+On Debian/Ubuntu, package maintainers avoid putting large collections of scripts
+directly into the system PATH.  Rather, a single wrapper script is used to launch
+the script you want to use; therefore if the khmer instructions say to run
+`load-into-counting.py ...whatever...` you need to prefix this command with
+`khmer`.  Furthermore, the .py extension may be omitted, resulting in a
+command of the format shown above.
+
+If you don't like this, simply add /usr/lib/khmer/bin to your personal PATH.
+
+## AUTHOR
+
+This wrapper and manapage were written by Tim Booth, who takes no credit for
+khmer itself.
diff --git a/debian/khmer.manpages b/debian/khmer.manpages
new file mode 100644
index 0000000..0f65186
--- /dev/null
+++ b/debian/khmer.manpages
@@ -0,0 +1 @@
+debian/*.1
diff --git a/debian/rules b/debian/rules
index a9ccca8..29811f1 100755
--- a/debian/rules
+++ b/debian/rules
@@ -11,7 +11,9 @@ override_dh_auto_build:
 	dh_auto_build
 	ln -s "`pwd`"/.pybuild/pythonX.Y_*/build/khmer/*.so khmer && \
 		./setup.py build_sphinx
+	ronn -r --manual=khmer --organization='Michigan State University' debian/khmer.1.ronn
 
 override_dh_auto_clean:
 	dh_auto_clean
 	rm -f khmer/*.so
+	rm -f *.1

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-med/khmer.git