index.html 7.5 KB

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