[med-svn] [graphlan] 04/14: 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 graphlan.

commit 8e2a3e770bb2ff6875de5a075fd3965122d2ca86
Author: Andreas Tille <tille at debian.org>
Date:   Wed Jun 1 08:37:56 2016 +0000

    Add manpage
---
 debian/graphlan.1          | 65 ++++++++++++++++++++++++++++++++++++++++++++++
 debian/graphlan_annotate.1 | 42 ++++++++++++++++++++++++++++++
 debian/manpages            |  1 +
 3 files changed, 108 insertions(+)

diff --git a/debian/graphlan.1 b/debian/graphlan.1
new file mode 100644
index 0000000..d5b94a7
--- /dev/null
+++ b/debian/graphlan.1
@@ -0,0 +1,65 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.4.
+.TH GRAPHLAN "1" "June 2016" "graphlan 1.1" "User Commands"
+.SH NAME
+graphlan \- circular representations of taxonomic and phylogenetic trees
+.SH SYNOPSIS
+.B graphlan
+[\-h] [\-\-format ['output_image_format']] [\-\-warnings WARNINGS]
+[\-\-positions POSITIONS] [\-\-dpi image_dpi] [\-\-size image_size]
+[\-\-pad pad_in] [\-\-external_legends] [\-v]
+input_tree output_image
+.SH DESCRIPTION
+GraPhlAn is a software tool for producing high-quality circular
+representations of taxonomic and phylogenetic trees. It focuses on
+concise, integrative, informative, and publication-ready representations
+of phylogenetically- and taxonomically-driven investigation.
+.SH OPTIONS
+.SS "positional arguments:"
+.TP
+input_tree
+the input tree in PhyloXML format
+.TP
+output_image
+the output image, the format is guessed from the
+extension unless \fB\-\-format\fR is given. Available file
+formats are: png, pdf, ps, eps, svg
+.SS "optional arguments:"
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+show this help message and exit
+.TP
+\fB\-\-format\fR ['output_image_format']
+set the format of the output image (default none
+meaning that the format is guessed from the output
+file extension)
+.TP
+\fB\-\-warnings\fR WARNINGS
+set whether warning messages should be reported or not
+(default 1)
+.TP
+\fB\-\-positions\fR POSITIONS
+set whether the absolute position of the points should
+be reported on the standard output. The two
+cohordinates are r and theta
+.TP
+\fB\-\-dpi\fR image_dpi
+the dpi of the output image for non vectorial formats
+.TP
+\fB\-\-size\fR image_size
+the size of the output image (in inches, default 7.0)
+.TP
+\fB\-\-pad\fR pad_in
+the distance between the most external graphical
+element and the border of the image
+.TP
+\fB\-\-external_legends\fR
+specify whether the two external legends should be put
+in separate file or keep them along with the image
+(default behavior)
+.TP
+\fB\-v\fR, \fB\-\-version\fR
+Prints the current GraPhlAn version and exit
+.SH AUTHOR
+The software was written by Nicola Segata <nsegata at hsph.harvard.edu>
+.P
+This manpage was written by Andreas Tille for the Debian distribution and can be used for any other usage of the program.
diff --git a/debian/graphlan_annotate.1 b/debian/graphlan_annotate.1
new file mode 100644
index 0000000..9660e23
--- /dev/null
+++ b/debian/graphlan_annotate.1
@@ -0,0 +1,42 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.4.
+.TH GRAPHLAN_ANNOTATE "1" "June 2016" "graphlan_annotate 1.1" "User Commands"
+.SH NAME
+graphlan_annotate \- GraPhlAn annotate module
+.SH SYNOPSIS
+.B graphlan_annotate
+[\-h] [\-\-annot annotation_file] [\-v]
+input_tree [output_tree]
+.SH DESCRIPTION
+GraPhlAn is a software tool for producing high-quality circular
+representations of taxonomic and phylogenetic trees. It focuses on
+concise, integrative, informative, and publication-ready representations
+of phylogenetically- and taxonomically-driven investigation.
+.P
+graphlan_annotate is the annotate module of graphlan(1).
+.SH OPTIONS
+.SS "positional arguments:"
+.TP
+input_tree
+the input tree in Newick, Nexus, PhyloXML or plain
+text format
+.TP
+output_tree
+the output tree in PhyloXML format containing the
+newly added annotations. If not specified, the input
+tree file will be overwritten
+.SS "optional arguments:"
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+show this help message and exit
+.TP
+\fB\-\-annot\fR annotation_file
+specify the annotation file
+.TP
+\fB\-v\fR, \fB\-\-version\fR
+Prints the current GraPhlAn version and exit
+.SH SEE ALSO
+graphlan(1)
+.SH AUTHOR
+The software was written by Nicola Segata <nsegata at hsph.harvard.edu>
+.P
+This manpage was written by Andreas Tille for the Debian distribution and can be used for any other usage of the program.
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

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