Diff for /embedaddon/pcre/doc/pcretest.txt between versions 1.1.1.2 and 1.1.1.5

version 1.1.1.2, 2012/02/21 23:50:25 version 1.1.1.5, 2014/06/15 19:46:04
Line 1 Line 1
PCRETEST(1)                                                        PCRETEST(1)PCRETEST(1)                 General Commands Manual                PCRETEST(1)
   
   
   
 NAME  NAME
        pcretest - a program for testing Perl-compatible regular expressions.         pcretest - a program for testing Perl-compatible regular expressions.
   
   
 SYNOPSIS  SYNOPSIS
   
        pcretest [options] [input file [output file]]         pcretest [options] [input file [output file]]
Line 14  SYNOPSIS Line 14  SYNOPSIS
        expressions.  This document describes the features of the test program;         expressions.  This document describes the features of the test program;
        for details of the regular expressions themselves, see the  pcrepattern         for details of the regular expressions themselves, see the  pcrepattern
        documentation. For details of the PCRE library function calls and their         documentation. For details of the PCRE library function calls and their
       options, see the  pcreapi  and  pcre16  documentation.  The  input  for       options, see the pcreapi , pcre16 and pcre32 documentation.
       pcretest 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. 
   
          The input for pcretest 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.
   
PCRE's 8-BIT and 16-BIT LIBRARIES       As  PCRE has evolved, it has acquired many different features, and as a
        result, pcretest now has rather a lot of obscure  options  for  testing
        every possible feature. Some of these options are specifically designed
        for use in conjunction with the test script and  data  files  that  are
        distributed  as  part of PCRE, and are unlikely to be of use otherwise.
        They are all documented here, but without much justification.
   
   
   INPUT DATA FORMAT
   
          Input to pcretest is processed line by line, either by  calling  the  C
          library's fgets() function, or via the libreadline library (see below).
          In Unix-like environments, fgets() treats any bytes other than  newline
          as  data characters. However, in some Windows environments character 26
          (hex 1A) causes an immediate end of file, and no further data is  read.
          For  maximum  portability,  therefore,  it  is safest to use only ASCII
          characters in pcretest input files.
   
   
   PCRE's 8-BIT, 16-BIT AND 32-BIT LIBRARIES
   
        From release 8.30, two separate PCRE libraries can be built. The origi-         From release 8.30, two separate PCRE libraries can be built. The origi-
        nal  one  supports  8-bit  character  strings, whereas the newer 16-bit         nal  one  supports  8-bit  character  strings, whereas the newer 16-bit
       library  supports  character  strings  encoded  in  16-bit  units.  The       library supports  character  strings  encoded  in  16-bit  units.  From
       pcretest  program  can  be  used to test both libraries. However, it is       release  8.32,  a  third  library  can  be  built, supporting character
       itself still an 8-bit program, reading 8-bit input  and  writing  8-bit       strings encoded in 32-bit units. The pcretest program can  be  used  to
       output.  When testing the 16-bit library, the patterns and data strings       test all three libraries. However, it is itself still an 8-bit program,
       are converted to 16-bit format before being passed to the PCRE  library       reading 8-bit input and writing 8-bit output.  When testing the  16-bit
       functions. Results are converted to 8-bit for output.       or  32-bit  library, the patterns and data strings are converted to 16-
        or 32-bit format before being passed to  the  PCRE  library  functions.
        Results are converted to 8-bit for output.
   
       References  to  functions  and structures of the form pcre[16]_xx below       References to functions and structures of the form pcre[16|32]_xx below
       mean "pcre_xx when using the 8-bit library or pcre16_xx when using  the       mean "pcre_xx when using the 8-bit library, pcre16_xx  when  using  the
       16-bit library".       16-bit library, or pcre32_xx when using the 32-bit library".
   
   
 COMMAND LINE OPTIONS  COMMAND LINE OPTIONS
   
       -16       If  both  the 8-bit and the 16-bit libraries have been built,       -8        If  both the 8-bit library has been built, this option causes
                 this option causes the 16-bit library to be used. If only the                 the 8-bit library to be used (which is the default);  if  the
                 16-bit library has been built, this is the default (so has no                 8-bit  library  has  not  been  built,  this option causes an
                 effect). If only the  8-bit  library  has  been  built,  this                 error.
                 option causes an error. 
   
       -b        Behave  as  if each pattern has the /B (show byte code) modi-       -16       If both the 8-bit or the 32-bit,  and  the  16-bit  libraries
                  have  been built, this option causes the 16-bit library to be
                  used. If only the 16-bit library has been built, this is  the
                  default  (so  has no effect). If only the 8-bit or the 32-bit
                  library has been built, this option causes an error.
 
        -32       If both the 8-bit or the 16-bit,  and  the  32-bit  libraries
                  have  been built, this option causes the 32-bit library to be
                  used. If only the 32-bit library has been built, this is  the
                  default  (so  has no effect). If only the 8-bit or the 16-bit
                  library has been built, this option causes an error.
 
        -b        Behave as if each pattern has the /B (show byte  code)  modi-
                  fier; the internal form is output after compilation.                   fier; the internal form is output after compilation.
   
        -C        Output the version number of the PCRE library, and all avail-         -C        Output the version number of the PCRE library, and all avail-
                 able   information  about  the  optional  features  that  are                 able  information  about  the  optional  features  that   are
                 included, and then exit. All other options are ignored.                 included,  and  then  exit  with  zero  exit  code. All other
                  options are ignored.
   
        -C option Output information about a specific build-time  option,  then         -C option Output information about a specific build-time  option,  then
                  exit.  This functionality is intended for use in scripts such                   exit.  This functionality is intended for use in scripts such
                 as RunTest. The following options output the value indicated:                 as RunTest. The following options output the  value  and  set
                  the exit code as indicated:
   
                   linksize   the internal link size (2, 3, or 4)                   ebcdic-nl  the code for LF (= NL) in an EBCDIC environment:
                                 0x15 or 0x25
                                 0 if used in an ASCII environment
                                 exit code is always 0
                    linksize   the configured internal link size (2, 3, or 4)
                                 exit code is set to the link size
                    newline    the default newline setting:                     newline    the default newline setting:
                                 CR, LF, CRLF, ANYCRLF, or ANY                                  CR, LF, CRLF, ANYCRLF, or ANY
                                   exit code is always 0
   
                 The following options output 1 for true or zero for false:                 The  following  options output 1 for true or 0                  The  following  options output 1 for true or 0 
                  set the exit code to the same value:
   
                      ebcdic     compiled for an EBCDIC environment
                    jit        just-in-time support is available                     jit        just-in-time support is available
                    pcre16     the 16-bit library was built                     pcre16     the 16-bit library was built
                      pcre32     the 32-bit library was built
                    pcre8      the 8-bit library was built                     pcre8      the 8-bit library was built
                    ucp        Unicode property support is available                     ucp        Unicode property support is available
                   utf        UTF-8 and/or UTF-16 support is available                   utf        UTF-8 and/or UTF-16 and/or UTF-32 support
                                 is available
   
       -d        Behave as if each pattern has the /D  (debug)  modifier;  the                 If an unknown option is given, an error  message  is  output;
                 internal  form  and information about the compiled pattern is                 the exit code is 0.
 
        -d        Behave  as  if  each pattern has the /D (debug) modifier; the
                  internal form and information about the compiled  pattern  is
                  output after compilation; -d is equivalent to -b -i.                   output after compilation; -d is equivalent to -b -i.
   
       -dfa      Behave as if each data line contains the \D escape  sequence;       -dfa      Behave  as if each data line contains the \D escape sequence;
                  this    causes    the    alternative    matching    function,                   this    causes    the    alternative    matching    function,
                 pcre[16]_dfa_exec(), to  be  used  instead  of  the  standard                 pcre[16|32]_dfa_exec(),  to  be  used instead of the standard
                 pcre[16]_exec() function (more detail is given below).                 pcre[16|32]_exec() function (more detail is given below).
   
        -help     Output a brief summary these options and then exit.         -help     Output a brief summary these options and then exit.
   
       -i        Behave  as  if  each pattern has the /I modifier; information       -i        Behave as if each pattern has the  /I  modifier;  information
                  about the compiled pattern is given after compilation.                   about the compiled pattern is given after compilation.
   
       -M        Behave as if each data line contains the \M escape  sequence;       -M        Behave  as if each data line contains the \M escape sequence;
                 this  causes  PCRE  to  discover  the minimum MATCH_LIMIT and                 this causes PCRE to  discover  the  minimum  MATCH_LIMIT  and
                 MATCH_LIMIT_RECURSION  settings  by  calling  pcre[16]_exec()                 MATCH_LIMIT_RECURSION  settings by calling pcre[16|32]_exec()
                  repeatedly with different limits.                   repeatedly with different limits.
   
       -m        Output  the  size  of each compiled pattern after it has been       -m        Output the size of each compiled pattern after  it  has  been
                 compiled. This is equivalent to adding  /M  to  each  regular                 compiled.  This  is  equivalent  to adding /M to each regular
                  expression. The size is given in bytes for both libraries.                   expression. The size is given in bytes for both libraries.
   
          -O        Behave as if each pattern has the /O modifier, that  is  dis-
                    able auto-possessification for all patterns.
   
        -o osize  Set  the number of elements in the output vector that is used         -o osize  Set  the number of elements in the output vector that is used
                 when calling pcre[16]_exec()  or  pcre[16]_dfa_exec()  to  be                 when calling pcre[16|32]_exec() or pcre[16|32]_dfa_exec()  to
                 osize.  The  default value is 45, which is enough for 14 cap-                 be  osize.  The  default  value is 45, which is enough for 14
                 turing subexpressions for  pcre[16]_exec()  or  22  different                 capturing subexpressions for pcre[16|32]_exec() or 22 differ-
                 matches  for  pcre[16]_dfa_exec().   The  vector  size can be                 ent  matches for pcre[16|32]_dfa_exec().  The vector size can
                 changed for individual matching calls by including \O in  the                 be changed for individual matching calls by including  \O  in
                 data line (see below).                 the data line (see below).
   
        -p        Behave  as  if  each  pattern  has the /P modifier; the POSIX         -p        Behave  as  if  each  pattern  has the /P modifier; the POSIX
                  wrapper API is used to call PCRE. None of the  other  options                   wrapper API is used to call PCRE. None of the  other  options
