diff options
Diffstat (limited to 'Doc/Zsh/zle.yo')
| -rw-r--r-- | Doc/Zsh/zle.yo | 57 |
1 files changed, 53 insertions, 4 deletions
diff --git a/Doc/Zsh/zle.yo b/Doc/Zsh/zle.yo index 743fb7f93..ce1b27fec 100644 --- a/Doc/Zsh/zle.yo +++ b/Doc/Zsh/zle.yo @@ -102,7 +102,8 @@ 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. -Finally, they can examine and edit the ZLE buffer being edited by +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 reading and setting the special parameters described below. cindex(parameters, editor) @@ -162,7 +163,11 @@ and meta-keys are reported with a leading `tt(M-)', as in `tt(M-a)' and ) vindex(NUMERIC) item(tt(NUMERIC) (integer))( -The numeric argument. +The numeric argument. If no numeric argument was given, this parameter +is unset. When this is set inside a widget function, builtin widgets +called with the tt(zle) builtin command will use the value +assigned. If it is unset inside awidget function, builtin widgets +called behave as if no numeric argument was given. ) vindex(HISTNO) item(tt(HISTNO) (integer))( @@ -346,6 +351,10 @@ item(tt(down-line-or-search))( Move down a line in the buffer, or if already at the bottom line, search forward in the history for a line beginning with the first word in the buffer. + +If called from a function by the tt(zle) command with arguments, the first +argument is taken as the string for which to search, rather than the +first word in the buffer. ) tindex(down-history) item(tt(down-history) (unbound) (^N) (unbound))( @@ -414,6 +423,17 @@ search, leaving the last found line in the buffer. Any single character that is not bound to one of the above functions, or tt(self-insert) or tt(self-insert-unmeta), will have the same effect but the function will be executed. + +When called from a widget function by the tt(zle) command, the incremental +search commands can take a string argument. This will be treated as a +string of keys, as for arguments to the tt(bindkey) command, and used as +initial input for the command. Any characters in the string which are +unused by the incremental search will be silently ignored. For example, + +example(zle history-incremental-search-backward forceps) + +will search backwards for tt(forceps), leaving the minibuffer containing +the string `tt(forceps)'. ) tindex(history-incremental-search-forward) item(tt(history-incremental-search-forward) (^S ^Xs) (unbound) (unbound))( @@ -427,6 +447,10 @@ tindex(history-search-backward) item(tt(history-search-backward) (ESC-P ESC-p) (unbound) (unbound))( Search backward in the history for a line beginning with the first word in the buffer. + +If called from a function by the tt(zle) command with arguments, the first +argument is taken as the string for which to search, rather than the +first word in the buffer. ) tindex(vi-history-search-backward) item(tt(vi-history-search-backward) (unbound) (/) (unbound))( @@ -454,18 +478,27 @@ tt(magic-space) is treated as a space. Any other character that is not bound to self-insert or self-insert-unmeta will beep and be ignored. If the function is called from vi command mode, the bindings of the current insert mode will be used. + +If called from a function by the tt(zle) command with arguments, the first +argument is taken as the string for which to search, rather than the +first word in the buffer. ) tindex(history-search-forward) item(tt(history-search-forward) (ESC-N ESC-n) (unbound) (unbound))( Search forward in the history for a line beginning with the first word in the buffer. + +If called from a function by the tt(zle) command with arguments, the first +argument is taken as the string for which to search, rather than the +first word in the buffer. ) tindex(vi-history-search-forward) item(tt(vi-history-search-forward) (unbound) (?) (unbound))( Search forward in the history for a specified string. The string may begin with `tt(^)' to anchor the search to the beginning of the line. The functions available in the mini-buffer are the same -as for tt(vi-history-search-backward). +as for tt(vi-history-search-backward). Argument handling is also the same +as for that command. ) tindex(infer-next-history) item(tt(infer-next-history) (^X^N) (unbound) (unbound))( @@ -504,6 +537,10 @@ item(tt(up-line-or-search))( Move up a line in the buffer, or if already at the top line, search backward in the history for a line beginning with the first word in the buffer. + +If called from a function by the tt(zle) command with arguments, the first +argument is taken as the string for which to search, rather than the +first word in the buffer. ) tindex(up-history) item(tt(up-history) (unbound) (^P) (unbound))( @@ -800,7 +837,11 @@ startitem() tindex(digit-argument) item(tt(digit-argument) (ESC-0..ESC-9) (1-9) (unbound))( Start a new numeric argument, or add to the current one. -See also tt(vi-digit-or-beginning-of-line). +See also tt(vi-digit-or-beginning-of-line). This only works if bound to a +key sequence ending in a decimal digit. + +Inside a widget function, a call to this function treats the last key of +the key sequence which called the widget as the digit. ) tindex(neg-argument) item(tt(neg-argument) (ESC--) (unbound) (unbound))( @@ -815,6 +856,10 @@ repeated using this command. For example, if this command occurs twice, followed immediately by tt(forward-char), move forward sixteen spaces; if instead it is followed by tt(-2), then tt(forward-char), move backward two spaces. + +Inside a widget function, if passed an argument, i.e. `tt(zle +universal-argument) var(num)', the numerical argument will be set to +var(num); this is equivalent to `tt(NUMERIC=)var(num)'. ) enditem() texinode(Completion)(Miscellaneous)(Arguments)(Zsh Line Editor) @@ -911,6 +956,10 @@ item(tt(accept-line-and-down-history) (^O) (unbound) (unbound))( Execute the current line, and push the next history event on the the buffer stack. ) +tindex(beep) +item(tt(beep))( +Beep, unless the tt(BEEP) option is unset. +) tindex(vi-cmd-mode) item(tt(vi-cmd-mode) (^X^V) (unbound) (^[))( Enter command mode; that is, select the `tt(vicmd)' keymap. |