[med-svn] [circlator] 02/03: Add manpage stubs for all executables

[Afif Elghraoui]

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

afif pushed a commit to branch master
in repository circlator.

commit 802300337cbf25ed619920e6434a22c794898822
Author: Afif Elghraoui <afif at ghraoui.name>
Date:   Sun Mar 20 00:07:20 2016 -0700

    Add manpage stubs for all executables
    
    They at least serve as explanations of the purpose of
    the program and as pointers to more detailed information.
---
 debian/man/bio-assembly-refinement.1 | 27 +++++++++++++++++++++++++++
 debian/man/circlator.1               | 19 +++++++++++++++++++
 debian/man/contig_break_finder.1     |  1 +
 debian/man/contig_cleaner.1          |  1 +
 debian/man/contig_overlap_trimmer.1  |  1 +
 debian/man/pacbio_post_process.1     |  1 +
 debian/manpages                      |  1 +
 7 files changed, 51 insertions(+)

diff --git a/debian/man/bio-assembly-refinement.1 b/debian/man/bio-assembly-refinement.1
new file mode 100644
index 0000000..d6fa2df
--- /dev/null
+++ b/debian/man/bio-assembly-refinement.1
@@ -0,0 +1,27 @@
+.TH BIO-ASSEMBLY-REFINEMENT 1 "March 2016"
+.SH NAME
+bio-assembly-refinement \- tools to refine and finish an assembly
+.SH SYNOPSIS
+.B contig_break_finder
+.RI [ options ] " files" ...
+.br
+.B contig_cleaner
+.RI [ options ] " files" ...
+.br
+.B contig_overlap_trimmer
+.RI [ options ] " files" ...
+.br
+.B pacbio_post_process
+.RI [ options ] " files" ...
+.SH DESCRIPTION
+bio_assembly_refinement provides a pipeline to filter, trim, circularize, and re-assemble contigs.
+.SH OPTIONS
+For a complete description of available options, see the help menu.
+.TP
+.B \-h, \-\-help
+Show summary of options.
+.TP
+.B \-v, \-\-version
+Show version of program.
+.SH SEE ALSO
+.BR circlator (1)
diff --git a/debian/man/circlator.1 b/debian/man/circlator.1
new file mode 100644
index 0000000..280de37
--- /dev/null
+++ b/debian/man/circlator.1
@@ -0,0 +1,19 @@
+.TH CIRCLATOR 1 "March 2016"
+.SH NAME
+circlator \- circularize genome assemblies
+.SH SYNOPSIS
+.B circlator
+.I subcommand
+.RI [ options ] " files" ...
+.SH DESCRIPTION
+Circlator is a tool to automate assembly circularization for bacterial
+and small eukaryotic genomes and produce accurate linear
+representations of circular sequences.
+.SH OPTIONS
+For a complete description of options, see the help menus.
+.TP
+.B \-h, \-\-help
+Show summary of options.
+.SH SEE ALSO
+.br
+https://github.com/sanger-pathogens/circlator/wiki
diff --git a/debian/man/contig_break_finder.1 b/debian/man/contig_break_finder.1
new file mode 120000
index 0000000..00f1318
--- /dev/null
+++ b/debian/man/contig_break_finder.1
@@ -0,0 +1 @@
+bio-assembly-refinement.1
\ No newline at end of file
diff --git a/debian/man/contig_cleaner.1 b/debian/man/contig_cleaner.1
new file mode 120000
index 0000000..00f1318
--- /dev/null
+++ b/debian/man/contig_cleaner.1
@@ -0,0 +1 @@
+bio-assembly-refinement.1
\ No newline at end of file
diff --git a/debian/man/contig_overlap_trimmer.1 b/debian/man/contig_overlap_trimmer.1
new file mode 120000
index 0000000..00f1318
--- /dev/null
+++ b/debian/man/contig_overlap_trimmer.1
@@ -0,0 +1 @@
+bio-assembly-refinement.1
\ No newline at end of file
diff --git a/debian/man/pacbio_post_process.1 b/debian/man/pacbio_post_process.1
new file mode 120000
index 0000000..00f1318
--- /dev/null
+++ b/debian/man/pacbio_post_process.1
@@ -0,0 +1 @@
+bio-assembly-refinement.1
\ No newline at end of file
diff --git a/debian/manpages b/debian/manpages
new file mode 100644
index 0000000..13cdaf4
--- /dev/null
+++ b/debian/manpages
@@ -0,0 +1 @@
+debian/man/*.1

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