doc/regexprops-generic.texi

   1 @c Copyright (C) 1994, 1996, 1998, 2000--2001, 2003--2007, 2009--2024 Free
   2 @c Software Foundation, Inc.
   3 @c
   4 @c Permission is granted to copy, distribute and/or modify this document
   5 @c under the terms of the GNU Free Documentation License, Version 1.3 or
   6 @c any later version published by the Free Software Foundation; with no
   7 @c Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.  A
   8 @c copy of the license is at <https://www.gnu.org/licenses/fdl-1.3.en.html>.
   9
  10 @c this regular expression description is for: generic
  11
  12 @menu
  13 * awk regular expression syntax::
  14 * egrep regular expression syntax::
  15 * ed regular expression syntax::
  16 * emacs regular expression syntax::
  17 * gnu-awk regular expression syntax::
  18 * grep regular expression syntax::
  19 * posix-awk regular expression syntax::
  20 * posix-basic regular expression syntax::
  21 * posix-egrep regular expression syntax::
  22 * posix-extended regular expression syntax::
  23 * posix-minimal-basic regular expression syntax::
  24 * sed regular expression syntax::
  25 @end menu
  26
  27 @node awk regular expression syntax
  28 @subsection @samp{awk} regular expression syntax
  29
  30
  31 The character @samp{.} matches any single character except the null character.
  32
  33
  34 @table @samp
  35
  36 @item +
  37 indicates that the regular expression should match one or more occurrences of the previous atom or regexp.
  38 @item ?
  39 indicates that the regular expression should match zero or one occurrence of the previous atom or regexp.
  40 @item \+
  41 matches a @samp{+}
  42 @item \?
  43 matches a @samp{?}.
  44 @end table
  45
  46
  47 Bracket expressions are used to match ranges of characters.  Bracket expressions where the range is backward, for example @samp{[z-a]}, are invalid.  Within square brackets, @samp{\} can be used to quote the following character.  Character classes are supported; for example @samp{[[:digit:]]} will match a single decimal digit.
  48
  49 GNU extensions are not supported and so @samp{\w}, @samp{\W}, @samp{\<}, @samp{\>}, @samp{\b}, @samp{\B}, @samp{\`}, and @samp{\'} match @samp{w}, @samp{W}, @samp{<}, @samp{>}, @samp{b}, @samp{B}, @samp{`}, and @samp{'} respectively.
  50
  51 Grouping is performed with parentheses @samp{()}.  An unmatched @samp{)} matches just itself.  A backslash followed by a digit matches that digit.
  52
  53 The alternation operator is @samp{|}.
  54
  55 The characters @samp{^} and @samp{$} always represent the beginning and end of a string respectively, except within square brackets.  Within brackets, @samp{^} can be used to invert the membership of the character class being specified.
  56
  57 @samp{*}, @samp{+} and @samp{?} are special at any point in a regular expression except:
  58 @enumerate
  59
  60 @item At the beginning of a regular expression
  61
  62 @item After an open-group, signified by
  63 @samp{(}
  64 @item After the alternation operator @samp{|}
  65
  66 @end enumerate
  67
  68
  69
  70
  71 The longest possible match is returned; this applies to the regular expression as a whole and (subject to this constraint) to subexpressions within groups.
  72
  73
  74 @node egrep regular expression syntax
  75 @subsection @samp{egrep} regular expression syntax
  76
  77
  78 The character @samp{.} matches any single character.
  79
  80
  81 @table @samp
  82
  83 @item +
  84 indicates that the regular expression should match one or more occurrences of the previous atom or regexp.
  85 @item ?
  86 indicates that the regular expression should match zero or one occurrence of the previous atom or regexp.
  87 @item \+
  88 matches a @samp{+}
  89 @item \?
  90 matches a @samp{?}.
  91 @end table
  92
  93
  94 Bracket expressions are used to match ranges of characters.  Bracket expressions where the range is backward, for example @samp{[z-a]}, are invalid.  Within square brackets, @samp{\} is taken literally.  Character classes are supported; for example @samp{[[:digit:]]} will match a single decimal digit.
  95
  96 GNU extensions are supported:
  97 @enumerate
  98
  99 @item @samp{\w} matches a character within a word
 100
 101 @item @samp{\W} matches a character which is not within a word
 102
 103 @item @samp{\<} matches the beginning of a word
 104
 105 @item @samp{\>} matches the end of a word
 106
 107 @item @samp{\b} matches a word boundary
 108
 109 @item @samp{\B} matches characters which are not a word boundary
 110
 111 @item @samp{\`} matches the beginning of the whole input
 112
 113 @item @samp{\'} matches the end of the whole input
 114
 115 @end enumerate
 116
 117
 118 Grouping is performed with parentheses @samp{()}.  An unmatched @samp{)} matches just itself.  A backslash followed by a digit acts as a back-reference and matches the same thing as the previous grouped expression indicated by that number.  For example @samp{\2} matches the second group expression.  The order of group expressions is determined by the position of their opening parenthesis @samp{(}.
 119
 120 The alternation operator is @samp{|}.
 121
 122 The characters @samp{^} and @samp{$} always represent the beginning and end of a string respectively, except within square brackets.  Within brackets, @samp{^} can be used to invert the membership of the character class being specified.
 123
 124 The characters @samp{*}, @samp{+} and @samp{?} are special anywhere in a regular expression.
 125
 126 Intervals are specified by @samp{@{} and @samp{@}}.  Invalid intervals are treated as literals, for example @samp{a@{1} is treated as @samp{a\@{1}
 127
 128 The longest possible match is returned; this applies to the regular expression as a whole and (subject to this constraint) to subexpressions within groups.
 129
 130
 131 @node ed regular expression syntax
 132 @subsection @samp{ed} regular expression syntax
 133
 134
 135 The character @samp{.} matches any single character except the null character.
 136
 137
 138 @table @samp
 139
 140 @item \+
 141 indicates that the regular expression should match one or more occurrences of the previous atom or regexp.
 142 @item \?
 143 indicates that the regular expression should match zero or one occurrence of the previous atom or regexp.
 144 @item + and ?
 145 match themselves.
 146 @end table
 147
 148
 149 Bracket expressions are used to match ranges of characters.  Bracket expressions where the range is backward, for example @samp{[z-a]}, are invalid.  Within square brackets, @samp{\} is taken literally.  Character classes are supported; for example @samp{[[:digit:]]} will match a single decimal digit.
 150
 151 GNU extensions are supported:
 152 @enumerate
 153
 154 @item @samp{\w} matches a character within a word
 155
 156 @item @samp{\W} matches a character which is not within a word
 157
 158 @item @samp{\<} matches the beginning of a word
 159
 160 @item @samp{\>} matches the end of a word
 161
 162 @item @samp{\b} matches a word boundary
 163
 164 @item @samp{\B} matches characters which are not a word boundary
 165
 166 @item @samp{\`} matches the beginning of the whole input
 167
 168 @item @samp{\'} matches the end of the whole input
 169
 170 @end enumerate
 171
 172
 173 Grouping is performed with backslashes followed by parentheses @samp{\(}, @samp{\)}.  A backslash followed by a digit acts as a back-reference and matches the same thing as the previous grouped expression indicated by that number.  For example @samp{\2} matches the second group expression.  The order of group expressions is determined by the position of their opening parenthesis @samp{\(}.
 174
 175 The alternation operator is @samp{\|}.
 176
 177 The character @samp{^} only represents the beginning of a string when it appears:
 178 @enumerate
 179
 180 @item
 181 At the beginning of a regular expression
 182
 183 @item After an open-group, signified by
 184 @samp{\(}
 185
 186 @item After the alternation operator @samp{\|}
 187
 188 @end enumerate
 189
 190
 191 The character @samp{$} only represents the end of a string when it appears:
 192 @enumerate
 193
 194 @item At the end of a regular expression
 195
 196 @item Before a close-group, signified by
 197 @samp{\)}
 198 @item Before the alternation operator @samp{\|}
 199
 200 @end enumerate
 201
 202
 203 @samp{\*}, @samp{\+} and @samp{\?} are special at any point in a regular expression except:
 204 @enumerate
 205
 206 @item At the beginning of a regular expression
 207
 208 @item After an open-group, signified by
 209 @samp{\(}
 210 @item After the alternation operator @samp{\|}
 211
 212 @end enumerate
 213
 214
 215 Intervals are specified by @samp{\@{} and @samp{\@}}.  Invalid intervals such as @samp{a\@{1z} are not accepted.
 216
 217 The longest possible match is returned; this applies to the regular expression as a whole and (subject to this constraint) to subexpressions within groups.
 218
 219
 220 @node emacs regular expression syntax
 221 @subsection @samp{emacs} regular expression syntax
 222
 223
 224 The character @samp{.} matches any single character except newline.
 225
 226
 227 @table @samp
 228
 229 @item +
 230 indicates that the regular expression should match one or more occurrences of the previous atom or regexp.
 231 @item ?
 232 indicates that the regular expression should match zero or one occurrence of the previous atom or regexp.
 233 @item \+
 234 matches a @samp{+}
 235 @item \?
 236 matches a @samp{?}.
 237 @end table
 238
 239
 240 Bracket expressions are used to match ranges of characters.  Bracket expressions where the range is backward, for example @samp{[z-a]}, are ignored.  Within square brackets, @samp{\} is taken literally.  Character classes are not supported, so for example you would need to use @samp{[0-9]} instead of @samp{[[:digit:]]}.
 241
 242 GNU extensions are supported:
 243 @enumerate
 244
 245 @item @samp{\w} matches a character within a word
 246
 247 @item @samp{\W} matches a character which is not within a word
 248
 249 @item @samp{\<} matches the beginning of a word
 250
 251 @item @samp{\>} matches the end of a word
 252
 253 @item @samp{\b} matches a word boundary
 254
 255 @item @samp{\B} matches characters which are not a word boundary
 256
 257 @item @samp{\`} matches the beginning of the whole input
 258
 259 @item @samp{\'} matches the end of the whole input
 260
 261 @end enumerate
 262
 263
 264 Grouping is performed with backslashes followed by parentheses @samp{\(}, @samp{\)}.  A backslash followed by a digit acts as a back-reference and matches the same thing as the previous grouped expression indicated by that number.  For example @samp{\2} matches the second group expression.  The order of group expressions is determined by the position of their opening parenthesis @samp{\(}.
 265
 266 The alternation operator is @samp{\|}.
 267
 268 The character @samp{^} only represents the beginning of a string when it appears:
 269 @enumerate
 270
 271 @item
 272 At the beginning of a regular expression
 273
 274 @item After an open-group, signified by
 275 @samp{\(}
 276
 277 @item After the alternation operator @samp{\|}
 278
 279 @end enumerate
 280
 281
 282 The character @samp{$} only represents the end of a string when it appears:
 283 @enumerate
 284
 285 @item At the end of a regular expression
 286
 287 @item Before a close-group, signified by
 288 @samp{\)}
 289 @item Before the alternation operator @samp{\|}
 290
 291 @end enumerate
 292
 293
 294 @samp{*}, @samp{+} and @samp{?} are special at any point in a regular expression except:
 295 @enumerate
 296
 297 @item At the beginning of a regular expression
 298
 299 @item After an open-group, signified by
 300 @samp{\(}
 301 @item After the alternation operator @samp{\|}
 302
 303 @end enumerate
 304
 305
 306
 307
 308 The longest possible match is returned; this applies to the regular expression as a whole and (subject to this constraint) to subexpressions within groups.
 309
 310
 311 @node gnu-awk regular expression syntax
 312 @subsection @samp{gnu-awk} regular expression syntax
 313
 314
 315 The character @samp{.} matches any single character.
 316
 317
 318 @table @samp
 319
 320 @item +
 321 indicates that the regular expression should match one or more occurrences of the previous atom or regexp.
 322 @item ?
 323 indicates that the regular expression should match zero or one occurrence of the previous atom or regexp.
 324 @item \+
 325 matches a @samp{+}
 326 @item \?
 327 matches a @samp{?}.
 328 @end table
 329
 330
 331 Bracket expressions are used to match ranges of characters.  Bracket expressions where the range is backward, for example @samp{[z-a]}, are invalid.  Within square brackets, @samp{\} can be used to quote the following character.  Character classes are supported; for example @samp{[[:digit:]]} will match a single decimal digit.
 332
 333 GNU extensions are supported:
 334 @enumerate
 335
 336 @item @samp{\w} matches a character within a word
 337
 338 @item @samp{\W} matches a character which is not within a word
 339
 340 @item @samp{\<} matches the beginning of a word
 341
 342 @item @samp{\>} matches the end of a word
 343
 344 @item @samp{\b} matches a word boundary
 345
 346 @item @samp{\B} matches characters which are not a word boundary
 347
 348 @item @samp{\`} matches the beginning of the whole input
 349
 350 @item @samp{\'} matches the end of the whole input
 351
 352 @end enumerate
 353
 354
 355 Grouping is performed with parentheses @samp{()}.  An unmatched @samp{)} matches just itself.  A backslash followed by a digit acts as a back-reference and matches the same thing as the previous grouped expression indicated by that number.  For example @samp{\2} matches the second group expression.  The order of group expressions is determined by the position of their opening parenthesis @samp{(}.
 356
 357 The alternation operator is @samp{|}.
 358
 359 The characters @samp{^} and @samp{$} always represent the beginning and end of a string respectively, except within square brackets.  Within brackets, @samp{^} can be used to invert the membership of the character class being specified.
 360
 361 @samp{*}, @samp{+} and @samp{?} are special at any point in a regular expression except:
 362 @enumerate
 363
 364 @item At the beginning of a regular expression
 365
 366 @item After an open-group, signified by
 367 @samp{(}
 368 @item After the alternation operator @samp{|}
 369
 370 @end enumerate
 371
 372
 373 Intervals are specified by @samp{@{} and @samp{@}}.  Invalid intervals are treated as literals, for example @samp{a@{1} is treated as @samp{a\@{1}
 374
 375 The longest possible match is returned; this applies to the regular expression as a whole and (subject to this constraint) to subexpressions within groups.
 376
 377
 378 @node grep regular expression syntax
 379 @subsection @samp{grep} regular expression syntax
 380
 381
 382 The character @samp{.} matches any single character.
 383
 384
 385 @table @samp
 386
 387 @item \+
 388 indicates that the regular expression should match one or more occurrences of the previous atom or regexp.
 389 @item \?
 390 indicates that the regular expression should match zero or one occurrence of the previous atom or regexp.
 391 @item + and ?
 392 match themselves.
 393 @end table
 394
 395
 396 Bracket expressions are used to match ranges of characters.  Bracket expressions where the range is backward, for example @samp{[z-a]}, are invalid.  Within square brackets, @samp{\} is taken literally.  Character classes are supported; for example @samp{[[:digit:]]} will match a single decimal digit.
 397
 398 GNU extensions are supported:
 399 @enumerate
 400
 401 @item @samp{\w} matches a character within a word
 402
 403 @item @samp{\W} matches a character which is not within a word
 404
 405 @item @samp{\<} matches the beginning of a word
 406
 407 @item @samp{\>} matches the end of a word
 408
 409 @item @samp{\b} matches a word boundary
 410
 411 @item @samp{\B} matches characters which are not a word boundary
 412
 413 @item @samp{\`} matches the beginning of the whole input
 414
 415 @item @samp{\'} matches the end of the whole input
 416
 417 @end enumerate
 418
 419
 420 Grouping is performed with backslashes followed by parentheses @samp{\(}, @samp{\)}.  A backslash followed by a digit acts as a back-reference and matches the same thing as the previous grouped expression indicated by that number.  For example @samp{\2} matches the second group expression.  The order of group expressions is determined by the position of their opening parenthesis @samp{\(}.
 421
 422 The alternation operator is @samp{\|}.
 423
 424 The character @samp{^} only represents the beginning of a string when it appears:
 425 @enumerate
 426
 427 @item
 428 At the beginning of a regular expression
 429
 430 @item After an open-group, signified by
 431 @samp{\(}
 432
 433 @item After a newline
 434
 435 @item After the alternation operator @samp{\|}
 436
 437 @end enumerate
 438
 439
 440 The character @samp{$} only represents the end of a string when it appears:
 441 @enumerate
 442
 443 @item At the end of a regular expression
 444
 445 @item Before a close-group, signified by
 446 @samp{\)}
 447 @item Before a newline
 448
 449 @item Before the alternation operator @samp{\|}
 450
 451 @end enumerate
 452
 453
 454 @samp{\*}, @samp{\+} and @samp{\?} are special at any point in a regular expression except:
 455 @enumerate
 456
 457 @item At the beginning of a regular expression
 458
 459 @item After an open-group, signified by
 460 @samp{\(}
 461 @item After a newline
 462
 463 @item After the alternation operator @samp{\|}
 464
 465 @end enumerate
 466
 467
 468 Intervals are specified by @samp{\@{} and @samp{\@}}.  Invalid intervals such as @samp{a\@{1z} are not accepted.
 469
 470 The longest possible match is returned; this applies to the regular expression as a whole and (subject to this constraint) to subexpressions within groups.
 471
 472
 473 @node posix-awk regular expression syntax
 474 @subsection @samp{posix-awk} regular expression syntax
 475
 476
 477 The character @samp{.} matches any single character except the null character.
 478
 479
 480 @table @samp
 481
 482 @item +
 483 indicates that the regular expression should match one or more occurrences of the previous atom or regexp.
 484 @item ?
 485 indicates that the regular expression should match zero or one occurrence of the previous atom or regexp.
 486 @item \+
 487 matches a @samp{+}
 488 @item \?
 489 matches a @samp{?}.
 490 @end table
 491
 492
 493 Bracket expressions are used to match ranges of characters.  Bracket expressions where the range is backward, for example @samp{[z-a]}, are invalid.  Within square brackets, @samp{\} can be used to quote the following character.  Character classes are supported; for example @samp{[[:digit:]]} will match a single decimal digit.
 494
 495 GNU extensions are not supported and so @samp{\w}, @samp{\W}, @samp{\<}, @samp{\>}, @samp{\b}, @samp{\B}, @samp{\`}, and @samp{\'} match @samp{w}, @samp{W}, @samp{<}, @samp{>}, @samp{b}, @samp{B}, @samp{`}, and @samp{'} respectively.
 496
 497 Grouping is performed with parentheses @samp{()}.  An unmatched @samp{)} matches just itself.  A backslash followed by a digit acts as a back-reference and matches the same thing as the previous grouped expression indicated by that number.  For example @samp{\2} matches the second group expression.  The order of group expressions is determined by the position of their opening parenthesis @samp{(}.
 498
 499 The alternation operator is @samp{|}.
 500
 501 The characters @samp{^} and @samp{$} always represent the beginning and end of a string respectively, except within square brackets.  Within brackets, @samp{^} can be used to invert the membership of the character class being specified.
 502
 503 @samp{*}, @samp{+} and @samp{?} are special at any point in a regular expression except the following places, where they are not allowed:
 504 @enumerate
 505
 506 @item At the beginning of a regular expression
 507
 508 @item After an open-group, signified by
 509 @samp{(}
 510 @item After the alternation operator @samp{|}
 511
 512 @end enumerate
 513
 514
 515 Intervals are specified by @samp{@{} and @samp{@}}.  Invalid intervals are treated as literals, for example @samp{a@{1} is treated as @samp{a\@{1}
 516
 517 The longest possible match is returned; this applies to the regular expression as a whole and (subject to this constraint) to subexpressions within groups.
 518
 519
 520 @node posix-basic regular expression syntax
 521 @subsection @samp{posix-basic} regular expression syntax
 522 This is a synonym for ed.
 523 @node posix-egrep regular expression syntax
 524 @subsection @samp{posix-egrep} regular expression syntax
 525 This is a synonym for egrep.
 526 @node posix-extended regular expression syntax
 527 @subsection @samp{posix-extended} regular expression syntax
 528
 529
 530 The character @samp{.} matches any single character except the null character.
 531
 532
 533 @table @samp
 534
 535 @item +
 536 indicates that the regular expression should match one or more occurrences of the previous atom or regexp.
 537 @item ?
 538 indicates that the regular expression should match zero or one occurrence of the previous atom or regexp.
 539 @item \+
 540 matches a @samp{+}
 541 @item \?
 542 matches a @samp{?}.
 543 @end table
 544
 545
 546 Bracket expressions are used to match ranges of characters.  Bracket expressions where the range is backward, for example @samp{[z-a]}, are invalid.  Within square brackets, @samp{\} is taken literally.  Character classes are supported; for example @samp{[[:digit:]]} will match a single decimal digit.
 547
 548 GNU extensions are supported:
 549 @enumerate
 550
 551 @item @samp{\w} matches a character within a word
 552
 553 @item @samp{\W} matches a character which is not within a word
 554
 555 @item @samp{\<} matches the beginning of a word
 556
 557 @item @samp{\>} matches the end of a word
 558
 559 @item @samp{\b} matches a word boundary
 560
 561 @item @samp{\B} matches characters which are not a word boundary
 562
 563 @item @samp{\`} matches the beginning of the whole input
 564
 565 @item @samp{\'} matches the end of the whole input
 566
 567 @end enumerate
 568
 569
 570 Grouping is performed with parentheses @samp{()}.  An unmatched @samp{)} matches just itself.  A backslash followed by a digit acts as a back-reference and matches the same thing as the previous grouped expression indicated by that number.  For example @samp{\2} matches the second group expression.  The order of group expressions is determined by the position of their opening parenthesis @samp{(}.
 571
 572 The alternation operator is @samp{|}.
 573
 574 The characters @samp{^} and @samp{$} always represent the beginning and end of a string respectively, except within square brackets.  Within brackets, @samp{^} can be used to invert the membership of the character class being specified.
 575
 576 @samp{*}, @samp{+} and @samp{?} are special at any point in a regular expression except the following places, where they are not allowed:
 577 @enumerate
 578
 579 @item At the beginning of a regular expression
 580
 581 @item After an open-group, signified by
 582 @samp{(}
 583 @item After the alternation operator @samp{|}
 584
 585 @end enumerate
 586
 587
 588 Intervals are specified by @samp{@{} and @samp{@}}.  Invalid intervals such as @samp{a@{1z} are not accepted.
 589
 590 The longest possible match is returned; this applies to the regular expression as a whole and (subject to this constraint) to subexpressions within groups.
 591
 592
 593 @node posix-minimal-basic regular expression syntax
 594 @subsection @samp{posix-minimal-basic} regular expression syntax
 595
 596
 597 The character @samp{.} matches any single character except the null character.
 598
 599
 600
 601 Bracket expressions are used to match ranges of characters.  Bracket expressions where the range is backward, for example @samp{[z-a]}, are invalid.  Within square brackets, @samp{\} is taken literally.  Character classes are supported; for example @samp{[[:digit:]]} will match a single decimal digit.
 602
 603 GNU extensions are supported:
 604 @enumerate
 605
 606 @item @samp{\w} matches a character within a word
 607
 608 @item @samp{\W} matches a character which is not within a word
 609
 610 @item @samp{\<} matches the beginning of a word
 611
 612 @item @samp{\>} matches the end of a word
 613
 614 @item @samp{\b} matches a word boundary
 615
 616 @item @samp{\B} matches characters which are not a word boundary
 617
 618 @item @samp{\`} matches the beginning of the whole input
 619
 620 @item @samp{\'} matches the end of the whole input
 621
 622 @end enumerate
 623
 624
 625 Grouping is performed with backslashes followed by parentheses @samp{\(}, @samp{\)}.  A backslash followed by a digit acts as a back-reference and matches the same thing as the previous grouped expression indicated by that number.  For example @samp{\2} matches the second group expression.  The order of group expressions is determined by the position of their opening parenthesis @samp{\(}.
 626
 627
 628
 629 The character @samp{^} only represents the beginning of a string when it appears:
 630 @enumerate
 631
 632 @item
 633 At the beginning of a regular expression
 634
 635 @item After an open-group, signified by
 636 @samp{\(}
 637
 638 @end enumerate
 639
 640
 641 The character @samp{$} only represents the end of a string when it appears:
 642 @enumerate
 643
 644 @item At the end of a regular expression
 645
 646 @item Before a close-group, signified by
 647 @samp{\)}
 648 @end enumerate
 649
 650
 651
 652
 653 Intervals are specified by @samp{\@{} and @samp{\@}}.  Invalid intervals such as @samp{a\@{1z} are not accepted.
 654
 655 The longest possible match is returned; this applies to the regular expression as a whole and (subject to this constraint) to subexpressions within groups.
 656
 657
 658 @node sed regular expression syntax
 659 @subsection @samp{sed} regular expression syntax
 660 This is a synonym for ed.