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-27 16:21:24 +00:00
parent dff3fe6d57
commit d98035be05
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
zsh-completions-howto.org
View File

@ -68,13 +68,15 @@ The compadd builtin is the core function used to add completion words to the com
However, most of the time you will not need to use compadd, since there are many utility functions such as _arguments However, most of the time you will not need to use compadd, since there are many utility functions such as _arguments
and _describe which are easier to use. and _describe which are easier to use.
For very basic completions the _describe function should be adequate
** Utility functions ** Utility functions
Here is a list of some of the utility functions that may be of use. Here is a list of some of the utility functions that may be of use.
The full list of utility functions, with full explanations, is available [[http://zsh.sourceforge.net/Doc/Release/Completion-System.html#Completion-Functions][here]]. The full list of utility functions, with full explanations, is available [[http://zsh.sourceforge.net/Doc/Release/Completion-System.html#Completion-Functions][here]].
Examples of how to use these functions are given in the next section. Examples of how to use these functions are given in the next section.
*** main utility functions for overall completion *** main utility functions for overall completion
| _alternative | Loop over tag labels and perform actions based on matching tag label. | | _alternative | Can be used to generate completion candidates from other utility functions or shell code. |
| _arguments | Used to specify how to complete individual options & arguments for a command with unix style options. | | _arguments | Used to specify how to complete individual options & arguments for a command with unix style options. |
| _describe | Used for creating simple completions consisting of single words with descriptions (but no actions). Easier to use than _arguments | | _describe | Used for creating simple completions consisting of single words with descriptions (but no actions). Easier to use than _arguments |
| _gnu_generic | Can be used to complete options for commands that understand the `--help' option. | | _gnu_generic | Can be used to complete options for commands that understand the `--help' option. |
@ -313,11 +315,10 @@ firstword2=("$reply[@]")
_regex_arguments _hello /$'[^\0]##\0'/ "${firstword[@]}" "${firstword2[@]}" _regex_arguments _hello /$'[^\0]##\0'/ "${firstword[@]}" "${firstword2[@]}"
_hello "$@" _hello "$@"
#+END_SRC #+END_SRC
In this case the first word can be one of "foo", "man", "chu", "boo", "ga" or "loo".
If the first word is "boo" or "ga" then the second word can be "woo" or "hoo",
and if the first word is "loo" then the second word can be "yee" or "haa", in the other
cases there is no second word.
*** Patterns *** Patterns
Note * = wildcard, # = wildcard Note * = wildcard, # = wildcard
* Testing & debugging * Testing & debugging