summaryrefslogtreecommitdiff
path: root/doc/grep.texi
blob: 557ea68dc6393d1cef6c77b17a8f210c1595d76a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
\input texinfo  @c -*-texinfo-*-
@c %**start of header
@setfilename grep.info
@settitle grep, print lines matching a pattern
@c %**end of header

@c This file has the new style title page commands.
@c Run `makeinfo' rather than `texinfo-format-buffer'.

@c smallbook

@c tex
@c \overfullrule=0pt
@c end tex

@include version.texi

@c Combine indices.
@syncodeindex ky cp
@syncodeindex pg cp
@syncodeindex tp cp

@defcodeindex op
@syncodeindex op fn
@syncodeindex vr fn

@ifinfo
@direntry
* grep: (grep).                   print lines matching a pattern.
@end direntry
This file documents @sc{grep}, a pattern matching engine.


Published by the Free Software Foundation,
59 Temple Place - Suite 330
Boston, MA 02111-1307, USA

Copyright 1999 Free Software Foundation, Inc.

Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission notice
are preserved on all copies.

@ignore
Permission is granted to process this file through TeX and print the
results, provided the printed document carries copying permission
notice identical to this one except for the removal of this paragraph
(this paragraph not being relevant to the printed manual).

@end ignore
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided that the entire
resulting derived work is distributed under the terms of a permission
notice identical to this one.

Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that this permission notice may be stated in a translation approved
by the Foundation.
@end ifinfo

@setchapternewpage off

@titlepage
@title grep, searching for a pattern
@subtitle version @value{VERSION}, @value{UPDATED}
@author Alain Magloire et al.

@page
@vskip 0pt plus 1filll
Copyright @copyright{} 1999 Free Software Foundation, Inc.

@sp 2
Published by the Free Software Foundation, @*
59 Temple Place - Suite 330, @*
Boston, MA 02111-1307, USA

Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission notice
are preserved on all copies.

Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided that the entire
resulting derived work is distributed under the terms of a permission
notice identical to this one.

Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that this permission notice may be stated in a translation approved
by the Foundation.

@end titlepage
@page


@node Top, Introduction, (dir), (dir)
@comment  node-name,  next,  previous,  up

@ifinfo
This document was produced for version @value{VERSION} of @sc{GNU} @sc{grep}.
@end ifinfo

@menu
* Introduction::                Introduction.
* Invoking::                    Invoking @sc{grep}; description of options.
* Diagnostics::                 Exit status returned by @sc{grep}.
* Grep Programs::               @sc{grep} programs.
* Regular Expressions::         Regular Expressions.
* Reporting Bugs::              Reporting Bugs.
* Concept Index::               A menu with all the topics in this manual.
* Index::                       A menu with all @sc{grep} commands
                                 and command-line options.
@end menu


@node Introduction,  Invoking, Top, Top
@comment  node-name,  next,  previous,  up
@chapter Introduction

@cindex Searching for a pattern.
@sc{grep} searches the input files for lines containing a match to a given
pattern list.  When it finds a match in a line, it copies the line to standard
output (by default), or does whatever other sort of output you have requested
with options.  @sc{grep} expects to do the matching on text.
Since newline is also a separator for the list of patterns, there
is no way to match newline characters in a text.

@node Invoking, Diagnostics, Introduction, Top
@comment  node-name,  next,  previous,  up
@chapter Invoking @sc{grep}

@sc{grep} comes with a rich set of options from POSIX.2 and GNU extensions.

@table @samp

@item -c
@itemx --count
@opindex -c
@opindex -count
@cindex counting lines
Suppress normal output; instead print a count of matching
lines for each input file.  With the @samp{-v}, @samp{--invert-match} option,
count non-matching lines.

@item -e @var{pattern}
@itemx --regexp=@var{pattern}
@opindex -e
@opindex --regexp=@var{pattern}
@cindex pattern list
Use @var{pattern} as the pattern; useful to protect  patterns
beginning with a @samp{-}.

@item  -f @var{file}
@itemx --file=@var{file}
@opindex  -f
@opindex  --file 
@cindex pattern from file
Obtain patterns from @var{file}, one  per  line.   The  empty
file contains zero patterns, and therefore matches nothing.

@item -i
@itemx --ignore-case
@opindex -i
@opindex --ignore-case
@cindex case insensitive search
Ignore case distinctions in both the  pattern  and  the input files.

