/[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 287 by ph10, Tue Dec 18 20:11:28 2007 UTC revision 599 by ph10, Sat May 7 16:09:06 2011 UTC
# Line 25  documentation. Line 25  documentation.
25  .rs  .rs
26  .TP 10  .TP 10
27  \fB-b\fP  \fB-b\fP
28  Behave as if each regex has the \fB/B\fP (show bytecode) modifier; the internal  Behave as if each regex has the \fB/B\fP (show byte code) modifier; the
29  form is output after compilation.  internal form is output after compilation.
30  .TP 10  .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
# 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 71  set. Line 76  set.
76  Do not output the version number of \fBpcretest\fP at the start of execution.  Do not output the version number of \fBpcretest\fP at the start of execution.
77  .TP 10  .TP 10
78  \fB-S\fP \fIsize\fP  \fB-S\fP \fIsize\fP
79  On Unix-like systems, set the size of the runtime stack to \fIsize\fP  On Unix-like systems, set the size of the run-time stack to \fIsize\fP
80  megabytes.  megabytes.
81  .TP 10  .TP 10
82  \fB-t\fP  \fB-t\fP
# 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  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  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  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  provides line-editing and history facilities. The output from the \fB-help\fP
# Line 149  pcretest to read the next line as a cont Line 154  pcretest to read the next line as a cont
154  A pattern may be followed by any number of modifiers, which are mostly single  A pattern may be followed by any number of modifiers, which are mostly single
155  characters. Following Perl usage, these are referred to below as, for example,  characters. Following Perl usage, these are referred to below as, for example,
156  "the \fB/i\fP modifier", even though the delimiter of the pattern need not  "the \fB/i\fP modifier", even though the delimiter of the pattern need not
157  always be a slash, and no slash is used when writing modifiers. Whitespace may  always be a slash, and no slash is used when writing modifiers. White space may
158  appear between the final pattern delimiter and the first modifier, and between  appear between the final pattern delimiter and the first modifier, and between
159  the modifiers themselves.  the modifiers themselves.
160  .P  .P
# 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
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
186    \fB/<crlf>\fP         PCRE_NEWLINE_CRLF    \fB/<crlf>\fP         PCRE_NEWLINE_CRLF
# Line 179  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 205  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 230  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 257  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"
327  .rs  .rs
328  .sp  .sp
329  Before each data line is passed to \fBpcre_exec()\fP, leading and trailing  Before each data line is passed to \fBpcre_exec()\fP, leading and trailing
330  whitespace is removed, and it is then scanned for \e escapes. Some of these are  white space is removed, and it is then scanned for \e escapes. Some of these
331  pretty esoteric features, intended for checking out some of the more  are pretty esoteric features, intended for checking out some of the more
332  complicated features of PCRE. If you are just testing "ordinary" regular  complicated features of PCRE. If you are just testing "ordinary" regular
333  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
334  recognized:  recognized:
# Line 294  recognized: Line 336  recognized:
336    \ea         alarm (BEL, \ex07)    \ea         alarm (BEL, \ex07)
337    \eb         backspace (\ex08)    \eb         backspace (\ex08)
338    \ee         escape (\ex27)    \ee         escape (\ex27)
339    \ef         formfeed (\ex0c)    \ef         form feed (\ex0c)
340    \en         newline (\ex0a)    \en         newline (\ex0a)
341  .\" JOIN  .\" JOIN
342    \eqdd       set the PCRE_MATCH_LIMIT limit to dd    \eqdd       set the PCRE_MATCH_LIMIT limit to dd
# Line 303  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 350  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 388  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 413  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 452  found. This is always the shortest possi Line 507  found. This is always the shortest possi
507  This section describes the output when the normal matching function,  This section describes the output when the normal matching function,
508  \fBpcre_exec()\fP, is being used.  \fBpcre_exec()\fP, is being used.
509  .P  .P
510  When a match succeeds, pcretest outputs the list of captured substrings that  When a match succeeds, \fBpcretest\fP outputs the list of captured substrings
511  \fBpcre_exec()\fP returns, starting with number 0 for the string that matched  that \fBpcre_exec()\fP returns, starting with number 0 for the string that
512  the whole pattern. Otherwise, it outputs "No match" or "Partial match"  matched 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 return, \fBpcretest\fP outputs
518    the PCRE negative error number and a short descriptive phrase. If the error is
519    a failed UTF-8 string check, the byte offset of the start of the failing
520    character and the reason code are also output, provided that the size of the
521    output vector is at least two. Here is an example of an interactive
522    \fBpcretest\fP run.
523  .sp  .sp
524    $ pcretest    $ pcretest
525    PCRE version 7.0 30-Nov-2006    PCRE version 8.13 2011-04-30
526  .sp  .sp
527      re> /^abc(\ed+)/      re> /^abc(\ed+)/
528    data> abc123    data> abc123
# Line 469  of an interactive \fBpcretest\fP run. Line 531  of an interactive \fBpcretest\fP run.
531    data> xyz    data> xyz
532    No match    No match
533  .sp  .sp
534  Note that unset capturing substrings that are not followed by one that is set  Unset capturing substrings that are not followed by one that is set are not
535  are not returned by \fBpcre_exec()\fP, and are not shown by \fBpcretest\fP. In  returned by \fBpcre_exec()\fP, and are not shown by \fBpcretest\fP. In the
536  the following example, there are two capturing substrings, but when the first  following example, there are two capturing substrings, but when the first data
537  data line is matched, the second, unset substring is not shown. An "internal"  line is matched, the second, unset substring is not shown. An "internal" unset
538  unset substring is shown as "<unset>", as for the second data line.  substring is shown as "<unset>", as for the second data line.
539  .sp  .sp
540      re> /(a)|(b)/      re> /(a)|(b)/
541    data> a    data> a
# Line 507  matching attempts are output in sequence Line 569  matching attempts are output in sequence
569     0: ipp     0: ipp
570     1: pp     1: pp
571  .sp  .sp
572  "No match" is output only if the first match attempt fails.  "No match" is output only if the first match attempt fails. Here is an example
573    of a failure message (the offset 4 that is specified by \e>4 is past the end of
574    the subject string):
575    .sp
576        re> /xyz/
577      data> xyz\>4
578      Error -24 (bad offset value)
579  .P  .P
580  If any of the sequences \fB\eC\fP, \fB\eG\fP, or \fB\eL\fP are present in a  If any of the sequences \fB\eC\fP, \fB\eG\fP, or \fB\eL\fP are present in a
581  data line that is successfully matched, the substrings extracted by the  data line that is successfully matched, the substrings extracted by the
# Line 538  the subject where there is at least one Line 606  the subject where there is at least one
606     2: tan     2: tan
607  .sp  .sp
608  (Using the normal matching function on this data finds only "tang".) The  (Using the normal matching function on this data finds only "tang".) The
609  longest matching string is always given first (and numbered zero).  longest matching string is always given first (and numbered zero). After a
610    PCRE_ERROR_PARTIAL return, the output is "Partial match:", followed by the
611    partially matching substring. (Note that this is the entire substring that was
612    inspected during the partial match; it may include characters before the actual
613    match start if a lookbehind assertion, \eK, \eb, or \eB was involved.)
614  .P  .P
615  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
616  at the end of the longest match. For example:  at the end of the longest match. For example:
# Line 640  function to distinguish printing and non Line 712  function to distinguish printing and non
712  .rs  .rs
713  .sp  .sp
714  The facilities described in this section are not available when the POSIX  The facilities described in this section are not available when the POSIX
715  inteface to PCRE is being used, that is, when the \fB/P\fP pattern modifier is  interface to PCRE is being used, that is, when the \fB/P\fP pattern modifier is
716  specified.  specified.
717  .P  .P
718  When the POSIX interface is not in use, you can cause \fBpcretest\fP to write a  When the POSIX interface is not in use, you can cause \fBpcretest\fP to write a
# Line 664  exact copy of the compiled pattern. If t Line 736  exact copy of the compiled pattern. If t
736  follows immediately after the compiled pattern. After writing the file,  follows immediately after the compiled pattern. After writing the file,
737  \fBpcretest\fP expects to read a new pattern.  \fBpcretest\fP expects to read a new pattern.
738  .P  .P
739  A saved pattern can be reloaded into \fBpcretest\fP by specifing < and a file  A saved pattern can be reloaded into \fBpcretest\fP by specifying < and a file
740  name instead of a pattern. The name of the file must not contain a < character,  name instead of a pattern. The name of the file must not contain a < character,
741  as otherwise \fBpcretest\fP will interpret the line as a pattern delimited by <  as otherwise \fBpcretest\fP will interpret the line as a pattern delimited by <
742  characters.  characters.
# Line 717  Cambridge CB2 3QH, England. Line 789  Cambridge CB2 3QH, England.
789  .rs  .rs
790  .sp  .sp
791  .nf  .nf
792  Last updated: 18 December 2007  Last updated: 07 May 2011
793  Copyright (c) 1997-2007 University of Cambridge.  Copyright (c) 1997-2011 University of Cambridge.
794  .fi  .fi

Legend:
Removed from v.287  
changed lines
  Added in v.599

  ViewVC Help
Powered by ViewVC 1.1.5