/[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 287 by ph10, Tue Dec 18 20:11:28 2007 UTC
# Line 97  that file and writes to stdout. Otherwis Line 97  that file and writes to stdout. Otherwis
97  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
98  expressions, and "data>" to prompt for data lines.  expressions, and "data>" to prompt for data lines.
99  .P  .P
100    When \fBpcretest\fP is built, a configuration option can specify that it should
101    be linked with the \fBlibreadline\fP library. When this is done, if the input
102    is from a terminal, it is read using the \fBreadline()\fP function. This
103    provides line-editing and history facilities. The output from the \fB-help\fP
104    option states whether or not \fBreadline()\fP will be used.
105    .P
106  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
107  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
108  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 163  effect as they do in Perl. For example:
163  The following table shows additional modifiers for setting PCRE options that do  The following table shows additional modifiers for setting PCRE options that do
164  not correspond to anything in Perl:  not correspond to anything in Perl:
165  .sp  .sp
166    \fB/A\fP       PCRE_ANCHORED    \fB/A\fP              PCRE_ANCHORED
167    \fB/C\fP       PCRE_AUTO_CALLOUT    \fB/C\fP              PCRE_AUTO_CALLOUT
168    \fB/E\fP       PCRE_DOLLAR_ENDONLY    \fB/E\fP              PCRE_DOLLAR_ENDONLY
169    \fB/f\fP       PCRE_FIRSTLINE    \fB/f\fP              PCRE_FIRSTLINE
170    \fB/J\fP       PCRE_DUPNAMES    \fB/J\fP              PCRE_DUPNAMES
171    \fB/N\fP       PCRE_NO_AUTO_CAPTURE    \fB/N\fP              PCRE_NO_AUTO_CAPTURE
172    \fB/U\fP       PCRE_UNGREEDY    \fB/U\fP              PCRE_UNGREEDY
173    \fB/X\fP       PCRE_EXTRA    \fB/X\fP              PCRE_EXTRA
174    \fB/<cr>\fP    PCRE_NEWLINE_CR    \fB/<cr>\fP           PCRE_NEWLINE_CR
175    \fB/<lf>\fP    PCRE_NEWLINE_LF    \fB/<lf>\fP           PCRE_NEWLINE_LF
176    \fB/<crlf>\fP  PCRE_NEWLINE_CRLF    \fB/<crlf>\fP         PCRE_NEWLINE_CRLF
177    \fB/<any>\fP   PCRE_NEWLINE_ANY    \fB/<anycrlf>\fP      PCRE_NEWLINE_ANYCRLF
178  .sp    \fB/<any>\fP          PCRE_NEWLINE_ANY
179  Those specifying line ending sequencess are literal strings as shown. This    \fB/<bsr_anycrlf>\fP  PCRE_BSR_ANYCRLF
180  example sets multiline matching with CRLF as the line ending sequence:    \fB/<bsr_unicode>\fP  PCRE_BSR_UNICODE
181    .sp
182    Those specifying line ending sequences are literal strings as shown, but the
183    letters can be in either case. This example sets multiline matching with CRLF
184    as the line ending sequence:
185  .sp  .sp
186    /^abc/m<crlf>    /^abc/m<crlf>
187  .sp  .sp
# Line 214  the subject string. This is useful for t Line 224  the subject string. This is useful for t
224  multiple copies of the same substring.  multiple copies of the same substring.
225  .P  .P
226  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
227  output a representation of the compiled byte code after compilation.  output a representation of the compiled byte code after compilation. Normally
228    this information contains length and offset values; however, if \fB/Z\fP is
229    also present, this data is replaced by spaces. This is a special feature for
230    use in the automatic test scripts; it ensures that the same output is generated
231    for different internal link sizes.
232  .P  .P
233  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
234  example,  example,
# Line 233  so on). It does this by calling \fBpcre_ Line 247  so on). It does this by calling \fBpcre_
247  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.
248  .P  .P
249  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
250  \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.
251  .P  .P
252  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
253  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 368  recognized: Line 382  recognized:
382    \e<crlf>    pass the PCRE_NEWLINE_CRLF option to \fBpcre_exec()\fP    \e<crlf>    pass the PCRE_NEWLINE_CRLF option to \fBpcre_exec()\fP
383                 or \fBpcre_dfa_exec()\fP                 or \fBpcre_dfa_exec()\fP
384  .\" JOIN  .\" JOIN
385      \e<anycrlf> pass the PCRE_NEWLINE_ANYCRLF option to \fBpcre_exec()\fP
386                   or \fBpcre_dfa_exec()\fP
387    .\" JOIN
388    \e<any>     pass the PCRE_NEWLINE_ANY option to \fBpcre_exec()\fP    \e<any>     pass the PCRE_NEWLINE_ANY option to \fBpcre_exec()\fP
389                 or \fBpcre_dfa_exec()\fP                 or \fBpcre_dfa_exec()\fP
390  .sp  .sp
# Line 403  and \eZ, causing REG_NOTBOL and REG_NOTE Line 420  and \eZ, causing REG_NOTBOL and REG_NOTE
420  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
421  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
422  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
423  six bytes, encoded according to the UTF-8 rules.  six bytes, encoded according to the original UTF-8 rules of RFC 2279. This
424    allows for values in the range 0 to 0x7FFFFFFF. Note that not all of those are
425    valid Unicode code points, or indeed valid UTF-8 characters according to the
426    later rules in RFC 3629.
427  .  .
428  .  .
429  .SH "THE ALTERNATIVE MATCHING FUNCTION"  .SH "THE ALTERNATIVE MATCHING FUNCTION"
# Line 449  of an interactive \fBpcretest\fP run. Line 469  of an interactive \fBpcretest\fP run.
469    data> xyz    data> xyz
470    No match    No match
471  .sp  .sp
472    Note that unset capturing substrings that are not followed by one that is set
473    are not returned by \fBpcre_exec()\fP, and are not shown by \fBpcretest\fP. In
474    the following example, there are two capturing substrings, but when the first
475    data line is matched, the second, unset substring is not shown. An "internal"
476    unset substring is shown as "<unset>", as for the second data line.
477    .sp
478        re> /(a)|(b)/
479      data> a
480       0: a
481       1: a
482      data> b
483       0: b
484       1: <unset>
485       2: b
486    .sp
487  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
488  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
489  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 529  indicating that the subject partially ma Line 564  indicating that the subject partially ma
564  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
565  example:  example:
566  .sp  .sp
567      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$/
568    data> 23ja\eP\eD    data> 23ja\eP\eD
569    Partial match: 23ja    Partial match: 23ja
570    data> n05\eR\eD    data> n05\eR\eD
# Line 665  result is undefined. Line 700  result is undefined.
700  .rs  .rs
701  .sp  .sp
702  \fBpcre\fP(3), \fBpcreapi\fP(3), \fBpcrecallout\fP(3), \fBpcrematching\fP(3),  \fBpcre\fP(3), \fBpcreapi\fP(3), \fBpcrecallout\fP(3), \fBpcrematching\fP(3),
703  \fBpcrepartial\fP(d), \fPpcrepattern\fP(3), \fBpcreprecompile\fP(3).  \fBpcrepartial\fP(d), \fBpcrepattern\fP(3), \fBpcreprecompile\fP(3).
704  .  .
705  .  .
706  .SH AUTHOR  .SH AUTHOR
707  .rs  .rs
708  .sp  .sp
709    .nf
710  Philip Hazel  Philip Hazel
711  .br  University Computing Service
 University Computing Service,  
 .br  
712  Cambridge CB2 3QH, England.  Cambridge CB2 3QH, England.
713  .P  .fi
714  .in 0  .
715  Last updated: 30 November 2006  .
716  .br  .SH REVISION
717  Copyright (c) 1997-2006 University of Cambridge.  .rs
718    .sp
719    .nf
720    Last updated: 18 December 2007
721    Copyright (c) 1997-2007 University of Cambridge.
722    .fi
Legend:
Removed from v.93  
changed lines
  Added in v.287
  ViewVC Help
Powered by ViewVC 1.1.5