summaryrefslogtreecommitdiff
path: root/doc/fzf.txt
diff options
context:
space:
mode:
authorJunegunn Choi <junegunn.c@gmail.com>2024-08-19 20:51:08 +0900
committerJunegunn Choi <junegunn.c@gmail.com>2024-08-19 20:51:26 +0900
commit8cb59e6fcac3dce8dfa44b678fdc94cf81efa11b (patch)
tree187f1d5671c039229bd77701c4445256e0d830a6 /doc/fzf.txt
parent5cce17e80a326680b503a51aadcf570cc089ea5c (diff)
downloadfzf-8cb59e6fcac3dce8dfa44b678fdc94cf81efa11b.tar.gz
[vim] Add 'exit' callback
A spec can have `exit` callback that is called with the exit status of fzf. This can be used to clean up temporary resources or restore the original state when fzf is closed without a selection.
Diffstat (limited to 'doc/fzf.txt')
-rw-r--r--doc/fzf.txt3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/fzf.txt b/doc/fzf.txt
index f946184f..c8de4b92 100644
--- a/doc/fzf.txt
+++ b/doc/fzf.txt
@@ -306,8 +306,9 @@ The following table summarizes the available options.
`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
+ `sink` | funcref | Function to be called with each selected item
`sinklist` (or `sink*` ) | funcref | Similar to `sink` , but takes the list of output lines at once
+ `exit` | funcref | Function to be called with the exit status of fzf (e.g. 0, 1, 2, 130)
`options` | string/list | Options to fzf
`dir` | string | Working directory
`up` / `down` / `left` / `right` | number/string | (Layout) Window position and size (e.g. `20` , `50%` )