xref: /freebsd/usr.bin/grep/zgrep.1 (revision abd87254)
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.Dd July 20, 2020
26.Dt ZGREP 1
27.Os
28.Sh NAME
29.Nm zgrep ,
30.Nm zegrep ,
31.Nm zfgrep ,
32.Nm bzgrep ,
33.Nm bzegrep ,
34.Nm bzfgrep ,
35.Nm lzgrep ,
36.Nm lzegrep ,
37.Nm lzfgrep ,
38.Nm xzgrep ,
39.Nm xzegrep ,
40.Nm xzfgrep ,
41.Nm zstdgrep ,
42.Nm zstdegrep ,
43.Nm zstdfgrep
44.Nd grep compressed files
45.Sh SYNOPSIS
46.Nm
47.Oo Ar flags Oc Ar files
48.Nm zegrep
49.Oo Ar flags Oc Ar files
50.Nm zfgrep
51.Oo Ar flags Oc Ar files
52.Pp
53.Nm bzgrep
54.Oo Ar flags Oc Ar files
55.Nm bzegrep
56.Oo Ar flags Oc Ar files
57.Nm bzfgrep
58.Oo Ar flags Oc Ar files
59.Pp
60.Nm lzgrep
61.Oo Ar flags Oc Ar files
62.Nm lzegrep
63.Oo Ar flags Oc Ar files
64.Nm lzfgrep
65.Oo Ar flags Oc Ar files
66.Pp
67.Nm xzgrep
68.Oo Ar flags Oc Ar files
69.Nm xzegrep
70.Oo Ar flags Oc Ar files
71.Nm xzfgrep
72.Oo Ar flags Oc Ar files
73.Pp
74.Nm zstdgrep
75.Oo Ar flags Oc Ar files
76.Nm zstdegrep
77.Oo Ar flags Oc Ar files
78.Nm zstdfgrep
79.Oo Ar flags Oc Ar files
80.Sh DESCRIPTION
81Allow
82.Xr grep 1
83to read compressed files.
84.Sh SEE ALSO
85.Xr bzip2 1 ,
86.Xr grep 1 ,
87.Xr gzip 1 ,
88.Xr xz 1 ,
89.Xr zstd 1
90.Sh AUTHORS
91This version of the
92.Nm
93utility was written by
94.An Thomas Klausner Aq Mt wiz@NetBSD.org .
95.Sh BUGS
96.Xr zgrep 1
97does not handle flags that take arguments if there is no whitespace
98between the flag and the argument, for example:
99.Pp
100.Dl "zgrep -enfs /etc/rpc"
101.Pp
102When more than one
103.Fl e
104flag is used matching
105should occur for any of the patterns (similar to multiple patterns
106supplied in a file with the
107.Fl f
108flag).
109.Xr zgrep 1
110only matches the last
111.Fl e
112pattern.
113