diff options
Diffstat (limited to 'Doc/Zsh/mod_computil.yo')
| -rw-r--r-- | Doc/Zsh/mod_computil.yo | 34 |
1 files changed, 21 insertions, 13 deletions
diff --git a/Doc/Zsh/mod_computil.yo b/Doc/Zsh/mod_computil.yo index fc1959bf1..00a9c4d49 100644 --- a/Doc/Zsh/mod_computil.yo +++ b/Doc/Zsh/mod_computil.yo @@ -1,31 +1,36 @@ -texinode(The computil Module)(The deltochar Module)(The complist Module)(Zsh Modules) -sect(The computil Module) +COMMENT(!MOD!zsh/computil +A module with utility builtins needed for the shell function based +completion system. +!MOD!) cindex(completion, utility) -The tt(computil) module adds four builtin commands that are used by +The tt(zsh/computil) module adds several builtin commands that are used by some of the completion functions in the shell function based completions system (see ifzman(zmanref(zshcompsys))\ ifnzman(noderef(Completion System)) -). Except for tt(compdisplay) these builtin commands are very +). Except for tt(compquote) these builtin commands are very specialised and thus not very interesting when writing your own completion functions. In short, these builtin commands are: startitem() -item(tt(compdisplay) var(name) var(string) var(defs) ...)( -The var(defs) are strings should be of the form -`var(str)tt(:)var(descr)' (the intended use is that the var(descr) -describes the var(str)) and tt(compdisplay) will convert them to -strings in which the colon is replaced by the var(string) given as the -second argument and spaces are inserted before that so that they are -aligned over all strings. These resultings strings are then assigned -to an array with the var(name) given as the first argument. +item(tt(compquote) var(names) ...)( +There may be reasons to write completion functions that have to add +the matches using the tt(-Q) option to tt(compadd) and do the quoting +themselves. Instead of interpreting the first character of the +tt(all_quotes) key of the tt(compstate) special association and using +the tt(q) flag for parameter expansions, one can use this builtin +command. The arguments are the names of scalar or array parameters +and the values of these parameters are quoted as needed for the +innermost quoting level. + +The return value is non-zero in case of an error and zero otherwise. ) item(tt(compdescribe))( This is used by the tt(_describe) function to build the displays for the matches and to get the strings to add as matches with their options. The first call has to give the tt(-i) or tt(-I) option as the first argument. In the first case, display strings without the -descriptions will be generated, inthe second case, the string used to +descriptions will be generated, in the second case, the string used to separate the matches from their descriptions has to be given as the second argument and the descriptions (if any) will be shown. All other arguments are like the definition arguments to tt(_describe) itself. @@ -48,4 +53,7 @@ to access the state information to decide what should be completed. item(tt(compvalues))( Like tt(comparguments), but for the tt(_values) function. ) +item(tt(comptags), tt(comptry))( +This implements the internals of the tags mechanism. +) enditem() |