diff options
Diffstat (limited to 'Doc/Zsh/zle.yo')
| -rw-r--r-- | Doc/Zsh/zle.yo | 70 |
1 files changed, 53 insertions, 17 deletions
diff --git a/Doc/Zsh/zle.yo b/Doc/Zsh/zle.yo index 6d517b81b..31eb3f3ba 100644 --- a/Doc/Zsh/zle.yo +++ b/Doc/Zsh/zle.yo @@ -50,13 +50,15 @@ argument causes the next command entered to be repeated the specified number of times, unless otherwise noted below; this is implemented by the tt(digit-argument) widget. See also ifzman(the em(Arguments) subsection of the em(Widgets) section )\ -ifnzman(noderef(Arguments) )\ +ifnzman(noderef(Arguments))\ for some other ways the numeric argument can be modified. startmenu() menu(Keymaps) menu(Zle Builtins) menu(Zle Widgets) +menu(User-Defined Widgets) +menu(Standard Widgets) menu(Character Highlighting) endmenu() @@ -107,6 +109,7 @@ In the `tt(.safe)' keymap, each single key is bound to tt(self-insert), except for ^J (line feed) and ^M (return) which are bound to tt(accept-line). This is deliberately not pleasant to use; if you are using it, it means you deleted the main keymap, and you should put it back. + subsect(Reading Commands) When ZLE is reading a command from the terminal, it may read a sequence that is bound to some command and is also a prefix of a longer bound string. @@ -137,6 +140,7 @@ in user-defined widgets with the tt(read-command) widget, described in ifzman(the subsection `Miscellaneous' of the section `Standard Widgets' below)\ ifnzman(noderef(Miscellaneous) below)\ . + subsect(Local Keymaps) cindex(local keymaps) While for normal editing a single keymap is used exclusively, in many @@ -372,7 +376,7 @@ If the tt(-p) flag is given, the following string will be taken as the prompt to display at the left. If the tt(-r) flag is given, the following string gives the prompt to display at the right. If the tt(-h) flag is specified, the history can be accessed from ZLE. If the -tt(-e) flag is given, typing tt(^D) (Control-D) on an empty line +tt(-e) flag is given, typing tt(^D) (Control-D) in an empty buffer causes tt(vared) to exit immediately with a non-zero return value. The tt(-M) option gives a keymap to link to the tt(main) keymap during @@ -728,15 +732,17 @@ enditem() ) enditem() -texinode(Zle Widgets)(Character Highlighting)(Zle Builtins)(Zsh Line Editor) -sect(Widgets) +texinode(Zle Widgets)(User-Defined Widgets)(Zle Builtins)(Zsh Line Editor) +sect(Zle Widgets) cindex(widgets) All actions in the editor are performed by `widgets'. A widget's job is simply to perform some small action. The ZLE commands that key sequences in keymaps are bound to are in fact widgets. Widgets can be user-defined or built in. -The standard widgets built into ZLE are listed in Standard Widgets below. +The standard widgets built into ZLE are listed in +ifzman(the section `Standard Widgets' below)\ +ifnzman(noderef(Standard Widgets)). Other built-in widgets can be defined by other modules (see ifzman(zmanref(zshmodules))\ ifnzman(noderef(Zsh Modules))\ @@ -750,6 +756,8 @@ as shell functions. When the widget is executed, the corresponding shell function is executed, and can perform editing (or other) actions. It is recommended that user-defined widgets should not have names starting with `tt(.)'. + +texinode(User-Defined Widgets)(Standard Widgets)(Zle Widgets)(Zsh Line Editor) sect(User-Defined Widgets) cindex(widgets, user-defined) User-defined widgets, being implemented as shell functions, @@ -1206,6 +1214,7 @@ This can be used for detecting switches between the vi command ) enditem() +texinode(Standard Widgets)(Character Highlighting)(User-Defined Widgets)(Zsh Line Editor) sect(Standard Widgets) cindex(widgets, standard) The following is a list of all the standard widgets, @@ -1231,7 +1240,7 @@ menu(Completion) menu(Miscellaneous) menu(Text Objects) endmenu() -texinode(Movement)(History Control)()(Zle Widgets) +texinode(Movement)(History Control)()(Standard Widgets) subsect(Movement) startitem() tindex(vi-backward-blank-word) @@ -1378,7 +1387,7 @@ item(tt(up-line) (unbound) (unbound) (unbound))( Move up a line in the buffer. ) enditem() -texinode(History Control)(Modifying Text)(Movement)(Zle Widgets) +texinode(History Control)(Modifying Text)(Movement)(Standard Widgets) subsect(History Control) startitem() tindex(beginning-of-buffer-or-history) @@ -1726,7 +1735,7 @@ the numeric argument. Zero for both local and imported lines and nonzero for only local lines. ) enditem() -texinode(Modifying Text)(Arguments)(History Control)(Zle Widgets) +texinode(Modifying Text)(Arguments)(History Control)(Standard Widgets) subsect(Modifying Text) startitem() tindex(vi-add-eol) @@ -2052,7 +2061,7 @@ into the kill buffer. Arguably, this is what Y should do in vi, but it isn't what it actually does. ) enditem() -texinode(Arguments)(Completion)(Modifying Text)(Zle Widgets) +texinode(Arguments)(Completion)(Modifying Text)(Standard Widgets) subsect(Arguments) startitem() tindex(digit-argument) @@ -2100,7 +2109,7 @@ example(zle argument-base 16 zle universal-argument) ) enditem() -texinode(Completion)(Miscellaneous)(Arguments)(Zle Widgets) +texinode(Completion)(Miscellaneous)(Arguments)(Standard Widgets) subsect(Completion) startitem() tindex(accept-and-menu-complete) @@ -2175,7 +2184,7 @@ When a previous completion displayed a list below the prompt, this widget can be used to move the prompt below the list. ) enditem() -texinode(Miscellaneous)(Text Objects)(Completion)(Zle Widgets) +texinode(Miscellaneous)(Text Objects)(Completion)(Standard Widgets) subsect(Miscellaneous) startitem() tindex(accept-and-hold) @@ -2461,10 +2470,11 @@ command. tt(run-help) is normally aliased to tt(man). tindex(vi-set-buffer) item(tt(vi-set-buffer) (unbound) (tt(")) (unbound))( Specify a buffer to be used in the following command. -There are 37 buffers that can be specified: +There are 39 buffers that can be specified: the 26 `named' buffers tt("a) to tt("z), the `yank' buffer tt("0), -the nine `queued' buffers tt("1) to tt("9) and the `black hole' buffer -tt("_). The named buffers can also be specified as tt("A) to tt("Z). +the nine `queued' buffers tt("1) to tt("9), the `black hole' buffer +tt("_) and the system selection tt("*) and clipboard tt("+). +The named buffers can also be specified as tt("A) to tt("Z). When a buffer is specified for a cut, change or yank command, the text concerned replaces the previous contents of the specified buffer. If @@ -2473,6 +2483,10 @@ appended to the buffer instead of overwriting it. When using the tt("_) buffer, nothing happens. This can be useful for deleting text without affecting any buffers. +Updating the system clipboard relies on specific support from the terminal. +Reading it is not possible so a paste command with tt("*) or tt("+) will do +nothing. + If no buffer is specified for a cut or change command, tt("1) is used, and the contents of tt("1) to tt("8) are each shifted along one buffer; the contents of tt("9) is lost. If no buffer is specified for a yank @@ -2573,7 +2587,7 @@ If the last command executed was a digit as part of an argument, continue the argument. Otherwise, execute vi-beginning-of-line. ) enditem() -texinode(Text Objects)()(Miscellaneous)(Zle Widgets) +texinode(Text Objects)()(Miscellaneous)(Standard Widgets) subsect(Text Objects) cindex(text objects) Text objects are commands that can be used to select a block of text @@ -2618,7 +2632,7 @@ argument, multiple words will be selected. ) enditem() -texinode(Character Highlighting)()(Zle Widgets)(Zsh Line Editor) +texinode(Character Highlighting)()(Standard Widgets)(Zsh Line Editor) sect(Character Highlighting) vindex(zle_highlight, setting) @@ -2677,6 +2691,9 @@ for different completions. item(tt(paste))( Following a command to paste text, the characters that were inserted. ) +item(tt(ellipsis))( +Markers used to indicate where the text doesn't fit within the terminal. +) enditem() When tt(region_highlight) is set, the contexts that describe a region DASH()- @@ -2766,9 +2783,13 @@ This works similarly to the foreground colour, except the background is not usually affected by the bold attribute. ) item(tt(bold))( -The characters in the given context are shown in a bold font. +The characters in the given context are shown with a bold font weight. Not all terminals distinguish bold fonts. ) +item(tt(faint))( +The characters in the given context are shown with a faint font weight. +Not all terminals distinguish faint fonts. +) item(tt(standout))( The characters in the given context are shown in the terminal's standout mode. The actual effect is specific to the terminal; on many terminals it @@ -2782,6 +2803,21 @@ The characters in the given context are shown underlined. Some terminals show the foreground in a different colour instead; in this case whitespace will not be highlighted. ) +item(tt(italic))( +The characters in the given context are shown in a italic font. +Not all terminals support italic fonts. +) +item(tt(hl=)var(group))( +Use the specified highlighting group. The var(group) is used as a key into +the associative array tt(.zle.hlgroups) to determine the actual highlighting. +) +item(tt(layer=)var(layer))( +The layer is used to determine precedence when multiple highlighting regions +overlap. The var(layer) is a decimal integer, with higher numbers taking +precedence over lower numbers. The default layer is 10 with 30 used as the +default for tt(special), 20 for tt(region) and tt(isearch) and 15 for +tt(paste). +) enditem() The characters described above as `special' are as follows. The |