Commit acfbe7e4 authored by Andreas Tille's avatar Andreas Tille
Browse files

Add manpage

parent 4ff5a14a
Loading
Loading
Loading
Loading

debian/createmanpages

0 → 100755
+22 −0
Original line number Diff line number Diff line
#!/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

0 → 100644
+1 −0
Original line number Diff line number Diff line
debian/*.1

debian/rampler.1

0 → 100644
+49 −0
Original line number Diff line number Diff line
.\" 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.