Document that a command's own key withholds the show key

Missed when the check learned about them. Also hyphenate 'comma-separated'.
This commit is contained in:
Junegunn Choi
2026-08-26 23:40:32 +09:00
parent e541ce6037
commit c63f25a2ba
3 changed files with 7 additions and 6 deletions
+3 -3
View File
@@ -108,8 +108,8 @@ Commands
`:Rg`, `:Ag`, `:Grep`, `:Lines`, `:BLines`, `:Tags`, `:BTags`, `:Marks`, `:Rg`, `:Ag`, `:Grep`, `:Lines`, `:BLines`, `:Tags`, `:BTags`, `:Marks`,
`:Changes`). Requires fzf 0.74.4 or later, and is not offered in fullscreen `:Changes`). Requires fzf 0.74.4 or later, and is not offered in fullscreen
mode, with a layout that leaves no other window (`enew`, `tabnew`), on mode, with a layout that leaves no other window (`enew`, `tabnew`), on
Windows, or when the key is already used by `g:fzf_vim.paste_key` or Windows, or when the key is already used by `g:fzf_vim.paste_key`,
`g:fzf_action` `g:fzf_action`, or the command itself, as `CTRL-ALT-X` is in `:Buffers`
- Bang-versions of the commands (e.g. `Ag!`) will open fzf in fullscreen - Bang-versions of the commands (e.g. `Ag!`) will open fzf in fullscreen
- You can set `g:fzf_vim.command_prefix` to give the same prefix to the commands - You can set `g:fzf_vim.command_prefix` to give the same prefix to the commands
- e.g. `let g:fzf_vim.command_prefix = 'Fzf'` and you have `FzfFiles`, etc. - e.g. `let g:fzf_vim.command_prefix = 'Fzf'` and you have `FzfFiles`, etc.
@@ -188,7 +188,7 @@ was started from and leaves fzf open, so you can look through several entries
in one run (see the command list above). It is labelled `Show` in the footer in one run (see the command list above). It is labelled `Show` in the footer
to set it apart from `Enter`, which opens the entry and closes fzf. Customize to set it apart from `Enter`, which opens the entry and closes fzf. Customize
it with `g:fzf_vim.show_key`, or set it to an empty string to turn the key it with `g:fzf_vim.show_key`, or set it to an empty string to turn the key
off. A comma separated list binds every key in it. It takes the key over from off. A comma-separated list binds every key in it. It takes the key over from
`$FZF_DEFAULT_OPTS`, so pick another key or turn it off to keep a binding of `$FZF_DEFAULT_OPTS`, so pick another key or turn it off to keep a binding of
your own. your own.
+1 -1
View File
@@ -442,7 +442,7 @@ function! s:show_key()
return s:conf('show_key', 'ctrl-o') return s:conf('show_key', 'ctrl-o')
endfunction endfunction
" A key can be a comma separated list, which fzf binds to every key in it. " A key can be a comma-separated list, which fzf binds to every key in it.
" fzf escapes 'alt-,' before splitting on the comma, so do the same. It also " fzf escapes 'alt-,' before splitting on the comma, so do the same. It also
" lowercases a key name before matching it, except for 'alt-X' and a bare " lowercases a key name before matching it, except for 'alt-X' and a bare
" character, where it takes the rune as typed, so fold the same ones here and " character, where it takes the rune as typed, so fold the same ones here and
+3 -2
View File
@@ -161,7 +161,8 @@ COMMANDS *fzf-vim-commands*
Grep, Lines, BLines, Tags, BTags, Marks, Changes). Requires fzf 0.74.4 or Grep, Lines, BLines, Tags, BTags, Marks, Changes). Requires fzf 0.74.4 or
later, and is not offered in fullscreen mode, with a layout that leaves no later, and is not offered in fullscreen mode, with a layout that leaves no
other window (enew, tabnew), on Windows, or when the key is already used other window (enew, tabnew), on Windows, or when the key is already used
by g:fzf_vim.paste_key or g:fzf_action by g:fzf_vim.paste_key, g:fzf_action, or the command itself, as
CTRL-ALT-X is in :Buffers
- Bang-versions of the commands (e.g. `Ag!`) will open fzf in fullscreen - Bang-versions of the commands (e.g. `Ag!`) will open fzf in fullscreen
- You can set `g:fzf_vim.command_prefix` to give the same prefix to the commands - You can set `g:fzf_vim.command_prefix` to give the same prefix to the commands
- e.g. `let g:fzf_vim.command_prefix = 'Fzf'` and you have `FzfFiles`, etc. - e.g. `let g:fzf_vim.command_prefix = 'Fzf'` and you have `FzfFiles`, etc.
@@ -256,7 +257,7 @@ Most commands support a key that opens the current entry in the window fzf was
started from and leaves fzf open, so you can look through several entries in started from and leaves fzf open, so you can look through several entries in
one run. It is labelled Show in the footer to set it apart from Enter, which one run. It is labelled Show in the footer to set it apart from Enter, which
opens the entry and closes fzf. Customize it with `g:fzf_vim.show_key`, or set opens the entry and closes fzf. Customize it with `g:fzf_vim.show_key`, or set
it to an empty string to turn the key off. A comma separated list binds every it to an empty string to turn the key off. A comma-separated list binds every
key in it. It takes the key over from `$FZF_DEFAULT_OPTS`, so pick another key key in it. It takes the key over from `$FZF_DEFAULT_OPTS`, so pick another key
or turn it off to keep a binding of your own. or turn it off to keep a binding of your own.
> >