]> git.ipfire.org Git - thirdparty/vim.git/commitdiff
runtime(doc): MS-Windows: Improve documentation about VTP support
authorChristian Brabandt <cb@256bit.org>
Thu, 25 Sep 2025 20:03:13 +0000 (20:03 +0000)
committerChristian Brabandt <cb@256bit.org>
Thu, 25 Sep 2025 20:03:13 +0000 (20:03 +0000)
Signed-off-by: Christian Brabandt <cb@256bit.org>
runtime/doc/options.txt
runtime/doc/os_win32.txt
runtime/doc/tags

index 05da8012686e3131b3b874f5700a55d5c77a26b1..012027518358ebf0125a37f227112e725f2f8880 100644 (file)
@@ -8926,9 +8926,8 @@ A jump table for the options with a short description can be found at |Q_op|.
        For Win32 console, Windows 10 version 1703 (Creators Update) or later
        is required.  Use this check to find out: >
                if has('vcon')
-<      This requires Vim to be built with the |+vtp| feature.  Enabling
-       'termguicolors' also enable Virtual Terminal Processing (VTP) in the
-       Windows console, which improves rendering of multi-byte characters.
+<      This requires Vim to be built with the |+vtp| feature, see also
+       |win32-term-colors|.
 
        Note that the "cterm" attributes are still used, not the "gui" ones.
 
index f5fa0ac98ed067297867c7fb49f1f3749f703f5b..fc3ea8439f2f593ddb129653f3803c168211b9bf 100644 (file)
@@ -1,4 +1,4 @@
-*os_win32.txt*  For Vim version 9.1.  Last change: 2025 Aug 06
+*os_win32.txt*  For Vim version 9.1.  Last change: 2025 Sep 25
 
 
                  VIM REFERENCE MANUAL    by George Reilly
@@ -24,7 +24,8 @@ The 32 bit version also runs on 64 bit MS-Windows systems.
 7. Installation package                |win32-installer|
 8. Win32 mini FAQ              |win32-faq|
 
-Additionally, there are a number of common Win32 and DOS items:
+Additionally, there are a number of common Win32 and DOS items in
+|os_dos.txt|:
 File locations                 |dos-locations|
 Using backslashes              |dos-backslash|
 Standard mappings              |dos-standard-mappings|
@@ -85,6 +86,21 @@ The only kind of terminal type that the Win32 version of Vim understands is
 probably get very strange behavior from Vim.  Therefore Vim does not obtain
 the default value of 'term' from the environment variable "TERM".
 
+Terminal Colors                                                *win32-term-colors*
+
+The Win32 console supports 16 colors by default |dos-colors|.  From Windows 10
+version 1703 (Creators Update) onwards, the console supports 256 colors and
+true color (24-bit) when 'termguicolors' is set and Vim is built with support
+for Virtual Terminal Processing (VTP) |+vtp|.
+
+Virtual Terminal Processing is automatically enabled if either the
+'termguicolors' option is set or the 't_Co' option is set to 256.  This
+enables ANSI escape sequences for colors, improves rendering of multi-byte
+characters and enables other terminal features in the Windows console.
+
+The actual color rendering depends on whether your terminal supports VTP (such
+as Windows Terminal or the modern Windows 10/11 console).
+
 $PATH                                                  *win32-PATH*
 
 The directory of the Vim executable is appended to $PATH.  This is mostly to
index 7890b417e19f3e7550a127ed366b846c77608858..9dc1f3dc5e4d803d51faea7cf209d30b6acede91 100644 (file)
@@ -11739,6 +11739,7 @@ win32-quotes    os_win32.txt    /*win32-quotes*
 win32-restore  os_win32.txt    /*win32-restore*
 win32-startup  os_win32.txt    /*win32-startup*
 win32-term     os_win32.txt    /*win32-term*
+win32-term-colors      os_win32.txt    /*win32-term-colors*
 win32-vimrun   gui_w32.txt     /*win32-vimrun*
 win32-win3.1   os_win32.txt    /*win32-win3.1*
 win32-win95    os_win32.txt    /*win32-win95*