diff options
Diffstat (limited to 'doc/agrep.1')
| -rw-r--r-- | doc/agrep.1 | 183 |
1 files changed, 183 insertions, 0 deletions
diff --git a/doc/agrep.1 b/doc/agrep.1 new file mode 100644 index 0000000000000..af13a3361cf3f --- /dev/null +++ b/doc/agrep.1 @@ -0,0 +1,183 @@ +.TH agrep 1 "November 21, 2004" "TRE agrep 0.8.0" +.SH NAME +agrep \- print lines approximately matching a pattern +.SH SYNOPSIS +.B agrep +.RI [ OPTION ]... +.I PATTERN +.RI [ FILE ]... +.SH DESCRIPTION +Searches for approximate matches of PATTERN in each FILE or standard +input. Example: `agrep \-2 optimize foo.txt' outputs all lines in +file `foo.txt' that match "optimize" within two errors. E.g. lines +which contain "optimise", "optmise", and "opitmize" all match. +.SH OPTIONS +.SS "Regexp selection and interpretation:" +.TP +.BI \-e " PATTERN" "\fR,\fP \-\^\-regexp=" PATTERN +Use +.I PATTERN +as a regular expression; useful to protect patterns beginning with +.BR \- . +.TP +.BR \-i ", " \-\^\-ignore\-case +Ignore case distinctions (as defined by the current locale) in +.I PATTERN +and input files. +.TP +.BR \-k ", " \-\^\-literal +Treat +.I PATTERN +as a literal string, that is, a fixed string with no special +characters. +.TP +.BR \-w ", " \-\^\-word\-regexp +Force +.I PATTERN +to match only whole words. A "whole word" is a substring which either +starts at the beginning or the record or is preceded by a non-word +constituent character. Similarly, the substring must either end at +the end of the record or be followed by a non-word constituent +character. Word-constituent characters are alphanumerics (as +defined by the current locale) and the underscore character. Note +that the non-word constituent characters +.B must +surround the match; they cannot be counted as errors. +.SS "Approximate matching settings:" +.TP +.BI \-D " NUM" "\fR,\fP \-\^\-delete\-cost=" NUM +Set cost of missing characters to +.IR NUM . +.TP +.BI \-I " NUM" "\fR,\fP \-\^\-insert\-cost=" NUM +Set cost of extra characters to +.IR NUM . +.TP +.BI \-S " NUM" "\fR,\fP \-\^\-substitute\-cost=" NUM +Set cost of incorrect characters to +.IR NUM . +Note that a deletion (a missing character) and an insertion (an extra +character) together constitute a substituted character, but the cost +will be the that of a deletion and an insertion added together. Thus, +if the const of a substitution is set to be larger than the sum +of the costs of deletion and insertion, direct substitutions will +never be done. +.TP +.BI \-E " NUM" "\fR,\fP \-\^\-max\-errors=" NUM +Select records that have at most +.I NUM +errors. +.TP +-\fI#\fR +Select records that have at most \fI#\fR errors (\fI#\fR is a +digit between 0 and 9). +.SS "Miscellaneous:" +.TP +.BI \-d " PATTERN" "\fR,\fP \-\^\-delimiter=" PATTERN +Set the record delimiter regular expression to +.IR PATTERN . +The text between two delimiters, before the first delimiter, and after +the last delimiter is considered to be a record. The default record +delimiter is the regexp "\\n", so by default a record is a line. +.I PATTERN +can be any regular expression that does not match the empty string. +For example, using +.B \-d +"^From " +defines mail messages as records in a Mailbox format file. +.TP +.BR \-v ", " \-\^\-invert\-match +Select non-matching records instead of matching records. +.TP +.BR \-V ", " \-\^\-version +Print version information and exit. +.TP +.BR \-y ", " \-\^\-nothing +Does nothing. This options exists only for compatibility with the +non-free agrep program. +.TP +.BR \-\^\-help +Display a brief help message and exit. +.SS "Output control:" +.TP +.BR \-B ", " \-\^\-best\-match +Only output the best matching records, that is, the records with the +lowest cost. This is currently implemented by making two passes over +the input files and cannot be used when reading from standard input. +.TP +.BR \-\^\-color ", " \-\^\-colour +Highlight the matching strings in the output with a color marker. The +color string is taken from the +.BI GREP_COLOR +environment variable. The default color is red. +.TP +.BR \-c ", " \-\^\-count +Only print a count of matching records per each input file, +suppressing normal output. +.TP +.BR \-h ", " \-\^\-no\-filename +Suppress the prefixing filename on output when multiple files are +searched. +.TP +.BR \-H ", " \-\^\-with\-filename +Prefix each output record with the name of the input file where the +record was read from. +.TP +.BR \-l ", " \-\^\-files\-with\-matches +Only print the name of each input file which contains at least one +match, suppressing normal output. The scanning for each file will +stop on the first match. +.TP +.BR \-n ", " \-\^\-record\-number +Prefix each output record with its sequence number in the input file. +The number of the first record is 1. +.TP +.BR \-q ", " \-\^\-quiet ", " \-\^\-silent +Do not write anything to standard output. Exit immediately with zero +exit status if a match is found. +.TP +.BR \-s ", " \-\^\-show\-cost +Print match cost with output. +.TP +.BR \-\^\-show\-position +Prefix each output record with the start and end offset of the first +match within the record. The offset of the first character of the +record is 0. The end position is given as the offset of the first +character after the match. +.TP +.BR \-M ", " \-\^\-delimiter\-after +By default, the record delimiter is the newline character and is +output after the matching record. If +.B \-d +is used, the record delimiter will be output before the matching +record. This option causes the delimiter to be output after the +matching record. +.PP +With no +.IR FILE , +or when +.I FILE +is -, reads standard input. If less than two +.IR FILE s +are given +.B \-h +is assumed, otherwise +.B \-H +is the default. +.SH DIAGNOSTICS +Exit status is 0 if a match is found, 1 for no match, and 2 if there +were errors. If +.B \-E +or -\fI#\fR is not specified, only exact matches are selected. +.PP +.I PATTERN +is a POSIX extended regular expression (ERE) with the TRE extensions. +.SH "REPORTING BUGS" +Report bugs to the TRE mailing list +.BR "" < tre-general@lists.laurikari.net >. +.SH COPYRIGHT +Copyright \(co 2002-2004 Ville Laurikari. +.br +This is free software, and comes with ABSOLUTELY NO WARRANTY. +You are welcome to redistribute this software under certain +conditions; see the source for the full license text. |