/[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 345 by ph10, Mon Apr 28 15:10:02 2008 UTC revision 576 by ph10, Sun Nov 21 18:45:10 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 160  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/8\fP              PCRE_UTF8
172      \fB/?\fP              PCRE_NO_UTF8_CHECK
173    \fB/A\fP              PCRE_ANCHORED    \fB/A\fP              PCRE_ANCHORED
174    \fB/C\fP              PCRE_AUTO_CALLOUT    \fB/C\fP              PCRE_AUTO_CALLOUT
175    \fB/E\fP              PCRE_DOLLAR_ENDONLY    \fB/E\fP              PCRE_DOLLAR_ENDONLY
# Line 170  not correspond to anything in Perl: Line 177  not correspond to anything in Perl:
177    \fB/J\fP              PCRE_DUPNAMES    \fB/J\fP              PCRE_DUPNAMES
178    \fB/N\fP              PCRE_NO_AUTO_CAPTURE    \fB/N\fP              PCRE_NO_AUTO_CAPTURE
179    \fB/U\fP              PCRE_UNGREEDY    \fB/U\fP              PCRE_UNGREEDY
180      \fB/W\fP              PCRE_UCP
181    \fB/X\fP              PCRE_EXTRA    \fB/X\fP              PCRE_EXTRA
182      \fB/Y\fP              PCRE_NO_START_OPTIMIZE
183    \fB/<JS>\fP           PCRE_JAVASCRIPT_COMPAT    \fB/<JS>\fP           PCRE_JAVASCRIPT_COMPAT
184    \fB/<cr>\fP           PCRE_NEWLINE_CR    \fB/<cr>\fP           PCRE_NEWLINE_CR
185    \fB/<lf>\fP           PCRE_NEWLINE_LF    \fB/<lf>\fP           PCRE_NEWLINE_LF
# Line 180  not correspond to anything in Perl: Line 189  not correspond to anything in Perl:
189    \fB/<bsr_anycrlf>\fP  PCRE_BSR_ANYCRLF    \fB/<bsr_anycrlf>\fP  PCRE_BSR_ANYCRLF
190    \fB/<bsr_unicode>\fP  PCRE_BSR_UNICODE    \fB/<bsr_unicode>\fP  PCRE_BSR_UNICODE
191  .sp  .sp
192  Those specifying line ending sequences are literal strings as shown, but the  The modifiers that are enclosed in angle brackets are literal strings as shown,
193  letters can be in either case. This example sets multiline matching with CRLF  including the angle brackets, but the letters can be in either case. This
194  as the line ending sequence:  example sets multiline matching with CRLF as the line ending sequence:
195  .sp  .sp
196    /^abc/m<crlf>    /^abc/m<crlf>
197  .sp  .sp
198  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
199    any non-printing characters in output strings to be printed using the
200    \ex{hh...} notation if they are valid UTF-8 sequences. Full details of the PCRE
201    options are given in the
202  .\" HREF  .\" HREF
203  \fBpcreapi\fP  \fBpcreapi\fP
204  .\"  .\"
# Line 206  substring. This makes a difference to th Line 218  substring. This makes a difference to th
218  begins with a lookbehind assertion (including \eb or \eB).  begins with a lookbehind assertion (including \eb or \eB).
219  .P  .P
220  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
221  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
222  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
223  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
224  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
225  \fB/g\fP modifier or the \fBsplit()\fP function.  using the \fB/g\fP modifier or the \fBsplit()\fP function. Normally, the start
226    offset is advanced by one character, but if the newline convention recognizes
227    CRLF as a newline, and the current character is CR followed by LF, an advance
228    of two is used.
229  .  .
230  .  .
231  .SS "Other modifiers"  .SS "Other modifiers"
# Line 231  also present, this data is replaced by s Line 246  also present, this data is replaced by s
246  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
247  for different internal link sizes.  for different internal link sizes.
248  .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  
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 \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.
251  .P  .P
# Line 258  available when the POSIX interface to PC Line 257  available when the POSIX interface to PC
257  \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
258  reloading compiled patterns below.  reloading compiled patterns below.
259  .P  .P
260  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
261  expression has been compiled, and the results used when the expression is  compiled pattern (whether it is anchored, has a fixed first character, and
262  matched.  so on). It does this by calling \fBpcre_fullinfo()\fP after compiling a
263    pattern. If the pattern is studied, the results of that are also output.
264    .P
265    The \fB/K\fP modifier requests \fBpcretest\fP to show names from backtracking
266    control verbs that are returned from calls to \fBpcre_exec()\fP. It causes
267    \fBpcretest\fP to create a \fBpcre_extra\fP block if one has not already been
268    created by a call to \fBpcre_study()\fP, and to set the PCRE_EXTRA_MARK flag
269    and the \fBmark\fP field within it, every time that \fBpcre_exec()\fP is
270    called. If the variable that the \fBmark\fP field points to is non-NULL for a
271    match, non-match, or partial match, \fBpcretest\fP prints the string to which
272    it points. For a match, this is shown on a line by itself, tagged with "MK:".
273    For a non-match it is added to the message.
274    .P
275    The \fB/L\fP modifier must be followed directly by the name of a locale, for
276    example,
277    .sp
278      /pattern/Lfr_FR
279    .sp
280    For this reason, it must be the last modifier. The given locale is set,
281    \fBpcre_maketables()\fP is called to build a set of character tables for the
282    locale, and this is then passed to \fBpcre_compile()\fP when compiling the
283    regular expression. Without an \fB/L\fP (or \fB/T\fP) modifier, NULL is passed
284    as the tables pointer; that is, \fB/L\fP applies only to the expression on
285    which it appears.
286  .P  .P
287  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
288  pattern to be output.  pattern to be output.
289  .P  .P
290    The \fB/S\fP modifier causes \fBpcre_study()\fP to be called after the
291    expression has been compiled, and the results used when the expression is
292    matched.
293    .P
294    The \fB/T\fP modifier must be followed by a single digit. It causes a specific
295    set of built-in character tables to be passed to \fBpcre_compile()\fP. It is
296    used in the standard PCRE tests to check behaviour with different character
297    tables. The digit specifies the tables as follows:
298    .sp
299      0   the default ASCII tables, as distributed in
300            pcre_chartables.c.dist
301      1   a set of tables defining ISO 8859 characters
302    .sp
303    In table 1, some characters whose codes are greater than 128 are identified as
304    letters, digits, spaces, etc.
305    .
306    .
307    .SS "Using the POSIX wrapper API"
308    .rs
309    .sp
310  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
311  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
312  \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:
313  present, and REG_NEWLINE is set if \fB/m\fP is present. The wrapper functions  .sp
314  force PCRE_DOLLAR_ENDONLY always, and PCRE_DOTALL unless REG_NEWLINE is set.    /i    REG_ICASE
315  .P    /m    REG_NEWLINE
316  The \fB/8\fP modifier causes \fBpcretest\fP to call PCRE with the PCRE_UTF8    /N    REG_NOSUB
317  option set. This turns on support for UTF-8 character handling in PCRE,    /s    REG_DOTALL     )
318  provided that it was compiled with this support enabled. This modifier also    /U    REG_UNGREEDY   ) These options are not part of
319  causes any non-printing characters in output strings to be printed using the    /W    REG_UCP        )   the POSIX standard
320  \ex{hh...} notation if they are valid UTF-8 sequences.    /8    REG_UTF8       )
321  .P  .sp
322  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
323  call \fBpcre_compile()\fP with the PCRE_NO_UTF8_CHECK option, to suppress the  ignored.
 checking of the string for UTF-8 validity.  
