docs(autocompletion): update autocompletion docs

Update the autocompletion documentation (in `README` and `man` page) to
include information about configuring `zsh` autocompletion script.
This commit is contained in:
Chris Lane 2020-04-07 18:47:35 -04:00
parent bd53768f67
commit c9840c2d6f
3 changed files with 25 additions and 13 deletions

View File

@ -196,14 +196,13 @@ cheat -p personal -t networking --regex -s '(?:[0-9]{1,3}\.){3}[0-9]{1,3}'
Advanced Usage Advanced Usage
-------------- --------------
Shell autocompletion is currently available for the `bash` and `fish` shells. Shell autocompletion is currently available for `bash`, `fish`, and `zsh`. Copy
Copy the relevant [completion script][completions] into the appropriate the relevant [completion script][completions] into the appropriate directory on
directory on your filesystem to enable autocompletion. (This directory will your filesystem to enable autocompletion. (This directory will vary depending
vary depending on operating system and shell specifics.) on operating system and shell specifics.)
Additionally, `cheat` supports enhanced autocompletion via integration with Additionally, `cheat` supports enhanced autocompletion via integration with
[fzf][]. (This feature is currently available on bash only.) To enable `fzf` [fzf][]. To enable `fzf` integration:
integration:
1. Ensure that `fzf` is available on your `$PATH` 1. Ensure that `fzf` is available on your `$PATH`
2. Set an envvar: `export CHEAT_USE_FZF=true` 2. Set an envvar: `export CHEAT_USE_FZF=true`

View File

@ -175,15 +175,17 @@ For detailed instructions on how to configure cheatpaths, please refer
to the comments in conf.yml. to the comments in conf.yml.
.SS Autocompletion .SS Autocompletion
.PP .PP
Autocompletion scripts for \f[B]bash\f[]/\f[B]zsh\f[] and \f[B]fish\f[] Autocompletion scripts for \f[B]bash\f[], \f[B]zsh\f[], and
are available for download: \f[B]fish\f[] are available for download:
.IP \[bu] 2 .IP \[bu] 2
<https://github.com/cheat/cheat/blob/master/scripts/cheat.bash> <https://github.com/cheat/cheat/blob/master/scripts/cheat.bash>
.IP \[bu] 2 .IP \[bu] 2
<https://github.com/cheat/cheat/blob/master/scripts/cheat.fish> <https://github.com/cheat/cheat/blob/master/scripts/cheat.fish>
.IP \[bu] 2
<https://github.com/cheat/cheat/blob/master/scripts/cheat.zsh>
.PP .PP
The \f[B]bash\f[]/\f[B]zsh\f[] scripts provide optional integration with The \f[B]bash\f[] and \f[B]zsh\f[] scripts provide optional integration
\f[B]fzf\f[], if the latter is available on your \f[B]PATH\f[]. with \f[B]fzf\f[], if the latter is available on your \f[B]PATH\f[].
.PP .PP
The installation process will vary per system and shell configuration, The installation process will vary per system and shell configuration,
and thus will not be discussed here. and thus will not be discussed here.
@ -195,6 +197,12 @@ If \f[B]CHEAT_CONFIG_PATH\f[] is set, all other config paths will be
ignored. ignored.
.RS .RS
.RE .RE
.TP
.B \f[B]CHEAT_USE_FZF\f[]
If set, autocompletion scripts will attempt to integrate with
\f[B]fzf\f[].
.RS
.RE
.SH BUGS .SH BUGS
.PP .PP
See GitHub issues: <https://github.com/cheat/cheat/issues> See GitHub issues: <https://github.com/cheat/cheat/issues>

View File

@ -137,14 +137,15 @@ comments in conf.yml.
Autocompletion Autocompletion
-------------- --------------
Autocompletion scripts for **bash**/**zsh** and **fish** are available for Autocompletion scripts for **bash**, **zsh**, and **fish** are available for
download: download:
- <https://github.com/cheat/cheat/blob/master/scripts/cheat.bash> - <https://github.com/cheat/cheat/blob/master/scripts/cheat.bash>
- <https://github.com/cheat/cheat/blob/master/scripts/cheat.fish> - <https://github.com/cheat/cheat/blob/master/scripts/cheat.fish>
- <https://github.com/cheat/cheat/blob/master/scripts/cheat.zsh>
The **bash**/**zsh** scripts provide optional integration with **fzf**, if the The **bash** and **zsh** scripts provide optional integration with **fzf**, if
latter is available on your **PATH**. the latter is available on your **PATH**.
The installation process will vary per system and shell configuration, and thus The installation process will vary per system and shell configuration, and thus
will not be discussed here. will not be discussed here.
@ -158,6 +159,10 @@ ENVIRONMENT
: The path at which the config file is available. If **CHEAT_CONFIG_PATH** is : The path at which the config file is available. If **CHEAT_CONFIG_PATH** is
set, all other config paths will be ignored. set, all other config paths will be ignored.
**CHEAT_USE_FZF**
: If set, autocompletion scripts will attempt to integrate with **fzf**.
BUGS BUGS
==== ====