/[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 123 by ph10, Mon Mar 12 15:19:06 2007 UTC revision 386 by ph10, Tue Mar 10 11:48:33 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 237  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 372  recognized: Line 388  recognized:
388    \e<crlf>    pass the PCRE_NEWLINE_CRLF option to \fBpcre_exec()\fP    \e<crlf>    pass the PCRE_NEWLINE_CRLF option to \fBpcre_exec()\fP
389                 or \fBpcre_dfa_exec()\fP                 or \fBpcre_dfa_exec()\fP
390  .\" JOIN  .\" JOIN
391      \e<anycrlf> pass the PCRE_NEWLINE_ANYCRLF option to \fBpcre_exec()\fP
392                   or \fBpcre_dfa_exec()\fP
393    .\" JOIN
394    \e<any>     pass the PCRE_NEWLINE_ANY option to \fBpcre_exec()\fP    \e<any>     pass the PCRE_NEWLINE_ANY option to \fBpcre_exec()\fP
395                 or \fBpcre_dfa_exec()\fP                 or \fBpcre_dfa_exec()\fP
396  .sp  .sp
# Line 407  and \eZ, causing REG_NOTBOL and REG_NOTE Line 426  and \eZ, causing REG_NOTBOL and REG_NOTE
426  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
427  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
428  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
429  six bytes, encoded according to the UTF-8 rules.  six bytes, encoded according to the original UTF-8 rules of RFC 2279. This
430    allows for values in the range 0 to 0x7FFFFFFF. Note that not all of those are
431    valid Unicode code points, or indeed valid UTF-8 characters according to the
432    later rules in RFC 3629.
433  .  .
434  .  .
435  .SH "THE ALTERNATIVE MATCHING FUNCTION"  .SH "THE ALTERNATIVE MATCHING FUNCTION"
# Line 453  of an interactive \fBpcretest\fP run. Line 475  of an interactive \fBpcretest\fP run.
475    data> xyz    data> xyz
476    No match    No match
477  .sp  .sp
478    Note that unset capturing substrings that are not followed by one that is set
479    are not returned by \fBpcre_exec()\fP, and are not shown by \fBpcretest\fP. In
480    the following example, there are two capturing substrings, but when the first
481    data line is matched, the second, unset substring is not shown. An "internal"
482    unset substring is shown as "<unset>", as for the second data line.
483    .sp
484        re> /(a)|(b)/
485      data> a
486       0: a
487       1: a
488      data> b
489       0: b
490       1: <unset>
491       2: b
492    .sp
493  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
494  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
495  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 533  indicating that the subject partially ma Line 570  indicating that the subject partially ma
570  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
571  example:  example:
572  .sp  .sp
573      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$/
574    data> 23ja\eP\eD    data> 23ja\eP\eD
575    Partial match: 23ja    Partial match: 23ja
576    data> n05\eR\eD    data> n05\eR\eD
# Line 669  result is undefined. Line 706  result is undefined.
706  .rs  .rs
707  .sp  .sp
708  \fBpcre\fP(3), \fBpcreapi\fP(3), \fBpcrecallout\fP(3), \fBpcrematching\fP(3),  \fBpcre\fP(3), \fBpcreapi\fP(3), \fBpcrecallout\fP(3), \fBpcrematching\fP(3),
709  \fBpcrepartial\fP(d), \fPpcrepattern\fP(3), \fBpcreprecompile\fP(3).  \fBpcrepartial\fP(d), \fBpcrepattern\fP(3), \fBpcreprecompile\fP(3).
710  .  .
711  .  .
712  .SH AUTHOR  .SH AUTHOR
# Line 686  Cambridge CB2 3QH, England. Line 723  Cambridge CB2 3QH, England.
723  .rs  .rs
724  .sp  .sp
725  .nf  .nf
726  Last updated: 06 March 2007  Last updated: 10 March 2009
727  Copyright (c) 1997-2007 University of Cambridge.  Copyright (c) 1997-2009 University of Cambridge.
728  .fi  .fi
Legend:
Removed from v.123  
changed lines
  Added in v.386
webmaster@exim.org
 ViewVC Help
Powered by ViewVC 1.1.12