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