xenia/home
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: Document the form of next-key sub-modes in the ModeChange hook.

Browse Source
This commit is contained in:
Tim Allen 2020-09-21 17:28:18 +10:00
parent dbd7e4da79
commit 9bc00b6853
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/pages/hooks.asciidoc
View File

@ -146,6 +146,11 @@ name. Hooks with no description will always use an empty string.
*ModeChange* `[push|pop]:<old mode>:<new mode>`:: *ModeChange* `[push|pop]:<old mode>:<new mode>`::
Triggered whenever a mode is pushed or removed from the mode stack. Triggered whenever a mode is pushed or removed from the mode stack.
The mode name can be things like 'normal' or 'insert' for regular
interactive modes, or 'next-key[<name>]' for sub-modes where Kakoune
prompts for a key. For example, `g` in normal mode pushes 'next-key[goto]'
mode, the `enter-user-mode foo` command pushes 'next-key[user.foo]' mode,
and the `on-key -mode-name bar` command pushes 'next-key[bar]' mode.
*KakBegin* `session name`:: *KakBegin* `session name`::
kakoune has started, this hook is called just after reading the user kakoune has started, this hook is called just after reading the user