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

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

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

revision 211 by ph10, Thu Aug 9 09:52:43 2007 UTC revision 456 by ph10, Fri Oct 2 08:53:31 2009 UTC
# Line 6  PCRE - Perl-compatible regular expressio Line 6  PCRE - Perl-compatible regular expressio
6  .sp  .sp
7  The PCRE library is a set of functions that implement regular expression  The PCRE library is a set of functions that implement regular expression
8  pattern matching using the same syntax and semantics as Perl, with just a few  pattern matching using the same syntax and semantics as Perl, with just a few
9  differences. (Certain features that appeared in Python and PCRE before they  differences. Some features that appeared in Python and PCRE before they
10  appeared in Perl are also available using the Python syntax.)  appeared in Perl are also available using the Python syntax, there is some
11  .P  support for one or two .NET and Oniguruma syntax items, and there is an option
12  The current implementation of PCRE (release 7.x) corresponds approximately with  for requesting some minor changes that give better JavaScript compatibility.
13  Perl 5.10, including support for UTF-8 encoded strings and Unicode general  .P
14  category properties. However, UTF-8 and Unicode support has to be explicitly  The current implementation of PCRE corresponds approximately with Perl 5.10,
15  enabled; it is not the default. The Unicode tables correspond to Unicode  including support for UTF-8 encoded strings and Unicode general category
16  release 5.0.0.  properties. However, UTF-8 and Unicode support has to be explicitly enabled; it
17    is not the default. The Unicode tables correspond to Unicode release 5.1.
18  .P  .P
19  In addition to the Perl-compatible matching function, PCRE contains an  In addition to the Perl-compatible matching function, PCRE contains an
20  alternative matching function that matches the same compiled patterns in a  alternative function that matches the same compiled patterns in a different
21  different way. In certain circumstances, the alternative function has some  way. In certain circumstances, the alternative function has some advantages.
22  advantages. For a discussion of the two matching algorithms, see the  For a discussion of the two matching algorithms, see the
23  .\" HREF  .\" HREF
24  \fBpcrematching\fP  \fBpcrematching\fP
25  .\"  .\"
# Line 64  available. The features themselves are d Line 65  available. The features themselves are d
65  \fBpcrebuild\fP  \fBpcrebuild\fP
66  .\"  .\"
67  page. Documentation about building PCRE for various operating systems can be  page. Documentation about building PCRE for various operating systems can be
68  found in the \fBREADME\fP file in the source distribution.  found in the \fBREADME\fP and \fBNON-UNIX-USE\fP files in the source
69    distribution.
70  .P  .P
71  The library contains a number of undocumented internal functions and data  The library contains a number of undocumented internal functions and data
72  tables that are used by more than one of the exported external functions, but  tables that are used by more than one of the exported external functions, but
# Line 81  not exported. Line 83  not exported.
83  The user documentation for PCRE comprises a number of different sections. In  The user documentation for PCRE comprises a number of different sections. In
84  the "man" format, each of these is a separate "man page". In the HTML format,  the "man" format, each of these is a separate "man page". In the HTML format,
85  each is a separate page, linked from the index page. In the plain text format,  each is a separate page, linked from the index page. In the plain text format,
86  all the sections are concatenated, for ease of searching. The sections are as  all the sections, except the \fBpcredemo\fP section, are concatenated, for ease
87  follows:  of searching. The sections are as follows:
88  .sp  .sp
89    pcre              this document    pcre              this document
90    pcre-config       show PCRE installation configuration information    pcre-config       show PCRE installation configuration information
# Line 91  follows: Line 93  follows:
93    pcrecallout       details of the callout feature    pcrecallout       details of the callout feature
94    pcrecompat        discussion of Perl compatibility    pcrecompat        discussion of Perl compatibility
95    pcrecpp           details of the C++ wrapper    pcrecpp           details of the C++ wrapper
96      pcredemo          a demonstration C program that uses PCRE
97    pcregrep          description of the \fBpcregrep\fP command    pcregrep          description of the \fBpcregrep\fP command
98    pcrematching      discussion of the two matching algorithms    pcrematching      discussion of the two matching algorithms
99    pcrepartial       details of the partial matching facility    pcrepartial       details of the partial matching facility
100  .\" JOIN  .\" JOIN
101    pcrepattern       syntax and semantics of supported    pcrepattern       syntax and semantics of supported
102                        regular expressions                        regular expressions
   pcresyntax        quick syntax reference  
