/[pcre]/code/trunk/doc/pcretest.1

Diff of /code/trunk/doc/pcretest.1

Parent Directory | Revision Log | View Patch Patch

-revision 553 by ph10,
Fri Oct 22 15:57:50 2010 UTC
+revision 616 by ph10,
Mon Jul 11 15:55:25 2011 UTC
 Line 4 
 pcretest - a program for testing Perl-co
  .SH SYNOPSIS
  .rs
  .sp
- .B pcretest "[options] [source] [destination]"
+ .B pcretest "[options] [input file [output file]]"
  .sp
  \fBpcretest\fP was written as a test program for the PCRE regular expression
  library itself, but it can also be used for experimenting with regular
 Line 18 
 options, see the
  .\" HREF
  \fBpcreapi\fP
  .\"
- documentation.
+ documentation. The input for \fBpcretest\fP is a sequence of regular expression
+ patterns and strings to be matched, as described below. The output shows the
+ result of each match. Options on the command line and the patterns control PCRE
+ options and exactly what is output.
  .
  .
- .SH OPTIONS
+ .SH COMMAND LINE OPTIONS
  .rs
  .TP 10
  \fB-b\fP
- 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
- form is output after compilation.
+ internal form is output after compilation.
  .TP 10
  \fB-C\fP
  Output the version number of the PCRE library, and all available information
  about the optional features that are included, and then exit.
  .TP 10
  \fB-d\fP
- 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
  form and information about the compiled pattern is output after compilation;
  \fB-d\fP is equivalent to \fB-b -i\fP.
  .TP 10
