This is 1.02

[perl/modules/Regexp-Wildcards.git] / README

diff --git a/README b/README
index 7d0d9b9247aa56495c305e64ccddd6e0c01de043..19cb5b7733ad7e7ffc72bc5b3341f9bf2647be33 100644 (file)
--- a/README
+++ b/README
@@ -3,7 +3,7 @@ NAME
     expressions.
 
 VERSION
-    Version 1.01
+    Version 1.02
 
 SYNOPSIS
         use Regexp::Wildcards;
@@ -33,8 +33,9 @@ DESCRIPTION
     regular expressions, so that you can use them for matching.
 
     It handles the "*" and "?" jokers, as well as Unix bracketed
-    alternatives "{,}", but also "%" and "_" SQL wildcards. It can also keep
-    original "(...)" groups. Backspace ("\") is used as an escape character.
+    alternatives "{,}", but also "%" and "_" SQL wildcards. If required, it
+    can also keep original "(...)" groups or "^" and "$" anchors. Backspace
+    ("\") is used as an escape character.
 
     Typesets that mimic the behaviour of Windows and Unix shells are also
     provided.
@@ -54,8 +55,8 @@ METHODS
     more details.
 
   "do [ $what | set => $c1, add => $c2, rem => $c3 ]"
-    Specifies the list of metacharacters to convert. They are classified
-    into five classes :
+    Specifies the list of metacharacters to convert or to prevent for
+    escaping. They fit into six classes :
 
     *   'jokers' converts "?" to "." and "*" to ".*" ;
 
@@ -86,6 +87,12 @@ METHODS
 
             'a(b(c))d\\(\\)' ==> (no change)
 
+    *   'anchors' prevents the *beginning-of-line* "^" and *end-of-line* "$"
+        anchors to be escaped. Since "[...]" character class are currently
+        escaped, a "^" will always be interpreted as *beginning-of-line*.
+
+            'a^b$c' ==> (no change)
+
     Each $c can be any of :
 
     *   A hash reference, with wanted metacharacter group names (described