-The HTML documentation for PCRE comprises the following pages: +The HTML documentation for PCRE consists of a number of pages that are listed +below in alphabetical order. If you are new to PCRE, please read the first one +first.
| pcre | Introductory page |
| pcre-config | +Information about the installation configuration |
| pcre16 | Discussion of the 16-bit PCRE library |
| pcre-config | -Information about the installation configuration |
| pcre32 | +Discussion of the 32-bit PCRE library |
| pcreapi | PCRE's native API |
| pcrebuild | -Options for building PCRE | Building PCRE |
| pcrecallout | The callout facility | Some comments on performance |
| pcreposix | -The POSIX API to the PCRE library | The POSIX API to the PCRE 8-bit library |
| pcreprecompile | How to save and re-use compiled patterns | The pcretest command for testing PCRE |
| pcreunicode | -Discussion of Unicode and UTF-8 support | Discussion of Unicode and UTF-8/UTF-16/UTF-32 support |
There are also individual pages that summarize the interface for each function -in the library. There is a single page for each pair of 8-bit/16-bit functions. +in the library. There is a single page for each triple of 8-bit/16-bit/32-bit +functions.
| Match a compiled pattern to a subject string (DFA algorithm; not Perl compatible) | -|
| pcre_free_study | -Free study data |
| pcre_exec | Match a compiled pattern to a subject string (Perl compatible) |
| pcre_free_study | +Free study data |
| pcre_free_substring | Free extracted substring |
| pcre_get_stringnumber | Convert captured string name to number |
| pcre_get_stringtable_entries | +Find table entries for given string name |
| pcre_get_substring | Extract numbered substring into new memory |
| pcre_get_substring_list | Extract all substrings into new memory |
| pcre_info | -Obsolete information extraction function |
| pcre_jit_exec | +Fast path interface to JIT matching |
| pcre_jit_stack_alloc | Create a stack for JIT matching |
| pcre_utf16_to_host_byte_order | Convert UTF-16 string to host byte order if necessary |
| pcre_utf32_to_host_byte_order | +Convert UTF-32 string to host byte order if necessary |
| pcre_version | Return PCRE version and release date |