[med-svn] [Git][med-team/rampler][master] Add manpage

[Andreas Tille]

Andreas Tille pushed to branch master at Debian Med / rampler


Commits:
acfbe7e4 by Andreas Tille at 2018-06-09T20:12:27+02:00
Add manpage

- - - - -


3 changed files:

- + debian/createmanpages
- + debian/manpages
- + debian/rampler.1


Changes:

=====================================
debian/createmanpages
=====================================
--- /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=rampler
+help2man --no-info --no-discard-stderr --help-option=" --help" \
+         --name='module for sampling genomic sequences' \
+            --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
+


=====================================
debian/manpages
=====================================
--- /dev/null
+++ b/debian/manpages
@@ -0,0 +1 @@
+debian/*.1


=====================================
debian/rampler.1
=====================================
--- /dev/null
+++ b/debian/rampler.1
@@ -0,0 +1,49 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.6.
+.TH RAMPLER "1" "June 2018" "rampler 1.1.0" "User Commands"
+.SH NAME
+rampler \- module for sampling genomic sequences
+.SH DESCRIPTION
+usage: rampler [options ...] <mode>
+.SS <mode>
+.SS subsample <sequences> <reference length> <coverage> [<coverage> ...]
+.HP
+<sequences>
+.IP
+input file in FASTA/FASTQ format (can be compressed with gzip)
+containing sequences to be subsampled
+.HP
+<reference length>
+.IP
+integer denoting length of the reference genome (or
+assembly) from which the sequences originate
+.HP
+<coverage>
+.IP
+integer denoting desired coverage of the subsampled
+sequences
+.SS split <sequences> <chunk size>
+.HP
+<sequences>
+.IP
+input file in FASTA/FASTQ format (can be compressed with gzip)
+containing sequences which will be split into smaller chunks
+.HP
+<chunk size>
+.IP
+integer denoting the desired chunk size in bytes
+.SH OPTIONS
+.HP
+\fB\-o\fR, \fB\-\-out\-directory\fR
+.IP
+default: current directory
+path in which sampled files will be created
+.HP
+\fB\-\-version\fR
+.IP
+prints the version number
+.HP
+\fB\-h\fR, \fB\-\-help\fR
+.IP
+prints the usage
+.SH AUTHOR
+This manpage was written by Andreas Tille for the Debian distribution and can be used for any other usage of the program.



View it on GitLab: https://salsa.debian.org/med-team/rampler/commit/acfbe7e41e1674e998242c97f7c33202fafb71de

-- 
View it on GitLab: https://salsa.debian.org/med-team/rampler/commit/acfbe7e41e1674e998242c97f7c33202fafb71de
You're receiving this email because of your account on salsa.debian.org.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://alioth-lists.debian.net/pipermail/debian-med-commit/attachments/20180609/a8cfeb22/attachment-0001.html>