Line 111  COMMAND LINE OPTIONS Line 161  COMMAND LINE OPTIONS
                  size megabytes.                   size megabytes.
   
        -s or -s+ Behave as if each pattern  has  the  /S  modifier;  in  other         -s or -s+ Behave as if each pattern  has  the  /S  modifier;  in  other
                 words,  force each pattern to be studied. If -s+ is used, the                 words,  force each pattern to be studied. If -s+ is used, all
                 PCRE_STUDY_JIT_COMPILE flag is  passed  to  pcre[16]_study(),                 the JIT compile options are  passed  to  pcre[16|32]_study(),
                  causing  just-in-time  optimization  to  be  set  up if it is                   causing  just-in-time  optimization  to  be  set  up if it is
                 available. If the /I or /D option is  present  on  a  pattern                 available, for both full and partial matching.  Specific  JIT
                 (requesting  output  about the compiled pattern), information                 compile options can be selected by following -s+ with a digit
                 about the result of studying is not included when studying is                 in the range 1 to 7, which selects the JIT compile  modes  as
                 caused  only  by  -s  and neither -i nor -d is present on the                 follows:
                 command line. This behaviour means that the output from tests 
                 that  are run with and without -s should be identical, except 
                 when options that output information about the actual running 
                 of a match are set. 
   
                      1  normal match only
                      2  soft partial match only
                      3  normal match and soft partial match
                      4  hard partial match only
                      6  soft and hard partial match
                      7  all three modes (default)
   
                    If  -s++  is used instead of -s+ (with or without a following
                    digit), the text "(JIT)" is added to the  first  output  line
                    after a match or no match when JIT-compiled code was actually
                    used.
   
                    Note that there are pattern options  that  can  override  -s,
                    either specifying no studying at all, or suppressing JIT com-
                    pilation.
   
                    If the /I or /D 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  -s  and neither -i nor -d is present on the command
                    line. This behaviour means that the output  from  tests  that
                    are  run with and without -s should be identical, except when
                    options that output information about the actual running of a
                    match are set.
   
                  The  -M,  -t,  and  -tm options, which give information about                   The  -M,  -t,  and  -tm options, which give information about
                  resources used, are likely to produce different  output  with                   resources used, are likely to produce different  output  with
                  and  without  -s.  Output may also differ if the /C option is                   and  without  -s.  Output may also differ if the /C option is
Line 135  COMMAND LINE OPTIONS Line 206  COMMAND LINE OPTIONS
                  tern modifier below).                   tern modifier below).
   
        -t        Run each compile, study, and match many times with  a  timer,         -t        Run each compile, study, and match many times with  a  timer,
                 and  output resulting time per compile or match (in millisec-                 and  output  the resulting times per compile, study, or match
                 onds). Do not set -m with -t, because you will then  get  the                 (in milliseconds). Do not set -m with -t,  because  you  will
                 size  output  a  zillion  times,  and the timing will be dis-                 then get the size output a zillion times, and the timing will
                 torted. You can control the number  of  iterations  that  are                 be distorted. You can control the number of  iterations  that
                 used  for timing by following -t with a number (as a separate                 are used for timing by following -t with a number (as a sepa-
                 item on the command line). For example, "-t 1000" would iter-                 rate item on the command line). For example, "-t 1000"  iter-
                 ate 1000 times. The default is to iterate 500000 times.                 ates 1000 times.  The default is to iterate 500000 times.
   
        -tm       This is like -t except that it times only the matching phase,         -tm       This is like -t except that it times only the matching phase,
                  not the compile or study phases.                   not the compile or study phases.
   
          -T -TM    These behave like -t and -tm, but in addition, at the end  of
                    a run, the total times for all compiles, studies, and matches
                    are output.
   
   
 DESCRIPTION  DESCRIPTION
   
        If pcretest is given two filename arguments, it reads  from  the  first         If pcretest is given two filename arguments, it reads  from  the  first
