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 _regex_words notes, and pattern notes

This commit is contained in:
Joe Bloggs 2014-07-06 12:12:43 +01:00
parent f01f6a11ff
commit e60360b0e1
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
zsh-completions-howto.org
View File

@ -302,8 +302,8 @@ and I can't find documentation anywhere.
However I have managed to work out what the following special chars are for: However I have managed to work out what the following special chars are for:
| * | wildcard - any number of chars | | * | wildcard - any number of chars |
| ? | wildcard - single char | | ? | wildcard - single char |
| # | zero or more of the previous char (like * in a normal regular expression) | | # | zero or more of the previous thing (like * in a normal regular expression) |
| ## | one or more of the previous char (like + in a normal regular expression) | | ## | one or more of the previous thing (like + in a normal regular expression) |
*** _regex_words *** _regex_words
The _regex_words function makes it much easier to create specifications for _regex_arguments. The _regex_words function makes it much easier to create specifications for _regex_arguments.
The results of calling _regex_words can be stored in a variable which can then be used instead The results of calling _regex_words can be stored in a variable which can then be used instead
@ -311,8 +311,8 @@ of a specification for _regex_arguments.
To create a specification using _regex_words you supply it with a tag followed by a description followed by a list To create a specification using _regex_words you supply it with a tag followed by a description followed by a list
of specifications for individual words. These specifications take the form 'WORD:DESCRIPTION:SPEC' where WORD is the of specifications for individual words. These specifications take the form 'WORD:DESCRIPTION:SPEC' where WORD is the
word to be completed, DESCRIPTION is a description for it, and SPEC can be another variable created by _regex_words word to be completed, DESCRIPTION is a description for it, and SPEC specifies words that come after WORD.
specifying words that come after the current word or blank if there are no further words. SPEC can be another variable created by _regex_words or a _regex_arguments specification, or left blank.
For example: For example:
#+BEGIN_SRC sh #+BEGIN_SRC sh
_regex_words subcmd 'The subcommand' 'foo:do foo' 'bar:do bar' 'far:do far' _regex_words subcmd 'The subcommand' 'foo:do foo' 'bar:do bar' 'far:do far'