/[pcre]/code/trunk/doc/pcrebuild.3
ViewVC logotype

Diff of /code/trunk/doc/pcrebuild.3

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

revision 96 by nigel, Fri Mar 2 13:10:43 2007 UTC revision 857 by ph10, Sat Jan 7 17:39:10 2012 UTC
# Line 1  Line 1 
1  .TH PCREBUILD 3  .TH PCREBUILD 3
2  .SH NAME  .SH NAME
3  PCRE - Perl-compatible regular expressions  PCRE - Perl-compatible regular expressions
4    .
5    .
6  .SH "PCRE BUILD-TIME OPTIONS"  .SH "PCRE BUILD-TIME OPTIONS"
7  .rs  .rs
8  .sp  .sp
9  This document describes the optional features of PCRE that can be selected when  This document describes the optional features of PCRE that can be selected when
10  the library is compiled. They are all selected, or deselected, by providing  the library is compiled. It assumes use of the \fBconfigure\fP script, where
11  options to the \fBconfigure\fP script that is run before the \fBmake\fP  the optional features are selected or deselected by providing options to
12  command. The complete list of options for \fBconfigure\fP (which includes the  \fBconfigure\fP before running the \fBmake\fP command. However, the same
13  standard ones such as the selection of the installation directory) can be  options can be selected in both Unix-like and non-Unix-like environments using
14  obtained by running  the GUI facility of \fBcmake-gui\fP if you are using \fBCMake\fP instead of
15    \fBconfigure\fP to build PCRE.
16    .P
17    There is a lot more information about building PCRE in non-Unix-like
18    environments in the file called \fINON_UNIX_USE\fP, which is part of the PCRE
19    distribution. You should consult this file as well as the \fIREADME\fP file if
20    you are building in a non-Unix-like environment.
21    .P
22    The complete list of options for \fBconfigure\fP (which includes the standard
23    ones such as the selection of the installation directory) can be obtained by
24    running
25  .sp  .sp
26    ./configure --help    ./configure --help
27  .sp  .sp
28  The following sections describe certain options whose names begin with --enable  The following sections include descriptions of options whose names begin with
29  or --disable. These settings specify changes to the defaults for the  --enable or --disable. These settings specify changes to the defaults for the
30  \fBconfigure\fP command. Because of the way that \fBconfigure\fP works,  \fBconfigure\fP command. Because of the way that \fBconfigure\fP works,
31  --enable and --disable always come in pairs, so the complementary option always  --enable and --disable always come in pairs, so the complementary option always
32  exists as well, but as it specifies the default, it is not described.  exists as well, but as it specifies the default, it is not described.
33  .  .
34    .
35    .SH "BUILDING 8-BIT and 16-BIT LIBRARIES"
36    .rs
37    .sp
38    By default, a library called \fBlibpcre\fP is built, containing functions that
39    take string arguments contained in vectors of bytes, either as single-byte
40    characters, or interpreted as UTF-8 strings. You can also build a separate
41    library, called \fBlibpcre16\fP, in which strings are contained in vectors of
42    16-bit data units and interpreted either as single-unit characters or UTF-16
43    strings, by adding
44    .sp
45      --enable-pcre16
46    .sp
47    to the \fBconfigure\fP command. If you do not want the 8-bit library, add
48    .sp
49      --disable-pcre8
50    .sp
51    as well. At least one of the two libraries must be built. Note that the C++ and
52    POSIX wrappers are for the 8-bit library only, and that \fBpcregrep\fP is an
53    8-bit program. None of these are built if you select only the 16-bit library.
54    .
55    .
56    .SH "BUILDING SHARED AND STATIC LIBRARIES"
57    .rs
58    .sp
59    The PCRE building process uses \fBlibtool\fP to build both shared and static
60    Unix libraries by default. You can suppress one of these by adding one of
61    .sp
62      --disable-shared
63      --disable-static
64    .sp
65    to the \fBconfigure\fP command, as required.
66    .
67    .
68  .SH "C++ SUPPORT"  .SH "C++ SUPPORT"
69  .rs  .rs
70  .sp  .sp
71  By default, the \fBconfigure\fP script will search for a C++ compiler and C++  By default, if the 8-bit library is being built, the \fBconfigure\fP script
72  header files. If it finds them, it automatically builds the C++ wrapper library  will search for a C++ compiler and C++ header files. If it finds them, it
73  for PCRE. You can disable this by adding  automatically builds the C++ wrapper library (which supports only 8-bit
74    strings). You can disable this by adding
75  .sp  .sp
76    --disable-cpp    --disable-cpp
77  .sp  .sp
78  to the \fBconfigure\fP command.  to the \fBconfigure\fP command.
79  .  .
80  .SH "UTF-8 SUPPORT"  .
81    .SH "UTF-8 and UTF-16 SUPPORT"
82  .rs  .rs
83  .sp  .sp
84  To build PCRE with support for UTF-8 character strings, add  To build PCRE with support for UTF Unicode character strings, add
85  .sp  .sp
86    --enable-utf8    --enable-utf
87  .sp  .sp
88  to the \fBconfigure\fP command. Of itself, this does not make PCRE treat  to the \fBconfigure\fP command. This setting applies to both libraries, adding
89  strings as UTF-8. As well as compiling PCRE with this option, you also have  support for UTF-8 to the 8-bit library and support for UTF-16 to the 16-bit
90  have to set the PCRE_UTF8 option when you call the \fBpcre_compile()\fP  library. It is not possible to build one library with UTF support and the other
91  function.  without in the same configuration. (For backwards compatibility, --enable-utf8
92    is a synonym of --enable-utf.)
93    .P
94    Of itself, this setting does not make PCRE treat strings as UTF-8 or UTF-16. As
95    well as compiling PCRE with this option, you also have have to set the
96    PCRE_UTF8 or PCRE_UTF16 option when you call one of the pattern compiling
97    functions.
98    .P
99    If you set --enable-utf when compiling in an EBCDIC environment, PCRE expects
100    its input to be either ASCII or UTF-8 (depending on the runtime option). It is
101    not possible to support both EBCDIC and UTF-8 codes in the same version of the
102    library. Consequently, --enable-utf and --enable-ebcdic are mutually
103    exclusive.
104    .
105  .  .
106  .SH "UNICODE CHARACTER PROPERTY SUPPORT"  .SH "UNICODE CHARACTER PROPERTY SUPPORT"
107  .rs  .rs
108  .sp  .sp
109  UTF-8 support allows PCRE to process character values greater than 255 in the  UTF support allows the libraries to process character codepoints up to 0x10ffff
110  strings that it handles. On its own, however, it does not provide any  in the strings that they handle. On its own, however, it does not provide any
111  facilities for accessing the properties of such characters. If you want to be  facilities for accessing the properties of such characters. If you want to be
112  able to use the pattern escapes \eP, \ep, and \eX, which refer to Unicode  able to use the pattern escapes \eP, \ep, and \eX, which refer to Unicode
113  character properties, you must add  character properties, you must add
114  .sp  .sp
115    --enable-unicode-properties    --enable-unicode-properties
116  .sp  .sp
117  to the \fBconfigure\fP command. This implies UTF-8 support, even if you have  to the \fBconfigure\fP command. This implies UTF support, even if you have
118  not explicitly requested it.  not explicitly requested it.
119  .P  .P
120  Including Unicode property support adds around 90K of tables to the PCRE  Including Unicode property support adds around 30K of tables to the PCRE
121  library, approximately doubling its size. Only the general category properties  library. Only the general category properties such as \fILu\fP and \fINd\fP are
122  such as \fILu\fP and \fINd\fP are supported. Details are given in the  supported. Details are given in the
123  .\" HREF  .\" HREF
124  \fBpcrepattern\fP  \fBpcrepattern\fP
125  .\"  .\"
126  documentation.  documentation.
127  .  .
128    .
129    .SH "JUST-IN-TIME COMPILER SUPPORT"
130    .rs
131    .sp
132    Just-in-time compiler support is included in the build by specifying
133    .sp
134      --enable-jit
135    .sp
136    This support is available only for certain hardware architectures. If this
137    option is set for an unsupported architecture, a compile time error occurs.
138    See the
139    .\" HREF
140    \fBpcrejit\fP
141    .\"
142    documentation for a discussion of JIT usage. When JIT support is enabled,
143    pcregrep automatically makes use of it, unless you add
144    .sp
145      --disable-pcregrep-jit
146    .sp
147    to the "configure" command.
148    .
149    .
150  .SH "CODE VALUE OF NEWLINE"  .SH "CODE VALUE OF NEWLINE"
151  .rs  .rs
152  .sp  .sp
153  By default, PCRE interprets character 10 (linefeed, LF) as indicating the end  By default, PCRE interprets the linefeed (LF) character as indicating the end
154  of a line. This is the normal newline character on Unix-like systems. You can  of a line. This is the normal newline character on Unix-like systems. You can
155  compile PCRE to use character 13 (carriage return, CR) instead, by adding  compile PCRE to use carriage return (CR) instead, by adding
156  .sp  .sp
157    --enable-newline-is-cr    --enable-newline-is-cr
158  .sp  .sp
# Line 83  character sequence CRLF. If you want thi Line 166  character sequence CRLF. If you want thi
166  .sp  .sp
167  to the \fBconfigure\fP command. There is a fourth option, specified by  to the \fBconfigure\fP command. There is a fourth option, specified by
168  .sp  .sp
169      --enable-newline-is-anycrlf
170    .sp
171    which causes PCRE to recognize any of the three sequences CR, LF, or CRLF as
172    indicating a line ending. Finally, a fifth option, specified by
173    .sp
174    --enable-newline-is-any    --enable-newline-is-any
175  .sp  .sp
176  which causes PCRE to recognize any Unicode newline sequence.  causes PCRE to recognize any Unicode newline sequence.
177  .P  .P
178  Whatever line ending convention is selected when PCRE is built can be  Whatever line ending convention is selected when PCRE is built can be
179  overridden when the library functions are called. At build time it is  overridden when the library functions are called. At build time it is
180  conventional to use the standard for your operating system.  conventional to use the standard for your operating system.
181  .  .
182  .SH "BUILDING SHARED AND STATIC LIBRARIES"  .
183    .SH "WHAT \eR MATCHES"
184  .rs  .rs
185  .sp  .sp
186  The PCRE building process uses \fBlibtool\fP to build both shared and static  By default, the sequence \eR in a pattern matches any Unicode newline sequence,
187  Unix libraries by default. You can suppress one of these by adding one of  whatever has been selected as the line ending sequence. If you specify
188  .sp  .sp
189    --disable-shared    --enable-bsr-anycrlf
   --disable-static  
