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 21:53:43 +00:00
parent 89a769a7af
commit f5a7053b70
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
zsh-completions-howto.org
View File

@ -117,6 +117,22 @@ Here the non-option argument
_arguments '--help[show help]' '-?[show help]' '1:First arg:_files' _arguments '--help[show help]' '-?[show help]' '1:First arg:_files'
#+END_SRC #+END_SRC
** Writing completion functions using _describe ** Writing completion functions using _describe
The _describe function can be used for simple completions where the order and position of the options/arguments is
not important. You just need to create an array parameter to hold the options & their descriptions, and then pass
the parameter name as an argument to _describe, e.g. like this:
#+BEGIN_SRC sh
local -a options
options=('-c:description for -c opt' '-d:description for -d opt')
_describe 'values' options
#+END_SRC
You can use several different lists separated by -- e.g. like this:
#+BEGIN_SRC sh
local -a options arguments
options=('-c:description for -c opt' '-d:description for -d opt')
arguments=('e:description for e arg' 'f:description for f arg')
_describe 'values' options -- arguments
#+END_SRC
** Writing completion functions using _alternative ** Writing completion functions using _alternative
** 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.