diff options
Diffstat (limited to 'Doc/Zsh/compsys.yo')
| -rw-r--r-- | Doc/Zsh/compsys.yo | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/Doc/Zsh/compsys.yo b/Doc/Zsh/compsys.yo index 1cd61a22f..370585863 100644 --- a/Doc/Zsh/compsys.yo +++ b/Doc/Zsh/compsys.yo @@ -863,7 +863,7 @@ that implement a state machine. In this case, the `var(string)' (with all leading and trailing spaces and tabs removed) will be stored in the global parameter tt(state) and the function returns with a return value of 300 (to make it distinguishable from other return values) -after setting the global `tt(line)' and `tt(options)' +after setting the global `tt(line)' and `tt(opt_args)' parameters as described below and without resetting any changes made to the special parameters such as tt(PREFIX) and tt(words). @@ -894,7 +894,7 @@ During the evaluation or execution of the action the array `tt(line)' will be set to the command name and normal arguments from the command line, i.e. to the words from the command line excluding all options and their arguments. These are stored in the associative array -`tt(options)', using the option names as keys and their arguments as +`tt(opt_args)', using the option names as keys and their arguments as the values. For options that have more than one argument these are given as one string, separated by colons. All colons in the original arguments are preceded with backslashes. @@ -1044,6 +1044,10 @@ To decide if the descriptions for the values (not those for the arguments) should be printed, the configuration key tt(describe_values) is used in the same way as the key tt(describe_options) is used by the tt(_arguments) function. + +One last difference is that this function uses the associative array +tt(val_args) to report values and their arguments (but otherwise this +is the same as the tt(opt_args) association used by tt(_arguments)). ) item(tt(_regex_arguments))( This function is a compiler to generate a completion function. The |