diff options
Diffstat (limited to 'Doc')
| -rw-r--r-- | Doc/Zsh/compwid.yo | 27 | ||||
| -rw-r--r-- | Doc/Zsh/zle.yo | 6 |
2 files changed, 20 insertions, 13 deletions
diff --git a/Doc/Zsh/compwid.yo b/Doc/Zsh/compwid.yo index abf15a324..bb283ffed 100644 --- a/Doc/Zsh/compwid.yo +++ b/Doc/Zsh/compwid.yo @@ -12,23 +12,28 @@ ifnzman(noderef(The zsh/zle Module))\ example(zle -C complete expand-or-complete completer) -defines a widget named tt(complete). When this widget is bound to a key -using the tt(bindkey) builtin command defined in the tt(zsh/zle) module -(see -ifzman(zmanref(zshzle))\ -ifnzman(noderef(Zsh Line Editor))\ -), typing that key will call the shell function tt(completer). This -function is responsible for generating the possible matches using the -builtins described below. Once the function returns, the completion code -takes over control again and treats the matches as the builtin widget -tt(expand-or-complete) would do. For this second argument, the name of any -of the builtin widgets that handle completions can be given: +defines a widget named `tt(complete)'. The second argument is the name +of any of the builtin widgets that handle completions: tt(complete-word), tt(expand-or-complete), tt(expand-or-complete-prefix), tt(menu-complete), tt(menu-expand-or-complete), tt(reverse-menu-complete), tt(list-choices), or tt(delete-char-or-list). Note that this will still work even if the widget in question has been rebound. +When this newly defined widget is bound to a key +using the tt(bindkey) builtin command defined in the tt(zsh/zle) module +(\ +ifzman(see zmanref(zshzle))\ +ifnzman(noderef(Zsh Line Editor))\ +), typing that key will call the shell function `tt(completer)'. This +function is responsible for generating the possible matches using the +builtins described below. As with other ZLE widgets, the function is +called with its standard input closed. + +Once the function returns, the completion code takes over control again +and treats the matches in the same manner as the specified builtin +widget, in this case tt(expand-or-complete). + startmenu() menu(Special Parameters) menu(Builtin Commands) diff --git a/Doc/Zsh/zle.yo b/Doc/Zsh/zle.yo index 31eb4dec9..49c8f8e88 100644 --- a/Doc/Zsh/zle.yo +++ b/Doc/Zsh/zle.yo @@ -104,8 +104,10 @@ cindex(widgets, user-defined) User-defined widgets, being implemented as shell functions, can execute any normal shell command. They can also run other widgets (whether built-in or user-defined) using the tt(zle) builtin command. -They can use tt(read -k) or tt(read -q) to read characters from standard -input. Finally, they can examine and edit the ZLE buffer being edited by +The standard input of the function is closed to prevent external commands +from unintentionally blocking ZLE by reading from the terminal, but +tt(read -k) or tt(read -q) can be used to read characters. Finally, +they can examine and edit the ZLE buffer being edited by reading and setting the special parameters described below. cindex(parameters, editor) |