embedaddon/pcre/README - diff

Return to README CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / pcre

Diff for /embedaddon/pcre/README between versions 1.1.1.3 and 1.1.1.5

version 1.1.1.3, 2012/10/09 09:19:17	version 1.1.1.5, 2014/06/15 19:46:03
Line 9 from:	Line 9 from:
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

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
	pcre-dev@exim.org. You can access the archives and subscribe or manage your
	subscription here:

pcre-dev@exim.org	https://lists.exim.org/mailman/listinfo/pcre-dev

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.
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:
Shared libraries	Shared libraries
Cross-compiling using autotools	Cross-compiling using autotools
Using HP's ANSI C++ compiler (aCC)	Using HP's ANSI C++ compiler (aCC)
	Compiling in Tru64 using native compilers
	Using Sun's compilers for Solaris
Using PCRE from MySQL	Using PCRE from MySQL
Making new tarballs	Making new tarballs
Testing PCRE	Testing PCRE
Line 35 The contents of this README file are:	Line 39 The contents of this README file are:
The PCRE APIs	The PCRE APIs
-------------	-------------

PCRE is written in C, and it has its own API. There are two sets of functions,	PCRE is written in C, and it has its own API. There are three sets of
one for the 8-bit library, which processes strings of bytes, and one for the	functions, one for the 8-bit library, which processes strings of bytes, one for
16-bit library, which processes strings of 16-bit values. The distribution also	the 16-bit library, which processes strings of 16-bit values, and one for the
	32-bit library, which processes strings of 32-bit values. The distribution also
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),
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
C++.	C++.
Line 109 contributions provided support for compiling PCRE on v	Line 114 contributions provided support for compiling PCRE on v
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
in the standard distribution, so these contibutions have been archived.	in the standard distribution, so these contibutions have been archived.

	A PCRE user maintains downloadable Windows binaries of the pcregrep and
	pcretest programs here:

	http://www.rexegg.com/pcregrep-pcretest.html


Building PCRE on non-Unix-like systems	Building PCRE on non-Unix-like systems
--------------------------------------	--------------------------------------

Line 183 library. They are also documented in the pcrebuild man	Line 193 library. They are also documented in the pcrebuild man
(See also "Shared libraries on Unix-like systems" below.)	(See also "Shared libraries on Unix-like systems" below.)

. By default, only the 8-bit library is built. If you add --enable-pcre16 to	. By default, only the 8-bit library is built. If you add --enable-pcre16 to
the "configure" command, the 16-bit library is also built. If you want only	the "configure" command, the 16-bit library is also built. If you add
the 16-bit library, use "./configure --enable-pcre16 --disable-pcre8".	--enable-pcre32 to the "configure" command, the 32-bit library is also built.
	If you want only the 16-bit or 32-bit library, use --disable-pcre8 to disable
	building the 8-bit library.

. If you are building the 8-bit library and want to suppress the building of	. If you are building the 8-bit library and want to suppress the building of
the C++ wrapper library, you can add --disable-cpp to the "configure"	the C++ wrapper library, you can add --disable-cpp to the "configure"
Line 203 library. They are also documented in the pcrebuild man	Line 215 library. They are also documented in the pcrebuild man

. If you want to make use of the support for UTF-8 Unicode character strings in	. If you want to make use of the support for UTF-8 Unicode character strings in
the 8-bit library, or UTF-16 Unicode character strings in the 16-bit library,	the 8-bit library, or UTF-16 Unicode character strings in the 16-bit library,
you must add --enable-utf to the "configure" command. Without it, the code	or UTF-32 Unicode character strings in the 32-bit library, you must add
for handling UTF-8 and UTF-16 is not included in the relevant library. Even	--enable-utf to the "configure" command. Without it, the code for handling
	UTF-8, UTF-16 and UTF-8 is not included in the relevant library. Even
when --enable-utf is included, the use of a UTF encoding still has to be	when --enable-utf is included, the use of a UTF encoding still has to be
enabled by an option at run time. When PCRE is compiled with this option, its	enabled by an option at run time. When PCRE is compiled with this option, its
input can only either be ASCII or UTF-8/16, even when running on EBCDIC	input can only either be ASCII or UTF-8/16/32, even when running on EBCDIC
platforms. It is not possible to use both --enable-utf and --enable-ebcdic at	platforms. It is not possible to use both --enable-utf and --enable-ebcdic at
the same time.	the same time.

