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 16:02:14 +00:00
parent 815c0a73ff
commit 886184642f
1 changed files with 25 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
zsh-completions-howto.org
View File

@ -68,27 +68,31 @@ However, most of the time you will not need to use compadd, since there are many
and _regex_arguments which are easier to use. and _regex_arguments which are easier to use.
** Utility functions ** Utility functions
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 Here is a list of some of the utility functions that may be of use.
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]].
| _alternative | Loop over tag labels and perform actions based on matching tag label. | *** main utility functions for overall completion
| _arguments | Used to specify how to complete individual command line options for a command with unix style options. Often used. | | _arguments | Used to specify how to complete individual command line options for a command with unix style options. Often used. |
| _combination | Used to complete combinations of values, for example pairs of hostnames and usernames. | | _regex_arguments | Creates a function for matching commandline arguments with regular expressions, and then performing actions/completions. |
| _gnu_generic | Wrapper around the _arguments function. 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. |
| _guard | Can be used in the ACTION of specifications for _arguments and similar functions to check the word being completed. | | _alternative | Loop over tag labels and perform actions based on matching tag label. |
| _message | Used for displaying help messages in places where no completions can be generated. | *** functions for performing complex completions
| _multi_parts | Used for completing multiple parts of word separately where each part is seperated by some char, e.g. for completing partial filepaths: /u/i/sy -> /usr/include/sys | | _values | Used for completing arbitrary keywords (values) and their arguments, or comma separated lists of such combinations. |
| _options | Can be used to complete the names of shell options. | | _combination | Used to complete combinations of values, for example pairs of hostnames and usernames. |
| _parameters | Used to complete the names of shell parameters/variables (can restrict to those matching a pattern). | | _multi_parts | Used for completing multiple parts of words separately where each part is separated by some char, e.g. for completing partial filepaths: /u/i/sy -> /usr/include/sys |
| _pick_variant | Used for resolving situations where there are several different commands with the same name each having different completion strategies. | | _sep_parts | Like _multi_parts but allows different separators at different parts of the completion. |
| _regex_arguments | Creates a function for matching commandline arguments with regular expressions, and then performing actions/completions. | *** functions for completing specific types of objects
| _regex_words | Can be used to generate arguments for the _regex_arguments command. This should be easier than writing the arguments manually. | | _path_files | Used to complete filepaths. Take several options to control behaviour. |
| _sep_parts | Given a list of alternating arrays and separators, use the arrays to complete corresponding parts of string containing separators (see also _multi_parts) | | _files | Calls _path_files with all options except -g and -/. These options depend on file-patterns style setting. |
| _values | Used for completing arbitrary keywords (values) and their arguments, or comma separated lists of such combinations. Can be an ACTION in an _arguments/_regex_arguments spec. | | _net_interfaces | Used for completing network interface names |
| _path_files | Used to complete filepaths. Can complete partial paths, e.g. /u/i/sy -> /usr/include/sys | | _users | Used for completing user names |
| _files | Calls _path_files with all options except -g and -/. These options depend on file-patterns style setting. | | _groups | Used for completing group names |
| _net_interfaces | Used for completing network interface names | | _options | Used for completing the names of shell options. |
| _users | | | _parameters | Used for completing the names of shell parameters/variables (can restrict to those matching a pattern). |
| _groups | | *** other functions
| _message | Used for displaying help messages in places where no completions can be generated. |
| _regex_words | Can be used to generate arguments for the _regex_arguments command. This is easier than writing the arguments manually. |
| _guard | Can be used in the ACTION of specifications for _arguments and similar functions to check the word being completed. |
** Writing completion functions using _arguments ** Writing completion functions using _arguments
The _arguments function makes it easy to create completion functions. The _arguments function makes it easy to create completion functions.
As arguments it takes special strings specifying the options & arguments to the function being completed, As arguments it takes special strings specifying the options & arguments to the function being completed,
@ -100,8 +104,6 @@ This example completes the options --help & -? when trying to complete a hyphen,
with the same description in this case. The first non-option argument is completed using the _files function which with the same description in this case. The first non-option argument is completed using the _files function which
completes file/directories. completes file/directories.
The
There are a couple of tutorials on how to use _arguments [[http://www.linux-mag.com/id/1106/][here]] and [[http://wikimatze.de/writing-zsh-completion-for-padrino.html][here]], so I won't cover any more here. There are a couple of tutorials on how to use _arguments [[http://www.linux-mag.com/id/1106/][here]] and [[http://wikimatze.de/writing-zsh-completion-for-padrino.html][here]], so I won't cover any more here.
Also have a look at the many completion functions listed [[https://github.com/vapniks/zsh-completions/tree/master/src][here]] many of which use _arguments. Also have a look at the many completion functions listed [[https://github.com/vapniks/zsh-completions/tree/master/src][here]] many of which use _arguments.
The full documentation for _arguments is available [[http://zsh.sourceforge.net/Doc/Release/Completion-System.html#Completion-Functions][here]]. The full documentation for _arguments is available [[http://zsh.sourceforge.net/Doc/Release/Completion-System.html#Completion-Functions][here]].