[med-svn] [patman] 05/08: Add manpage

[Andreas Tille]

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

tille pushed a commit to branch master
in repository patman.

commit 6a11a3cd42c971e8342c58cdf9a86fc2d9402727
Author: Andreas Tille <tille at debian.org>
Date:   Wed Dec 13 20:47:43 2017 +0100

    Add manpage
---
 debian/createmanpages | 22 +++++++++++++++++++++
 debian/manpages       |  1 +
 debian/patman.1       | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 76 insertions(+)

diff --git a/debian/createmanpages b/debian/createmanpages
new file mode 100755
index 0000000..d1c3577
--- /dev/null
+++ b/debian/createmanpages
@@ -0,0 +1,22 @@
+#!/bin/sh
+MANDIR=debian
+mkdir -p $MANDIR
+
+VERSION=`dpkg-parsechangelog | awk '/^Version:/ {print $2}' | sed -e 's/^[0-9]*://' -e 's/-.*//' -e 's/[+~]dfsg$//'`
+
+AUTHOR=".SH AUTHOR\nThis manpage was written by $DEBFULLNAME for the Debian distribution and
+can be used for any other usage of the program.
+"
+
+progname=patman
+help2man --no-info --no-discard-stderr  \
+         --name='rapid alignment of short sequences to large databases' \
+            --version-string="$VERSION" ${progname} > $MANDIR/${progname}.1
+echo $AUTHOR >> $MANDIR/${progname}.1
+
+cat <<EOT
+Please enhance the help2man output.
+The following web page might be helpful in doing so:
+    http://liw.fi/manpages/
+EOT
+
diff --git a/debian/manpages b/debian/manpages
new file mode 100644
index 0000000..0f65186
--- /dev/null
+++ b/debian/manpages
@@ -0,0 +1 @@
+debian/*.1
diff --git a/debian/patman.1 b/debian/patman.1
new file mode 100644
index 0000000..d21bbc5
--- /dev/null
+++ b/debian/patman.1
@@ -0,0 +1,53 @@
+.TH PATMAN "1" "December 2017" "patman 1.2.2" "User Commands"
+.SH NAME
+patman \- rapid alignment of short sequences to large databases
+.SH SYNOPSIS
+.B patman
+[\fI\,OPTION\/\fR...] [\fI\,input-file\/\fR...]
+.SH DESCRIPTION
+Patman searches for short patterns in large DNA databases, allowing
+for approximate matches. It is optimized for searching for many small
+pattern at the same time, for example microarray probes.
+.SH OPTIONS
+.TP
+\fB\-V\fR, \fB\-\-version\fR
+Print version number and exit
+.TP
+\fB\-e\fR, \fB\-\-edits\fR=\fI\,N\/\fR
+Set maximum edit distance to N (default: 2)
+.TP
+\fB\-g\fR, \fB\-\-gaps\fR=\fI\,N\/\fR
+Set maximum number of gaps to N (default: 0)
+.TP
+\fB\-D\fR, \fB\-\-databases\fR
+Following files are databases
+.TP
+\fB\-P\fR, \fB\-\-patterns\fR
+Following files contain patterns
+.TP
+\fB\-o\fR, \fB\-\-output\fR=\fI\,FILE\/\fR
+Write output to FILE
+.TP
+\fB\-a\fR, \fB\-\-ambicodes\fR
+Interpret ambiguity codes in patterns
+.TP
+\fB\-s\fR, \fB\-\-singlestrand\fR
+Do not match reverse\-complements
+.TP
+\fB\-p\fR, \fB\-\-prefetch\fR=\fI\,N\/\fR
+Prefetch N nodes (default: 3)
+.TP
+\fB\-q\fR, \fB\-\-quiet\fR
+Turn off warnings
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+Print additional progress reports
+.SS "Help options:"
+.TP
+\-?, \fB\-\-help\fR
+Show this help message
+.TP
+\fB\-\-usage\fR
+Display brief usage message
+.SH AUTHOR
+This manpage was written by Andreas Tille for the Debian distribution and can be used for any other usage of the program.

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