xinb
/
zsh-completions
mirror of https://github.com/zsh-users/zsh-completions.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update

This commit is contained in:
Joe Bloggs 2014-03-25 22:07:11 +00:00
parent ffcc35f6b6
commit de8fd3f8bd
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
zsh-completions-howto.org
View File

@ -103,13 +103,13 @@ If you have a very large number of completions you can save them in a cache file
Many of the utility functions such as _arguments, _regex_arguments, _alternative and _values may include an action Many of the utility functions such as _arguments, _regex_arguments, _alternative and _values may include an action
at the end of an option/argument specification. This action indicates how to complete the corresponding argument. at the end of an option/argument specification. This action indicates how to complete the corresponding argument.
The actions can take one of the following forms: The actions can take one of the following forms:
| ( ) | Argument is required but no matches are generated for it. | | ( ) | Argument is required but no matches are generated for it. |
| (ITEM1 ITEM2 ETC) | List of possible matches | | (ITEM1 ITEM2) | List of possible matches |
| ((ITEM1\:DESC1 ITEM2\:DESC2 ETC\:BLAH)) | List of possible matches, with descriptions. | | ((ITEM1\:DESC1 ITEM2\:DESC2)) | List of possible matches, with descriptions. |
| ->STRING | Set $state to STRING and continue ($state can be checked in a case statement after the utility function call) | | ->STRING | Set $state to STRING and continue ($state can be checked in a case statement after the utility function call) |
| FUNCTION | Name of a function to call for generating matches or performing some other action, e.g. _files or _message | | FUNCTION | Name of a function to call for generating matches or performing some other action, e.g. _files or _message |
| {EVAL-STRING} | Evaluate string as shell code to generate matches. | | {EVAL-STRING} | Evaluate string as shell code to generate matches. |
| =ACTION | Inserts a dummy word into completion command line without changing the point at which completion takes place. | | =ACTION | Inserts a dummy word into completion command line without changing the point at which completion takes place. |
Not all action types are available for all utility functions that use them. For example the ->STRING type is not available in the Not all action types are available for all utility functions that use them. For example the ->STRING type is not available in the
_regex_arguments or _alternative functions. _regex_arguments or _alternative functions.
**** Examples **** Examples