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

Merge pull request #789 from syohex/add-table-of-contents 

Add table of contents
This commit is contained in:
Shohei YOSHIDA 2021-03-23 15:27:54 +09:00 committed by GitHub
parent 788926ffba cec348209c
commit f0c856912c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
zsh-completions-howto.org
View File

@ -1,3 +1,22 @@
* Table of Contents :TOC:
- [[#intro][Intro]]
- [[#getting-started][Getting started]]
- [[#telling-zsh-which-function-to-use-for-completing-a-command][Telling zsh which function to use for completing a command]]
- [[#completing-generic-gnu-commands][Completing generic gnu commands]]
- [[#copying-completions-from-another-command][Copying completions from another command]]
- [[#writing-your-own-completion-functions][Writing your own completion functions]]
- [[#utility-functions][Utility functions]]
- [[#writing-simple-completion-functions-using-_describe][Writing simple completion functions using _describe]]
- [[#writing-completion-functions-using-_alternative][Writing completion functions using _alternative]]
- [[#writing-completion-functions-using-_arguments][Writing completion functions using _arguments]]
- [[#writing-completion-functions-using-_regex_arguments-and-_regex_words][Writing completion functions using _regex_arguments and _regex_words]]
- [[#complex-completions-with-_values-_sep_parts--_multi_parts][complex completions with _values, _sep_parts, & _multi_parts]]
- [[#adding-completion-words-directly-using-compadd][Adding completion words directly using compadd]]
- [[#testing--debugging][Testing & debugging]]
- [[#gotchas-things-to-watch-out-for][Gotchas (things to watch out for)]]
- [[#tips][Tips]]
- [[#other-resources][Other resources]]
* Intro * Intro
The official documentation for writing zsh completion functions is difficult to understand, and doesn't give many examples. 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 a few other tutorials on the web, however those tutorials only At the time of writing this document I was able to find a few other tutorials on the web, however those tutorials only