← Back to branch summary

~ubuntu-branches/ubuntu/trusty/cctools/trusty-proposed

« back to all changes in this revision

Viewing changes to doc/man/sand_uncompress_reads.m4

  • Committer: Package Import Robot
  • Author(s): Michael Hanke
  • Date: 2011-10-26 11:51:10 UTC
  • mfrom: (1.1.3)
  • Revision ID: package-import@ubuntu.com-20111026115110-5pc2qxp03chldcdi
Tags: 3.4.0-1
* New upstream release.
* Improve DEP5 compliance of debian/copyright.
* Added patch to make "starch" use python instead of python2 as interpreter.
* Tighten build-dependencies (added swig and m4).
* Enable MPI-support for work-queue.
* Move to dh_python2.
* Split Python-bindings for workqueue into a dedicated package and build
  them for all supported Python versions.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/man/sand_uncompress_reads.m4
 
1
include(manual.h)dnl
 
2
HEADER(sand_uncompress_reads)
 
3
 
 
4
SECTION(NAME)
 
5
BOLD(sand_uncompress_reads) - uncompress sequence data
 
6
 
 
7
SECTION(SYNOPSIS)
 
8
CODE(BOLD(sand_uncompress_reads [-qvh] [infile] [outfile]))
 
9
 
 
10
SECTION(DESCRIPTION)
 
11
 
 
12
BOLD(sand_uncompress_reads) reads sequence data in compressed FASTA format (cfa) used by MANPAGE(sand_filter_master,1) and MANPAGE(sand_align_master,1).
 
13
and produces output in the standard FASTA format.
 
14
PARA
 
15
If the output file is omitted, standard output is used.
 
16
if the input file is omitted, standard input is used.
 
17
After completing the compression, this program will output a summary
 
18
line of sequences and bytes compressed.
 
19
 
 
20
SECTION(OPTIONS)
 
21
 
 
22
OPTIONS_BEGIN
 
23
OPTION_ITEM(-q) Quiet mode: suppress summary line.
 
24
OPTION_ITEM(-h) Display version information.
 
25
OPTION_ITEM(-v) Show help text.
 
26
OPTIONS_END
 
27
 
 
28
SECTION(EXIT STATUS)
 
29
On success, returns zero.  On failure, returns non-zero.
 
30
 
 
31
SECTION(EXAMPLES)
 
32
 
 
33
To uncompress CODE(mydata.cfa) into CODE(mydata.fasta):
 
34
 
 
35
LONGCODE_BEGIN
 
36
% sand_uncompress_reads mydata.cfa mydata.fa
 
37
LONGCODE_END
 
38
 
 
39
SECTION(COPYRIGHT)
 
40
 
 
41
COPYRIGHT_BOILERPLATE
 
42
 
 
43
SECTION(SEE ALSO)
 
44
 
 
45
SEE_ALSO_SAND
 
46
 
 
47
FOOTER