. There are no separate options for enabling UTF-8 and UTF-16 independently	. There are no separate options for enabling UTF-8, UTF-16 and UTF-32
because that would allow ridiculous settings such as requesting UTF-16	independently because that would allow ridiculous settings such as requesting
support while building only the 8-bit library. However, the option	UTF-16 support while building only the 8-bit library. However, the option
--enable-utf8 is retained for backwards compatibility with earlier releases	--enable-utf8 is retained for backwards compatibility with earlier releases
that did not support 16-bit character strings. It is synonymous with	that did not support 16-bit or 32-bit character strings. It is synonymous with
--enable-utf. It is not possible to configure one library with UTF support	--enable-utf. It is not possible to configure one library with UTF support
and the other without in the same configuration.	and the other without in the same configuration.

. If, in addition to support for UTF-8/16 character strings, you want to	. If, in addition to support for UTF-8/16/32 character strings, you want to
include support for the \P, \p, and \X sequences that recognize Unicode	include support for the \P, \p, and \X sequences that recognize Unicode
character properties, you must add --enable-unicode-properties to the	character properties, you must add --enable-unicode-properties to the
"configure" command. This adds about 30K to the size of the library (in the	"configure" command. This adds about 30K to the size of the library (in the
Line 256 library. They are also documented in the pcrebuild man	Line 269 library. They are also documented in the pcrebuild man

on the "configure" command.	on the "configure" command.

. 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
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
million. You can change the default by setting, for example,	is compiled. The default is 250, but you can change it by setting, for
	example,

	--with-parens-nest-limit=500

	. PCRE has a counter that can be set to limit the amount of resources it uses
	when matching a pattern. If the limit is exceeded during a match, the match
	fails. The default is ten million. You can change the default by setting, for
	example,

--with-match-limit=500000	--with-match-limit=500000

on the "configure" command. This is just the default; individual calls to	on the "configure" command. This is just the default; individual calls to
Line 281 library. They are also documented in the pcrebuild man	Line 302 library. They are also documented in the pcrebuild man
library, PCRE then uses three bytes instead of two for offsets to different	library, PCRE then uses three bytes instead of two for offsets to different
parts of the compiled pattern. In the 16-bit library, --with-link-size=3 is	parts of the compiled pattern. In the 16-bit library, --with-link-size=3 is
the same as --with-link-size=4, which (in both libraries) uses four-byte	the same as --with-link-size=4, which (in both libraries) uses four-byte
offsets. Increasing the internal link size reduces performance.	offsets. Increasing the internal link size reduces performance. In the 32-bit
	library, the only supported link size is 4.

. You can build PCRE so that its internal match() function that is called from	. You can build PCRE so that its internal match() function that is called from
pcre_exec() does not call itself recursively. Instead, it uses memory blocks	pcre_exec() does not call itself recursively. Instead, it uses memory blocks
Line 310 library. They are also documented in the pcrebuild man	Line 332 library. They are also documented in the pcrebuild man
pcre_chartables.c.dist. See "Character tables" below for further information.	pcre_chartables.c.dist. See "Character tables" below for further information.

. It is possible to compile PCRE for use on systems that use EBCDIC as their	. It is possible to compile PCRE for use on systems that use EBCDIC as their
character code (as opposed to ASCII) by specifying	character code (as opposed to ASCII/Unicode) by specifying

--enable-ebcdic	--enable-ebcdic

This automatically implies --enable-rebuild-chartables (see above). However,	This automatically implies --enable-rebuild-chartables (see above). However,
when PCRE is built this way, it always operates in EBCDIC. It cannot support	when PCRE is built this way, it always operates in EBCDIC. It cannot support
both EBCDIC and UTF-8/16.	both EBCDIC and UTF-8/16/32. There is a second option, --enable-ebcdic-nl25,
	which specifies that the code value for the EBCDIC NL character is 0x25
	instead of the default 0x15.

	. In environments where valgrind is installed, if you specify

	--enable-valgrind

	PCRE will use valgrind annotations to mark certain memory regions as
	unaddressable. This allows it to detect invalid memory accesses, and is
	mostly useful for debugging PCRE itself.

	. In environments where the gcc compiler is used and lcov version 1.6 or above
	is installed, if you specify

	--enable-coverage

	the build process implements a code coverage report for the test suite. The
	report is generated by running "make coverage". If ccache is installed on
	your system, it must be disabled when building PCRE for coverage reporting.
	You can do this by setting the environment variable CCACHE_DISABLE=1 before
	running "make" to build PCRE. There is more information about coverage
	reporting in the "pcrebuild" documentation.

. The pcregrep program currently supports only 8-bit data files, and so	. The pcregrep program currently supports only 8-bit data files, and so
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
libz and/or libbz2, in order to read .gz and .bz2 files (respectively), by	libz and/or libbz2, in order to read .gz and .bz2 files (respectively), by
Line 366 The "configure" script builds the following files for	Line 410 The "configure" script builds the following files for
that were set for "configure"	that were set for "configure"
. libpcre.pc ) data for the pkg-config command	. libpcre.pc ) data for the pkg-config command
. libpcre16.pc )	. libpcre16.pc )
	. libpcre32.pc )
