summary refs log tree commit diff
path: root/Doc/Zsh/compsys.yo
diff options
context:
space:
mode:
authorSven Wischnowsky <wischnow@users.sourceforge.net>2002-05-14 07:54:23 +0000
committerSven Wischnowsky <wischnow@users.sourceforge.net>2002-05-14 07:54:23 +0000
commit1acda13c7048d2d994f49f4c9f29f79421b1dab8 (patch)
tree35dd07fb0c556ea9c377f53352b61b2e673df862 /Doc/Zsh/compsys.yo
parent139b6d48415becd3cafbc6a502fcfc19421ee2d7 (diff)
downloadzsh-1acda13c7048d2d994f49f4c9f29f79421b1dab8.tar.gz
zsh-1acda13c7048d2d994f49f4c9f29f79421b1dab8.tar.xz
zsh-1acda13c7048d2d994f49f4c9f29f79421b1dab8.zip
fix doc for _describe, mention -t option (17146)
Diffstat (limited to 'Doc/Zsh/compsys.yo')
-rw-r--r--Doc/Zsh/compsys.yo5
1 files changed, 4 insertions, 1 deletions
diff --git a/Doc/Zsh/compsys.yo b/Doc/Zsh/compsys.yo
index 139c82b38..200f83532 100644
--- a/Doc/Zsh/compsys.yo
+++ b/Doc/Zsh/compsys.yo
@@ -3616,7 +3616,7 @@ tt(compadd) when generating matches from the style value, or to
 the functions for the fields if they are called.
 )
 findex(_describe)
-item(tt(_describe) [ tt(-o) ] var(descr) var(name1) [ var(name2) ] var(opts) ... tt(-)tt(-) ...)(
+item(tt(_describe) [ tt(-o) | tt(-t) var(tag) ] var(descr) var(name1) [ var(name2) ] var(opts) ... tt(-)tt(-) ...)(
 This function is useful for preparing a list of command options or
 arguments, together with their descriptions var(descr), as matches.
 Multiple groups separated by tt(-)tt(-) can be supplied, potentially with
@@ -3639,6 +3639,9 @@ will be treated as option names (typically following a `tt(-)',
 the tt(prefix-hidden), tt(prefix-needed) and tt(verbose) styles to find out
 if the strings should be added at all and if the descriptions should be
 shown.  Without the `tt(-o)' option, only the tt(verbose) style is used.
+With the tt(-t) option a var(tag) can be specified that should be used
+instead of the default `tt(values)' or, if the tt(-o) option is given,
+`tt(options)'.
 
 If selected by the tt(list-grouped) style, strings with the same
 description will be added in a way that they appear together in the list.