summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJunegunn Choi <junegunn.c@gmail.com>2014-06-15 03:18:29 +0900
committerJunegunn Choi <junegunn.c@gmail.com>2014-06-15 03:18:29 +0900
commit65c1b5327539c6d72392a90ab710443a04fd4e21 (patch)
tree6a9f2768880318e32c24368a662152cd7cb65bdc /README.md
parent0b43f988c7ffd587835875bf12e8d312ab52d002 (diff)
[vim] Options to xterm command
Diffstat (limited to 'README.md')
-rw-r--r--README.md37
1 files changed, 23 insertions, 14 deletions
diff --git a/README.md b/README.md
index ad2eb69c..ca3c3a43 100644
--- a/README.md
+++ b/README.md
@@ -287,7 +287,7 @@ TODO :smiley:
Usage as Vim plugin
-------------------
-Note: To use fzf in GVim, bash and xterm are required.
+(Note: To use fzf in GVim, bash and xterm are required.)
### `:FZF[!]`
@@ -311,6 +311,13 @@ If you're on a tmux session, `:FZF` will launch fzf in a new split-window whose
height can be adjusted with `g:fzf_tmux_height` (default: '40%'). However, the
bang version (`:FZF!`) will always start in fullscreen.
+In GVim, `xterm` command will be used to launch fzf. You can set options to
+`xterm` command with `g:fzf_xterm_options`. For example,
+
+```vim
+let g:fzf_xterm_options = '-geometry 120x30'
+```
+
### `fzf#run([options])`
For more advanced uses, you can call `fzf#run()` function which returns the list
@@ -318,16 +325,17 @@ of the selected items.
`fzf#run()` may take an options-dictionary:
-| Option name | Type | Description |
-| ------------- | ------------- | ------------------------------------------------------------------ |
-| `source` | string | External command to generate input to fzf (e.g. `find .`) |
-| `source` | list | Vim list as input to fzf |
-| `sink` | string | Vim command to handle the selected item (e.g. `e`, `tabe`) |
-| `sink` | funcref | Reference to function to process each selected item |
-| `options` | string | Options to fzf |
-| `dir` | string | Working directory |
-| `tmux_width` | number/string | Use tmux vertical split with the given height (e.g. `20`, `50%`) |
-| `tmux_height` | number/string | Use tmux horizontal split with the given height (e.g. `20`, `50%`) |
+| Option name | Type | Description |
+| --------------- | ------------- | ------------------------------------------------------------------ |
+| `source` | string | External command to generate input to fzf (e.g. `find .`) |
+| `source` | list | Vim list as input to fzf |
+| `sink` | string | Vim command to handle the selected item (e.g. `e`, `tabe`) |
+| `sink` | funcref | Reference to function to process each selected item |
+| `options` | string | Options to fzf |
+| `dir` | string | Working directory |
+| `tmux_width` | number/string | Use tmux vertical split with the given height (e.g. `20`, `50%`) |
+| `tmux_height` | number/string | Use tmux horizontal split with the given height (e.g. `20`, `50%`) |
+| `xterm_options` | string | Options to `xterm` command (Only used in GVim) |
#### Examples
@@ -353,9 +361,10 @@ nnoremap <silent> <Leader>C :call fzf#run({
\ 'source':
\ map(split(globpath(&rtp, "colors/*.vim"), "\n"),
\ "substitute(fnamemodify(v:val, ':t'), '\\..\\{-}$', '', '')"),
-\ 'sink': 'colo',
-\ 'options': '+m',
-\ 'tmux_width': 20
+\ 'sink': 'colo',
+\ 'options': '+m',
+\ 'tmux_width': 20,
+\ 'xterm_options': '-geometry 20x30'
\ })<CR>
```