/[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 91 by nigel, Sat Feb 24 21:41:34 2007 UTC revision 289 by ph10, Sun Dec 23 12:17:20 2007 UTC
# Line 24  documentation. Line 24  documentation.
24  .SH OPTIONS  .SH OPTIONS
25  .rs  .rs
26  .TP 10  .TP 10
27    \fB-b\fP
28    Behave as if each regex has the \fB/B\fP (show bytecode) modifier; the internal
29    form is output after compilation.
30    .TP 10
31  \fB-C\fP  \fB-C\fP
32  Output the version number of the PCRE library, and all available information  Output the version number of the PCRE library, and all available information
33  about the optional features that are included, and then exit.  about the optional features that are included, and then exit.
34  .TP 10  .TP 10
35  \fB-d\fP  \fB-d\fP
36  Behave as if each regex has the \fB/D\fP (debug) modifier; the internal  Behave as if each regex has the \fB/D\fP (debug) modifier; the internal
37  form is output after compilation.  form and information about the compiled pattern is output after compilation;
38    \fB-d\fP is equivalent to \fB-b -i\fP.
39  .TP 10  .TP 10
40  \fB-dfa\fP  \fB-dfa\fP
41  Behave as if each data line contains the \eD escape sequence; this causes the  Behave as if each data line contains the \eD escape sequence; this causes the
42  alternative matching function, \fBpcre_dfa_exec()\fP, to be used instead of the  alternative matching function, \fBpcre_dfa_exec()\fP, to be used instead of the
43  standard \fBpcre_exec()\fP function (more detail is given below).  standard \fBpcre_exec()\fP function (more detail is given below).
44  .TP 10  .TP 10
45    \fB-help\fP
46    Output a brief summary these options and then exit.
47    .TP 10
48  \fB-i\fP  \fB-i\fP
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.
# Line 48  with earlier versions of pcretest, \fB-s Line 56  with earlier versions of pcretest, \fB-s
56  .TP 10  .TP 10
57  \fB-o\fP \fIosize\fP  \fB-o\fP \fIosize\fP
58  Set the number of elements in the output vector that is used when calling  Set the number of elements in the output vector that is used when calling
59  \fBpcre_exec()\fP to be \fIosize\fP. The default value is 45, which is enough  \fBpcre_exec()\fP or \fBpcre_dfa_exec()\fP to be \fIosize\fP. The default value
60  for 14 capturing subexpressions. The vector size can be changed for individual  is 45, which is enough for 14 capturing subexpressions for \fBpcre_exec()\fP or
61  matching calls by including \eO in the data line (see below).  22 different matches for \fBpcre_dfa_exec()\fP. The vector size can be
62    changed for individual matching calls by including \eO in the data line (see
63    below).
64  .TP 10  .TP 10
65  \fB-p\fP  \fB-p\fP
66  Behave as if each regex has the \fB/P\fP modifier; the POSIX wrapper API is  Behave as if each regex has the \fB/P\fP modifier; the POSIX wrapper API is
# Line 68  megabytes. Line 78  megabytes.
78  Run each compile, study, and match many times with a timer, and output  Run each compile, study, and match many times with a timer, and output
79  resulting time per compile or match (in milliseconds). Do not set \fB-m\fP with  resulting time per compile or match (in milliseconds). Do not set \fB-m\fP with
80  \fB-t\fP, because you will then get the size output a zillion times, and the  \fB-t\fP, because you will then get the size output a zillion times, and the
81  timing will be distorted.  timing will be distorted. You can control the number of iterations that are
82    used for timing by following \fB-t\fP with a number (as a separate item on the
83    command line). For example, "-t 1000" would iterate 1000 times. The default is
84    to iterate 500000 times.
85    .TP 10
86    \fB-tm\fP
87    This is like \fB-t\fP except that it times only the matching phase, not the
88    compile or study phases.
89  .  .
90  .  .
91  .SH DESCRIPTION  .SH DESCRIPTION
# Line 80  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.
109  .P  .P
110  Each data line is matched separately and independently. If you want to do  Each data line is matched separately and independently. If you want to do
111  multi-line matches, you have to use the \en escape sequence (or \er or \er\en,  multi-line matches, you have to use the \en escape sequence (or \er or \er\en,
112  depending on the newline setting) in a single line of input to encode the  etc., depending on the newline setting) in a single line of input to encode the
113  newline characters. There is no limit on the length of data lines; the input  newline sequences. There is no limit on the length of data lines; the input
114  buffer is automatically extended if it is too small.  buffer is automatically extended if it is too small.
115  .P  .P
116  An empty line signals the end of the data lines, at which point a new regular  An empty line signals the end of the data lines, at which point a new regular
# Line 140  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/<anycrlf>\fP      PCRE_NEWLINE_ANYCRLF
178      \fB/<any>\fP          PCRE_NEWLINE_ANY
179      \fB/<bsr_anycrlf>\fP  PCRE_BSR_ANYCRLF
180      \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  Those specifying line endings are literal strings as shown. Details of the    /^abc/m<crlf>
187  meanings of these PCRE options are given in the  .sp
188    Details of the meanings of these PCRE options are given in the
189  .\" HREF  .\" HREF
190  \fBpcreapi\fP  \fBpcreapi\fP
191  .\"  .\"
# Line 191  matched the entire pattern, pcretest sho Line 223  matched the entire pattern, pcretest sho
223  the subject string. This is useful for tests where the subject contains  the subject string. This is useful for tests where the subject contains
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
227    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
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,
235  .sp  .sp
# Line 207  compiled pattern (whether it is anchored Line 246  compiled pattern (whether it is anchored
246  so on). It does this by calling \fBpcre_fullinfo()\fP after compiling a  so on). It does this by calling \fBpcre_fullinfo()\fP after compiling a
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, which also assumes \fB/I\fP.  The \fB/D\fP modifier is a PCRE debugging feature, and is equivalent to
250  It causes the internal form of compiled regular expressions to be output after  \fB/BI\fP, that is, both the \fB/B\fP and the \fB/I\fP modifiers.
 compilation. If the pattern was studied, the information returned is also  
 output.  
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 254  complicated features of PCRE. If you are Line 291  complicated features of PCRE. If you are
291  expressions, you probably don't need any of these. The following escapes are  expressions, you probably don't need any of these. The following escapes are
292  recognized:  recognized:
293  .sp  .sp
294    \ea         alarm (= BEL)    \ea         alarm (BEL, \ex07)
295    \eb         backspace    \eb         backspace (\ex08)
296    \ee         escape    \ee         escape (\ex27)
297    \ef         formfeed    \ef         formfeed (\ex0c)
298    \en         newline    \en         newline (\ex0a)
299  .\" JOIN  .\" JOIN
300    \eqdd       set the PCRE_MATCH_LIMIT limit to dd    \eqdd       set the PCRE_MATCH_LIMIT limit to dd
301                 (any number of digits)                 (any number of digits)
302    \er         carriage return    \er         carriage return (\ex0d)
303    \et         tab    \et         tab (\ex09)
304    \ev         vertical tab    \ev         vertical tab (\ex0b)
305    \ennn       octal character (up to 3 octal digits)    \ennn       octal character (up to 3 octal digits)
306    \exhh       hexadecimal character (up to 2 hex digits)    \exhh       hexadecimal character (up to 2 hex digits)
307  .\" JOIN  .\" JOIN
# Line 344  recognized: Line 381  recognized:
381  .\" JOIN  .\" JOIN
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
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
389                   or \fBpcre_dfa_exec()\fP
390  .sp  .sp
391  The escapes that specify line endings are literal strings, exactly as shown.  The escapes that specify line ending sequences are literal strings, exactly as
392  A backslash followed by anything else just escapes the anything else. If the  shown. No more than one newline setting should be present in any data line.
393  very last character is a backslash, it is ignored. This gives a way of passing  .P
394  an empty line as data, since a real empty line terminates the data input.  A backslash followed by anything else just escapes the anything else. If
395    the very last character is a backslash, it is ignored. This gives a way of
396    passing an empty line as data, since a real empty line terminates the data
397    input.
398  .P  .P
399  If \eM is present, \fBpcretest\fP calls \fBpcre_exec()\fP several times, with  If \eM is present, \fBpcretest\fP calls \fBpcre_exec()\fP several times, with
400  different values in the \fImatch_limit\fP and \fImatch_limit_recursion\fP  different values in the \fImatch_limit\fP and \fImatch_limit_recursion\fP
# Line 374  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 411  respectively, and otherwise the PCRE neg Line 460  respectively, and otherwise the PCRE neg
460  of an interactive \fBpcretest\fP run.  of an interactive \fBpcretest\fP run.
461  .sp  .sp
462    $ pcretest    $ pcretest
463    PCRE version 5.00 07-Sep-2004    PCRE version 7.0 30-Nov-2006
464  .sp  .sp
465      re> /^abc(\ed+)/      re> /^abc(\ed+)/
466    data> abc123    data> abc123
# Line 420  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. If the pattern has the \fB/+\fP modifier, the output for substring 0  pattern. See below for the definition of non-printing characters. If the
490  is followed by the the rest of the subject string, identified by "0+" like  pattern has the \fB/+\fP modifier, the output for substring 0 is followed by
491  this:  the the rest of the subject string, identified by "0+" like this:
492  .sp  .sp
493      re> /cat/+      re> /cat/+
494    data> cataract    data> cataract
# Line 452  instead of a colon. This is in addition Line 516  instead of a colon. This is in addition
516  length (that is, the return from the extraction function) is given in  length (that is, the return from the extraction function) is given in
517  parentheses after each string for \fB\eC\fP and \fB\eG\fP.  parentheses after each string for \fB\eC\fP and \fB\eG\fP.
518  .P  .P
519  Note that while patterns can be continued over several lines (a plain ">"  Note that whereas patterns can be continued over several lines (a plain ">"
520  prompt is used for continuations), data lines may not. However newlines can be  prompt is used for continuations), data lines may not. However newlines can be
521  included in data by means of the \en escape (or \er or \er\en for those newline  included in data by means of the \en escape (or \er, \er\en, etc., depending on
522  settings).  the newline sequence setting).
523    .
524  .  .
525  .  .
526  .SH "OUTPUT FROM THE ALTERNATIVE MATCHING FUNCTION"  .SH "OUTPUT FROM THE ALTERNATIVE MATCHING FUNCTION"
# Line 475  the subject where there is at least one Line 540  the subject where there is at least one
540  (Using the normal matching function on this data finds only "tang".) The  (Using the normal matching function on this data finds only "tang".) The
541  longest matching string is always given first (and numbered zero).  longest matching string is always given first (and numbered zero).
542  .P  .P
543  If \fB/g\P 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
544  at the end of the longest match. For example:  at the end of the longest match. For example:
545  .sp  .sp
546      re> /(tang|tangerine|tan)/g      re> /(tang|tangerine|tan)/g
# Line 499  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 556  the Line 621  the
621  documentation.  documentation.
622  .  .
623  .  .
624    .
625    .SH "NON-PRINTING CHARACTERS"
626    .rs
627    .sp
628    When \fBpcretest\fP is outputting text in the compiled version of a pattern,
629    bytes other than 32-126 are always treated as non-printing characters are are
630    therefore shown as hex escapes.
631    .P
632    When \fBpcretest\fP is outputting text that is a matched part of a subject
633    string, it behaves in the same way, unless a different locale has been set for
634    the pattern (using the \fB/L\fP modifier). In this case, the \fBisprint()\fP
635    function to distinguish printing and non-printing characters.
636    .
637    .
638    .
639  .SH "SAVING AND RELOADING COMPILED PATTERNS"  .SH "SAVING AND RELOADING COMPILED PATTERNS"
640  .rs  .rs
641  .sp  .sp
# Line 616  Finally, if you attempt to load a file t Line 696  Finally, if you attempt to load a file t
696  result is undefined.  result is undefined.
697  .  .
698  .  .
699    .SH "SEE ALSO"
700    .rs
701    .sp
702    \fBpcre\fP(3), \fBpcreapi\fP(3), \fBpcrecallout\fP(3), \fBpcrematching\fP(3),
703    \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
712  University Computing Service,  Cambridge CB2 3QH, England.
713  .br  .fi
714  Cambridge CB2 3QG, England.  .
715  .P  .
716  .in 0  .SH REVISION
717  Last updated: 29 June 2006  .rs
718  .br  .sp
719  Copyright (c) 1997-2006 University of Cambridge.  .nf
720    Last updated: 18 December 2007
721    Copyright (c) 1997-2007 University of Cambridge.
722    .fi

Legend:
Removed from v.91  
changed lines
  Added in v.289

  ViewVC Help
Powered by ViewVC 1.1.5