]> git.donarmstrong.com Git - fastq-tools.git/blob - doc/fastq-grep.1
Much simpler faster code for parsing fastq files.
[fastq-tools.git] / doc / fastq-grep.1
1 .TH FASTQ-GREP 1
2
3 .SH NAME
4 fastq-grep - print sequences matching a pattern
5
6 .SH SYNOPSIS
7 .B fastq-grep [OPTION]... PATTERN [FILE]...
8
9 .SH DESCRIPTION
10 Given a PATTERN, specified as a perl-compatible regular expression, print every
11 FASTQ entry with a matching nucleotide sequence.
12
13 One ore more FILEs may be specified, otherwise input is read from standard input.
14 Input files may be gziped.
15
16 .SH OPTIONS
17 .TP 
18 \fB\-i\fR, \fB\-\-id\fR
19 Match the read ID (by default, the sequence is matched).
20 .TP
21 \fB\-v\fR, \fB\-\-invert\-match\fR
22 Invert the sense of matching, to select non-matching entries.
23 .TP
24 \fB\-m\fR, \fB\-\-mismatches=FILE\fR
25 Output non-matching entries to the given file.
26 .TP
27 \fB\-c\fR, \fB\-\-count\fR
28 Suppress normal output; instead output the number of matching (or, non-matching,
29 with '-v') entries.
30 .TP
31 \fB\-h\fR, \fB\-\-help\fR
32 Output a help message and exit.
33 .TP
34 \fB\-V\fR, \fB\-\-version\fR
35 Output version information and exit.
36
37 .SH AUTHOR
38 Written by Daniel C. Jones <dcjones@cs.washington.edu>
39