. libpcreposix.pc )	. libpcreposix.pc )
. libtool script that builds shared and/or static libraries	. libtool script that builds shared and/or static libraries

Line 385 The "configure" script also creates config.status, whi	Line 430 The "configure" script also creates config.status, whi
script that can be run to recreate the configuration, and config.log, which	script that can be run to recreate the configuration, and config.log, which
contains compiler output from tests that "configure" runs.	contains compiler output from tests that "configure" runs.

Once "configure" has run, you can run "make". This builds either or both of the	Once "configure" has run, you can run "make". This builds the the libraries
libraries libpcre and libpcre16, and a test program called pcretest. If you	libpcre, libpcre16 and/or libpcre32, and a test program called pcretest. If you
enabled JIT support with --enable-jit, a test program called pcre_jit_test is	enabled JIT support with --enable-jit, a test program called pcre_jit_test is
built as well.	built as well.

Line 410 system. The following are installed (file names are al	Line 455 system. The following are installed (file names are al

Libraries (lib):	Libraries (lib):
libpcre16 (if 16-bit support is enabled)	libpcre16 (if 16-bit support is enabled)
	libpcre32 (if 32-bit support is enabled)
libpcre (if 8-bit support is enabled)	libpcre (if 8-bit support is enabled)
libpcreposix (if 8-bit support is enabled)	libpcreposix (if 8-bit support is enabled)
libpcrecpp (if 8-bit and C++ support is enabled)	libpcrecpp (if 8-bit and C++ support is enabled)

Configuration information (lib/pkgconfig):	Configuration information (lib/pkgconfig):
libpcre16.pc	libpcre16.pc
	libpcre32.pc
libpcre.pc	libpcre.pc
libpcreposix.pc	libpcreposix.pc
libpcrecpp.pc (if C++ support is enabled)	libpcrecpp.pc (if C++ support is enabled)
Line 546 running the "configure" script:	Line 593 running the "configure" script:
CXXLDFLAGS="-lstd_v2 -lCsup_v2"	CXXLDFLAGS="-lstd_v2 -lCsup_v2"


	Compiling in Tru64 using native compilers
	-----------------------------------------

	The following error may occur when compiling with native compilers in the Tru64
	operating system:

	CXX libpcrecpp_la-pcrecpp.lo
	cxx: Error: /usr/lib/cmplrs/cxx/V7.1-006/include/cxx/iosfwd, line 58: #error
	directive: "cannot include iosfwd -- define __USE_STD_IOSTREAM to
	override default - see section 7.1.2 of the C++ Using Guide"
	#error "cannot include iosfwd -- define __USE_STD_IOSTREAM to override default
	- see section 7.1.2 of the C++ Using Guide"

	This may be followed by other errors, complaining that 'namespace "std" has no
	member'. The solution to this is to add the line

	#define __USE_STD_IOSTREAM 1

	to the config.h file.


Using Sun's compilers for Solaris	Using Sun's compilers for Solaris
---------------------------------	---------------------------------

Line 595 NON-AUTOTOOLS-BUILD.	Line 663 NON-AUTOTOOLS-BUILD.
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
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
directory, and compares the output with the contents of the corresponding	directory, and compares the output with the contents of the corresponding
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
were selected. For example, the tests for UTF-8/16 support are run only if	from pcretest. Other files whose names begin with "test" are used as working
--enable-utf was used. RunTest outputs a comment when it skips a test.	files in some tests.

	Some tests are relevant only when certain build-time options were selected. For
	example, the tests for UTF-8/16/32 support are run only if --enable-utf was
	used. RunTest outputs a comment when it skips a test.

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
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
tests that are marked "never study" (see the pcretest program for how this is	tests that are marked "never study" (see the pcretest program for how this is
done). If JIT support is available, the non-DFA tests are run a third time,	done). If JIT support is available, the non-DFA tests are run a third time,
this time with a forced pcre_study() with the PCRE_STUDY_JIT_COMPILE option.	this time with a forced pcre_study() with the PCRE_STUDY_JIT_COMPILE option.
	This testing can be suppressed by putting "nojit" on the RunTest command line.

When both 8-bit and 16-bit support is enabled, the entire set of tests is run	The entire set of tests is run once for each of the 8-bit, 16-bit and 32-bit
twice, once for each library. 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
RunTest with either the -8 or -16 option.	RunTest with either the -8, -16 or -32 option.

RunTest uses a file called testtry to hold the main output from pcretest.	If valgrind is installed, you can run the tests under it by putting "valgrind"
Other files whose names begin with "test" are used as working files in some	on the RunTest command line. To run pcretest on just one or more specific test
tests. To run pcretest on just one or more specific test files, give their	files, give their numbers as arguments to RunTest, for example:
numbers as arguments to RunTest, for example:

RunTest 2 7 11	RunTest 2 7 11

	You can also specify ranges of tests such as 3-6 or 3- (meaning 3 to the
	end), or a number preceded by ~ to exclude a test. For example:

	Runtest 3-15 ~10

	This runs tests 3 to 15, excluding test 10, and just ~13 runs all the tests
	except test 13. Whatever order the arguments are in, the tests are always run
	in numerical order.

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
a list of tests.	a list of tests.

Line 658 RunTest.bat. The version of RunTest.bat included with	Line 739 RunTest.bat. The version of RunTest.bat included with
Windows versions of test 2. More info on using RunTest.bat is included in the	Windows versions of test 2. More info on using RunTest.bat is included in the
document entitled NON-UNIX-USE.]	document entitled NON-UNIX-USE.]

