[med-svn] r13859 - trunk/packages/mira/trunk/debian

[Andreas Tille]

Author: tille
Date: 2013-06-07 06:48:11 +0000 (Fri, 07 Jun 2013)
New Revision: 13859

Added:
   trunk/packages/mira/trunk/debian/mira.1
Modified:
   trunk/packages/mira/trunk/debian/changelog
Log:
Wrote manpage for main program


Modified: trunk/packages/mira/trunk/debian/changelog
===================================================================
--- trunk/packages/mira/trunk/debian/changelog	2013-06-07 06:34:10 UTC (rev 13858)
+++ trunk/packages/mira/trunk/debian/changelog	2013-06-07 06:48:11 UTC (rev 13859)
@@ -21,6 +21,7 @@
   
   [ Andreas Tille ]
   * delete debian/README.source which is outdated / wrong
+  * debian/mira.1: Wrote manpage for main program
 
  -- Andreas Tille <tille at debian.org>  Fri, 07 Jun 2013 08:34:21 +0200
 

Added: trunk/packages/mira/trunk/debian/mira.1
===================================================================
--- trunk/packages/mira/trunk/debian/mira.1	                        (rev 0)
+++ trunk/packages/mira/trunk/debian/mira.1	2013-06-07 06:48:11 UTC (rev 13859)
@@ -0,0 +1,53 @@
+.TH 3.9.17 "1" "June 2013" "User Commands"
+.SH NAME
+mira \- The Genome and EST Sequence Assembly System
+.SH DESCRIPTION
+The mira genome fragment assembler is a specialised assembler for
+sequencing projects classified as 'hard' due to high number of similar
+repeats. For expressed sequence tags (ESTs) transcripts, miraEST is
+specialised on reconstructing pristine mRNA transcripts while
+detecting and classifying single nucleotide polymorphisms (SNP)
+occuring in different variations thereof.
+.PP
+The assembler is routinely used for such various tasks as mutation
+detection in different cell types, similarity analysis of transcripts
+between organisms, and pristine assembly of sequences from various
+sources for oligo design in clinical microarray experiments.
+.PP
+The purpose of the \fBmira\fR executable is to assemble sequencing data.
+.SH SYNOPSIS
+mira
+[\fIOPTION\fR] manifest_file [\fImanifest_file\fR] ...
+.SH OPTIONS
+.TP
+\fB\-c\fR / \fB\-\-cwd=\fRdirectory
+Change working directory
+.TP
+\fB\-r\fR / \fB\-\-resume\fR
+Resume an interrupted assembly
+.TP
+\fB\-h\fR / \fB\-\-help\fR
+Print short help and exit
+.TP
+\fB\-v\fR / \fB\-\-version\fR
+Print version and exit
+.SH "SEE ALSO"
+A more extensive documentation is provided in the mira-doc package and can be found at
+/usr/share/doc/mira-assembler/DefinitiveGuideToMIRA.html.
+.PP
+You can also subscribe one of the MIRA mailing lists at
+.IP
+http://www.chevreux.org/mira_mailinglists.html
+.PP
+After subscribing, mail general questions to the MIRA talk mailing list:
+.IP
+mira_talk at freelists.org
+.SH BUGS
+To report bugs or ask for features, please use the new ticketing system at:
+.IP
+http://sourceforge.net/apps/trac/mira\-assembler/
+.SH AUTHOR
+The author of the mira code is Bastien Chevreux <bach at chevreux.org>
+.PP
+This manual page was written by Andreas Tille <tille at debian.org> but can be freely used for any other
+distribution.