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

Docs: add missing PromptIdle hook mentions

Browse Source
This commit is contained in:
Delapouite 2017-07-05 13:45:45 +02:00
parent 620e718087
commit 8ed29dbd7a
4 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.asciidoc
View File

@ -966,7 +966,7 @@ Some options are built in Kakoune, and can be used to control its behaviour:
* `debug` _flags(hooks|shell|profile)_: dump various debug information in * `debug` _flags(hooks|shell|profile)_: dump various debug information in
the `*debug*` buffer. the `*debug*` buffer.
* `idle_timeout` _int_: timeout, in milliseconds, with no user input that will * `idle_timeout` _int_: timeout, in milliseconds, with no user input that will
trigger the `InsertIdle` and `NormalIdle` hooks. trigger the `PromptIdle`, `InsertIdle` and `NormalIdle` hooks.
* `fs_checkout_timeout` _int_: timeout, in milliseconds, between checks in * `fs_checkout_timeout` _int_: timeout, in milliseconds, between checks in
normal mode of modifications of the file associated with the current buffer normal mode of modifications of the file associated with the current buffer
on the filesystem. on the filesystem.
@ -1427,6 +1427,8 @@ Existing hooks are:
by the main selection is used for filtering by the main selection is used for filtering
* `InsertMove`: The cursor moved (without inserting) in insert mode, the key * `InsertMove`: The cursor moved (without inserting) in insert mode, the key
that triggered the move is used for filtering that triggered the move is used for filtering
* `PromptIdle`: A certain duration has passed since last key was pressed in
prompt mode.
* `WinCreate`: A window was created, the filtering text is the buffer name * `WinCreate`: A window was created, the filtering text is the buffer name
* `WinClose`: A window was destroyed, the filtering text is the buffer name * `WinClose`: A window was destroyed, the filtering text is the buffer name
* `WinDisplay`: A window was bound a client, the filtering text is the buffer * `WinDisplay`: A window was bound a client, the filtering text is the buffer

3
doc/manpages/hooks.asciidoc
View File

@ -76,6 +76,9 @@ Default hooks
the cursor moved (without inserting) in insert mode, the key that the cursor moved (without inserting) in insert mode, the key that
triggered the move is used for filtering triggered the move is used for filtering
*PromptIdle*::
a certain duration has passed since last key was pressed in prompt mode
*WinCreate*:: *WinCreate*::
a window was created, the filtering text is the buffer name a window was created, the filtering text is the buffer name

2
doc/manpages/options.asciidoc
View File

@ -137,7 +137,7 @@ Builtin options
*idle_timeout* 'int':: *idle_timeout* 'int'::
timeout, in milliseconds, with no user input that will trigger the timeout, in milliseconds, with no user input that will trigger the
*InsertIdle* and *NormalIdle* hooks. *PromptIdle*, *InsertIdle* and *NormalIdle* hooks.
*fs_checkout_timeout* 'int':: *fs_checkout_timeout* 'int'::
timeout, in milliseconds, between checks in normal mode of modifications timeout, in milliseconds, between checks in normal mode of modifications

2
src/commands.cc
View File

@ -766,7 +766,7 @@ static constexpr auto hooks = {
"BufWritePre", "BufOpenFifo", "BufCloseFifo", "BufReadFifo", "BufSetOption", "BufWritePre", "BufOpenFifo", "BufCloseFifo", "BufReadFifo", "BufSetOption",
"InsertBegin", "InsertChar", "InsertDelete", "InsertEnd", "InsertIdle", "InsertKey", "InsertBegin", "InsertChar", "InsertDelete", "InsertEnd", "InsertIdle", "InsertKey",
"InsertMove", "InsertCompletionHide", "InsertCompletionShow", "InsertMove", "InsertCompletionHide", "InsertCompletionShow",
"KakBegin", "KakEnd", "FocusIn", "FocusOut", "RuntimeError", "KakBegin", "KakEnd", "FocusIn", "FocusOut", "RuntimeError", "PromptIdle",
"NormalBegin", "NormalEnd", "NormalIdle", "NormalKey", "RawKey", "NormalBegin", "NormalEnd", "NormalIdle", "NormalKey", "RawKey",
"WinClose", "WinCreate", "WinDisplay", "WinResize", "WinSetOption", "WinClose", "WinCreate", "WinDisplay", "WinResize", "WinSetOption",
}; };