Line 164  DESCRIPTION Line 239  DESCRIPTION
   
        The program handles any number of sets of input on a single input file.         The program handles any number of sets of input on a single input file.
        Each set starts with a regular expression, and continues with any  num-         Each set starts with a regular expression, and continues with any  num-
       ber of data lines to be matched against the pattern.       ber of data lines to be matched against that pattern.
   
        Each  data line is matched separately and independently. If you want to         Each  data line is matched separately and independently. If you want to
        do multi-line matches, you have to use the \n escape sequence (or \r or         do multi-line matches, you have to use the \n escape sequence (or \r or
Line 207  DESCRIPTION Line 282  DESCRIPTION
 PATTERN MODIFIERS  PATTERN MODIFIERS
   
        A pattern may be followed by any number of modifiers, which are  mostly         A pattern may be followed by any number of modifiers, which are  mostly
       single  characters.  Following  Perl usage, these are referred to below       single  characters,  though  some  of these can be qualified by further
       as, for example, "the /i modifier", even though the  delimiter  of  the       characters.  Following Perl usage, these are referred to below as,  for
       pattern  need  not always be a slash, and no slash is used when writing       example,  "the  /i  modifier", even though the delimiter of the pattern
       modifiers. White space may appear between the final  pattern  delimiter       need not always be a slash, and no slash is  used  when  writing  modi-
       and the first modifier, and between the modifiers themselves.       fiers.  White  space may appear between the final pattern delimiter and
        the first modifier, and between the modifiers  themselves.  For  refer-
        ence,  here  is  a  complete  list of modifiers. They fall into several
        groups that are described in detail in the following sections.
   
            /8              set UTF mode
            /9              set PCRE_NEVER_UTF (locks out UTF mode)
            /?              disable UTF validity check
            /+              show remainder of subject after match
            /=              show all captures (not just those that are set)
   
            /A              set PCRE_ANCHORED
            /B              show compiled code
            /C              set PCRE_AUTO_CALLOUT
            /D              same as /B plus /I
            /E              set PCRE_DOLLAR_ENDONLY
            /F              flip byte order in compiled pattern
            /f              set PCRE_FIRSTLINE
            /G              find all matches (shorten string)
            /g              find all matches (use startoffset)
            /I              show information about pattern
            /i              set PCRE_CASELESS
            /J              set PCRE_DUPNAMES
            /K              show backtracking control names
            /L              set locale
            /M              show compiled memory size
            /m              set PCRE_MULTILINE
            /N              set PCRE_NO_AUTO_CAPTURE
            /O              set PCRE_NO_AUTO_POSSESS
            /P              use the POSIX wrapper
            /S              study the pattern after compilation
            /s              set PCRE_DOTALL
            /T              select character tables
            /U              set PCRE_UNGREEDY
            /W              set PCRE_UCP
            /X              set PCRE_EXTRA
            /x              set PCRE_EXTENDED
            /Y              set PCRE_NO_START_OPTIMIZE
            /Z              don't show lengths in /B output
   
            /<any>          set PCRE_NEWLINE_ANY
            /<anycrlf>      set PCRE_NEWLINE_ANYCRLF
            /<cr>           set PCRE_NEWLINE_CR
            /<crlf>         set PCRE_NEWLINE_CRLF
            /<lf>           set PCRE_NEWLINE_LF
            /<bsr_anycrlf>  set PCRE_BSR_ANYCRLF
            /<bsr_unicode>  set PCRE_BSR_UNICODE
            /<JS>           set PCRE_JAVASCRIPT_COMPAT
   
   
      Perl-compatible modifiers
   
        The /i, /m, /s, and /x modifiers set the PCRE_CASELESS, PCRE_MULTILINE,         The /i, /m, /s, and /x modifiers set the PCRE_CASELESS, PCRE_MULTILINE,
       PCRE_DOTALL, or PCRE_EXTENDED options, respectively, when pcre[16]_com-       PCRE_DOTALL,    or    PCRE_EXTENDED    options,    respectively,   when
       pile()  is  called. These four modifier letters have the same effect as       pcre[16|32]_compile() is called. These four modifier letters  have  the
       they do in Perl. For example:       same effect as they do in Perl. For example:
   
          /caseless/i           /caseless/i
   
       The following table shows additional modifiers for  setting  PCRE  com-        pile-time options that do not correspond to anything in Perl:
    Modifiers for other PCRE options
 
        The  following  table  shows additional modifiers for setting PCRE com-
        pile-time options that do not correspond to anything in Perl:         pile-time options that do not correspond to anything in Perl:
   
          /8              PCRE_UTF8           ) when using the 8-bit           /8              PCRE_UTF8           ) when using the 8-bit
Line 229  PATTERN MODIFIERS Line 357  PATTERN MODIFIERS
          /8              PCRE_UTF16          ) when using the 16-bit           /8              PCRE_UTF16          ) when using the 16-bit
          /?              PCRE_NO_UTF16_CHECK )   library           /?              PCRE_NO_UTF16_CHECK )   library
   
            /8              PCRE_UTF32          ) when using the 32-bit
            /?              PCRE_NO_UTF32_CHECK )   library
   
            /9              PCRE_NEVER_UTF
          /A              PCRE_ANCHORED           /A              PCRE_ANCHORED
          /C              PCRE_AUTO_CALLOUT           /C              PCRE_AUTO_CALLOUT
          /E              PCRE_DOLLAR_ENDONLY           /E              PCRE_DOLLAR_ENDONLY
          /f              PCRE_FIRSTLINE           /f              PCRE_FIRSTLINE
          /J              PCRE_DUPNAMES           /J              PCRE_DUPNAMES
          /N              PCRE_NO_AUTO_CAPTURE           /N              PCRE_NO_AUTO_CAPTURE
            /O              PCRE_NO_AUTO_POSSESS
          /U              PCRE_UNGREEDY           /U              PCRE_UNGREEDY
          /W              PCRE_UCP           /W              PCRE_UCP
          /X              PCRE_EXTRA           /X              PCRE_EXTRA
          /Y              PCRE_NO_START_OPTIMIZE           /Y              PCRE_NO_START_OPTIMIZE
         /<JS>           PCRE_JAVASCRIPT_COMPAT         /<any>          PCRE_NEWLINE_ANY
          /<anycrlf>      PCRE_NEWLINE_ANYCRLF
          /<cr>           PCRE_NEWLINE_CR           /<cr>           PCRE_NEWLINE_CR
          /<lf>           PCRE_NEWLINE_LF  
          /<crlf>         PCRE_NEWLINE_CRLF           /<crlf>         PCRE_NEWLINE_CRLF
         /<anycrlf>      PCRE_NEWLINE_ANYCRLF         /<lf>           PCRE_NEWLINE_LF
         /<any>          PCRE_NEWLINE_ANY 
          /<bsr_anycrlf>  PCRE_BSR_ANYCRLF           /<bsr_anycrlf>  PCRE_BSR_ANYCRLF
          /<bsr_unicode>  PCRE_BSR_UNICODE           /<bsr_unicode>  PCRE_BSR_UNICODE
            /<JS>           PCRE_JAVASCRIPT_COMPAT
   
       The  modifiers  that are enclosed in angle brackets are literal strings       The modifiers that are enclosed in angle brackets are  literal  strings
       as shown, including the angle brackets, but the letters within  can  be       as  shown,  including the angle brackets, but the letters within can be
       in  either case.  This example sets multiline matching with CRLF as the       in either case.  This example sets multiline matching with CRLF as  the
        line ending sequence:         line ending sequence:
   
          /^abc/m<CRLF>           /^abc/m<CRLF>
   
       As well as turning on the PCRE_UTF8/16 option, the /8  modifier  causes       As  well  as  turning  on  the  PCRE_UTF8/16/32 option, the /8 modifier
       all  non-printing  characters in output strings to be printed using the       causes all non-printing characters in  output  strings  to  be  printed
       \x{hh...} notation. Otherwise, those less than 0x100 are output in  hex       using the \x{hh...} notation. Otherwise, those less than 0x100 are out-
       without the curly brackets.       put in hex without the curly brackets.
   
       Full  details  of  the PCRE options are given in the pcreapi documenta-       Full details of the PCRE options are given in  the  pcreapi  documenta-
        tion.         tion.
   
    Finding all matches in a string     Finding all matches in a string
   
       Searching for all possible matches within each subject  string  can  be       Searching  for  all  possible matches within each subject string can be
       requested  by  the  /g  or  /G modifier. After finding a match, PCRE is       requested by the /g or /G modifier. After  finding  a  match,  PCRE  is
        called again to search the remainder of the subject string. The differ-         called again to search the remainder of the subject string. The differ-
        ence between /g and /G is that the former uses the startoffset argument         ence between /g and /G is that the former uses the startoffset argument
       to pcre[16]_exec() to start searching at a new point within the  entire       to  pcre[16|32]_exec()  to  start  searching  at a new point within the
       string  (which  is in effect what Perl does), whereas the latter passes       entire string (which is in effect what Perl does), whereas  the  latter
       over a shortened substring. This makes a  difference  to  the  matching       passes  over  a  shortened  substring.  This  makes a difference to the
       process if the pattern begins with a lookbehind assertion (including \b       matching process if the pattern  begins  with  a  lookbehind  assertion
       or \B).       (including \b or \B).
   
       If any call to pcre[16]_exec() in a /g or /G sequence matches an  empty       If  any  call  to  pcre[16|32]_exec() in a /g or /G sequence matches an
       string,  the  next  call  is  done  with  the PCRE_NOTEMPTY_ATSTART and       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,       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       match at the same point. If this second match fails, the  start  offset
       is advanced, and the normal match is retried.  This  imitates  the  way       is  advanced,  and  the  normal match is retried. This imitates the way
        Perl handles such cases when using the /g modifier or the split() func-         Perl handles such cases when using the /g modifier or the split() func-
       tion. Normally, the start offset is advanced by one character,  but  if       tion.  Normally,  the start offset is advanced by one character, but if
       the  newline  convention  recognizes CRLF as a newline, and the current       the newline convention recognizes CRLF as a newline,  and  the  current
        character is CR followed by LF, an advance of two is used.         character is CR followed by LF, an advance of two is used.
   
    Other modifiers     Other modifiers
   
        There are yet more modifiers for controlling the way pcretest operates.         There are yet more modifiers for controlling the way pcretest operates.
   
       The /+ modifier requests that as well as outputting the substring  that       The  /+ modifier requests that as well as outputting the substring that
       matched  the  entire  pattern,  pcretest  should in addition output the       matched the entire pattern, pcretest  should  in  addition  output  the
       remainder of the subject string. This is useful  for  tests  where  the       remainder  of  the  subject  string. This is useful for tests where the
       subject  contains multiple copies of the same substring. If the + modi-       subject contains multiple copies of the same substring. If the +  modi-
       fier appears twice, the same action is taken for  captured  substrings.       fier  appears  twice, the same action is taken for captured substrings.
       In  each case the remainder is output on the following line with a plus       In each case the remainder is output on the following line with a  plus
       character following the capture number. Note that  this  modifier  must       character  following  the  capture number. Note that this modifier must
       not immediately follow the /S modifier because /S+ has another meaning.       not immediately follow the /S modifier because /S+ and /S++ have  other
        meanings.
   
        The  /=  modifier  requests  that  the values of all potential captured         The  /=  modifier  requests  that  the values of all potential captured
        parentheses be output after a match. By default, only those up  to  the         parentheses be output after a match. By default, only those up  to  the
        highest one actually used in the match are output (corresponding to the         highest one actually used in the match are output (corresponding to the
       return code from pcre[16]_exec()). Values in the offsets vector  corre-       return code from pcre[16|32]_exec()). Values in the offsets vector cor-
       sponding to higher numbers should be set to -1, and these are output as       responding  to higher numbers should be set to -1, and these are output
       "<unset>". This modifier gives a way of checking that this  is  happen-       as "<unset>". This modifier gives a way of checking that this  is  hap-
       ing.       pening.
   
        The  /B modifier is a debugging feature. It requests that pcretest out-         The  /B modifier is a debugging feature. It requests that pcretest out-
        put a representation of the compiled code after  compilation.  Normally         put a representation of the compiled code after  compilation.  Normally
