RETURN VALUES is for function return values only. FreeBSD has an own
[dragonfly.git] / usr.bin / gzip / zgrep.1
1 .\" $NetBSD: zgrep.1,v 1.1 2003/12/28 17:26:00 wiz Exp $
2 .\" $DragonFly: src/usr.bin/gzip/zgrep.1,v 1.2 2006/03/01 08:08:44 swildner Exp $
3 .\"
4 .\" Copyright (c) 2003 Thomas Klausner.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\" 3. The name of the author may not be used to endorse or promote products
15 .\"    derived from this software without specific prior written permission.
16 .\"
17 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 .Dd December 28, 2003
28 .Dt ZGREP 1
29 .Os
30 .Sh NAME
31 .Nm zgrep ,
32 .Nm zegrep ,
33 .Nm zfgrep
34 .Nd print lines matching a pattern in gzip-compressed files
35 .Sh SYNOPSIS
36 .Nm
37 .Op Ar grep-flags
38 .Op Fl -
39 .Ar pattern
40 .Op Ar files ...
41 .Pp
42 .Nm zegrep
43 .Op Ar grep-flags
44 .Op Fl -
45 .Ar pattern
46 .Op Ar
47 .Pp
48 .Nm zfgrep
49 .Op Ar grep-flags
50 .Op Fl -
51 .Ar pattern
52 .Op Ar
53 .Sh DESCRIPTION
54 .Nm
55 runs
56 .Xr grep 1
57 on
58 .Ar files
59 or stdin, if no
60 .Ar files
61 argument is given, after decompressing them with
62 .Xr zcat 1 .
63 .Pp
64 The
65 .Ar grep-flags
66 and
67 .Ar pattern
68 arguments are passed on to
69 .Xr grep 1 .
70 If an
71 .Fl e
72 flag is found in the
73 .Ar grep-flags ,
74 .Nm
75 will not look for a
76 .Ar pattern
77 argument.
78 .Pp
79 .Nm zegrep
80 calls
81 .Xr egrep 1 ,
82 while
83 .Nm zfgrep
84 calls
85 .Xr fgrep 1 .
86 .Sh DIAGNOSTICS
87 In case of missing arguments or missing pattern,
88 1 will be returned, otherwise 0.
89 .Sh SEE ALSO
90 .Xr egrep 1 ,
91 .Xr fgrep 1 ,
92 .Xr grep 1 ,
93 .Xr gzip 1 ,
94 .Xr zcat 1
95 .Sh AUTHORS
96 .An Thomas Klausner
97 .Aq wiz@NetBSD.org