/[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 227 by ph10, Tue Aug 21 15:00:15 2007 UTC revision 566 by ph10, Wed Nov 3 18:32:55 2010 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 154  effect as they do in Perl. For example: Line 165  effect as they do in Perl. For example:
165  .sp  .sp
166    /caseless/i    /caseless/i
167  .sp  .sp
168  The following table shows additional modifiers for setting PCRE options that do  The following table shows additional modifiers for setting PCRE compile-time
169  not correspond to anything in Perl:  options that do not correspond to anything in Perl:
170  .sp  .sp
171    \fB/A\fP          PCRE_ANCHORED    \fB/8\fP              PCRE_UTF8
172    \fB/C\fP          PCRE_AUTO_CALLOUT    \fB/?\fP              PCRE_NO_UTF8_CHECK
173    \fB/E\fP          PCRE_DOLLAR_ENDONLY    \fB/A\fP              PCRE_ANCHORED
174    \fB/f\fP          PCRE_FIRSTLINE    \fB/C\fP              PCRE_AUTO_CALLOUT
175    \fB/J\fP          PCRE_DUPNAMES    \fB/E\fP              PCRE_DOLLAR_ENDONLY
176    \fB/N\fP          PCRE_NO_AUTO_CAPTURE    \fB/f\fP              PCRE_FIRSTLINE
177    \fB/U\fP          PCRE_UNGREEDY    \fB/J\fP              PCRE_DUPNAMES
178    \fB/X\fP          PCRE_EXTRA    \fB/N\fP              PCRE_NO_AUTO_CAPTURE
179    \fB/<cr>\fP       PCRE_NEWLINE_CR    \fB/U\fP              PCRE_UNGREEDY
180    \fB/<lf>\fP       PCRE_NEWLINE_LF    \fB/W\fP              PCRE_UCP
181    \fB/<crlf>\fP     PCRE_NEWLINE_CRLF    \fB/X\fP              PCRE_EXTRA
182    \fB/<anycrlf>\fP  PCRE_NEWLINE_ANYCRLF    \fB/<JS>\fP           PCRE_JAVASCRIPT_COMPAT
183    \fB/<any>\fP      PCRE_NEWLINE_ANY    \fB/<cr>\fP           PCRE_NEWLINE_CR
184  .sp    \fB/<lf>\fP           PCRE_NEWLINE_LF
185  Those specifying line ending sequences are literal strings as shown, but the    \fB/<crlf>\fP         PCRE_NEWLINE_CRLF
186  letters can be in either case. This example sets multiline matching with CRLF    \fB/<anycrlf>\fP      PCRE_NEWLINE_ANYCRLF
187  as the line ending sequence:    \fB/<any>\fP          PCRE_NEWLINE_ANY
188      \fB/<bsr_anycrlf>\fP  PCRE_BSR_ANYCRLF
189      \fB/<bsr_unicode>\fP  PCRE_BSR_UNICODE
190    .sp
191    The modifiers that are enclosed in angle brackets are literal strings as shown,
192    including the angle brackets, but the letters can be in either case. This
193    example sets multiline matching with CRLF as the line ending sequence:
194  .sp  .sp
195    /^abc/m<crlf>    /^abc/m<crlf>
196  .sp  .sp
197  Details of the meanings of these PCRE options are given in the  As well as turning on the PCRE_UTF8 option, the \fB/8\fP modifier also causes
198    any non-printing characters in output strings to be printed using the
199    \ex{hh...} notation if they are valid UTF-8 sequences. Full details of the PCRE
200    options are given in the
201  .\" HREF  .\" HREF
202  \fBpcreapi\fP  \fBpcreapi\fP
203  .\"  .\"
# Line 197  substring. This makes a difference to th Line 217  substring. This makes a difference to th
217  begins with a lookbehind assertion (including \eb or \eB).  begins with a lookbehind assertion (including \eb or \eB).
218  .P  .P
219  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
220  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
221  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
222  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, and the
223  match is retried. This imitates the way Perl handles such cases when using the  normal match is retried. This imitates the way Perl handles such cases when
224  \fB/g\fP modifier or the \fBsplit()\fP function.  using the \fB/g\fP modifier or the \fBsplit()\fP function. Normally, the start
225    offset is advanced by one character, but if the newline convention recognizes
226    CRLF as a newline, and the current character is CR followed by LF, an advance
227    of two is used.
228  .  .
229  .  .
230  .SS "Other modifiers"  .SS "Other modifiers"
# Line 222  also present, this data is replaced by s Line 245  also present, this data is replaced by s
245  use in the automatic test scripts; it ensures that the same output is generated  use in the automatic test scripts; it ensures that the same output is generated
246  for different internal link sizes.  for different internal link sizes.
247  .P  .P
 The \fB/L\fP modifier must be followed directly by the name of a locale, for  
 example,  
 .sp  
   /pattern/Lfr_FR  
 .sp  
 For this reason, it must be the last modifier. The given locale is set,  
 \fBpcre_maketables()\fP is called to build a set of character tables for the  
 locale, and this is then passed to \fBpcre_compile()\fP when compiling the  
 regular expression. Without an \fB/L\fP modifier, NULL is passed as the tables  
 pointer; that is, \fB/L\fP applies only to the expression on which it appears.  
 .P  
 The \fB/I\fP modifier requests that \fBpcretest\fP output information about the  
 compiled pattern (whether it is anchored, has a fixed first character, and  
 so on). It does this by calling \fBpcre_fullinfo()\fP after compiling a  
 pattern. If the pattern is studied, the results of that are also output.  
 .P  
248  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
249  \fB/BI\fP, that is, both the \fB/B\fP and the \fB/I\fP modifiers.  \fB/BI\fP, that is, both the \fB/B\fP and the \fB/I\fP modifiers.
250  .P  .P
# Line 249  available when the POSIX interface to PC Line 256  available when the POSIX interface to PC
256  \fB/P\fP pattern modifier is specified. See also the section about saving and  \fB/P\fP pattern modifier is specified. See also the section about saving and
257  reloading compiled patterns below.  reloading compiled patterns below.
258  .P  .P
259  The \fB/S\fP modifier causes \fBpcre_study()\fP to be called after the  The \fB/I\fP modifier requests that \fBpcretest\fP output information about the
260  expression has been compiled, and the results used when the expression is  compiled pattern (whether it is anchored, has a fixed first character, and
261  matched.  so on). It does this by calling \fBpcre_fullinfo()\fP after compiling a
262    pattern. If the pattern is studied, the results of that are also output.
263    .P
264    The \fB/K\fP modifier requests \fBpcretest\fP to show names from backtracking
265    control verbs that are returned from calls to \fBpcre_exec()\fP. It causes
266    \fBpcretest\fP to create a \fBpcre_extra\fP block if one has not already been
267    created by a call to \fBpcre_study()\fP, and to set the PCRE_EXTRA_MARK flag
268    and the \fBmark\fP field within it, every time that \fBpcre_exec()\fP is
269    called. If the variable that the \fBmark\fP field points to is non-NULL for a
270    match, non-match, or partial match, \fBpcretest\fP prints the string to which
271    it points. For a match, this is shown on a line by itself, tagged with "MK:".
272    For a non-match it is added to the message.
273    .P
274    The \fB/L\fP modifier must be followed directly by the name of a locale, for
275    example,
276    .sp
277      /pattern/Lfr_FR
278    .sp
279    For this reason, it must be the last modifier. The given locale is set,
280    \fBpcre_maketables()\fP is called to build a set of character tables for the
281    locale, and this is then passed to \fBpcre_compile()\fP when compiling the
282    regular expression. Without an \fB/L\fP (or \fB/T\fP) modifier, NULL is passed
283    as the tables pointer; that is, \fB/L\fP applies only to the expression on
284    which it appears.
285  .P  .P
286  The \fB/M\fP modifier causes the size of memory block used to hold the compiled  The \fB/M\fP modifier causes the size of memory block used to hold the compiled
287  pattern to be output.  pattern to be output.
288  .P  .P
289    The \fB/S\fP modifier causes \fBpcre_study()\fP to be called after the
290    expression has been compiled, and the results used when the expression is
291    matched.
292    .P
293    The \fB/T\fP modifier must be followed by a single digit. It causes a specific
294    set of built-in character tables to be passed to \fBpcre_compile()\fP. It is
295    used in the standard PCRE tests to check behaviour with different character
296    tables. The digit specifies the tables as follows:
297    .sp
298      0   the default ASCII tables, as distributed in
299            pcre_chartables.c.dist
300      1   a set of tables defining ISO 8859 characters
301    .sp
302    In table 1, some characters whose codes are greater than 128 are identified as
303    letters, digits, spaces, etc.
304    .
305    .
306    .SS "Using the POSIX wrapper API"
307    .rs
308    .sp
309  The \fB/P\fP modifier causes \fBpcretest\fP to call PCRE via the POSIX wrapper  The \fB/P\fP modifier causes \fBpcretest\fP to call PCRE via the POSIX wrapper
310  API rather than its native API. When this is done, all other modifiers except  API rather than its native API. When \fB/P\fP is set, the following modifiers
311  \fB/i\fP, \fB/m\fP, and \fB/+\fP are ignored. REG_ICASE is set if \fB/i\fP is  set options for the \fBregcomp()\fP function:
312  present, and REG_NEWLINE is set if \fB/m\fP is present. The wrapper functions  .sp
313  force PCRE_DOLLAR_ENDONLY always, and PCRE_DOTALL unless REG_NEWLINE is set.    /i    REG_ICASE
314  .P    /m    REG_NEWLINE
315  The \fB/8\fP modifier causes \fBpcretest\fP to call PCRE with the PCRE_UTF8    /N    REG_NOSUB
316  option set. This turns on support for UTF-8 character handling in PCRE,    /s    REG_DOTALL     )
317  provided that it was compiled with this support enabled. This modifier also    /U    REG_UNGREEDY   ) These options are not part of
318  causes any non-printing characters in output strings to be printed using the    /W    REG_UCP        )   the POSIX standard
319  \ex{hh...} notation if they are valid UTF-8 sequences.    /8    REG_UTF8       )
320  .P  .sp
321  If the \fB/?\fP modifier is used with \fB/8\fP, it causes \fBpcretest\fP to  The \fB/+\fP modifier works as described above. All other modifiers are
322  call \fBpcre_compile()\fP with the PCRE_NO_UTF8_CHECK option, to suppress the  ignored.
 checking of the string for UTF-8 validity.  