324  .  .
325  .  .
326  .SH "DATA LINES"  .SH "DATA LINES"
# Line 304  recognized: Line 345  recognized:
345    \et         tab (\ex09)    \et         tab (\ex09)
346    \ev         vertical tab (\ex0b)    \ev         vertical tab (\ex0b)
347    \ennn       octal character (up to 3 octal digits)    \ennn       octal character (up to 3 octal digits)
348    \exhh       hexadecimal character (up to 2 hex digits)                 always a byte unless > 255 in UTF-8 mode
349      \exhh       hexadecimal byte (up to 2 hex digits)
350  .\" JOIN  .\" JOIN
351    \ex{hh...}  hexadecimal character, any number of digits    \ex{hh...}  hexadecimal character, any number of digits
352                 in UTF-8 mode                 in UTF-8 mode
# Line 351  recognized: Line 393  recognized:
393                 MATCH_LIMIT_RECURSION settings                 MATCH_LIMIT_RECURSION settings
394  .\" JOIN  .\" JOIN
395    \eN         pass the PCRE_NOTEMPTY option to \fBpcre_exec()\fP    \eN         pass the PCRE_NOTEMPTY option to \fBpcre_exec()\fP
396                 or \fBpcre_dfa_exec()\fP                 or \fBpcre_dfa_exec()\fP; if used twice, pass the
397                   PCRE_NOTEMPTY_ATSTART option
398  .\" JOIN  .\" JOIN
399    \eOdd       set the size of the output vector passed to    \eOdd       set the size of the output vector passed to
400                 \fBpcre_exec()\fP to dd (any number of digits)                 \fBpcre_exec()\fP to dd (any number of digits)
401  .\" JOIN  .\" JOIN
402    \eP         pass the PCRE_PARTIAL option to \fBpcre_exec()\fP    \eP         pass the PCRE_PARTIAL_SOFT option to \fBpcre_exec()\fP
403                 or \fBpcre_dfa_exec()\fP                 or \fBpcre_dfa_exec()\fP; if used twice, pass the
404                   PCRE_PARTIAL_HARD option
405  .\" JOIN  .\" JOIN
406    \eQdd       set the PCRE_MATCH_LIMIT_RECURSION limit to dd    \eQdd       set the PCRE_MATCH_LIMIT_RECURSION limit to dd
407                 (any number of digits)                 (any number of digits)
408    \eR         pass the PCRE_DFA_RESTART option to \fBpcre_dfa_exec()\fP    \eR         pass the PCRE_DFA_RESTART option to \fBpcre_dfa_exec()\fP
409    \eS         output details of memory get/free calls during matching    \eS         output details of memory get/free calls during matching
410  .\" JOIN  .\" JOIN
411      \eY         pass the PCRE_NO_START_OPTIMIZE option to \fBpcre_exec()\fP
412                   or \fBpcre_dfa_exec()\fP
413    .\" JOIN
414    \eZ         pass the PCRE_NOTEOL option to \fBpcre_exec()\fP    \eZ         pass the PCRE_NOTEOL option to \fBpcre_exec()\fP
415                 or \fBpcre_dfa_exec()\fP                 or \fBpcre_dfa_exec()\fP
416  .\" JOIN  .\" JOIN
417    \e?         pass the PCRE_NO_UTF8_CHECK option to    \e?         pass the PCRE_NO_UTF8_CHECK option to
418                 \fBpcre_exec()\fP or \fBpcre_dfa_exec()\fP                 \fBpcre_exec()\fP or \fBpcre_dfa_exec()\fP
   \e>dd       start the match at offset dd (any number of digits);  