The fourth and fifth tests check the UTF-8/16 support and error handling and	The fourth and fifth tests check the UTF-8/16/32 support and error handling and
internal UTF features of PCRE that are not relevant to Perl, respectively. The	internal UTF features of PCRE that are not relevant to Perl, respectively. The
sixth and seventh tests do the same for Unicode character properties support.	sixth and seventh tests do the same for Unicode character properties support.

The eighth, ninth, and tenth tests check the pcre_dfa_exec() alternative	The eighth, ninth, and tenth tests check the pcre_dfa_exec() alternative
matching function, in non-UTF-8/16 mode, UTF-8/16 mode, and UTF-8/16 mode with	matching function, in non-UTF-8/16/32 mode, UTF-8/16/32 mode, and UTF-8/16/32
Unicode property support, respectively.	mode with Unicode property support, respectively.

The eleventh test checks some internal offsets and code size features; it is	The eleventh test checks some internal offsets and code size features; it is
run only when the default "link size" of 2 is set (in other cases the sizes	run only when the default "link size" of 2 is set (in other cases the sizes
Line 675 test is run only when JIT support is not available. Th	Line 756 test is run only when JIT support is not available. Th
features such as information output from pcretest about JIT compilation.	features such as information output from pcretest about JIT compilation.

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
the seventeenth, eighteenth, and nineteenth tests are run only in 16-bit mode.	the seventeenth, eighteenth, and nineteenth tests are run only in 16/32-bit
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
general cases, UTF-8/16 support, and Unicode property support, respectively.	for general cases, UTF-8/16/32 support, and Unicode property support,
	respectively.

The twentieth test is run only in 16-bit mode. It tests some specific 16-bit	The twentieth test is run only in 16/32-bit mode. It tests some specific
features of the DFA matching engine.	16/32-bit features of the DFA matching engine.

The twenty-first and twenty-second tests are run only in 16-bit mode, when the	The twenty-first and twenty-second tests are run only in 16/32-bit mode, when
link size is set to 2. They test reloading pre-compiled patterns.	the link size is set to 2 for the 16-bit library. They test reloading
	pre-compiled patterns.

	The twenty-third and twenty-fourth tests are run only in 16-bit mode. They are
	for general cases, and UTF-16 support, respectively.

	The twenty-fifth and twenty-sixth tests are run only in 32-bit mode. They are
	for general cases, and UTF-32 support, respectively.


Character tables	Character tables
----------------	----------------

Line 744 File manifest	Line 833 File manifest
-------------	-------------

The distribution should contain the files listed below. Where a file name is	The distribution should contain the files listed below. Where a file name is
given as pcre[16]_xxx it means that there are two files, one with the name	given as pcre[16\|32]_xxx it means that there are three files, one with the name
pcre_xxx and the other with the name pcre16_xxx.	pcre_xxx, one with the name pcre16_xx, and a third with the name pcre32_xxx.

(A) Source files of the PCRE library functions and their headers:	(A) Source files of the PCRE library functions and their headers:

dftables.c auxiliary program for building pcre_chartables.c	dftables.c auxiliary program for building pcre_chartables.c
when --enable-rebuild-chartables is specified	when --enable-rebuild-chartables is specified

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
coding; used, unless --enable-rebuild-chartables is	coding; used, unless --enable-rebuild-chartables is
specified, by copying to pcre[16]_chartables.c	specified, by copying to pcre[16]_chartables.c

pcreposix.c )	pcreposix.c )
pcre[16]_byte_order.c )	pcre[16\|32]_byte_order.c )
pcre[16]_compile.c )	pcre[16\|32]_compile.c )
pcre[16]_config.c )	pcre[16\|32]_config.c )
pcre[16]_dfa_exec.c )	pcre[16\|32]_dfa_exec.c )
pcre[16]_exec.c )	pcre[16\|32]_exec.c )
pcre[16]_fullinfo.c )	pcre[16\|32]_fullinfo.c )
pcre[16]_get.c ) sources for the functions in the library,	pcre[16\|32]_get.c ) sources for the functions in the library,
pcre[16]_globals.c ) and some internal functions that they use	pcre[16\|32]_globals.c ) and some internal functions that they use
pcre[16]_jit_compile.c )	pcre[16\|32]_jit_compile.c )
pcre[16]_maketables.c )	pcre[16\|32]_maketables.c )
pcre[16]_newline.c )	pcre[16\|32]_newline.c )
pcre[16]_refcount.c )	pcre[16\|32]_refcount.c )
pcre[16]_string_utils.c )	pcre[16\|32]_string_utils.c )
pcre[16]_study.c )	pcre[16\|32]_study.c )
pcre[16]_tables.c )	pcre[16\|32]_tables.c )
pcre[16]_ucd.c )	pcre[16\|32]_ucd.c )
pcre[16]_version.c )	pcre[16\|32]_version.c )
pcre[16]_xclass.c )	pcre[16\|32]_xclass.c )
pcre_ord2utf8.c )	pcre_ord2utf8.c )
pcre_valid_utf8.c )	pcre_valid_utf8.c )
pcre16_ord2utf16.c )	pcre16_ord2utf16.c )
pcre16_utf16_utils.c )	pcre16_utf16_utils.c )
pcre16_valid_utf16.c )	pcre16_valid_utf16.c )
	pcre32_utf32_utils.c )
	pcre32_valid_utf32.c )

