debian: Prepare for upload
[xz/debian.git] / src / scripts / xzgrep.1
blob4bddbe2d4e701c9853031d91c8967405e32e0a6c
1 .\"
2 .\" Original zgrep.1 for gzip: Jean-loup Gailly
3 .\"                            Charles Levert <charles@comm.polymtl.ca>
4 .\"
5 .\" Modifications for XZ Utils: Lasse Collin
6 .\"
7 .\" License: GNU GPLv2+
8 .\"
9 .TH XZGREP 1 "2011-03-19" "Tukaani" "XZ Utils"
10 .SH NAME
11 xzgrep \- search compressed files for a regular expression
12 .SH SYNOPSIS
13 .B xzgrep
14 .RI [ grep_options ]
15 .RB [ \-e ]
16 .I pattern
17 .IR file "..."
18 .br
19 .B xzegrep
20 .RB ...
21 .br
22 .B xzfgrep
23 .RB ...
24 .br
25 .B lzgrep
26 .RB ...
27 .br
28 .B lzegrep
29 .RB ...
30 .br
31 .B lzfgrep
32 .RB ...
33 .SH DESCRIPTION
34 .B xzgrep
35 invokes
36 .BR grep (1)
38 .I files
39 which may be either uncompressed or compressed with
40 .BR xz (1),
41 .BR lzma (1),
42 .BR gzip (1),
43 .BR bzip2 (1),
45 .BR lzop (1).
46 All options specified are passed directly to
47 .BR grep (1).
48 .PP
49 If no
50 .I file
51 is specified, then standard input is decompressed if necessary
52 and fed to
53 .BR grep (1).
54 When reading from standard input,
55 .BR gzip (1),
56 .BR bzip2 (1),
57 and
58 .BR lzop (1)
59 compressed files are not supported.
60 .PP
62 .B xzgrep
63 is invoked as
64 .B xzegrep
66 .B xzfgrep
67 then
68 .BR egrep (1)
70 .BR fgrep (1)
71 is used instead of
72 .BR grep (1).
73 The same applies to names
74 .BR lzgrep ,
75 .BR lzegrep ,
76 and
77 .BR lzfgrep ,
78 which are provided for backward compatibility with LZMA Utils.
79 .PP
80 .SH ENVIRONMENT
81 .TP
82 .B GREP
83 If the
84 .B GREP
85 environment variable is set,
86 .B xzgrep
87 uses it instead of
88 .BR grep (1),
89 .BR egrep (1),
91 .BR fgrep (1).
92 .SH "SEE ALSO"
93 .BR grep (1),
94 .BR xz (1),
95 .BR gzip (1),
96 .BR bzip2 (1),
97 .BR lzop (1),
98 .BR zgrep (1)