323  .  .
324  .  .
325  .SH "DATA LINES"  .SH "DATA LINES"
# Line 342  recognized: Line 391  recognized:
391                 MATCH_LIMIT_RECURSION settings                 MATCH_LIMIT_RECURSION settings
392  .\" JOIN  .\" JOIN
393    \eN         pass the PCRE_NOTEMPTY option to \fBpcre_exec()\fP    \eN         pass the PCRE_NOTEMPTY option to \fBpcre_exec()\fP
394                 or \fBpcre_dfa_exec()\fP                 or \fBpcre_dfa_exec()\fP; if used twice, pass the
395                   PCRE_NOTEMPTY_ATSTART option
396  .\" JOIN  .\" JOIN
397    \eOdd       set the size of the output vector passed to    \eOdd       set the size of the output vector passed to
398                 \fBpcre_exec()\fP to dd (any number of digits)                 \fBpcre_exec()\fP to dd (any number of digits)
399  .\" JOIN  .\" JOIN
400    \eP         pass the PCRE_PARTIAL option to \fBpcre_exec()\fP    \eP         pass the PCRE_PARTIAL_SOFT option to \fBpcre_exec()\fP
401                 or \fBpcre_dfa_exec()\fP                 or \fBpcre_dfa_exec()\fP; if used twice, pass the
402                   PCRE_PARTIAL_HARD option
403  .\" JOIN  .\" JOIN
404    \eQdd       set the PCRE_MATCH_LIMIT_RECURSION limit to dd    \eQdd       set the PCRE_MATCH_LIMIT_RECURSION limit to dd
405                 (any number of digits)                 (any number of digits)
406    \eR         pass the PCRE_DFA_RESTART option to \fBpcre_dfa_exec()\fP    \eR         pass the PCRE_DFA_RESTART option to \fBpcre_dfa_exec()\fP
407    \eS         output details of memory get/free calls during matching    \eS         output details of memory get/free calls during matching
408  .\" JOIN  .\" JOIN
409      \eY         pass the PCRE_NO_START_OPTIMIZE option to \fBpcre_exec()\fP
410                   or \fBpcre_dfa_exec()\fP
411    .\" JOIN
412    \eZ         pass the PCRE_NOTEOL option to \fBpcre_exec()\fP    \eZ         pass the PCRE_NOTEOL option to \fBpcre_exec()\fP
413                 or \fBpcre_dfa_exec()\fP                 or \fBpcre_dfa_exec()\fP
414  .\" JOIN  .\" JOIN
# Line 405  by the \fB-O\fP command line option (or Line 459  by the \fB-O\fP command line option (or
459  the call of \fBpcre_exec()\fP for the line in which it appears.  the call of \fBpcre_exec()\fP for the line in which it appears.
460  .P  .P
461  If the \fB/P\fP modifier was present on the pattern, causing the POSIX wrapper  If the \fB/P\fP modifier was present on the pattern, causing the POSIX wrapper
462  API to be used, the only option-setting sequences that have any effect are \eB  API to be used, the only option-setting sequences that have any effect are \eB,
463  and \eZ, causing REG_NOTBOL and REG_NOTEOL, respectively, to be passed to  \eN, and \eZ, causing REG_NOTBOL, REG_NOTEMPTY, and REG_NOTEOL, respectively,
464  \fBregexec()\fP.  to be passed to \fBregexec()\fP.
465  .P  .P
466  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
467  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
# Line 446  This section describes the output when t Line 500  This section describes the output when t
500  .P  .P
501  When a match succeeds, pcretest outputs the list of captured substrings that  When a match succeeds, pcretest outputs the list of captured substrings that
502  \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
503  the whole pattern. Otherwise, it outputs "No match" or "Partial match"  the whole pattern. Otherwise, it outputs "No match" when the return is
504  when \fBpcre_exec()\fP returns PCRE_ERROR_NOMATCH or PCRE_ERROR_PARTIAL,  PCRE_ERROR_NOMATCH, and "Partial match:" followed by the partially matching
505  respectively, and otherwise the PCRE negative error number. Here is an example  substring when \fBpcre_exec()\fP returns PCRE_ERROR_PARTIAL. (Note that this is
506  of an interactive \fBpcretest\fP run.  the entire substring that was inspected during the partial match; it may
507    include characters before the actual match start if a lookbehind assertion,
508    \eK, \eb, or \eB was involved.) For any other returns, it outputs the PCRE
509    negative error number. Here is an example of an interactive \fBpcretest\fP run.
510  .sp  .sp
511    $ pcretest    $ pcretest
512    PCRE version 7.0 30-Nov-2006    PCRE version 7.0 30-Nov-2006
# Line 461  of an interactive \fBpcretest\fP run. Line 518  of an interactive \fBpcretest\fP run.
518    data> xyz    data> xyz
519    No match    No match
520  .sp  .sp
521    Note that unset capturing substrings that are not followed by one that is set
522    are not returned by \fBpcre_exec()\fP, and are not shown by \fBpcretest\fP. In
523    the following example, there are two capturing substrings, but when the first
524    data line is matched, the second, unset substring is not shown. An "internal"
525    unset substring is shown as "<unset>", as for the second data line.
526    .sp
527        re> /(a)|(b)/
528      data> a
529       0: a
530       1: a
531      data> b
532       0: b
533       1: <unset>
534       2: b
535    .sp
536  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
537  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
538  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 515  the subject where there is at least one Line 587  the subject where there is at least one
587     2: tan     2: tan
588  .sp  .sp
589  (Using the normal matching function on this data finds only "tang".) The  (Using the normal matching function on this data finds only "tang".) The
590  longest matching string is always given first (and numbered zero).  longest matching string is always given first (and numbered zero). After a
591    PCRE_ERROR_PARTIAL return, the output is "Partial match:", followed by the
592    partially matching substring. (Note that this is the entire substring that was
593    inspected during the partial match; it may include characters before the actual
594    match start if a lookbehind assertion, \eK, \eb, or \eB was involved.)
595  .P  .P
596  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
597  at the end of the longest match. For example:  at the end of the longest match. For example:
# Line 694  Cambridge CB2 3QH, England. Line 770  Cambridge CB2 3QH, England.
770  .rs  .rs
771  .sp  .sp
772  .nf  .nf
773  Last updated: 21 August 2007  Last updated: 01 November 2010
774  Copyright (c) 1997-2007 University of Cambridge.  Copyright (c) 1997-2010 University of Cambridge.
775  .fi  .fi

Legend:
Removed from v.227  
changed lines
  Added in v.566

  ViewVC Help
Powered by ViewVC 1.1.5