util/X86LINUX64/man/mann/regexp.n

   1 '\"
   2 '\" Copyright (c) 1998 Sun Microsystems, Inc.
   3 '\"
   4 '\" See the file "license.terms" for information on usage and redistribution
   5 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
   6 '\"
   7 .TH regexp n 8.3 Tcl "Tcl Built-In Commands"
   8 .\" The -*- nroff -*- definitions below are for supplemental macros used
   9 .\" in Tcl/Tk manual entries.
  10 .\"
  11 .\" .AP type name in/out ?indent?
  12 .\"     Start paragraph describing an argument to a library procedure.
  13 .\"     type is type of argument (int, etc.), in/out is either "in", "out",
  14 .\"     or "in/out" to describe whether procedure reads or modifies arg,
  15 .\"     and indent is equivalent to second arg of .IP (shouldn't ever be
  16 .\"     needed;  use .AS below instead)
  17 .\"
  18 .\" .AS ?type? ?name?
  19 .\"     Give maximum sizes of arguments for setting tab stops.  Type and
  20 .\"     name are examples of largest possible arguments that will be passed
  21 .\"     to .AP later.  If args are omitted, default tab stops are used.
  22 .\"
  23 .\" .BS
  24 .\"     Start box enclosure.  From here until next .BE, everything will be
  25 .\"     enclosed in one large box.
  26 .\"
  27 .\" .BE
  28 .\"     End of box enclosure.
  29 .\"
  30 .\" .CS
  31 .\"     Begin code excerpt.
  32 .\"
  33 .\" .CE
  34 .\"     End code excerpt.
  35 .\"
  36 .\" .VS ?version? ?br?
  37 .\"     Begin vertical sidebar, for use in marking newly-changed parts
  38 .\"     of man pages.  The first argument is ignored and used for recording
  39 .\"     the version when the .VS was added, so that the sidebars can be
  40 .\"     found and removed when they reach a certain age.  If another argument
  41 .\"     is present, then a line break is forced before starting the sidebar.
  42 .\"
  43 .\" .VE
  44 .\"     End of vertical sidebar.
  45 .\"
  46 .\" .DS
  47 .\"     Begin an indented unfilled display.
  48 .\"
  49 .\" .DE
  50 .\"     End of indented unfilled display.
  51 .\"
  52 .\" .SO ?manpage?
  53 .\"     Start of list of standard options for a Tk widget. The manpage
  54 .\"     argument defines where to look up the standard options; if
  55 .\"     omitted, defaults to "options". The options follow on successive
  56 .\"     lines, in three columns separated by tabs.
  57 .\"
  58 .\" .SE
  59 .\"     End of list of standard options for a Tk widget.
  60 .\"
  61 .\" .OP cmdName dbName dbClass
  62 .\"     Start of description of a specific option.  cmdName gives the
  63 .\"     option's name as specified in the class command, dbName gives
  64 .\"     the option's name in the option database, and dbClass gives
  65 .\"     the option's class in the option database.
  66 .\"
  67 .\" .UL arg1 arg2
  68 .\"     Print arg1 underlined, then print arg2 normally.
  69 .\"
  70 .\" .QW arg1 ?arg2?
  71 .\"     Print arg1 in quotes, then arg2 normally (for trailing punctuation).
  72 .\"
  73 .\" .PQ arg1 ?arg2?
  74 .\"     Print an open parenthesis, arg1 in quotes, then arg2 normally
  75 .\"     (for trailing punctuation) and then a closing parenthesis.
  76 .\"
  77 .\"     # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
  78 .if t .wh -1.3i ^B
  79 .nr ^l \n(.l
  80 .ad b
  81 .\"     # Start an argument description
  82 .de AP
  83 .ie !"\\$4"" .TP \\$4
  84 .el \{\
  85 .   ie !"\\$2"" .TP \\n()Cu
  86 .   el          .TP 15
  87 .\}
  88 .ta \\n()Au \\n()Bu
  89 .ie !"\\$3"" \{\
  90 \&\\$1 \\fI\\$2\\fP (\\$3)
  91 .\".b
  92 .\}
  93 .el \{\
  94 .br
  95 .ie !"\\$2"" \{\
  96 \&\\$1  \\fI\\$2\\fP
  97 .\}
  98 .el \{\
  99 \&\\fI\\$1\\fP
 100 .\}
 101 .\}
 102 ..
 103 .\"     # define tabbing values for .AP
 104 .de AS
 105 .nr )A 10n
 106 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
 107 .nr )B \\n()Au+15n
 108 .\"
 109 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
 110 .nr )C \\n()Bu+\\w'(in/out)'u+2n
 111 ..
 112 .AS Tcl_Interp Tcl_CreateInterp in/out
 113 .\"     # BS - start boxed text
 114 .\"     # ^y = starting y location
 115 .\"     # ^b = 1
 116 .de BS
 117 .br
 118 .mk ^y
 119 .nr ^b 1u
 120 .if n .nf
 121 .if n .ti 0
 122 .if n \l'\\n(.lu\(ul'
 123 .if n .fi
 124 ..
 125 .\"     # BE - end boxed text (draw box now)
 126 .de BE
 127 .nf
 128 .ti 0
 129 .mk ^t
 130 .ie n \l'\\n(^lu\(ul'
 131 .el \{\
 132 .\"     Draw four-sided box normally, but don't draw top of
 133 .\"     box if the box started on an earlier page.
 134 .ie !\\n(^b-1 \{\
 135 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 136 .\}
 137 .el \}\
 138 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 139 .\}
 140 .\}
 141 .fi
 142 .br
 143 .nr ^b 0
 144 ..
 145 .\"     # VS - start vertical sidebar
 146 .\"     # ^Y = starting y location
 147 .\"     # ^v = 1 (for troff;  for nroff this doesn't matter)
 148 .de VS
 149 .if !"\\$2"" .br
 150 .mk ^Y
 151 .ie n 'mc \s12\(br\s0
 152 .el .nr ^v 1u
 153 ..
 154 .\"     # VE - end of vertical sidebar
 155 .de VE
 156 .ie n 'mc
 157 .el \{\
 158 .ev 2
 159 .nf
 160 .ti 0
 161 .mk ^t
 162 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
 163 .sp -1
 164 .fi
 165 .ev
 166 .\}
 167 .nr ^v 0
 168 ..
 169 .\"     # Special macro to handle page bottom:  finish off current
 170 .\"     # box/sidebar if in box/sidebar mode, then invoked standard
 171 .\"     # page bottom macro.
 172 .de ^B
 173 .ev 2
 174 'ti 0
 175 'nf
 176 .mk ^t
 177 .if \\n(^b \{\
 178 .\"     Draw three-sided box if this is the box's first page,
 179 .\"     draw two sides but no top otherwise.
 180 .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 181 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 182 .\}
 183 .if \\n(^v \{\
 184 .nr ^x \\n(^tu+1v-\\n(^Yu
 185 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
 186 .\}
 187 .bp
 188 'fi
 189 .ev
 190 .if \\n(^b \{\
 191 .mk ^y
 192 .nr ^b 2
 193 .\}
 194 .if \\n(^v \{\
 195 .mk ^Y
 196 .\}
 197 ..
 198 .\"     # DS - begin display
 199 .de DS
 200 .RS
 201 .nf
 202 .sp
 203 ..
 204 .\"     # DE - end display
 205 .de DE
 206 .fi
 207 .RE
 208 .sp
 209 ..
 210 .\"     # SO - start of list of standard options
 211 .de SO
 212 'ie '\\$1'' .ds So \\fBoptions\\fR
 213 'el .ds So \\fB\\$1\\fR
 214 .SH "STANDARD OPTIONS"
 215 .LP
 216 .nf
 217 .ta 5.5c 11c
 218 .ft B
 219 ..
 220 .\"     # SE - end of list of standard options
 221 .de SE
 222 .fi
 223 .ft R
 224 .LP
 225 See the \\*(So manual entry for details on the standard options.
 226 ..
 227 .\"     # OP - start of full description for a single option
 228 .de OP
 229 .LP
 230 .nf
 231 .ta 4c
 232 Command-Line Name:      \\fB\\$1\\fR
 233 Database Name:  \\fB\\$2\\fR
 234 Database Class: \\fB\\$3\\fR
 235 .fi
 236 .IP
 237 ..
 238 .\"     # CS - begin code excerpt
 239 .de CS
 240 .RS
 241 .nf
 242 .ta .25i .5i .75i 1i
 243 ..
 244 .\"     # CE - end code excerpt
 245 .de CE
 246 .fi
 247 .RE
 248 ..
 249 .\"     # UL - underline word
 250 .de UL
 251 \\$1\l'|0\(ul'\\$2
 252 ..
 253 .\"     # QW - apply quotation marks to word
 254 .de QW
 255 .ie '\\*(lq'"' ``\\$1''\\$2
 256 .\"" fix emacs highlighting
 257 .el \\*(lq\\$1\\*(rq\\$2
 258 ..
 259 .\"     # PQ - apply parens and quotation marks to word
 260 .de PQ
 261 .ie '\\*(lq'"' (``\\$1''\\$2)\\$3
 262 .\"" fix emacs highlighting
 263 .el (\\*(lq\\$1\\*(rq\\$2)\\$3
 264 ..
 265 .\"     # QR - quoted range
 266 .de QR
 267 .ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3
 268 .\"" fix emacs highlighting
 269 .el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3
 270 ..
 271 .\"     # MT - "empty" string
 272 .de MT
 273 .QW ""
 274 ..
 275 .BS
 276 '\" Note:  do not modify the .SH NAME line immediately below!
 277 .SH NAME
 278 regexp \- Match a regular expression against a string
 279 .SH SYNOPSIS
 280 \fBregexp \fR?\fIswitches\fR? \fIexp string \fR?\fImatchVar\fR? ?\fIsubMatchVar subMatchVar ...\fR?
 281 .BE
 282 .SH DESCRIPTION
 283 .PP
 284 Determines whether the regular expression \fIexp\fR matches part or
 285 all of \fIstring\fR and returns 1 if it does, 0 if it does not, unless
 286 \fB\-inline\fR is specified (see below).
 287 (Regular expression matching is described in the \fBre_syntax\fR
 288 reference page.)
 289 .PP
 290 If additional arguments are specified after \fIstring\fR then they
 291 are treated as the names of variables in which to return
 292 information about which part(s) of \fIstring\fR matched \fIexp\fR.
 293 \fIMatchVar\fR will be set to the range of \fIstring\fR that
 294 matched all of \fIexp\fR.  The first \fIsubMatchVar\fR will contain
 295 the characters in \fIstring\fR that matched the leftmost parenthesized
 296 subexpression within \fIexp\fR, the next \fIsubMatchVar\fR will
 297 contain the characters that matched the next parenthesized
 298 subexpression to the right in \fIexp\fR, and so on.
 299 .PP
 300 If the initial arguments to \fBregexp\fR start with \fB\-\fR then
 301 they are treated as switches.  The following switches are
 302 currently supported:
 303 .TP 15
 304 \fB\-about\fR
 305 .
 306 Instead of attempting to match the regular expression, returns a list
 307 containing information about the regular expression.  The first
 308 element of the list is a subexpression count.  The second element is a
 309 list of property names that describe various attributes of the regular
 310 expression. This switch is primarily intended for debugging purposes.
 311 .TP 15
 312 \fB\-expanded\fR
 313 .
 314 Enables use of the expanded regular expression syntax where
 315 whitespace and comments are ignored.  This is the same as specifying
 316 the \fB(?x)\fR embedded option (see the \fBre_syntax\fR manual page).
 317 .TP 15
 318 \fB\-indices\fR
 319 .
 320 Changes what is stored in the \fIsubMatchVar\fRs.
 321 Instead of storing the matching characters from \fIstring\fR,
 322 each variable
 323 will contain a list of two decimal strings giving the indices
 324 in \fIstring\fR of the first and last characters in the matching
 325 range of characters.
 326 .TP 15
 327 \fB\-line\fR
 328 .
 329 Enables newline-sensitive matching.  By default, newline is a
 330 completely ordinary character with no special meaning.  With this
 331 flag,
 332 .QW [^
 333 bracket expressions and
 334 .QW .
 335 never match newline,
 336 .QW ^
 337 matches an empty string after any newline in addition to its normal
 338 function, and
 339 .QW $
 340 matches an empty string before any newline in
 341 addition to its normal function.  This flag is equivalent to
 342 specifying both \fB\-linestop\fR and \fB\-lineanchor\fR, or the
 343 \fB(?n)\fR embedded option (see the \fBre_syntax\fR manual page).
 344 .TP 15
 345 \fB\-linestop\fR
 346 .
 347 Changes the behavior of
 348 .QW [^
 349 bracket expressions and
 350 .QW .
 351 so that they
 352 stop at newlines.  This is the same as specifying the \fB(?p)\fR
 353 embedded option (see the \fBre_syntax\fR manual page).
 354 .TP 15
 355 \fB\-lineanchor\fR
 356 .
 357 Changes the behavior of
 358 .QW ^
 359 and
 360 .QW $
 361 (the
 362 .QW anchors )
 363 so they match the
 364 beginning and end of a line respectively.  This is the same as
 365 specifying the \fB(?w)\fR embedded option (see the \fBre_syntax\fR
 366 manual page).
 367 .TP 15
 368 \fB\-nocase\fR
 369 .
 370 Causes upper-case characters in \fIstring\fR to be treated as
 371 lower case during the matching process.
 372 .TP 15
 373 \fB\-all\fR
 374 .
 375 Causes the regular expression to be matched as many times as possible
 376 in the string, returning the total number of matches found.  If this
 377 is specified with match variables, they will contain information for
 378 the last match only.
 379 .TP 15
 380 \fB\-inline\fR
 381 .
 382 Causes the command to return, as a list, the data that would otherwise
 383 be placed in match variables.  When using \fB\-inline\fR,
 384 match variables may not be specified.  If used with \fB\-all\fR, the
 385 list will be concatenated at each iteration, such that a flat list is
 386 always returned.  For each match iteration, the command will append the
 387 overall match data, plus one element for each subexpression in the
 388 regular expression.  Examples are:
 389 .RS
 390 .PP
 391 .CS
 392 \fBregexp\fR -inline -- {\ew(\ew)} " inlined "
 393       \fI\(-> in n\fR
 394 \fBregexp\fR -all -inline -- {\ew(\ew)} " inlined "
 395       \fI\(-> in n li i ne e\fR
 396 .CE
 397 .RE
 398 .TP 15
 399 \fB\-start\fR \fIindex\fR
 400 .
 401 Specifies a character index offset into the string to start
 402 matching the regular expression at.
 403 The \fIindex\fR value is interpreted in the same manner
 404 as the \fIindex\fR argument to \fBstring index\fR.
 405 When using this switch,
 406 .QW ^
 407 will not match the beginning of the line, and \eA will still
 408 match the start of the string at \fIindex\fR.  If \fB\-indices\fR
 409 is specified, the indices will be indexed starting from the
 410 absolute beginning of the input string.
 411 \fIindex\fR will be constrained to the bounds of the input string.
 412 .TP 15
 413 \fB\-\|\-\fR
 414 .
 415 Marks the end of switches.  The argument following this one will
 416 be treated as \fIexp\fR even if it starts with a \fB\-\fR.
 417 .PP
 418 If there are more \fIsubMatchVar\fRs than parenthesized
 419 subexpressions within \fIexp\fR, or if a particular subexpression
 420 in \fIexp\fR does not match the string (e.g. because it was in a
 421 portion of the expression that was not matched), then the corresponding
 422 \fIsubMatchVar\fR will be set to
 423 .QW "\fB\-1 \-1\fR"
 424 if \fB\-indices\fR has been specified or to an empty string otherwise.
 425 .SH EXAMPLES
 426 .PP
 427 Find the first occurrence of a word starting with \fBfoo\fR in a
 428 string that is not actually an instance of \fBfoobar\fR, and get the
 429 letters following it up to the end of the word into a variable:
 430 .PP
 431 .CS
 432 \fBregexp\fR {\emfoo(?!bar\eM)(\ew*)} $string \-> restOfWord
 433 .CE
 434 .PP
 435 Note that the whole matched substring has been placed in the variable
 436 .QW \fB\->\fR ,
 437 which is a name chosen to look nice given that we are not
 438 actually interested in its contents.
 439 .PP
 440 Find the index of the word \fBbadger\fR (in any case) within a string
 441 and store that in the variable \fBlocation\fR:
 442 .PP
 443 .CS
 444 \fBregexp\fR \-indices {(?i)\embadger\eM} $string location
 445 .CE
 446 .PP
 447 This could also be written as a \fIbasic\fR regular expression (as opposed
 448 to using the default syntax of \fIadvanced\fR regular expressions) match by
 449 prefixing the expression with a suitable flag:
 450 .PP
 451 .CS
 452 \fBregexp\fR \-indices {(?ib)\e<badger\e>} $string location
 453 .CE
 454 .PP
 455 This counts the number of octal digits in a string:
 456 .PP
 457 .CS
 458 \fBregexp\fR \-all {[0\-7]} $string
 459 .CE
 460 .PP
 461 This lists all words (consisting of all sequences of non-whitespace
 462 characters) in a string, and is useful as a more powerful version of the
 463 \fBsplit\fR command:
 464 .PP
 465 .CS
 466 \fBregexp\fR \-all \-inline {\eS+} $string
 467 .CE
 468 .SH "SEE ALSO"
 469 re_syntax(n), regsub(n), string(n)
 470 .SH KEYWORDS
 471 match, parsing, pattern, regular expression, splitting, string
 472 '\" Local Variables:
 473 '\" mode: nroff
 474 '\" End: