/[pcre]/code/trunk/README
ViewVC logotype

Diff of /code/trunk/README

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1251 by ph10, Wed Feb 20 17:42:03 2013 UTC revision 1404 by ph10, Tue Nov 19 15:36:57 2013 UTC
# Line 9  from: Line 9  from:
9    ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/pcre-xxx.zip    ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/pcre-xxx.zip
10    
11  There is a mailing list for discussion about the development of PCRE at  There is a mailing list for discussion about the development of PCRE at
12    pcre-dev@exim.org. You can access the archives and subscribe or manage your
13    subscription here:
14    
15    pcre-dev@exim.org     https://lists.exim.org/mailman/listinfo/pcre-dev
16    
17  Please read the NEWS file if you are upgrading from a previous release.  Please read the NEWS file if you are upgrading from a previous release.
18  The contents of this README file are:  The contents of this README file are:
# Line 25  The contents of this README file are: Line 27  The contents of this README file are:
27    Shared libraries    Shared libraries
28    Cross-compiling using autotools    Cross-compiling using autotools
29    Using HP's ANSI C++ compiler (aCC)    Using HP's ANSI C++ compiler (aCC)
30      Compiling in Tru64 using native compilers
31      Using Sun's compilers for Solaris
32    Using PCRE from MySQL    Using PCRE from MySQL
33    Making new tarballs    Making new tarballs
34    Testing PCRE    Testing PCRE
# Line 35  The contents of this README file are: Line 39  The contents of this README file are:
39  The PCRE APIs  The PCRE APIs
40  -------------  -------------
41    
42  PCRE is written in C, and it has its own API. There are three sets of functions,  PCRE is written in C, and it has its own API. There are three sets of
43  one for the 8-bit library, which processes strings of bytes, one for the  functions, one for the 8-bit library, which processes strings of bytes, one for
44  16-bit library, which processes strings of 16-bit values, and one for the 32-bit  the 16-bit library, which processes strings of 16-bit values, and one for the
45  library, which processes strings of 32-bit values. The distribution also  32-bit library, which processes strings of 32-bit values. The distribution also
46  includes a set of C++ wrapper functions (see the pcrecpp man page for details),  includes a set of C++ wrapper functions (see the pcrecpp man page for details),
47  courtesy of Google Inc., which can be used to call the 8-bit PCRE library from  courtesy of Google Inc., which can be used to call the 8-bit PCRE library from
48  C++.  C++.
# Line 110  contributions provided support for compi Line 114  contributions provided support for compi
114  Windows (I myself do not use Windows). Nowadays there is more Windows support  Windows (I myself do not use Windows). Nowadays there is more Windows support
115  in the standard distribution, so these contibutions have been archived.  in the standard distribution, so these contibutions have been archived.
116    
117    A PCRE user maintains downloadable Windows binaries of the pcregrep and
118    pcretest programs here:
119    
120      http://www.rexegg.com/pcregrep-pcretest.html
121    
122    
123  Building PCRE on non-Unix-like systems  Building PCRE on non-Unix-like systems
124  --------------------------------------  --------------------------------------
# Line 260  library. They are also documented in the Line 269  library. They are also documented in the
269    
270    on the "configure" command.    on the "configure" command.
271    
272  . PCRE has a counter that can be set to limit the amount of resources it uses.  . PCRE has a counter that limits the depth of nesting of parentheses in a
273    If the limit is exceeded during a match, the match fails. The default is ten    pattern. This limits the amount of system stack that a pattern uses when it
274    million. You can change the default by setting, for example,    is compiled. The default is 250, but you can change it by setting, for
275      example,
276    
277      --with-parens-nest-limit=500
278    
279    . PCRE has a counter that can be set to limit the amount of resources it uses
280      when matching a pattern. If the limit is exceeded during a match, the match
281      fails. The default is ten million. You can change the default by setting, for
282      example,
283    
284    --with-match-limit=500000    --with-match-limit=500000
285    
# Line 342  library. They are also documented in the Line 359  library. They are also documented in the
359    report is generated by running "make coverage". If ccache is installed on    report is generated by running "make coverage". If ccache is installed on
360    your system, it must be disabled when building PCRE for coverage reporting.    your system, it must be disabled when building PCRE for coverage reporting.
361    You can do this by setting the environment variable CCACHE_DISABLE=1 before    You can do this by setting the environment variable CCACHE_DISABLE=1 before
362    running "make" to build PCRE.    running "make" to build PCRE. There is more information about coverage
363      reporting in the "pcrebuild" documentation.
364    
365  . The pcregrep program currently supports only 8-bit data files, and so  . The pcregrep program currently supports only 8-bit data files, and so
366    requires the 8-bit PCRE library. It is possible to compile pcregrep to use    requires the 8-bit PCRE library. It is possible to compile pcregrep to use
# Line 575  running the "configure" script: Line 593  running the "configure" script:
593    CXXLDFLAGS="-lstd_v2 -lCsup_v2"    CXXLDFLAGS="-lstd_v2 -lCsup_v2"
594    
595    
596    Compiling in Tru64 using native compilers
597    -----------------------------------------
598    
599    The following error may occur when compiling with native compilers in the Tru64
600    operating system:
601    
602      CXX    libpcrecpp_la-pcrecpp.lo
603    cxx: Error: /usr/lib/cmplrs/cxx/V7.1-006/include/cxx/iosfwd, line 58: #error
604              directive: "cannot include iosfwd -- define __USE_STD_IOSTREAM to
605              override default - see section 7.1.2 of the C++ Using Guide"
606    #error "cannot include iosfwd -- define __USE_STD_IOSTREAM to override default
607    - see section 7.1.2 of the C++ Using Guide"
608    
609    This may be followed by other errors, complaining that 'namespace "std" has no
610    member'. The solution to this is to add the line
611    
612    #define __USE_STD_IOSTREAM 1
613    
614    to the config.h file.
615    
616    
617  Using Sun's compilers for Solaris  Using Sun's compilers for Solaris
618  ---------------------------------  ---------------------------------
619    
# Line 624  NON-AUTOTOOLS-BUILD. Line 663  NON-AUTOTOOLS-BUILD.
663  The RunTest script runs the pcretest test program (which is documented in its  The RunTest script runs the pcretest test program (which is documented in its
664  own man page) on each of the relevant testinput files in the testdata  own man page) on each of the relevant testinput files in the testdata
665  directory, and compares the output with the contents of the corresponding  directory, and compares the output with the contents of the corresponding
666  testoutput files. Some tests are relevant only when certain build-time options  testoutput files. RunTest uses a file called testtry to hold the main output
667  were selected. For example, the tests for UTF-8/16/32 support are run only if  from pcretest. Other files whose names begin with "test" are used as working
668  --enable-utf was used. RunTest outputs a comment when it skips a test.  files in some tests.
669    
670    Some tests are relevant only when certain build-time options were selected. For
671    example, the tests for UTF-8/16/32 support are run only if --enable-utf was
672    used. RunTest outputs a comment when it skips a test.
673    
674  Many of the tests that are not skipped are run up to three times. The second  Many of the tests that are not skipped are run up to three times. The second
675  run forces pcre_study() to be called for all patterns except for a few in some  run forces pcre_study() to be called for all patterns except for a few in some
# Line 639  The entire set of tests is run once for Line 682  The entire set of tests is run once for
682  libraries that are enabled. If you want to run just one set of tests, call  libraries that are enabled. If you want to run just one set of tests, call
683  RunTest with either the -8, -16 or -32 option.  RunTest with either the -8, -16 or -32 option.
684    
685  If valgrind is installed, you can run the tests under it by putting "valgrind"  If valgrind is installed, you can run the tests under it by putting "valgrind"
686  on the RunTest command line.  on the RunTest command line. To run pcretest on just one or more specific test
687    files, give their numbers as arguments to RunTest, for example:
 RunTest uses a file called testtry to hold the main output from pcretest.  
 Other files whose names begin with "test" are used as working files in some  
 tests. To run pcretest on just one or more specific test files, give their  
 numbers as arguments to RunTest, for example:  
688    
689    RunTest 2 7 11    RunTest 2 7 11
690    
691    You can also specify ranges of tests such as 3-6 or 3- (meaning 3 to the
692    end), or a number preceded by ~ to exclude a test. For example:
693    
694      Runtest 3-15 ~10
695    
696    This runs tests 3 to 15, excluding test 10, and just ~13 runs all the tests
697    except test 13. Whatever order the arguments are in, the tests are always run
698    in numerical order.
699    
700  You can also call RunTest with the single argument "list" to cause it to output  You can also call RunTest with the single argument "list" to cause it to output
701  a list of tests.  a list of tests.
702    
# Line 708  test is run only when JIT support is not Line 756  test is run only when JIT support is not
756  features such as information output from pcretest about JIT compilation.  features such as information output from pcretest about JIT compilation.
757    
758  The fourteenth, fifteenth, and sixteenth tests are run only in 8-bit mode, and  The fourteenth, fifteenth, and sixteenth tests are run only in 8-bit mode, and
759  the seventeenth, eighteenth, and nineteenth tests are run only in 16/32-bit mode.  the seventeenth, eighteenth, and nineteenth tests are run only in 16/32-bit
760  These are tests that generate different output in the two modes. They are for  mode. These are tests that generate different output in the two modes. They are
761  general cases, UTF-8/16/32 support, and Unicode property support, respectively.  for general cases, UTF-8/16/32 support, and Unicode property support,
762    respectively.
763    
764  The twentieth test is run only in 16/32-bit mode. It tests some specific  The twentieth test is run only in 16/32-bit mode. It tests some specific
765  16/32-bit features of the DFA matching engine.  16/32-bit features of the DFA matching engine.
766    
767  The twenty-first and twenty-second tests are run only in 16/32-bit mode, when the  The twenty-first and twenty-second tests are run only in 16/32-bit mode, when
768  link size is set to 2 for the 16-bit library. They test reloading pre-compiled patterns.  the link size is set to 2 for the 16-bit library. They test reloading
769    pre-compiled patterns.
770    
771    The twenty-third and twenty-fourth tests are run only in 16-bit mode. They are
772    for general cases, and UTF-16 support, respectively.
773    
774  The twenty-third and twenty-fourth tests are run only in 16-bit mode. They are for  The twenty-fifth and twenty-sixth tests are run only in 32-bit mode. They are
775  general cases, and UTF-16 support, respectively.  for general cases, and UTF-32 support, respectively.
776    
 The twenty-fifth and twenty-sixth tests are run only in 32-bit mode. They are for  
 general cases, and UTF-32 support, respectively.  
777    
778  Character tables  Character tables
779  ----------------  ----------------
# Line 788  pcre_xxx, one with the name pcre16_xx, a Line 839  pcre_xxx, one with the name pcre16_xx, a
839  (A) Source files of the PCRE library functions and their headers:  (A) Source files of the PCRE library functions and their headers:
840    
841    dftables.c              auxiliary program for building pcre_chartables.c    dftables.c              auxiliary program for building pcre_chartables.c
842                              when --enable-rebuild-chartables is specified                            when --enable-rebuild-chartables is specified
843    
844    pcre_chartables.c.dist  a default set of character tables that assume ASCII    pcre_chartables.c.dist  a default set of character tables that assume ASCII
845                              coding; used, unless --enable-rebuild-chartables is                            coding; used, unless --enable-rebuild-chartables is
846                              specified, by copying to pcre[16]_chartables.c                            specified, by copying to pcre[16]_chartables.c
847    
848    pcreposix.c                )    pcreposix.c                )
849    pcre[16|32]_byte_order.c   )    pcre[16|32]_byte_order.c   )
# Line 936  pcre_xxx, one with the name pcre16_xx, a Line 987  pcre_xxx, one with the name pcre16_xx, a
987  Philip Hazel  Philip Hazel
988  Email local part: ph10  Email local part: ph10
989  Email domain: cam.ac.uk  Email domain: cam.ac.uk
990  Last updated: 20 February 2013  Last updated: 05 November 2013

Legend:
Removed from v.1251  
changed lines
  Added in v.1404

  ViewVC Help
Powered by ViewVC 1.1.5