aboutsummaryrefslogtreecommitdiff
path: root/src/scripts/xzgrep.1
diff options
context:
space:
mode:
authorLasse Collin <lasse.collin@tukaani.org>2009-07-05 22:25:17 +0300
committerLasse Collin <lasse.collin@tukaani.org>2009-07-05 22:25:17 +0300
commit96e4b257e101d72072d43e144897d92920270669 (patch)
tree5f1852c0c90b41b66dd0b24ba8719b68cea5d048 /src/scripts/xzgrep.1
parentUse @PACKAGE_HOMEPAGE@ in liblzma.pc.in. (diff)
downloadxz-96e4b257e101d72072d43e144897d92920270669.tar.xz
Major update to the xzgrep and other scripts based on
the latest versions found from gzip CVS repository. configure will try to find a POSIX shell to be used by the scripts. This should ease portability on systems which have pre-POSIX /bin/sh. xzgrep and xzdiff support .xz, .lzma, .gz, and .bz2 files. xzmore and xzless support only .xz and .lzma files. The name of the xz executable used in these scripts is now correct even if --program-transform-name has been used.
Diffstat (limited to 'src/scripts/xzgrep.1')
-rw-r--r--src/scripts/xzgrep.185
1 files changed, 51 insertions, 34 deletions
diff --git a/src/scripts/xzgrep.1 b/src/scripts/xzgrep.1
index d8647f2a..996d64ae 100644
--- a/src/scripts/xzgrep.1
+++ b/src/scripts/xzgrep.1
@@ -1,13 +1,20 @@
-.\" Original file was take from gzip, thus this man page is under GNU GPLv2+.
-.TH XZGREP 1 "2009-04-13" "XZ Utils"
+.\"
+.\" Original zgrep.1 for gzip: Jean-loup Gailly
+.\" Charles Levert <charles@comm.polymtl.ca>
+.\"
+.\" Modifications for XZ Utils: Lasse Collin
+.\"
+.\" License: GNU GPLv2+
+.\"
+.TH XZGREP 1 "2009-07-05" "Tukaani" "XZ Utils"
.SH NAME
-xzgrep \- search .xz and .lzma compressed files for a regular expression
+xzgrep \- search compressed files for a regular expression
.SH SYNOPSIS
.B xzgrep
.RI [ grep_options ]
.RB [ \-e ]
.I pattern
-.IR filename ".\|.\|."
+.IR file ".\|.\|."
.br
.B xzegrep
.RB ...
@@ -25,14 +32,28 @@ xzgrep \- search .xz and .lzma compressed files for a regular expression
.RB ...
.SH DESCRIPTION
.B xzgrep
-is used to invoke the
+invokes
.BR grep (1)
-on .xz or .lzma compressed files. All options specified are passed directly to
-.BR grep .
-If no file is specified, then the standard input is decompressed
-if necessary and fed to grep.
-Otherwise the given files are uncompressed if necessary and fed to
-.BR grep .
+on
+.I files
+which may be either uncompressed or compressed with
+.BR xz (1),
+.BR lzma (1),
+.BR gzip (1),
+or
+.BR bzip2 (1).
+All options specified are passed directly to
+.BR grep (1).
+.PP
+If no
+.I file
+is specified, then the standard input is decompressed if necessary and fed to
+.BR grep (1).
+When reading from standard input,
+.BR gzip (1)
+and
+.BR bzip2 (1)
+compressed files are not supported.
.PP
If
.B xzgrep
@@ -41,37 +62,33 @@ is invoked as
or
.B xzfgrep
then
-.B egrep
+.BR egrep (1)
or
-.B fgrep
+.BR fgrep (1)
is used instead of
-.B grep.
+.BR grep (1).
The same applies to names
.BR lzgrep ,
.BR lzegrep ,
and
.BR lzfgrep ,
which are provided for backward compatibility with LZMA Utils.
-
-If the GREP environment variable is set,
-.B xzgrep
-uses it as the
-.B grep
-program to be invoked. For example:
-
- for sh: GREP=fgrep xzgrep string files
- for csh: (setenv GREP fgrep; xzgrep string files)
-.SH AUTHORS
-Original
-.BR zgrep (1)
-manual page by Charles Levert <charles@comm.polymtl.ca>.
.PP
-Minor modifications for XZ Utils by Lasse Collin
-<lasse.collin@tukaani.org>.
-.SH "SEE ALSO"
+.SH ENVIRONMENT
+.TP
+.B GREP
+If the
+.B GREP
+environment variable is set,
+.B xzgrep
+uses it instead of
.BR grep (1),
.BR egrep (1),
-.BR fgrep (1),
-.BR xzdiff (1),
-.BR xzmore (1),
-.BR xz (1)
+or
+.BR fgrep (1).
+.SH "SEE ALSO"
+.BR grep (1),
+.BR xz (1),
+.BR gzip (1),
+.BR bzip2 (1),
+.BR zgrep (1)