From d5e72bf55d0bb317a3b9515885e92d94097b38fe Mon Sep 17 00:00:00 2001 From: Junegunn Choi Date: Fri, 28 Apr 2017 02:09:55 +0900 Subject: [PATCH] Update README-VIM: options as list (#896) --- README-VIM.md | 11 ++++++++++- doc/fzf.txt | 11 +++++++++-- 2 files changed, 19 insertions(+), 3 deletions(-) diff --git a/README-VIM.md b/README-VIM.md index 0cee379..804400d 100644 --- a/README-VIM.md +++ b/README-VIM.md @@ -99,13 +99,22 @@ 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`) | | `launcher` | string | External terminal emulator to start fzf with (GVim only) | | `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. + +```vim +call fzf#run({'options': '--reverse --prompt "C:\\Program Files\\"'}) +call fzf#run({'options': ['--reverse', '--prompt', 'C:\Program Files\']}) +``` + `fzf#wrap` ---------- diff --git a/doc/fzf.txt b/doc/fzf.txt index 1039094..52080ef 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* ==============================================================================