@item -l
@itemx --files-with-matches
@opindex -l
@opindex --files-with-matches
@cindex names of matching files
Suppress normal output; instead print the name of  each input
file  from which output would normally have been printed.
The scanning of every file will stop on the first match.

@item -n
@itemx --line-number
@opindex -n
@opindex --line-number
@cindex line numbering
Prefix each line of output with the line number  within its input file.

@item -q
@itemx --quiet
@itemx --silent
@opindex -q
@opindex --quiet
@opindex --silent
@cindex quiet, silent
Quiet; suppress normal output.  The scanning of every file will  stop on
the first match.  Also see the @samp{-s} or @samp{--no-messages} option.

@item -s
@itemx --no-messages
@opindex -s
@opindex --no-messages
@cindex suppress error messages
Suppress error messages about nonexistent or unreadable files.
Portability  note:  unlike  GNU @sc{grep}, BSD @sc{grep} does not comply
with POSIX.2, because BSD @sc{grep} lacks a @samp{-q}  option and its
@samp{-s} option behaves like GNU @sc{grep}'s @samp{-q} option.  Shell
scripts intended to be portable to BSD @sc{grep} should avoid both
@samp{-q} and @samp{-s} and should redirect
output to @file{/dev/null} instead.

@item -v
@itemx --invert-match
@opindex -v
@opindex --invert-match
@cindex invert matching
@cindex print non-matching lines
Invert the sense of matching,  to  select  non-matching lines.

@item -x
@itemx --line-regexp
@opindex -x
@opindex --line-regexp
@cindex match the whole line
Select only those matches that exactly match the  whole line.

@end table

@section GNU Extensions

@table @samp

@item -A @var{num}
@itemx --after-context=@var{num}
@opindex -A
@opindex --after-context
@cindex after context
@cindex context lines, after match
Print @var{num} lines of trailing context after matching lines.

@item -B @var{num}
@itemx --before-context=@var{num}
@opindex -B
@opindex --before-context
@cindex before context
@cindex context lines, before match
Print @var{num} lines of leading context before matching lines.

@item -C @var{num}
@itemx --context@var{[=num]}
@opindex -C
@opindex --context
@cindex context
Print @var{num} lines (default 2) of output context.


@item -NUM
@opindex -NUM
Same as @samp{--context=@var{num}} lines  of  leading  and  trailing
context.  However, grep will never print any given line more than once.


@item -V
@itemx --version
@opindex -V
@opindex --version
@cindex Version, printing
Print the version number of @sc{grep} to the standard output stream.
This  version  number  should  be  included  in all bug reports.

@item --help
@opindex --help
@cindex Usage summary, printing
Print a usage message briefly summarizing these command-line options
and the bug-reporting address, then exit.

@item -b
@itemx --byte-offset
@opindex -b
@opindex --byte-offset
@cindex byte offset
Print the byte offset within the input file before each line of output.
When @sc{grep} runs on MS-DOS or MS-Windows, the printed byte offsets
depend on whether the @samp{-u} (@samp{--unix-byte-offsets}) option is
used; see below.

@item -d @var{action}
@itemx --directories=@var{action}
@opindex -d 
@opindex --directories
@cindex directory search
If an input file is a directory, use @var{action} to  process it.
By  default, @var{action} is @samp{read}, which means that directories are
read just  as  if  they  were  ordinary files (some operating systems
and filesystems disallow this, and will cause @sc{grep} to print error
messages for every directory).  If @var{action} is @samp{skip},
directories are silently skipped.  If @var{action} is @samp{recurse},
@sc{grep} reads all files under each directory, recursively; this is
equivalent to the @samp{-r} option.

@item -H
@itemx --with-filename
@opindex -H
@opindex --With-filename
@cindex with filename prefix
Print the filename for each match.

@item -h
@itemx --no-filename
@opindex -h
@opindex --no-filename
@cindex no filename prefix
Suppress the prefixing of filenames on output when multiple files are searched.

@item -L
@itemx --files-without-match
@opindex -L
@opindex --files-without-match
@cindex files which don't match
Suppress normal output; instead print the name of  each input
file  from  which  no output would normally have been printed.
The  scanning of every file will  stop  on  the  first match.

