blob: fc93ed07816a60b95a2d2561cc5f24ee338c0768 [file] [log] [blame]
Tristan Matthews04616462013-11-14 16:09:34 -05001<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>
14The HTML documentation for PCRE comprises the following pages:
15</p>
16
17<table>
18<tr><td><a href="pcre.html">pcre</a></td>
19 <td>&nbsp;&nbsp;Introductory page</td></tr>
20
21<tr><td><a href="pcre-config.html">pcre-config</a></td>
22 <td>&nbsp;&nbsp;Information about the installation configuration</td></tr>
23
24<tr><td><a href="pcreapi.html">pcreapi</a></td>
25 <td>&nbsp;&nbsp;PCRE's native API</td></tr>
26
27<tr><td><a href="pcrebuild.html">pcrebuild</a></td>
28 <td>&nbsp;&nbsp;Options for building PCRE</td></tr>
29
30<tr><td><a href="pcrecallout.html">pcrecallout</a></td>
31 <td>&nbsp;&nbsp;The <i>callout</i> facility</td></tr>
32
33<tr><td><a href="pcrecompat.html">pcrecompat</a></td>
34 <td>&nbsp;&nbsp;Compability with Perl</td></tr>
35
36<tr><td><a href="pcrecpp.html">pcrecpp</a></td>
37 <td>&nbsp;&nbsp;The C++ wrapper for the PCRE library</td></tr>
38
39<tr><td><a href="pcredemo.html">pcredemo</a></td>
40 <td>&nbsp;&nbsp;A demonstration C program that uses the PCRE library</td></tr>
41
42<tr><td><a href="pcregrep.html">pcregrep</a></td>
43 <td>&nbsp;&nbsp;The <b>pcregrep</b> command</td></tr>
44
45<tr><td><a href="pcrejit.html">pcrejit</a></td>
46 <td>&nbsp;&nbsp;Discussion of the just-in-time optimization support</td></tr>
47
48<tr><td><a href="pcrelimits.html">pcrelimits</a></td>
49 <td>&nbsp;&nbsp;Details of size and other limits</td></tr>
50
51<tr><td><a href="pcrematching.html">pcrematching</a></td>
52 <td>&nbsp;&nbsp;Discussion of the two matching algorithms</td></tr>
53
54<tr><td><a href="pcrepartial.html">pcrepartial</a></td>
55 <td>&nbsp;&nbsp;Using PCRE for partial matching</td></tr>
56
57<tr><td><a href="pcrepattern.html">pcrepattern</a></td>
58 <td>&nbsp;&nbsp;Specification of the regular expressions supported by PCRE</td></tr>
59
60<tr><td><a href="pcreperform.html">pcreperform</a></td>
61 <td>&nbsp;&nbsp;Some comments on performance</td></tr>
62
63<tr><td><a href="pcreposix.html">pcreposix</a></td>
64 <td>&nbsp;&nbsp;The POSIX API to the PCRE library</td></tr>
65
66<tr><td><a href="pcreprecompile.html">pcreprecompile</a></td>
67 <td>&nbsp;&nbsp;How to save and re-use compiled patterns</td></tr>
68
69<tr><td><a href="pcresample.html">pcresample</a></td>
70 <td>&nbsp;&nbsp;Discussion of the pcredemo program</td></tr>
71
72<tr><td><a href="pcrestack.html">pcrestack</a></td>
73 <td>&nbsp;&nbsp;Discussion of PCRE's stack usage</td></tr>
74
75<tr><td><a href="pcresyntax.html">pcresyntax</a></td>
76 <td>&nbsp;&nbsp;Syntax quick-reference summary</td></tr>
77
78<tr><td><a href="pcretest.html">pcretest</a></td>
79 <td>&nbsp;&nbsp;The <b>pcretest</b> command for testing PCRE</td></tr>
80
81<tr><td><a href="pcreunicode.html">pcreunicode</a></td>
82 <td>&nbsp;&nbsp;Discussion of Unicode and UTF-8 support</td></tr>
83</table>
84
85<p>
86There are also individual pages that summarize the interface for each function
87in the library:
88</p>
89
90<table>
91
92<tr><td><a href="pcre_assign_jit_stack.html">pcre_assign_jit_stack</a></td>
93 <td>&nbsp;&nbsp;Assign stack for JIT matching</td></tr>
94
95<tr><td><a href="pcre_compile.html">pcre_compile</a></td>
96 <td>&nbsp;&nbsp;Compile a regular expression</td></tr>
97
98<tr><td><a href="pcre_compile2.html">pcre_compile2</a></td>
99 <td>&nbsp;&nbsp;Compile a regular expression (alternate interface)</td></tr>
100
101<tr><td><a href="pcre_config.html">pcre_config</a></td>
102 <td>&nbsp;&nbsp;Show build-time configuration options</td></tr>
103
104<tr><td><a href="pcre_copy_named_substring.html">pcre_copy_named_substring</a></td>
105 <td>&nbsp;&nbsp;Extract named substring into given buffer</td></tr>
106
107<tr><td><a href="pcre_copy_substring.html">pcre_copy_substring</a></td>
108 <td>&nbsp;&nbsp;Extract numbered substring into given buffer</td></tr>
109
110<tr><td><a href="pcre_dfa_exec.html">pcre_dfa_exec</a></td>
111 <td>&nbsp;&nbsp;Match a compiled pattern to a subject string
112 (DFA algorithm; <i>not</i> Perl compatible)</td></tr>
113
114<tr><td><a href="pcre_free_study.html">pcre_free_study</a></td>
115 <td>&nbsp;&nbsp;Free study data</td></tr>
116
117<tr><td><a href="pcre_exec.html">pcre_exec</a></td>
118 <td>&nbsp;&nbsp;Match a compiled pattern to a subject string
119 (Perl compatible)</td></tr>
120
121<tr><td><a href="pcre_free_substring.html">pcre_free_substring</a></td>
122 <td>&nbsp;&nbsp;Free extracted substring</td></tr>
123
124<tr><td><a href="pcre_free_substring_list.html">pcre_free_substring_list</a></td>
125 <td>&nbsp;&nbsp;Free list of extracted substrings</td></tr>
126
127<tr><td><a href="pcre_fullinfo.html">pcre_fullinfo</a></td>
128 <td>&nbsp;&nbsp;Extract information about a pattern</td></tr>
129
130<tr><td><a href="pcre_get_named_substring.html">pcre_get_named_substring</a></td>
131 <td>&nbsp;&nbsp;Extract named substring into new memory</td></tr>
132
133<tr><td><a href="pcre_get_stringnumber.html">pcre_get_stringnumber</a></td>
134 <td>&nbsp;&nbsp;Convert captured string name to number</td></tr>
135
136<tr><td><a href="pcre_get_substring.html">pcre_get_substring</a></td>
137 <td>&nbsp;&nbsp;Extract numbered substring into new memory</td></tr>
138
139<tr><td><a href="pcre_get_substring_list.html">pcre_get_substring_list</a></td>
140 <td>&nbsp;&nbsp;Extract all substrings into new memory</td></tr>
141
142<tr><td><a href="pcre_info.html">pcre_info</a></td>
143 <td>&nbsp;&nbsp;Obsolete information extraction function</td></tr>
144
145<tr><td><a href="pcre_jit_stack_alloc.html">pcre_jit_stack_alloc</a></td>
146 <td>&nbsp;&nbsp;Create a stack for JIT matching</td></tr>
147
148<tr><td><a href="pcre_jit_stack_free.html">pcre_jit_stack_free</a></td>
149 <td>&nbsp;&nbsp;Free a JIT matching stack</td></tr>
150
151<tr><td><a href="pcre_maketables.html">pcre_maketables</a></td>
152 <td>&nbsp;&nbsp;Build character tables in current locale</td></tr>
153
154<tr><td><a href="pcre_refcount.html">pcre_refcount</a></td>
155 <td>&nbsp;&nbsp;Maintain reference count in compiled pattern</td></tr>
156
157<tr><td><a href="pcre_study.html">pcre_study</a></td>
158 <td>&nbsp;&nbsp;Study a compiled pattern</td></tr>
159
160<tr><td><a href="pcre_version.html">pcre_version</a></td>
161 <td>&nbsp;&nbsp;Return PCRE version and release date</td></tr>
162</table>
163
164</html>