Line 326  PATTERN MODIFIERS Line 460  PATTERN MODIFIERS
   
        The  /I  modifier  requests  that pcretest output information about the         The  /I  modifier  requests  that pcretest output information about the
        compiled pattern (whether it is anchored, has a fixed first  character,         compiled pattern (whether it is anchored, has a fixed first  character,
       and so on). It does this by calling pcre[16]_fullinfo() after compiling       and  so  on). It does this by calling pcre[16|32]_fullinfo() after com-
       a pattern. If the pattern is studied, the results of that are also out-       piling a pattern. If the pattern is studied, the results  of  that  are
       put.       also output.
   
        The  /K modifier requests pcretest to show names from backtracking con-         The  /K modifier requests pcretest to show names from backtracking con-
       trol verbs that are returned from calls to pcre[16]_exec().  It  causes       trol verbs that are  returned  from  calls  to  pcre[16|32]_exec().  It
       pcretest  to  create a pcre[16]_extra block if one has not already been       causes  pcretest  to  create  a  pcre[16|32]_extra block if one has not
       created by a call to pcre[16]_study(), and to set  the  PCRE_EXTRA_MARK       already been created by a call to pcre[16|32]_study(), and to  set  the
       flag  and  the mark field within it, every time that pcre[16]_exec() is       PCRE_EXTRA_MARK  flag  and  the  mark  field within it, every time that
       called. If the variable that the mark field points to is non-NULL for a       pcre[16|32]_exec() is called. If  the  variable  that  the  mark  field
       match, non-match, or partial match, pcretest prints the string to which       points  to  is  non-NULL  for  a  match,  non-match,  or partial match,
       it points. For a match, this is shown on a line by itself, tagged  with       pcretest prints the string to which it points. For  a  match,  this  is
       "MK:". For a non-match it is added to the message.       shown  on  a  line  by itself, tagged with "MK:". For a non-match it is
        added to the message.
   
       The  /L modifier must be followed directly by the name of a locale, for       The /L modifier must be followed directly by the name of a locale,  for
        example,         example,
   
          /pattern/Lfr_FR           /pattern/Lfr_FR
   
        For this reason, it must be the last modifier. The given locale is set,         For this reason, it must be the last modifier. The given locale is set,
       pcre[16]_maketables()  is called to build a set of character tables for       pcre[16|32]_maketables() is called to build a set of  character  tables
       the locale, and this is then passed to pcre[16]_compile() when  compil-       for  the  locale, and this is then passed to pcre[16|32]_compile() when
       ing  the  regular  expression.  Without an /L (or /T) modifier, NULL is       compiling the regular expression. Without an /L (or /T) modifier,  NULL
       passed as the tables pointer; that is, /L applies only to  the  expres-       is  passed  as  the  tables  pointer;  that  is, /L applies only to the
       sion on which it appears.       expression on which it appears.
   
       The  /M  modifier  causes the size in bytes of the memory block used to       The /M modifier causes the size in bytes of the memory  block  used  to
       hold the compiled pattern to be output. This does not include the  size       hold  the compiled pattern to be output. This does not include the size
       of the pcre[16] block; it is just the actual compiled data. If the pat-       of the pcre[16|32] block; it is just the actual compiled data.  If  the
       tern is successfully studied with  the  PCRE_STUDY_JIT_COMPILE  option,       pattern is successfully studied with the PCRE_STUDY_JIT_COMPILE option,
        the size of the JIT compiled code is also output.         the size of the JIT compiled code is also output.
   
       If  the  /S  modifier  appears  once,  it causes pcre[16]_study() to be       The /S modifier causes  pcre[16|32]_study()  to  be  called  after  the
       called after the expression has been compiled,  and  the  results  used       expression  has been compiled, and the results used when the expression
       when  the  expression  is  matched.  If /S appears twice, it suppresses       is matched. There are a number of qualifying characters that may follow
       studying, even if it was requested externally by the  -s  command  line       /S.  They may appear in any order.
       option.  This  makes  it  possible to specify that certain patterns are 
       always studied, and others are never studied, independently of -s. This 
       feature  is  used  in the test files in a few cases where the output is 
       different when the pattern is studied. 
   
       If the /S modifier is immediately followed by a + character,  the  call       If /S is followed by an exclamation mark, pcre[16|32]_study() is called
       to  pcre[16]_study()  is  made  with the PCRE_STUDY_JIT_COMPILE option,       with the PCRE_STUDY_EXTRA_NEEDED option, causing it always to return  a
       requesting just-in-time optimization support if it is  available.  Note       pcre_extra block, even when studying discovers no useful information.
       that  there  is  also  a  /+ modifier; it must not be given immediately 
       after /S because this will be misinterpreted. If JIT studying  is  suc- 
       cessful,  it  will  automatically  be used when pcre[16]_exec() is run, 
       except when incompatible run-time options are specified. These  include 
       the  partial  matching options; a complete list is given in the pcrejit 
       documentation. See also the \J escape sequence below for a way of  set- 
       ting the size of the JIT stack. 
   
       The  /T  modifier  must be followed by a single digit. It causes a spe-       If /S is followed by a second S character, it suppresses studying, even
       cific set of built-in character tables to be  passed  to  pcre[16]_com-       if it was requested externally by the  -s  command  line  option.  This
       pile().  It  is used in the standard PCRE tests to check behaviour with       makes  it possible to specify that certain patterns are always studied,
        and others are never studied, independently of -s. This feature is used
        in the test files in a few cases where the output is different when the
        pattern is studied.
 
        If the  /S  modifier  is  followed  by  a  +  character,  the  call  to
        pcre[16|32]_study()  is made with all the JIT study options, requesting
        just-in-time optimization support if it is available, for  both  normal
        and  partial matching. If you want to restrict the JIT compiling modes,
        you can follow /S+ with a digit in the range 1 to 7:
 
          1  normal match only
          2  soft partial match only
          3  normal match and soft partial match
          4  hard partial match only
          6  soft and hard partial match
          7  all three modes (default)
 
        If /S++ is used instead of /S+ (with or without a following digit), the
        text  "(JIT)"  is  added  to  the first output line after a match or no
        match when JIT-compiled code was actually used.
 
        Note that there is also an independent /+  modifier;  it  must  not  be
        given immediately after /S or /S+ because this will be misinterpreted.
 
        If JIT studying is successful, the compiled JIT code will automatically
        be used when pcre[16|32]_exec() is run, except when  incompatible  run-
        time  options are specified. For more details, see the pcrejit documen-
        tation. See also the \J escape sequence below for a way of setting  the
        size of the JIT stack.
 
        Finally,  if  /S  is  followed by a minus character, JIT compilation is
        suppressed, even if it was requested externally by the -s command  line
        option.  This makes it possible to specify that JIT is never to be used
        for certain patterns.
 
        The /T modifier must be followed by a single digit. It  causes  a  spe-
        cific set of built-in character tables to be passed to pcre[16|32]_com-
        pile(). It is used in the standard PCRE tests to check  behaviour  with
        different character tables. The digit specifies the tables as follows:         different character tables. The digit specifies the tables as follows:
   
          0   the default ASCII tables, as distributed in           0   the default ASCII tables, as distributed in
                pcre_chartables.c.dist                 pcre_chartables.c.dist
          1   a set of tables defining ISO 8859 characters           1   a set of tables defining ISO 8859 characters
   
       In table 1, some characters whose codes are greater than 128 are  iden-       In  table 1, some characters whose codes are greater than 128 ariden-
        tified as letters, digits, spaces, etc.         tified as letters, digits, spaces, etc.
   
    Using the POSIX wrapper API     Using the POSIX wrapper API
   
       The  /P modifier causes pcretest to call PCRE via the POSIX wrapper API       The /P modifier causes pcretest to call PCRE via the POSIX wrapper  API
       rather than its native API. This supports only the 8-bit library.  When       rather  than its native API. This supports only the 8-bit library. When
       /P  is set, the following modifiers set options for the regcomp() func-       /P is set, the following modifiers set options for the regcomp()  func-
        tion:         tion:
   
          /i    REG_ICASE           /i    REG_ICASE
