aboutsummaryrefslogtreecommitdiff
path: root/runtime
diff options
context:
space:
mode:
authorBjörn Linse <bjorn.linse@gmail.com>2019-02-05 16:17:23 +0100
committerBjörn Linse <bjorn.linse@gmail.com>2019-02-05 19:41:38 +0100
commitbaf93d96063ceab109ecf16046a51e861a9c2c26 (patch)
tree206993aff9892e2beee704c84448221accebdb15 /runtime
parent36378c33c6ca6b5c906b8ab326db508feb32c859 (diff)
downloadrneovim-baf93d96063ceab109ecf16046a51e861a9c2c26.tar.gz
rneovim-baf93d96063ceab109ecf16046a51e861a9c2c26.tar.bz2
rneovim-baf93d96063ceab109ecf16046a51e861a9c2c26.zip
UI: always use contrete colors for default_colors_set
But add an escape hatch needed for external TUI, so it still can use terminal emulator defaults.
Diffstat (limited to 'runtime')
-rw-r--r--runtime/doc/ui.txt8
1 files changed, 8 insertions, 0 deletions
diff --git a/runtime/doc/ui.txt b/runtime/doc/ui.txt
index 8235f3a238..c6a06a4531 100644
--- a/runtime/doc/ui.txt
+++ b/runtime/doc/ui.txt
@@ -35,6 +35,7 @@ a dictionary with these (optional) keys:
`ext_linegrid` Use new revision of the grid events. |ui-linegrid|
`ext_multigrid` Use per-window grid based events. |ui-multigrid|
`ext_hlstate` Use detailed highlight state. |ui-hlstate|
+ `ext_termcolors` Use external default colors.
Specifying a non-existent option is an error. UIs can check the |api-metadata|
`ui_options` key for supported options. Additionally Nvim (currently) requires
@@ -239,6 +240,13 @@ numerical highlight `id`:s to the actual attributes.
special colors respectively. `cterm_fg` and `cterm_bg` specifies the
default color codes to use in a 256-color terminal.
+ The rgb values will always be valid colors, by default. If no
+ colors have been set, they will default to black and white, depending
+ on 'background'. By setting the `ext_termcolors` option, instead
+ -1 will be used for unset colors. This is mostly useful for a
+ TUI implementation, where using the terminal emulators builitn
+ 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.