diff options
| author | Daniel Shahaf <d.s@daniel.shahaf.name> | 2020-09-26 10:24:09 +0000 |
|---|---|---|
| committer | Daniel Shahaf <d.s@daniel.shahaf.name> | 2020-10-03 05:32:35 +0000 |
| commit | 00d20ed15e18f5af682f0daec140d6b8383c479a (patch) | |
| tree | eb8053c37b088e1051a28fb4454819466e0226b7 /Doc/Zsh/zle.yo | |
| parent | 59a451abae442892e35b13844a612c7723ce699c (diff) | |
| download | zsh-00d20ed15e18f5af682f0daec140d6b8383c479a.tar.gz zsh-00d20ed15e18f5af682f0daec140d6b8383c479a.tar.xz zsh-00d20ed15e18f5af682f0daec140d6b8383c479a.zip | |
users/26088: docs: zle -R: Clarify that it needs not be called in the normal course of things, but only when an immediate, interim redisplay is desired.
Diffstat (limited to 'Doc/Zsh/zle.yo')
| -rw-r--r-- | Doc/Zsh/zle.yo | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/Doc/Zsh/zle.yo b/Doc/Zsh/zle.yo index 84be010e1..9694a1f74 100644 --- a/Doc/Zsh/zle.yo +++ b/Doc/Zsh/zle.yo @@ -501,8 +501,7 @@ ifnzman(noderef(Completion Widgets))\ . ) item(tt(-R) [ tt(-c) ] [ var(display-string) ] [ var(string) ... ])( -Redisplay the command line; this is to be called from within a user-defined -widget to allow changes to become visible. If a var(display-string) is +Redisplay the command line. If a var(display-string) is given and not empty, this is shown in the status line (immediately below the line being edited). @@ -511,9 +510,9 @@ prompt in the same way as completion lists are printed. If no var(string)s are given but the tt(-c) option is used such a list is cleared. -Note that this option is only useful for widgets that do not exit -immediately after using it because the strings displayed will be erased -immediately after return from the widget. +Note that immediately after returning from running widgets, the command line +will be redisplayed and the strings displayed will be erased. Therefore, this +option is only useful for widgets that do not exit immediately after using it. This command can safely be called outside user defined widgets; if zle is active, the display will be refreshed, while if zle is not active, the |