about summary refs log tree commit diff
path: root/Doc/Zsh/mod_zleparameter.yo
diff options
context:
space:
mode:
Diffstat (limited to 'Doc/Zsh/mod_zleparameter.yo')
-rw-r--r--Doc/Zsh/mod_zleparameter.yo28
1 files changed, 28 insertions, 0 deletions
diff --git a/Doc/Zsh/mod_zleparameter.yo b/Doc/Zsh/mod_zleparameter.yo
new file mode 100644
index 000000000..cf79668e4
--- /dev/null
+++ b/Doc/Zsh/mod_zleparameter.yo
@@ -0,0 +1,28 @@
+texinode(The zleparameter Module)()(The zle Module)(Zsh Modules)
+sect(The zleparameter Module)
+cindex(parameters, special)
+The tt(zleparameter) module defines two special parameters that can be 
+used to access internal information of the Zsh Line Editor (see
+ifzman(zmanref(zshzle))\
+ifnzman(noderef(Zsh Line Editor))\
+).
+
+startitem()
+vindex(zlekeymaps)
+item(tt(zlekeymaps))(
+This array contains the names of the keymaps currently defined.
+)
+vindex(zlewidgets)
+item(tt(zlewidgets))(
+This associative array contains one entry per widget defined. The name 
+of the widget is the key and the value gives information about the
+widget. It is either the string `tt(builtin)' for builtin widgets, a
+string of the form `tt(user:)var(name)' for user-defined widgets,
+where var(name) is the name of the shell function implementing the
+widget, or it is a string of the form
+`tt(completion:)var(type)tt(:)var(name)', for completion widgets. In
+the last case var(type) is the name of the builtin widgets the
+completion widget imitates in its behavior and var(name) is the name
+of the shell function implementing the completion widget.
+)
+enditem()