about summary refs log tree commit diff
path: root/Doc/Zsh/mod_pcre.yo
diff options
context:
space:
mode:
Diffstat (limited to 'Doc/Zsh/mod_pcre.yo')
-rw-r--r--Doc/Zsh/mod_pcre.yo22
1 files changed, 22 insertions, 0 deletions
diff --git a/Doc/Zsh/mod_pcre.yo b/Doc/Zsh/mod_pcre.yo
new file mode 100644
index 000000000..76cf5dec6
--- /dev/null
+++ b/Doc/Zsh/mod_pcre.yo
@@ -0,0 +1,22 @@
+COMMENT(!MOD!zsh/pcre
+Interface to the PCRE library.
+!MOD!)
+cindex(regular expressions, perl-compatible)
+The tt(zsh/pcre) module makes some commands available as builtins:
+
+startitem()
+findex(pcre_compile)
+item(tt(pcre_compile) [ tt(-aimx) ] var(PCRE))(
+Compiles a perl-compatible regular expression.
+)
+findex(pcre_study)
+item(tt(pcre_study))(
+Studies the previously-compiled PCRE which may result in faster
+matching.
+)
+findex(pcre_match)
+item(tt(pcre_match) var(string))(
+Returns successfully if tt(string) matches the previously-compiled
+PCRE.
+)
+enditem()