/[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 598 by ph10, Sat May 7 15:37:31 2011 UTC revision 780 by ph10, Fri Dec 2 11:39:21 2011 UTC
# Line 4  pcretest - a program for testing Perl-co Line 4  pcretest - a program for testing Perl-co
4  .SH SYNOPSIS  .SH SYNOPSIS
5  .rs  .rs
6  .sp  .sp
7  .B pcretest "[options] [source] [destination]"  .B pcretest "[options] [input file [output file]]"
8  .sp  .sp
9  \fBpcretest\fP was written as a test program for the PCRE regular expression  \fBpcretest\fP was written as a test program for the PCRE regular expression
10  library itself, but it can also be used for experimenting with regular  library itself, but it can also be used for experimenting with regular
# Line 18  options, see the Line 18  options, see the
18  .\" HREF  .\" HREF
19  \fBpcreapi\fP  \fBpcreapi\fP
20  .\"  .\"
21  documentation.  documentation. The input for \fBpcretest\fP is a sequence of regular expression
22    patterns and strings to be matched, as described below. The output shows the
23    result of each match. Options on the command line and the patterns control PCRE
24    options and exactly what is output.
25  .  .
26  .  .
27  .SH OPTIONS  .SH COMMAND LINE OPTIONS
28  .rs  .rs
29  .TP 10  .TP 10
30  \fB-b\fP  \fB-b\fP
31  Behave as if each regex has the \fB/B\fP (show bytecode) modifier; the internal  Behave as if each pattern has the \fB/B\fP (show byte code) modifier; the
32  form is output after compilation.  internal form is output after compilation.
33  .TP 10  .TP 10
34  \fB-C\fP  \fB-C\fP
35  Output the version number of the PCRE library, and all available information  Output the version number of the PCRE library, and all available information
36  about the optional features that are included, and then exit.  about the optional features that are included, and then exit.
37  .TP 10  .TP 10
38  \fB-d\fP  \fB-d\fP
39  Behave as if each regex has the \fB/D\fP (debug) modifier; the internal  Behave as if each pattern has the \fB/D\fP (debug) modifier; the internal
40  form and information about the compiled pattern is output after compilation;  form and information about the compiled pattern is output after compilation;
41  \fB-d\fP is equivalent to \fB-b -i\fP.  \fB-d\fP is equivalent to \fB-b -i\fP.
42  .TP 10  .TP 10
# Line 46  standard \fBpcre_exec()\fP function (mor Line 49  standard \fBpcre_exec()\fP function (mor
49  Output a brief summary these options and then exit.  Output a brief summary these options and then exit.
50  .TP 10  .TP 10
51  \fB-i\fP  \fB-i\fP
52  Behave as if each regex has the \fB/I\fP modifier; information about the  Behave as if each pattern has the \fB/I\fP modifier; information about the
53  compiled pattern is given after compilation.  compiled pattern is given after compilation.
54  .TP 10  .TP 10
55  \fB-M\fP  \fB-M\fP
# Line 56  calling \fBpcre_exec()\fP repeatedly wit Line 59  calling \fBpcre_exec()\fP repeatedly wit
59  .TP 10  .TP 10
60  \fB-m\fP  \fB-m\fP
61  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
62  equivalent to adding \fB/M\fP to each regular expression. For compatibility  equivalent to adding \fB/M\fP to each regular expression.
 with earlier versions of pcretest, \fB-s\fP is a synonym for \fB-m\fP.  
63  .TP 10  .TP 10
64  \fB-o\fP \fIosize\fP  \fB-o\fP \fIosize\fP
65  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
# Line 68  changed for individual matching calls by Line 70  changed for individual matching calls by
70  below).  below).
71  .TP 10  .TP 10
72  \fB-p\fP  \fB-p\fP
73  Behave as if each regex has the \fB/P\fP modifier; the POSIX wrapper API is  Behave as if each pattern has the \fB/P\fP modifier; the POSIX wrapper API is
74  used to call PCRE. None of the other options has any effect when \fB-p\fP is  used to call PCRE. None of the other options has any effect when \fB-p\fP is
75  set.  set.
76  .TP 10  .TP 10
# Line 76  set. Line 78  set.
78  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.
79  .TP 10  .TP 10
80  \fB-S\fP \fIsize\fP  \fB-S\fP \fIsize\fP
81  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
82  megabytes.  megabytes.
83  .TP 10  .TP 10
84    \fB-s\fP or \fB-s+\fP
85    Behave as if each pattern has the \fB/S\fP modifier; in other words, force each
86    pattern to be studied. If \fB-s+\fP is used, the PCRE_STUDY_JIT_COMPILE flag is
87    passed to \fBpcre_study()\fP, causing just-in-time optimization to be set up if
88    it is available. If the \fB/I\fP or \fB/D\fP option is present on a pattern
89    (requesting output about the compiled pattern), information about the result of
90    studying is not included when studying is caused only by \fB-s\fP and neither
91    \fB-i\fP nor \fB-d\fP is present on the command line. This behaviour means that
92    the output from tests that are run with and without \fB-s\fP should be
93    identical, except when options that output information about the actual running
94    of a match are set. The \fB-M\fP, \fB-t\fP, and \fB-tm\fP options, which give
95    information about resources used, are likely to produce different output with
96    and without \fB-s\fP. Output may also differ if the \fB/C\fP option is present
97    on an individual pattern. This uses callouts to trace the the matching process,
98    and this may be different between studied and non-studied patterns. If the
99    pattern contains (*MARK) items there may also be differences, for the same
100    reason. The \fB-s\fP command line option can be overridden for specific
101    patterns that should never be studied (see the \fB/S\fP pattern modifier
102    below).
103    .TP 10
104  \fB-t\fP  \fB-t\fP
105  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
106  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
# Line 154  pcretest to read the next line as a cont Line 176  pcretest to read the next line as a cont
176  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
177  characters. Following Perl usage, these are referred to below as, for example,  characters. Following Perl usage, these are referred to below as, for example,
178  "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
179  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
180  appear between the final pattern delimiter and the first modifier, and between  appear between the final pattern delimiter and the first modifier, and between
181  the modifiers themselves.  the modifiers themselves.
182  .P  .P
# Line 190  options that do not correspond to anythi Line 212  options that do not correspond to anythi
212    \fB/<bsr_unicode>\fP  PCRE_BSR_UNICODE    \fB/<bsr_unicode>\fP  PCRE_BSR_UNICODE
213  .sp  .sp
214  The modifiers that are enclosed in angle brackets are literal strings as shown,  The modifiers that are enclosed in angle brackets are literal strings as shown,
215  including the angle brackets, but the letters can be in either case. This  including the angle brackets, but the letters within can be in either case.
216  example sets multiline matching with CRLF as the line ending sequence:  This example sets multiline matching with CRLF as the line ending sequence:
217  .sp  .sp
218    /^abc/m<crlf>    /^abc/m<CRLF>
219  .sp  .sp
220  As well as turning on the PCRE_UTF8 option, the \fB/8\fP modifier also causes  As well as turning on the PCRE_UTF8 option, the \fB/8\fP modifier also causes
221  any non-printing characters in output strings to be printed using the  any non-printing characters in output strings to be printed using the
# Line 235  There are yet more modifiers for control Line 257  There are yet more modifiers for control
257  operates.  operates.
258  .P  .P
259  The \fB/+\fP modifier requests that as well as outputting the substring that  The \fB/+\fP modifier requests that as well as outputting the substring that
260  matched the entire pattern, pcretest should in addition output the remainder of  matched the entire pattern, \fBpcretest\fP should in addition output the
261  the subject string. This is useful for tests where the subject contains  remainder of the subject string. This is useful for tests where the subject
262  multiple copies of the same substring.  contains multiple copies of the same substring. If the \fB+\fP modifier appears
263    twice, the same action is taken for captured substrings. In each case the
264    remainder is output on the following line with a plus character following the
265    capture number. Note that this modifier must not immediately follow the /S
266    modifier because /S+ has another meaning.
267    .P
268    The \fB/=\fP modifier requests that the values of all potential captured
269    parentheses be output after a match by \fBpcre_exec()\fP. By default, only
270    those up to the highest one actually used in the match are output
271    (corresponding to the return code from \fBpcre_exec()\fP). Values in the
272    offsets vector corresponding to higher numbers should be set to -1, and these
273    are output as "<unset>". This modifier gives a way of checking that this is
274    happening.
275  .P  .P
276  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
277  output a representation of the compiled byte code after compilation. Normally  output a representation of the compiled byte code after compilation. Normally
# Line 285  as the tables pointer; that is, \fB/L\fP Line 319  as the tables pointer; that is, \fB/L\fP
319  which it appears.  which it appears.
320  .P  .P
321  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
322  pattern to be output.  pattern to be output. This does not include the size of the \fBpcre\fP block;
323  .P  it is just the actual compiled data. If the pattern is successfully studied
324  The \fB/S\fP modifier causes \fBpcre_study()\fP to be called after the  with the PCRE_STUDY_JIT_COMPILE option, the size of the JIT compiled code is
325  expression has been compiled, and the results used when the expression is  also output.
326  matched.  .P
327    If the \fB/S\fP modifier appears once, it causes \fBpcre_study()\fP to be
328    called after the expression has been compiled, and the results used when the
329    expression is matched. If \fB/S\fP appears twice, it suppresses studying, even
330    if it was requested externally by the \fB-s\fP command line option. This makes
331    it possible to specify that certain patterns are always studied, and others are
332    never studied, independently of \fB-s\fP. This feature is used in the test
333    files in a few cases where the output is different when the pattern is studied.
334    .P
335    If the \fB/S\fP modifier is immediately followed by a + character, the call to
336    \fBpcre_study()\fP is made with the PCRE_STUDY_JIT_COMPILE option, requesting
337    just-in-time optimization support if it is available. Note that there is also a
338    \fB/+\fP modifier; it must not be given immediately after \fB/S\fP because this
339    will be misinterpreted. If JIT studying is successful, it will automatically be
340    used when \fBpcre_exec()\fP is run, except when incompatible run-time options
341    are specified. These include the partial matching options; a complete list is
342    given in the
343    .\" HREF
344    \fBpcrejit\fP
345    .\"
346    documentation. See also the \fB\eJ\fP escape sequence below for a way of
347    setting the size of the JIT stack.
348  .P  .P
349  The \fB/T\fP modifier must be followed by a single digit. It causes a specific  The \fB/T\fP modifier must be followed by a single digit. It causes a specific
350  set of built-in character tables to be passed to \fBpcre_compile()\fP. It is  set of built-in character tables to be passed to \fBpcre_compile()\fP. It is
# Line 327  ignored. Line 382  ignored.
382  .rs  .rs
383  .sp  .sp
384  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
385  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
386  pretty esoteric features, intended for checking out some of the more  are pretty esoteric features, intended for checking out some of the more
387  complicated features of PCRE. If you are just testing "ordinary" regular  complicated features of PCRE. If you are just testing "ordinary" regular
388  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
389  recognized:  recognized:
# Line 336  recognized: Line 391  recognized:
391    \ea         alarm (BEL, \ex07)    \ea         alarm (BEL, \ex07)
392    \eb         backspace (\ex08)    \eb         backspace (\ex08)
393    \ee         escape (\ex27)    \ee         escape (\ex27)
394    \ef         formfeed (\ex0c)    \ef         form feed (\ex0c)
395    \en         newline (\ex0a)    \en         newline (\ex0a)
396  .\" JOIN  .\" JOIN
397    \eqdd       set the PCRE_MATCH_LIMIT limit to dd    \eqdd       set the PCRE_MATCH_LIMIT limit to dd
# Line 386  recognized: Line 441  recognized:
441                 "name" after a successful match (name termin-                 "name" after a successful match (name termin-
442                 ated by next non-alphanumeric character)                 ated by next non-alphanumeric character)
443  .\" JOIN  .\" JOIN
444      \eJdd       set up a JIT stack of dd kilobytes maximum (any
445                   number of digits)
446    .\" JOIN
447    \eL         call pcre_get_substringlist() after a    \eL         call pcre_get_substringlist() after a
448                 successful match                 successful match
449  .\" JOIN  .\" JOIN
# Line 451  the very last character is a backslash, Line 509  the very last character is a backslash,
509  passing an empty line as data, since a real empty line terminates the data  passing an empty line as data, since a real empty line terminates the data
510  input.  input.
511  .P  .P
512    The \fB\eJ\fP escape provides a way of setting the maximum stack size that is
513    used by the just-in-time optimization code. It is ignored if JIT optimization
514    is not being used. Providing a stack that is larger than the default 32K is
515    necessary only for very complicated patterns.
516    .P
517  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
518  different values in the \fImatch_limit\fP and \fImatch_limit_recursion\fP  different values in the \fImatch_limit\fP and \fImatch_limit_recursion\fP
519  fields of the \fBpcre_extra\fP data structure, until it finds the minimum  fields of the \fBpcre_extra\fP data structure, until it finds the minimum
520  numbers for each parameter that allow \fBpcre_exec()\fP to complete. The  numbers for each parameter that allow \fBpcre_exec()\fP to complete without
521  \fImatch_limit\fP number is a measure of the amount of backtracking that takes  error. Because this is testing a specific feature of the normal interpretive
522  place, and checking it out can be instructive. For most simple matches, the  \fBpcre_exec()\fP execution, the use of any JIT optimization that might have
523  number is quite small, but for patterns with very large numbers of matching  been set up by the \fB/S+\fP qualifier of \fB-s+\fP option is disabled.
524  possibilities, it can become large very quickly with increasing length of  .P
525  subject string. The \fImatch_limit_recursion\fP number is a measure of how much  The \fImatch_limit\fP number is a measure of the amount of backtracking
526  stack (or, if PCRE is compiled with NO_RECURSE, how much heap) memory is needed  that takes place, and checking it out can be instructive. For most simple
527  to complete the match attempt.  matches, the number is quite small, but for patterns with very large numbers of
528    matching possibilities, it can become large very quickly with increasing length
529    of subject string. The \fImatch_limit_recursion\fP number is a measure of how
530    much stack (or, if PCRE is compiled with NO_RECURSE, how much heap) memory is
531    needed to complete the match attempt.
532  .P  .P
533  When \eO is used, the value specified may be higher or lower than the size set  When \eO is used, the value specified may be higher or lower than the size set
534  by the \fB-O\fP command line option (or defaulted to 45); \eO applies only to  by the \fB-O\fP command line option (or defaulted to 45); \eO applies only to
# Line 517  include characters before the actual mat Line 584  include characters before the actual mat
584  \eK, \eb, or \eB was involved.) For any other return, \fBpcretest\fP outputs  \eK, \eb, or \eB was involved.) For any other return, \fBpcretest\fP outputs
585  the PCRE negative error number and a short descriptive phrase. If the error is  the PCRE negative error number and a short descriptive phrase. If the error is
586  a failed UTF-8 string check, the byte offset of the start of the failing  a failed UTF-8 string check, the byte offset of the start of the failing
587  character and the reason code are also output, provided that the size of the  character and the reason code are also output, provided that the size of the
588  output vector is at least two. Here is an example of an interactive  output vector is at least two. Here is an example of an interactive
589  \fBpcretest\fP run.  \fBpcretest\fP run.
590  .sp  .sp
# Line 569  matching attempts are output in sequence Line 636  matching attempts are output in sequence
636     0: ipp     0: ipp
637     1: pp     1: pp
638  .sp  .sp
639  "No match" is output only if the first match attempt fails. Here is an example  "No match" is output only if the first match attempt fails. Here is an example
640  of a failure message (the offset 4 that is specified by \e>4 is past the end of  of a failure message (the offset 4 that is specified by \e>4 is past the end of
641  the subject string):  the subject string):
642  .sp  .sp
643      re> /xyz/      re> /xyz/
644    data> xyz\>4    data> xyz\e>4
645    Error -24 (bad offset value)    Error -24 (bad offset value)
646  .P  .P
647  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
648  data line that is successfully matched, the substrings extracted by the  data line that is successfully matched, the substrings extracted by the
# Line 680  example: Line 747  example:
747    +10 ^ ^    +10 ^ ^
748     0: E*     0: E*
749  .sp  .sp
750    If a pattern contains (*MARK) items, an additional line is output whenever
751    a change of latest mark is passed to the callout function. For example:
752    .sp
753        re> /a(*MARK:X)bc/C
754      data> abc
755      --->abc
756       +0 ^       a
757       +1 ^^      (*MARK:X)
758      +10 ^^      b
759      Latest Mark: X
760      +11 ^ ^     c
761      +12 ^  ^
762       0: abc
763    .sp
764    The mark changes between matching "a" and "b", but stays the same for the rest
765    of the match, so nothing more is output. If, as a result of backtracking, the
766    mark reverts to being unset, the text "<unset>" is output.
767    .P
768  The callout function in \fBpcretest\fP returns zero (carry on matching) by  The callout function in \fBpcretest\fP returns zero (carry on matching) by
769  default, but you can use a \eC item in a data line (as described above) to  default, but you can use a \eC item in a data line (as described above) to
770  change this.  change this and other parameters of the callout.
771  .P  .P
772  Inserting callouts can be helpful when using \fBpcretest\fP to check  Inserting callouts can be helpful when using \fBpcretest\fP to check
773  complicated regular expressions. For further information about callouts, see  complicated regular expressions. For further information about callouts, see
# Line 712  function to distinguish printing and non Line 797  function to distinguish printing and non
797  .rs  .rs
798  .sp  .sp
799  The facilities described in this section are not available when the POSIX  The facilities described in this section are not available when the POSIX
800  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
801  specified.  specified.
802  .P  .P
803  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 726  See the Line 811  See the
811  \fBpcreprecompile\fP  \fBpcreprecompile\fP
812  .\"  .\"
813  documentation for a discussion about saving and re-using compiled patterns.  documentation for a discussion about saving and re-using compiled patterns.
814    Note that if the pattern was successfully studied with JIT optimization, the
815    JIT data cannot be saved.
816  .P  .P
817  The data that is written is binary. The first eight bytes are the length of the  The data that is written is binary. The first eight bytes are the length of the
818  compiled pattern data followed by the length of the optional study data, each  compiled pattern data followed by the length of the optional study data, each
# Line 733  written as four bytes in big-endian orde Line 820  written as four bytes in big-endian orde
820  there is no study data (either the pattern was not studied, or studying did not  there is no study data (either the pattern was not studied, or studying did not
821  return any data), the second length is zero. The lengths are followed by an  return any data), the second length is zero. The lengths are followed by an
822  exact copy of the compiled pattern. If there is additional study data, this  exact copy of the compiled pattern. If there is additional study data, this
823  follows immediately after the compiled pattern. After writing the file,  (excluding any JIT data) follows immediately after the compiled pattern. After
824  \fBpcretest\fP expects to read a new pattern.  writing the file, \fBpcretest\fP expects to read a new pattern.
825  .P  .P
826  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
827  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,
828  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 <
829  characters.  characters.
830  For example:  For example:
831  .sp  .sp
832     re> </some/file     re> </some/file
833    Compiled regex loaded from /some/file    Compiled pattern loaded from /some/file
834    No study data    No study data
835  .sp  .sp
836  When the pattern has been loaded, \fBpcretest\fP proceeds to read data lines in  If the pattern was previously studied with the JIT optimization, the JIT
837  the usual way.  information cannot be saved and restored, and so is lost. When the pattern has
838    been loaded, \fBpcretest\fP proceeds to read data lines in the usual way.
839  .P  .P
840  You can copy a file written by \fBpcretest\fP to a different host and reload it  You can copy a file written by \fBpcretest\fP to a different host and reload it
841  there, even if the new host has opposite endianness to the one on which the  there, even if the new host has opposite endianness to the one on which the
# Line 771  result is undefined. Line 859  result is undefined.
859  .SH "SEE ALSO"  .SH "SEE ALSO"
860  .rs  .rs
861  .sp  .sp
862  \fBpcre\fP(3), \fBpcreapi\fP(3), \fBpcrecallout\fP(3), \fBpcrematching\fP(3),  \fBpcre\fP(3), \fBpcreapi\fP(3), \fBpcrecallout\fP(3), \fBpcrejit\fP,
863  \fBpcrepartial\fP(d), \fBpcrepattern\fP(3), \fBpcreprecompile\fP(3).  \fBpcrematching\fP(3), \fBpcrepartial\fP(d), \fBpcrepattern\fP(3),
864    \fBpcreprecompile\fP(3).
865  .  .
866  .  .
867  .SH AUTHOR  .SH AUTHOR
# Line 789  Cambridge CB2 3QH, England. Line 878  Cambridge CB2 3QH, England.
878  .rs  .rs
879  .sp  .sp
880  .nf  .nf
881  Last updated: 06 May 2011  Last updated: 02 December 2011
882  Copyright (c) 1997-2011 University of Cambridge.  Copyright (c) 1997-2011 University of Cambridge.
883  .fi  .fi

Legend:
Removed from v.598  
changed lines
  Added in v.780

  ViewVC Help
Powered by ViewVC 1.1.5