Line 405  PATTERN MODIFIERS Line 567  PATTERN MODIFIERS
          /W    REG_UCP        )   the POSIX standard           /W    REG_UCP        )   the POSIX standard
          /8    REG_UTF8       )           /8    REG_UTF8       )
   
       The /+ modifier works as  described  above.  All  other  modifiers  are       The  /+  modifier  works  as  described  above. All other modifiers are
        ignored.         ignored.
   
      Locking out certain modifiers
   
          PCRE can be compiled with or without support for certain features  such
          as  UTF-8/16/32  or Unicode properties. Accordingly, the standard tests
          are split up into a number of different files  that  are  selected  for
          running  depending  on  which features are available. When updating the
          tests, it is all too easy to put a new test into the wrong file by mis-
          take;  for example, to put a test that requires UTF support into a file
          that is used when it is not available. To help detect such mistakes  as
          early  as  possible, there is a facility for locking out specific modi-
          fiers. If an input line for pcretest starts with the string "< forbid "
          the  following  sequence  of characters is taken as a list of forbidden
          modifiers. For example, in the test files that must not use UTF or Uni-
          code property support, this line appears:
   
            < forbid 8W
   
          This  locks out the /8 and /W modifiers. An immediate error is given if
          they are subsequently encountered. If the character string  contains  <
          but  not  >,  all  the  multi-character modifiers that begin with < are
          locked out. Otherwise, such modifiers must be  explicitly  listed,  for
          example:
   
            < forbid <JS><cr>
   
          There must be a single space between < and "forbid" for this feature to
          be recognised. If there is not, the line is  interpreted  either  as  a
          request  to  re-load  a pre-compiled pattern (see "SAVING AND RELOADING
          COMPILED PATTERNS" below) or, if there is a another < character,  as  a
          pattern that uses < as its delimiter.
   
   
 DATA LINES  DATA LINES
   
       Before  each data line is passed to pcre[16]_exec(), leading and trail-       Before  each  data  line  is  passed to pcre[16|32]_exec(), leading and
       ing white space is removed, and it is then scanned for \ escapes.  Some       trailing white space is removed, and it is then scanned for \  escapes.
       of  these  are pretty esoteric features, intended for checking out some       Some  of  these are pretty esoteric features, intended for checking out
       of the more complicated features of  PCRE.  If  you  are  just  testing       some of the more complicated features of PCRE. If you are just  testing
        "ordinary"  regular  expressions, you probably don't need any of these.         "ordinary"  regular  expressions, you probably don't need any of these.
        The following escapes are recognized:         The following escapes are recognized:
   
Line 429  DATA LINES Line 622  DATA LINES
          \t         tab (\x09)           \t         tab (\x09)
          \v         vertical tab (\x0b)           \v         vertical tab (\x0b)
          \nnn       octal character (up to 3 octal digits); always           \nnn       octal character (up to 3 octal digits); always
                      a byte unless > 255 in UTF-8 or 16-bit mode                      a byte unless > 255 in UTF-8 or 16-bit or 32-bit mode
          \o{dd...}  octal character (any number of octal digits}
          \xhh       hexadecimal byte (up to 2 hex digits)           \xhh       hexadecimal byte (up to 2 hex digits)
          \x{hh...}  hexadecimal character (any number of hex digits)           \x{hh...}  hexadecimal character (any number of hex digits)
         \A         pass the PCRE_ANCHORED option to pcre[16]_exec()         \A         pass the PCRE_ANCHORED option to pcre[16|32]_exec()
                      or pcre[16]_dfa_exec()                      or pcre[16|32]_dfa_exec()
         \B         pass the PCRE_NOTBOL option to pcre[16]_exec()         \B         pass the PCRE_NOTBOL option to pcre[16|32]_exec()
                      or pcre[16]_dfa_exec()                      or pcre[16|32]_dfa_exec()
         \Cdd       call pcre[16]_copy_substring() for substring dd         \Cdd       call pcre[16|32]_copy_substring() for substring dd
                       after a successful match (number less than 32)                        after a successful match (number less than 32)
         \Cname     call pcre[16]_copy_named_substring() for substring         \Cname     call pcre[16|32]_copy_named_substring() for substring
                       "name" after a successful match (name termin-                        "name" after a successful match (name termin-
                       ated by next non alphanumeric character)                        ated by next non alphanumeric character)
          \C+        show the current captured substrings at callout           \C+        show the current captured substrings at callout
Line 450  DATA LINES Line 644  DATA LINES
                       reached for the nth time                        reached for the nth time
          \C*n       pass the number n (may be negative) as callout           \C*n       pass the number n (may be negative) as callout
                       data; this is used as the callout return value                        data; this is used as the callout return value
         \D         use the pcre[16]_dfa_exec() match function         \D         use the pcre[16|32]_dfa_exec() match function
         \F         only shortest match for pcre[16]_dfa_exec()         \F         only shortest match for pcre[16|32]_dfa_exec()
         \Gdd       call pcre[16]_get_substring() for substring dd         \Gdd       call pcre[16|32]_get_substring() for substring dd
                       after a successful match (number less than 32)                        after a successful match (number less than 32)
         \Gname     call pcre[16]_get_named_substring() for substring         \Gname     call pcre[16|32]_get_named_substring() for substring
                       "name" after a successful match (name termin-                        "name" after a successful match (name termin-
                       ated by next non-alphanumeric character)                        ated by next non-alphanumeric character)
          \Jdd       set up a JIT stack of dd kilobytes maximum (any           \Jdd       set up a JIT stack of dd kilobytes maximum (any
                       number of digits)                        number of digits)
         \L         call pcre[16]_get_substringlist() after a         \L         call pcre[16|32]_get_substringlist() after a
                       successful match                        successful match
          \M         discover the minimum MATCH_LIMIT and           \M         discover the minimum MATCH_LIMIT and
                       MATCH_LIMIT_RECURSION settings                        MATCH_LIMIT_RECURSION settings
         \N         pass the PCRE_NOTEMPTY option to pcre[16]_exec()         \N         pass the PCRE_NOTEMPTY option to pcre[16|32]_exec()
                      or pcre[16]_dfa_exec(); if used twice, pass the                      or pcre[16|32]_dfa_exec(); if used twice, pass the
                       PCRE_NOTEMPTY_ATSTART option                        PCRE_NOTEMPTY_ATSTART option
          \Odd       set the size of the output vector passed to           \Odd       set the size of the output vector passed to
                      pcre[16]_exec() to dd (any number of digits)                      pcre[16|32]_exec() to dd (any number of digits)
         \P         pass the PCRE_PARTIAL_SOFT option to pcre[16]_exec()         \P         pass the PCRE_PARTIAL_SOFT option to pcre[16|32]_exec()
                      or pcre[16]_dfa_exec(); if used twice, pass the                      or pcre[16|32]_dfa_exec(); if used twice, pass the
                       PCRE_PARTIAL_HARD option                        PCRE_PARTIAL_HARD option
          \Qdd       set the PCRE_MATCH_LIMIT_RECURSION limit to dd           \Qdd       set the PCRE_MATCH_LIMIT_RECURSION limit to dd
                       (any number of digits)                        (any number of digits)
         \R         pass the PCRE_DFA_RESTART option to pcre[16]_dfa_exec()         \R         pass the PCRE_DFA_RESTART option to pcre[16|32]_dfa_exec()
          \S         output details of memory get/free calls during matching           \S         output details of memory get/free calls during matching
         \Y         pass the PCRE_NO_START_OPTIMIZE option to pcre[16]_exec()         \Y            pass    the    PCRE_NO_START_OPTIMIZE     option     to
                      or pcre[16]_dfa_exec()       pcre[16|32]_exec()
         \Z         pass the PCRE_NOTEOL option to pcre[16]_exec()                      or pcre[16|32]_dfa_exec()
                      or pcre[16]_dfa_exec()         \Z         pass the PCRE_NOTEOL option to pcre[16|32]_exec()
         \?         pass the PCRE_NO_UTF[8|16]_CHECK option to                      or pcre[16|32]_dfa_exec()
                      pcre[16]_exec() or pcre[16]_dfa_exec()          \>dd       start the match at offset dd (optional "-"; then
                       pcre[16|32]_exec() or pcre[16|32]_dfa_exec()
          \>dd       start the match at offset dd (optional "-"; then           \>dd       start the match at offset dd (optional "-"; then
                       any number of digits); this sets the startoffset                        any number of digits); this sets the startoffset
                      argument for pcre[16]_exec() or pcre[16]_dfa_exec()                      argument         for        pcre[16|32]_exec()        or
         \<cr>      pass the PCRE_NEWLINE_CR option to pcre[16]_exec()       pcre[16|32]_dfa_exec()
                      or pcre[16]_dfa_exec()         \<cr>      pass the PCRE_NEWLINE_CR option to pcre[16|32]_exec()
         \<lf>      pass the PCRE_NEWLINE_LF option to pcre[16]_exec()                      or pcre[16|32]_dfa_exec()
                      or pcre[16]_dfa_exec()         \<lf>      pass the PCRE_NEWLINE_LF option to pcre[16|32]_exec()
         \<crlf>    pass the PCRE_NEWLINE_CRLF option to pcre[16]_exec()                      or pcre[16|32]_dfa_exec()
                      or pcre[16]_dfa_exec()         \<crlf>    pass the PCRE_NEWLINE_CRLF option to pcre[16|32]_exec()
         \<anycrlf> pass the PCRE_NEWLINE_ANYCRLF option to pcre[16]_exec()                      or pcre[16|32]_dfa_exec()
                      or pcre[16]_dfa_exec()         \<anycrlf> pass the PCRE_NEWLINE_ANYCRLF option to pcre[16|32]_exec()
         \<any>     pass the PCRE_NEWLINE_ANY option to pcre[16]_exec()                      or pcre[16|32]_dfa_exec()
                      or pcre[16]_dfa_exec()         \<any>     pass the PCRE_NEWLINE_ANY option to pcre[16|32]_exec()
                       or pcre[16|32]_dfa_exec()
   
        The use of \x{hh...} is not dependent on the use of the /8 modifier  on         The use of \x{hh...} is not dependent on the use of the /8 modifier  on
        the  pattern. It is recognized always. There may be any number of hexa-         the  pattern. It is recognized always. There may be any number of hexa-
Line 511  DATA LINES Line 707  DATA LINES
        In UTF-16 mode, all 4-digit \x{hhhh} values are accepted. This makes it         In UTF-16 mode, all 4-digit \x{hhhh} values are accepted. This makes it
        possible to construct invalid UTF-16 sequences for testing purposes.         possible to construct invalid UTF-16 sequences for testing purposes.
   
          In UTF-32 mode, all 4- to 8-digit \x{...}  values  are  accepted.  This
          makes  it  possible  to  construct invalid UTF-32 sequences for testing
          purposes.
   
        The escapes that specify line ending  sequences  are  literal  strings,         The escapes that specify line ending  sequences  are  literal  strings,
        exactly as shown. No more than one newline setting should be present in         exactly as shown. No more than one newline setting should be present in
        any data line.         any data line.
Line 525  DATA LINES Line 725  DATA LINES
        mization  is  not being used. Providing a stack that is larger than the         mization  is  not being used. Providing a stack that is larger than the
        default 32K is necessary only for very complicated patterns.         default 32K is necessary only for very complicated patterns.
   
       If \M is present, pcretest calls pcre[16]_exec()  several  times,  with       If \M is present, pcretest calls pcre[16|32]_exec() several times, with
        different values in the match_limit and match_limit_recursion fields of         different values in the match_limit and match_limit_recursion fields of
       the pcre[16]_extra data structure, until it finds the  minimum  numbers       the pcre[16|32]_extra data structure, until it finds the  minimum  num-
       for  each  parameter  that  allow  pcre[16]_exec()  to complete without       bers for each parameter that allow pcre[16|32]_exec() to complete with-
       error. Because this is testing a specific feature of the normal  inter-       out error. Because this is testing a specific  feature  of  the  normal
       pretive pcre[16]_exec() execution, the use of any JIT optimization that       interpretive pcre[16|32]_exec() execution, the use of any JIT optimiza-
       might have been set up by the /S+ qualifier of -s+ option is disabled.       tion that might have been set up by the /S+ qualifier of -s+ option  is
        disabled.
   
       The match_limit number is a measure of the amount of backtracking  that       The  match_limit number is a measure of the amount of backtracking that
       takes  place,  and  checking it out can be instructive. For most simple       takes place, and checking it out can be instructive.  For  most  simple
       matches, the number is quite small, but for patterns  with  very  large       matches,  the  number  is quite small, but for patterns with very large
       numbers  of  matching  possibilities,  it can become large very quickly       numbers of matching possibilities, it can  become  large  very  quickly
       with increasing length of  subject  string.  The  match_limit_recursion       with  increasing  length  of  subject string. The match_limit_recursion
       number  is  a  measure  of how much stack (or, if PCRE is compiled with       number is a measure of how much stack (or, if  PCRE  is  compiled  with
       NO_RECURSE, how much heap) memory  is  needed  to  complete  the  match       NO_RECURSE,  how  much  heap)  memory  is  needed to complete the match
        attempt.         attempt.
   
       When  \O  is  used, the value specified may be higher or lower than the       When \O is used, the value specified may be higher or  lower  than  the
        size set by the -O command line option (or defaulted to 45); \O applies         size set by the -O command line option (or defaulted to 45); \O applies
       only to the call of pcre[16]_exec() for the line in which it appears.       only to the call  of  pcre[16|32]_exec()  for  the  line  in  which  it
        appears.
   
        If  the /P modifier was present on the pattern, causing the POSIX wrap-         If  the /P modifier was present on the pattern, causing the POSIX wrap-
        per API to be used, the only option-setting  sequences  that  have  any         per API to be used, the only option-setting  sequences  that  have  any
Line 555  DATA LINES Line 757  DATA LINES
 THE ALTERNATIVE MATCHING FUNCTION  THE ALTERNATIVE MATCHING FUNCTION
   
        By  default,  pcretest  uses  the  standard  PCRE  matching   function,         By  default,  pcretest  uses  the  standard  PCRE  matching   function,
       pcre[16]_exec() to match each data line. PCRE also supports an alterna-       pcre[16|32]_exec()  to  match  each  data  line.  PCRE also supports an
       tive matching function, pcre[16]_dfa_test(), which operates in  a  dif-       alternative matching function, pcre[16|32]_dfa_test(),  which  operates
       ferent  way, and has some restrictions. The differences between the two       in  a different way, and has some restrictions. The differences between
       functions are described in the pcrematching documentation.       the two functions are described in the pcrematching documentation.
   
        If a data line contains the \D escape sequence, or if the command  line         If a data line contains the \D escape sequence, or if the command  line
        contains  the  -dfa  option, the alternative matching function is used.         contains  the  -dfa  option, the alternative matching function is used.
Line 570  THE ALTERNATIVE MATCHING FUNCTION Line 772  THE ALTERNATIVE MATCHING FUNCTION
 DEFAULT OUTPUT FROM PCRETEST  DEFAULT OUTPUT FROM PCRETEST
   
        This section describes the output when the  normal  matching  function,         This section describes the output when the  normal  matching  function,
       pcre[16]_exec(), is being used.       pcre[16|32]_exec(), is being used.
   
        When a match succeeds, pcretest outputs the list of captured substrings         When a match succeeds, pcretest outputs the list of captured substrings
       that pcre[16]_exec() returns, starting with number  0  for  the  string       that pcre[16|32]_exec() returns, starting with number 0 for the  string
        that  matched  the whole pattern. Otherwise, it outputs "No match" when         that  matched  the whole pattern. Otherwise, it outputs "No match" when
        the return is PCRE_ERROR_NOMATCH, and "Partial match:" followed by  the         the return is PCRE_ERROR_NOMATCH, and "Partial match:" followed by  the
       partially    matching    substring    when    pcre[16]_exec()   returns       partially    matching   substring   when   pcre[16|32]_exec()   returns
        PCRE_ERROR_PARTIAL. (Note that this is the entire  substring  that  was         PCRE_ERROR_PARTIAL. (Note that this is the entire  substring  that  was
        inspected  during  the  partial match; it may include characters before         inspected  during  the  partial match; it may include characters before
        the actual match start if a lookbehind assertion, \K,  \b,  or  \B  was         the actual match start if a lookbehind assertion, \K,  \b,  or  \B  was
Line 598  DEFAULT OUTPUT FROM PCRETEST Line 800  DEFAULT OUTPUT FROM PCRETEST
          No match           No match
   
        Unset capturing substrings that are not followed by one that is set are         Unset capturing substrings that are not followed by one that is set are
       not  returned by pcre[16]_exec(), and are not shown by pcretest. In the       not  returned  by pcre[16|32]_exec(), and are not shown by pcretest. In
       following example, there are two capturing  substrings,  but  when  the       the following example, there are two capturing substrings, but when the
        first  data  line is matched, the second, unset substring is not shown.         first  data  line is matched, the second, unset substring is not shown.
        An "internal" unset substring is shown as "<unset>", as for the  second         An "internal" unset substring is shown as "<unset>", as for the  second
        data line.         data line.
Line 660  DEFAULT OUTPUT FROM PCRETEST Line 862  DEFAULT OUTPUT FROM PCRETEST
   
 OUTPUT FROM THE ALTERNATIVE MATCHING FUNCTION  OUTPUT FROM THE ALTERNATIVE MATCHING FUNCTION
   
       When  the  alternative  matching function, pcre[16]_dfa_exec(), is used       When the alternative matching function, pcre[16|32]_dfa_exec(), is used
        (by means of the \D escape sequence or the -dfa command  line  option),         (by means of the \D escape sequence or the -dfa command  line  option),
        the  output  consists  of  a  list of all the matches that start at the         the  output  consists  of  a  list of all the matches that start at the
        first point in the subject where there is at least one match. For exam-         first point in the subject where there is at least one match. For exam-
Line 813  SAVING AND RELOADING COMPILED PATTERNS Line 1015  SAVING AND RELOADING COMPILED PATTERNS
        writing the file, pcretest expects to read a new pattern.         writing the file, pcretest expects to read a new pattern.
   
        A  saved  pattern  can  be reloaded into pcretest by specifying < and a         A  saved  pattern  can  be reloaded into pcretest by specifying < and a
       file name instead of a pattern. The name of the file must not contain a       file name instead of a pattern. There must be no space  between  <  and
       < character, as otherwise pcretest will interpret the line as a pattern       the  file  name,  which  must  not  contain a < character, as otherwise
       delimited by < characters.  For example:       pcretest will interpret the line as a pattern delimited  by  <  charac-
        ters. For example:
   
           re> </some/file            re> </some/file
          Compiled pattern loaded from /some/file           Compiled pattern loaded from /some/file
          No study data           No study data
   
       If the pattern was previously studied with the  JIT  optimization,  the       If  the  pattern  was previously studied with the JIT optimization, the
       JIT  information cannot be saved and restored, and so is lost. When the       JIT information cannot be saved and restored, and so is lost. When  the
       pattern has been loaded, pcretest proceeds to read data  lines  in  the       pattern  has  been  loaded, pcretest proceeds to read data lines in the
        usual way.         usual way.
   
       You  can copy a file written by pcretest to a different host and reload       You can copy a file written by pcretest to a different host and  reload
       it there, even if the new host has opposite endianness to  the  one  on       it  there,  even  if the new host has opposite endianness to the one on
       which  the pattern was compiled. For example, you can compile on an i86       which the pattern was compiled. For example, you can compile on an  i86
       machine and run on a SPARC machine. When a pattern  is  reloaded  on  a       machine  and  run  on  a SPARC machine. When a pattern is reloaded on a
        host with different endianness, the confirmation message is changed to:         host with different endianness, the confirmation message is changed to:
   
          Compiled pattern (byte-inverted) loaded from /some/file           Compiled pattern (byte-inverted) loaded from /some/file
   
        The test suite contains some saved pre-compiled patterns with different         The test suite contains some saved pre-compiled patterns with different
       endianness. These are reloaded using "<!" instead  of  just  "<".  This       endianness.  These  are  reloaded  using "<!" instead of just "<". This
        suppresses the "(byte-inverted)" text so that the output is the same on         suppresses the "(byte-inverted)" text so that the output is the same on
       all hosts. It also forces debugging output once the  pattern  has  been       all  hosts.  It  also forces debugging output once        all  hosts.  It  also forces debugging output once the pattern has been
        reloaded.         reloaded.
   
       File  names  for  saving and reloading can be absolute or relative, but       File names for saving and reloading can be absolute  or  relative,  but
       note that the shell facility of expanding a file name that starts  with       note  that the shell facility of expanding a file name that starts with
        a tilde (~) is not available.         a tilde (~) is not available.
   
       The  ability to save and reload files in pcretest is intended for test-       The ability to save and reload files in pcretest is intended for  test-
       ing and experimentation. It is not intended for production use  because       ing  and experimentation. It is not intended for production use because
       only  a  single pattern can be written to a file. Furthermore, there is       only a single pattern can be written to a file. Furthermore,  there  is
       no facility for supplying  custom  character  tables  for  use  with  a       no  facility  for  supplying  custom  character  tables  for use with a
       reloaded  pattern.  If  the  original  pattern was compiled with custom       reloaded pattern. If the original  pattern  was  compiled  with  custom
       tables, an attempt to match a subject string using a  reloaded  pattern       tables,  an  attempt to match a subject string using a reloaded pattern
       is  likely to cause pcretest to crash.  Finally, if you attempt to load       is likely to cause pcretest to crash.  Finally, if you attempt to  load
        a file that is not in the correct format, the result is undefined.         a file that is not in the correct format, the result is undefined.
   
   
 SEE ALSO  SEE ALSO
   
       pcre(3)pcre16(3),  pcreapi(3),  pcrecallout(3),  pcrejit,  pcrematch-       pcre(3),  pcre16(3),  pcre32(3),  pcreapi(3),  pcrecallout(3)pcrejit,
       ing(3), pcrepartial(d), pcrepattern(3), pcreprecompile(3).       pcrematching(3), pcrepartial(d), pcrepattern(3), pcreprecompile(3).
   
   
 AUTHOR  AUTHOR
Line 869  AUTHOR Line 1072  AUTHOR
   
 REVISION  REVISION
   
       Last updated: 14 January 2012       Last updated: 12 November 2013
       Copyright (c) 1997-2012 University of Cambridge.       Copyright (c) 1997-2013 University of Cambridge.

Removed from v.1.1.1.2  
changed lines
  Added in v.1.1.1.5


FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>