aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorzeertzjq <zeertzjq@outlook.com>2021-12-27 17:31:32 +0800
committerzeertzjq <zeertzjq@outlook.com>2021-12-27 17:31:32 +0800
commitf6df44232c6780eb780143ef05e8f8e6951a17cb (patch)
tree2c9e9c491a3f9d26c93b8616657ed15f9fcbb9b4
parent56f3c41f5f9d2f07d436744a5c7d7a07b31aac98 (diff)
downloadrneovim-f6df44232c6780eb780143ef05e8f8e6951a17cb.tar.gz
rneovim-f6df44232c6780eb780143ef05e8f8e6951a17cb.tar.bz2
rneovim-f6df44232c6780eb780143ef05e8f8e6951a17cb.zip
docs: clarify UIEnter and UILeave docs
-rw-r--r--runtime/doc/autocmd.txt16
1 files changed, 10 insertions, 6 deletions
diff --git a/runtime/doc/autocmd.txt b/runtime/doc/autocmd.txt
index 3df8d5ced4..0cd0d1ce0e 100644
--- a/runtime/doc/autocmd.txt
+++ b/runtime/doc/autocmd.txt
@@ -663,15 +663,19 @@ FuncUndefined When a user function is used but it isn't
alternative is to use an autoloaded function.
See |autoload-functions|.
*UIEnter*
-UIEnter After a UI connects via |nvim_ui_attach()|,
- after VimEnter. Can be used for GUI-specific
- configuration.
+UIEnter After a UI connects via |nvim_ui_attach()|, or
+ after builtin TUI is started, after |VimEnter|.
Sets these |v:event| keys:
- chan
+ chan: 0 for builtin TUI
+ 1 for |--embed|
+ |channel-id| of the UI otherwise
*UILeave*
-UILeave After a UI disconnects from Nvim.
+UILeave After a UI disconnects from Nvim, or after
+ builtin TUI is stopped, after |VimLeave|.
Sets these |v:event| keys:
- chan
+ chan: 0 for builtin TUI
+ 1 for |--embed|
+ |channel-id| of the UI otherwise
*InsertChange*
InsertChange When typing <Insert> while in Insert or
Replace mode. The |v:insertmode| variable