summary refs log tree commit diff
diff options
context:
space:
mode:
authorWayne Davison <wayned@users.sourceforge.net>2001-04-11 05:27:24 +0000
committerWayne Davison <wayned@users.sourceforge.net>2001-04-11 05:27:24 +0000
commit50a2ef61bff82d34844f8ed0265b3cbc47e544da (patch)
tree990afac151ab56e6a8bae07dfd2d62bc6691b9ed
parente3e22f715c9fabc70de730347858197a0bda28bd (diff)
downloadzsh-50a2ef61bff82d34844f8ed0265b3cbc47e544da.tar.gz
zsh-50a2ef61bff82d34844f8ed0265b3cbc47e544da.tar.xz
zsh-50a2ef61bff82d34844f8ed0265b3cbc47e544da.zip
Updated the "preexec" docs.
-rw-r--r--Doc/Zsh/func.yo10
1 files changed, 8 insertions, 2 deletions
diff --git a/Doc/Zsh/func.yo b/Doc/Zsh/func.yo
index 67d496cd6..f6ff2a116 100644
--- a/Doc/Zsh/func.yo
+++ b/Doc/Zsh/func.yo
@@ -172,8 +172,14 @@ Executed before each prompt.
 findex(preexec)
 item(tt(preexec))(
 Executed just after a command has been read and is about to be
-executed.  If the history mechanism is active, the string to be
-executed is passed as an argument.
+executed.  If the history mechanism is active (and the line was not
+discarded from the history buffer), the string that the user typed is
+passed as the first argument, otherwise it is an empty string.  The
+actual command that will be executed (including expanded aliases) is
+passed in two differnt forms: the second argument is a single-line,
+size-limited version of the command (with things like function bodies
+elided); the third argument contains the full text what what is being
+executed.
 )
 item(tt(TRAP)var(NAL))(
 cindex(signals, trapping)