about summary refs log tree commit diff
diff options
context:
space:
mode:
authorFrank Terbeck <ft@bewatermyfriend.org>2013-03-23 18:07:01 +0100
committerFrank Terbeck <ft@bewatermyfriend.org>2013-04-05 17:23:46 +0200
commitdd638aea93c920228f164e38e350cd6388a6a645 (patch)
tree0f5c1c45eaf21644aee519c89a38b3bb402076cb
parentdaf4f19c3f52c63c4131b66ee086b5214a67d451 (diff)
downloadzsh-dd638aea93c920228f164e38e350cd6388a6a645.tar.gz
zsh-dd638aea93c920228f164e38e350cd6388a6a645.tar.xz
zsh-dd638aea93c920228f164e38e350cd6388a6a645.zip
31175: Add documentation for the new -i and -f options of vared
-rw-r--r--ChangeLog3
-rw-r--r--Doc/Zsh/zle.yo5
2 files changed, 8 insertions, 0 deletions
diff --git a/ChangeLog b/ChangeLog
index 792cd313e..3051eef36 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -6,6 +6,9 @@
 	* 31172: Src/Zle/zle_main.c: 31172: Let vared define custom init
 	and finish hooks
 
+	* 31175: Doc/Zsh/zle.yo: 31175: Add documentation for the new -i
+	and -f options of vared
+
 2013-04-04  Peter Stephenson  <p.stephenson@samsung.com>
 
 	* 31203: Completion/Unix/Command/.distfiles,
diff --git a/Doc/Zsh/zle.yo b/Doc/Zsh/zle.yo
index 3e8c25a90..3549fdae2 100644
--- a/Doc/Zsh/zle.yo
+++ b/Doc/Zsh/zle.yo
@@ -308,6 +308,7 @@ cindex(parameters, editing)
 cindex(editing parameters)
 xitem(tt(vared) [ tt(-Aache) ] [ tt(-p) var(prompt) ] [ tt(-r) var(rprompt) ])
 xitem(  [ tt(-M) var(main-keymap) ] [ tt(-m) var(vicmd-keymap) ])
+xitem(  [ tt(-i) var(init-widget) ] [ tt(-f) var(finish-widget) ])
 item(  [ tt(-t) var(tty) ] var(name))(
 The value of the parameter var(name) is loaded into the edit
 buffer, and the line editor is invoked.  When the editor exits,
@@ -343,6 +344,10 @@ to override tt(viins) and tt(vicmd).  For emacs-style editing, only tt(-M)
 is normally needed but the tt(-m) option may still be used.  On exit, the
 previous keymaps will be restored.
 
+tt(Vared) calls the usual `tt(zle-line-init)' and `tt(zle-line-finish)'
+hooks before and after it takes control. Using the tt(-i) and tt(-f)
+options, it is possible to replace these with other costum widgets.
+
 If `tt(-t) var(tty)' is given, var(tty) is the name of a terminal device
 to be used instead of the default tt(/dev/tty).  If var(tty) does not
 refer to a terminal an error is reported.