← Back to branch summary

~ubuntu-branches/ubuntu/trusty/pcre3/trusty

« back to all changes in this revision

Viewing changes to doc/pcre_study.3

  • Committer: Package Import Robot
  • Author(s): Mark Baker
  • Date: 2012-03-23 22:34:54 UTC
  • mfrom: (23.1.9 sid)
  • Revision ID: package-import@ubuntu.com-20120323223454-grhqqolk8a7x1h24
Tags: 1:8.30-4
* Reluctantly using an epoch, as it seems the funny version number with
  extra dots causes problems
* Bumped standard version to 3.9.3. No changes needed
* Converted to use new source format / quilt
* Put back obsolete pcre_info() API that upstream have dropped (Closes:
  #665300, #665356)
* Don't include pcregrep binary in debug package

Thanks to Elimar Riesebieter for the conversion to the new source format.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/pcre_study.3
10
10
.B pcre_extra *pcre_study(const pcre *\fIcode\fP, int \fIoptions\fP,
11
11
.ti +5n
12
12
.B const char **\fIerrptr\fP);
 
13
.PP
 
14
.B pcre16_extra *pcre16_study(const pcre16 *\fIcode\fP, int \fIoptions\fP,
 
15
.ti +5n
 
16
.B const char **\fIerrptr\fP);
13
17
.
14
18
.SH DESCRIPTION
15
19
.rs
18
22
be extracted that might speed up matching. Its arguments are:
19
23
.sp
20
24
  \fIcode\fP       A compiled regular expression
21
 
  \fIoptions\fP    Options for \fBpcre_study()\fP
 
25
  \fIoptions\fP    Options for \fBpcre[16]_study()\fP
22
26
  \fIerrptr\fP     Where to put an error message
23
27
.sp
24
28
If the function succeeds, it returns a value that can be passed to
25
 
\fBpcre_exec()\fP via its \fIextra\fP argument.
 
29
\fBpcre[16]_exec()\fP or \fBpcre[16]_dfa_exec()\fP via their \fIextra\fP
 
30
arguments.
26
31
.P
27
32
If the function returns NULL, either it could not find any additional
28
33
information, or there was an error. You can tell the difference by looking at
29
34
the error value. It is NULL in first case.
30
35
.P
31
 
There are currently no options defined; the value of the second argument should
32
 
always be zero.
 
36
The only option is PCRE_STUDY_JIT_COMPILE. It requests just-in-time compilation
 
37
if possible. If PCRE has been compiled without JIT support, this option is
 
38
ignored. See the
 
39
.\" HREF
 
40
\fBpcrejit\fP
 
41
.\"
 
42
page for further details.
33
43
.P
34
44
There is a complete description of the PCRE native API in the
35
45
.\" HREF