Commit 5c259a91 authored by Geoff Simmons's avatar Geoff Simmons

Update README due to internal rst changes.

parent 07d677aa
...@@ -314,7 +314,7 @@ turned off. ...@@ -314,7 +314,7 @@ turned off.
just after a newline, and ``$`` also matches just before a newline. Default is just after a newline, and ``$`` also matches just before a newline. Default is
**false**. **false**.
.. _vmod_re2.regex: .. _re2.regex():
new xregex = re2.regex(STRING pattern, BOOL utf8, BOOL posix_syntax, BOOL longest_match, INT max_mem, BOOL literal, BOOL never_nl, BOOL dot_nl, BOOL never_capture, BOOL case_sensitive, BOOL perl_classes, BOOL word_boundary, BOOL one_line) new xregex = re2.regex(STRING pattern, BOOL utf8, BOOL posix_syntax, BOOL longest_match, INT max_mem, BOOL literal, BOOL never_nl, BOOL dot_nl, BOOL never_capture, BOOL case_sensitive, BOOL perl_classes, BOOL word_boundary, BOOL one_line)
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
...@@ -352,7 +352,7 @@ Example:: ...@@ -352,7 +352,7 @@ Example::
never_capture=true); never_capture=true);
} }
.. _vmod_re2.regex.match: .. _xregex.match():
BOOL xregex.match(STRING) BOOL xregex.match(STRING)
------------------------- -------------------------
...@@ -366,7 +366,7 @@ Example:: ...@@ -366,7 +366,7 @@ Example::
call do_on_match; call do_on_match;
} }
.. _vmod_re2.regex.backref: .. _xregex.backref():
STRING xregex.backref(INT ref, STRING fallback) STRING xregex.backref(INT ref, STRING fallback)
----------------------------------------------- -----------------------------------------------
...@@ -433,7 +433,7 @@ Example:: ...@@ -433,7 +433,7 @@ Example::
set req.http.X-Domain = domainmatcher.backref(1); set req.http.X-Domain = domainmatcher.backref(1);
} }
.. _vmod_re2.regex.namedref: .. _xregex.namedref():
STRING xregex.namedref(STRING name, STRING fallback) STRING xregex.namedref(STRING name, STRING fallback)
---------------------------------------------------- ----------------------------------------------------
...@@ -490,7 +490,7 @@ Example:: ...@@ -490,7 +490,7 @@ Example::
} }
} }
.. _vmod_re2.regex.sub: .. _xregex.sub():
STRING xregex.sub(STRING text, STRING rewrite, STRING fallback) STRING xregex.sub(STRING text, STRING rewrite, STRING fallback)
--------------------------------------------------------------- ---------------------------------------------------------------
...@@ -531,7 +531,7 @@ Example:: ...@@ -531,7 +531,7 @@ Example::
set req.http.X-Yada = bmatcher.sub(req.http.Host, "d"); set req.http.X-Yada = bmatcher.sub(req.http.Host, "d");
} }
.. _vmod_re2.regex.suball: .. _xregex.suball():
STRING xregex.suball(STRING text, STRING rewrite, STRING fallback) STRING xregex.suball(STRING text, STRING rewrite, STRING fallback)
------------------------------------------------------------------ ------------------------------------------------------------------
...@@ -567,7 +567,7 @@ Example:: ...@@ -567,7 +567,7 @@ Example::
set req.http.X-Yada = bmatcher.suball(req.http.Host, "d"); set req.http.X-Yada = bmatcher.suball(req.http.Host, "d");
} }
.. _vmod_re2.regex.extract: .. _xregex.extract():
STRING xregex.extract(STRING text, STRING rewrite, STRING fallback) STRING xregex.extract(STRING text, STRING rewrite, STRING fallback)
------------------------------------------------------------------- -------------------------------------------------------------------
...@@ -601,7 +601,7 @@ Example:: ...@@ -601,7 +601,7 @@ Example::
set resp.http.X-UUCP = email.extract("boris@kremvax.ru", "\2!\1"); set resp.http.X-UUCP = email.extract("boris@kremvax.ru", "\2!\1");
} }
.. _vmod_re2.regex.cost: .. _xregex.cost():
INT xregex.cost() INT xregex.cost()
----------------- -----------------
...@@ -624,7 +624,7 @@ Example:: ...@@ -624,7 +624,7 @@ Example::
regex functional interface regex functional interface
========================== ==========================
.. _vmod_re2.match: .. _re2.match():
BOOL match(STRING pattern, STRING subject, BOOL utf8, BOOL posix_syntax, BOOL longest_match, INT max_mem, BOOL literal, BOOL never_nl, BOOL dot_nl, BOOL never_capture, BOOL case_sensitive, BOOL perl_classes, BOOL word_boundary, BOOL one_line) BOOL match(STRING pattern, STRING subject, BOOL utf8, BOOL posix_syntax, BOOL longest_match, INT max_mem, BOOL literal, BOOL never_nl, BOOL dot_nl, BOOL never_capture, BOOL case_sensitive, BOOL perl_classes, BOOL word_boundary, BOOL one_line)
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
...@@ -662,7 +662,7 @@ Example:: ...@@ -662,7 +662,7 @@ Example::
call do_on_match; call do_on_match;
} }
.. _vmod_re2.backref: .. _re2.backref():
STRING backref(INT ref, STRING fallback) STRING backref(INT ref, STRING fallback)
---------------------------------------- ----------------------------------------
...@@ -704,7 +704,7 @@ Example:: ...@@ -704,7 +704,7 @@ Example::
set beresp.http.X-Capture = re2.backref(1); set beresp.http.X-Capture = re2.backref(1);
} }
.. _vmod_re2.namedref: .. _re2.namedref():
STRING namedref(STRING name, STRING fallback) STRING namedref(STRING name, STRING fallback)
--------------------------------------------- ---------------------------------------------
...@@ -741,7 +741,7 @@ Example:: ...@@ -741,7 +741,7 @@ Example::
set beresp.http.X-Capture = re2.namedref("foo"); set beresp.http.X-Capture = re2.namedref("foo");
} }
.. _vmod_re2.sub: .. _re2.sub():
STRING sub(STRING pattern, STRING text, STRING rewrite, STRING fallback, BOOL utf8, BOOL posix_syntax, BOOL longest_match, INT max_mem, BOOL literal, BOOL never_nl, BOOL dot_nl, BOOL never_capture, BOOL case_sensitive, BOOL perl_classes, BOOL word_boundary, BOOL one_line) STRING sub(STRING pattern, STRING text, STRING rewrite, STRING fallback, BOOL utf8, BOOL posix_syntax, BOOL longest_match, INT max_mem, BOOL literal, BOOL never_nl, BOOL dot_nl, BOOL never_capture, BOOL case_sensitive, BOOL perl_classes, BOOL word_boundary, BOOL one_line)
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
...@@ -791,7 +791,7 @@ Example:: ...@@ -791,7 +791,7 @@ Example::
set beresp.http.X-Yada = re2.sub(beresp.http.X-Sub-Letters, set beresp.http.X-Yada = re2.sub(beresp.http.X-Sub-Letters,
bereq.http.Host, "d"); bereq.http.Host, "d");
.. _vmod_re2.suball: .. _re2.suball():
STRING suball(STRING pattern, STRING text, STRING rewrite, STRING fallback, BOOL utf8, BOOL posix_syntax, BOOL longest_match, INT max_mem, BOOL literal, BOOL never_nl, BOOL dot_nl, BOOL never_capture, BOOL case_sensitive, BOOL perl_classes, BOOL word_boundary, BOOL one_line) STRING suball(STRING pattern, STRING text, STRING rewrite, STRING fallback, BOOL utf8, BOOL posix_syntax, BOOL longest_match, INT max_mem, BOOL literal, BOOL never_nl, BOOL dot_nl, BOOL never_capture, BOOL case_sensitive, BOOL perl_classes, BOOL word_boundary, BOOL one_line)
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- -----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
...@@ -831,7 +831,7 @@ Example:: ...@@ -831,7 +831,7 @@ Example::
set beresp.http.X-Yada = re2.suball(beresp.http.X-Sub-Letters, set beresp.http.X-Yada = re2.suball(beresp.http.X-Sub-Letters,
bereq.http.Host, "d"); bereq.http.Host, "d");
.. _vmod_re2.extract: .. _re2.extract():
STRING extract(STRING pattern, STRING text, STRING rewrite, STRING fallback, BOOL utf8, BOOL posix_syntax, BOOL longest_match, INT max_mem, BOOL literal, BOOL never_nl, BOOL dot_nl, BOOL never_capture, BOOL case_sensitive, BOOL perl_classes, BOOL word_boundary, BOOL one_line) STRING extract(STRING pattern, STRING text, STRING rewrite, STRING fallback, BOOL utf8, BOOL posix_syntax, BOOL longest_match, INT max_mem, BOOL literal, BOOL never_nl, BOOL dot_nl, BOOL never_capture, BOOL case_sensitive, BOOL perl_classes, BOOL word_boundary, BOOL one_line)
------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
...@@ -872,7 +872,7 @@ Example:: ...@@ -872,7 +872,7 @@ Example::
set beresp.http.X-Query = re2.extract(beresp.http.X-Params, bereq.url, set beresp.http.X-Query = re2.extract(beresp.http.X-Params, bereq.url,
"\1:\2"); "\1:\2");
.. _vmod_re2.cost: .. _re2.cost():
INT cost(STRING pattern, BOOL utf8, BOOL posix_syntax, BOOL longest_match, INT max_mem, BOOL literal, BOOL never_nl, BOOL dot_nl, BOOL never_capture, BOOL case_sensitive, BOOL perl_classes, BOOL word_boundary, BOOL one_line) INT cost(STRING pattern, BOOL utf8, BOOL posix_syntax, BOOL longest_match, INT max_mem, BOOL literal, BOOL never_nl, BOOL dot_nl, BOOL never_capture, BOOL case_sensitive, BOOL perl_classes, BOOL word_boundary, BOOL one_line)
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
...@@ -906,7 +906,7 @@ Example:: ...@@ -906,7 +906,7 @@ Example::
std.log("simple cost=" + re2.cost("simple") std.log("simple cost=" + re2.cost("simple")
+ " complex cost=" + re2.cost("complex{1,128}")); + " complex cost=" + re2.cost("complex{1,128}"));
.. _vmod_re2.set: .. _re2.set():
new xset = re2.set(ENUM anchor, BOOL utf8, BOOL posix_syntax, BOOL longest_match, INT max_mem, BOOL literal, BOOL never_nl, BOOL dot_nl, BOOL case_sensitive, BOOL perl_classes, BOOL word_boundary, BOOL one_line) new xset = re2.set(ENUM anchor, BOOL utf8, BOOL posix_syntax, BOOL longest_match, INT max_mem, BOOL literal, BOOL never_nl, BOOL dot_nl, BOOL case_sensitive, BOOL perl_classes, BOOL word_boundary, BOOL one_line)
------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
...@@ -968,7 +968,7 @@ Example:: ...@@ -968,7 +968,7 @@ Example::
perl_classes=true); perl_classes=true);
} }
.. _vmod_re2.set.add: .. _xset.add():
VOID xset.add(STRING, [STRING string], [BACKEND backend], [BOOL save], [BOOL never_capture], [INT integer]) VOID xset.add(STRING, [STRING string], [BACKEND backend], [BOOL save], [BOOL never_capture], [INT integer])
----------------------------------------------------------------------------------------------------------- -----------------------------------------------------------------------------------------------------------
...@@ -1045,7 +1045,7 @@ Example:: ...@@ -1045,7 +1045,7 @@ Example::
# See the documentation of the .string() and .backend() methods # See the documentation of the .string() and .backend() methods
# below for uses of the parameters string and backend for .add(). # below for uses of the parameters string and backend for .add().
.. _vmod_re2.set.compile: .. _xset.compile():
VOID xset.compile() VOID xset.compile()
------------------- -------------------
...@@ -1066,7 +1066,7 @@ will fail. ...@@ -1066,7 +1066,7 @@ will fail.
See above for examples. See above for examples.
.. _vmod_re2.set.match: .. _xset.match():
BOOL xset.match(STRING) BOOL xset.match(STRING)
----------------------- -----------------------
...@@ -1100,7 +1100,7 @@ Example:: ...@@ -1100,7 +1100,7 @@ Example::
call do_when_a_host_matched; call do_when_a_host_matched;
} }
.. _vmod_re2.set.matched: .. _xset.matched():
BOOL xset.matched(INT) BOOL xset.matched(INT)
---------------------- ----------------------
...@@ -1144,7 +1144,7 @@ Example:: ...@@ -1144,7 +1144,7 @@ Example::
} }
} }
.. _vmod_re2.set.nmatches: .. _xset.nmatches():
INT xset.nmatches() INT xset.nmatches()
------------------- -------------------
...@@ -1169,7 +1169,7 @@ Example:: ...@@ -1169,7 +1169,7 @@ Example::
+ " patterns from the set"); + " patterns from the set");
} }
.. _vmod_re2.set.which: .. _xset.which():
INT xset.which(ENUM {FIRST, LAST, UNIQUE} select=UNIQUE) INT xset.which(ENUM {FIRST, LAST, UNIQUE} select=UNIQUE)
-------------------------------------------------------- --------------------------------------------------------
...@@ -1232,7 +1232,7 @@ Examples:: ...@@ -1232,7 +1232,7 @@ Examples::
# unsuccessful. # unsuccessful.
} }
.. _vmod_re2.set.string: .. _xset.string():
STRING xset.string(INT n, ENUM select) STRING xset.string(INT n, ENUM select)
-------------------------------------- --------------------------------------
...@@ -1368,7 +1368,7 @@ Examples:: ...@@ -1368,7 +1368,7 @@ Examples::
# vcl_synth is implemented as shown above # vcl_synth is implemented as shown above
.. _vmod_re2.set.backend: .. _xset.backend():
BACKEND xset.backend(INT n, ENUM select) BACKEND xset.backend(INT n, ENUM select)
---------------------------------------- ----------------------------------------
...@@ -1424,7 +1424,7 @@ Example:: ...@@ -1424,7 +1424,7 @@ Example::
} }
} }
.. _vmod_re2.set.integer: .. _xset.integer():
INT xset.integer(INT n, ENUM select) INT xset.integer(INT n, ENUM select)
------------------------------------ ------------------------------------
...@@ -1498,7 +1498,7 @@ Example:: ...@@ -1498,7 +1498,7 @@ Example::
} }
} }
.. _vmod_re2.set.sub: .. _xset.sub():
STRING xset.sub(STRING text, STRING rewrite, STRING fallback, INT n, ENUM select) STRING xset.sub(STRING text, STRING rewrite, STRING fallback, INT n, ENUM select)
--------------------------------------------------------------------------------- ---------------------------------------------------------------------------------
...@@ -1575,7 +1575,7 @@ Examples:: ...@@ -1575,7 +1575,7 @@ Examples::
} }
} }
.. _vmod_re2.set.suball: .. _xset.suball():
STRING xset.suball(STRING text, STRING rewrite, STRING fallback, INT n, ENUM select) STRING xset.suball(STRING text, STRING rewrite, STRING fallback, INT n, ENUM select)
------------------------------------------------------------------------------------ ------------------------------------------------------------------------------------
...@@ -1631,7 +1631,7 @@ Example:: ...@@ -1631,7 +1631,7 @@ Example::
} }
} }
.. _vmod_re2.set.extract: .. _xset.extract():
STRING xset.extract(STRING text, STRING rewrite, STRING fallback, INT n, ENUM select) STRING xset.extract(STRING text, STRING rewrite, STRING fallback, INT n, ENUM select)
------------------------------------------------------------------------------------- -------------------------------------------------------------------------------------
...@@ -1687,7 +1687,7 @@ Example:: ...@@ -1687,7 +1687,7 @@ Example::
} }
} }
.. _vmod_re2.set.saved: .. _xset.saved():
BOOL xset.saved(ENUM which, INT n, ENUM select) BOOL xset.saved(ENUM which, INT n, ENUM select)
----------------------------------------------- -----------------------------------------------
...@@ -1770,7 +1770,7 @@ Example:: ...@@ -1770,7 +1770,7 @@ Example::
# and which=REGEX by default. # and which=REGEX by default.
} }
.. _vmod_re2.set.hdr_filter: .. _xset.hdr_filter():
VOID xset.hdr_filter(HTTP, BOOL whitelist=1) VOID xset.hdr_filter(HTTP, BOOL whitelist=1)
-------------------------------------------- --------------------------------------------
...@@ -1814,7 +1814,7 @@ Example:: ...@@ -1814,7 +1814,7 @@ Example::
black.hdr_filter(resp, false); black.hdr_filter(resp, false);
} }
.. _vmod_re2.quotemeta: .. _re2.quotemeta():
STRING quotemeta(STRING, STRING fallback) STRING quotemeta(STRING, STRING fallback)
----------------------------------------- -----------------------------------------
...@@ -1842,7 +1842,7 @@ Example:: ...@@ -1842,7 +1842,7 @@ Example::
re2.quotemeta("1.5-2.0?") == "1\.5\-2\.0\?" re2.quotemeta("1.5-2.0?") == "1\.5\-2\.0\?"
re2.match(re2.quotemeta("1.5-2.0?"), "1.5-2.0?") re2.match(re2.quotemeta("1.5-2.0?"), "1.5-2.0?")
.. _vmod_re2.version: .. _re2.version():
STRING version() STRING version()
---------------- ----------------
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment