diff options
Diffstat (limited to 'runtime')
-rw-r--r-- | runtime/doc/api.txt | 8 | ||||
-rw-r--r-- | runtime/doc/autocmd.txt | 4 | ||||
-rw-r--r-- | runtime/doc/eval.txt | 8 | ||||
-rw-r--r-- | runtime/lua/vim/_meta/api.lua | 7 |
4 files changed, 14 insertions, 13 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index 6970479a78..908198de4c 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -3598,13 +3598,13 @@ nvim_ui_set_option({name}, {value}) *nvim_ui_set_option()* |RPC| only nvim_ui_term_event({event}, {value}) *nvim_ui_term_event()* - Tells Nvim when a terminal event has occurred: sets |v:termresponse| and - fires |TermResponse|. + Tells Nvim when a terminal event has occurred The following terminal events are supported: - • "osc_response": The terminal sent a OSC response sequence to Nvim. The - payload is the received OSC sequence. + • "termresponse": The terminal sent an OSC or DCS response sequence to + Nvim. The payload is the received response. Sets |v:termresponse| and + fires |TermResponse|. Attributes: ~ |RPC| only diff --git a/runtime/doc/autocmd.txt b/runtime/doc/autocmd.txt index 6b698b0868..c6f6559e37 100644 --- a/runtime/doc/autocmd.txt +++ b/runtime/doc/autocmd.txt @@ -987,8 +987,8 @@ TermClose When a |terminal| job ends. Sets these |v:event| keys: status *TermResponse* -TermResponse When Nvim receives a OSC response from the - terminal. Sets |v:termresponse|. When used +TermResponse When Nvim receives an OSC or DCS response from + the terminal. Sets |v:termresponse|. When used from Lua, the response string is included in the "data" field of the autocommand callback. May be triggered halfway through another event diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt index 2223829548..a73932be00 100644 --- a/runtime/doc/eval.txt +++ b/runtime/doc/eval.txt @@ -2318,10 +2318,10 @@ v:t_string Value of |String| type. Read-only. See: |type()| v:t_blob Value of |Blob| type. Read-only. See: |type()| *v:termresponse* *termresponse-variable* -v:termresponse The value of the most recent OSC escape sequence received by - Nvim from the terminal. This can be read in a |TermResponse| - event handler after querying the terminal using another escape - sequence. +v:termresponse The value of the most recent OSC or DCS escape sequence + received by Nvim from the terminal. This can be read in a + |TermResponse| event handler after querying the terminal using + another escape sequence. *v:testing* *testing-variable* v:testing Must be set before using `test_garbagecollect_now()`. diff --git a/runtime/lua/vim/_meta/api.lua b/runtime/lua/vim/_meta/api.lua index 2142a429a2..0c8979054f 100644 --- a/runtime/lua/vim/_meta/api.lua +++ b/runtime/lua/vim/_meta/api.lua @@ -2065,11 +2065,12 @@ function vim.api.nvim_ui_set_focus(gained) end --- @param value any function vim.api.nvim_ui_set_option(name, value) end ---- Tells Nvim when a terminal event has occurred. +--- Tells Nvim when a terminal event has occurred --- The following terminal events are supported: --- ---- • "osc_response": The terminal sent a OSC response sequence to Nvim. The ---- payload is the received OSC sequence. +--- • "termresponse": The terminal sent an OSC or DCS response sequence to +--- Nvim. The payload is the received response. Sets `v:termresponse` and +--- fires `TermResponse`. --- --- --- @param event string Event name |