pcre[16]_printint.c ) debugging function that is used by pcretest,	pcre[16\|32]_printint.c ) debugging function that is used by pcretest,
) and can also be #included in pcre_compile()	) and can also be #included in pcre_compile()

pcre.h.in template for pcre.h when built by "configure"	pcre.h.in template for pcre.h when built by "configure"
pcreposix.h header for the external POSIX wrapper API	pcreposix.h header for the external POSIX wrapper API
Line 847 pcre_xxx and the other with the name pcre16_xxx.	Line 938 pcre_xxx and the other with the name pcre16_xxx.
doc/perltest.txt plain text documentation of Perl test program	doc/perltest.txt plain text documentation of Perl test program
install-sh a shell script for installing files	install-sh a shell script for installing files
libpcre16.pc.in template for libpcre16.pc for pkg-config	libpcre16.pc.in template for libpcre16.pc for pkg-config
	libpcre32.pc.in template for libpcre32.pc for pkg-config
libpcre.pc.in template for libpcre.pc for pkg-config	libpcre.pc.in template for libpcre.pc for pkg-config
libpcreposix.pc.in template for libpcreposix.pc for pkg-config	libpcreposix.pc.in template for libpcreposix.pc for pkg-config
libpcrecpp.pc.in template for libpcrecpp.pc for pkg-config	libpcrecpp.pc.in template for libpcrecpp.pc for pkg-config
Line 895 pcre_xxx and the other with the name pcre16_xxx.	Line 987 pcre_xxx and the other with the name pcre16_xxx.
Philip Hazel	Philip Hazel
Email local part: ph10	Email local part: ph10
Email domain: cam.ac.uk	Email domain: cam.ac.uk
Last updated: 18 June 2012	Last updated: 05 November 2013

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

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