From 8458eee0577bce8c479afa0897e7cacf99d3f7d5 Mon Sep 17 00:00:00 2001 From: Paul Ackersviller Date: Mon, 8 Oct 2007 15:44:35 +0000 Subject: Merge of users/10172: read-command reads a key sequence as in normal zle operation but sets REPLY to the result instead of executing it. --- Doc/Zsh/zle.yo | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) (limited to 'Doc') diff --git a/Doc/Zsh/zle.yo b/Doc/Zsh/zle.yo index fb6f508a0..5bb76ff35 100644 --- a/Doc/Zsh/zle.yo +++ b/Doc/Zsh/zle.yo @@ -103,6 +103,12 @@ This input can itself invoke further replacement strings, but in order to detect loops the process will be stopped if there are twenty such replacements without a real command being read. +A key sequence typed by the user can be turned into a command name for use +in user-defined widgets with the tt(read-command) widget, described +ifzman(below)\ +ifnzman(in noderef(Miscellaneous) below)\ +. + texinode(Zle Builtins)(Zle Widgets)(Keymaps)(Zsh Line Editor) sect(Zle Builtins) cindex(zle, builtin commands) @@ -1763,6 +1769,16 @@ At a secondary (tt(PS2)) prompt, move the entire current multiline construct into the editor buffer. The latter is equivalent to tt(push-input) followed by tt(get-line). ) +tindex(read-command) +item(tt(read-command))( +Only useful from a user-defined widget. A keystroke is read just as in +normal operation, but instead of the command being executed the name +of the command that would be executed is stored in the shell parameter +tt(REPLY). This can be used as the argument of a future tt(zle) +command. If the key sequence is not bound, status 1 is returned; +typically, however, tt(REPLY) is set to tt(undefined-key) to indicate +a useless key sequence. +) tindex(recursive-edit) item(tt(recursive-edit))( Only useful from a user-defined widget. At this point in the function, -- cgit 1.4.1