doc/fastq-sort.1

   1 .TH FASTQ-SORT 1
   2
   3 .SH NAME
   4 fastq-sort - sort entries in a fastq file
   5
   6 .SH SYNOPSIS
   7 .B fastq-sort [OPTION]... [FILE]...
   8
   9 .SH DESCRIPTION
  10 Sort a FASTQ file, outputing the sorted file to standard out. If no files are
  11 given, read from standard input.
  12
  13 .SH OPTIONS
  14 .TP
  15 \fB\-r\fR, \fB\-\-reverse\fR
  16 Sort in reverse (i.e., descending) order.
  17 .TP
  18 \fB\-I\fR, \fB\-\-id\fR
  19 Sort alphabetically by read identifier.
  20 .TP
  21 \fB\-S\fR, \fB\-\-seq\fR
  22 Sort alphabetically by nucleotide sequence.
  23 .TP
  24 \fB\-R\fR, \fB\-\-random\fR
  25 Sort in random order. By default, a fixed seed is used so that random sort is
  26 deterministic. Use the '--seed' option to produce different random orderings on
  27 repeated runs.
  28 .TP
  29 \fB\-\-seed=[SEED]\fR
  30 If a decimal integer SEED is given, it is used as the seed when producing a
  31 random ordering. With no argument, a seed is generated using the current system
  32 time.
  33 .TP
  34 \fB\-G\fR, \fB\-\-gc\fR
  35 Sort by increasing GC-content.
  36 .TP
  37 \fB\-M\fR, \fB\-\-mean-qual\fR
  38 Sort by increasing mean quality score.
  39 .TP
  40 \fB\-h\fR, \fB\-\-help\fR
  41 Output a help message and exit.
  42 .TP
  43 \fB\-V\fR, \fB\-\-version\fR
  44 Output version information and exit.
  45
  46 .SH AUTHOR
  47 Written by Daniel C. Jones <dcjones@cs.washington.edu>