summary refs log tree commit diff
path: root/Doc/Zsh
diff options
context:
space:
mode:
authorBart Schaefer <barts@users.sourceforge.net>2011-03-08 16:08:37 +0000
committerBart Schaefer <barts@users.sourceforge.net>2011-03-08 16:08:37 +0000
commit07d1d2d402ef01825833f4c09b4de88c2391cc78 (patch)
tree208c42a7448abec401550a9d32498cd756d9a67b /Doc/Zsh
parent7bc97b920b74e7d9046c8a4489ecd0a0e646bdde (diff)
downloadzsh-07d1d2d402ef01825833f4c09b4de88c2391cc78.tar.gz
zsh-07d1d2d402ef01825833f4c09b4de88c2391cc78.tar.xz
zsh-07d1d2d402ef01825833f4c09b4de88c2391cc78.zip
Greg Klanderman: 28846: adapt prefix-needed zstyle to handle the
completion function naming convention of a leading underscore.
Diffstat (limited to 'Doc/Zsh')
-rw-r--r--Doc/Zsh/compsys.yo28
1 files changed, 22 insertions, 6 deletions
diff --git a/Doc/Zsh/compsys.yo b/Doc/Zsh/compsys.yo
index 4a24df74e..f878ebcab 100644
--- a/Doc/Zsh/compsys.yo
+++ b/Doc/Zsh/compsys.yo
@@ -2298,13 +2298,29 @@ The default value for this style is `false'.
 )
 kindex(prefix-needed, completion style)
 item(tt(prefix-needed))(
-This, too, is used for matches with a common prefix.  If it is set to
-`true' this common prefix must be typed by the user to generate the
-matches.  In the case of command options, this means that the initial
-`tt(-)', `tt(+)', or `tt(-)tt(-)' must be typed explicitly before option
-names will be completed.
+This style is also relevant for matches with a common prefix.  If it is
+set to `true' this common prefix must be typed by the user to generate
+the matches.
 
-The default value for this style is `true'.
+The style is applicable to the tt(options), tt(signals), tt(jobs),
+tt(functions), and tt(parameters) completion tags.
+
+For command options, this means that the initial `tt(-)', `tt(+)', or
+`tt(-)tt(-)' must be typed explicitly before option names will be
+completed.
+
+For signals, an initial `tt(-)' is required before signal names will
+be completed.
+
+For jobs, an initial `tt(%)' is required before job names will be
+completed.
+
+For function and parameter names, an initial `tt(_)' or `tt(.)' is
+required before function or parameter names starting with those
+characters will be completed.
+
+The default value for this style is `false' for tt(function) and
+tt(parameter) completions, and  `true' otherwise.
 )
 kindex(preserve-prefix, completion style)
 item(tt(preserve-prefix))(