1
0
mirror of https://github.com/dcarrillo/prezto.git synced 2024-12-22 23:08:00 +00:00
prezto/modules/completion/README.md
Indrajit Raychaudhuri 1ff9421f7b general: Update documentation better qualifying runcom paths
Zsh and Prezto files don't always reside in `~/`. Instead, they have
a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them
unambiguous in the documentation. Likewise, for `$GNUPGHOME`.

Further, add instruction for optionally setting up Prezto in
`$XDG_CONFIG_HOME`.

While at this, also add clarification on relative ordering of some of
the modules, apply more formatting tweaks and doc improvements.
2021-05-21 12:31:02 -05:00

1.9 KiB

Completion

Loads and configures TAB completion and provides additional completions from the zsh-completions project.

This module must be loaded late after the utility module and all other modules that provide completion definitions.

Options

  • COMPLETE_IN_WORD complete from both ends of a word.
  • ALWAYS_TO_END move cursor to the end of a completed word.
  • PATH_DIRS perform path search even on command names with slashes.
  • AUTO_MENU show completion menu on a successive TAB press.
  • AUTO_LIST automatically list choices on ambiguous completion.
  • AUTO_PARAM_SLASH if completed parameter is a directory, add a trailing slash (/).
  • EXTENDED_GLOB needed for file modification glob modifiers with compinit.
  • MENU_COMPLETE do not autoselect the first completion entry.
  • FLOW_CONTROL disable start/stop characters in shell editor.

Settings

Ignore /etc/hosts Entries

To ignore certain entries from static /etc/hosts for host completion, add the following lines in ${ZDOTDIR:-$HOME}/.zpreztorc with the IP addresses of the hosts as they appear in /etc/hosts. Both IP address and the associated hostname(s) will be ignored during host completion. However, some of the entries ignored from /etc/hosts still might appear during completion because of their presence in ssh configuration or history).

zstyle ':prezto:module:completion:*:hosts' etc-host-ignores \
    '0.0.0.0' '127.0.0.1'

Contributors

Completions should be submitted to the zsh-completions project according to its rules and regulations. This module will be synchronized against it.

Authors

The authors of this module should be contacted via the issue tracker.