-Line 46 
 standard \fBpcre_exec()\fP function (mor
+Line 49 
 standard \fBpcre_exec()\fP function (mor
  Output a brief summary these options and then exit.
  .TP 10
  \fB-i\fP
- 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
  compiled pattern is given after compilation.
  .TP 10
  \fB-M\fP
-Line 56 
 calling \fBpcre_exec()\fP repeatedly wit
+Line 59 
 calling \fBpcre_exec()\fP repeatedly wit
  .TP 10
  \fB-m\fP
  Output the size of each compiled pattern after it has been compiled. This is
- 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.
  .TP 10
  \fB-o\fP \fIosize\fP
  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
  below).
  .TP 10
  \fB-p\fP
- 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
  used to call PCRE. None of the other options has any effect when \fB-p\fP is
  set.
  .TP 10
-Line 76 
 set.
+Line 78 
 set.
  Do not output the version number of \fBpcretest\fP at the start of execution.
  .TP 10
  \fB-S\fP \fIsize\fP
- 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
  megabytes.
  .TP 10
+ \fB-s\fP
+ Behave as if each pattern has the \fB/S\fP modifier; in other words, force each
+ pattern to be studied. If the \fB/I\fP or \fB/D\fP option is present on a
+ pattern (requesting output about the compiled pattern), information about the
+ result of studying is not included when studying is caused only by \fB-s\fP and
+ neither \fB-i\fP nor \fB-d\fP is present on the command line. This behaviour
+ means that the output from tests that are run with and without \fB-s\fP should
+ be identical, except when options that output information about the actual
+ running of a match are set. The \fB-M\fP, \fB-t\fP, and \fB-tm\fP options,
+ which give information about resources used, are likely to produce different
+ output with and without \fB-s\fP. Output may also differ if the \fB/C\fP option
+ is present on an individual pattern. This uses callouts to trace the the
+ matching process, and this may be different between studied and non-studied
+ patterns. If the pattern contains (*MARK) items there may also be differences,
+ for the same reason. The \fB-s\fP command line option can be overridden for
+ specific patterns that should never be studied (see the /S option below).
+ .TP 10
  \fB-t\fP
  Run each compile, study, and match many times with a timer, and output
  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 173 
 pcretest to read the next line as a cont
  A pattern may be followed by any number of modifiers, which are mostly single
  characters. Following Perl usage, these are referred to below as, for example,
  "the \fB/i\fP modifier", even though the delimiter of the pattern need not
- 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
  appear between the final pattern delimiter and the first modifier, and between
  the modifiers themselves.
  .P
-Line 179 
 options that do not correspond to anythi
+Line 198 
 options that do not correspond to anythi
    \fB/U\fP              PCRE_UNGREEDY
    \fB/W\fP              PCRE_UCP
    \fB/X\fP              PCRE_EXTRA
+   \fB/Y\fP              PCRE_NO_START_OPTIMIZE
    \fB/<JS>\fP           PCRE_JAVASCRIPT_COMPAT
    \fB/<cr>\fP           PCRE_NEWLINE_CR
    \fB/<lf>\fP           PCRE_NEWLINE_LF
-Line 189 
 options that do not correspond to anythi
+Line 209 
 options that do not correspond to anythi
    \fB/<bsr_unicode>\fP  PCRE_BSR_UNICODE
  .sp
  The modifiers that are enclosed in angle brackets are literal strings as shown,
- 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.
- example sets multiline matching with CRLF as the line ending sequence:
+ This example sets multiline matching with CRLF as the line ending sequence:
  .sp
-   /^abc/m<crlf>
+   /^abc/m<CRLF>
  .sp
  As well as turning on the PCRE_UTF8 option, the \fB/8\fP modifier also causes
  any non-printing characters in output strings to be printed using the
-Line 219 
 begins with a lookbehind assertion (incl
+Line 239 
 begins with a lookbehind assertion (incl
  If any call to \fBpcre_exec()\fP in a \fB/g\fP or \fB/G\fP sequence matches an
  empty string, the next call is done with the PCRE_NOTEMPTY_ATSTART and
  PCRE_ANCHORED flags set in order to search for another, non-empty, match at the
- same point. If this second match fails, the start offset is advanced by one
+ same point. If this second match fails, the start offset is advanced, and the
- character, and the normal match is retried. This imitates the way Perl handles
+ normal match is retried. This imitates the way Perl handles such cases when
- such cases when using the \fB/g\fP modifier or the \fBsplit()\fP function.
+ using the \fB/g\fP modifier or the \fBsplit()\fP function. Normally, the start
+ offset is advanced by one character, but if the newline convention recognizes
+ CRLF as a newline, and the current character is CR followed by LF, an advance
+ of two is used.
  .
  .
  .SS "Other modifiers"
-Line 231 
 There are yet more modifiers for control
+Line 254 
 There are yet more modifiers for control
  operates.
  .P
  The \fB/+\fP modifier requests that as well as outputting the substring that
- matched the entire pattern, pcretest should in addition output the remainder of
+ matched the entire pattern, \fBpcretest\fP should in addition output the
- 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
- multiple copies of the same substring.
+ contains multiple copies of the same substring. If the \fB+\fP modifier appears
+ twice, the same action is taken for captured substrings. In each case the
+ remainder is output on the following line with a plus character following the
+ capture number.
  .P
  The \fB/B\fP modifier is a debugging feature. It requests that \fBpcretest\fP
  output a representation of the compiled byte code after compilation. Normally
-Line 283 
 which it appears.
+Line 309 
 which it appears.
  The \fB/M\fP modifier causes the size of memory block used to hold the compiled
  pattern to be output.
  .P
- The \fB/S\fP modifier causes \fBpcre_study()\fP to be called after the
+ If the \fB/S\fP modifier appears once, it causes \fBpcre_study()\fP to be
- expression has been compiled, and the results used when the expression is
+ called after the expression has been compiled, and the results used when the
- matched.
+ expression is matched. If \fB/S\fP appears twice, it suppresses studying, even
+ if it was requested externally by the \fB-s\fP command line option. This makes
+ it possible to specify that certain patterns are always studied, and others are
+ never studied, independently of \fB-s\fP. This feature is used in the test
+ files in a few cases where the output is different when the pattern is studied.
  .P
  The \fB/T\fP modifier must be followed by a single digit. It causes a specific
  set of built-in character tables to be passed to \fBpcre_compile()\fP. It is
-Line 323 
 ignored.
+Line 353 
 ignored.
  .rs
  .sp
  Before each data line is passed to \fBpcre_exec()\fP, leading and trailing
- 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
- pretty esoteric features, intended for checking out some of the more
+ are pretty esoteric features, intended for checking out some of the more
  complicated features of PCRE. If you are just testing "ordinary" regular
  expressions, you probably don't need any of these. The following escapes are
  recognized:
-Line 332 
 recognized:
+Line 362 
 recognized:
    \ea         alarm (BEL, \ex07)
    \eb         backspace (\ex08)
    \ee         escape (\ex27)
-   \ef         formfeed (\ex0c)
+   \ef         form feed (\ex0c)
    \en         newline (\ex0a)
  .\" JOIN
    \eqdd       set the PCRE_MATCH_LIMIT limit to dd
-Line 341 
 recognized:
+Line 371 
 recognized:
    \et         tab (\ex09)
    \ev         vertical tab (\ex0b)
    \ennn       octal character (up to 3 octal digits)
-   \exhh       hexadecimal character (up to 2 hex digits)
+                always a byte unless > 255 in UTF-8 mode
+   \exhh       hexadecimal byte (up to 2 hex digits)
  .\" JOIN
    \ex{hh...}  hexadecimal character, any number of digits
                 in UTF-8 mode
-Line 411 
 recognized:
+Line 442 
 recognized:
  .\" JOIN
    \e?         pass the PCRE_NO_UTF8_CHECK option to
                 \fBpcre_exec()\fP or \fBpcre_dfa_exec()\fP
-   \e>dd       start the match at offset dd (any number of digits);
  .\" JOIN
-                this sets the \fIstartoffset\fP argument for \fBpcre_exec()\fP
+   \e>dd       start the match at offset dd (optional "-"; then
-                or \fBpcre_dfa_exec()\fP
+                any number of digits); this sets the \fIstartoffset\fP
+                argument for \fBpcre_exec()\fP or \fBpcre_dfa_exec()\fP
  .\" JOIN
    \e<cr>      pass the PCRE_NEWLINE_CR option to \fBpcre_exec()\fP
                 or \fBpcre_dfa_exec()\fP
-Line 431 
 recognized:
+Line 462 
 recognized:
    \e<any>     pass the PCRE_NEWLINE_ANY option to \fBpcre_exec()\fP
                 or \fBpcre_dfa_exec()\fP
  .sp
+ Note that \exhh always specifies one byte, even in UTF-8 mode; this makes it
+ possible to construct invalid UTF-8 sequences for testing purposes. On the
+ other hand, \ex{hh} is interpreted as a UTF-8 character in UTF-8 mode,
+ generating more than one byte if the value is greater than 127. When not in
+ UTF-8 mode, it generates one byte for values less than 256, and causes an error
+ for greater values.
+ .P
  The escapes that specify line ending sequences are literal strings, exactly as
  shown. No more than one newline setting should be present in any data line.
  .P
-Line 495 
 found. This is always the shortest possi
+Line 533 
 found. This is always the shortest possi
  This section describes the output when the normal matching function,
  \fBpcre_exec()\fP, is being used.
  .P
- When a match succeeds, pcretest outputs the list of captured substrings that
+ When a match succeeds, \fBpcretest\fP outputs the list of captured substrings
- \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
- the whole pattern. Otherwise, it outputs "No match" when the return is
+ matched the whole pattern. Otherwise, it outputs "No match" when the return is
  PCRE_ERROR_NOMATCH, and "Partial match:" followed by the partially matching
  substring when \fBpcre_exec()\fP returns PCRE_ERROR_PARTIAL. (Note that this is
  the entire substring that was inspected during the partial match; it may
  include characters before the actual match start if a lookbehind assertion,
- \eK, \eb, or \eB was involved.) For any other returns, it outputs the PCRE
+ \eK, \eb, or \eB was involved.) For any other return, \fBpcretest\fP outputs
- negative error number. Here is an example of an interactive \fBpcretest\fP run.
+ the PCRE negative error number and a short descriptive phrase. If the error is
+ a failed UTF-8 string check, the byte offset of the start of the failing
+ character and the reason code are also output, provided that the size of the
+ output vector is at least two. Here is an example of an interactive
+ \fBpcretest\fP run.
  .sp
    $ pcretest
-   PCRE version 7.0 30-Nov-2006
+   PCRE version 8.13 2011-04-30
  .sp
      re> /^abc(\ed+)/
    data> abc123
-Line 515 
 negative error number. Here is an exampl
+Line 557 
 negative error number. Here is an exampl
    data> xyz
    No match
  .sp
- 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
- 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
- the following example, there are two capturing substrings, but when the first
+ following example, there are two capturing substrings, but when the first data
- 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
- unset substring is shown as "<unset>", as for the second data line.
+ substring is shown as "<unset>", as for the second data line.
  .sp
      re> /(a)|(b)/
    data> a
-Line 553 
 matching attempts are output in sequence
+Line 595 
 matching attempts are output in sequence
 : ipp
 : pp
  .sp
- "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
+ of a failure message (the offset 4 that is specified by \e>4 is past the end of
+ the subject string):
+ .sp
+     re> /xyz/
+   data> xyz\>4
+   Error -24 (bad offset value)
  .P
  If any of the sequences \fB\eC\fP, \fB\eG\fP, or \fB\eL\fP are present in a
  data line that is successfully matched, the substrings extracted by the
-Line 690 
 function to distinguish printing and non
+Line 738 
 function to distinguish printing and non
  .rs
  .sp
  The facilities described in this section are not available when the POSIX
- 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
  specified.
  .P
  When the POSIX interface is not in use, you can cause \fBpcretest\fP to write a
-Line 714 
 exact copy of the compiled pattern. If t
+Line 762 
 exact copy of the compiled pattern. If t
  follows immediately after the compiled pattern. After writing the file,
  \fBpcretest\fP expects to read a new pattern.
  .P
- 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
  name instead of a pattern. The name of the file must not contain a < character,
  as otherwise \fBpcretest\fP will interpret the line as a pattern delimited by <
  characters.
  For example:
  .sp
     re> </some/file
-   Compiled regex loaded from /some/file
+   Compiled pattern loaded from /some/file
    No study data
  .sp
  When the pattern has been loaded, \fBpcretest\fP proceeds to read data lines in
-Line 767 
 Cambridge CB2 3QH, England.
+Line 815 
 Cambridge CB2 3QH, England.
  .rs
  .sp
  .nf
- Last updated: 22 October 2010
+ Last updated: 11 July 2011
- Copyright (c) 1997-2010 University of Cambridge.
+ Copyright (c) 1997-2011 University of Cambridge.
  .fi

 Legend:



Removed from v.553
 


changed lines


 
Added in v.616
 Legend:



Removed from v.553
 


changed lines


 
Added in v.616
-Removed from v.553
+Added in v.616

webmaster@exim.org	ViewVC Help
Powered by ViewVC 1.1.12