diff options
author | Justin M. Keyes <justinkz@gmail.com> | 2019-05-02 09:56:22 +0200 |
---|---|---|
committer | Justin M. Keyes <justinkz@gmail.com> | 2019-05-02 09:56:22 +0200 |
commit | fd0fd752c872428cc4fb9c95721eab1b505fc111 (patch) | |
tree | 82b1f3d0635af4b2ce170b0f2768691df2855062 /runtime | |
parent | 49c51f839b537ac8ff60671030a8d7b2399ad4a7 (diff) | |
download | rneovim-fd0fd752c872428cc4fb9c95721eab1b505fc111.tar.gz rneovim-fd0fd752c872428cc4fb9c95721eab1b505fc111.tar.bz2 rneovim-fd0fd752c872428cc4fb9c95721eab1b505fc111.zip |
terminal: swap priority of terminal, editor highlights
closes #9964
Diffstat (limited to 'runtime')
-rw-r--r-- | runtime/doc/nvim_terminal_emulator.txt | 29 | ||||
-rw-r--r-- | runtime/doc/options.txt | 6 |
2 files changed, 21 insertions, 14 deletions
diff --git a/runtime/doc/nvim_terminal_emulator.txt b/runtime/doc/nvim_terminal_emulator.txt index af94c60629..cfaec12520 100644 --- a/runtime/doc/nvim_terminal_emulator.txt +++ b/runtime/doc/nvim_terminal_emulator.txt @@ -7,8 +7,8 @@ Terminal emulator *terminal* *terminal-emulator* Nvim embeds a VT220/xterm terminal emulator based on libvterm. The terminal is -presented as a special buffer type, asynchronously updated from the virtual -terminal as data is received from the program connected to it. +presented as a special 'buftype', asynchronously updated as data is received +from the connected program. Terminal buffers behave like normal buffers, except: - With 'modifiable', lines can be edited but not deleted. @@ -23,11 +23,11 @@ Terminal buffers behave like normal buffers, except: ============================================================================== Start *terminal-start* -There are 3 ways to create a terminal buffer: +There are several ways to create a terminal buffer: -- By invoking the |:terminal| ex command. -- By calling the |termopen()| function. -- By editing a file with a name matching `term://(.{-}//(\d+:)?)?\zs.*`. +- Invoke the |:terminal| command. +- Call the |termopen()| function. +- Edit a file with a name matching `term://(.{-}//(\d+:)?)?\zs.*`. For example: > :edit term://bash @@ -98,14 +98,21 @@ global configuration. - 'wrap' is disabled You can change the defaults with a TermOpen autocommand: > - au TermOpen * setlocal list + au TermOpen * setlocal list TERMINAL COLORS ~ -The `{g,b}:terminal_color_$NUM` variables control the terminal color palette, -where `$NUM` is the color index between 0 and 255 inclusive. This setting only -affects UIs with RGB capabilities; for normal terminals the color index is -just forwarded. The variables are read only during |TermOpen|. +The `{g,b}:terminal_color_x` variables control the terminal color palette, +where `x` is the color index between 0 and 255 inclusive. The variables are +read during |TermOpen|. The value must be a color name or hexadecimal string. +Example: > + let g:terminal_color_4 = '#ff0000' + let g:terminal_color_5 = 'green' +Only works for RGB UIs (see 'termguicolors'); for 256-color terminals the +color index is just forwarded. + +Editor highlighting (|syntax-highlighting|, |highlight-groups|, etc.) has +higher precedence: it is applied after terminal colors are resolved. ============================================================================== Status Variables *terminal-status* diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index 5b9a9d5dd0..cce9f681f9 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -6131,9 +6131,9 @@ A jump table for the options with a short description can be found at |Q_op|. *'termguicolors'* *'tgc'* 'termguicolors' 'tgc' boolean (default off) global - When on, uses |highlight-guifg| and |highlight-guibg| attributes in - the terminal (thus using 24-bit color). Requires a ISO-8613-3 - compatible terminal. + Enables 24-bit RGB color in the |TUI|. Uses "gui" |:highlight| + attributes instead of "cterm" attributes. |highlight-guifg| + Requires an ISO-8613-3 compatible terminal. *'terse'* *'noterse'* 'terse' boolean (default off) |