32 lines
1.8 KiB
Org Mode
32 lines
1.8 KiB
Org Mode
* Intro
|
|
The official documentation for writing zsh completion functions is difficult to understand, and doesn't give many examples.
|
|
At the time of writing this document I was able to find two other tutorials on the web, however both of those tutorials only
|
|
explain a small portion of the capabilities of the completion system. This document aims to give more complete and easy to
|
|
understand explanation for creating zsh completion functions. I do not go into all the details, but will give enough information
|
|
and examples to get you up and running. If you need more details you can look it up for yourself in the [[http://zsh.sourceforge.net/Doc/Release/Completion-System.html#Completion-System][official documentation]].
|
|
|
|
Please make any scripts that you create publically available for others (e.g. by forking this repo and making a [[id:64bcd501-b0f0-48c7-b8e2-07af708b95ec][pull request]]).
|
|
|
|
** Defining completion functions
|
|
Completion functions for commands are stored in files with names beginning with an underscore _, and these files should
|
|
be placed in a directory listed in the $fpath variable.
|
|
You can add a directory to $fpath by adding a line like this to your ~/.zshrc file:
|
|
#+BEGIN_SRC sh
|
|
fpath=(~/newdir $fpath)
|
|
#+END_SRC
|
|
* Utility functions with example code
|
|
** compadd
|
|
** _gnu_generic
|
|
** _arguments
|
|
|
|
** _regex_arguments
|
|
** _regex_words
|
|
** _values
|
|
** _comma_separated
|
|
* gotchas
|
|
* Putting it all together
|
|
* Other resources
|
|
[[http://wikimatze.de/writing-zsh-completion-for-padrino.html][Here]] is a nicely formatted short tutorial showing basic usage of the _arguments function,
|
|
and [[http://www.linux-mag.com/id/1106/][here]] is a slightly more advanced tutorial using the _arguments function.
|
|
[[http://zsh.sourceforge.net/Doc/Release/Completion-System.html#Completion-System][Here]] is the zshcompsys man page.
|