[med-svn] [quorum] 01/02: Manual edits of help2man-generated manpages. Original output is in branch `manpages`

Andreas Tille tille at debian.org
Wed May 17 14:21:15 UTC 2017


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

tille pushed a commit to branch master
in repository quorum.

commit f0ba36d7d50737ce14ab71232ef45879ddfd1550
Author: Andreas Tille <tille at debian.org>
Date:   Wed May 17 15:59:56 2017 +0200

    Manual edits of help2man-generated manpages.  Original output is in branch `manpages`
---
 debian/mans/merge_mate_pairs.1           | 6 ++++--
 debian/mans/quorum.1                     | 6 +++---
 debian/mans/quorum_create_database.1     | 4 ++--
 debian/mans/quorum_error_correct_reads.1 | 4 ++--
 debian/mans/split_mate_pairs.1           | 3 +--
 5 files changed, 12 insertions(+), 11 deletions(-)

diff --git a/debian/mans/merge_mate_pairs.1 b/debian/mans/merge_mate_pairs.1
index 6dc2556..292e581 100644
--- a/debian/mans/merge_mate_pairs.1
+++ b/debian/mans/merge_mate_pairs.1
@@ -1,12 +1,14 @@
-.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.4.
 .TH MERGE_MATE_PAIRS "1" "May 2017" "merge_mate_pairs 1.1.1" "User Commands"
 .SH NAME
 merge_mate_pairs \- interleave sequences from even and odd files
+.SH SYNOPSIS
+.B merge_mate_pairs
+[options] <even_number_of_files>
 .SH DESCRIPTION
 Merge input files
 .PP
 Take an even number of files and interleave sequences from even and odd files.
-.SS "Options (default value in (), *required):"
+.SH OPTIONS
 .TP
 \fB\-U\fR, \fB\-\-usage\fR
 Usage
diff --git a/debian/mans/quorum.1 b/debian/mans/quorum.1
index 55bc8e7..d875cee 100644
--- a/debian/mans/quorum.1
+++ b/debian/mans/quorum.1
@@ -1,10 +1,10 @@
-.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.4.
 .TH QUORUM "1" "May 2017" "quorum 1.1.1" "User Commands"
 .SH NAME
 quorum \- run quorum error corrector on fastq file
 .SH DESCRIPTION
-\fI\,/usr/bin/quorum\/\fP [options] .fastq [.fastq]+
-.PP
+.B quorum
+[options] <fastq> [fastq]
+.SH DESCRIPTION
 Run the quorum error corrector on the given fastq file. If the \fB\-\-paired\-files\fR
 switch is given, quorum expect an even number of files on the command line,
 each pair files containing pair end reads. The output will be two files
diff --git a/debian/mans/quorum_create_database.1 b/debian/mans/quorum_create_database.1
index 0a747d1..9a3518c 100644
--- a/debian/mans/quorum_create_database.1
+++ b/debian/mans/quorum_create_database.1
@@ -1,4 +1,3 @@
-.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.4.
 .TH QUORUM_CREATE_DATABASE "1" "May 2017" "quorum_create_database 1.1.1" "User Commands"
 .SH NAME
 quorum_create_database \- create database of k-mers for quorum error corrector
@@ -9,7 +8,8 @@ quorum_create_database \- create database of k-mers for quorum error corrector
 Create database of k\-mers for quorum error corrector
 .PP
 Create k\-mer database for quorum_error_correct
-.SS "Options (default value in (), *required):"
+.SH OPTIONS
+default value in (), *required:
 .TP
 \fB\-s\fR, \fB\-\-size\fR=\fI\,uint64\/\fR
 *Initial hash size
diff --git a/debian/mans/quorum_error_correct_reads.1 b/debian/mans/quorum_error_correct_reads.1
index 7b36aa3..0215d8a 100644
--- a/debian/mans/quorum_error_correct_reads.1
+++ b/debian/mans/quorum_error_correct_reads.1
@@ -1,4 +1,3 @@
-.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.4.
 .TH QUORUM_ERROR_CORRECT_READS "1" "May 2017" "quorum_error_correct_reads 1.1.1" "User Commands"
 .SH NAME
 quorum_error_correct_reads \- error correct reads from a fastq file based on the k-mer frequencies
@@ -7,7 +6,8 @@ quorum_error_correct_reads \- error correct reads from a fastq file based on the
 [\fI\,options\/\fR] \fI\,db:path sequence:path+\/\fR
 .SH DESCRIPTION
 Error correct reads from a fastq file based on the k\-mer frequencies.
-.SS "Options (default value in (), *required):"
+.SH OPTIONS
+default value in (), *required:
 .TP
 \fB\-t\fR, \fB\-\-thread\fR=\fI\,uint32\/\fR
 Number of threads (1)
diff --git a/debian/mans/split_mate_pairs.1 b/debian/mans/split_mate_pairs.1
index 9fde399..6abccbf 100644
--- a/debian/mans/split_mate_pairs.1
+++ b/debian/mans/split_mate_pairs.1
@@ -1,4 +1,3 @@
-.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.4.
 .TH SPLIT_MATE_PAIRS "1" "May 2017" "split_mate_pairs 1.1.1" "User Commands"
 .SH NAME
 split_mate_pairs \- split fasta file in two
@@ -6,7 +5,7 @@ split_mate_pairs \- split fasta file in two
 Split fasta file in two
 .PP
 Read fasta file from stdin and write sequence alternatively to two output files
-.SS "Options (default value in (), *required):"
+.SH OPTIONS
 .TP
 \fB\-U\fR, \fB\-\-usage\fR
 Usage

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



More information about the debian-med-commit mailing list