@item -a
@itemx --text
@opindex -a
@opindex --text
@cindex suppress binary data
@cindex binary files
Do not suppress output lines that contain binary  data.
Normally,  if  the  first  few bytes of a file indicate
that the file contains binary data, grep outputs only a
message saying that the file matches the pattern.  This
option causes grep to act as if  the  file  is  a  text
file, even if it would otherwise be treated as binary.
@emph{Warning:}  the  result  might  be  binary garbage
printed  to  the  terminal,  which  can  have  nasty
side-effects if the terminal driver interprets some of
it as commands.

@item -w
@itemx --word-regexp
@opindex -w
@opindex --word-regexp
@cindex matching whole words
Select only those lines containing  matches  that  form
whole  words.   The test is that the matching substring
must either be at the beginning of the  line,  or  preceded 
by a non-word constituent character.  Similarly,
it must be either at the end of the line or followed by
a  non-word  constituent  character.   Word-constituent
characters are letters, digits, and the underscore.

@item -r
@itemx --recursive
@opindex -r
@opindex --recursive
@cindex recursive search
@cindex searching directory trees
For each directory mentioned in the command line, read and process all
files in that directory, recursively.  This is the same as the @samp{-d
recurse} option.

@item -y
@opindex -y
@cindex case insensitive search, obsolete option
Obsolete synonym for @samp{-i}.

@item -U
@itemx --binary
@opindex -U
@opindex --binary
@cindex DOS/Windows binary files
@cindex binary files, DOS/Windows
Treat the file(s) as binary.  By default, under  MS-DOS
and  MS-Windows, @sc{grep} guesses the file type by looking
at the contents of the first 32KB read from  the  file.
If @sc{grep} decides the file is a text file, it strips the
CR characters from the original file contents (to  make
regular  expressions  with  @code{^} and @code{$} work correctly).
Specifying @samp{-U} overrules this guesswork, causing all
files  to  be read and passed to the matching mechanism
verbatim; if the file is a text file with  CR/LF  pairs
at  the  end of each line, this will cause some regular
expressions to fail.  This option has no effect on platforms other than
MS-DOS and MS-Windows.

@item -u
@itemx --unix-byte-offsets
@opindex -u
@opindex --unix-byte-offsets
@cindex DOS byte offsets
@cindex byte offsets, on DOS/Windows
Report Unix-style byte  offsets.   This  switch  causes
@sc{grep} to report byte offsets as if the file were Unix style
text file, i.e. the byte offsets ignore the CR characters which were
stripped  off.  This  will produce results identical to running @sc{grep} on
a Unix machine.  This option has no  effect  unless  @samp{-b}
option is also used; it has no effect on platforms other than MS-DOS and
MS-Windows.

@item -Z
@itemx --null
@opindex -Z
@opindex --null
@cindex zero-terminated file names
Output a zero byte (the @sc{ASCII} @sc{NUL} character) instead of the
character that normally follows a file name.  For example, @samp{grep
-lZ} outputs a zero byte after each file name instead of the usual
newline.  This option makes the output unambiguous, even in the presence
of file names containing unusual characters like newlines.  This option
can be used with commands like @samp{find -print0}, @samp{perl -0},
@samp{sort -z}, and @samp{xargs -0} to process arbitrary file names,
even those that contain newline characters.

@item -z
@itemx --null-data
@opindex -z
@opindex --null-data
@cindex zero-terminated lines
Treat the input as a set of lines, each terminated by a zero byte (the
@sc{ASCII} @sc{NUL} character) instead of a newline.  Like the @samp{-Z}
or @samp{--null} option, this option can be used with commands like
@samp{sort -z} to process arbitrary file names.

@end table

Several additional options control which variant of the @sc{grep}
matching engine is used.  @xref{Grep Programs}.

Grep's behavior is affected by the following environment variables.
@cindex environment variables

@table @code

@item GREP_OPTIONS
@vindex GREP_OPTIONS
@cindex default options environment variable
This variable specifies default options to be placed in front of any
explicit options.  For example, if @code{GREP_OPTIONS} is @samp{--text
--directories=skip}, @sc{grep} behaves as if the two options
@samp{--text} and @samp{--directories=skip} had been specified before
any explicit options.  Option specifications are separated by
whitespace.  A backslash escapes the next character, so it can be used to
specify an option containing whitespace or a backslash.

@item LC_ALL
@itemx LC_MESSAGES
@itemx LANG
@vindex LC_ALL
@vindex LC_MESSAGES
@vindex LANG
@cindex language of messages
@cindex message language
@cindex national language support
@cindex NLS
@cindex translation of message language
These variables specify the @code{LC_MESSAGES} locale, which determines
the language that @sc{grep} uses for messages.  The locale is determined
by the first of these variables that is set.  American English is used
if none of these environment variables are set, or if the message
catalog is not installed, or if @sc{grep} was not compiled with national
language support (NLS).

