The HTML documentation for PCRE2 consists of a number of pages that are listed below in alphabetical order. If you are new to PCRE2, please read the first one first.
| pcre | Introductory page |
| pcre-config | Information about the installation configuration |
| pcreapi | PCRE2's native API |
| pcrebuild | Building PCRE2 |
| pcre2callout | The callout facility |
| pcre2compat | Compability with Perl |
| pcre2demo | A demonstration C program that uses the PCRE2 library |
| pcre2grep | The pcre2grep command |
| pcre2jit | Discussion of the just-in-time optimization support |
| pcre2limits | Details of size and other limits |
| pcre2matching | Discussion of the two matching algorithms |
| pcre2partial | Using PCRE2 for partial matching |
| pcre2pattern | Specification of the regular expressions supported by PCRE2 |
| pcre2perform | Some comments on performance |
| pcre2posix | The POSIX API to the PCRE2 8-bit library |
| pcre2precompile | How to save and re-use compiled patterns |
| pcre2sample | Discussion of the pcre2demo program |
| pcre2stack | Discussion of PCRE2's stack usage |
| pcre2syntax | Syntax quick-reference summary |
| pcre2test | The pcre2test command for testing PCRE2 |
| pcre2unicode | 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 triple of 8-bit/16-bit/32-bit functions.
| pcre2_assign_jit_stack | Assign stack for JIT matching |
| pcre2_compile | Compile a regular expression |
| pcre2_compile2 | Compile a regular expression (alternate interface) |
| pcre2_config | Show build-time configuration options |
| pcre2_copy_named_substring | Extract named substring into given buffer |
| pcre2_copy_substring | Extract numbered substring into given buffer |
| pcre2_dfa_exec | Match a compiled pattern to a subject string (DFA algorithm; not Perl compatible) |
| pcre2_exec | Match a compiled pattern to a subject string (Perl compatible) |
| pcre2_free_study | Free study data |
| pcre2_free_substring | Free extracted substring |
| pcre2_free_substring_list | Free list of extracted substrings |
| pcre2_fullinfo | Extract information about a pattern |
| pcre2_get_named_substring | Extract named substring into new memory |
| pcre2_get_stringnumber | Convert captured string name to number |
| pcre2_get_stringtable_entries | Find table entries for given string name |
| pcre2_get_substring | Extract numbered substring into new memory |
| pcre2_get_substring_list | Extract all substrings into new memory |
| pcre2_jit_exec | Fast path interface to JIT matching |
| pcre2_jit_stack_alloc | Create a stack for JIT matching |
| pcre2_jit_stack_free | Free a JIT matching stack |
| pcre2_maketables | Build character tables in current locale |
| pcre2_pattern_to_host_byte_order | Convert compiled pattern to host byte order if necessary |
| pcre2_refcount | Maintain reference count in compiled pattern |
| pcre2_study | Study a compiled pattern |
| pcre2_utf16_to_host_byte_order | Convert UTF-16 string to host byte order if necessary |
| pcre2_utf32_to_host_byte_order | Convert UTF-32 string to host byte order if necessary |
| pcre2_version | Return PCRE2 version and release date |