Git/cheat
1
0
Fork 0
mirror of https://github.com/cheat/cheat.git synced 2025-09-04 11:08:29 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs(autocompletion): update autocompletion docs

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

16
doc/cheat.1
View File

@ -175,15 +175,17 @@ For detailed instructions on how to configure cheatpaths, please refer
to the comments in conf.yml.
.SS Autocompletion
.PP
Autocompletion scripts for \f[B]bash\f[]/\f[B]zsh\f[] and \f[B]fish\f[]
are available for download:
Autocompletion scripts for \f[B]bash\f[], \f[B]zsh\f[], and
\f[B]fish\f[] are available for download:
.IP \[bu] 2
<https://github.com/cheat/cheat/blob/master/scripts/cheat.bash>
.IP \[bu] 2
<https://github.com/cheat/cheat/blob/master/scripts/cheat.fish>
.IP \[bu] 2
<https://github.com/cheat/cheat/blob/master/scripts/cheat.zsh>
.PP
The \f[B]bash\f[]/\f[B]zsh\f[] scripts provide optional integration with
\f[B]fzf\f[], if the latter is available on your \f[B]PATH\f[].
The \f[B]bash\f[] and \f[B]zsh\f[] scripts provide optional integration
with \f[B]fzf\f[], if the latter is available on your \f[B]PATH\f[].
.PP
The installation process will vary per system and shell configuration,
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.
.RS
.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
.PP
See GitHub issues: <https://github.com/cheat/cheat/issues>

11
doc/cheat.1.md
View File

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