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

Contents of /code/trunk/README

Parent Directory Parent Directory | Revision Log Revision Log


Revision 939 - (hide annotations) (download)
Sun Feb 26 17:21:43 2012 UTC (2 years, 5 months ago) by ph10
File size: 40825 byte(s)
CMake support for linking pcretest with libedit.

1 nigel 41 README file for PCRE (Perl-compatible regular expression library)
2     -----------------------------------------------------------------
3 nigel 3
4 ph10 374 The latest release of PCRE is always available in three alternative formats
5     from:
6 nigel 43
7     ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/pcre-xxx.tar.gz
8 ph10 374 ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/pcre-xxx.tar.bz2
9     ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/pcre-xxx.zip
10 ph10 123
11 ph10 111 There is a mailing list for discussion about the development of PCRE at
12 nigel 43
13 ph10 123 pcre-dev@exim.org
14    
15 nigel 41 Please read the NEWS file if you are upgrading from a previous release.
16 ph10 109 The contents of this README file are:
17 nigel 23
18 ph10 109 The PCRE APIs
19     Documentation for PCRE
20     Contributions by users of PCRE
21     Building PCRE on non-Unix systems
22 ph10 122 Building PCRE on Unix-like systems
23     Retrieving configuration information on Unix-like systems
24 ph10 109 Shared libraries on Unix-like systems
25 ph10 122 Cross-compiling on Unix-like systems
26 ph10 109 Using HP's ANSI C++ compiler (aCC)
27 ph10 461 Using PCRE from MySQL
28 ph10 111 Making new tarballs
29 ph10 109 Testing PCRE
30     Character tables
31     File manifest
32 nigel 35
33 ph10 109
34 nigel 77 The PCRE APIs
35     -------------
36    
37 ph10 842 PCRE is written in C, and it has its own API. There are two sets of functions,
38 ph10 840 one for the 8-bit library, which processes strings of bytes, and one for the
39     16-bit library, which processes strings of 16-bit values. The distribution also
40     includes a set of C++ wrapper functions (see the pcrecpp man page for details),
41     courtesy of Google Inc., which can be used to call the 8-bit PCRE library from
42     C++.
43 nigel 77
44 ph10 842 In addition, there is a set of C wrapper functions (again, just for the 8-bit
45 ph10 840 library) that are based on the POSIX regular expression API (see the pcreposix
46     man page). These end up in the library called libpcreposix. Note that this just
47     provides a POSIX calling interface to PCRE; the regular expressions themselves
48     still follow Perl syntax and semantics. The POSIX API is restricted, and does
49     not give full access to all of PCRE's facilities.
50 nigel 77
51 ph10 109 The header file for the POSIX-style functions is called pcreposix.h. The
52     official POSIX name is regex.h, but I did not want to risk possible problems
53     with existing files of that name by distributing it that way. To use PCRE with
54     an existing program that uses the POSIX API, pcreposix.h will have to be
55     renamed or pointed at by a link.
56    
57 nigel 73 If you are using the POSIX interface to PCRE and there is already a POSIX regex
58 ph10 109 library installed on your system, as well as worrying about the regex.h header
59     file (as mentioned above), you must also take care when linking programs to
60 nigel 73 ensure that they link with PCRE's libpcreposix library. Otherwise they may pick
61 ph10 109 up the POSIX functions of the same name from the other library.
62 nigel 49
63 ph10 109 One way of avoiding this confusion is to compile PCRE with the addition of
64 ph10 122 -Dregcomp=PCREregcomp (and similarly for the other POSIX functions) to the
65     compiler flags (CFLAGS if you are using "configure" -- see below). This has the
66     effect of renaming the functions so that the names no longer clash. Of course,
67     you have to do the same thing for your applications, or write them using the
68     new names.
69 nigel 73
70 ph10 109
71 nigel 75 Documentation for PCRE
72     ----------------------
73    
74 ph10 122 If you install PCRE in the normal way on a Unix-like system, you will end up
75     with a set of man pages whose names all start with "pcre". The one that is just
76     called "pcre" lists all the others. In addition to these man pages, the PCRE
77     documentation is supplied in two other forms:
78 nigel 75
79 ph10 109 1. There are files called doc/pcre.txt, doc/pcregrep.txt, and
80     doc/pcretest.txt in the source distribution. The first of these is a
81     concatenation of the text forms of all the section 3 man pages except
82     those that summarize individual functions. The other two are the text
83     forms of the section 1 man pages for the pcregrep and pcretest commands.
84     These text forms are provided for ease of scanning with text editors or
85 ph10 123 similar tools. They are installed in <prefix>/share/doc/pcre, where
86 ph10 111 <prefix> is the installation prefix (defaulting to /usr/local).
87 nigel 75
88 ph10 109 2. A set of files containing all the documentation in HTML form, hyperlinked
89 ph10 123 in various ways, and rooted in a file called index.html, is distributed in
90 ph10 122 doc/html and installed in <prefix>/share/doc/pcre/html.
91 ph10 406
92 ph10 401 Users of PCRE have contributed files containing the documentation for various
93     releases in CHM format. These can be found in the Contrib directory of the FTP
94     site (see next section).
95 nigel 75
96    
97 nigel 53 Contributions by users of PCRE
98     ------------------------------
99    
100     You can find contributions from PCRE users in the directory
101    
102     ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/Contrib
103    
104 ph10 122 There is a README file giving brief descriptions of what they are. Some are
105     complete in themselves; others are pointers to URLs containing relevant files.
106 ph10 128 Some of this material is likely to be well out-of-date. Several of the earlier
107     contributions provided support for compiling PCRE on various flavours of
108     Windows (I myself do not use Windows). Nowadays there is more Windows support
109     in the standard distribution, so these contibutions have been archived.
110 nigel 53
111    
112 ph10 109 Building PCRE on non-Unix systems
113     ---------------------------------
114 ph10 101
115 ph10 122 For a non-Unix system, please read the comments in the file NON-UNIX-USE,
116     though if your system supports the use of "configure" and "make" you may be
117 ph10 260 able to build PCRE in the same way as for Unix-like systems. PCRE can also be
118 ph10 436 configured in many platform environments using the GUI facility provided by
119     CMake's cmake-gui command. This creates Makefiles, solution files, etc.
120 ph10 101
121 ph10 109 PCRE has been compiled on many different operating systems. It should be
122     straightforward to build PCRE on any system that has a Standard C compiler and
123     library, because it uses only Standard C functions.
124 ph10 101
125    
126 ph10 122 Building PCRE on Unix-like systems
127     ----------------------------------
128 nigel 3
129 nigel 87 If you are using HP's ANSI C++ compiler (aCC), please see the special note
130     in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.
131    
132 ph10 145 The following instructions assume the use of the widely used "configure, make,
133 ph10 317 make install" process. There is also support for CMake in the PCRE
134     distribution; there are some comments about using CMake in the NON-UNIX-USE
135     file, though it can also be used in Unix-like systems.
136 ph10 144
137 nigel 63 To build PCRE on a Unix-like system, first run the "configure" command from the
138     PCRE distribution directory, with your current directory set to the directory
139     where you want the files to be created. This command is a standard GNU
140     "autoconf" configuration script, for which generic instructions are supplied in
141 ph10 122 the file INSTALL.
142 nigel 3
143 nigel 53 Most commonly, people build PCRE within its own distribution directory, and in
144 ph10 109 this case, on many systems, just running "./configure" is sufficient. However,
145     the usual methods of changing standard defaults are available. For example:
146 nigel 53
147 nigel 41 CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local
148    
149 ph10 840 This command specifies that the C compiler should be run with the flags '-O2
150     -Wall' instead of the default, and that "make install" should install PCRE
151     under /opt/local instead of the default /usr/local.
152 nigel 41
153 nigel 53 If you want to build in a different directory, just run "configure" with that
154     directory as current. For example, suppose you have unpacked the PCRE source
155     into /source/pcre/pcre-xxx, but you want to build it in /build/pcre/pcre-xxx:
156    
157     cd /build/pcre/pcre-xxx
158     /source/pcre/pcre-xxx/configure
159    
160 nigel 87 PCRE is written in C and is normally compiled as a C library. However, it is
161     possible to build it as a C++ library, though the provided building apparatus
162     does not have any features to support this.
163    
164 nigel 63 There are some optional features that can be included or omitted from the PCRE
165 ph10 654 library. They are also documented in the pcrebuild man page.
166 nigel 49
167 ph10 654 . By default, both shared and static libraries are built. You can change this
168     by adding one of these options to the "configure" command:
169    
170     --disable-shared
171     --disable-static
172    
173     (See also "Shared libraries on Unix-like systems" below.)
174 ph10 842
175     . By default, only the 8-bit library is built. If you add --enable-pcre16 to
176     the "configure" command, the 16-bit library is also built. If you want only
177 ph10 840 the 16-bit library, use "./configure --enable-pcre16 --disable-pcre8".
178 ph10 654
179 ph10 842 . If you are building the 8-bit library and want to suppress the building of
180 ph10 840 the C++ wrapper library, you can add --disable-cpp to the "configure"
181     command. Otherwise, when "configure" is run without --disable-pcre8, it will
182     try to find a C++ compiler and C++ header files, and if it succeeds, it will
183     try to build the C++ wrapper.
184 ph10 691
185     . If you want to include support for just-in-time compiling, which can give
186     large performance improvements on certain platforms, add --enable-jit to the
187     "configure" command. This support is available only for certain hardware
188     architectures. If you try to enable it on an unsupported architecture, there
189 ph10 678 will be a compile time error.
190 ph10 691
191 ph10 685 . When JIT support is enabled, pcregrep automatically makes use of it, unless
192 ph10 691 you add --disable-pcregrep-jit to the "configure" command.
193 nigel 83
194 ph10 391 . If you want to make use of the support for UTF-8 Unicode character strings in
195 ph10 840 the 8-bit library, or UTF-16 Unicode character strings in the 16-bit library,
196     you must add --enable-utf to the "configure" command. Without it, the code
197     for handling UTF-8 and UTF-16 is not included in the relevant library. Even
198 ph10 873 when --enable-utf is included, the use of a UTF encoding still has to be
199     enabled by an option at run time. When PCRE is compiled with this option, its
200     input can only either be ASCII or UTF-8/16, even when running on EBCDIC
201     platforms. It is not possible to use both --enable-utf and --enable-ebcdic at
202     the same time.
203 nigel 63
204 ph10 903 . There are no separate options for enabling UTF-8 and UTF-16 independently
205 ph10 873 because that would allow ridiculous settings such as requesting UTF-16
206     support while building only the 8-bit library. However, the option
207     --enable-utf8 is retained for backwards compatibility with earlier releases
208     that did not support 16-bit character strings. It is synonymous with
209 ph10 842 --enable-utf. It is not possible to configure one library with UTF support
210     and the other without in the same configuration.
211    
212     . If, in addition to support for UTF-8/16 character strings, you want to
213 ph10 840 include support for the \P, \p, and \X sequences that recognize Unicode
214     character properties, you must add --enable-unicode-properties to the
215     "configure" command. This adds about 30K to the size of the library (in the
216     form of a property table); only the basic two-letter properties such as Lu
217     are supported.
218 nigel 75
219 nigel 93 . You can build PCRE to recognize either CR or LF or the sequence CRLF or any
220 ph10 149 of the preceding, or any of the Unicode newline sequences as indicating the
221     end of a line. Whatever you specify at build time is the default; the caller
222     of PCRE can change the selection at run time. The default newline indicator
223     is a single LF character (the Unix standard). You can specify the default
224     newline indicator by adding --enable-newline-is-cr or --enable-newline-is-lf
225     or --enable-newline-is-crlf or --enable-newline-is-anycrlf or
226     --enable-newline-is-any to the "configure" command, respectively.
227 ph10 109
228 ph10 149 If you specify --enable-newline-is-cr or --enable-newline-is-crlf, some of
229     the standard tests will fail, because the lines in the test files end with
230     LF. Even if the files are edited to change the line endings, there are likely
231     to be some failures. With --enable-newline-is-anycrlf or
232     --enable-newline-is-any, many tests should succeed, but there may be some
233     failures.
234 ph10 254
235     . By default, the sequence \R in a pattern matches any Unicode line ending
236     sequence. This is independent of the option specifying what PCRE considers to
237 ph10 251 be the end of a line (see above). However, the caller of PCRE can restrict \R
238     to match only CR, LF, or CRLF. You can make this the default by adding
239     --enable-bsr-anycrlf to the "configure" command (bsr = "backslash R").
240 nigel 63
241     . When called via the POSIX interface, PCRE uses malloc() to get additional
242     storage for processing capturing parentheses if there are more than 10 of
243 ph10 128 them in a pattern. You can increase this threshold by setting, for example,
244 nigel 63
245     --with-posix-malloc-threshold=20
246    
247     on the "configure" command.
248    
249 nigel 77 . PCRE has a counter that can be set to limit the amount of resources it uses.
250 nigel 63 If the limit is exceeded during a match, the match fails. The default is ten
251     million. You can change the default by setting, for example,
252    
253     --with-match-limit=500000
254    
255     on the "configure" command. This is just the default; individual calls to
256 ph10 122 pcre_exec() can supply their own value. There is more discussion on the
257     pcreapi man page.
258 nigel 63
259 nigel 91 . There is a separate counter that limits the depth of recursive function calls
260     during a matching process. This also has a default of ten million, which is
261     essentially "unlimited". You can change the default by setting, for example,
262    
263     --with-match-limit-recursion=500000
264    
265     Recursive function calls use up the runtime stack; running out of stack can
266     cause programs to crash in strange ways. There is a discussion about stack
267     sizes in the pcrestack man page.
268    
269 nigel 63 . The default maximum compiled pattern size is around 64K. You can increase
270 ph10 842 this by adding --with-link-size=3 to the "configure" command. In the 8-bit
271     library, PCRE then uses three bytes instead of two for offsets to different
272 ph10 840 parts of the compiled pattern. In the 16-bit library, --with-link-size=3 is
273 ph10 842 the same as --with-link-size=4, which (in both libraries) uses four-byte
274 ph10 840 offsets. Increasing the internal link size reduces performance.
275 nigel 63
276 nigel 77 . You can build PCRE so that its internal match() function that is called from
277 ph10 122 pcre_exec() does not call itself recursively. Instead, it uses memory blocks
278     obtained from the heap via the special functions pcre_stack_malloc() and
279     pcre_stack_free() to save data that would otherwise be saved on the stack. To
280     build PCRE like this, use
281 nigel 73
282     --disable-stack-for-recursion
283    
284     on the "configure" command. PCRE runs more slowly in this mode, but it may be
285 nigel 77 necessary in environments with limited stack sizes. This applies only to the
286 ph10 672 normal execution of the pcre_exec() function; if JIT support is being
287     successfully used, it is not relevant. Equally, it does not apply to
288     pcre_dfa_exec(), which does not use deeply nested recursion. There is a
289     discussion about stack sizes in the pcrestack man page.
290 nigel 73
291 ph10 128 . For speed, PCRE uses four tables for manipulating and identifying characters
292     whose code point values are less than 256. By default, it uses a set of
293     tables for ASCII encoding that is part of the distribution. If you specify
294    
295     --enable-rebuild-chartables
296    
297     a program called dftables is compiled and run in the default C locale when
298     you obey "make". It builds a source file called pcre_chartables.c. If you do
299     not specify this option, pcre_chartables.c is created as a copy of
300     pcre_chartables.c.dist. See "Character tables" below for further information.
301    
302     . It is possible to compile PCRE for use on systems that use EBCDIC as their
303 ph10 391 character code (as opposed to ASCII) by specifying
304 ph10 128
305     --enable-ebcdic
306    
307 ph10 392 This automatically implies --enable-rebuild-chartables (see above). However,
308     when PCRE is built this way, it always operates in EBCDIC. It cannot support
309 ph10 840 both EBCDIC and UTF-8/16.
310 ph10 128
311 ph10 842 . The pcregrep program currently supports only 8-bit data files, and so
312 ph10 840 requires the 8-bit PCRE library. It is possible to compile pcregrep to use
313     libz and/or libbz2, in order to read .gz and .bz2 files (respectively), by
314     specifying one or both of
315 ph10 286
316     --enable-pcregrep-libz
317     --enable-pcregrep-libbz2
318 ph10 289
319 ph10 287 Of course, the relevant libraries must be installed on your system.
320 ph10 289
321 ph10 654 . The default size of internal buffer used by pcregrep can be set by, for
322     example:
323    
324     --with-pcregrep-bufsize=50K
325    
326     The default value is 20K.
327    
328 ph10 289 . It is possible to compile pcretest so that it links with the libreadline
329 ph10 936 or libedit libraries, by specifying, respectively,
330 ph10 289
331 ph10 936 --enable-pcretest-libreadline or --enable-pcretest-libedit
332 ph10 289
333 ph10 287 If this is done, when pcretest's input is from a terminal, it reads it using
334     the readline() function. This provides line-editing and history facilities.
335     Note that libreadline is GPL-licenced, so if you distribute a binary of
336 ph10 936 pcretest linked in this way, there may be licensing issues. These can be
337 ph10 939 avoided by linking with libedit (which has a BSD licence) instead.
338 ph10 345
339 ph10 936 Enabling libreadline causes the -lreadline option to be added to the pcretest
340 ph10 338 build. In many operating environments with a sytem-installed readline
341     library this is sufficient. However, in some environments (e.g. if an
342     unmodified distribution version of readline is in use), it may be necessary
343     to specify something like LIBS="-lncurses" as well. This is because, to quote
344     the readline INSTALL, "Readline uses the termcap functions, but does not link
345     with the termcap or curses library itself, allowing applications which link
346 ph10 392 with readline the to choose an appropriate library." If you get error
347     messages about missing functions tgetstr, tgetent, tputs, tgetflag, or tgoto,
348     this is the problem, and linking with the ncurses library should fix it.
349 ph10 286
350 ph10 109 The "configure" script builds the following files for the basic C library:
351 nigel 49
352 ph10 672 . Makefile the makefile that builds the library
353     . config.h build-time configuration options for the library
354     . pcre.h the public PCRE header file
355     . pcre-config script that shows the building settings such as CFLAGS
356     that were set for "configure"
357     . libpcre.pc ) data for the pkg-config command
358 ph10 840 . libpcre16.pc )
359 ph10 672 . libpcreposix.pc )
360     . libtool script that builds shared and/or static libraries
361     . RunTest script for running tests on the basic C library
362     . RunGrepTest script for running tests on the pcregrep command
363 nigel 41
364 ph10 489 Versions of config.h and pcre.h are distributed in the PCRE tarballs under the
365     names config.h.generic and pcre.h.generic. These are provided for those who
366     have to built PCRE without using "configure" or CMake. If you use "configure"
367     or CMake, the .generic versions are not used.
368 nigel 77
369 ph10 840 When building the 8-bit library, if a C++ compiler is found, the following
370     files are also built:
371 ph10 109
372 ph10 672 . libpcrecpp.pc data for the pkg-config command
373     . pcrecpparg.h header file for calling PCRE via the C++ wrapper
374     . pcre_stringpiece.h header for the C++ "stringpiece" functions
375 nigel 77
376     The "configure" script also creates config.status, which is an executable
377     script that can be run to recreate the configuration, and config.log, which
378     contains compiler output from tests that "configure" runs.
379    
380 ph10 840 Once "configure" has run, you can run "make". This builds either or both of the
381     libraries libpcre and libpcre16, and a test program called pcretest. If you
382     enabled JIT support with --enable-jit, a test program called pcre_jit_test is
383     built as well.
384 nigel 3
385 ph10 840 If the 8-bit library is built, libpcreposix and the pcregrep command are also
386     built, and if a C++ compiler was found on your system, and you did not disable
387     it with --disable-cpp, "make" builds the C++ wrapper library, which is called
388     libpcrecpp, as well as some test programs called pcrecpp_unittest,
389     pcre_scanner_unittest, and pcre_stringpiece_unittest.
390    
391 ph10 109 The command "make check" runs all the appropriate tests. Details of the PCRE
392     tests are given below in a separate section of this document.
393 nigel 75
394 ph10 109 You can use "make install" to install PCRE into live directories on your
395     system. The following are installed (file names are all relative to the
396     <prefix> that is set when "configure" is run):
397 nigel 77
398 ph10 109 Commands (bin):
399     pcretest
400 ph10 840 pcregrep (if 8-bit support is enabled)
401 ph10 111 pcre-config
402 ph10 109
403     Libraries (lib):
404 ph10 842 libpcre16 (if 16-bit support is enabled)
405 ph10 840 libpcre (if 8-bit support is enabled)
406     libpcreposix (if 8-bit support is enabled)
407     libpcrecpp (if 8-bit and C++ support is enabled)
408 ph10 109
409     Configuration information (lib/pkgconfig):
410 ph10 842 libpcre16.pc
411 ph10 109 libpcre.pc
412 ph10 672 libpcreposix.pc
413 ph10 122 libpcrecpp.pc (if C++ support is enabled)
414 ph10 109
415     Header files (include):
416     pcre.h
417     pcreposix.h
418     pcre_scanner.h )
419     pcre_stringpiece.h ) if C++ support is enabled
420     pcrecpp.h )
421     pcrecpparg.h )
422    
423     Man pages (share/man/man{1,3}):
424     pcregrep.1
425     pcretest.1
426 ph10 691 pcre-config.1
427 ph10 109 pcre.3
428     pcre*.3 (lots more pages, all starting "pcre")
429    
430     HTML documentation (share/doc/pcre/html):
431     index.html
432     *.html (lots more pages, hyperlinked from index.html)
433    
434     Text file documentation (share/doc/pcre):
435     AUTHORS
436     COPYING
437     ChangeLog
438     LICENCE
439     NEWS
440     README
441 ph10 672 pcre.txt (a concatenation of the man(3) pages)
442     pcretest.txt the pcretest man page
443     pcregrep.txt the pcregrep man page
444 ph10 691 pcre-config.txt the pcre-config man page
445 ph10 109
446 nigel 77 If you want to remove PCRE from your system, you can run "make uninstall".
447     This removes all the files that "make install" installed. However, it does not
448     remove any directories, because these are often shared with other programs.
449    
450    
451 ph10 122 Retrieving configuration information on Unix-like systems
452     ---------------------------------------------------------
453 nigel 75
454 ph10 109 Running "make install" installs the command pcre-config, which can be used to
455     recall information about the PCRE configuration and installation. For example:
456 nigel 37
457 nigel 43 pcre-config --version
458    
459     prints the version number, and
460    
461 nigel 75 pcre-config --libs
462 nigel 43
463     outputs information about where the library is installed. This command can be
464     included in makefiles for programs that use PCRE, saving the programmer from
465     having to remember too many details.
466    
467 nigel 75 The pkg-config command is another system for saving and retrieving information
468     about installed libraries. Instead of separate commands for each library, a
469     single command is used. For example:
470 nigel 43
471 nigel 75 pkg-config --cflags pcre
472    
473     The data is held in *.pc files that are installed in a directory called
474 ph10 109 <prefix>/lib/pkgconfig.
475 nigel 75
476    
477 nigel 63 Shared libraries on Unix-like systems
478     -------------------------------------
479 nigel 53
480 nigel 77 The default distribution builds PCRE as shared libraries and static libraries,
481     as long as the operating system supports shared libraries. Shared library
482     support relies on the "libtool" script which is built as part of the
483 nigel 53 "configure" process.
484 nigel 39
485 nigel 53 The libtool script is used to compile and link both shared and static
486     libraries. They are placed in a subdirectory called .libs when they are newly
487     built. The programs pcretest and pcregrep are built to use these uninstalled
488     libraries (by means of wrapper scripts in the case of shared libraries). When
489     you use "make install" to install shared libraries, pcregrep and pcretest are
490     automatically re-built to use the newly installed shared libraries before being
491 ph10 122 installed themselves. However, the versions left in the build directory still
492 nigel 53 use the uninstalled libraries.
493    
494     To build PCRE using static libraries only you must use --disable-shared when
495 nigel 75 configuring it. For example:
496 nigel 3
497 nigel 43 ./configure --prefix=/usr/gnu --disable-shared
498 nigel 41
499 nigel 53 Then run "make" in the usual way. Similarly, you can use --disable-static to
500     build only shared libraries.
501 nigel 41
502 nigel 43
503 ph10 122 Cross-compiling on Unix-like systems
504     ------------------------------------
505 nigel 63
506     You can specify CC and CFLAGS in the normal way to the "configure" command, in
507 ph10 128 order to cross-compile PCRE for some other host. However, you should NOT
508     specify --enable-rebuild-chartables, because if you do, the dftables.c source
509     file is compiled and run on the local host, in order to generate the inbuilt
510     character tables (the pcre_chartables.c file). This will probably not work,
511     because dftables.c needs to be compiled with the local compiler, not the cross
512     compiler.
513 nigel 63
514 ph10 128 When --enable-rebuild-chartables is not specified, pcre_chartables.c is created
515     by making a copy of pcre_chartables.c.dist, which is a default set of tables
516     that assumes ASCII code. Cross-compiling with the default tables should not be
517     a problem.
518 nigel 63
519 ph10 128 If you need to modify the character tables when cross-compiling, you should
520     move pcre_chartables.c.dist out of the way, then compile dftables.c by hand and
521     run it on the local host to make a new version of pcre_chartables.c.dist.
522     Then when you cross-compile PCRE this new version of the tables will be used.
523    
524    
525 nigel 87 Using HP's ANSI C++ compiler (aCC)
526     ----------------------------------
527    
528 nigel 93 Unless C++ support is disabled by specifying the "--disable-cpp" option of the
529 ph10 122 "configure" script, you must include the "-AA" option in the CXXFLAGS
530 nigel 87 environment variable in order for the C++ components to compile correctly.
531    
532     Also, note that the aCC compiler on PA-RISC platforms may have a defect whereby
533     needed libraries fail to get included when specifying the "-AA" compiler
534     option. If you experience unresolved symbols when linking the C++ programs,
535     use the workaround of specifying the following environment variable prior to
536     running the "configure" script:
537    
538     CXXLDFLAGS="-lstd_v2 -lCsup_v2"
539    
540 ph10 461
541 ph10 469 Using Sun's compilers for Solaris
542     ---------------------------------
543    
544     A user reports that the following configurations work on Solaris 9 sparcv9 and
545     Solaris 9 x86 (32-bit):
546    
547     Solaris 9 sparcv9: ./configure --disable-cpp CC=/bin/cc CFLAGS="-m64 -g"
548     Solaris 9 x86: ./configure --disable-cpp CC=/bin/cc CFLAGS="-g"
549    
550    
551 ph10 452 Using PCRE from MySQL
552     ---------------------
553 ph10 123
554 ph10 461 On systems where both PCRE and MySQL are installed, it is possible to make use
555     of PCRE from within MySQL, as an alternative to the built-in pattern matching.
556 ph10 452 There is a web page that tells you how to do this:
557    
558 ph10 461 http://www.mysqludf.org/lib_mysqludf_preg/index.php
559 ph10 452
560    
561 ph10 111 Making new tarballs
562     -------------------
563 nigel 87
564 ph10 123 The command "make dist" creates three PCRE tarballs, in tar.gz, tar.bz2, and
565 ph10 155 zip formats. The command "make distcheck" does the same, but then does a trial
566     build of the new distribution to ensure that it works.
567 ph10 111
568 ph10 155 If you have modified any of the man page sources in the doc directory, you
569     should first run the PrepareRelease script before making a distribution. This
570     script creates the .txt and HTML forms of the documentation from the man pages.
571 ph10 111
572 ph10 155
573 nigel 41 Testing PCRE
574     ------------
575    
576 ph10 122 To test the basic PCRE library on a Unix system, run the RunTest script that is
577     created by the configuring process. There is also a script called RunGrepTest
578     that tests the options of the pcregrep command. If the C++ wrapper library is
579     built, three test programs called pcrecpp_unittest, pcre_scanner_unittest, and
580 ph10 691 pcre_stringpiece_unittest are also built. When JIT support is enabled, another
581 ph10 672 test program called pcre_jit_test is built.
582 nigel 41
583 ph10 109 Both the scripts and all the program tests are run if you obey "make check" or
584     "make test". For other systems, see the instructions in NON-UNIX-USE.
585 nigel 77
586     The RunTest script runs the pcretest test program (which is documented in its
587 ph10 672 own man page) on each of the relevant testinput files in the testdata
588     directory, and compares the output with the contents of the corresponding
589     testoutput files. Some tests are relevant only when certain build-time options
590 ph10 840 were selected. For example, the tests for UTF-8/16 support are run only if
591     --enable-utf was used. RunTest outputs a comment when it skips a test.
592 ph10 672
593 ph10 691 Many of the tests that are not skipped are run up to three times. The second
594     run forces pcre_study() to be called for all patterns except for a few in some
595     tests that are marked "never study" (see the pcretest program for how this is
596     done). If JIT support is available, the non-DFA tests are run a third time,
597 ph10 672 this time with a forced pcre_study() with the PCRE_STUDY_JIT_COMPILE option.
598    
599 ph10 842 When both 8-bit and 16-bit support is enabled, the entire set of tests is run
600     twice, once for each library. If you want to run just one set of tests, call
601 ph10 840 RunTest with either the -8 or -16 option.
602    
603 ph10 842 RunTest uses a file called testtry to hold the main output from pcretest.
604     Other files whose names begin with "test" are used as working files in some
605     tests. To run pcretest on just one or more specific test files, give their
606     numbers as arguments to RunTest, for example:
607 nigel 41
608 ph10 840 RunTest 2 7 11
609 ph10 842
610 ph10 672 The first test file can be fed directly into the perltest.pl script to check
611     that Perl gives the same results. The only difference you should see is in the
612     first few lines, where the Perl version is given instead of the PCRE version.
613 nigel 3
614 ph10 840 The second set of tests check pcre_fullinfo(), pcre_study(),
615 nigel 49 pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error
616     detection, and run-time flags that are specific to PCRE, as well as the POSIX
617 ph10 122 wrapper API. It also uses the debugging flags to check some of the internals of
618 nigel 49 pcre_compile().
619 nigel 7
620 nigel 49 If you build PCRE with a locale setting that is not the standard C locale, the
621     character tables may be different (see next paragraph). In some cases, this may
622     cause failures in the second set of tests. For example, in a locale where the
623     isprint() function yields TRUE for characters in the range 128-255, the use of
624     [:isascii:] inside a character class defines a different set of characters, and
625     this shows up in this test as a difference in the compiled code, which is being
626     listed for checking. Where the comparison test output contains [\x00-\x7f] the
627     test will contain [\x00-\xff], and similarly in some other cases. This is not a
628     bug in PCRE.
629    
630 nigel 63 The third set of tests checks pcre_maketables(), the facility for building a
631 nigel 25 set of character tables for a specific locale and using them instead of the
632 nigel 73 default tables. The tests make use of the "fr_FR" (French) locale. Before
633     running the test, the script checks for the presence of this locale by running
634     the "locale" command. If that command fails, or if it doesn't include "fr_FR"
635     in the list of available locales, the third test cannot be run, and a comment
636     is output to say why. If running this test produces instances of the error
637 nigel 25
638 nigel 73 ** Failed to set locale "fr_FR"
639 nigel 25
640     in the comparison output, it means that locale is not available on your system,
641     despite being listed by "locale". This does not mean that PCRE is broken.
642    
643 ph10 142 [If you are trying to run this test on Windows, you may be able to get it to
644 ph10 260 work by changing "fr_FR" to "french" everywhere it occurs. Alternatively, use
645     RunTest.bat. The version of RunTest.bat included with PCRE 7.4 and above uses
646     Windows versions of test 2. More info on using RunTest.bat is included in the
647     document entitled NON-UNIX-USE.]
648 ph10 139
649 ph10 840 The fourth and fifth tests check the UTF-8/16 support and error handling and
650     internal UTF features of PCRE that are not relevant to Perl, respectively. The
651     sixth and seventh tests do the same for Unicode character properties support.
652 nigel 3
653 ph10 840 The eighth, ninth, and tenth tests check the pcre_dfa_exec() alternative
654     matching function, in non-UTF-8/16 mode, UTF-8/16 mode, and UTF-8/16 mode with
655     Unicode property support, respectively.
656 nigel 3
657 ph10 840 The eleventh test checks some internal offsets and code size features; it is
658     run only when the default "link size" of 2 is set (in other cases the sizes
659 ph10 672 change) and when Unicode property support is enabled.
660 nigel 77
661 ph10 840 The twelfth test is run only when JIT support is available, and the thirteenth
662     test is run only when JIT support is not available. They test some JIT-specific
663     features such as information output from pcretest about JIT compilation.
664 ph10 461
665 ph10 842 The fourteenth, fifteenth, and sixteenth tests are run only in 8-bit mode, and
666     the seventeenth, eighteenth, and nineteenth tests are run only in 16-bit mode.
667     These are tests that generate different output in the two modes. They are for
668 ph10 840 general cases, UTF-8/16 support, and Unicode property support, respectively.
669 ph10 461
670 ph10 842 The twentieth test is run only in 16-bit mode. It tests some specific 16-bit
671 ph10 840 features of the DFA matching engine.
672 ph10 672
673 ph10 903 The twenty-first and twenty-second tests are run only in 16-bit mode, when the
674 ph10 900 link size is set to 2. They test reloading pre-compiled patterns.
675 ph10 672
676 ph10 900
677 nigel 3 Character tables
678     ----------------
679    
680 ph10 122 For speed, PCRE uses four tables for manipulating and identifying characters
681     whose code point values are less than 256. The final argument of the
682     pcre_compile() function is a pointer to a block of memory containing the
683     concatenated tables. A call to pcre_maketables() can be used to generate a set
684     of tables in the current locale. If the final argument for pcre_compile() is
685     passed as NULL, a set of default tables that is built into the binary is used.
686 nigel 3
687 ph10 128 The source file called pcre_chartables.c contains the default set of tables. By
688     default, this is created as a copy of pcre_chartables.c.dist, which contains
689     tables for ASCII coding. However, if --enable-rebuild-chartables is specified
690     for ./configure, a different version of pcre_chartables.c is built by the
691     program dftables (compiled from dftables.c), which uses the ANSI C character
692     handling functions such as isalnum(), isalpha(), isupper(), islower(), etc. to
693     build the table sources. This means that the default C locale which is set for
694     your system will control the contents of these default tables. You can change
695     the default tables by editing pcre_chartables.c and then re-building PCRE. If
696     you do this, you should take care to ensure that the file does not get
697     automatically re-generated. The best way to do this is to move
698     pcre_chartables.c.dist out of the way and replace it with your customized
699     tables.
700 nigel 3
701 ph10 128 When the dftables program is run as a result of --enable-rebuild-chartables,
702     it uses the default C locale that is set on your system. It does not pay
703     attention to the LC_xxx environment variables. In other words, it uses the
704     system's default locale rather than whatever the compiling user happens to have
705     set. If you really do want to build a source set of character tables in a
706     locale that is specified by the LC_xxx variables, you can run the dftables
707     program by hand with the -L option. For example:
708    
709     ./dftables -L pcre_chartables.c.special
710    
711 nigel 25 The first two 256-byte tables provide lower casing and case flipping functions,
712     respectively. The next table consists of three 32-byte bit maps which identify
713     digits, "word" characters, and white space, respectively. These are used when
714 ph10 111 building 32-byte bit maps that represent character classes for code points less
715 ph10 109 than 256.
716 nigel 25
717     The final 256-byte table has bits indicating various character types, as
718 nigel 3 follows:
719    
720     1 white space character
721     2 letter
722     4 decimal digit
723     8 hexadecimal digit
724     16 alphanumeric or '_'
725     128 regular expression metacharacter or binary zero
726    
727     You should not alter the set of characters that contain the 128 bit, as that
728     will cause PCRE to malfunction.
729    
730    
731 ph10 109 File manifest
732     -------------
733 nigel 3
734 ph10 842 The distribution should contain the files listed below. Where a file name is
735     given as pcre[16]_xxx it means that there are two files, one with the name
736 ph10 840 pcre_xxx and the other with the name pcre16_xxx.
737 nigel 3
738 ph10 109 (A) Source files of the PCRE library functions and their headers:
739 nigel 3
740 ph10 128 dftables.c auxiliary program for building pcre_chartables.c
741     when --enable-rebuild-chartables is specified
742 ph10 111
743 ph10 128 pcre_chartables.c.dist a default set of character tables that assume ASCII
744     coding; used, unless --enable-rebuild-chartables is
745 ph10 840 specified, by copying to pcre[16]_chartables.c
746 ph10 111
747 ph10 128 pcreposix.c )
748 ph10 840 pcre[16]_byte_order.c )
749     pcre[16]_compile.c )
750     pcre[16]_config.c )
751     pcre[16]_dfa_exec.c )
752     pcre[16]_exec.c )
753     pcre[16]_fullinfo.c )
754     pcre[16]_get.c ) sources for the functions in the library,
755     pcre[16]_globals.c ) and some internal functions that they use
756     pcre[16]_jit_compile.c )
757     pcre[16]_maketables.c )
758     pcre[16]_newline.c )
759     pcre[16]_refcount.c )
760     pcre[16]_string_utils.c )
761     pcre[16]_study.c )
762     pcre[16]_tables.c )
763     pcre[16]_ucd.c )
764     pcre[16]_version.c )
765     pcre[16]_xclass.c )
766 ph10 128 pcre_ord2utf8.c )
767     pcre_valid_utf8.c )
768 ph10 840 pcre16_ord2utf16.c )
769     pcre16_utf16_utils.c )
770     pcre16_valid_utf16.c )
771 ph10 842
772 ph10 840 pcre[16]_printint.c ) debugging function that is used by pcretest,
773 ph10 128 ) and can also be #included in pcre_compile()
774 ph10 842
775 ph10 128 pcre.h.in template for pcre.h when built by "configure"
776     pcreposix.h header for the external POSIX wrapper API
777     pcre_internal.h header for internal use
778 ph10 691 sljit/* 16 files that make up the JIT compiler
779 ph10 374 ucp.h header for Unicode property handling
780 ph10 111
781 ph10 128 config.h.in template for config.h, which is built by "configure"
782 ph10 111
783 ph10 128 pcrecpp.h public header file for the C++ wrapper
784     pcrecpparg.h.in template for another C++ header file
785     pcre_scanner.h public header file for C++ scanner functions
786     pcrecpp.cc )
787     pcre_scanner.cc ) source for the C++ wrapper library
788 ph10 111
789 ph10 128 pcre_stringpiece.h.in template for pcre_stringpiece.h, the header for the
790     C++ stringpiece functions
791     pcre_stringpiece.cc source for the C++ stringpiece functions
792    
793 ph10 109 (B) Source files for programs that use PCRE:
794 nigel 75
795 ph10 128 pcredemo.c simple demonstration of coding calls to PCRE
796     pcregrep.c source of a grep utility that uses PCRE
797     pcretest.c comprehensive test program
798 ph10 111
799     (C) Auxiliary files:
800    
801 ph10 128 132html script to turn "man" pages into HTML
802     AUTHORS information about the author of PCRE
803     ChangeLog log of changes to the code
804     CleanTxt script to clean nroff output for txt man pages
805     Detrail script to remove trailing spaces
806     HACKING some notes about the internals of PCRE
807     INSTALL generic installation instructions
808     LICENCE conditions for the use of PCRE
809     COPYING the same, using GNU's standard name
810     Makefile.in ) template for Unix Makefile, which is built by
811     ) "configure"
812     Makefile.am ) the automake input that was used to create
813     ) Makefile.in
814     NEWS important changes in this release
815     NON-UNIX-USE notes on building PCRE on non-Unix systems
816     PrepareRelease script to make preparations for "make dist"
817     README this file
818 ph10 138 RunTest a Unix shell script for running tests
819     RunGrepTest a Unix shell script for pcregrep tests
820 ph10 128 aclocal.m4 m4 macros (generated by "aclocal")
821     config.guess ) files used by libtool,
822     config.sub ) used only when building a shared library
823     configure a configuring shell script (built by autoconf)
824     configure.ac ) the autoconf input that was used to build
825     ) "configure" and config.h
826     depcomp ) script to find program dependencies, generated by
827     ) automake
828 ph10 429 doc/*.3 man page sources for PCRE
829 ph10 128 doc/*.1 man page sources for pcregrep and pcretest
830     doc/index.html.src the base HTML page
831     doc/html/* HTML documentation
832     doc/pcre.txt plain text version of the man pages
833     doc/pcretest.txt plain text documentation of test program
834     doc/perltest.txt plain text documentation of Perl test program
835     install-sh a shell script for installing files
836 ph10 840 libpcre16.pc.in template for libpcre16.pc for pkg-config
837 ph10 128 libpcre.pc.in template for libpcre.pc for pkg-config
838 ph10 461 libpcreposix.pc.in template for libpcreposix.pc for pkg-config
839 ph10 128 libpcrecpp.pc.in template for libpcrecpp.pc for pkg-config
840     ltmain.sh file used to build a libtool script
841     missing ) common stub for a few missing GNU programs while
842     ) installing, generated by automake
843     mkinstalldirs script for making install directories
844     perltest.pl Perl test program
845     pcre-config.in source of script which retains PCRE information
846 ph10 691 pcre_jit_test.c test program for the JIT compiler
847 ph10 111 pcrecpp_unittest.cc )
848     pcre_scanner_unittest.cc ) test programs for the C++ wrapper
849     pcre_stringpiece_unittest.cc )
850 ph10 128 testdata/testinput* test data for main library tests
851     testdata/testoutput* expected test results
852     testdata/grep* input and output for pcregrep tests
853 ph10 842 testdata/* other supporting test files
854 ph10 111
855 ph10 109 (D) Auxiliary files for cmake support
856 nigel 3
857 ph10 374 cmake/COPYING-CMAKE-SCRIPTS
858     cmake/FindPackageHandleStandardArgs.cmake
859 ph10 939 cmake/FindEditline.cmake
860 ph10 374 cmake/FindReadline.cmake
861 ph10 109 CMakeLists.txt
862 ph10 111 config-cmake.h.in
863 nigel 29
864 ph10 109 (E) Auxiliary files for VPASCAL
865 nigel 29
866 nigel 63 makevp.bat
867 ph10 135 makevp_c.txt
868     makevp_l.txt
869 ph10 111 pcregexp.pas
870    
871     (F) Auxiliary files for building PCRE "by hand"
872    
873 ph10 128 pcre.h.generic ) a version of the public PCRE header file
874     ) for use in non-"configure" environments
875     config.h.generic ) a version of config.h for use in non-"configure"
876     ) environments
877 ph10 111
878 ph10 109 (F) Miscellaneous
879 nigel 63
880 ph10 109 RunTest.bat a script for running tests under Windows
881    
882 nigel 77 Philip Hazel
883     Email local part: ph10
884     Email domain: cam.ac.uk
885 ph10 939 Last updated: 26 February 2012

Properties

Name Value
svn:eol-style native
svn:keywords "Author Date Id Revision Url"

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12