mirrors/zsh
1
0
Fork 0
mirror of git://git.code.sf.net/p/zsh/code synced 2025-12-30 07:21:02 +01:00
Code Releases Activity

_arguments docs: Divide into subsections

Browse source
This commit is contained in:
Daniel Shahaf 2015-07-15 18:12:47 +00:00
parent 2d41e443a1
commit a98260b174
1 changed files with 12 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

12
Doc/Zsh/compsys.yo
View file

@ -3532,6 +3532,8 @@ This function can be used to give a complete specification for completion
for a command whose arguments follow standard UNIX option and argument
conventions.
em(Options overview)
Options to tt(_arguments) itself must be in separate words, i.e. tt(-s -w),
not tt(-sw). The options are followed by var(spec)s that describe options and
arguments of the analyzed command. var(spec)s that describe option flags must
@ -3630,6 +3632,8 @@ example(tt(r:|[_-]=* r:|=*))
)
enditem()
em(var(spec)s: overview)
Each of the following forms is a var(spec) describing individual sets of
options or arguments on the command line being analyzed.
@ -3797,6 +3801,8 @@ given by an array, and tt(_arguments) is called repeatedly for more
specific contexts: on the first call `tt(_arguments $global_options)' is
used, and on subsequent calls `tt(_arguments !$^global_options)'.
em(var(spec)s: actions)
In each of the forms above the var(action) determines how
completions should be generated. Except for the `tt(->)var(string)'
form below, the var(action) will be executed by calling the
@ -3949,6 +3955,8 @@ example(local curcontext="$curcontext")
This is useful where it is not possible for multiple states to be valid
together.
em(Specifying multiple sets of options)
It is possible to specify multiple sets of options and
arguments with the sets separated by single hyphens. The specifications
before the first hyphen (if any) are shared by all the remaining sets.
@ -3995,6 +4003,8 @@ A useful alternative is often an option specification with rest-arguments
(as in `tt(-foo:*:...)'); here the option tt(-foo) swallows up all
remaining arguments as described by the var(optarg) definitions.
em(Deriving var(spec) forms from the help output)
The option `tt(-)tt(-)' allows tt(_arguments) to work out the names of long
options that support the `tt(-)tt(-help)' option which is standard in many
GNU commands. The command word is called with the argument
@ -4067,6 +4077,8 @@ as `tt(-)tt(-enable-foo)', but the script also accepts the negated form
example(_arguments -- -s "LPAR()(#s)--enable- --disable-RPAR()")
em(Miscellaneous notes)
Finally, note that tt(_arguments) generally expects to be the primary
function handling any completion for which it is used. It may have side
effects which change the treatment of any matches added by other functions