@item LC_ALL
@itemx LC_CTYPE
@itemx LANG
@vindex LC_ALL
@vindex LC_CTYPE
@vindex LANG
@cindex character type
@cindex national language support
@cindex NLS
These variables specify the @code{LC_CTYPE} locale, which determines the
type of characters, e.g. which characters are whitespace.  The locale is
determined by the first of these variables that is set.  The POSIX
locale is used if none of these environment variables are set, or if the
locale catalog is not installed, or if @sc{grep} was not compiled with
national language support (NLS).

@item POSIXLY_CORRECT
@vindex POSIXLY_CORRECT
If set, @sc{grep} behaves as POSIX.2 requires; otherwise, @sc{grep}
behaves more like other GNU programs.  POSIX.2 requires that options that
follow file names must be treated as file names; by default, such
options are permuted to the front of the operand list and are treated as
options.  Also, POSIX.2 requires that unrecognized options be diagnosed as
``illegal'', but since they are not really against the law the default
is to diagnose them as ``invalid''.  @code{POSIXLY_CORRECT} also
disables @code{_@var{N}_GNU_nonoption_argv_flags_}, described below.

@item _@var{N}_GNU_nonoption_argv_flags_
@vindex _@var{N}_GNU_nonoption_argv_flags_
(Here @code{@var{N}} is @sc{grep}'s numeric process ID.)  If the
@var{i}th character of this environment variable's value is @samp{1}, do
not consider the @var{i}th operand of @sc{grep} to be an option, even if
it appears to be one.  A shell can put this variable in the environment
for each command it runs, specifying which operands are the results of
file name wildcard expansion and therefore should not be treated as
options.  This behavior is available only with the GNU C library, and
only when @code{POSIXLY_CORRECT} is not set.

@end table

@node Diagnostics, Grep Programs, Invoking, Top
@comment  node-name,  next,  previous,  up
@chapter Diagnostics
Normally, exit status is 0 if matches were found, and 1 if no matches
were found (the @samp{-v} option inverts the sense of the exit status).
Exit status is 2  if  there  were  syntax errors  in  the  pattern,
inaccessible input files, or other system errors.

@node Grep Programs, Regular Expressions, Diagnostics, Top
@comment  node-name,  next,  previous,  up
@chapter @sc{grep} programs

@sc{grep} searches the named input files (or standard input if no
files are named, or the file name @file{-} is given) for lines containing
a match to the given pattern.  By default, @sc{grep} prints the matching lines.
There are three major variants of @sc{grep}, controlled by the following options.

@table @samp

@item -G
@itemx --basic-regexp
@opindex -G
@opindex --basic-regexp
@cindex matching basic regular expressions
Interpret pattern as a basic  regular  expression.  This is the default.

@item -E
@item --extended-regexp
@opindex -E
@opindex --extended-regexp
@cindex matching extended regular expressions
Interpret pattern as  an  extended  regular  expression.


@item -F
@itemx --fixed-strings
@opindex -F
@opindex --fixed-strings
@cindex matching fixed strings
Interpret pattern as a list of fixed strings, separated
by newlines, any of which is to be matched.

@end table

In addition, two variant programs @sc{egrep} and @sc{fgrep} are available.
@sc{egrep} is the same as @samp{grep -E}.  @sc{fgrep} is the
same as @samp{grep -F}.

@node Regular Expressions, Reporting Bugs, Grep Programs, Top
@comment  node-name,  next,  previous,  up
@chapter Regular Expressions
@cindex regular expressions

A @dfn{regular expression} is a pattern that describes  a  set  of strings.
Regular expressions are constructed analogously to arithmetic expressions,
by using various operators  to  combine smaller expressions.
@sc{grep} understands two different versions of  regular  expression
syntax:   ``basic''  and  ``extended''.  In GNU @sc{grep}, there is no
difference  in  available  functionality  using either  syntax.
In  other  implementations,  basic regular expressions are less powerful.
The  following  description applies  to  extended  regular  expressions;
differences for basic regular expressions are summarized afterwards.

The fundamental building blocks are the regular  expressions that  match
a single character.  Most characters, including all letters and digits,
are regular expressions  that  match themselves.  Any  metacharacter
with special meaning may be quoted by preceding it with a backslash.
A list of characters enclosed by @samp{[} and @samp{]} matches any
single character in that list; if the first character of the list is the
caret @samp{^}, then it 
matches any character @strong{not} in the list.  For example, the regular
expression @samp{[0123456789]} matches any single digit.
A range of @sc{ascii} characters may be specified by giving the first
and last characters, separated by a hyphen.

Finally, certain named classes of characters are predefined, as follows.
Their interpretation depends on the @code{LC_CTYPE} locale; the
interpretation below is that of the POSIX locale, which is the default
if no @code{LC_CTYPE} locale is specified.

@cindex classes of characters
@cindex character classes
@table @samp

@item [:alnum:]
@opindex alnum 
@cindex  alphanumeric characters
Any of [:digit:] or [:alpha:]

@item [:alpha:]
@opindex alpha
@cindex alphabetic characters
Any letter:@*
@code{a b c d e f g h i j k l m n o p q r s t u v w x y z},@*
@code{A B C D E F G H I J K L M N O P Q R S T U V W X Y Z}.

@item [:blank:]
@opindex blank
@cindex blank characters
Space or tab.

@item [:cntrl:]
@opindex cntrl
@cindex control characters
Any character with octal codes 000 through 037, or @code{DEL} (octal
code 177).

@item [:digit:]
@opindex digit
@cindex digit characters
@cindex numeric characters
Any one of @code{0 1 2 3 4 5 6 7 8 9}.

@item [:graph:]
@opindex graph
@cindex graphic characters
Anything that is not a @samp{[:alphanum:]} or @samp{[:punct:]}.

@item [:lower:]
@opindex lower
@cindex lower-case alphabetic characters
Any one of @code{a b c d e f g h i j k l m n o p q r s t u v w x y z}.

@item [:print:]
@opindex print
@cindex printable characters
Any character from the @samp{[:space:]} class, and any character that is
@strong{not} in the @samp{[:isgraph:]} class.

@item [:punct:]
@opindex punct
@cindex punctuation characters
Any one of @code{!@: " # $ % & ' ( ) * + , - .@: / : ; < = > ?@: @@ [ \ ] ^ _ ` @{ | @} ~}.

@item [:space:]
@opindex space
@cindex space characters
@cindex whitespace characters
Any one of @code{CR FF HT NL VT SPACE}.

@item [:upper:]
@opindex upper
@cindex upper-case alphabetic characters
Any one of @code{A B C D E F G H I J K L M N O P Q R S T U V W X Y Z}.

@item [:xdigit:]
@opindex xdigit
@cindex xdigit class
@cindex hexadecimal digits
Any one of @code{a b c d e f A B C D E F 0 1 2 3 4 5 6 7 8 9}.

@end table
For example, @samp{[[:alnum:]]} means @samp{[0-9A-Za-z]}, except the latter
form is dependent upon the @sc{ascii} character  encoding,  whereas  the
former  is portable.  (Note that the brackets in these class names are
part of the symbolic names, and must  be  included in  addition  to
the brackets delimiting the bracket list).  Most metacharacters lose
their special meaning inside lists.  To include a literal @samp{]}, place it
first in the list.  Similarly, to include a literal @samp{^}, place it anywhere
but  first.  Finally, to include a literal @samp{-}, place it last.

The period @samp{.} matches any single character.  The symbol @samp{\w}
is a synonym for @samp{[[:alnum:]]} and @samp{\W} is a synonym for
@samp{[^[:alnum]]}.

The caret @samp{^} and the dollar sign @samp{$} are metacharacters that
respectively match the empty string at the beginning and end
of a line.  The symbols @samp{\<} and  @samp{\>} respectively match the
empty string at the beginning and end of a word.  The symbol
@samp{\b} matches the empty string at the edge of a  word,  and  @samp{\B}
matches  the empty string provided it's not at the edge of a word.

A regular expression may  be  followed  by  one  of  several
repetition operators:


@table @samp

@item ?
@opindex ?
@cindex question mark
@cindex match sub-expression at most once
The preceding item is optional and will be matched at most once.

@item *
@opindex *
@cindex asterisk
@cindex match sub-expression zero or more times
The preceding item will be matched zero or more times.

@item +
@opindex +
@cindex plus sign 
The preceding item will be matched one or more times.

@item @{@var{n}@}
@opindex @{n@}
@cindex braces, one argument
@cindex match sub-expression n times
The preceding item is matched exactly @var{n} times.

@item @{@var{n},@}
@opindex @{n,@}
@cindex braces, second argument omitted
@cindex match sub-expression n or more times
The preceding item is matched n or more times.

@item @{@var{n},@var{m}@}
@opindex @{n,m@}
@cindex braces, two arguments
The preceding item is matched at least @var{n} times, but not more than
@var{m} times.

@end table

Two regular expressions may be concatenated;  the  resulting regular
expression matches any string formed by concatenating two substrings
that respectively match the  concatenated subexpressions.

Two regular expressions may be joined by the infix  operator @samp{|}; the
resulting  regular  expression  matches  any string matching either
subexpression.

Repetition takes precedence  over  concatenation,  which  in turn
takes precedence over alternation.  A whole subexpression may be
enclosed in parentheses to override  these  precedence rules.

The backreference @samp{\@var{n}}, where @var{n} is a single digit, matches the
substring previously matched by the @var{n}th parenthesized subexpression
of the regular expression.

@cindex basic regular expressions
In basic regular expressions the metacharacters @samp{?}, @samp{+},
@samp{@{}, @samp{|}, @samp{(}, and @samp{)} lose their special meaning;
instead use the backslashed versions @samp{\?}, @samp{\+}, @samp{\@{},
@samp{\|}, @samp{\(}, and @samp{\)}.

@cindex interval specifications
There is a longstanding minor compatibility problem with regular
expressions like @samp{x@{2,8@}} that use interval specifications.
Traditional @command{egrep} did not support interval specifications, but
@sc{posix} requires them, and says that the effect of regular
expressions like @samp{x@{,8@}} or @samp{(@{2,8@})} is undefined because
their interval specifications are invalid.  In @command{grep} 2.3 and
earlier, @samp{grep -E} acted as @sc{posix} required, but it reported an
error when it encountered a @samp{@{} that was not the prefix of a valid
interval specification.  Had @command{egrep} 2.3 been equivalent to
@samp{grep -E}, it would have broken old-fashioned scripts that assume
that @samp{@{} is not special in egrep patterns.  So @command{egrep} 2.3
and earlier did not support interval specifications, even though
@sc{posix} required it.

This compatibility problem has been addressed by changing @samp{grep -E}
to be less pedantic about invalid interval specifications.  Instead of
reporting an error, @samp{grep -E} assumes that @samp{@{} is not special
if it would be the start of an invalid interval specification.  For
example, @samp{grep -E @{1} now searches for the two-character string
@samp{@{1} instead of reporting a syntax error in the regular
expression.  @sc{posix} allows this behavior as an extension, and it is
more compatible with what old-fashioned scripts expect of
@command{egrep}.

The new behavior is incompatible with the traditional behavior in the
rare cases where @sc{posix} requires it.  For example, @samp{egrep
x@{5@}} is now equivalent to @samp{egrep xxxxx} as required by
@sc{posix}, whereas it formerly was equivalent to @samp{egrep
'x\@{5\@}'}.  Incompatibilities like these occur only when a valid
interval specification is found, not merely when @samp{@{} is found.

This new behavior exists only to support old scripts that do not conform
to @sc{posix}.  @sc{posix} does not define the behavior of invalid
interval specifications, and other @command{grep} implementations have
differing behavior in this area, so new scripts should avoid them.


@node Reporting Bugs, Concept Index, Regular Expressions, Top
@comment  node-name,  next,  previous,  up
@chapter Reporting bugs

@cindex Bugs, reporting
Email bug reports to @email{bug-gnu-utils@@gnu.org}.
Be sure to include the word ``grep'' somewhere in the ``Subject:'' field.

Large repetition counts in the  @samp{@{m,n@}}  construct  may  cause
@sc{grep}  to  use  lots  of  memory.  In addition, certain other
obscure regular expressions  require  exponential  time  and
space, and may cause grep to run out of memory.
Backreferences are very slow, and  may  require  exponential time.

@page
@node Concept Index , Index, Reporting Bugs, Top
@comment node-name,  next,  previous,  up
@unnumbered Concept Index

This is a general index of all issues discussed in this manual, with the
exception of the @sc{grep} commands and command-line options.

@printindex cp

@page
@node Index, , Concept Index, Top
@unnumbered Index

This is an alphabetical list of all @sc{grep} commands, command-line
options, and environment variables.

@printindex fn

@contents
@bye