diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2024-09-18 04:14:06 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-09-18 04:14:06 -0700 |
| commit | ff85e54939b0aca34a779a2b6381d09db1858b29 (patch) | |
| tree | eea30db8b69582af6c206b1a8ac0b4918fc61e20 /runtime/doc/api.txt | |
| parent | 22553e1f38addd867ad659b2944d00129141a499 (diff) | |
| download | rneovim-ff85e54939b0aca34a779a2b6381d09db1858b29.tar.gz rneovim-ff85e54939b0aca34a779a2b6381d09db1858b29.tar.bz2 rneovim-ff85e54939b0aca34a779a2b6381d09db1858b29.zip | |
feat(tui): builtin UI (TUI) sets client info #30397
Problem:
The default builtin UI client does not declare its client info. This
reduces discoverability and makes it difficult for plugins to identify
the UI.
Solution:
- Call nvim_set_client_info after attaching, as recommended by `:help dev-ui`.
- Also set the "pid" field.
- Also change `ui_active()` to return a count. Not directly relevant to
this commit, but will be useful later.
Diffstat (limited to 'runtime/doc/api.txt')
| -rw-r--r-- | runtime/doc/api.txt | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index a7b59f20bc..45c6168e3d 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -779,7 +779,7 @@ nvim_get_chan_info({chan}) *nvim_get_chan_info()* • {chan} channel_id, or 0 for current channel Return: ~ - Dictionary describing a channel, with these keys: + Channel info dict with these keys: • "id" Channel id. • "argv" (optional) Job arguments list. • "stream" Stream underlying the channel. @@ -792,11 +792,11 @@ nvim_get_chan_info({chan}) *nvim_get_chan_info()* • "terminal" |terminal| instance interprets ASCII sequences. • "rpc" |RPC| communication on the channel is active. • "pty" (optional) Name of pseudoterminal. On a POSIX system this is a - device path like "/dev/pts/1". If the name is unknown, the key will - still be present if a pty is used (e.g. for conpty on Windows). - • "buffer" (optional) Buffer with connected |terminal| instance. + device path like "/dev/pts/1". If unknown, the key will still be + present if a pty is used (e.g. for conpty on Windows). + • "buffer" (optional) Buffer connected to |terminal| instance. • "client" (optional) Info about the peer (client on the other end of - the RPC channel), if provided by it via |nvim_set_client_info()|. + the RPC channel), which it provided via |nvim_set_client_info()|. nvim_get_color_by_name({name}) *nvim_get_color_by_name()* Returns the 24-bit RGB value of a |nvim_get_color_map()| color name or @@ -1285,6 +1285,7 @@ nvim_set_client_info({name}, {version}, {type}, {methods}, {attributes}) inclusive. • {attributes} Arbitrary string:string map of informal client properties. Suggested keys: + • "pid": Process id. • "website": Client homepage URL (e.g. GitHub repository) • "license": License description ("Apache 2", "GPLv3", |