diff options
| author | Barton E. Schaefer <schaefer@zsh.org> | 2016-01-26 22:47:59 -0800 |
|---|---|---|
| committer | Barton E. Schaefer <schaefer@zsh.org> | 2016-01-27 22:10:38 -0800 |
| commit | 85c185aa895732e80d8865a851d3f7a27bbdcb5e (patch) | |
| tree | 2640f2f3268b37ca6e6185c4832ebf1fa6d4e6b2 /Doc | |
| parent | 8ddcdad0c1559612b72b733e907d10806415d4fb (diff) | |
| download | zsh-85c185aa895732e80d8865a851d3f7a27bbdcb5e.tar.gz zsh-85c185aa895732e80d8865a851d3f7a27bbdcb5e.tar.xz zsh-85c185aa895732e80d8865a851d3f7a27bbdcb5e.zip | |
37802: Clarify zparseopts description. (This file inadvertently ommitted
from previous commit.)
Diffstat (limited to 'Doc')
| -rw-r--r-- | Doc/Zsh/mod_zutil.yo | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/Doc/Zsh/mod_zutil.yo b/Doc/Zsh/mod_zutil.yo index fd6f2f384..dc17161f1 100644 --- a/Doc/Zsh/mod_zutil.yo +++ b/Doc/Zsh/mod_zutil.yo @@ -179,13 +179,14 @@ item(tt(zregexparse))( This implements some internals of the tt(_regex_arguments) function. ) findex(zparseopts) -item(tt(zparseopts) [ tt(-DKME) ] [ tt(-a) var(array) ] [ tt(-A) var(assoc) ] var(spec) ...)( +item(tt(zparseopts) [ tt(-D) tt(-K) tt(-M) tt(-E) ] [ tt(-a) var(array) ] [ tt(-A) var(assoc) ] var(spec) ...)( This builtin simplifies the parsing of options in positional parameters, i.e. the set of arguments given by tt($*). Each var(spec) describes one option and must be of the form `var(opt)[tt(=)var(array)]'. If an option described by var(opt) is found in the positional parameters it is copied into the var(array) specified with the tt(-a) option; if the optional -`tt(=)var(array)' is given, it is instead copied into that array. +`tt(=)var(array)' is given, it is instead copied into that array, which +should be declared as a normal array and never as an associative array. Note that it is an error to give any var(spec) without an `tt(=)var(array)' unless one of the tt(-a) or tt(-A) options is used. @@ -232,7 +233,10 @@ first colon. ) enditem() -The options of tt(zparseopts) itself are: +The options of tt(zparseopts) itself cannot be stacked because, for +example, the stack `tt(-DEK)' is indistinguishable from a var(spec) for +the GNU-style long option `tt(--DEK)'. The options of tt(zparseopts) +itself are: startitem() item(tt(-a) var(array))( |