diff options
author | ph10 <ph10@2f5784b3-3f2a-0410-8824-cb99058d5e15> | 2013-06-14 09:09:28 +0000 |
---|---|---|
committer | ph10 <ph10@2f5784b3-3f2a-0410-8824-cb99058d5e15> | 2013-06-14 09:09:28 +0000 |
commit | cb284848eb9e3c84b670166346baa02e6a55ebf6 (patch) | |
tree | 881af02f5fcb2266e2b1cd64ba5198651a07813c /doc/html/pcreapi.html | |
parent | 71ecd01f8b10d6e24d8cdc5d36f957759a424959 (diff) | |
download | pcre-cb284848eb9e3c84b670166346baa02e6a55ebf6.tar.gz |
Update man pages to avoid the use of .ti (which causes difficulties for some
translation software).
git-svn-id: svn://vcs.exim.org/pcre/code/trunk@1339 2f5784b3-3f2a-0410-8824-cb99058d5e15
Diffstat (limited to 'doc/html/pcreapi.html')
-rw-r--r-- | doc/html/pcreapi.html | 236 |
1 files changed, 119 insertions, 117 deletions
diff --git a/doc/html/pcreapi.html b/doc/html/pcreapi.html index 2a00d9b..62859ca 100644 --- a/doc/html/pcreapi.html +++ b/doc/html/pcreapi.html @@ -46,125 +46,125 @@ man page, in case the conversion went wrong. <br><a name="SEC1" href="#TOC1">PCRE NATIVE API BASIC FUNCTIONS</a><br> <P> <b>pcre *pcre_compile(const char *<i>pattern</i>, int <i>options</i>,</b> -<b>const char **<i>errptr</i>, int *<i>erroffset</i>,</b> -<b>const unsigned char *<i>tableptr</i>);</b> -</P> -<P> +<b> const char **<i>errptr</i>, int *<i>erroffset</i>,</b> +<b> const unsigned char *<i>tableptr</i>);</b> +<br> +<br> <b>pcre *pcre_compile2(const char *<i>pattern</i>, int <i>options</i>,</b> -<b>int *<i>errorcodeptr</i>,</b> -<b>const char **<i>errptr</i>, int *<i>erroffset</i>,</b> -<b>const unsigned char *<i>tableptr</i>);</b> -</P> -<P> +<b> int *<i>errorcodeptr</i>,</b> +<b> const char **<i>errptr</i>, int *<i>erroffset</i>,</b> +<b> const unsigned char *<i>tableptr</i>);</b> +<br> +<br> <b>pcre_extra *pcre_study(const pcre *<i>code</i>, int <i>options</i>,</b> -<b>const char **<i>errptr</i>);</b> -</P> -<P> +<b> const char **<i>errptr</i>);</b> +<br> +<br> <b>void pcre_free_study(pcre_extra *<i>extra</i>);</b> -</P> -<P> +<br> +<br> <b>int pcre_exec(const pcre *<i>code</i>, const pcre_extra *<i>extra</i>,</b> -<b>const char *<i>subject</i>, int <i>length</i>, int <i>startoffset</i>,</b> -<b>int <i>options</i>, int *<i>ovector</i>, int <i>ovecsize</i>);</b> -</P> -<P> +<b> const char *<i>subject</i>, int <i>length</i>, int <i>startoffset</i>,</b> +<b> int <i>options</i>, int *<i>ovector</i>, int <i>ovecsize</i>);</b> +<br> +<br> <b>int pcre_dfa_exec(const pcre *<i>code</i>, const pcre_extra *<i>extra</i>,</b> -<b>const char *<i>subject</i>, int <i>length</i>, int <i>startoffset</i>,</b> -<b>int <i>options</i>, int *<i>ovector</i>, int <i>ovecsize</i>,</b> -<b>int *<i>workspace</i>, int <i>wscount</i>);</b> +<b> const char *<i>subject</i>, int <i>length</i>, int <i>startoffset</i>,</b> +<b> int <i>options</i>, int *<i>ovector</i>, int <i>ovecsize</i>,</b> +<b> int *<i>workspace</i>, int <i>wscount</i>);</b> </P> <br><a name="SEC2" href="#TOC1">PCRE NATIVE API STRING EXTRACTION FUNCTIONS</a><br> <P> <b>int pcre_copy_named_substring(const pcre *<i>code</i>,</b> -<b>const char *<i>subject</i>, int *<i>ovector</i>,</b> -<b>int <i>stringcount</i>, const char *<i>stringname</i>,</b> -<b>char *<i>buffer</i>, int <i>buffersize</i>);</b> -</P> -<P> +<b> const char *<i>subject</i>, int *<i>ovector</i>,</b> +<b> int <i>stringcount</i>, const char *<i>stringname</i>,</b> +<b> char *<i>buffer</i>, int <i>buffersize</i>);</b> +<br> +<br> <b>int pcre_copy_substring(const char *<i>subject</i>, int *<i>ovector</i>,</b> -<b>int <i>stringcount</i>, int <i>stringnumber</i>, char *<i>buffer</i>,</b> -<b>int <i>buffersize</i>);</b> -</P> -<P> +<b> int <i>stringcount</i>, int <i>stringnumber</i>, char *<i>buffer</i>,</b> +<b> int <i>buffersize</i>);</b> +<br> +<br> <b>int pcre_get_named_substring(const pcre *<i>code</i>,</b> -<b>const char *<i>subject</i>, int *<i>ovector</i>,</b> -<b>int <i>stringcount</i>, const char *<i>stringname</i>,</b> -<b>const char **<i>stringptr</i>);</b> -</P> -<P> +<b> const char *<i>subject</i>, int *<i>ovector</i>,</b> +<b> int <i>stringcount</i>, const char *<i>stringname</i>,</b> +<b> const char **<i>stringptr</i>);</b> +<br> +<br> <b>int pcre_get_stringnumber(const pcre *<i>code</i>,</b> -<b>const char *<i>name</i>);</b> -</P> -<P> +<b> const char *<i>name</i>);</b> +<br> +<br> <b>int pcre_get_stringtable_entries(const pcre *<i>code</i>,</b> -<b>const char *<i>name</i>, char **<i>first</i>, char **<i>last</i>);</b> -</P> -<P> +<b> const char *<i>name</i>, char **<i>first</i>, char **<i>last</i>);</b> +<br> +<br> <b>int pcre_get_substring(const char *<i>subject</i>, int *<i>ovector</i>,</b> -<b>int <i>stringcount</i>, int <i>stringnumber</i>,</b> -<b>const char **<i>stringptr</i>);</b> -</P> -<P> +<b> int <i>stringcount</i>, int <i>stringnumber</i>,</b> +<b> const char **<i>stringptr</i>);</b> +<br> +<br> <b>int pcre_get_substring_list(const char *<i>subject</i>,</b> -<b>int *<i>ovector</i>, int <i>stringcount</i>, const char ***<i>listptr</i>);</b> -</P> -<P> +<b> int *<i>ovector</i>, int <i>stringcount</i>, const char ***<i>listptr</i>);</b> +<br> +<br> <b>void pcre_free_substring(const char *<i>stringptr</i>);</b> -</P> -<P> +<br> +<br> <b>void pcre_free_substring_list(const char **<i>stringptr</i>);</b> </P> <br><a name="SEC3" href="#TOC1">PCRE NATIVE API AUXILIARY FUNCTIONS</a><br> <P> <b>int pcre_jit_exec(const pcre *<i>code</i>, const pcre_extra *<i>extra</i>,</b> -<b>const char *<i>subject</i>, int <i>length</i>, int <i>startoffset</i>,</b> -<b>int <i>options</i>, int *<i>ovector</i>, int <i>ovecsize</i>,</b> -<b>pcre_jit_stack *<i>jstack</i>);</b> -</P> -<P> +<b> const char *<i>subject</i>, int <i>length</i>, int <i>startoffset</i>,</b> +<b> int <i>options</i>, int *<i>ovector</i>, int <i>ovecsize</i>,</b> +<b> pcre_jit_stack *<i>jstack</i>);</b> +<br> +<br> <b>pcre_jit_stack *pcre_jit_stack_alloc(int <i>startsize</i>, int <i>maxsize</i>);</b> -</P> -<P> +<br> +<br> <b>void pcre_jit_stack_free(pcre_jit_stack *<i>stack</i>);</b> -</P> -<P> +<br> +<br> <b>void pcre_assign_jit_stack(pcre_extra *<i>extra</i>,</b> -<b>pcre_jit_callback <i>callback</i>, void *<i>data</i>);</b> -</P> -<P> +<b> pcre_jit_callback <i>callback</i>, void *<i>data</i>);</b> +<br> +<br> <b>const unsigned char *pcre_maketables(void);</b> -</P> -<P> +<br> +<br> <b>int pcre_fullinfo(const pcre *<i>code</i>, const pcre_extra *<i>extra</i>,</b> -<b>int <i>what</i>, void *<i>where</i>);</b> -</P> -<P> +<b> int <i>what</i>, void *<i>where</i>);</b> +<br> +<br> <b>int pcre_refcount(pcre *<i>code</i>, int <i>adjust</i>);</b> -</P> -<P> +<br> +<br> <b>int pcre_config(int <i>what</i>, void *<i>where</i>);</b> -</P> -<P> +<br> +<br> <b>const char *pcre_version(void);</b> -</P> -<P> +<br> +<br> <b>int pcre_pattern_to_host_byte_order(pcre *<i>code</i>,</b> -<b>pcre_extra *<i>extra</i>, const unsigned char *<i>tables</i>);</b> +<b> pcre_extra *<i>extra</i>, const unsigned char *<i>tables</i>);</b> </P> <br><a name="SEC4" href="#TOC1">PCRE NATIVE API INDIRECTED FUNCTIONS</a><br> <P> <b>void *(*pcre_malloc)(size_t);</b> -</P> -<P> +<br> +<br> <b>void (*pcre_free)(void *);</b> -</P> -<P> +<br> +<br> <b>void *(*pcre_stack_malloc)(size_t);</b> -</P> -<P> +<br> +<br> <b>void (*pcre_stack_free)(void *);</b> -</P> -<P> +<br> +<br> <b>int (*pcre_callout)(pcre_callout_block *);</b> </P> <br><a name="SEC5" href="#TOC1">PCRE 8-BIT, 16-BIT, AND 32-BIT LIBRARIES</a><br> @@ -509,12 +509,14 @@ avoiding the use of the stack. <br><a name="SEC11" href="#TOC1">COMPILING A PATTERN</a><br> <P> <b>pcre *pcre_compile(const char *<i>pattern</i>, int <i>options</i>,</b> -<b>const char **<i>errptr</i>, int *<i>erroffset</i>,</b> -<b>const unsigned char *<i>tableptr</i>);</b> +<b> const char **<i>errptr</i>, int *<i>erroffset</i>,</b> +<b> const unsigned char *<i>tableptr</i>);</b> +<br> +<br> <b>pcre *pcre_compile2(const char *<i>pattern</i>, int <i>options</i>,</b> -<b>int *<i>errorcodeptr</i>,</b> -<b>const char **<i>errptr</i>, int *<i>erroffset</i>,</b> -<b>const unsigned char *<i>tableptr</i>);</b> +<b> int *<i>errorcodeptr</i>,</b> +<b> const char **<i>errptr</i>, int *<i>erroffset</i>,</b> +<b> const unsigned char *<i>tableptr</i>);</b> </P> <P> Either of the functions <b>pcre_compile()</b> or <b>pcre_compile2()</b> can be @@ -977,8 +979,8 @@ be used if the limits were changed when PCRE was built. <a name="studyingapattern"></a></P> <br><a name="SEC13" href="#TOC1">STUDYING A PATTERN</a><br> <P> -<b>pcre_extra *pcre_study(const pcre *<i>code</i>, int <i>options</i></b> -<b>const char **<i>errptr</i>);</b> +<b>pcre_extra *pcre_study(const pcre *<i>code</i>, int <i>options</i>,</b> +<b> const char **<i>errptr</i>);</b> </P> <P> If a compiled pattern is going to be used several times, it is worth spending @@ -1162,7 +1164,7 @@ below in the section on matching a pattern. <br><a name="SEC15" href="#TOC1">INFORMATION ABOUT A PATTERN</a><br> <P> <b>int pcre_fullinfo(const pcre *<i>code</i>, const pcre_extra *<i>extra</i>,</b> -<b>int <i>what</i>, void *<i>where</i>);</b> +<b> int <i>what</i>, void *<i>where</i>);</b> </P> <P> The <b>pcre_fullinfo()</b> function returns information about a compiled @@ -1559,8 +1561,8 @@ is different. (This seems a highly unlikely scenario.) <br><a name="SEC17" href="#TOC1">MATCHING A PATTERN: THE TRADITIONAL FUNCTION</a><br> <P> <b>int pcre_exec(const pcre *<i>code</i>, const pcre_extra *<i>extra</i>,</b> -<b>const char *<i>subject</i>, int <i>length</i>, int <i>startoffset</i>,</b> -<b>int <i>options</i>, int *<i>ovector</i>, int <i>ovecsize</i>);</b> +<b> const char *<i>subject</i>, int <i>length</i>, int <i>startoffset</i>,</b> +<b> int <i>options</i>, int *<i>ovector</i>, int <i>ovecsize</i>);</b> </P> <P> The function <b>pcre_exec()</b> is called to match a subject string against a @@ -2413,17 +2415,17 @@ no longer in use and is never returned. <br><a name="SEC18" href="#TOC1">EXTRACTING CAPTURED SUBSTRINGS BY NUMBER</a><br> <P> <b>int pcre_copy_substring(const char *<i>subject</i>, int *<i>ovector</i>,</b> -<b>int <i>stringcount</i>, int <i>stringnumber</i>, char *<i>buffer</i>,</b> -<b>int <i>buffersize</i>);</b> -</P> -<P> +<b> int <i>stringcount</i>, int <i>stringnumber</i>, char *<i>buffer</i>,</b> +<b> int <i>buffersize</i>);</b> +<br> +<br> <b>int pcre_get_substring(const char *<i>subject</i>, int *<i>ovector</i>,</b> -<b>int <i>stringcount</i>, int <i>stringnumber</i>,</b> -<b>const char **<i>stringptr</i>);</b> -</P> -<P> +<b> int <i>stringcount</i>, int <i>stringnumber</i>,</b> +<b> const char **<i>stringptr</i>);</b> +<br> +<br> <b>int pcre_get_substring_list(const char *<i>subject</i>,</b> -<b>int *<i>ovector</i>, int <i>stringcount</i>, const char ***<i>listptr</i>);</b> +<b> int *<i>ovector</i>, int <i>stringcount</i>, const char ***<i>listptr</i>);</b> </P> <P> Captured substrings can be accessed directly by using the offsets returned by @@ -2508,19 +2510,19 @@ provided. <br><a name="SEC19" href="#TOC1">EXTRACTING CAPTURED SUBSTRINGS BY NAME</a><br> <P> <b>int pcre_get_stringnumber(const pcre *<i>code</i>,</b> -<b>const char *<i>name</i>);</b> -</P> -<P> +<b> const char *<i>name</i>);</b> +<br> +<br> <b>int pcre_copy_named_substring(const pcre *<i>code</i>,</b> -<b>const char *<i>subject</i>, int *<i>ovector</i>,</b> -<b>int <i>stringcount</i>, const char *<i>stringname</i>,</b> -<b>char *<i>buffer</i>, int <i>buffersize</i>);</b> -</P> -<P> +<b> const char *<i>subject</i>, int *<i>ovector</i>,</b> +<b> int <i>stringcount</i>, const char *<i>stringname</i>,</b> +<b> char *<i>buffer</i>, int <i>buffersize</i>);</b> +<br> +<br> <b>int pcre_get_named_substring(const pcre *<i>code</i>,</b> -<b>const char *<i>subject</i>, int *<i>ovector</i>,</b> -<b>int <i>stringcount</i>, const char *<i>stringname</i>,</b> -<b>const char **<i>stringptr</i>);</b> +<b> const char *<i>subject</i>, int *<i>ovector</i>,</b> +<b> int <i>stringcount</i>, const char *<i>stringname</i>,</b> +<b> const char **<i>stringptr</i>);</b> </P> <P> To extract a substring by name, you first have to find associated number. @@ -2572,7 +2574,7 @@ same number causes an error at compile time. <br><a name="SEC20" href="#TOC1">DUPLICATE SUBPATTERN NAMES</a><br> <P> <b>int pcre_get_stringtable_entries(const pcre *<i>code</i>,</b> -<b>const char *<i>name</i>, char **<i>first</i>, char **<i>last</i>);</b> +<b> const char *<i>name</i>, char **<i>first</i>, char **<i>last</i>);</b> </P> <P> When a pattern is compiled with the PCRE_DUPNAMES option, names for subpatterns @@ -2653,9 +2655,9 @@ the value returned is the size of each block that is obtained from the heap. <br><a name="SEC23" href="#TOC1">MATCHING A PATTERN: THE ALTERNATIVE FUNCTION</a><br> <P> <b>int pcre_dfa_exec(const pcre *<i>code</i>, const pcre_extra *<i>extra</i>,</b> -<b>const char *<i>subject</i>, int <i>length</i>, int <i>startoffset</i>,</b> -<b>int <i>options</i>, int *<i>ovector</i>, int <i>ovecsize</i>,</b> -<b>int *<i>workspace</i>, int <i>wscount</i>);</b> +<b> const char *<i>subject</i>, int <i>length</i>, int <i>startoffset</i>,</b> +<b> int <i>options</i>, int *<i>ovector</i>, int <i>ovecsize</i>,</b> +<b> int *<i>workspace</i>, int <i>wscount</i>);</b> </P> <P> The function <b>pcre_dfa_exec()</b> is called to match a subject string against @@ -2850,7 +2852,7 @@ Cambridge CB2 3QH, England. </P> <br><a name="SEC26" href="#TOC1">REVISION</a><br> <P> -Last updated: 12 May 2013 +Last updated: 12 June 2013 <br> Copyright © 1997-2013 University of Cambridge. <br> |