Module: awful.completion
Completion module.
This module store a set of function using shell to complete commands name.
Info:
- Copyright: 2008 Julien Danjou, Sébastien Gross
-
Originally authored by: Julien Danjou <julien@danjou.info>,Sébastien Gross <seb-awesome@chezwam.org>
(Full contributors list available on our github project)
Static module functions
| awful.completion.bashcomp_load (src) | Enable programmable bash completion in awful.completion.bash at the price of a slight overhead. | |
| awful.completion.shell (command, cur_pos, ncomp[, shell=based on SHELL]) -> (string, number, table) | Use shell completion system to complete commands and filenames. | |
| awful.completion.generic (text, cur_pos, ncomp, keywords) -> () | Run a generic completion. | |
Static module functions
- awful.completion.bashcomp_load (src)
-
Enable programmable bash completion in awful.completion.bash at the price of
a slight overhead.
Parameters:
- src The bash completion source file, /etc/bash_completion by default.
- awful.completion.shell (command, cur_pos, ncomp[, shell=based on SHELL]) -> (string, number, table)
-
Use shell completion system to complete commands and filenames.
Parameters:
- command string The command line.
- cur_pos number The cursor position.
- ncomp number The element number to complete.
- shell string The shell to use for completion. Supports "bash" and "zsh". (default based on SHELL)
Returns:
- awful.completion.generic (text, cur_pos, ncomp, keywords) -> ()
-
Run a generic completion.
For this function to run properly the awful.completion.keyword table should
be fed up with all keywords. The completion is run against these keywords.
Parameters:
- text The current text the user had typed yet.
- cur_pos The current cursor position.
- ncomp The number of yet requested completion using current text.
- keywords The keywords table uised for completion.
Returns:
-
The new match, the new cursor position, the table of all matches.