190  .sp  .sp
191  to the \fBconfigure\fP command, as required.  the default is changed so that \eR matches only CR, LF, or CRLF. Whatever is
192    selected when PCRE is built can be overridden when the library functions are
193    called.
194    .
195  .  .
196  .SH "POSIX MALLOC USAGE"  .SH "POSIX MALLOC USAGE"
197  .rs  .rs
198  .sp  .sp
199  When PCRE is called through the POSIX interface (see the  When the 8-bit library is called through the POSIX interface (see the
200  .\" HREF  .\" HREF
201  \fBpcreposix\fP  \fBpcreposix\fP
202  .\"  .\"
# Line 121  such as Line 212  such as
212  .sp  .sp
213  to the \fBconfigure\fP command.  to the \fBconfigure\fP command.
214  .  .
215    .
216  .SH "HANDLING VERY LARGE PATTERNS"  .SH "HANDLING VERY LARGE PATTERNS"
217  .rs  .rs
218  .sp  .sp
# Line 129  another (for example, from an opening pa Line 221  another (for example, from an opening pa
221  metacharacter). By default, two-byte values are used for these offsets, leading  metacharacter). By default, two-byte values are used for these offsets, leading
222  to a maximum size for a compiled pattern of around 64K. This is sufficient to  to a maximum size for a compiled pattern of around 64K. This is sufficient to
223  handle all but the most gigantic patterns. Nevertheless, some people do want to  handle all but the most gigantic patterns. Nevertheless, some people do want to
224  process enormous patterns, so it is possible to compile PCRE to use three-byte  process truly enormous patterns, so it is possible to compile PCRE to use
225  or four-byte offsets by adding a setting such as  three-byte or four-byte offsets by adding a setting such as
226  .sp  .sp
227    --with-link-size=3    --with-link-size=3
228  .sp  .sp
229  to the \fBconfigure\fP command. The value given must be 2, 3, or 4. Using  to the \fBconfigure\fP command. The value given must be 2, 3, or 4. For the
230  longer offsets slows down the operation of PCRE because it has to load  16-bit library, a value of 3 is rounded up to 4. Using longer offsets slows
231  additional bytes when handling them.  down the operation of PCRE because it has to load additional data when handling
232  .P  them.
233  If you build PCRE with an increased link size, test 2 (and test 5 if you are  .
 using UTF-8) will fail. Part of the output of these tests is a representation  
 of the compiled pattern, and this changes with the link size.  
