/[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 77 by nigel, Sat Feb 24 21:40:45 2007 UTC revision 149 by ph10, Mon Apr 16 15:28:08 2007 UTC
# Line 1  Line 1 
1  .TH PCRE 3  .TH PCREBUILD 3
2  .SH NAME  .SH NAME
3  PCRE - Perl-compatible regular expressions  PCRE - Perl-compatible regular expressions
4  .SH "PCRE BUILD-TIME OPTIONS"  .SH "PCRE BUILD-TIME OPTIONS"
# Line 13  obtained by running Line 13  obtained by running
13  .sp  .sp
14    ./configure --help    ./configure --help
15  .sp  .sp
16  The following sections describe certain options whose names begin with --enable  The following sections include descriptions of options whose names begin with
17  or --disable. These settings specify changes to the defaults for the  --enable or --disable. These settings specify changes to the defaults for the
18  \fBconfigure\fP command. Because of the way that \fBconfigure\fP works,  \fBconfigure\fP command. Because of the way that \fBconfigure\fP works,
19  --enable and --disable always come in pairs, so the complementary option always  --enable and --disable always come in pairs, so the complementary option always
20  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.
21  .  .
22    .SH "C++ SUPPORT"
23    .rs
24    .sp
25    By default, the \fBconfigure\fP script will search for a C++ compiler and C++
26    header files. If it finds them, it automatically builds the C++ wrapper library
27    for PCRE. You can disable this by adding
28    .sp
29      --disable-cpp
30    .sp
31    to the \fBconfigure\fP command.
32    .
33  .SH "UTF-8 SUPPORT"  .SH "UTF-8 SUPPORT"
34  .rs  .rs
35  .sp  .sp
# Line 45  character properties, you must add Line 56  character properties, you must add
56  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
57  not explicitly requested it.  not explicitly requested it.
58  .P  .P
59  Including Unicode property support adds around 90K of tables to the PCRE  Including Unicode property support adds around 30K of tables to the PCRE
60  library, approximately doubling its size. Only the general category properties  library. Only the general category properties such as \fILu\fP and \fINd\fP are
61  such as \fILu\fP and \fINd\fP are supported. Details are given in the  supported. Details are given in the
62  .\" HREF  .\" HREF
63  \fBpcrepattern\fP  \fBpcrepattern\fP
64  .\"  .\"
# Line 56  documentation. Line 67  documentation.
67  .SH "CODE VALUE OF NEWLINE"  .SH "CODE VALUE OF NEWLINE"
68  .rs  .rs
69  .sp  .sp
70  By default, PCRE treats character 10 (linefeed) as the newline character. This  By default, PCRE interprets character 10 (linefeed, LF) as indicating the end
71  is the normal newline character on Unix-like systems. You can compile PCRE to  of a line. This is the normal newline character on Unix-like systems. You can
72  use character 13 (carriage return) instead by adding  compile PCRE to use character 13 (carriage return, CR) instead, by adding
73  .sp  .sp
74    --enable-newline-is-cr    --enable-newline-is-cr
75  .sp  .sp
76  to the \fBconfigure\fP command. For completeness there is also a  to the \fBconfigure\fP command. There is also a --enable-newline-is-lf option,
77  --enable-newline-is-lf option, which explicitly specifies linefeed as the  which explicitly specifies linefeed as the newline character.
78  newline character.  .sp
79    Alternatively, you can specify that line endings are to be indicated by the two
80    character sequence CRLF. If you want this, add
81    .sp
82      --enable-newline-is-crlf
83    .sp
84    to the \fBconfigure\fP command. There is a fourth option, specified by
85    .sp
86      --enable-newline-is-anycrlf
87    .sp
88    which causes PCRE to recognize any of the three sequences CR, LF, or CRLF as
89    indicating a line ending. Finally, a fifth option, specified by
90    .sp
91      --enable-newline-is-any
92    .sp
93    causes PCRE to recognize any Unicode newline sequence.
94    .P
95    Whatever line ending convention is selected when PCRE is built can be
96    overridden when the library functions are called. At build time it is
97    conventional to use the standard for your operating system.
98  .  .
99  .SH "BUILDING SHARED AND STATIC LIBRARIES"  .SH "BUILDING SHARED AND STATIC LIBRARIES"
100  .rs  .rs
# Line 96  such as Line 126  such as
126  .sp  .sp
127  to the \fBconfigure\fP command.  to the \fBconfigure\fP command.
128  .  .
 .SH "LIMITING PCRE RESOURCE USAGE"  
 .rs  
 .sp  
 Internally, PCRE has a function called \fBmatch()\fP, which it calls repeatedly  
 (possibly recursively) when matching a pattern with the \fBpcre_exec()\fP  
 function. By controlling the maximum number of times this function may be  
 called during a single matching operation, a limit can be placed on the  
 resources used by a single call to \fBpcre_exec()\fP. The limit can be changed  
 at run time, as described in the  
 .\" HREF  
 \fBpcreapi\fP  
 .\"  
 documentation. The default is 10 million, but this can be changed by adding a  
 setting such as  
 .sp  
   --with-match-limit=500000  
 .sp  
 to the \fBconfigure\fP command. This setting has no effect on the  
 \fBpcre_dfa_exec()\fP matching function.  
 .  
129  .SH "HANDLING VERY LARGE PATTERNS"  .SH "HANDLING VERY LARGE PATTERNS"
130  .rs  .rs
131  .sp  .sp
# Line 132  or four-byte offsets by adding a setting Line 142  or four-byte offsets by adding a setting
142  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
143  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
144  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.  
145  .  .
146  .SH "AVOIDING EXCESSIVE STACK USAGE"  .SH "AVOIDING EXCESSIVE STACK USAGE"
147  .rs  .rs
# Line 144  When matching with the \fBpcre_exec()\fP Line 150  When matching with the \fBpcre_exec()\fP
150  by making recursive calls to an internal function called \fBmatch()\fP. In  by making recursive calls to an internal function called \fBmatch()\fP. In
151  environments where the size of the stack is limited, this can severely limit  environments where the size of the stack is limited, this can severely limit
152  PCRE's operation. (The Unix environment does not usually suffer from this  PCRE's operation. (The Unix environment does not usually suffer from this
153  problem.) An alternative approach that uses memory from the heap to remember  problem, but it may sometimes be necessary to increase the maximum stack size.
154  data, instead of using recursive function calls, has been implemented to work  There is a discussion in the
155  round this problem. If you want to build a version of PCRE that works this way,  .\" HREF
156  add  \fBpcrestack\fP
157    .\"
158    documentation.) An alternative approach to recursion that uses memory from the
159    heap to remember data, instead of using recursive function calls, has been
160    implemented to work round the problem of limited stack size. If you want to
161    build a version of PCRE that works this way, add
162  .sp  .sp
163    --disable-stack-for-recursion    --disable-stack-for-recursion
164  .sp  .sp
# Line 161  optimized functions that perform better Line 172  optimized functions that perform better
172  way. This option affects only the \fBpcre_exec()\fP function; it is not  way. This option affects only the \fBpcre_exec()\fP function; it is not
173  relevant for the the \fBpcre_dfa_exec()\fP function.  relevant for the the \fBpcre_dfa_exec()\fP function.
174  .  .
175    .SH "LIMITING PCRE RESOURCE USAGE"
176    .rs
177    .sp
178    Internally, PCRE has a function called \fBmatch()\fP, which it calls repeatedly
179    (sometimes recursively) when matching a pattern with the \fBpcre_exec()\fP
180    function. By controlling the maximum number of times this function may be
181    called during a single matching operation, a limit can be placed on the
182    resources used by a single call to \fBpcre_exec()\fP. The limit can be changed
183    at run time, as described in the
184    .\" HREF
185    \fBpcreapi\fP
186    .\"
187    documentation. The default is 10 million, but this can be changed by adding a
188    setting such as
189    .sp
190      --with-match-limit=500000
191    .sp
192    to the \fBconfigure\fP command. This setting has no effect on the
193    \fBpcre_dfa_exec()\fP matching function.
194    .P
195    In some environments it is desirable to limit the depth of recursive calls of
196    \fBmatch()\fP more strictly than the total number of calls, in order to
197    restrict the maximum amount of stack (or heap, if --disable-stack-for-recursion
198    is specified) that is used. A second limit controls this; it defaults to the
199    value that is set for --with-match-limit, which imposes no additional
200    constraints. However, you can set a lower limit by adding, for example,
201    .sp
202      --with-match-limit-recursion=10000
203    .sp
204    to the \fBconfigure\fP command. This value can also be overridden at run time.
205    .
206    .SH "CREATING CHARACTER TABLES AT BUILD TIME"
207    .rs
208    .sp
209    PCRE uses fixed tables for processing characters whose code values are less
210    than 256. By default, PCRE is built with a set of tables that are distributed
211    in the file \fIpcre_chartables.c.dist\fP. These tables are for ASCII codes
212    only. If you add
213    .sp
214      --enable-rebuild-chartables
215    .sp
216    to the \fBconfigure\fP command, the distributed tables are no longer used.
217    Instead, a program called \fBdftables\fP is compiled and run. This outputs the
218    source for new set of tables, created in the default locale of your C runtime
219    system. (This method of replacing the tables does not work if you are cross
220    compiling, because \fBdftables\fP is run on the local host. If you need to
221    create alternative tables when cross compiling, you will have to do so "by
222    hand".)
223    .
224  .SH "USING EBCDIC CODE"  .SH "USING EBCDIC CODE"
225  .rs  .rs
226  .sp  .sp
# Line 170  compiled to run in an EBCDIC environment Line 230  compiled to run in an EBCDIC environment
230  .sp  .sp
231    --enable-ebcdic    --enable-ebcdic
232  .sp  .sp
233  to the \fBconfigure\fP command.  to the \fBconfigure\fP command. This setting implies
234  .P  --enable-rebuild-chartables.
235  .in 0  .
236  Last updated: 28 February 2005  .
237  .br  .SH "SEE ALSO"
238  Copyright (c) 1997-2005 University of Cambridge.  .rs
239    .sp
240    \fBpcreapi\fP(3), \fBpcre_config\fP(3).
241    .
242    .
243    .SH AUTHOR
244    .rs
245    .sp
246    .nf
247    Philip Hazel
248    University Computing Service
249    Cambridge CB2 3QH, England.
250    .fi
251    .
252    .
253    .SH REVISION
254    .rs
255    .sp
256    .nf
257    Last updated: 16 April 2007
258    Copyright (c) 1997-2007 University of Cambridge.
259    .fi

Legend:
Removed from v.77  
changed lines
  Added in v.149

  ViewVC Help
Powered by ViewVC 1.1.5