/[pcre]/code/trunk/doc/pcretest.1
ViewVC logotype

Diff of /code/trunk/doc/pcretest.1

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 93 by nigel, Sat Feb 24 21:41:42 2007 UTC revision 455 by ph10, Sat Sep 26 19:12:32 2009 UTC
# Line 49  Output a brief summary these options and Line 49  Output a brief summary these options and
49  Behave as if each regex has the \fB/I\fP modifier; information about the  Behave as if each regex has the \fB/I\fP modifier; information about the
50  compiled pattern is given after compilation.  compiled pattern is given after compilation.
51  .TP 10  .TP 10
52    \fB-M\fP
53    Behave as if each data line contains the \eM escape sequence; this causes
54    PCRE to discover the minimum MATCH_LIMIT and MATCH_LIMIT_RECURSION settings by
55    calling \fBpcre_exec()\fP repeatedly with different limits.
56    .TP 10
57  \fB-m\fP  \fB-m\fP
58  Output the size of each compiled pattern after it has been compiled. This is  Output the size of each compiled pattern after it has been compiled. This is
59  equivalent to adding \fB/M\fP to each regular expression. For compatibility  equivalent to adding \fB/M\fP to each regular expression. For compatibility
# Line 97  that file and writes to stdout. Otherwis Line 102  that file and writes to stdout. Otherwis
102  stdout, and prompts for each line of input, using "re>" to prompt for regular  stdout, and prompts for each line of input, using "re>" to prompt for regular
103  expressions, and "data>" to prompt for data lines.  expressions, and "data>" to prompt for data lines.
104  .P  .P
105    When \fBpcretest\fP is built, a configuration option can specify that it should
106    be linked with the \fBlibreadline\fP library. When this is done, if the input
107    is from a terminal, it is read using the \fBreadline()\fP function. This
108    provides line-editing and history facilities. The output from the \fB-help\fP
109    option states whether or not \fBreadline()\fP will be used.
110    .P
111  The program handles any number of sets of input on a single input file. Each  The program handles any number of sets of input on a single input file. Each
112  set starts with a regular expression, and continues with any number of data  set starts with a regular expression, and continues with any number of data
113  lines to be matched against the pattern.  lines to be matched against the pattern.
# Line 157  effect as they do in Perl. For example: Line 168  effect as they do in Perl. For example:
168  The following table shows additional modifiers for setting PCRE options that do  The following table shows additional modifiers for setting PCRE options that do
169  not correspond to anything in Perl:  not correspond to anything in Perl:
170  .sp  .sp
171    \fB/A\fP       PCRE_ANCHORED    \fB/A\fP              PCRE_ANCHORED
172    \fB/C\fP       PCRE_AUTO_CALLOUT    \fB/C\fP              PCRE_AUTO_CALLOUT
173    \fB/E\fP       PCRE_DOLLAR_ENDONLY    \fB/E\fP              PCRE_DOLLAR_ENDONLY
174    \fB/f\fP       PCRE_FIRSTLINE    \fB/f\fP              PCRE_FIRSTLINE
175    \fB/J\fP       PCRE_DUPNAMES    \fB/J\fP              PCRE_DUPNAMES
176    \fB/N\fP       PCRE_NO_AUTO_CAPTURE    \fB/N\fP              PCRE_NO_AUTO_CAPTURE
177    \fB/U\fP       PCRE_UNGREEDY    \fB/U\fP              PCRE_UNGREEDY
178    \fB/X\fP       PCRE_EXTRA    \fB/X\fP              PCRE_EXTRA
179    \fB/<cr>\fP    PCRE_NEWLINE_CR    \fB/<JS>\fP           PCRE_JAVASCRIPT_COMPAT
180    \fB/<lf>\fP    PCRE_NEWLINE_LF    \fB/<cr>\fP           PCRE_NEWLINE_CR
181    \fB/<crlf>\fP  PCRE_NEWLINE_CRLF    \fB/<lf>\fP           PCRE_NEWLINE_LF
182    \fB/<any>\fP   PCRE_NEWLINE_ANY    \fB/<crlf>\fP         PCRE_NEWLINE_CRLF
183  .sp    \fB/<anycrlf>\fP      PCRE_NEWLINE_ANYCRLF
184  Those specifying line ending sequencess are literal strings as shown. This    \fB/<any>\fP          PCRE_NEWLINE_ANY
185  example sets multiline matching with CRLF as the line ending sequence:    \fB/<bsr_anycrlf>\fP  PCRE_BSR_ANYCRLF
186      \fB/<bsr_unicode>\fP  PCRE_BSR_UNICODE
187    .sp
188    Those specifying line ending sequences are literal strings as shown, but the
189    letters can be in either case. This example sets multiline matching with CRLF
190    as the line ending sequence:
191  .sp  .sp
192    /^abc/m<crlf>    /^abc/m<crlf>
193  .sp  .sp
# Line 195  substring. This makes a difference to th Line 211  substring. This makes a difference to th
211  begins with a lookbehind assertion (including \eb or \eB).  begins with a lookbehind assertion (including \eb or \eB).
212  .P  .P
213  If any call to \fBpcre_exec()\fP in a \fB/g\fP or \fB/G\fP sequence matches an  If any call to \fBpcre_exec()\fP in a \fB/g\fP or \fB/G\fP sequence matches an
214  empty string, the next call is done with the PCRE_NOTEMPTY and PCRE_ANCHORED  empty string, the next call is done with the PCRE_NOTEMPTY_ATSTART and
215  flags set in order to search for another, non-empty, match at the same point.  PCRE_ANCHORED flags set in order to search for another, non-empty, match at the
216  If this second match fails, the start offset is advanced by one, and the normal  same point. If this second match fails, the start offset is advanced by one
217  match is retried. This imitates the way Perl handles such cases when using the  character, and the normal match is retried. This imitates the way Perl handles
218  \fB/g\fP modifier or the \fBsplit()\fP function.  such cases when using the \fB/g\fP modifier or the \fBsplit()\fP function.
219  .  .
220  .  .
221  .SS "Other modifiers"  .SS "Other modifiers"
# Line 214  the subject string. This is useful for t Line 230  the subject string. This is useful for t
230  multiple copies of the same substring.  multiple copies of the same substring.
231  .P  .P
232  The \fB/B\fP modifier is a debugging feature. It requests that \fBpcretest\fP  The \fB/B\fP modifier is a debugging feature. It requests that \fBpcretest\fP
233  output a representation of the compiled byte code after compilation.  output a representation of the compiled byte code after compilation. Normally
234    this information contains length and offset values; however, if \fB/Z\fP is
235    also present, this data is replaced by spaces. This is a special feature for
236    use in the automatic test scripts; it ensures that the same output is generated
237    for different internal link sizes.
238  .P  .P
239  The \fB/L\fP modifier must be followed directly by the name of a locale, for  The \fB/L\fP modifier must be followed directly by the name of a locale, for
240  example,  example,
# Line 233  so on). It does this by calling \fBpcre_ Line 253  so on). It does this by calling \fBpcre_
253  pattern. If the pattern is studied, the results of that are also output.  pattern. If the pattern is studied, the results of that are also output.
254  .P  .P
255  The \fB/D\fP modifier is a PCRE debugging feature, and is equivalent to  The \fB/D\fP modifier is a PCRE debugging feature, and is equivalent to
256  \fB/BI\fP, that is, both the \fP/B\fP and the \fB/I\fP modifiers.  \fB/BI\fP, that is, both the \fB/B\fP and the \fB/I\fP modifiers.
257  .P  .P
258  The \fB/F\fP modifier causes \fBpcretest\fP to flip the byte order of the  The \fB/F\fP modifier causes \fBpcretest\fP to flip the byte order of the
259  fields in the compiled pattern that contain 2-byte and 4-byte numbers. This  fields in the compiled pattern that contain 2-byte and 4-byte numbers. This
# Line 336  recognized: Line 356  recognized:
356                 MATCH_LIMIT_RECURSION settings                 MATCH_LIMIT_RECURSION settings
357  .\" JOIN  .\" JOIN
358    \eN         pass the PCRE_NOTEMPTY option to \fBpcre_exec()\fP    \eN         pass the PCRE_NOTEMPTY option to \fBpcre_exec()\fP
359                 or \fBpcre_dfa_exec()\fP                 or \fBpcre_dfa_exec()\fP; if used twice, pass the
360                   PCRE_NOTEMPTY_ATSTART option
361  .\" JOIN  .\" JOIN
362    \eOdd       set the size of the output vector passed to    \eOdd       set the size of the output vector passed to
363                 \fBpcre_exec()\fP to dd (any number of digits)                 \fBpcre_exec()\fP to dd (any number of digits)
364  .\" JOIN  .\" JOIN
365    \eP         pass the PCRE_PARTIAL option to \fBpcre_exec()\fP    \eP         pass the PCRE_PARTIAL_SOFT option to \fBpcre_exec()\fP
366                 or \fBpcre_dfa_exec()\fP                 or \fBpcre_dfa_exec()\fP; if used twice, pass the
367                   PCRE_PARTIAL_HARD option
368  .\" JOIN  .\" JOIN
369    \eQdd       set the PCRE_MATCH_LIMIT_RECURSION limit to dd    \eQdd       set the PCRE_MATCH_LIMIT_RECURSION limit to dd
370                 (any number of digits)                 (any number of digits)
371    \eR         pass the PCRE_DFA_RESTART option to \fBpcre_dfa_exec()\fP    \eR         pass the PCRE_DFA_RESTART option to \fBpcre_dfa_exec()\fP
372    \eS         output details of memory get/free calls during matching    \eS         output details of memory get/free calls during matching
373  .\" JOIN  .\" JOIN
374      \eY         pass the PCRE_NO_START_OPTIMIZE option to \fBpcre_exec()\fP
375                   or \fBpcre_dfa_exec()\fP
376    .\" JOIN
377    \eZ         pass the PCRE_NOTEOL option to \fBpcre_exec()\fP    \eZ         pass the PCRE_NOTEOL option to \fBpcre_exec()\fP
378                 or \fBpcre_dfa_exec()\fP                 or \fBpcre_dfa_exec()\fP
379  .\" JOIN  .\" JOIN
# Line 368  recognized: Line 393  recognized:
393    \e<crlf>    pass the PCRE_NEWLINE_CRLF option to \fBpcre_exec()\fP    \e<crlf>    pass the PCRE_NEWLINE_CRLF option to \fBpcre_exec()\fP
394                 or \fBpcre_dfa_exec()\fP                 or \fBpcre_dfa_exec()\fP
395  .\" JOIN  .\" JOIN
396      \e<anycrlf> pass the PCRE_NEWLINE_ANYCRLF option to \fBpcre_exec()\fP
397                   or \fBpcre_dfa_exec()\fP
398    .\" JOIN
399    \e<any>     pass the PCRE_NEWLINE_ANY option to \fBpcre_exec()\fP    \e<any>     pass the PCRE_NEWLINE_ANY option to \fBpcre_exec()\fP
400                 or \fBpcre_dfa_exec()\fP                 or \fBpcre_dfa_exec()\fP
401  .sp  .sp
# Line 403  and \eZ, causing REG_NOTBOL and REG_NOTE Line 431  and \eZ, causing REG_NOTBOL and REG_NOTE
431  The use of \ex{hh...} to represent UTF-8 characters is not dependent on the use  The use of \ex{hh...} to represent UTF-8 characters is not dependent on the use
432  of the \fB/8\fP modifier on the pattern. It is recognized always. There may be  of the \fB/8\fP modifier on the pattern. It is recognized always. There may be
433  any number of hexadecimal digits inside the braces. The result is from one to  any number of hexadecimal digits inside the braces. The result is from one to
434  six bytes, encoded according to the UTF-8 rules.  six bytes, encoded according to the original UTF-8 rules of RFC 2279. This
435    allows for values in the range 0 to 0x7FFFFFFF. Note that not all of those are
436    valid Unicode code points, or indeed valid UTF-8 characters according to the
437    later rules in RFC 3629.
438  .  .
439  .  .
440  .SH "THE ALTERNATIVE MATCHING FUNCTION"  .SH "THE ALTERNATIVE MATCHING FUNCTION"
# Line 434  This section describes the output when t Line 465  This section describes the output when t
465  .P  .P
466  When a match succeeds, pcretest outputs the list of captured substrings that  When a match succeeds, pcretest outputs the list of captured substrings that
467  \fBpcre_exec()\fP returns, starting with number 0 for the string that matched  \fBpcre_exec()\fP returns, starting with number 0 for the string that matched
468  the whole pattern. Otherwise, it outputs "No match" or "Partial match"  the whole pattern. Otherwise, it outputs "No match" when the return is
469  when \fBpcre_exec()\fP returns PCRE_ERROR_NOMATCH or PCRE_ERROR_PARTIAL,  PCRE_ERROR_NOMATCH, and "Partial match:" followed by the partially matching
470  respectively, and otherwise the PCRE negative error number. Here is an example  substring when \fBpcre_exec()\fP returns PCRE_ERROR_PARTIAL. For any other
471  of an interactive \fBpcretest\fP run.  returns, it outputs the PCRE negative error number. Here is an example of an
472    interactive \fBpcretest\fP run.
473  .sp  .sp
474    $ pcretest    $ pcretest
475    PCRE version 7.0 30-Nov-2006    PCRE version 7.0 30-Nov-2006
# Line 449  of an interactive \fBpcretest\fP run. Line 481  of an interactive \fBpcretest\fP run.
481    data> xyz    data> xyz
482    No match    No match
483  .sp  .sp
484    Note that unset capturing substrings that are not followed by one that is set
485    are not returned by \fBpcre_exec()\fP, and are not shown by \fBpcretest\fP. In
486    the following example, there are two capturing substrings, but when the first
487    data line is matched, the second, unset substring is not shown. An "internal"
488    unset substring is shown as "<unset>", as for the second data line.
489    .sp
490        re> /(a)|(b)/
491      data> a
492       0: a
493       1: a
494      data> b
495       0: b
496       1: <unset>
497       2: b
498    .sp
499  If the strings contain any non-printing characters, they are output as \e0x  If the strings contain any non-printing characters, they are output as \e0x
500  escapes, or as \ex{...} escapes if the \fB/8\fP modifier was present on the  escapes, or as \ex{...} escapes if the \fB/8\fP modifier was present on the
501  pattern. See below for the definition of non-printing characters. If the  pattern. See below for the definition of non-printing characters. If the
# Line 503  the subject where there is at least one Line 550  the subject where there is at least one
550     2: tan     2: tan
551  .sp  .sp
552  (Using the normal matching function on this data finds only "tang".) The  (Using the normal matching function on this data finds only "tang".) The
553  longest matching string is always given first (and numbered zero).  longest matching string is always given first (and numbered zero). After a
554    PCRE_ERROR_PARTIAL return, the output is "Partial match:", followed by the
555    partially matching substring.
556  .P  .P
557  If \fB/g\fP is present on the pattern, the search for further matches resumes  If \fB/g\fP is present on the pattern, the search for further matches resumes
558  at the end of the longest match. For example:  at the end of the longest match. For example:
# Line 529  indicating that the subject partially ma Line 578  indicating that the subject partially ma
578  match with additional subject data by means of the \eR escape sequence. For  match with additional subject data by means of the \eR escape sequence. For
579  example:  example:
580  .sp  .sp
581      re> /^\d?\d(jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|dec)\d\d$/      re> /^\ed?\ed(jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|dec)\ed\ed$/
582    data> 23ja\eP\eD    data> 23ja\eP\eD
583    Partial match: 23ja    Partial match: 23ja
584    data> n05\eR\eD    data> n05\eR\eD
# Line 665  result is undefined. Line 714  result is undefined.
714  .rs  .rs
715  .sp  .sp
716  \fBpcre\fP(3), \fBpcreapi\fP(3), \fBpcrecallout\fP(3), \fBpcrematching\fP(3),  \fBpcre\fP(3), \fBpcreapi\fP(3), \fBpcrecallout\fP(3), \fBpcrematching\fP(3),
717  \fBpcrepartial\fP(d), \fPpcrepattern\fP(3), \fBpcreprecompile\fP(3).  \fBpcrepartial\fP(d), \fBpcrepattern\fP(3), \fBpcreprecompile\fP(3).
718  .  .
719  .  .
720  .SH AUTHOR  .SH AUTHOR
721  .rs  .rs
722  .sp  .sp
723    .nf
724  Philip Hazel  Philip Hazel
725  .br  University Computing Service
 University Computing Service,  
 .br  
726  Cambridge CB2 3QH, England.  Cambridge CB2 3QH, England.
727  .P  .fi
728  .in 0  .
729  Last updated: 30 November 2006  .
730  .br  .SH REVISION
731  Copyright (c) 1997-2006 University of Cambridge.  .rs
732    .sp
733    .nf
734    Last updated: 26 September 2009
735    Copyright (c) 1997-2009 University of Cambridge.
736    .fi

Legend:
Removed from v.93  
changed lines
  Added in v.455

  ViewVC Help
Powered by ViewVC 1.1.5