Annotation of src/usr.bin/grep/grep.1, Revision 1.37
1.37 ! tedu 1: .\" $OpenBSD: grep.1,v 1.36 2009/02/08 17:15:10 jmc Exp $
1.6 deraadt 2: .\" Copyright (c) 1980, 1990, 1993
3: .\" The Regents of the University of California. All rights reserved.
1.1 deraadt 4: .\"
5: .\" Redistribution and use in source and binary forms, with or without
6: .\" modification, are permitted provided that the following conditions
7: .\" are met:
8: .\" 1. Redistributions of source code must retain the above copyright
9: .\" notice, this list of conditions and the following disclaimer.
10: .\" 2. Redistributions in binary form must reproduce the above copyright
11: .\" notice, this list of conditions and the following disclaimer in the
12: .\" documentation and/or other materials provided with the distribution.
1.9 millert 13: .\" 3. Neither the name of the University nor the names of its contributors
1.6 deraadt 14: .\" may be used to endorse or promote products derived from this software
15: .\" without specific prior written permission.
1.1 deraadt 16: .\"
1.6 deraadt 17: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
1.1 deraadt 18: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1.6 deraadt 20: .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
1.1 deraadt 21: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27: .\" SUCH DAMAGE.
28: .\"
1.6 deraadt 29: .\" @(#)grep.1 8.3 (Berkeley) 4/18/94
30: .\"
1.37 ! tedu 31: .Dd $Mdocdate: February 8 2009 $
1.1 deraadt 32: .Dt GREP 1
33: .Os
34: .Sh NAME
1.27 jmc 35: .Nm grep , egrep , fgrep ,
36: .Nm zgrep , zegrep , zfgrep
1.6 deraadt 37: .Nd file pattern searcher
1.1 deraadt 38: .Sh SYNOPSIS
39: .Nm grep
1.27 jmc 40: .Bk -words
1.37 ! tedu 41: .Op Fl abcEFGhIiLlnqRsUVvwxZ
1.27 jmc 42: .Op Fl A Ar num
43: .Op Fl B Ar num
44: .Op Fl C Ns Op Ar num
45: .Op Fl e Ar pattern
46: .Op Fl f Ar file
47: .Op Fl -binary-files Ns = Ns Ar value
1.12 tedu 48: .Op Fl -context Ns Op = Ns Ar num
1.24 otto 49: .Op Fl -line-buffered
1.21 mcbride 50: .Op Ar pattern
1.6 deraadt 51: .Op Ar
1.27 jmc 52: .Ek
1.1 deraadt 53: .Sh DESCRIPTION
54: The
1.6 deraadt 55: .Nm grep
1.27 jmc 56: utility searches any given input files,
57: selecting lines that match one or more patterns.
58: By default, a pattern matches an input line if the regular expression
59: (RE) in the pattern matches the input line
60: without its trailing newline.
1.6 deraadt 61: An empty expression matches every line.
62: Each input line that matches at least one of the patterns is written
63: to the standard output.
1.1 deraadt 64: .Pp
1.6 deraadt 65: .Nm grep
1.27 jmc 66: is used for simple patterns and
1.29 jmc 67: basic regular expressions
68: .Pq BREs ;
1.1 deraadt 69: .Nm egrep
1.29 jmc 70: can handle extended regular expressions
71: .Pq EREs .
72: See
73: .Xr re_format 7
74: for more information on regular expressions.
1.1 deraadt 75: .Nm fgrep
1.27 jmc 76: is quicker than both
77: .Nm grep
78: and
79: .Nm egrep ,
80: but can only handle fixed patterns
81: (i.e. it does not interpret regular expressions).
82: Patterns may consist of one or more lines,
83: allowing any of the pattern lines to match a portion of the input.
84: .Pp
1.7 deraadt 85: .Nm zgrep ,
86: .Nm zegrep ,
87: and
88: .Nm zfgrep
1.27 jmc 89: act like
1.7 deraadt 90: .Nm grep ,
91: .Nm egrep ,
92: and
1.27 jmc 93: .Nm fgrep ,
94: respectively, but accept input files compressed with the
1.6 deraadt 95: .Xr compress 1
96: or
97: .Xr gzip 1
98: compression utilities.
1.1 deraadt 99: .Pp
1.6 deraadt 100: The following options are available:
101: .Bl -tag -width indent
102: .It Fl A Ar num
1.7 deraadt 103: Print
1.6 deraadt 104: .Ar num
105: lines of trailing context after each match.
1.27 jmc 106: See also the
107: .Fl B
108: and
109: .Fl C
110: options.
111: .It Fl a
112: Treat all files as ASCII text.
1.30 jmc 113: Normally
114: .Nm
115: will simply print
116: .Dq Binary file ... matches
117: if files contain binary characters.
118: Use of this option forces
119: .Nm
120: to output lines matching the specified pattern.
1.6 deraadt 121: .It Fl B Ar num
1.7 deraadt 122: Print
123: .Ar num
1.6 deraadt 124: lines of leading context before each match.
1.27 jmc 125: See also the
126: .Fl A
127: and
128: .Fl C
129: options.
130: .It Fl b
131: The offset in bytes of a matched pattern is
132: displayed in front of the respective matched line.
133: .It Fl C Ns Op Ar num
134: Print
135: .Ar num
136: lines of leading and trailing context surrounding each match.
137: The default is 2 and is equivalent to
1.6 deraadt 138: .Fl A
139: .Ar 2
140: .Fl B
141: .Ar 2 .
1.27 jmc 142: Note:
143: no whitespace may be given between the option and its argument.
144: .It Fl c
145: Only a count of selected lines is written to standard output.
1.1 deraadt 146: .It Fl E
1.27 jmc 147: Interpret
148: .Ar pattern
149: as an extended regular expression
150: (i.e. force
1.7 deraadt 151: .Nm grep
152: to behave as
1.27 jmc 153: .Nm egrep ) .
154: .It Fl e Ar pattern
155: Specify a pattern used during the search of the input:
156: an input line is selected if it matches any of the specified patterns.
157: This option is most useful when multiple
158: .Fl e
159: options are used to specify multiple patterns,
160: or when a pattern begins with a dash
161: .Pq Sq - .
1.1 deraadt 162: .It Fl F
1.27 jmc 163: Interpret
164: .Ar pattern
165: as a set of fixed strings
166: (i.e. force
1.6 deraadt 167: .Nm grep
1.7 deraadt 168: to behave as
1.27 jmc 169: .Nm fgrep ) .
170: .It Fl f Ar file
171: Read one or more newline separated patterns from
172: .Ar file .
1.33 kili 173: Empty pattern lines match every input line.
1.27 jmc 174: Newlines are not considered part of a pattern.
1.33 kili 175: If
176: .Ar file
177: is empty, nothing is matched.
1.6 deraadt 178: .It Fl G
1.27 jmc 179: Interpret
180: .Ar pattern
181: as a basic regular expression
182: (i.e. force
1.6 deraadt 183: .Nm grep
1.27 jmc 184: to behave as traditional
185: .Nm grep ) .
186: .It Fl h
187: Never print filename headers
188: .Pq i.e. filenames
189: with output lines.
1.10 tedu 190: .It Fl I
191: Ignore binary files.
1.27 jmc 192: .It Fl i
193: Perform case insensitive matching.
194: By default,
195: .Nm grep
196: is case sensitive.
1.6 deraadt 197: .It Fl L
198: Only the names of files not containing selected lines are written to
199: standard output.
200: Pathnames are listed once per file searched.
1.28 jmc 201: If the standard input is searched, the string
202: .Dq (standard input)
1.6 deraadt 203: is written.
1.1 deraadt 204: .It Fl l
1.6 deraadt 205: Only the names of files containing selected lines are written to
1.7 deraadt 206: standard output.
1.27 jmc 207: .Nm grep
208: will only search a file until a match has been found,
209: making searches potentially less expensive.
1.7 deraadt 210: Pathnames are listed once per file searched.
1.28 jmc 211: If the standard input is searched, the string
212: .Dq (standard input)
1.6 deraadt 213: is written.
1.1 deraadt 214: .It Fl n
1.6 deraadt 215: Each output line is preceded by its relative line number in the file,
216: starting at line 1.
217: The line number counter is reset for each file processed.
218: This option is ignored if
219: .Fl c ,
1.27 jmc 220: .Fl L ,
1.6 deraadt 221: .Fl l ,
222: or
1.32 jmc 223: .Fl q
1.6 deraadt 224: is
225: specified.
1.1 deraadt 226: .It Fl q
1.27 jmc 227: Quiet mode:
228: suppress normal output.
229: .Nm grep
230: will only search a file until a match has been found,
231: making searches potentially less expensive.
232: .It Fl R
233: Recursively search subdirectories listed.
1.1 deraadt 234: .It Fl s
1.7 deraadt 235: Silent mode.
1.27 jmc 236: Nonexistent and unreadable files are ignored
237: (i.e. their error messages are suppressed).
238: .It Fl U
239: Search binary files, but do not attempt to print them.
240: .It Fl V
241: Display version information.
242: All other options are ignored.
1.1 deraadt 243: .It Fl v
1.6 deraadt 244: Selected lines are those
245: .Em not
1.14 dhartmei 246: matching any of the specified patterns.
1.1 deraadt 247: .It Fl w
1.27 jmc 248: The expression is searched for as a word (as if surrounded by
249: .Sq [[:<:]]
250: and
251: .Sq [[:>:]] ;
252: see
1.26 jmc 253: .Xr re_format 7 ) .
1.1 deraadt 254: .It Fl x
1.6 deraadt 255: Only input lines selected against an entire fixed string or regular
256: expression are considered to be matching lines.
1.27 jmc 257: .It Fl Z
258: Force
259: .Nm grep
260: to behave as
261: .Nm zgrep .
262: .It Fl Fl binary-files Ns = Ns Ar value
263: Controls searching and printing of binary files.
264: Options are
265: .Ar binary ,
266: the default: search binary files but do not print them;
267: .Ar without-match :
268: do not search binary files;
269: and
270: .Ar text :
271: treat all files as text.
1.12 tedu 272: .Sm off
273: .It Fl Fl context Op = Ar num
274: .Sm on
275: Print
276: .Ar num
277: lines of leading and trailing context.
1.27 jmc 278: The default is 2.
1.24 otto 279: .It Fl Fl line-buffered
280: Force output to be line buffered.
281: By default, output is line buffered when standard output is a terminal
282: and block buffered otherwise.
1.6 deraadt 283: .Pp
1.1 deraadt 284: .El
1.6 deraadt 285: If no file arguments are specified, the standard input is used.
1.7 deraadt 286: .Sh RETURN VALUES
1.1 deraadt 287: The
1.6 deraadt 288: .Nm grep
1.1 deraadt 289: utility exits with one of the following values:
290: .Pp
291: .Bl -tag -width flag -compact
1.6 deraadt 292: .It Li 0
293: One or more lines were selected.
294: .It Li 1
295: No lines were selected.
1.27 jmc 296: .It Li \*(Gt1
1.6 deraadt 297: An error occurred.
1.4 jmc 298: .El
1.6 deraadt 299: .Sh EXAMPLES
1.27 jmc 300: To find all occurrences of the word
301: .Sq patricia
302: in a file:
1.6 deraadt 303: .Pp
1.27 jmc 304: .Dl $ grep 'patricia' myfile
1.6 deraadt 305: .Pp
306: To find all occurrences of the pattern
1.27 jmc 307: .Ql .Pp
1.6 deraadt 308: at the beginning of a line:
309: .Pp
1.27 jmc 310: .Dl $ grep '^\e.Pp' myfile
1.6 deraadt 311: .Pp
1.7 deraadt 312: The apostrophes ensure the entire expression is evaluated by
1.6 deraadt 313: .Nm grep
1.27 jmc 314: instead of by the user's shell.
1.6 deraadt 315: The caret
1.27 jmc 316: .Ql ^
1.6 deraadt 317: matches the null string at the beginning of a line,
318: and the
1.27 jmc 319: .Ql \e
1.6 deraadt 320: escapes the
1.27 jmc 321: .Ql \&. ,
1.6 deraadt 322: which would otherwise match any character.
1.21 mcbride 323: .Pp
1.27 jmc 324: To find all lines in a file which do not contain the words
325: .Sq foo
326: or
327: .Sq bar :
1.21 mcbride 328: .Pp
1.27 jmc 329: .Dl $ grep -v -e 'foo' -e 'bar' myfile
1.6 deraadt 330: .Pp
331: A simple example of an extended regular expression:
332: .Pp
1.27 jmc 333: .Dl $ egrep '19|20|25' calendar
1.6 deraadt 334: .Pp
1.27 jmc 335: Peruses the file
336: .Sq calendar
337: looking for either 19, 20, or 25.
1.1 deraadt 338: .Sh SEE ALSO
1.6 deraadt 339: .Xr ed 1 ,
340: .Xr ex 1 ,
1.27 jmc 341: .Xr gzip 1 ,
1.6 deraadt 342: .Xr sed 1 ,
1.7 deraadt 343: .Xr re_format 7
1.27 jmc 344: .Sh STANDARDS
345: The
1.34 jmc 346: .Nm
1.27 jmc 347: utility is compliant with the
1.36 jmc 348: .St -p1003.1-2008
1.27 jmc 349: specification.
350: .Pp
351: The flags
1.37 ! tedu 352: .Op Fl AaBbCGhILRUVwZ
1.33 kili 353: are extensions to that specification, and the behaviour of the
354: .Fl f
355: flag when used with an empty pattern file is left undefined.
1.27 jmc 356: .Pp
357: All long options are provided for compatibility with
358: GNU versions of this utility.
359: .Pp
360: Historic versions of the
361: .Nm grep
362: utility also supported the flags
363: .Op Fl ruy .
364: This implementation supports those options;
365: however, their use is strongly discouraged.
1.1 deraadt 366: .Sh HISTORY
1.6 deraadt 367: The
1.1 deraadt 368: .Nm grep
1.27 jmc 369: command first appeared in
1.1 deraadt 370: .At v6 .
![[BACK]](/icons/back.gif){kind=icon}
Return to grep.1 CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / grep