diff options
author | Marc Cornellà <marc.cornella@live.com> | 2020-10-20 23:48:59 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-10-20 23:48:59 +0200 |
commit | 7d73908223222d3df7f36ed5a362fcfccd770ca5 (patch) | |
tree | 3694ab73b1873f1e128b3301467d668fbf0ad07b /plugins/fzf/README.md | |
parent | f9f45ca222a0ec6fa867ab3733f15911d1b894e6 (diff) | |
download | zsh-7d73908223222d3df7f36ed5a362fcfccd770ca5.tar.gz zsh-7d73908223222d3df7f36ed5a362fcfccd770ca5.tar.bz2 zsh-7d73908223222d3df7f36ed5a362fcfccd770ca5.zip |
fzf: add check for OpenSUSE and OpenBSD packages (#9327)
Diffstat (limited to 'plugins/fzf/README.md')
-rw-r--r-- | plugins/fzf/README.md | 51 |
1 files changed, 35 insertions, 16 deletions
diff --git a/plugins/fzf/README.md b/plugins/fzf/README.md index d9617563a..791a3eb6f 100644 --- a/plugins/fzf/README.md +++ b/plugins/fzf/README.md @@ -1,33 +1,52 @@ # fzf -This plugin enables [junegunn's fzf](https://github.com/junegunn/fzf) fuzzy auto-completion and key bindings +This plugin tries to find [junegunn's fzf](https://github.com/junegunn/fzf) based on where +it's been installed, and enables its 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: +All these settings should go in your zshrc file, before Oh My Zsh is sourced. + +### `FZF_BASE` + +Set to fzf installation directory path: + +```zsh +export FZF_BASE=/path/to/fzf/install/dir +``` + +### `FZF_DEFAULT_COMMAND` + +Set default command to use when input is tty: ```zsh -# Set fzf installation directory path -# export FZF_BASE=/path/to/fzf/install/dir +export FZF_DEFAULT_COMMAND='<your fzf default commmand>' +``` + +If not set, the plugin will try to set it to these, in the order in which they're found: -# Uncomment to set the FZF_DEFAULT_COMMAND -# export FZF_DEFAULT_COMMAND='<your fzf default commmand>' +- [`rg`](https://github.com/BurntSushi/ripgrep) +- [`fd`](https://github.com/sharkdp/fd) +- [`ag`](https://github.com/ggreer/the_silver_searcher) -# Uncomment the following line to disable fuzzy completion -# DISABLE_FZF_AUTO_COMPLETION="true" +### `DISABLE_FZF_AUTO_COMPLETION` -# Uncomment the following line to disable key bindings (CTRL-T, CTRL-R, ALT-C) -# DISABLE_FZF_KEY_BINDINGS="true" +Set whether to load fzf auto-completion: + +```zsh +DISABLE_FZF_AUTO_COMPLETION="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) | +### `DISABLE_FZF_KEY_BINDINGS` + +Set whether to disable key bindings (CTRL-T, CTRL-R, ALT-C): + +```zsh +DISABLE_FZF_KEY_BINDINGS="true" +``` |