.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.3.
.TH HFST-GREP "1" "August 2018" "HFST" "User Commands"
.SH NAME
hfst-grep \- =Search for PATTERN in each FILE or standard input.
.SH SYNOPSIS
.B hfst-grep
[\fI\,OPTIONS\/\fR...] \fI\,PATTERN \/\fR[\fI\,FILE\/\fR...]
.SH DESCRIPTION
Search for PATTERN in each FILE or standard input.
Pattern is, by default, a Xerox regular expression (XRE).
Example: hfst\-grep 'h e l l o %  w o r l d' menu.h menu.c
.SS "Common options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
Print help message
.TP
\fB\-V\fR, \fB\-\-version\fR
Print version info
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Print verbosely while processing
.TP
\fB\-q\fR, \fB\-\-quiet\fR
Only print fatal erros and requested output
.TP
\fB\-s\fR, \fB\-\-silent\fR
Alias of \fB\-\-quiet\fR
.TP
\fB\-9\fR, \fB\-\-format\fR=\fI\,TYPE\/\fR
compile expressions to TYPE automata
.SS "Regexp selection and interpretation:"
.TP
\fB\-E\fR, \fB\-\-extended\-regexp\fR
PATTERN is an extended regular expression (ERE)
.TP
\fB\-F\fR, \fB\-\-fixed\-strings\fR
PATTERN is a set of newline\-separated fixed strings
.TP
\fB\-G\fR, \fB\-\-basic\-regexp\fR
PATTERN is a basic regular expression (BRE)
.TP
\fB\-P\fR, \fB\-\-perl\-regexp\fR
PATTERN is a Perl regular expression
.TP
\fB\-X\fR, \fB\-\-xerox\-regexp\fR
PATTERN is a Xerox regulare expression
.TP
\fB\-e\fR, \fB\-\-regexp\fR=\fI\,PATTERN\/\fR
use PATTERN for matching
.TP
\fB\-f\fR, \fB\-\-file\fR=\fI\,FILE\/\fR
obtain PATTERN from FILE
.TP
\fB\-I\fR, \fB\-\-ignore\-case\fR
ignore case distinctions
.TP
\fB\-w\fR, \fB\-\-word\-regexp\fR
force PATTERN to match only whole words
.TP
\fB\-x\fR, \fB\-\-line\-regexp\fR
force PATTERN to match only whole lines
.TP
\fB\-z\fR, \fB\-\-null\-data\fR
a data line ends in 0 byte, not newline
.SS "Miscellaneous options:"
.TP
\fB\-\-no\-messages\fR
suppress error messages
.TP
\fB\-\-invert\-match\fR
select non\-matching lines
.SS "Output control:"
.TP
\fB\-m\fR, \fB\-\-max\-count\fR=\fI\,NUM\/\fR
stop after NUM matches\en  \fB\-b\fR, \fB\-\-byte\-offset\fR         print the byte offset with output lines
.TP
\fB\-n\fR, \fB\-\-line\-number\fR
print line number with output lines
.TP
\fB\-\-line\-buffered\fR
flush output on every line
.TP
\fB\-H\fR, \fB\-\-with\-filename\fR
print the filename for each match
.TP
\fB\-h\fR, \fB\-\-no\-filename\fR
suppress the prefixing filename on output
.TP
\fB\-\-label\fR=\fI\,LABEL\/\fR
print LABEL as filename for standard input
.TP
\fB\-o\fR, \fB\-\-only\-matching\fR
show only the part of a line matching PATTERN
.TP
\fB\-\-binary\-files\fR=\fI\,TYPE\/\fR
assume that binary files are TYPE;
TYPE is `binary', `text', or `without\-match'
.TP
\fB\-a\fR, \fB\-\-text\fR
equivalent to \fB\-\-binary\-files\fR=\fI\,text\/\fR
.TP
\fB\-d\fR, \fB\-\-directories\fR=\fI\,ACTION\/\fR
how to handle directories;
ACTION is `read', `recurse', or `skip'
.TP
\fB\-D\fR, \fB\-\-devices\fR=\fI\,ACTION\/\fR
how to handle devices, FIFOs and sockets;
ACTION is `read' or `skip'
.TP
\fB\-R\fR, \fB\-r\fR, \fB\-\-recursive\fR
equivalent to \fB\-\-directories\fR=\fI\,recurse\/\fR
.TP
\fB\-\-include\fR=\fI\,FILE_PATTERN\/\fR
search only files that match FILE_PATTERN
.TP
\fB\-\-exclude\fR=\fI\,FILE_PATTERN\/\fR
skip files and directories matching FILE_PATTERN
.TP
\fB\-\-exclude\-from\fR=\fI\,FILE\/\fR
skip files matching any file pattern from FILE
.TP
\fB\-\-exclude\-dir\fR=\fI\,PATTERN\/\fR
directories that match PATTERN will be skipped
.TP
\fB\-L\fR, \fB\-\-files\-without\-match\fR
print only names of FILEs containing  no match
.TP
\fB\-l\fR, \fB\-\-files\-with\-matches\fR
print only names of FILEs containing matches
.TP
\fB\-c\fR, \fB\-\-count\fR
print only a count of matching lines per FILE
.TP
\fB\-T\fR, \fB\-\-initial\-tab\fR
make tabs line up (if needed)
.TP
\fB\-Z\fR, \fB\-\-null\fR
print 0 byte after FILE name
.SS "Context control:"
.TP
\fB\-B\fR, \fB\-\-before\-context\fR=\fI\,NUM\/\fR
print NUM lines of leading context
.TP
\fB\-A\fR, \fB\-\-after\-context\fR=\fI\,NUM\/\fR
print NUM lines of trailing context
.TP
\fB\-C\fR, \fB\-\-context\fR=\fI\,NUM\/\fR
print NUM lines of output context
.HP
\fB\-\-color\fR[=\fI\,WHEN\/\fR],
.TP
\fB\-\-colour\fR[=\fI\,WHEN\/\fR]
use markers to highlight the matching strings;
WHEN is `always', `never', or `auto'
.TP
\fB\-U\fR, \fB\-\-binary\fR
do not strip CR characters at EOL (MSDOS)
.TP
\fB\-u\fR, \fB\-\-unix\-byte\-offsets\fR
report offsets as if CRs were not there (MSDOS)
.SH "REPORTING BUGS"
Report bugs to <hfst\-bugs@helsinki.fi> or directly to our bug tracker at:
<https://github.com/hfst/hfst/issues>
hfst\-grep home page:
<https://kitwiki.csc.fi/twiki/bin/view/KitWiki//HfstGrep>
.br
General help using HFST software:
<https://kitwiki.csc.fi/twiki/bin/view/KitWiki//HfstHome>
.SH COPYRIGHT
Copyright \(co 2017 University of Helsinki,
License GPLv3: GNU GPL version 3 <http://gnu.org/licenses/gpl.html>
.br
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.