mirrors/zsh
1
0
Fork 0
mirror of git://git.code.sf.net/p/zsh/code synced 2025-11-01 18:30:55 +01:00
Code Releases Activity

39708: Document _email_addresses.

Browse source
This commit is contained in:
Daniel Shahaf 2016-10-22 21:54:06 +00:00
parent f1c0480afc
commit 4eef3e6f0e
3 changed files with 47 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

42
Doc/Zsh/compsys.yo
View file

@ -826,6 +826,10 @@ kindex(domains, completion tag)
item(tt(domains))(
for network domains
)
kindex(email-*, completion tag)
item(tt(email-)var(plugin))(
for email addresses from the `tt(_email-)var(plugin)' backend of tt(_email_addresses)
)
kindex(expansions, completion tag)
item(tt(expansions))(
used by the tt(_expand) completer for individual words (as opposed to
@ -4387,6 +4391,44 @@ tt($service) to the var(string) being tried, and sets
the var(context/command) field (the fourth) of the tt($curcontext)
parameter to the var(context) given as the first argument.
)
findex(_email_addresses)
item(tt(_email_addresses) [ tt(-c) ] [ tt(-n) var(plugin) ])(
Complete email addresses. Addresses are provided by plugins.
startitem()
item(tt(-c))(
Complete bare tt(localhost@domain.tld) addresses, without a name part or
a comment.
Without this option, RFC822 `var(Firstname Lastname) tt(<)var(address)tt(>)'
strings are completed.
)
item(tt(-n) var(plugin))(
Complete aliases from var(plugin).
)
COMMENT(Intentionally leaving tt(-s) undocumented: new code should use
tt(_sequence) instead.)\
enditem()
The following plugins are available by default:
tt(_email-ldap) (see the tt(filter) style),
tt(_email-local) (completes var(user)tt(@)var(hostname) Unix addresses),
tt(_email-mail) (completes aliases from tt(~/.mailrc)),
tt(_email-mush),
tt(_email-mutt),
and
tt(_email-pine).
Addresses from the tt(_email-)var(foo) plugin are added under the
tag `tt(email-)var(foo)'.
em(Writing plugins)
Plugins are written as separate functions with names starting with `tt(_email-)'.
They are invoked with the tt(-c) option and tt(compadd) options.
They should either do their own completion or
set the tt($reply) array to a list of `var(alias)tt(:)var(address)' elements and return tt(300).
New plugins will be picked up and run automatically.
)
findex(_files)
item(tt(_files))(
The function tt(_files) calls tt(_path_files) with all the arguments it