419  .\" JOIN  .\" JOIN
420                 this sets the \fIstartoffset\fP argument for \fBpcre_exec()\fP    \e>dd       start the match at offset dd (optional "-"; then
421                 or \fBpcre_dfa_exec()\fP                 any number of digits); this sets the \fIstartoffset\fP
422                   argument for \fBpcre_exec()\fP or \fBpcre_dfa_exec()\fP
423  .\" JOIN  .\" JOIN
424    \e<cr>      pass the PCRE_NEWLINE_CR option to \fBpcre_exec()\fP    \e<cr>      pass the PCRE_NEWLINE_CR option to \fBpcre_exec()\fP
425                 or \fBpcre_dfa_exec()\fP                 or \fBpcre_dfa_exec()\fP
# Line 389  recognized: Line 436  recognized:
436    \e<any>     pass the PCRE_NEWLINE_ANY option to \fBpcre_exec()\fP    \e<any>     pass the PCRE_NEWLINE_ANY option to \fBpcre_exec()\fP
437                 or \fBpcre_dfa_exec()\fP                 or \fBpcre_dfa_exec()\fP
438  .sp  .sp
439    Note that \exhh always specifies one byte, even in UTF-8 mode; this makes it
440    possible to construct invalid UTF-8 sequences for testing purposes. On the
441    other hand, \ex{hh} is interpreted as a UTF-8 character in UTF-8 mode,
442    generating more than one byte if the value is greater than 127. When not in
443    UTF-8 mode, it generates one byte for values less than 256, and causes an error
444    for greater values.
445    .P
446  The escapes that specify line ending sequences are literal strings, exactly as  The escapes that specify line ending sequences are literal strings, exactly as
447  shown. No more than one newline setting should be present in any data line.  shown. No more than one newline setting should be present in any data line.
448  .P  .P
# Line 414  by the \fB-O\fP command line option (or Line 468  by the \fB-O\fP command line option (or
468  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.
469  .P  .P
470  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
471  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,
472  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,
473  \fBregexec()\fP.  to be passed to \fBregexec()\fP.
474  .P  .P
475  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
476  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 455  This section describes the output when t Line 509  This section describes the output when t
509  .P  .P
510  When a match succeeds, pcretest outputs the list of captured substrings that  When a match succeeds, pcretest outputs the list of captured substrings that
511  \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
512  the whole pattern. Otherwise, it outputs "No match" or "Partial match"  the whole pattern. Otherwise, it outputs "No match" when the return is
513  when \fBpcre_exec()\fP returns PCRE_ERROR_NOMATCH or PCRE_ERROR_PARTIAL,  PCRE_ERROR_NOMATCH, and "Partial match:" followed by the partially matching
514  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
515  of an interactive \fBpcretest\fP run.  the entire substring that was inspected during the partial match; it may
516    include characters before the actual match start if a lookbehind assertion,
517    \eK, \eb, or \eB was involved.) For any other returns, it outputs the PCRE
518    negative error number. Here is an example of an interactive \fBpcretest\fP run.
519  .sp  .sp
520    $ pcretest    $ pcretest
521    PCRE version 7.0 30-Nov-2006    PCRE version 7.0 30-Nov-2006
# Line 539  the subject where there is at least one Line 596  the subject where there is at least one
596     2: tan     2: tan
597  .sp  .sp
598  (Using the normal matching function on this data finds only "tang".) The  (Using the normal matching function on this data finds only "tang".) The
599  longest matching string is always given first (and numbered zero).  longest matching string is always given first (and numbered zero). After a
600    PCRE_ERROR_PARTIAL return, the output is "Partial match:", followed by the
601    partially matching substring. (Note that this is the entire substring that was
602    inspected during the partial match; it may include characters before the actual
603    match start if a lookbehind assertion, \eK, \eb, or \eB was involved.)
604  .P  .P
605  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
606  at the end of the longest match. For example:  at the end of the longest match. For example:
# Line 718  Cambridge CB2 3QH, England. Line 779  Cambridge CB2 3QH, England.
779  .rs  .rs
780  .sp  .sp
781  .nf  .nf
782  Last updated: 12 April 2008  Last updated: 21 November 2010
783  Copyright (c) 1997-2008 University of Cambridge.  Copyright (c) 1997-2010 University of Cambridge.
784  .fi  .fi

Legend:
Removed from v.345  
changed lines
  Added in v.576

  ViewVC Help
Powered by ViewVC 1.1.5