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

Contents of /code/trunk/README

Parent Directory Parent Directory | Revision Log Revision Log


Revision 654 - (hide annotations) (download)
Tue Aug 2 11:00:40 2011 UTC (3 years, 3 months ago) by ph10
File size: 36627 byte(s)
Documentation and general text tidies in preparation for test release.

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

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