aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc
diff options
context:
space:
mode:
authorGregory Anders <greg@gpanders.com>2023-12-05 10:01:32 -0800
committerGregory Anders <greg@gpanders.com>2023-12-06 07:57:09 -0800
commit2613ba5000d4c0d9b15e2eec2d2b97615575925e (patch)
tree7fde88589dbf7e5e30130ae65cdb6a9df2e61ccb /runtime/doc
parent5b40a1c09dda83275784053b325ad16626fc55f2 (diff)
downloadrneovim-2613ba5000d4c0d9b15e2eec2d2b97615575925e.tar.gz
rneovim-2613ba5000d4c0d9b15e2eec2d2b97615575925e.tar.bz2
rneovim-2613ba5000d4c0d9b15e2eec2d2b97615575925e.zip
feat(defaults): enable 'termguicolors' by default when supported by terminal
Enable 'termguicolors' automatically when Nvim can detect that truecolor is supported by the host terminal. If $COLORTERM is set to "truecolor" or "24bit", or the terminal's terminfo entry contains capabilities for Tc, RGB, or setrgbf and setrgbb, then we assume that the terminal supports truecolor. Otherwise, the terminal is queried (using both XTGETTCAP and SGR + DECRQSS). If the terminal's response to these queries (if any) indicates that it supports truecolor, then 'termguicolors' is enabled.
Diffstat (limited to 'runtime/doc')
-rw-r--r--runtime/doc/news.txt3
-rw-r--r--runtime/doc/options.txt4
-rw-r--r--runtime/doc/vim_diff.txt2
3 files changed, 9 insertions, 0 deletions
diff --git a/runtime/doc/news.txt b/runtime/doc/news.txt
index e38707fa76..3006287e62 100644
--- a/runtime/doc/news.txt
+++ b/runtime/doc/news.txt
@@ -98,6 +98,9 @@ The following changes may require adaptations in user config or plugins.
• Default color scheme has been updated to be "Neovim branded" and accessible.
Use `:colorscheme vim` to revert to the old legacy color scheme.
+• 'termguicolors' is enabled by default when Nvim is able to determine that
+ the host terminal emulator supports 24-bit color.
+
==============================================================================
BREAKING CHANGES IN HEAD *news-breaking-dev*
diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index f47093782c..355c8cc99a 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -6495,6 +6495,10 @@ A jump table for the options with a short description can be found at |Q_op|.
attributes instead of "cterm" attributes. |guifg|
Requires an ISO-8613-3 compatible terminal.
+ Nvim will automatically attempt to determine if the host terminal
+ supports 24-bit color and will enable this option if it does
+ (unless explicitly disabled by the user).
+
*'termpastefilter'* *'tpf'*
'termpastefilter' 'tpf' string (default "BS,HT,ESC,DEL")
global
diff --git a/runtime/doc/vim_diff.txt b/runtime/doc/vim_diff.txt
index f6dfe3b14a..220505f573 100644
--- a/runtime/doc/vim_diff.txt
+++ b/runtime/doc/vim_diff.txt
@@ -75,6 +75,8 @@ Defaults *nvim-defaults*
- 'switchbuf' defaults to "uselast"
- 'tabpagemax' defaults to 50
- 'tags' defaults to "./tags;,tags"
+- 'termguicolors' is enabled by default if Nvim can detect support from the
+ host terminal
- 'ttimeoutlen' defaults to 50
- 'ttyfast' is always set
- 'undodir' defaults to ~/.local/state/nvim/undo// (|xdg|), auto-created