diff options
Diffstat (limited to 'runtime')
| -rw-r--r-- | runtime/doc/debug.txt | 2 | ||||
| -rw-r--r-- | runtime/doc/deprecated.txt | 6 | ||||
| -rw-r--r-- | runtime/doc/intro.txt | 7 | ||||
| -rw-r--r-- | runtime/doc/ui.txt | 40 |
4 files changed, 30 insertions, 25 deletions
diff --git a/runtime/doc/debug.txt b/runtime/doc/debug.txt index 1019becf9c..fab12e36fa 100644 --- a/runtime/doc/debug.txt +++ b/runtime/doc/debug.txt @@ -108,7 +108,7 @@ line numbers. Double-click one of the lines and the Find Source dialog will appear. Navigate to the directory where the Vim source is (if you have it.) If you don't know how to debug this any further, follow the instructions -at ":help bug-reports". Paste the call stack into the bug report. +at ":help bug-report". Paste the call stack into the bug report. If you have a non-free version of Visual Studio, you can save a minidump via the Debug menu and send it with the bug report. A minidump is a small file diff --git a/runtime/doc/deprecated.txt b/runtime/doc/deprecated.txt index 9272c0693e..e6b6a9df45 100644 --- a/runtime/doc/deprecated.txt +++ b/runtime/doc/deprecated.txt @@ -68,10 +68,8 @@ Options ~ *'viminfofile'* Deprecated alias to 'shadafile' option. UI extensions~ -*ui-wildmenu* Use `ext_cmdline` and `ext_popupmenu` instead. - Enabled by `ext_wildmenu` |ui-options|. - If `ext_wildmenu` is set, these events are emitted for - backwards-compatibility: +*ui-wildmenu* Use |ui-cmdline| with |ui-popupmenu| instead. Enabled + by `ext_wildmenu` |ui-options|. Emits these events: ["wildmenu_show", items] ["wildmenu_select", selected] ["wildmenu_hide"] diff --git a/runtime/doc/intro.txt b/runtime/doc/intro.txt index 1d2cca3073..1fb06e169c 100644 --- a/runtime/doc/intro.txt +++ b/runtime/doc/intro.txt @@ -58,7 +58,7 @@ For more information try one of these: ============================================================================== Nvim on the interwebs *internet* - *www* *WWW* *faq* *FAQ* *distribution* *download* + *www* *faq* *distribution* *download* Nvim home page: https://neovim.io/ Nvim FAQ: https://github.com/neovim/neovim/wiki/FAQ @@ -67,9 +67,10 @@ Nvim on the interwebs *internet* Vim home page: https://www.vim.org/ -Bug reports: *bugs* *bug-reports* *bugreport.vim* + *bugs* *bug-report* *bugreport.vim* *feature-request* -Report bugs on GitHub: https://github.com/neovim/neovim/issues +Report bugs and request features here: +https://github.com/neovim/neovim/issues Be brief, yet complete. Always give a reproducible example and try to find out which settings or other things trigger the bug. diff --git a/runtime/doc/ui.txt b/runtime/doc/ui.txt index 73eb2210f5..bfcd0369ad 100644 --- a/runtime/doc/ui.txt +++ b/runtime/doc/ui.txt @@ -25,13 +25,20 @@ done by an embedder, see |ui-startup| below for details, but an UI can also connect to a running nvim instance and invoke this method. `options` must be a dictionary with these (optional) keys: `rgb` Decides the color format. *ui-rgb* - Set true (default) for 24-bit RGB colors. - Set false for terminal colors (max of 256). + true: (default) 24-bit RGB colors + false: Terminal colors (8-bit, max 256) + `override` Decides how UI capabilities are resolved. + true: Enable requested UI capabilities, even + if not supported by all connected UIs + (including |TUI|). + false: (default) Disable UI capabilities not + supported by all connected UIs + (including TUI). *ui-ext-options* - `ext_popupmenu` Externalize the popupmenu. |ui-popupmenu| + `ext_popupmenu` Externalize |popupmenu-completion| and + 'wildmenu'. |ui-popupmenu| `ext_tabline` Externalize the tabline. |ui-tabline| `ext_cmdline` Externalize the cmdline. |ui-cmdline| - `ext_wildmenu` Externalize the wildmenu (deprecated). |ui-wildmenu| `ext_messages` Externalize messages. |ui-messages| `ext_linegrid` Use new revision of the grid events. |ui-linegrid| `ext_multigrid` Use per-window grid based events. |ui-multigrid| @@ -245,9 +252,9 @@ numerical highlight ids to the actual attributes. implementation, where using the terminal builtin ("ANSI") defaults are expected. - Note: unlike the corresponding events in the first revision, the - screen is not always cleared after sending this event. The GUI has to - repaint the screen with changed background color itself. + Note: Unlike the corresponding |ui-grid-old| events, the screen is not + always cleared after sending this event. The UI must repaint the + screen with changed background color itself. *ui-event-hl_attr_define* ["hl_attr_define", id, rgb_attr, cterm_attr, info] @@ -554,6 +561,7 @@ See |nvim_input_mouse| for sending mouse events to Nvim. Popupmenu Events *ui-popupmenu* Only sent if `ext_popupmenu` option is set in |ui-options|. +Events for |popupmenu-completion| and command-line 'wildmenu'. ["popupmenu_show", items, selected, row, col, grid] Show |popupmenu-completion|. `items` is an array of completion items @@ -590,9 +598,7 @@ Only sent if `ext_tabline` option is set in |ui-options| Cmdline Events *ui-cmdline* Only sent if `ext_cmdline` option is set in |ui-options|. To handle -command-line completion (wildmenu), use |ui-popupmenu| events activated by -|ext_popupmenu| option. (The `ext_wildmenu` option only exists for backwards -compatibility). +command-line 'wildmenu', enable |ui-popupmenu| and handle its events. ["cmdline_show", content, pos, firstc, prompt, indent, level] content: List of [attrs, string] @@ -650,18 +656,18 @@ compatibility). ============================================================================== Message Events *ui-messages* -Only sent if `ext_messages` option is set in |ui-options|. This option implies -`ext_linegrid` and `ext_cmdline` also being set. |ui-linegrid| and |ui-cmdline| events -will thus also be sent. +Only sent if `ext_messages` option is set in |ui-options|. This option +implicitly enables `ext_linegrid` and `ext_cmdline`. |ui-linegrid| and +|ui-cmdline| events will thus also be sent. This extension allows the UI to control the display of messages that otherwise would have been displayed in the message/cmdline area in the bottom of the screen. -Activating this extension means that Nvim will allocate no screen space for -the cmdline or messages, and 'cmdheight' will be set to zero. Attempting to -change 'cmdheight' will silently be ignored. |ui-cmdline| events will be used -to represent the state of the cmdline. +Activating this extension means that Nvim will not allocate screen space for +the cmdline or messages, 'cmdheight' will be zero. Attempting to change +'cmdheight' will be silently ignored. |ui-cmdline| events represent the state +of the cmdline. ["msg_show", kind, content, replace_last] Display a message to the user. |