doc/index.html.src

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