diff options
Diffstat (limited to 'plugins/fzf/README.md')
| -rw-r--r-- | plugins/fzf/README.md | 30 |
1 files changed, 22 insertions, 8 deletions
diff --git a/plugins/fzf/README.md b/plugins/fzf/README.md index b3a434347..d9617563a 100644 --- a/plugins/fzf/README.md +++ b/plugins/fzf/README.md @@ -2,18 +2,32 @@ This plugin enables [junegunn's fzf](https://github.com/junegunn/fzf) fuzzy auto-completion and key bindings +To use it, add `fzf` to the plugins array in your zshrc file: +```zsh +plugins=(... fzf) +``` + +## Settings + +Add these before the `plugins=()` line in your zshrc file: + ```zsh # Set fzf installation directory path -export FZF_BASE=/path/to/fzf/install/dir +# export FZF_BASE=/path/to/fzf/install/dir + +# Uncomment to set the FZF_DEFAULT_COMMAND +# export FZF_DEFAULT_COMMAND='<your fzf default commmand>' # Uncomment the following line to disable fuzzy completion -# export DISABLE_FZF_AUTO_COMPLETION="true" +# DISABLE_FZF_AUTO_COMPLETION="true" # Uncomment the following line to disable key bindings (CTRL-T, CTRL-R, ALT-C) -# export DISABLE_FZF_KEY_BINDINGS="true" - -plugins=( - ... - fzf -) +# DISABLE_FZF_KEY_BINDINGS="true" ``` + +| Setting | Example value | Description | +|-----------------------------|----------------------------|-------------------------------------------------------------| +| FZF_BASE | `/path/to/fzf/install/dir` | Set fzf installation directory path (**export**) | +| FZF_DEFAULT_COMMAND | `fd --type f` | Set default command to use when input is tty (**export**) | +| DISABLE_FZF_AUTO_COMPLETION | `true` | Set whether to load fzf auto-completion | +| DISABLE_FZF_KEY_BINDINGS | `true` | Set whether to disable key bindings (CTRL-T, CTRL-R, ALT-C) | |