fastq-sample: options to set the rng seed and output the complement of the sample

[fastq-tools.git] / doc / fastq-sample.1

diff --git a/doc/fastq-sample.1 b/doc/fastq-sample.1
index 53434e037bcad92aa479e8cb01dfc3746e589cf2..4ce0cb4e6b87c2d20d7c7c0a2385a9fbafdc3b85 100644 (file)
--- a/doc/fastq-sample.1
+++ b/doc/fastq-sample.1
@@ -4,7 +4,7 @@
 fastq-sample - sample random reads from a fastq file
 
 .SH SYNOPSIS
-.B fastq-sample [OPTION]... [[FILE] [FILE2]]
+.B fastq-sample [OPTION]... FILE [FILE2]
 
 .SH DESCRIPTION
 Given a FASTQ file, random reads are sampled and output, with or without
@@ -33,6 +33,14 @@ being sampled, the output file is [PREFIX].fastq, and with paired-end,
 \fB\-r\fR, \fB\-\-with\-replacement\fR
 Sample with replacement. (By default, sampling is done without replacement.)
 .TP
+\fB\-c\fR, \fB\-\-complement-output=PREFIX\fR
+Output reads not included in the random sample to a file (or files) with the
+given prefix. By default, these reads are not output.
+.TP
+\fB\-s\fR, \fB\-\-seed\fR
+Seed the random number generator. Using the same seed on the same data set will
+produce the same random sample.
+.TP
 \fB\-h\fR, \fB\-\-help\fR
 Output a help message and exit.
 .TP