summaryrefslogtreecommitdiffstats
path: root/doc/zgrep.1
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--doc/zgrep.1120
1 files changed, 98 insertions, 22 deletions
diff --git a/doc/zgrep.1 b/doc/zgrep.1
index fee5e3d..aab13b2 100644
--- a/doc/zgrep.1
+++ b/doc/zgrep.1
@@ -1,39 +1,115 @@
-.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.36.
-.TH ZGREP "1" "December 2009" "Zgrep (zutils) 0.8-rc1" "User Commands"
+.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1.
+.TH ZGREP "1" "November 2010" "Zgrep (zutils) 0.8" "User Commands"
.SH NAME
Zgrep \- search compressed files for a regular expression
.SH SYNOPSIS
.B zgrep
-[\fIOPTIONS\fR] [\fIGREP_OPTIONS\fR] \fIPATTERN \fR[\fIFILES\fR]
+[\fIoptions\fR] \fI<pattern> \fR[\fIfiles\fR]
.SH DESCRIPTION
-Zgrep \- Grep wrapper for compressed files.
-.PP
-Zgrep is a wrapper script around the grep command that allows
-transparent search on any combination of compressed and non\-compressed
-files. If any given file is compressed, its uncompressed content is
-used. If a given file does not exist, zgrep tries the compressed file
-names corresponding to the supported compressors. If no files are
-specified, data is read from standard input, decompressed if needed, and
-fed to grep. Data read from standard input must be of the same type; all
-uncompressed or all compressed with the same compressor.
+Zgrep is a front end to the grep program that allows transparent search
+on any combination of compressed and non\-compressed files. If any given
+file is compressed, its uncompressed content is used. If a given file
+does not exist, and its name does not end with one of the known
+extensions, zgrep tries the compressed file names corresponding to the
+supported compressors. If no files are specified, data is read from
+standard input, decompressed if needed, and fed to grep. Data read from
+standard input must be of the same type; all uncompressed or all
+compressed with the same compressor.
The supported compressors are bzip2, gzip, lzip and xz.
.PP
-Zegrep is a shortcut for "zgrep \fB\-E\fR"
-Zfgrep is a shortcut for "zgrep \fB\-F\fR"
-.PP
-GREP_OPTIONS are passed directly to grep.
-The exit status from grep is preserved.
+Exit status is 0 if match, 1 if no match, 2 if trouble.
.SH OPTIONS
.TP
-\fB\-h\fR, \fB\-\-help\fR
+\fB\-\-help\fR
display this help and exit
.TP
\fB\-V\fR, \fB\-\-version\fR
output version information and exit
+.TP
+\fB\-a\fR, \fB\-\-text\fR
+treat all files as text
+.TP
+\fB\-A\fR, \fB\-\-after\-context=\fR<n>
+print <n> lines of trailing context
+.TP
+\fB\-b\fR, \fB\-\-byte\-offset\fR
+print the byte offset of each line
+.TP
+\fB\-B\fR, \fB\-\-before\-context=\fR<n>
+print <n> lines of leading context
+.TP
+\fB\-c\fR, \fB\-\-count\fR
+only print a count of matching lines per file
+.TP
+\fB\-C\fR, \fB\-\-context=\fR<n>
+print <n> lines of output context
+.TP
+\fB\-e\fR, \fB\-\-regexp=\fR<pattern>
+use <pattern> as the pattern to match
+.TP
+\fB\-E\fR, \fB\-\-extended\-regexp\fR
+<pattern> is an extended regular expression
+.TP
+\fB\-f\fR, \fB\-\-file=\fR<file>
+obtain patterns from <file>
+.TP
+\fB\-F\fR, \fB\-\-fixed\-strings\fR
+<pattern> is a set of newline\-separated strings
+.TP
+\fB\-h\fR, \fB\-\-no\-filename\fR
+suppress the prefixing filename on output
+.TP
+\fB\-H\fR, \fB\-\-with\-filename\fR
+print the filename for each match
+.TP
+\fB\-i\fR, \fB\-\-ignore\-case\fR
+ignore case distinctions
+.TP
+\fB\-I\fR
+ignore binary files
+.TP
+\fB\-l\fR, \fB\-\-files\-with\-matches\fR
+only print names of files containing matches
+.TP
+\fB\-L\fR, \fB\-\-files\-without\-match\fR
+only print names of files containing no matches
+.TP
+\fB\-m\fR, \fB\-\-max\-count=\fR<n>
+stop after <n> matches
+.TP
+\fB\-n\fR, \fB\-\-line\-number\fR
+print the line number of each line
+.TP
+\fB\-o\fR, \fB\-\-only\-matching\fR
+show only the part of a line matching <pattern>
+.TP
+\fB\-q\fR, \fB\-\-quiet\fR
+suppress all messages
+.TP
+\fB\-r\fR, \fB\-\-recursive\fR
+operate recursively on directories
+.TP
+\fB\-s\fR, \fB\-\-no\-messages\fR
+suppress error messages
+.TP
+\fB\-v\fR, \fB\-\-invert\-match\fR
+select non\-matching lines
+.TP
+\fB\-\-verbose\fR
+verbose mode (show error messages)
+.TP
+\fB\-w\fR, \fB\-\-word\-regexp\fR
+match only whole words
+.TP
+\fB\-x\fR, \fB\-\-line\-regexp\fR
+match only whole lines
.SH "REPORTING BUGS"
Report bugs to zutils\-bug@nongnu.org
+.br
Zutils home page: http://www.nongnu.org/zutils/zutils.html
.SH COPYRIGHT
-Copyright \(co 2009 Antonio Diaz Diaz.
-This script is free software: you have unlimited permission
-to copy, distribute and modify it.
+Copyright \(co 2010 Antonio Diaz Diaz.
+License GPLv3+: GNU GPL version 3 or later <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.