| blob | 9fdf321590b489bef9fae57b4bdd807584afa31a |
1 '\" te
2 .\" Copyright 1989 AT&T
3 .\" Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved
4 .\" Portions Copyright (c) 1992, X/Open Company Limited All Rights Reserved
5 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
6 .\" http://www.opengroup.org/bookstore/.
7 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
8 .\" This notice shall appear on any product containing this material.
9 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
10 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
11 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
12 .TH EGREP 1 "May 3, 2013"
13 .SH NAME
14 egrep \- search a file for a pattern using full regular expressions
15 .SH SYNOPSIS
16 .LP
17 .nf
18 \fB/usr/bin/egrep\fR [\fB-bcHhilnqsv\fR] \fB-e\fR \fIpattern_list\fR [\fIfile...\fR]
19 .fi
21 .LP
22 .nf
23 \fB/usr/bin/egrep\fR [\fB-bcHhilnqsv\fR] \fB-f\fR \fIfile\fR [\fIfile...\fR]
24 .fi
26 .LP
27 .nf
28 \fB/usr/bin/egrep\fR [\fB-bcHhilnqsv\fR] \fIpattern\fR [\fIfile...\fR]
29 .fi
31 .LP
32 .nf
33 \fB/usr/xpg4/bin/egrep\fR [\fB-bcHhilnqsvx\fR] \fB-e\fR \fIpattern_list\fR [\fB-f\fR \fIfile\fR]
34 [\fIfile...\fR]
35 .fi
37 .LP
38 .nf
39 \fB/usr/xpg4/bin/egrep\fR [\fB-bcHhilnqsvx\fR] [\fB-e\fR \fIpattern_list\fR] \fB-f\fR \fIfile\fR
40 [\fIfile...\fR]
41 .fi
43 .LP
44 .nf
45 \fB/usr/xpg4/bin/egrep\fR [\fB-bcHhilnqsvx\fR] \fIpattern\fR [\fIfile...\fR]
46 .fi
48 .SH DESCRIPTION
49 .sp
50 .LP
51 The \fBegrep\fR (\fIexpression grep\fR) utility searches files for a pattern of
52 characters and prints all lines that contain that pattern. \fBegrep\fR uses
53 full regular expressions (expressions that have string values that use the full
54 set of alphanumeric and special characters) to match the patterns. It uses a
55 fast deterministic algorithm that sometimes needs exponential space.
56 .sp
57 .LP
58 If no files are specified, \fBegrep\fR assumes standard input. Normally, each
59 line found is copied to the standard output. The file name is printed before
60 each line found if there is more than one input file.
61 .SS "/usr/bin/egrep"
62 .sp
63 .LP
64 The \fB/usr/bin/egrep\fR utility accepts full regular expressions as described
65 on the \fBregexp\fR(5) manual page, except for \fB\e(\fR and \fB\e)\fR,
66 \fB\e(\fR and \fB\e)\fR, \fB\e{\fR and \fB\e}\fR, \fB\e<\fR and \fB\e>\fR, and
67 \fB\en\fR, and with the addition of:
68 .RS +4
69 .TP
70 1.
71 A full regular expression followed by \fB+\fR that matches one or more
72 occurrences of the full regular expression.
73 .RE
74 .RS +4
75 .TP
76 2.
77 A full regular expression followed by \fB?\fR that matches 0 or 1
78 occurrences of the full regular expression.
79 .RE
80 .RS +4
81 .TP
82 3.
83 Full regular expressions separated by | or by a \fBNEWLINE\fR that match
84 strings that are matched by any of the expressions.
85 .RE
86 .RS +4
87 .TP
88 4.
89 A full regular expression that can be enclosed in parentheses \fB()\fRfor
90 grouping.
91 .RE
92 .sp
93 .LP
94 Be careful using the characters \fB$\fR, \fB*\fR, \fB[\fR, \fB^\fR, |, \fB(\fR,
95 \fB)\fR, and \fB\e\fR in \fIfull regular expression\fR, because they are also
96 meaningful to the shell. It is safest to enclose the entire \fIfull regular
97 expression\fR in single quotes (\fBa\'\fR\fBa\'\fR).
98 .sp
99 .LP
100 The order of precedence of operators is \fB[\|]\fR, then \fB*\|?\|+\fR, then
101 concatenation, then | and NEWLINE.
102 .SS "/usr/xpg4/bin/egrep"
103 .sp
104 .LP
105 The \fB/usr/xpg4/bin/egrep\fR utility uses the regular expressions described in
106 the \fBEXTENDED REGULAR EXPRESSIONS\fR section of the \fBregex\fR(5) manual
107 page.
108 .SH OPTIONS
109 .sp
110 .LP
111 The following options are supported for both \fB/usr/bin/egrep\fR and
112 \fB/usr/xpg4/bin/egrep\fR:
113 .sp
114 .ne 2
115 .na
116 \fB\fB-b\fR\fR
117 .ad
118 .RS 19n
119 Precede each line by the block number on which it was found. This can be useful
120 in locating block numbers by context (first block is 0).
121 .RE
123 .sp
124 .ne 2
125 .na
126 \fB\fB-c\fR\fR
127 .ad
128 .RS 19n
129 Print only a count of the lines that contain the pattern.
130 .RE
132 .sp
133 .ne 2
134 .na
135 \fB\fB-e\fR \fIpattern_list\fR\fR
136 .ad
137 .RS 19n
138 Search for a \fIpattern_list\fR (\fIfull regular expression\fR that begins with
139 a \fB\(mi\fR).
140 .RE
142 .sp
143 .ne 2
144 .na
145 \fB\fB-f\fR \fIfile\fR\fR
146 .ad
147 .RS 19n
148 Take the list of \fIfull\fR \fIregular\fR \fIexpressions\fR from \fIfile\fR.
149 .RE
151 .sp
152 .ne 2
153 .na
154 \fB\fB-H\fR\fR
155 .ad
156 .RS 19n
157 Precedes each line by the name of the file containing the matching line.
158 .RE
160 .sp
161 .ne 2
162 .na
163 \fB\fB-h\fR\fR
164 .ad
165 .RS 19n
166 Suppress printing of filenames when searching multiple files.
167 .RE
169 .sp
170 .ne 2
171 .na
172 \fB\fB-i\fR\fR
173 .ad
174 .RS 19n
175 Ignore upper/lower case distinction during comparisons.
176 .RE
178 .sp
179 .ne 2
180 .na
181 \fB\fB-l\fR\fR
182 .ad
183 .RS 19n
184 Print the names of files with matching lines once, separated by NEWLINEs. Does
185 not repeat the names of files when the pattern is found more than once.
186 .RE
188 .sp
189 .ne 2
190 .na
191 \fB\fB-n\fR\fR
192 .ad
193 .RS 19n
194 Precede each line by its line number in the file (first line is 1).
195 .RE
197 .sp
198 .ne 2
199 .na
200 \fB\fB-q\fR\fR
201 .ad
202 .RS 19n
203 Quiet. Does not write anything to the standard output, regardless of matching
204 lines. Exits with zero status if an input line is selected.
205 .RE
207 .sp
208 .ne 2
209 .na
210 \fB\fB-s\fR\fR
211 .ad
212 .RS 19n
213 Legacy equivalent of \fB-q\fR.
214 .RE
216 .sp
217 .ne 2
218 .na
219 \fB\fB-v\fR\fR
220 .ad
221 .RS 19n
222 Print all lines except those that contain the pattern.
223 .RE
225 .SS "/usr/xpg4/bin/egrep"
226 .sp
227 .LP
228 The following options are supported for \fB/usr/xpg4/bin/egrep\fR only:
229 .sp
230 .ne 2
231 .na
232 \fB\fB-x\fR\fR
233 .ad
234 .RS 6n
235 Consider only input lines that use all characters in the line to match an
236 entire fixed string or regular expression to be matching lines.
237 .RE
239 .SH OPERANDS
240 .sp
241 .LP
242 The following operands are supported:
243 .sp
244 .ne 2
245 .na
246 \fB\fIfile\fR\fR
247 .ad
248 .RS 8n
249 A path name of a file to be searched for the patterns. If no \fIfile\fR
250 operands are specified, the standard input is used.
251 .RE
253 .SS "/usr/bin/egrep"
254 .sp
255 .ne 2
256 .na
257 \fB\fIpattern\fR\fR
258 .ad
259 .RS 11n
260 Specify a pattern to be used during the search for input.
261 .RE
263 .SS "/usr/xpg4/bin/egrep"
264 .sp
265 .ne 2
266 .na
267 \fB\fIpattern\fR\fR
268 .ad
269 .RS 11n
270 Specify one or more patterns to be used during the search for input. This
271 operand is treated as if it were specified as \fB-e\fR\fIpattern_list.\fR.
272 .RE
274 .SH USAGE
275 .sp
276 .LP
277 See \fBlargefile\fR(5) for the description of the behavior of \fBegrep\fR when
278 encountering files greater than or equal to 2 Gbyte ( 2^31 bytes).
279 .SH ENVIRONMENT VARIABLES
280 .sp
281 .LP
282 See \fBenviron\fR(5) for descriptions of the following environment variables
283 that affect the execution of \fBegrep\fR: \fBLC_COLLATE\fR, \fBLC_CTYPE\fR,
284 \fBLC_MESSAGES\fR, and \fBNLSPATH\fR.
285 .SH EXIT STATUS
286 .sp
287 .LP
288 The following exit values are returned:
289 .sp
290 .ne 2
291 .na
292 \fB\fB0\fR\fR
293 .ad
294 .RS 5n
295 If any matches are found.
296 .RE
298 .sp
299 .ne 2
300 .na
301 \fB\fB1\fR\fR
302 .ad
303 .RS 5n
304 If no matches are found.
305 .RE
307 .sp
308 .ne 2
309 .na
310 \fB\fB2\fR\fR
311 .ad
312 .RS 5n
313 For syntax errors or inaccessible files (even if matches were found).
314 .RE
316 .SH ATTRIBUTES
317 .sp
318 .LP
319 See \fBattributes\fR(5) for descriptions of the following attributes:
320 .SS "/usr/bin/egrep"
321 .sp
323 .sp
324 .TS
325 box;
326 c | c
327 l | l .
328 ATTRIBUTE TYPE ATTRIBUTE VALUE
329 _
330 CSI Not Enabled
331 .TE
333 .SS "/usr/xpg4/bin/egrep"
334 .sp
336 .sp
337 .TS
338 box;
339 c | c
340 l | l .
341 ATTRIBUTE TYPE ATTRIBUTE VALUE
342 _
343 CSI Enabled
344 .TE
346 .SH SEE ALSO
347 .sp
348 .LP
349 \fBfgrep\fR(1), \fBgrep\fR(1), \fBsed\fR(1), \fBsh\fR(1), \fBattributes\fR(5),
350 \fBenviron\fR(5), \fBlargefile\fR(5), \fBregex\fR(5), \fBregexp\fR(5),
351 \fBXPG4\fR(5)
352 .SH NOTES
353 .sp
354 .LP
355 Ideally there should be only one \fBgrep\fR command, but there is not a single
356 algorithm that spans a wide enough range of space-time trade-offs.
357 .sp
358 .LP
359 Lines are limited only by the size of the available virtual memory.
360 .SS "/usr/xpg4/bin/egrep"
361 .sp
362 .LP
363 The \fB/usr/xpg4/bin/egrep\fR utility is identical to \fB/usr/xpg4/bin/grep\fR
364 \fB-E\fR. See \fBgrep\fR(1). Portable applications should use
365 \fB/usr/xpg4/bin/grep\fR \fB-E\fR.