about summary refs log tree commit diff
path: root/Doc/Zsh/mod_pcre.yo
diff options
context:
space:
mode:
authorPeter Stephenson <pws@users.sourceforge.net>2007-05-01 22:05:03 +0000
committerPeter Stephenson <pws@users.sourceforge.net>2007-05-01 22:05:03 +0000
commit7f03c3d851c571d86d18c701d882c13ad5d06c6c (patch)
tree17edf1709daf6247f505f82d12bbd5c67fa69906 /Doc/Zsh/mod_pcre.yo
parenteb4c3d4bf2e6b13078afd0820375dc02a2eb2a1f (diff)
downloadzsh-7f03c3d851c571d86d18c701d882c13ad5d06c6c.tar.gz
zsh-7f03c3d851c571d86d18c701d882c13ad5d06c6c.tar.xz
zsh-7f03c3d851c571d86d18c701d882c13ad5d06c6c.zip
23375: Phil Pennock: =~, zsh/regex etc. etc.
Diffstat (limited to 'Doc/Zsh/mod_pcre.yo')
-rw-r--r--Doc/Zsh/mod_pcre.yo7
1 files changed, 5 insertions, 2 deletions
diff --git a/Doc/Zsh/mod_pcre.yo b/Doc/Zsh/mod_pcre.yo
index 58833823a..f6131f5e4 100644
--- a/Doc/Zsh/mod_pcre.yo
+++ b/Doc/Zsh/mod_pcre.yo
@@ -22,14 +22,17 @@ Studies the previously-compiled PCRE which may result in faster
 matching.
 )
 findex(pcre_match)
-item(tt(pcre_match) [ tt(-a) var(arr) ] var(string))(
+item(tt(pcre_match) [ tt(-v) var(var) ] [ tt(-a) var(arr) ] var(string))(
 Returns successfully if tt(string) matches the previously-compiled
 PCRE.
 
 If the expression captures substrings within parentheses,
 tt(pcre_match) will set the array var($match) to those
 substrings, unless the tt(-a) option is given, in which
-case it will set the array var(arr).
+case it will set the array var(arr).  Similarly, the variable
+var(MATCH) will be set to the entire matched portion of the
+string, unless the tt(-v) option is given, in which case the variable
+var(var) will be set.
 )
 enditem()