xref: /freebsd/usr.bin/grep/zgrep.1 (revision 3cbb4cc200f8a0ad7ed08233425ea54524a21f1c)
1.\" Copyright (c) 2018 Baptiste Daroussin <bapt@FreeBSD.org>
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd July 20, 2020
28.Dt ZGREP 1
29.Os
30.Sh NAME
31.Nm zgrep ,
32.Nm zegrep ,
33.Nm zfgrep ,
34.Nm bzgrep ,
35.Nm bzegrep ,
36.Nm bzfgrep ,
37.Nm lzgrep ,
38.Nm lzegrep ,
39.Nm lzfgrep ,
40.Nm xzgrep ,
41.Nm xzegrep ,
42.Nm xzfgrep ,
43.Nm zstdgrep ,
44.Nm zstdegrep ,
45.Nm zstdfgrep
46.Nd grep compressed files
47.Sh SYNOPSIS
48.Nm
49.Oo Ar flags Oc Ar files
50.Nm zegrep
51.Oo Ar flags Oc Ar files
52.Nm zfgrep
53.Oo Ar flags Oc Ar files
54.Pp
55.Nm bzgrep
56.Oo Ar flags Oc Ar files
57.Nm bzegrep
58.Oo Ar flags Oc Ar files
59.Nm bzfgrep
60.Oo Ar flags Oc Ar files
61.Pp
62.Nm lzgrep
63.Oo Ar flags Oc Ar files
64.Nm lzegrep
65.Oo Ar flags Oc Ar files
66.Nm lzfgrep
67.Oo Ar flags Oc Ar files
68.Pp
69.Nm xzgrep
70.Oo Ar flags Oc Ar files
71.Nm xzegrep
72.Oo Ar flags Oc Ar files
73.Nm xzfgrep
74.Oo Ar flags Oc Ar files
75.Pp
76.Nm zstdgrep
77.Oo Ar flags Oc Ar files
78.Nm zstdegrep
79.Oo Ar flags Oc Ar files
80.Nm zstdfgrep
81.Oo Ar flags Oc Ar files
82.Sh DESCRIPTION
83Allow
84.Xr grep 1
85to read compressed files.
86.Sh SEE ALSO
87.Xr bzip2 1 ,
88.Xr grep 1 ,
89.Xr gzip 1 ,
90.Xr xz 1 ,
91.Xr zstd 1
92.Sh AUTHORS
93This version of the
94.Nm
95utility was written by
96.An Thomas Klausner Aq Mt wiz@NetBSD.org .
97.Sh BUGS
98.Xr zgrep 1
99does not handle flags that take arguments if there is no whitespace
100between the flag and the argument, for example:
101.Pp
102.Dl "zgrep -enfs /etc/rpc"
103.Pp
104When more than one
105.Fl e
106flag is used matching
107should occur for any of the patterns (similar to multiple patterns
108supplied in a file with the
109.Fl f
110flag).
111.Xr zgrep 1
112only matches the last
113.Fl e
114pattern.
115