234  .  .
235  .SH "AVOIDING EXCESSIVE STACK USAGE"  .SH "AVOIDING EXCESSIVE STACK USAGE"
236  .rs  .rs
# Line 163  build a version of PCRE that works this Line 253  build a version of PCRE that works this
253  .sp  .sp
254  to the \fBconfigure\fP command. With this configuration, PCRE will use the  to the \fBconfigure\fP command. With this configuration, PCRE will use the
255  \fBpcre_stack_malloc\fP and \fBpcre_stack_free\fP variables to call memory  \fBpcre_stack_malloc\fP and \fBpcre_stack_free\fP variables to call memory
256  management functions. Separate functions are provided because the usage is very  management functions. By default these point to \fBmalloc()\fP and
257  predictable: the block sizes requested are always the same, and the blocks are  \fBfree()\fP, but you can replace the pointers so that your own functions are
258  always freed in reverse order. A calling program might be able to implement  used instead.
259  optimized functions that perform better than the standard \fBmalloc()\fP and  .P
260  \fBfree()\fP functions. PCRE runs noticeably more slowly when built in this  Separate functions are provided rather than using \fBpcre_malloc\fP and
261  way. This option affects only the \fBpcre_exec()\fP function; it is not  \fBpcre_free\fP because the usage is very predictable: the block sizes
262  relevant for the the \fBpcre_dfa_exec()\fP function.  requested are always the same, and the blocks are always freed in reverse
263    order. A calling program might be able to implement optimized functions that
264    perform better than \fBmalloc()\fP and \fBfree()\fP. PCRE runs noticeably more
265    slowly when built in this way. This option affects only the \fBpcre_exec()\fP
266    function; it is not relevant for \fBpcre_dfa_exec()\fP.
267    .
268  .  .
269  .SH "LIMITING PCRE RESOURCE USAGE"  .SH "LIMITING PCRE RESOURCE USAGE"
270  .rs  .rs
# Line 202  constraints. However, you can set a lowe Line 297  constraints. However, you can set a lowe
297  .sp  .sp
298  to the \fBconfigure\fP command. This value can also be overridden at run time.  to the \fBconfigure\fP command. This value can also be overridden at run time.
299  .  .
300    .
301    .SH "CREATING CHARACTER TABLES AT BUILD TIME"
302    .rs
303    .sp
304    PCRE uses fixed tables for processing characters whose code values are less
305    than 256. By default, PCRE is built with a set of tables that are distributed
306    in the file \fIpcre_chartables.c.dist\fP. These tables are for ASCII codes
307    only. If you add
308    .sp
309      --enable-rebuild-chartables
310    .sp
311    to the \fBconfigure\fP command, the distributed tables are no longer used.
312    Instead, a program called \fBdftables\fP is compiled and run. This outputs the
313    source for new set of tables, created in the default locale of your C runtime
314    system. (This method of replacing the tables does not work if you are cross
315    compiling, because \fBdftables\fP is run on the local host. If you need to
316    create alternative tables when cross compiling, you will have to do so "by
317    hand".)
318    .
319    .
320  .SH "USING EBCDIC CODE"  .SH "USING EBCDIC CODE"
321  .rs  .rs
322  .sp  .sp
323  PCRE assumes by default that it will run in an environment where the character  PCRE assumes by default that it will run in an environment where the character
324  code is ASCII (or Unicode, which is a superset of ASCII). PCRE can, however, be  code is ASCII (or Unicode, which is a superset of ASCII). This is the case for
325  compiled to run in an EBCDIC environment by adding  most computer operating systems. PCRE can, however, be compiled to run in an
326    EBCDIC environment by adding
327  .sp  .sp
328    --enable-ebcdic    --enable-ebcdic
329  .sp  .sp
330  to the \fBconfigure\fP command.  to the \fBconfigure\fP command. This setting implies
331    --enable-rebuild-chartables. You should only use it if you know that you are in
332    an EBCDIC environment (for example, an IBM mainframe operating system). The
333    --enable-ebcdic option is incompatible with --enable-utf.
334  .  .
335  .  .
336  .SH "SEE ALSO"  .SH "PCREGREP OPTIONS FOR COMPRESSED FILE SUPPORT"
337  .rs  .rs
338  .sp  .sp
339  \fBpcreapi\fP(3), \fBpcre_config\fP(3).  By default, \fBpcregrep\fP reads all files as plain text. You can build it so
340    that it recognizes files whose names end in \fB.gz\fP or \fB.bz2\fP, and reads
341    them with \fBlibz\fP or \fBlibbz2\fP, respectively, by adding one or both of
342    .sp
343      --enable-pcregrep-libz
344      --enable-pcregrep-libbz2
345    .sp
346    to the \fBconfigure\fP command. These options naturally require that the
347    relevant libraries are installed on your system. Configuration will fail if
348    they are not.
349    .
350    .
351    .SH "PCREGREP BUFFER SIZE"
352    .rs
353    .sp
354    \fBpcregrep\fP uses an internal buffer to hold a "window" on the file it is
355    scanning, in order to be able to output "before" and "after" lines when it
356    finds a match. The size of the buffer is controlled by a parameter whose
357    default value is 20K. The buffer itself is three times this size, but because
358    of the way it is used for holding "before" lines, the longest line that is
359    guaranteed to be processable is the parameter size. You can change the default
360    parameter value by adding, for example,
361    .sp
362      --with-pcregrep-bufsize=50K
363    .sp
364    to the \fBconfigure\fP command. The caller of \fPpcregrep\fP can, however,
365    override this value by specifying a run-time option.
366    .
367    .
368    .SH "PCRETEST OPTION FOR LIBREADLINE SUPPORT"
369    .rs
370    .sp
371    If you add
372    .sp
373      --enable-pcretest-libreadline
374    .sp
375    to the \fBconfigure\fP command, \fBpcretest\fP is linked with the
376    \fBlibreadline\fP library, and when its input is from a terminal, it reads it
377    using the \fBreadline()\fP function. This provides line-editing and history
378    facilities. Note that \fBlibreadline\fP is GPL-licensed, so if you distribute a
379    binary of \fBpcretest\fP linked in this way, there may be licensing issues.
380  .P  .P
381  .in 0  Setting this option causes the \fB-lreadline\fP option to be added to the
382  Last updated: 30 November 2006  \fBpcretest\fP build. In many operating environments with a sytem-installed
383  .br  \fBlibreadline\fP this is sufficient. However, in some environments (e.g.
384  Copyright (c) 1997-2006 University of Cambridge.  if an unmodified distribution version of readline is in use), some extra
385    configuration may be necessary. The INSTALL file for \fBlibreadline\fP says
386    this:
387    .sp
388      "Readline uses the termcap functions, but does not link with the
389      termcap or curses library itself, allowing applications which link
390      with readline the to choose an appropriate library."
391    .sp
392    If your environment has not been set up so that an appropriate library is
393    automatically included, you may need to add something like
394    .sp
395      LIBS="-ncurses"
396    .sp
397    immediately before the \fBconfigure\fP command.
398    .
399    .
400    .SH "SEE ALSO"
401    .rs
402    .sp
403    \fBpcreapi\fP(3), \fBpcre16\fP, \fBpcre_config\fP(3).
404    .
405    .
406    .SH AUTHOR
407    .rs
408    .sp
409    .nf
410    Philip Hazel
411    University Computing Service
412    Cambridge CB2 3QH, England.
413    .fi
414    .
415    .
416    .SH REVISION
417    .rs
418    .sp
419    .nf
420    Last updated: 07 January 2012
421    Copyright (c) 1997-2012 University of Cambridge.
422    .fi

Legend:
Removed from v.96  
changed lines
  Added in v.857

  ViewVC Help
Powered by ViewVC 1.1.5