summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorshmuz <shmuz>2008-06-15 03:22:58 +0000
committershmuz <shmuz>2008-06-15 03:22:58 +0000
commitb17e31a4fc97efd82ac58077637910dc11ff0aec (patch)
tree5ff62d03f37dd5fa80dbd3acaaff526a15442d1e /doc
parent3ec09b94097cb2f761ec7dc8660d775874add130 (diff)
downloadlrexlib-b17e31a4fc97efd82ac58077637910dc11ff0aec.tar.gz
update version and copyright strings (prepare to release 2.4)
Diffstat (limited to 'doc')
-rwxr-xr-xdoc/index.txt2
-rwxr-xr-xdoc/license.html2
-rwxr-xr-xdoc/manual.txt27
3 files changed, 21 insertions, 10 deletions
diff --git a/doc/index.txt b/doc/index.txt
index d0af20c..49b70c7 100755
--- a/doc/index.txt
+++ b/doc/index.txt
@@ -1,4 +1,4 @@
-Lrexlib 2.3
+Lrexlib 2.4
===========
| by Reuben Thomas (rrt@sc3d.org)
diff --git a/doc/license.html b/doc/license.html
index 1d10f73..b327713 100755
--- a/doc/license.html
+++ b/doc/license.html
@@ -5,7 +5,7 @@
</head>
<body>
-<h2>Lrexlib 2.3</h2>
+<h2>Lrexlib 2.4</h2>
<p>Copyright &copy; Reuben Thomas 2000-2008<br>
Copyright &copy; Shmuel Zeigerman 2004-2008
diff --git a/doc/manual.txt b/doc/manual.txt
index b7fe2d3..92086c8 100755
--- a/doc/manual.txt
+++ b/doc/manual.txt
@@ -1,6 +1,6 @@
.. role:: funcdef(literal)
-Lrexlib 2.3 Reference Manual
+Lrexlib 2.4 Reference Manual
============================
.. contents:: Table of Contents
@@ -47,9 +47,13 @@ Notes
generate an error if that pattern is found invalid by the used POSIX_ / PCRE_
library.
+5. All functions receiving a string-type regex argument accept a compiled regex
+ too. If this is the case, then cf_ and locale_ arguments are ignored (should
+ be either supplied as nils or omitted).
+
.. _cf:
-5. The default value for *compilation flags* (*cf*) that Lrexlib uses when
+6. The default value for *compilation flags* (*cf*) that Lrexlib uses when
the parameter is not supplied or ``nil``, is:
* 0 for PCRE
@@ -72,7 +76,7 @@ Notes
.. _ef:
-6. The default value for *execution flags* (*ef*) that Lrexlib uses when
+7. The default value for *execution flags* (*ef*) that Lrexlib uses when
the parameter is not supplied or ``nil``, is:
* 0 for PCRE
@@ -82,7 +86,7 @@ Notes
.. _locale:
-7. Parameter *locale* (*lo*) can be either a string (e.g., "French_France.1252"),
+8. Parameter *locale* (*lo*) can be either a string (e.g., "French_France.1252"),
or a userdata obtained from a call to maketables_. The default value, used
when the parameter is not supplied or ``nil``, is the built-in PCRE set of
character tables.
@@ -113,7 +117,9 @@ PCRE: A locale *lo* may be specified.
+---------+-------------------------------+--------+-------------+
| subj | subject | string | n/a |
+---------+-------------------------------+--------+-------------+
- | patt |regular expression pattern | string | n/a |
+ | patt |regular expression pattern |string | n/a |
+ | | |or | |
+ | | |userdata| |
+---------+-------------------------------+--------+-------------+
| [init] |start offset in the subject | number | 1 |
| |(can be negative) | | |
@@ -159,7 +165,9 @@ PCRE: A locale *lo* may be specified.
+---------+-------------------------------+--------+-------------+
| subj | subject | string | n/a |
+---------+-------------------------------+--------+-------------+
- | patt |regular expression pattern | string | n/a |
+ | patt |regular expression pattern |string | n/a |
+ | | |or | |
+ | | |userdata| |
+---------+-------------------------------+--------+-------------+
| [init] |start offset in the subject | number | 1 |
| |(can be negative) | | |
@@ -202,6 +210,8 @@ PCRE: A locale *lo* may be specified.
| subj | subject |string | n/a |
+---------+-------------------------------+--------+-------------+
| patt |regular expression pattern |string | n/a |
+ | | |or | |
+ | | |userdata| |
+---------+-------------------------------+--------+-------------+
| [cf] |compilation flags (bitwise OR) |number | cf_ |
+---------+-------------------------------+--------+-------------+
@@ -235,7 +245,7 @@ PCRE: A locale *lo* may be specified.
+=========+===================================+=========================+=============+
| subj |subject | string | n/a |
+---------+-----------------------------------+-------------------------+-------------+
- | patt |regular expression pattern | string | n/a |
+ | patt |regular expression pattern |string or userdata | n/a |
+---------+-----------------------------------+-------------------------+-------------+
| repl |substitution source |string, function or table| n/a |
+---------+-----------------------------------+-------------------------+-------------+
@@ -358,7 +368,8 @@ PCRE: A locale *lo* may be specified.
| subj | subject |string | n/a |
+---------+-------------------------------+--------+-------------+
| sep |separator (regular expression |string | n/a |
- | |pattern) | | |
+ | |pattern) |or | |
+ | | |userdata| |
+---------+-------------------------------+--------+-------------+
| [cf] |compilation flags (bitwise OR) |number | cf_ |
+---------+-------------------------------+--------+-------------+