summary refs log tree commit diff
path: root/Doc/Zsh
diff options
context:
space:
mode:
authorPeter Stephenson <p.w.stephenson@ntlworld.com>2015-01-04 00:28:03 +0000
committerPeter Stephenson <p.w.stephenson@ntlworld.com>2015-01-04 00:28:03 +0000
commitaa622e08014744c54e585e34613c2572a27f0f4b (patch)
tree7a593962eea341db5efbe6f7b9abc737decce88e /Doc/Zsh
parent454bb777cfc9b9c7970ccc1c7574fbf66b83d157 (diff)
downloadzsh-aa622e08014744c54e585e34613c2572a27f0f4b.tar.gz
zsh-aa622e08014744c54e585e34613c2572a27f0f4b.tar.xz
zsh-aa622e08014744c54e585e34613c2572a27f0f4b.zip
users/19682: document recommended use of whence
Diffstat (limited to 'Doc/Zsh')
-rw-r--r--Doc/Zsh/builtins.yo7
1 files changed, 6 insertions, 1 deletions
diff --git a/Doc/Zsh/builtins.yo b/Doc/Zsh/builtins.yo
index b4f4b6742..49c2c11c3 100644
--- a/Doc/Zsh/builtins.yo
+++ b/Doc/Zsh/builtins.yo
@@ -2087,6 +2087,11 @@ item(tt(whence) [ tt(-vcwfpamsS) ] var(name) ...)(
 For each name, indicate how it would be interpreted if used as a
 command name.
 
+tt(whence) is most useful when var(name) is only the last path component
+of a command, i.e. does not include a `tt(/)'; in particular, pattern
+matching only succeeds if just the non-directory component of the command is
+passed.
+
 startitem()
 item(tt(-v))(
 Produce a more verbose report.
@@ -2119,7 +2124,7 @@ throughout the command path.
 Normally only the first occurrence is printed.
 )
 item(tt(-m))(
-The arguments are taken as patterns (should be
+The arguments are taken as patterns (pattern characters should be
 quoted), and the information is displayed for each command matching one
 of these patterns.
 )