| blob | c7bc196b669c8ddc881524a8380538b8f6d21083 |
1 <html>
2 <!-- This is a manually maintained file that is the root of the HTML version of
3 the PCRE documentation. When the HTML documents are built from the man
4 page versions, the entire doc/html directory is emptied, this file is then
5 copied into doc/html/index.html, and the remaining files therein are
6 created by the 132html script.
7 -->
8 <head>
9 <title>PCRE specification</title>
10 </head>
11 <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
12 <h1>Perl-compatible Regular Expressions (PCRE)</h1>
13 <p>
14 The HTML documentation for PCRE comprises the following pages:
15 </p>
17 <table>
18 <tr><td><a href="pcre.html">pcre</a></td>
19 <td> Introductory page</td></tr>
21 <tr><td><a href="pcre16.html">pcre16</a></td>
22 <td> Discussion of the 16-bit PCRE library</td></tr>
24 <tr><td><a href="pcre32.html">pcre32</a></td>
25 <td> Discussion of the 32-bit PCRE library</td></tr>
27 <tr><td><a href="pcre-config.html">pcre-config</a></td>
28 <td> Information about the installation configuration</td></tr>
30 <tr><td><a href="pcreapi.html">pcreapi</a></td>
31 <td> PCRE's native API</td></tr>
33 <tr><td><a href="pcrebuild.html">pcrebuild</a></td>
34 <td> Options for building PCRE</td></tr>
36 <tr><td><a href="pcrecallout.html">pcrecallout</a></td>
37 <td> The <i>callout</i> facility</td></tr>
39 <tr><td><a href="pcrecompat.html">pcrecompat</a></td>
40 <td> Compability with Perl</td></tr>
42 <tr><td><a href="pcrecpp.html">pcrecpp</a></td>
43 <td> The C++ wrapper for the PCRE library</td></tr>
45 <tr><td><a href="pcredemo.html">pcredemo</a></td>
46 <td> A demonstration C program that uses the PCRE library</td></tr>
48 <tr><td><a href="pcregrep.html">pcregrep</a></td>
49 <td> The <b>pcregrep</b> command</td></tr>
51 <tr><td><a href="pcrejit.html">pcrejit</a></td>
52 <td> Discussion of the just-in-time optimization support</td></tr>
54 <tr><td><a href="pcrelimits.html">pcrelimits</a></td>
55 <td> Details of size and other limits</td></tr>
57 <tr><td><a href="pcrematching.html">pcrematching</a></td>
58 <td> Discussion of the two matching algorithms</td></tr>
60 <tr><td><a href="pcrepartial.html">pcrepartial</a></td>
61 <td> Using PCRE for partial matching</td></tr>
63 <tr><td><a href="pcrepattern.html">pcrepattern</a></td>
64 <td> Specification of the regular expressions supported by PCRE</td></tr>
66 <tr><td><a href="pcreperform.html">pcreperform</a></td>
67 <td> Some comments on performance</td></tr>
69 <tr><td><a href="pcreposix.html">pcreposix</a></td>
70 <td> The POSIX API to the PCRE library</td></tr>
72 <tr><td><a href="pcreprecompile.html">pcreprecompile</a></td>
73 <td> How to save and re-use compiled patterns</td></tr>
75 <tr><td><a href="pcresample.html">pcresample</a></td>
76 <td> Discussion of the pcredemo program</td></tr>
78 <tr><td><a href="pcrestack.html">pcrestack</a></td>
79 <td> Discussion of PCRE's stack usage</td></tr>
81 <tr><td><a href="pcresyntax.html">pcresyntax</a></td>
82 <td> Syntax quick-reference summary</td></tr>
84 <tr><td><a href="pcretest.html">pcretest</a></td>
85 <td> The <b>pcretest</b> command for testing PCRE</td></tr>
87 <tr><td><a href="pcreunicode.html">pcreunicode</a></td>
88 <td> Discussion of Unicode and UTF-8/UTF-16/UTF-32 support</td></tr>
89 </table>
91 <p>
92 There are also individual pages that summarize the interface for each function
93 in the library. There is a single page for each triple of 8-bit/16-bit/32-bit
94 functions.
95 </p>
97 <table>
99 <tr><td><a href="pcre_assign_jit_stack.html">pcre_assign_jit_stack</a></td>
100 <td> Assign stack for JIT matching</td></tr>
102 <tr><td><a href="pcre_compile.html">pcre_compile</a></td>
103 <td> Compile a regular expression</td></tr>
105 <tr><td><a href="pcre_compile2.html">pcre_compile2</a></td>
106 <td> Compile a regular expression (alternate interface)</td></tr>
108 <tr><td><a href="pcre_config.html">pcre_config</a></td>
109 <td> Show build-time configuration options</td></tr>
111 <tr><td><a href="pcre_copy_named_substring.html">pcre_copy_named_substring</a></td>
112 <td> Extract named substring into given buffer</td></tr>
114 <tr><td><a href="pcre_copy_substring.html">pcre_copy_substring</a></td>
115 <td> Extract numbered substring into given buffer</td></tr>
117 <tr><td><a href="pcre_dfa_exec.html">pcre_dfa_exec</a></td>
118 <td> Match a compiled pattern to a subject string
119 (DFA algorithm; <i>not</i> Perl compatible)</td></tr>
121 <tr><td><a href="pcre_free_study.html">pcre_free_study</a></td>
122 <td> Free study data</td></tr>
124 <tr><td><a href="pcre_exec.html">pcre_exec</a></td>
125 <td> Match a compiled pattern to a subject string
126 (Perl compatible)</td></tr>
128 <tr><td><a href="pcre_free_substring.html">pcre_free_substring</a></td>
129 <td> Free extracted substring</td></tr>
131 <tr><td><a href="pcre_free_substring_list.html">pcre_free_substring_list</a></td>
132 <td> Free list of extracted substrings</td></tr>
134 <tr><td><a href="pcre_fullinfo.html">pcre_fullinfo</a></td>
135 <td> Extract information about a pattern</td></tr>
137 <tr><td><a href="pcre_get_named_substring.html">pcre_get_named_substring</a></td>
138 <td> Extract named substring into new memory</td></tr>
140 <tr><td><a href="pcre_get_stringnumber.html">pcre_get_stringnumber</a></td>
141 <td> Convert captured string name to number</td></tr>
143 <tr><td><a href="pcre_get_substring.html">pcre_get_substring</a></td>
144 <td> Extract numbered substring into new memory</td></tr>
146 <tr><td><a href="pcre_get_substring_list.html">pcre_get_substring_list</a></td>
147 <td> Extract all substrings into new memory</td></tr>
149 <tr><td><a href="pcre_info.html">pcre_info</a></td>
150 <td> Obsolete information extraction function</td></tr>
152 <tr><td><a href="pcre_jit_stack_alloc.html">pcre_jit_stack_alloc</a></td>
153 <td> Create a stack for JIT matching</td></tr>
155 <tr><td><a href="pcre_jit_stack_free.html">pcre_jit_stack_free</a></td>
156 <td> Free a JIT matching stack</td></tr>
158 <tr><td><a href="pcre_maketables.html">pcre_maketables</a></td>
159 <td> Build character tables in current locale</td></tr>
161 <tr><td><a href="pcre_pattern_to_host_byte_order.html">pcre_pattern_to_host_byte_order</a></td>
162 <td> Convert compiled pattern to host byte order if necessary</td></tr>
164 <tr><td><a href="pcre_refcount.html">pcre_refcount</a></td>
165 <td> Maintain reference count in compiled pattern</td></tr>
167 <tr><td><a href="pcre_study.html">pcre_study</a></td>
168 <td> Study a compiled pattern</td></tr>
170 <tr><td><a href="pcre_utf16_to_host_byte_order.html">pcre_utf16_to_host_byte_order</a></td>
171 <td> Convert UTF-16 string to host byte order if necessary</td></tr>
173 <tr><td><a href="pcre_utf32_to_host_byte_order.html">pcre_utf32_to_host_byte_order</a></td>
174 <td> Convert UTF-32 string to host byte order if necessary</td></tr>
176 <tr><td><a href="pcre_version.html">pcre_version</a></td>
177 <td> Return PCRE version and release date</td></tr>
178 </table>
180 </html>