103    pcreperform       discussion of performance issues    pcreperform       discussion of performance issues
104    pcreposix         the POSIX-compatible C API    pcreposix         the POSIX-compatible C API
105    pcreprecompile    details of saving and re-using precompiled patterns    pcreprecompile    details of saving and re-using precompiled patterns
106    pcresample        discussion of the sample program    pcresample        discussion of the pcredemo program
107    pcrestack         discussion of stack usage    pcrestack         discussion of stack usage
108      pcresyntax        quick syntax reference
109    pcretest          description of the \fBpcretest\fP testing command    pcretest          description of the \fBpcretest\fP testing command
110  .sp  .sp
111  In addition, in the "man" and HTML formats, there is a short page for each  In addition, in the "man" and HTML formats, there is a short page for each
# Line 145  issues, see the Line 148  issues, see the
148  .\"  .\"
149  documentation.  documentation.
150  .  .
 .\" HTML <a name="utf8support"></a>  
151  .  .
152    .\" HTML <a name="utf8support"></a>
153  .  .
154  .SH "UTF-8 AND UNICODE PROPERTY SUPPORT"  .SH "UTF-8 AND UNICODE PROPERTY SUPPORT"
155  .rs  .rs
# Line 161  the code, and, in addition, you must cal Line 164  the code, and, in addition, you must cal
164  .\" HREF  .\" HREF
165  \fBpcre_compile()\fP  \fBpcre_compile()\fP
166  .\"  .\"
167  with the PCRE_UTF8 option flag. When you do this, both the pattern and any  with the PCRE_UTF8 option flag, or the pattern must start with the sequence
168  subject strings that are matched against it are treated as UTF-8 strings  (*UTF8). When either of these is the case, both the pattern and any subject
169  instead of just strings of bytes.  strings that are matched against it are treated as UTF-8 strings instead of
170    strings of 1-byte characters.
171  .P  .P
172  If you compile PCRE with UTF-8 support, but do not use it at run time, the  If you compile PCRE with UTF-8 support, but do not use it at run time, the
173  library will be a bit bigger, but the additional run time overhead is limited  library will be a bit bigger, but the additional run time overhead is limited
# Line 183  documentation. Only the short names for Line 187  documentation. Only the short names for
187  Furthermore, in Perl, many properties may optionally be prefixed by "Is", for  Furthermore, in Perl, many properties may optionally be prefixed by "Is", for
188  compatibility with Perl 5.6. PCRE does not support this.  compatibility with Perl 5.6. PCRE does not support this.
189  .  .
190    .
191  .\" HTML <a name="utf8strings"></a>  .\" HTML <a name="utf8strings"></a>
192  .  .
193  .SS "Validity of UTF-8 strings"  .SS "Validity of UTF-8 strings"
# Line 250  digits, spaces, or word characters remai Line 255  digits, spaces, or word characters remai
255  values less than 256. This remains true even when PCRE includes Unicode  values less than 256. This remains true even when PCRE includes Unicode
256  property support, because to do otherwise would slow down PCRE in many common  property support, because to do otherwise would slow down PCRE in many common
257  cases. If you really want to test for a wider sense of, say, "digit", you  cases. If you really want to test for a wider sense of, say, "digit", you
258  must use Unicode property tests such as \ep{Nd}.  must use Unicode property tests such as \ep{Nd}. Note that this also applies to
259    \eb, because it is defined in terms of \ew and \eW.
260  .P  .P
261  7. Similarly, characters that match the POSIX named character classes are all  7. Similarly, characters that match the POSIX named character classes are all
262  low-valued characters.  low-valued characters.
# Line 287  two digits 10, at the domain cam.ac.uk. Line 293  two digits 10, at the domain cam.ac.uk.
293  .rs  .rs
294  .sp  .sp
295  .nf  .nf
296  Last updated: 09 August 2007  Last updated: 28 September 2009
297  Copyright (c) 1997-2007 University of Cambridge.  Copyright (c) 1997-2009 University of Cambridge.
298  .fi  .fi

Legend:
Removed from v.211  
changed lines
  Added in v.456

  ViewVC Help
Powered by ViewVC 1.1.5