summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJunegunn Choi <junegunn.c@gmail.com>2017-04-28 02:09:55 +0900
committerJunegunn Choi <junegunn.c@gmail.com>2017-04-28 02:09:55 +0900
commitd5e72bf55d0bb317a3b9515885e92d94097b38fe (patch)
tree0645a39a44c009f39a59ea9e1aa4eb9be64652c5 /doc
parent5677e5e1338a07d00d0a1c74ce918710a9ce8fdc (diff)
Update README-VIM: options as list (#896)
Diffstat (limited to 'doc')
-rw-r--r--doc/fzf.txt11
1 files changed, 9 insertions, 2 deletions
diff --git a/doc/fzf.txt b/doc/fzf.txt
index 10390942..52080ef6 100644
--- a/doc/fzf.txt
+++ b/doc/fzf.txt
@@ -1,4 +1,4 @@
-fzf.txt fzf Last change: April 1 2017
+fzf.txt fzf Last change: April 28 2017
FZF - TABLE OF CONTENTS *fzf* *fzf-toc*
==============================================================================
@@ -125,7 +125,7 @@ following options.
`sink` | string | Vim command to handle the selected item (e.g. `e` , `tabe` )
`sink` | funcref | Reference to function to process each selected item
`sink*` | funcref | Similar to `sink` , but takes the list of output lines at once
- `options` | string | Options to fzf
+ `options` | string/list | Options to fzf
`dir` | string | Working directory
`up` / `down` / `left` / `right` | number/string | Use tmux pane with the given size (e.g. `20` , `50%` )
`window` (Neovim only) | string | Command to open fzf window (e.g. `vertical aboveleft 30new` )
@@ -133,6 +133,13 @@ following options.
`launcher` | funcref | Function for generating `launcher` string (GVim only)
---------------------------+---------------+--------------------------------------------------------------
+`options` entry can be either a string or a list. For simple cases, string
+should suffice, but prefer to use list type if you're concerned about escaping
+issues on different platforms.
+>
+ call fzf#run({'options': '--reverse --prompt "C:\\Program Files\\"'})
+ call fzf#run({'options': ['--reverse', '--prompt', 'C:\Program Files\']})
+<
FZF#WRAP *fzf#wrap*
==============================================================================