/[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 436 by ph10, Sun Sep 6 16:23:55 2009 UTC
# Line 5  PCRE - Perl-compatible regular expressio Line 5  PCRE - Perl-compatible regular expressio
5  .rs  .rs
6  .sp  .sp
7  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
8  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
9  options to the \fBconfigure\fP script that is run before the \fBmake\fP  the optional features are selected or deselected by providing options to
10  command. The complete list of options for \fBconfigure\fP (which includes the  \fBconfigure\fP before running the \fBmake\fP command. However, the same
11  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
12  obtained by running  the GUI facility of \fBcmake-gui\fP if you are using \fBCMake\fP instead of
13    \fBconfigure\fP to build PCRE.
14    .P
15    There is a lot more information about building PCRE in non-Unix-like
16    environments in the file called \fINON_UNIX_USE\fP, which is part of the PCRE
17    distribution. You should consult this file as well as the \fIREADME\fP file if
18    you are building in a non-Unix-like environment.
19    .P
20    The complete list of options for \fBconfigure\fP (which includes the standard
21    ones such as the selection of the installation directory) can be obtained by
22    running
23  .sp  .sp
24    ./configure --help    ./configure --help
25  .sp  .sp
26  The following sections describe certain options whose names begin with --enable  The following sections include descriptions of options whose names begin with
27  or --disable. These settings specify changes to the defaults for the  --enable or --disable. These settings specify changes to the defaults for the
28  \fBconfigure\fP command. Because of the way that \fBconfigure\fP works,  \fBconfigure\fP command. Because of the way that \fBconfigure\fP works,
29  --enable and --disable always come in pairs, so the complementary option always  --enable and --disable always come in pairs, so the complementary option always
30  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.
# Line 33  to the \fBconfigure\fP command. Line 43  to the \fBconfigure\fP command.
43  .SH "UTF-8 SUPPORT"  .SH "UTF-8 SUPPORT"
44  .rs  .rs
45  .sp  .sp
46  To build PCRE with support for UTF-8 character strings, add  To build PCRE with support for UTF-8 Unicode character strings, add
47  .sp  .sp
48    --enable-utf8    --enable-utf8
49  .sp  .sp
# Line 41  to the \fBconfigure\fP command. Of itsel Line 51  to the \fBconfigure\fP command. Of itsel
51  strings as UTF-8. As well as compiling PCRE with this option, you also have  strings as UTF-8. As well as compiling PCRE with this option, you also have
52  have to set the PCRE_UTF8 option when you call the \fBpcre_compile()\fP  have to set the PCRE_UTF8 option when you call the \fBpcre_compile()\fP
53  function.  function.
54    .P
55    If you set --enable-utf8 when compiling in an EBCDIC environment, PCRE expects
56    its input to be either ASCII or UTF-8 (depending on the runtime option). It is
57    not possible to support both EBCDIC and UTF-8 codes in the same version of the
58    library. Consequently, --enable-utf8 and --enable-ebcdic are mutually
59    exclusive.
60  .  .
61  .SH "UNICODE CHARACTER PROPERTY SUPPORT"  .SH "UNICODE CHARACTER PROPERTY SUPPORT"
62  .rs  .rs
# Line 56  character properties, you must add Line 72  character properties, you must add
72  to the \fBconfigure\fP command. This implies UTF-8 support, even if you have  to the \fBconfigure\fP command. This implies UTF-8 support, even if you have
73  not explicitly requested it.  not explicitly requested it.
74  .P  .P
75  Including Unicode property support adds around 90K of tables to the PCRE  Including Unicode property support adds around 30K of tables to the PCRE
76  library, approximately doubling its size. Only the general category properties  library. Only the general category properties such as \fILu\fP and \fINd\fP are
77  such as \fILu\fP and \fINd\fP are supported. Details are given in the  supported. Details are given in the
78  .\" HREF  .\" HREF
79  \fBpcrepattern\fP  \fBpcrepattern\fP
80  .\"  .\"
# Line 67  documentation. Line 83  documentation.
83  .SH "CODE VALUE OF NEWLINE"  .SH "CODE VALUE OF NEWLINE"
84  .rs  .rs
85  .sp  .sp
86  By default, PCRE interprets character 10 (linefeed, LF) as indicating the end  By default, PCRE interprets the linefeed (LF) character as indicating the end
87  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
88  compile PCRE to use character 13 (carriage return, CR) instead, by adding  compile PCRE to use carriage return (CR) instead, by adding
89  .sp  .sp
90    --enable-newline-is-cr    --enable-newline-is-cr
91  .sp  .sp
# Line 83  character sequence CRLF. If you want thi Line 99  character sequence CRLF. If you want thi
99  .sp  .sp
100  to the \fBconfigure\fP command. There is a fourth option, specified by  to the \fBconfigure\fP command. There is a fourth option, specified by
101  .sp  .sp
102      --enable-newline-is-anycrlf
103    .sp
104    which causes PCRE to recognize any of the three sequences CR, LF, or CRLF as
105    indicating a line ending. Finally, a fifth option, specified by
106    .sp
107    --enable-newline-is-any    --enable-newline-is-any
108  .sp  .sp
109  which causes PCRE to recognize any Unicode newline sequence.  causes PCRE to recognize any Unicode newline sequence.
110  .P  .P
111  Whatever line ending convention is selected when PCRE is built can be  Whatever line ending convention is selected when PCRE is built can be
112  overridden when the library functions are called. At build time it is  overridden when the library functions are called. At build time it is
113  conventional to use the standard for your operating system.  conventional to use the standard for your operating system.
114  .  .
115    .SH "WHAT \eR MATCHES"
116    .rs
117    .sp
118    By default, the sequence \eR in a pattern matches any Unicode newline sequence,
119    whatever has been selected as the line ending sequence. If you specify
120    .sp
121      --enable-bsr-anycrlf
122    .sp
123    the default is changed so that \eR matches only CR, LF, or CRLF. Whatever is
124    selected when PCRE is built can be overridden when the library functions are
125    called.
126    .
127  .SH "BUILDING SHARED AND STATIC LIBRARIES"  .SH "BUILDING SHARED AND STATIC LIBRARIES"
128  .rs  .rs
129  .sp  .sp
# Line 137  or four-byte offsets by adding a setting Line 170  or four-byte offsets by adding a setting
170  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. Using
171  longer offsets slows down the operation of PCRE because it has to load  longer offsets slows down the operation of PCRE because it has to load
172  additional bytes when handling them.  additional bytes when handling them.
 .P  
 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.  
173  .  .
174  .SH "AVOIDING EXCESSIVE STACK USAGE"  .SH "AVOIDING EXCESSIVE STACK USAGE"
175  .rs  .rs
# Line 163  build a version of PCRE that works this Line 192  build a version of PCRE that works this
192  .sp  .sp
193  to the \fBconfigure\fP command. With this configuration, PCRE will use the  to the \fBconfigure\fP command. With this configuration, PCRE will use the
194  \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
195  management functions. Separate functions are provided because the usage is very  management functions. By default these point to \fBmalloc()\fP and
196  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
197  always freed in reverse order. A calling program might be able to implement  used.
198  optimized functions that perform better than the standard \fBmalloc()\fP and  .P
199  \fBfree()\fP functions. PCRE runs noticeably more slowly when built in this  Separate functions are provided rather than using \fBpcre_malloc\fP and
200  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
201  relevant for the the \fBpcre_dfa_exec()\fP function.  requested are always the same, and the blocks are always freed in reverse
202    order. A calling program might be able to implement optimized functions that
203    perform better than \fBmalloc()\fP and \fBfree()\fP. PCRE runs noticeably more
204    slowly when built in this way. This option affects only the \fBpcre_exec()\fP
205    function; it is not relevant for the the \fBpcre_dfa_exec()\fP function.
206  .  .
207  .SH "LIMITING PCRE RESOURCE USAGE"  .SH "LIMITING PCRE RESOURCE USAGE"
208  .rs  .rs
# Line 202  constraints. However, you can set a lowe Line 235  constraints. However, you can set a lowe
235  .sp  .sp
236  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.
237  .  .
238    .SH "CREATING CHARACTER TABLES AT BUILD TIME"
239    .rs
240    .sp
241    PCRE uses fixed tables for processing characters whose code values are less
242    than 256. By default, PCRE is built with a set of tables that are distributed
243    in the file \fIpcre_chartables.c.dist\fP. These tables are for ASCII codes
244    only. If you add
245    .sp
246      --enable-rebuild-chartables
247    .sp
248    to the \fBconfigure\fP command, the distributed tables are no longer used.
249    Instead, a program called \fBdftables\fP is compiled and run. This outputs the
250    source for new set of tables, created in the default locale of your C runtime
251    system. (This method of replacing the tables does not work if you are cross
252    compiling, because \fBdftables\fP is run on the local host. If you need to
253    create alternative tables when cross compiling, you will have to do so "by
254    hand".)
255    .
256  .SH "USING EBCDIC CODE"  .SH "USING EBCDIC CODE"
257  .rs  .rs
258  .sp  .sp
259  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
260  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
261  compiled to run in an EBCDIC environment by adding  most computer operating systems. PCRE can, however, be compiled to run in an
262    EBCDIC environment by adding
263  .sp  .sp
264    --enable-ebcdic    --enable-ebcdic
265  .sp  .sp
266  to the \fBconfigure\fP command.  to the \fBconfigure\fP command. This setting implies
267    --enable-rebuild-chartables. You should only use it if you know that you are in
268    an EBCDIC environment (for example, an IBM mainframe operating system). The
269    --enable-ebcdic option is incompatible with --enable-utf8.
270    .
271    .SH "PCREGREP OPTIONS FOR COMPRESSED FILE SUPPORT"
272    .rs
273    .sp
274    By default, \fBpcregrep\fP reads all files as plain text. You can build it so
275    that it recognizes files whose names end in \fB.gz\fP or \fB.bz2\fP, and reads
276    them with \fBlibz\fP or \fBlibbz2\fP, respectively, by adding one or both of
277    .sp
278      --enable-pcregrep-libz
279      --enable-pcregrep-libbz2
280    .sp
281    to the \fBconfigure\fP command. These options naturally require that the
282    relevant libraries are installed on your system. Configuration will fail if
283    they are not.
284    .
285    .SH "PCRETEST OPTION FOR LIBREADLINE SUPPORT"
286    .rs
287    .sp
288    If you add
289    .sp
290      --enable-pcretest-libreadline
291    .sp
292    to the \fBconfigure\fP command, \fBpcretest\fP is linked with the
293    \fBlibreadline\fP library, and when its input is from a terminal, it reads it
294    using the \fBreadline()\fP function. This provides line-editing and history
295    facilities. Note that \fBlibreadline\fP is GPL-licenced, so if you distribute a
296    binary of \fBpcretest\fP linked in this way, there may be licensing issues.
297    .P
298    Setting this option causes the \fB-lreadline\fP option to be added to the
299    \fBpcretest\fP build. In many operating environments with a sytem-installed
300    \fBlibreadline\fP this is sufficient. However, in some environments (e.g.
301    if an unmodified distribution version of readline is in use), some extra
302    configuration may be necessary. The INSTALL file for \fBlibreadline\fP says
303    this:
304    .sp
305      "Readline uses the termcap functions, but does not link with the
306      termcap or curses library itself, allowing applications which link
307      with readline the to choose an appropriate library."
308    .sp
309    If your environment has not been set up so that an appropriate library is
310    automatically included, you may need to add something like
311    .sp
312      LIBS="-ncurses"
313    .sp
314    immediately before the \fBconfigure\fP command.
315  .  .
316  .  .
317  .SH "SEE ALSO"  .SH "SEE ALSO"
318  .rs  .rs
319  .sp  .sp
320  \fBpcreapi\fP(3), \fBpcre_config\fP(3).  \fBpcreapi\fP(3), \fBpcre_config\fP(3).
321  .P  .
322  .in 0  .
323  Last updated: 30 November 2006  .SH AUTHOR
324  .br  .rs
325  Copyright (c) 1997-2006 University of Cambridge.  .sp
326    .nf
327    Philip Hazel
328    University Computing Service
329    Cambridge CB2 3QH, England.
330    .fi
331    .
332    .
333    .SH REVISION
334    .rs
335    .sp
336    .nf
337    Last updated: 06 September 2009
338    Copyright (c) 1997-2009 University of Cambridge.
339    .fi

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

  ViewVC Help
Powered by ViewVC 1.1.5