summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJunegunn Choi <junegunn.c@gmail.com>2020-10-18 13:06:51 +0900
committerJunegunn Choi <junegunn.c@gmail.com>2020-10-18 13:23:40 +0900
commit305896fcb3b76c5ea94401f6cce74f0f287e8f21 (patch)
treeb498fd4e477f1bfd2b629a7c76d1f124ea02839f
parent6c9adea0d3eec72af9999ce291259c86ad8788e2 (diff)
README-VIM: g:fzf_action doesn't work with custom sink
Fix https://github.com/junegunn/fzf.vim/issues/1131
-rw-r--r--README-VIM.md24
-rw-r--r--doc/fzf.txt41
2 files changed, 47 insertions, 18 deletions
diff --git a/README-VIM.md b/README-VIM.md
index 126862b2..568f723f 100644
--- a/README-VIM.md
+++ b/README-VIM.md
@@ -127,11 +127,13 @@ let g:fzf_action = {
\ 'ctrl-v': 'vsplit' }
" Default fzf layout
-" - down / up / left / right / window
-let g:fzf_layout = { 'down': '40%' }
+" - Popup window
let g:fzf_layout = { 'window': { 'width': 0.9, 'height': 0.6 } }
-" You can set up fzf window using a Vim command (Neovim or latest Vim 8 required)
+" - down / up / left / right
+let g:fzf_layout = { 'down': '40%' }
+
+" - Window using a Vim command
let g:fzf_layout = { 'window': 'enew' }
let g:fzf_layout = { 'window': '-tabnew' }
let g:fzf_layout = { 'window': '10new' }
@@ -332,8 +334,9 @@ After we *"wrap"* our spec, we pass it to `fzf#run`.
call fzf#run(fzf#wrap({'source': 'ls'}))
```
-Now it supports `CTRL-T`, `CTRL-V`, and `CTRL-X` key bindings and it opens fzf
-window according to `g:fzf_layout` setting.
+Now it supports `CTRL-T`, `CTRL-V`, and `CTRL-X` key bindings (configurable
+via `g:fzf_action`) and it opens fzf window according to `g:fzf_layout`
+setting.
To make it easier to use, let's define `LS` command.
@@ -370,6 +373,17 @@ command! -bang -complete=dir -nargs=* LS
\ call fzf#run(fzf#wrap('ls', {'source': 'ls', 'dir': <q-args>}, <bang>0))
```
+### Global options supported by `fzf#wrap`
+
+- `g:fzf_layout`
+- `g:fzf_action`
+ - **Works only when no custom `sink` (or `sink*`) is provided**
+ - Having custom sink usually means that each entry is not an ordinary
+ file path (e.g. name of color scheme), so we can't blindly apply the
+ same strategy (i.e. `tabedit some-color-scheme` doesn't make sense)
+- `g:fzf_colors`
+- `g:fzf_history_dir`
+
Tips
----
diff --git a/doc/fzf.txt b/doc/fzf.txt
index 2c04872d..5da12323 100644
--- a/doc/fzf.txt
+++ b/doc/fzf.txt
@@ -1,4 +1,4 @@
-fzf.txt fzf Last change: April 4 2020
+fzf.txt fzf Last change: October 18 2020
FZF - TABLE OF CONTENTS *fzf* *fzf-toc*
==============================================================================
@@ -11,6 +11,7 @@ FZF - TABLE OF CONTENTS *fzf* *fzf-to
Explanation of g:fzf_colors
fzf#run
fzf#wrap
+ Global options supported by fzf#wrap
Tips
fzf inside terminal buffer
Starting fzf in a popup window
@@ -105,14 +106,14 @@ the whole if we start off with `:FZF` command.
" Bang version starts fzf in fullscreen mode
:FZF!
<
-Similarly to {ctrlp.vim}{2}, use enter key, CTRL-T, CTRL-X or CTRL-V to open
+Similarly to {ctrlp.vim}{3}, use enter key, CTRL-T, CTRL-X or CTRL-V to open
selected files in the current window, in new tabs, in horizontal splits, or in
vertical splits respectively.
Note that the environment variables `FZF_DEFAULT_COMMAND` and
`FZF_DEFAULT_OPTS` also apply here.
- {2} https://github.com/kien/ctrlp.vim
+ {3} https://github.com/kien/ctrlp.vim
< Configuration >_____________________________________________________________~
@@ -154,11 +155,13 @@ Examples~
\ 'ctrl-v': 'vsplit' }
" Default fzf layout
- " - down / up / left / right / window
- let g:fzf_layout = { 'down': '~40%' }
+ " - Popup window
let g:fzf_layout = { 'window': { 'width': 0.9, 'height': 0.6 } }
- " You can set up fzf window using a Vim command (Neovim or latest Vim 8 required)
+ " - down / up / left / right
+ let g:fzf_layout = { 'down': '40%' }
+
+ " - Window using a Vim command
let g:fzf_layout = { 'window': 'enew' }
let g:fzf_layout = { 'window': '-tabnew' }
let g:fzf_layout = { 'window': '10new' }
@@ -347,8 +350,8 @@ After we "wrap" our spec, we pass it to `fzf#run`.
>
call fzf#run(fzf#wrap({'source': 'ls'}))
<
-Now it supports CTRL-T, CTRL-V, and CTRL-X key bindings and it opens fzf
-window according to `g:fzf_layout` setting.
+Now it supports CTRL-T, CTRL-V, and CTRL-X key bindings (configurable via
+`g:fzf_action`) and it opens fzf window according to `g:fzf_layout` setting.
To make it easier to use, let's define `LS` command.
>
@@ -378,6 +381,19 @@ unique name to our command and pass it as the first argument to `fzf#wrap`.
\ call fzf#run(fzf#wrap('ls', {'source': 'ls', 'dir': <q-args>}, <bang>0))
<
+< Global options supported by fzf#wrap >______________________________________~
+ *fzf-global-options-supported-by-fzf#wrap*
+
+ - `g:fzf_layout`
+ - `g:fzf_action`
+ - Works only when no custom `sink` (or `sink*`) is provided
+ - Having custom sink usually means that each entry is not an ordinary
+ file path (e.g. name of color scheme), so we can't blindly apply the
+ same strategy (i.e. `tabedit some-color-scheme` doesn't make sense)
+ - `g:fzf_colors`
+ - `g:fzf_history_dir`
+
+
TIPS *fzf-tips*
==============================================================================
@@ -398,8 +414,8 @@ Starting fzf in a popup window~
*fzf-starting-fzf-in-a-popup-window*
>
" Required:
- " - width [float range [0 ~ 1]]
- " - height [float range [0 ~ 1]]
+ " - width [float range [0 ~ 1]] or [integer range [8 ~ ]]
+ " - height [float range [0 ~ 1]] or [integer range [4 ~ ]]
"
" Optional:
" - xoffset [float default 0.5 range [0 ~ 1]]
@@ -427,9 +443,8 @@ When fzf starts in a terminal buffer, the file type of the buffer is set to
`fzf`. So you can set up `FileType fzf` autocmd to customize the settings of
the window.
-For example, if you use a non-popup layout (e.g. `{'down': '40%'}`) on
-Neovim, you might want to temporarily disable the statusline for a cleaner
-look.
+For example, if you use a non-popup layout (e.g. `{'down': '40%'}`) on Neovim,
+you might want to temporarily disable the statusline for a cleaner look.
>
if has('nvim') && !exists('g:fzf_layout')
autocmd! FileType fzf