Mercurial > vim
annotate runtime/doc/term.txt @ 30019:347cf03fee2b v9.0.0347
patch 9.0.0347: MS-Windows: cannot set cursor shape in Windows Terminal
Commit: https://github.com/vim/vim/commit/df5320c439e9a7f7bf1ebff3cb455d45e223547a
Author: K.Takata <kentkt@csc.jp>
Date: Thu Sep 1 13:20:16 2022 +0100
patch 9.0.0347: MS-Windows: cannot set cursor shape in Windows Terminal
Problem: MS-Windows: cannot set cursor shape in Windows Terminal.
Solution: Make cursor shape work with Windows Terminal. (Ken Takata,
closes #11028, closes #6576)
| author | Bram Moolenaar <Bram@vim.org> |
|---|---|
| date | Thu, 01 Sep 2022 14:30:02 +0200 |
| parents | f00c56ee8118 |
| children | eb2638f278bf |
| rev | line source |
|---|---|
| 29314 | 1 *term.txt* For Vim version 9.0. Last change: 2022 Apr 23 |
| 7 | 2 |
| 3 | |
| 4 VIM REFERENCE MANUAL by Bram Moolenaar | |
| 5 | |
| 6 | |
| 7 Terminal information *terminal-info* | |
| 8 | |
| 9 Vim uses information about the terminal you are using to fill the screen and | |
| 10 recognize what keys you hit. If this information is not correct, the screen | |
| 11 may be messed up or keys may not be recognized. The actions which have to be | |
| 12 performed on the screen are accomplished by outputting a string of | |
| 13 characters. Special keys produce a string of characters. These strings are | |
| 14 stored in the terminal options, see |terminal-options|. | |
| 15 | |
| 16 NOTE: Most of this is not used when running the |GUI|. | |
| 17 | |
| 18 1. Startup |startup-terminal| | |
| 19 2. Terminal options |terminal-options| | |
| 20 3. Window size |window-size| | |
| 21 4. Slow and fast terminals |slow-fast-terminal| | |
| 22 5. Using the mouse |mouse-using| | |
| 23 | |
| 24 ============================================================================== | |
| 25 1. Startup *startup-terminal* | |
| 26 | |
| 27 When Vim is started a default terminal type is assumed. For the Amiga this is | |
| 18972 | 28 a standard CLI window, for MS-Windows the pc terminal, for Unix an ansi |
| 29 terminal. A few other terminal types are always available, see below | |
| 30 |builtin-terms|. | |
| 7 | 31 |
| 32 You can give the terminal name with the '-T' Vim argument. If it is not given | |
| 33 Vim will try to get the name from the TERM environment variable. | |
| 34 | |
| 35 *termcap* *terminfo* *E557* *E558* *E559* | |
| 36 On Unix the terminfo database or termcap file is used. This is referred to as | |
| 37 "termcap" in all the documentation. At compile time, when running configure, | |
| 38 the choice whether to use terminfo or termcap is done automatically. When | |
| 39 running Vim the output of ":version" will show |+terminfo| if terminfo is | |
| 40 used. Also see |xterm-screens|. | |
| 41 | |
| 42 On non-Unix systems a termcap is only available if Vim was compiled with | |
| 43 TERMCAP defined. | |
| 44 | |
| 45 *builtin-terms* *builtin_terms* | |
|
29883
1342ee83ab97
patch 9.0.0280: the builtin termcap list depends on the version
Bram Moolenaar <Bram@vim.org>
parents:
29403
diff
changeset
|
46 A number of builtin terminals are available. Since patch 9.0.0280 there is no |
|
1342ee83ab97
patch 9.0.0280: the builtin termcap list depends on the version
Bram Moolenaar <Bram@vim.org>
parents:
29403
diff
changeset
|
47 difference between Vim versions. You can see a list of available builtin |
|
1342ee83ab97
patch 9.0.0280: the builtin termcap list depends on the version
Bram Moolenaar <Bram@vim.org>
parents:
29403
diff
changeset
|
48 terminals in the error message you get for `:set term=xxx` (when not running |
| 29885 | 49 the GUI). Also see |++builtin_terms|. |
| 7 | 50 |
| 51 If the termcap code is included Vim will try to get the strings for the | |
| 52 terminal you are using from the termcap file and the builtin termcaps. Both | |
| 53 are always used, if an entry for the terminal you are using is present. Which | |
| 54 one is used first depends on the 'ttybuiltin' option: | |
| 55 | |
| 56 'ttybuiltin' on 1: builtin termcap 2: external termcap | |
| 57 'ttybuiltin' off 1: external termcap 2: builtin termcap | |
| 58 | |
| 59 If an option is missing in one of them, it will be obtained from the other | |
| 60 one. If an option is present in both, the one first encountered is used. | |
| 61 | |
| 62 Which external termcap file is used varies from system to system and may | |
| 63 depend on the environment variables "TERMCAP" and "TERMPATH". See "man | |
| 64 tgetent". | |
| 65 | |
| 66 Settings depending on terminal *term-dependent-settings* | |
| 67 | |
| 68 If you want to set options or mappings, depending on the terminal name, you | |
| 69 can do this best in your .vimrc. Example: > | |
| 70 | |
| 71 if &term == "xterm" | |
| 72 ... xterm maps and settings ... | |
| 73 elseif &term =~ "vt10." | |
| 74 ... vt100, vt102 maps and settings ... | |
| 75 endif | |
| 76 < | |
| 77 *raw-terminal-mode* | |
| 78 For normal editing the terminal will be put into "raw" mode. The strings | |
|
18299
a9cf41bcb5d6
patch 8.1.2144: side effects when using t_ti to enable modifyOtherKeys
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
79 defined with 't_ti', 't_TI' and 't_ks' will be sent to the terminal. Normally |
|
a9cf41bcb5d6
patch 8.1.2144: side effects when using t_ti to enable modifyOtherKeys
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
80 this puts the terminal in a state where the termcap codes are valid and |
|
a9cf41bcb5d6
patch 8.1.2144: side effects when using t_ti to enable modifyOtherKeys
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
81 activates the cursor and function keys. |
|
a9cf41bcb5d6
patch 8.1.2144: side effects when using t_ti to enable modifyOtherKeys
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
82 When Vim exits the terminal will be put back into the mode it was before Vim |
|
a9cf41bcb5d6
patch 8.1.2144: side effects when using t_ti to enable modifyOtherKeys
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
83 started. The strings defined with 't_te', 't_TE' and 't_ke' will be sent to |
|
a9cf41bcb5d6
patch 8.1.2144: side effects when using t_ti to enable modifyOtherKeys
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
84 the terminal. On the Amiga, with commands that execute an external command |
|
a9cf41bcb5d6
patch 8.1.2144: side effects when using t_ti to enable modifyOtherKeys
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
85 (e.g., "!!"), the terminal will be put into Normal mode for a moment. This |
|
a9cf41bcb5d6
patch 8.1.2144: side effects when using t_ti to enable modifyOtherKeys
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
86 means that you can stop the output to the screen by hitting a printing key. |
|
a9cf41bcb5d6
patch 8.1.2144: side effects when using t_ti to enable modifyOtherKeys
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
87 Output resumes when you hit <BS>. |
|
a9cf41bcb5d6
patch 8.1.2144: side effects when using t_ti to enable modifyOtherKeys
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
88 |
|
a9cf41bcb5d6
patch 8.1.2144: side effects when using t_ti to enable modifyOtherKeys
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
89 Note: When 't_ti' is not empty, Vim assumes that it causes switching to the |
|
a9cf41bcb5d6
patch 8.1.2144: side effects when using t_ti to enable modifyOtherKeys
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
90 alternate screen. This may slightly change what happens when executing a |
|
a9cf41bcb5d6
patch 8.1.2144: side effects when using t_ti to enable modifyOtherKeys
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
91 shell command or exiting Vim. To avoid this use 't_TI' and 't_TE'. |
| 7 | 92 |
|
10640
27be410d6d29
patch 8.0.0210: no support for bracketed paste
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
93 *xterm-bracketed-paste* |
|
27be410d6d29
patch 8.0.0210: no support for bracketed paste
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
94 When the 't_BE' option is set then 't_BE' will be sent to the |
|
27be410d6d29
patch 8.0.0210: no support for bracketed paste
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
95 terminal when entering "raw" mode and 't_BD' when leaving "raw" mode. The |
|
27be410d6d29
patch 8.0.0210: no support for bracketed paste
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
96 terminal is then expected to put 't_PS' before pasted text and 't_PE' after |
|
27be410d6d29
patch 8.0.0210: no support for bracketed paste
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
97 pasted text. This way Vim can separate text that is pasted from characters |
|
27be410d6d29
patch 8.0.0210: no support for bracketed paste
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
98 that are typed. The pasted text is handled like when the middle mouse button |
|
10813
09eb5fd275e0
patch 8.0.0296: bracketed paste can only append, not insert
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
99 is used, it is inserted literally and not interpreted as commands. |
|
09eb5fd275e0
patch 8.0.0296: bracketed paste can only append, not insert
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
100 |
|
09eb5fd275e0
patch 8.0.0296: bracketed paste can only append, not insert
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
101 When the cursor is in the first column, the pasted text will be inserted |
|
09eb5fd275e0
patch 8.0.0296: bracketed paste can only append, not insert
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
102 before it. Otherwise the pasted text is appended after the cursor position. |
|
09eb5fd275e0
patch 8.0.0296: bracketed paste can only append, not insert
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
103 This means one cannot paste after the first column. Unfortunately Vim does |
|
09eb5fd275e0
patch 8.0.0296: bracketed paste can only append, not insert
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
104 not have a way to tell where the mouse pointer was. |
|
10640
27be410d6d29
patch 8.0.0210: no support for bracketed paste
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
105 |
|
27be410d6d29
patch 8.0.0210: no support for bracketed paste
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
106 Note that in some situations Vim will not recognize the bracketed paste and |
|
27be410d6d29
patch 8.0.0210: no support for bracketed paste
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
107 you will get the raw text. In other situations Vim will only get the first |
| 10734 | 108 pasted character and drop the rest, e.g. when using the "r" command. If you |
| 109 have a problem with this, disable bracketed paste by putting this in your | |
| 110 .vimrc: > | |
| 111 set t_BE= | |
| 112 If this is done while Vim is running the 't_BD' will be sent to the terminal | |
| 113 to disable bracketed paste. | |
|
10640
27be410d6d29
patch 8.0.0210: no support for bracketed paste
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
114 |
| 14123 | 115 If your terminal supports bracketed paste, but the options are not set |
| 116 automatically, you can try using something like this: > | |
| 117 | |
| 118 if &term =~ "screen" | |
| 119 let &t_BE = "\e[?2004h" | |
| 120 let &t_BD = "\e[?2004l" | |
| 121 exec "set t_PS=\e[200~" | |
| 122 exec "set t_PE=\e[201~" | |
| 123 endif | |
| 124 < | |
| 25700 | 125 *tmux-integration* |
| 126 If you experience issues when running Vim inside tmux, here are a few hints. | |
| 127 You can comment-out parts if something doesn't work (it may depend on the | |
| 128 terminal that tmux is running in): > | |
| 129 | |
| 130 if !has('gui_running') && &term =~ '^\%(screen\|tmux\)' | |
| 131 " Better mouse support, see :help 'ttymouse' | |
| 132 set ttymouse=sgr | |
| 133 | |
| 134 " Enable true colors, see :help xterm-true-color | |
| 135 let &termguicolors = v:true | |
| 136 let &t_8f = "\<Esc>[38;2;%lu;%lu;%lum" | |
| 137 let &t_8b = "\<Esc>[48;2;%lu;%lu;%lum" | |
| 138 | |
| 139 " Enable bracketed paste mode, see :help xterm-bracketed-paste | |
| 140 let &t_BE = "\<Esc>[?2004h" | |
| 141 let &t_BD = "\<Esc>[?2004l" | |
| 142 let &t_PS = "\<Esc>[200~" | |
| 143 let &t_PE = "\<Esc>[201~" | |
| 144 | |
| 145 " Enable focus event tracking, see :help xterm-focus-event | |
| 146 let &t_fe = "\<Esc>[?1004h" | |
| 147 let &t_fd = "\<Esc>[?1004l" | |
| 26591 | 148 execute "set <FocusGained>=\<Esc>[I" |
| 149 execute "set <FocusLost>=\<Esc>[O" | |
| 25700 | 150 |
| 26438 | 151 " Enable modified arrow keys, see :help arrow_modifiers |
| 25700 | 152 execute "silent! set <xUp>=\<Esc>[@;*A" |
| 153 execute "silent! set <xDown>=\<Esc>[@;*B" | |
| 154 execute "silent! set <xRight>=\<Esc>[@;*C" | |
| 155 execute "silent! set <xLeft>=\<Esc>[@;*D" | |
| 156 endif | |
| 157 < | |
| 7 | 158 *cs7-problem* |
| 159 Note: If the terminal settings are changed after running Vim, you might have | |
| 160 an illegal combination of settings. This has been reported on Solaris 2.5 | |
| 161 with "stty cs8 parenb", which is restored as "stty cs7 parenb". Use | |
| 162 "stty cs8 -parenb -istrip" instead, this is restored correctly. | |
| 163 | |
| 164 Some termcap entries are wrong in the sense that after sending 't_ks' the | |
| 165 cursor keys send codes different from the codes defined in the termcap. To | |
| 166 avoid this you can set 't_ks' (and 't_ke') to empty strings. This must be | |
| 167 done during initialization (see |initialization|), otherwise it's too late. | |
| 168 | |
| 169 Some termcap entries assume that the highest bit is always reset. For | |
| 170 example: The cursor-up entry for the Amiga could be ":ku=\E[A:". But the | |
| 171 Amiga really sends "\233A". This works fine if the highest bit is reset, | |
| 172 e.g., when using an Amiga over a serial line. If the cursor keys don't work, | |
| 173 try the entry ":ku=\233A:". | |
| 174 | |
| 175 Some termcap entries have the entry ":ku=\E[A:". But the Amiga really sends | |
| 176 "\233A". On output "\E[" and "\233" are often equivalent, on input they | |
| 177 aren't. You will have to change the termcap entry, or change the key code with | |
| 178 the :set command to fix this. | |
| 179 | |
| 180 Many cursor key codes start with an <Esc>. Vim must find out if this is a | |
| 181 single hit of the <Esc> key or the start of a cursor key sequence. It waits | |
| 182 for a next character to arrive. If it does not arrive within one second a | |
| 183 single <Esc> is assumed. On very slow systems this may fail, causing cursor | |
| 184 keys not to work sometimes. If you discover this problem reset the 'timeout' | |
| 185 option. Vim will wait for the next character to arrive after an <Esc>. If | |
| 186 you want to enter a single <Esc> you must type it twice. Resetting the | |
| 187 'esckeys' option avoids this problem in Insert mode, but you lose the | |
| 188 possibility to use cursor and function keys in Insert mode. | |
| 189 | |
| 190 On the Amiga the recognition of window resizing is activated only when the | |
| 191 terminal name is "amiga" or "builtin_amiga". | |
| 192 | |
| 193 Some terminals have confusing codes for the cursor keys. The televideo 925 is | |
| 194 such a terminal. It sends a CTRL-H for cursor-left. This would make it | |
| 195 impossible to distinguish a backspace and cursor-left. To avoid this problem | |
| 196 CTRL-H is never recognized as cursor-left. | |
| 197 | |
| 198 *vt100-cursor-keys* *xterm-cursor-keys* | |
| 199 Other terminals (e.g., vt100 and xterm) have cursor keys that send <Esc>OA, | |
| 200 <Esc>OB, etc. Unfortunately these are valid commands in insert mode: Stop | |
| 201 insert, Open a new line above the new one, start inserting 'A', 'B', etc. | |
| 202 Instead of performing these commands Vim will erroneously recognize this typed | |
| 203 key sequence as a cursor key movement. To avoid this and make Vim do what you | |
| 204 want in either case you could use these settings: > | |
| 205 :set notimeout " don't timeout on mappings | |
| 206 :set ttimeout " do timeout on terminal key codes | |
| 207 :set timeoutlen=100 " timeout after 100 msec | |
| 1621 | 208 This requires the key-codes to be sent within 100 msec in order to recognize |
| 7 | 209 them as a cursor key. When you type you normally are not that fast, so they |
| 210 are recognized as individual typed commands, even though Vim receives the same | |
| 211 sequence of bytes. | |
| 212 | |
| 213 *vt100-function-keys* *xterm-function-keys* | |
| 214 An xterm can send function keys F1 to F4 in two modes: vt100 compatible or | |
| 179 | 215 not. Because Vim may not know what the xterm is sending, both types of keys |
| 7 | 216 are recognized. The same happens for the <Home> and <End> keys. |
| 217 normal vt100 ~ | |
| 218 <F1> t_k1 <Esc>[11~ <xF1> <Esc>OP *<xF1>-xterm* | |
| 219 <F2> t_k2 <Esc>[12~ <xF2> <Esc>OQ *<xF2>-xterm* | |
| 220 <F3> t_k3 <Esc>[13~ <xF3> <Esc>OR *<xF3>-xterm* | |
| 221 <F4> t_k4 <Esc>[14~ <xF4> <Esc>OS *<xF4>-xterm* | |
| 222 <Home> t_kh <Esc>[7~ <xHome> <Esc>OH *<xHome>-xterm* | |
| 223 <End> t_@7 <Esc>[4~ <xEnd> <Esc>OF *<xEnd>-xterm* | |
| 224 | |
| 225 When Vim starts, <xF1> is mapped to <F1>, <xF2> to <F2> etc. This means that | |
| 226 by default both codes do the same thing. If you make a mapping for <xF2>, | |
| 227 because your terminal does have two keys, the default mapping is overwritten, | |
| 228 thus you can use the <F2> and <xF2> keys for something different. | |
| 229 | |
| 230 *xterm-shifted-keys* | |
| 231 Newer versions of xterm support shifted function keys and special keys. Vim | |
| 232 recognizes most of them. Use ":set termcap" to check which are supported and | |
| 233 what the codes are. Mostly these are not in a termcap, they are only | |
| 234 supported by the builtin_xterm termcap. | |
| 235 | |
| 179 | 236 *xterm-modifier-keys* |
| 237 Newer versions of xterm support Alt and Ctrl for most function keys. To avoid | |
| 238 having to add all combinations of Alt, Ctrl and Shift for every key a special | |
| 239 sequence is recognized at the end of a termcap entry: ";*X". The "X" can be | |
| 240 any character, often '~' is used. The ";*" stands for an optional modifier | |
| 241 argument. ";2" is Shift, ";3" is Alt, ";5" is Ctrl and ";9" is Meta (when | |
| 242 it's different from Alt). They can be combined. Examples: > | |
| 243 :set <F8>=^[[19;*~ | |
| 244 :set <Home>=^[[1;*H | |
| 245 Another speciality about these codes is that they are not overwritten by | |
| 246 another code. That is to avoid that the codes obtained from xterm directly | |
| 247 |t_RV| overwrite them. | |
|
23406
24ce202a7d68
patch 8.2.2246: cursor keys not recognized at the hit-Enter prompt
Bram Moolenaar <Bram@vim.org>
parents:
20619
diff
changeset
|
248 |
|
24ce202a7d68
patch 8.2.2246: cursor keys not recognized at the hit-Enter prompt
Bram Moolenaar <Bram@vim.org>
parents:
20619
diff
changeset
|
249 Another special value is a termcap entry ending in "@;*X". This is for cursor |
|
24ce202a7d68
patch 8.2.2246: cursor keys not recognized at the hit-Enter prompt
Bram Moolenaar <Bram@vim.org>
parents:
20619
diff
changeset
|
250 keys, which either use "CSI X" or "CSI 1 ; modifier X". Thus the "@" |
|
24ce202a7d68
patch 8.2.2246: cursor keys not recognized at the hit-Enter prompt
Bram Moolenaar <Bram@vim.org>
parents:
20619
diff
changeset
|
251 stands for either "1" if a modifier follows, or nothing. |
| 26438 | 252 *arrow_modifiers* |
| 253 Several terminal emulators (alacritty, gnome, konsole, etc.) send special | |
| 254 codes for keys with modifiers, but these do not have an entry in the | |
| 255 termcap/terminfo database. You can make them work by adding a few lines in | |
| 256 your vimrc. For example, to make the Control modifier work with arrow keys | |
| 257 for the gnome terminal: > | |
| 258 if &term =~ 'gnome' | |
| 259 execute "set <xUp>=\<Esc>[@;*A" | |
| 260 execute "set <xDown>=\<Esc>[@;*B" | |
| 261 execute "set <xRight>=\<Esc>[@;*C" | |
| 262 execute "set <xLeft>=\<Esc>[@;*D" | |
| 263 endif | |
| 264 < *xterm-scroll-region* | |
| 7 | 265 The default termcap entry for xterm on Sun and other platforms does not |
| 266 contain the entry for scroll regions. Add ":cs=\E[%i%d;%dr:" to the xterm | |
| 267 entry in /etc/termcap and everything should work. | |
| 268 | |
| 269 *xterm-end-home-keys* | |
| 270 On some systems (at least on FreeBSD with XFree86 3.1.2) the codes that the | |
| 271 <End> and <Home> keys send contain a <Nul> character. To make these keys send | |
| 272 the proper key code, add these lines to your ~/.Xdefaults file: | |
| 273 | |
| 274 *VT100.Translations: #override \n\ | |
| 275 <Key>Home: string("0x1b") string("[7~") \n\ | |
| 276 <Key>End: string("0x1b") string("[8~") | |
| 277 | |
| 278 *xterm-8bit* *xterm-8-bit* | |
| 279 Xterm can be run in a mode where it uses 8-bit escape sequences. The CSI code | |
| 280 is used instead of <Esc>[. The advantage is that an <Esc> can quickly be | |
| 281 recognized in Insert mode, because it can't be confused with the start of a | |
| 282 special key. | |
| 283 For the builtin termcap entries, Vim checks if the 'term' option contains | |
| 284 "8bit" anywhere. It then uses 8-bit characters for the termcap entries, the | |
| 285 mouse and a few other things. You would normally set $TERM in your shell to | |
| 286 "xterm-8bit" and Vim picks this up and adjusts to the 8-bit setting | |
| 287 automatically. | |
| 288 When Vim receives a response to the |t_RV| (request version) sequence and it | |
| 289 starts with CSI, it assumes that the terminal is in 8-bit mode and will | |
| 290 convert all key sequences to their 8-bit variants. | |
| 291 | |
| 292 ============================================================================== | |
| 667 | 293 2. Terminal options *terminal-options* *termcap-options* *E436* |
| 7 | 294 |
| 295 The terminal options can be set just like normal options. But they are not | |
| 296 shown with the ":set all" command. Instead use ":set termcap". | |
| 297 | |
| 298 It is always possible to change individual strings by setting the | |
| 299 appropriate option. For example: > | |
| 300 :set t_ce=^V^[[K (CTRL-V, <Esc>, [, K) | |
| 301 | |
| 302 The options are listed below. The associated termcap code is always equal to | |
| 303 the last two characters of the option name. Only one termcap code is | |
| 304 required: Cursor motion, 't_cm'. | |
| 305 | |
| 6602 | 306 The options 't_da', 't_db', 't_ms', 't_xs', 't_xn' represent flags in the |
| 307 termcap. When the termcap flag is present, the option will be set to "y". | |
| 308 But any non-empty string means that the flag is set. An empty string means | |
| 309 that the flag is not set. 't_CS' works like this too, but it isn't a termcap | |
| 310 flag. | |
| 7 | 311 |
| 11062 | 312 OUTPUT CODES *terminal-output-codes* |
| 7 | 313 option meaning ~ |
| 314 | |
| 315 t_AB set background color (ANSI) *t_AB* *'t_AB'* | |
| 316 t_AF set foreground color (ANSI) *t_AF* *'t_AF'* | |
| 317 t_AL add number of blank lines *t_AL* *'t_AL'* | |
| 318 t_al add new blank line *t_al* *'t_al'* | |
| 319 t_bc backspace character *t_bc* *'t_bc'* | |
| 320 t_cd clear to end of screen *t_cd* *'t_cd'* | |
| 321 t_ce clear to end of line *t_ce* *'t_ce'* | |
| 322 t_cl clear screen *t_cl* *'t_cl'* | |
| 323 t_cm cursor motion (required!) *E437* *t_cm* *'t_cm'* | |
| 324 t_Co number of colors *t_Co* *'t_Co'* | |
| 325 t_CS if non-empty, cursor relative to scroll region *t_CS* *'t_CS'* | |
| 326 t_cs define scrolling region *t_cs* *'t_cs'* | |
| 327 t_CV define vertical scrolling region *t_CV* *'t_CV'* | |
| 328 t_da if non-empty, lines from above scroll down *t_da* *'t_da'* | |
| 329 t_db if non-empty, lines from below scroll up *t_db* *'t_db'* | |
| 330 t_DL delete number of lines *t_DL* *'t_DL'* | |
| 331 t_dl delete line *t_dl* *'t_dl'* | |
| 332 t_fs set window title end (from status line) *t_fs* *'t_fs'* | |
| 333 t_ke exit "keypad transmit" mode *t_ke* *'t_ke'* | |
| 334 t_ks start "keypad transmit" mode *t_ks* *'t_ks'* | |
| 335 t_le move cursor one char left *t_le* *'t_le'* | |
| 336 t_mb blinking mode *t_mb* *'t_mb'* | |
| 337 t_md bold mode *t_md* *'t_md'* | |
| 338 t_me Normal mode (undoes t_mr, t_mb, t_md and color) *t_me* *'t_me'* | |
| 339 t_mr reverse (invert) mode *t_mr* *'t_mr'* | |
| 340 *t_ms* *'t_ms'* | |
| 341 t_ms if non-empty, cursor can be moved in standout/inverse mode | |
| 342 t_nd non destructive space character *t_nd* *'t_nd'* | |
| 343 t_op reset to original color pair *t_op* *'t_op'* | |
| 344 t_RI cursor number of chars right *t_RI* *'t_RI'* | |
| 345 t_Sb set background color *t_Sb* *'t_Sb'* | |
| 346 t_Sf set foreground color *t_Sf* *'t_Sf'* | |
| 347 t_se standout end *t_se* *'t_se'* | |
| 348 t_so standout mode *t_so* *'t_so'* | |
| 349 t_sr scroll reverse (backward) *t_sr* *'t_sr'* | |
|
18299
a9cf41bcb5d6
patch 8.1.2144: side effects when using t_ti to enable modifyOtherKeys
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
350 t_te end of "termcap" mode *t_te* *'t_te'* |
|
a9cf41bcb5d6
patch 8.1.2144: side effects when using t_ti to enable modifyOtherKeys
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
351 t_ti put terminal into "termcap" mode *t_ti* *'t_ti'* |
| 7 | 352 t_ts set window title start (to status line) *t_ts* *'t_ts'* |
| 353 t_ue underline end *t_ue* *'t_ue'* | |
| 354 t_us underline mode *t_us* *'t_us'* | |
| 355 t_ut clearing uses the current background color *t_ut* *'t_ut'* | |
| 356 t_vb visual bell *t_vb* *'t_vb'* | |
| 357 t_ve cursor visible *t_ve* *'t_ve'* | |
| 358 t_vi cursor invisible *t_vi* *'t_vi'* | |
| 12254 | 359 t_vs cursor very visible (blink) *t_vs* *'t_vs'* |
| 7 | 360 *t_xs* *'t_xs'* |
| 361 t_xs if non-empty, standout not erased by overwriting (hpterm) | |
| 6602 | 362 *t_xn* *'t_xn'* |
| 6647 | 363 t_xn if non-empty, writing a character at the last screen cell |
| 364 does not cause scrolling | |
| 7 | 365 t_ZH italics mode *t_ZH* *'t_ZH'* |
| 366 t_ZR italics end *t_ZR* *'t_ZR'* | |
| 367 | |
| 368 Added by Vim (there are no standard codes for these): | |
|
20619
68c206d3a251
patch 8.2.0863: cannot set a separate color for underline/undercurl
Bram Moolenaar <Bram@vim.org>
parents:
20115
diff
changeset
|
369 t_AU set underline color (ANSI) *t_AU* *'t_AU'* |
|
29328
60977de70684
patch 9.0.0007: no support for double, dotted and dashed underlines
Bram Moolenaar <Bram@vim.org>
parents:
29314
diff
changeset
|
370 t_Ce undercurl and underline end *t_Ce* *'t_Ce'* |
|
60977de70684
patch 9.0.0007: no support for double, dotted and dashed underlines
Bram Moolenaar <Bram@vim.org>
parents:
29314
diff
changeset
|
371 t_Cs undercurl (curly underline) mode *t_Cs* *'t_Cs'* |
|
60977de70684
patch 9.0.0007: no support for double, dotted and dashed underlines
Bram Moolenaar <Bram@vim.org>
parents:
29314
diff
changeset
|
372 t_Us double underline mode *t_Us* *'t_Us'* |
|
60977de70684
patch 9.0.0007: no support for double, dotted and dashed underlines
Bram Moolenaar <Bram@vim.org>
parents:
29314
diff
changeset
|
373 t_ds dotted underline mode *t_ds* *'t_ds'* |
|
60977de70684
patch 9.0.0007: no support for double, dotted and dashed underlines
Bram Moolenaar <Bram@vim.org>
parents:
29314
diff
changeset
|
374 t_Ds dashed underline mode *t_Ds* *'t_Ds'* |
| 12499 | 375 t_Te strikethrough end *t_Te* *'t_Te'* |
| 376 t_Ts strikethrough mode *t_Ts* *'t_Ts'* | |
| 7 | 377 t_IS set icon text start *t_IS* *'t_IS'* |
| 378 t_IE set icon text end *t_IE* *'t_IE'* | |
| 379 t_WP set window position (Y, X) in pixels *t_WP* *'t_WP'* | |
|
11400
0f8713fe20dc
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
11062
diff
changeset
|
380 t_GP get window position (Y, X) in pixels *t_GP* *'t_GP'* |
|
11763
21f3930dfe6e
Documentation updates.
Christian Brabandt <cb@256bit.org>
parents:
11400
diff
changeset
|
381 t_WS set window size (height, width in cells) *t_WS* *'t_WS'* |
| 12254 | 382 t_VS cursor normally visible (no blink) *t_VS* *'t_VS'* |
| 856 | 383 t_SI start insert mode (bar cursor shape) *t_SI* *'t_SI'* |
| 6727 | 384 t_SR start replace mode (underline cursor shape) *t_SR* *'t_SR'* |
| 385 t_EI end insert or replace mode (block cursor shape) *t_EI* *'t_EI'* | |
| 500 | 386 |termcap-cursor-shape| |
| 28620 | 387 t_RV request terminal version string (works for *t_RV* *'t_RV'* |
| 388 xterm and other terminal emulators) The | |
| 389 response is stored in |v:termresponse| |xterm-8bit| | |
| 390 |'ttymouse'| |xterm-codes| | |
| 4229 | 391 t_u7 request cursor position (for xterm) *t_u7* *'t_u7'* |
| 392 see |'ambiwidth'| | |
| 15640 | 393 The response is stored in |v:termu7resp| |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12499
diff
changeset
|
394 t_RF request terminal foreground color *t_RF* *'t_RF'* |
| 15640 | 395 The response is stored in |v:termrfgresp| |
| 6884 | 396 t_RB request terminal background color *t_RB* *'t_RB'* |
| 15640 | 397 The response is stored in |v:termrbgresp| |
|
8969
c83e2c1e7f2b
commit https://github.com/vim/vim/commit/8a633e3427b47286869aa4b96f2bfc1fe65b25cd
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
398 t_8f set foreground color (R, G, B) *t_8f* *'t_8f'* |
|
c83e2c1e7f2b
commit https://github.com/vim/vim/commit/8a633e3427b47286869aa4b96f2bfc1fe65b25cd
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
399 |xterm-true-color| |
|
c83e2c1e7f2b
commit https://github.com/vim/vim/commit/8a633e3427b47286869aa4b96f2bfc1fe65b25cd
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
400 t_8b set background color (R, G, B) *t_8b* *'t_8b'* |
|
c83e2c1e7f2b
commit https://github.com/vim/vim/commit/8a633e3427b47286869aa4b96f2bfc1fe65b25cd
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
401 |xterm-true-color| |
|
20619
68c206d3a251
patch 8.2.0863: cannot set a separate color for underline/undercurl
Bram Moolenaar <Bram@vim.org>
parents:
20115
diff
changeset
|
402 t_8u set underline color (R, G, B) *t_8u* *'t_8u'* |
|
10640
27be410d6d29
patch 8.0.0210: no support for bracketed paste
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
403 t_BE enable bracketed paste mode *t_BE* *'t_BE'* |
|
27be410d6d29
patch 8.0.0210: no support for bracketed paste
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
404 |xterm-bracketed-paste| |
|
27be410d6d29
patch 8.0.0210: no support for bracketed paste
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
405 t_BD disable bracketed paste mode *t_BD* *'t_BD'* |
|
27be410d6d29
patch 8.0.0210: no support for bracketed paste
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
406 |xterm-bracketed-paste| |
| 12254 | 407 t_SC set cursor color start *t_SC* *'t_SC'* |
| 408 t_EC set cursor color end *t_EC* *'t_EC'* | |
| 409 t_SH set cursor shape *t_SH* *'t_SH'* | |
| 12499 | 410 t_RC request terminal cursor blinking *t_RC* *'t_RC'* |
| 15640 | 411 The response is stored in |v:termblinkresp| |
| 12254 | 412 t_RS request terminal cursor style *t_RS* *'t_RS'* |
| 15640 | 413 The response is stored in |v:termstyleresp| |
|
14479
3375a8cbb442
patch 8.1.0253: saving and restoring window title does not always work
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
414 t_ST save window title to stack *t_ST* *'t_ST'* |
|
3375a8cbb442
patch 8.1.0253: saving and restoring window title does not always work
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
415 t_RT restore window title from stack *t_RT* *'t_RT'* |
|
3375a8cbb442
patch 8.1.0253: saving and restoring window title does not always work
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
416 t_Si save icon text to stack *t_Si* *'t_Si'* |
|
3375a8cbb442
patch 8.1.0253: saving and restoring window title does not always work
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
417 t_Ri restore icon text from stack *t_Ri* *'t_Ri'* |
|
18299
a9cf41bcb5d6
patch 8.1.2144: side effects when using t_ti to enable modifyOtherKeys
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
418 t_TE end of "raw" mode *t_TE* *'t_TE'* |
|
a9cf41bcb5d6
patch 8.1.2144: side effects when using t_ti to enable modifyOtherKeys
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
419 t_TI put terminal into "raw" mode *t_TI* *'t_TI'* |
| 24911 | 420 t_fe enable focus-event tracking *t_fe* *'t_fe'* |
|
23606
f98939164e91
patch 8.2.2345: no focus events in a terminal
Bram Moolenaar <Bram@vim.org>
parents:
23466
diff
changeset
|
421 |xterm-focus-event| |
| 24911 | 422 t_fd disable focus-event tracking *t_fd* *'t_fd'* |
|
23606
f98939164e91
patch 8.2.2345: no focus events in a terminal
Bram Moolenaar <Bram@vim.org>
parents:
23466
diff
changeset
|
423 |xterm-focus-event| |
| 12254 | 424 |
| 425 Some codes have a start, middle and end part. The start and end are defined | |
| 426 by the termcap option, the middle part is text. | |
| 427 set title text: t_ts {title text} t_fs | |
| 428 set icon text: t_IS {icon text} t_IE | |
| 429 set cursor color: t_SC {color name} t_EC | |
| 430 | |
| 431 t_SH must take one argument: | |
| 432 0, 1 or none blinking block cursor | |
| 433 2 block cursor | |
| 434 3 blinking underline cursor | |
| 435 4 underline cursor | |
| 436 5 blinking vertical bar cursor | |
| 437 6 vertical bar cursor | |
| 438 | |
| 439 t_RS is sent only if the response to t_RV has been received. It is not used | |
| 440 on Mac OS when Terminal.app could be recognized from the termresponse. | |
| 441 | |
| 7 | 442 |
| 11062 | 443 KEY CODES *terminal-key-codes* |
| 7 | 444 Note: Use the <> form if possible |
| 445 | |
| 446 option name meaning ~ | |
| 447 | |
| 448 t_ku <Up> arrow up *t_ku* *'t_ku'* | |
| 449 t_kd <Down> arrow down *t_kd* *'t_kd'* | |
| 450 t_kr <Right> arrow right *t_kr* *'t_kr'* | |
| 451 t_kl <Left> arrow left *t_kl* *'t_kl'* | |
| 180 | 452 <xUp> alternate arrow up *<xUp>* |
| 453 <xDown> alternate arrow down *<xDown>* | |
| 454 <xRight> alternate arrow right *<xRight>* | |
| 455 <xLeft> alternate arrow left *<xLeft>* | |
| 7 | 456 <S-Up> shift arrow up |
| 457 <S-Down> shift arrow down | |
| 458 t_%i <S-Right> shift arrow right *t_%i* *'t_%i'* | |
| 459 t_#4 <S-Left> shift arrow left *t_#4* *'t_#4'* | |
| 460 t_k1 <F1> function key 1 *t_k1* *'t_k1'* | |
| 461 <xF1> alternate F1 *<xF1>* | |
| 462 t_k2 <F2> function key 2 *<F2>* *t_k2* *'t_k2'* | |
| 463 <xF2> alternate F2 *<xF2>* | |
| 464 t_k3 <F3> function key 3 *<F3>* *t_k3* *'t_k3'* | |
| 465 <xF3> alternate F3 *<xF3>* | |
| 466 t_k4 <F4> function key 4 *<F4>* *t_k4* *'t_k4'* | |
| 467 <xF4> alternate F4 *<xF4>* | |
| 468 t_k5 <F5> function key 5 *<F5>* *t_k5* *'t_k5'* | |
| 469 t_k6 <F6> function key 6 *<F6>* *t_k6* *'t_k6'* | |
| 470 t_k7 <F7> function key 7 *<F7>* *t_k7* *'t_k7'* | |
| 471 t_k8 <F8> function key 8 *<F8>* *t_k8* *'t_k8'* | |
| 472 t_k9 <F9> function key 9 *<F9>* *t_k9* *'t_k9'* | |
| 473 t_k; <F10> function key 10 *<F10>* *t_k;* *'t_k;'* | |
| 4437 | 474 t_F1 <F11> function key 11 *<F11>* *t_F1* *'t_F1'* |
| 7 | 475 t_F2 <F12> function key 12 *<F12>* *t_F2* *'t_F2'* |
| 476 t_F3 <F13> function key 13 *<F13>* *t_F3* *'t_F3'* | |
| 477 t_F4 <F14> function key 14 *<F14>* *t_F4* *'t_F4'* | |
| 478 t_F5 <F15> function key 15 *<F15>* *t_F5* *'t_F5'* | |
| 479 t_F6 <F16> function key 16 *<F16>* *t_F6* *'t_F6'* | |
| 480 t_F7 <F17> function key 17 *<F17>* *t_F7* *'t_F7'* | |
| 481 t_F8 <F18> function key 18 *<F18>* *t_F8* *'t_F8'* | |
| 482 t_F9 <F19> function key 19 *<F19>* *t_F9* *'t_F9'* | |
| 483 <S-F1> shifted function key 1 | |
| 484 <S-xF1> alternate <S-F1> *<S-xF1>* | |
| 485 <S-F2> shifted function key 2 *<S-F2>* | |
| 486 <S-xF2> alternate <S-F2> *<S-xF2>* | |
| 487 <S-F3> shifted function key 3 *<S-F3>* | |
| 488 <S-xF3> alternate <S-F3> *<S-xF3>* | |
| 489 <S-F4> shifted function key 4 *<S-F4>* | |
| 490 <S-xF4> alternate <S-F4> *<S-xF4>* | |
| 491 <S-F5> shifted function key 5 *<S-F5>* | |
| 492 <S-F6> shifted function key 6 *<S-F6>* | |
| 493 <S-F7> shifted function key 7 *<S-F7>* | |
| 494 <S-F8> shifted function key 8 *<S-F8>* | |
| 495 <S-F9> shifted function key 9 *<S-F9>* | |
| 496 <S-F10> shifted function key 10 *<S-F10>* | |
| 497 <S-F11> shifted function key 11 *<S-F11>* | |
| 498 <S-F12> shifted function key 12 *<S-F12>* | |
| 499 t_%1 <Help> help key *t_%1* *'t_%1'* | |
| 500 t_&8 <Undo> undo key *t_&8* *'t_&8'* | |
| 501 t_kI <Insert> insert key *t_kI* *'t_kI'* | |
| 502 t_kD <Del> delete key *t_kD* *'t_kD'* | |
| 503 t_kb <BS> backspace key *t_kb* *'t_kb'* | |
| 4437 | 504 t_kB <S-Tab> back-tab (shift-tab) *<S-Tab>* *t_kB* *'t_kB'* |
| 7 | 505 t_kh <Home> home key *t_kh* *'t_kh'* |
| 4437 | 506 t_#2 <S-Home> shifted home key *<S-Home>* *t_#2* *'t_#2'* |
| 7 | 507 <xHome> alternate home key *<xHome>* |
| 508 t_@7 <End> end key *t_@7* *'t_@7'* | |
| 509 t_*7 <S-End> shifted end key *<S-End>* *t_star7* *'t_star7'* | |
| 510 <xEnd> alternate end key *<xEnd>* | |
| 511 t_kP <PageUp> page-up key *t_kP* *'t_kP'* | |
| 512 t_kN <PageDown> page-down key *t_kN* *'t_kN'* | |
| 513 t_K1 <kHome> keypad home key *t_K1* *'t_K1'* | |
| 514 t_K4 <kEnd> keypad end key *t_K4* *'t_K4'* | |
| 515 t_K3 <kPageUp> keypad page-up key *t_K3* *'t_K3'* | |
| 516 t_K5 <kPageDown> keypad page-down key *t_K5* *'t_K5'* | |
| 517 t_K6 <kPlus> keypad plus key *<kPlus>* *t_K6* *'t_K6'* | |
| 518 t_K7 <kMinus> keypad minus key *<kMinus>* *t_K7* *'t_K7'* | |
| 4437 | 519 t_K8 <kDivide> keypad divide *<kDivide>* *t_K8* *'t_K8'* |
| 520 t_K9 <kMultiply> keypad multiply *<kMultiply>* *t_K9* *'t_K9'* | |
| 7 | 521 t_KA <kEnter> keypad enter key *<kEnter>* *t_KA* *'t_KA'* |
| 522 t_KB <kPoint> keypad decimal point *<kPoint>* *t_KB* *'t_KB'* | |
| 523 t_KC <k0> keypad 0 *<k0>* *t_KC* *'t_KC'* | |
| 524 t_KD <k1> keypad 1 *<k1>* *t_KD* *'t_KD'* | |
| 525 t_KE <k2> keypad 2 *<k2>* *t_KE* *'t_KE'* | |
| 526 t_KF <k3> keypad 3 *<k3>* *t_KF* *'t_KF'* | |
| 527 t_KG <k4> keypad 4 *<k4>* *t_KG* *'t_KG'* | |
| 528 t_KH <k5> keypad 5 *<k5>* *t_KH* *'t_KH'* | |
| 529 t_KI <k6> keypad 6 *<k6>* *t_KI* *'t_KI'* | |
| 530 t_KJ <k7> keypad 7 *<k7>* *t_KJ* *'t_KJ'* | |
| 531 t_KK <k8> keypad 8 *<k8>* *t_KK* *'t_KK'* | |
| 532 t_KL <k9> keypad 9 *<k9>* *t_KL* *'t_KL'* | |
| 533 <Mouse> leader of mouse code *<Mouse>* | |
| 11062 | 534 *t_PS* *'t_PS'* |
| 535 t_PS start of bracketed paste |xterm-bracketed-paste| | |
| 536 t_PE end of bracketed paste |xterm-bracketed-paste| *t_PE* *'t_PE'* | |
| 7 | 537 |
| 538 Note about t_so and t_mr: When the termcap entry "so" is not present the | |
| 539 entry for "mr" is used. And vice versa. The same is done for "se" and "me". | |
| 540 If your terminal supports both inversion and standout mode, you can see two | |
| 541 different modes. If your terminal supports only one of the modes, both will | |
| 542 look the same. | |
| 543 | |
| 33 | 544 *keypad-comma* |
| 7 | 545 The keypad keys, when they are not mapped, behave like the equivalent normal |
| 33 | 546 key. There is one exception: if you have a comma on the keypad instead of a |
| 547 decimal point, Vim will use a dot anyway. Use these mappings to fix that: > | |
| 548 :noremap <kPoint> , | |
| 549 :noremap! <kPoint> , | |
| 550 < *xterm-codes* | |
| 7 | 551 There is a special trick to obtain the key codes which currently only works |
| 552 for xterm. When |t_RV| is defined and a response is received which indicates | |
| 553 an xterm with patchlevel 141 or higher, Vim uses special escape sequences to | |
| 554 request the key codes directly from the xterm. The responses are used to | |
| 555 adjust the various t_ codes. This avoids the problem that the xterm can | |
| 556 produce different codes, depending on the mode it is in (8-bit, VT102, | |
| 557 VT220, etc.). The result is that codes like <xF1> are no longer needed. | |
|
26670
a77b661439f9
patch 8.2.3864: cannot disable requesting key codes from xterm
Bram Moolenaar <Bram@vim.org>
parents:
26591
diff
changeset
|
558 |
|
a77b661439f9
patch 8.2.3864: cannot disable requesting key codes from xterm
Bram Moolenaar <Bram@vim.org>
parents:
26591
diff
changeset
|
559 One of the codes that can change is 't_Co', the number of colors. This will |
|
a77b661439f9
patch 8.2.3864: cannot disable requesting key codes from xterm
Bram Moolenaar <Bram@vim.org>
parents:
26591
diff
changeset
|
560 trigger a redraw. If this is a problem, reset the 'xtermcodes' option as |
|
a77b661439f9
patch 8.2.3864: cannot disable requesting key codes from xterm
Bram Moolenaar <Bram@vim.org>
parents:
26591
diff
changeset
|
561 early as possible: > |
|
a77b661439f9
patch 8.2.3864: cannot disable requesting key codes from xterm
Bram Moolenaar <Bram@vim.org>
parents:
26591
diff
changeset
|
562 set noxtermcodes |
|
a77b661439f9
patch 8.2.3864: cannot disable requesting key codes from xterm
Bram Moolenaar <Bram@vim.org>
parents:
26591
diff
changeset
|
563 |
|
a77b661439f9
patch 8.2.3864: cannot disable requesting key codes from xterm
Bram Moolenaar <Bram@vim.org>
parents:
26591
diff
changeset
|
564 Note: Requesting the key codes is only done on startup. If the xterm options |
|
a77b661439f9
patch 8.2.3864: cannot disable requesting key codes from xterm
Bram Moolenaar <Bram@vim.org>
parents:
26591
diff
changeset
|
565 are changed after Vim has started, the escape sequences may not be recognized |
|
a77b661439f9
patch 8.2.3864: cannot disable requesting key codes from xterm
Bram Moolenaar <Bram@vim.org>
parents:
26591
diff
changeset
|
566 anymore. |
| 7 | 567 |
|
8969
c83e2c1e7f2b
commit https://github.com/vim/vim/commit/8a633e3427b47286869aa4b96f2bfc1fe65b25cd
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
568 *xterm-true-color* |
|
c83e2c1e7f2b
commit https://github.com/vim/vim/commit/8a633e3427b47286869aa4b96f2bfc1fe65b25cd
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
569 Vim supports using true colors in the terminal (taken from |highlight-guifg| |
| 18831 | 570 and |highlight-guibg|), given that the terminal supports this. To make this |
|
9027
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
571 work the 'termguicolors' option needs to be set. |
|
10140
b11ceef7116e
commit https://github.com/vim/vim/commit/64d8e25bf6efe5f18b032563521c3ce278c316ab
Christian Brabandt <cb@256bit.org>
parents:
9027
diff
changeset
|
572 See https://gist.github.com/XVilka/8346728 for a list of terminals that |
|
b11ceef7116e
commit https://github.com/vim/vim/commit/64d8e25bf6efe5f18b032563521c3ce278c316ab
Christian Brabandt <cb@256bit.org>
parents:
9027
diff
changeset
|
573 support true colors. |
|
8969
c83e2c1e7f2b
commit https://github.com/vim/vim/commit/8a633e3427b47286869aa4b96f2bfc1fe65b25cd
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
574 |
|
9027
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
575 Sometimes setting 'termguicolors' is not enough and one has to set the |t_8f| |
|
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
576 and |t_8b| options explicitly. Default values of these options are |
|
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
577 "^[[38;2;%lu;%lu;%lum" and "^[[48;2;%lu;%lu;%lum" respectively, but it is only |
|
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
578 set when `$TERM` is `xterm`. Some terminals accept the same sequences, but |
|
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
579 with all semicolons replaced by colons (this is actually more compatible, but |
|
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
580 less widely supported): > |
|
10140
b11ceef7116e
commit https://github.com/vim/vim/commit/64d8e25bf6efe5f18b032563521c3ce278c316ab
Christian Brabandt <cb@256bit.org>
parents:
9027
diff
changeset
|
581 let &t_8f = "\<Esc>[38:2:%lu:%lu:%lum" |
|
b11ceef7116e
commit https://github.com/vim/vim/commit/64d8e25bf6efe5f18b032563521c3ce278c316ab
Christian Brabandt <cb@256bit.org>
parents:
9027
diff
changeset
|
582 let &t_8b = "\<Esc>[48:2:%lu:%lu:%lum" |
|
9027
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
583 |
|
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
584 These options contain printf strings, with |printf()| (actually, its C |
|
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
585 equivalent hence `l` modifier) invoked with the t_ option value and three |
|
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
586 unsigned long integers that may have any value between 0 and 255 (inclusive) |
|
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
587 representing red, green and blue colors respectively. |
|
8969
c83e2c1e7f2b
commit https://github.com/vim/vim/commit/8a633e3427b47286869aa4b96f2bfc1fe65b25cd
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
588 |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
589 *xterm-resize* |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
590 Window resizing with xterm only works if the allowWindowOps resource is |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
591 enabled. On some systems and versions of xterm it's disabled by default |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
592 because someone thought it would be a security issue. It's not clear if this |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
593 is actually the case. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
594 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
595 To overrule the default, put this line in your ~/.Xdefaults or |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
596 ~/.Xresources: |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
597 > |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
598 XTerm*allowWindowOps: true |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
599 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
600 And run "xrdb -merge .Xresources" to make it effective. You can check the |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
601 value with the context menu (right mouse button while CTRL key is pressed), |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
602 there should be a tick at allow-window-ops. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
603 |
|
23606
f98939164e91
patch 8.2.2345: no focus events in a terminal
Bram Moolenaar <Bram@vim.org>
parents:
23466
diff
changeset
|
604 *xterm-focus-event* |
|
f98939164e91
patch 8.2.2345: no focus events in a terminal
Bram Moolenaar <Bram@vim.org>
parents:
23466
diff
changeset
|
605 Some terminals including xterm support the focus event tracking feature. |
|
f98939164e91
patch 8.2.2345: no focus events in a terminal
Bram Moolenaar <Bram@vim.org>
parents:
23466
diff
changeset
|
606 If this feature is enabled by the 't_fe' sequence, special key sequences are |
|
f98939164e91
patch 8.2.2345: no focus events in a terminal
Bram Moolenaar <Bram@vim.org>
parents:
23466
diff
changeset
|
607 sent from the terminal to Vim every time the terminal gains or loses focus. |
|
f98939164e91
patch 8.2.2345: no focus events in a terminal
Bram Moolenaar <Bram@vim.org>
parents:
23466
diff
changeset
|
608 Vim fires focus events (|FocusGained|/|FocusLost|) by handling them accordingly. |
|
f98939164e91
patch 8.2.2345: no focus events in a terminal
Bram Moolenaar <Bram@vim.org>
parents:
23466
diff
changeset
|
609 Focus event tracking is disabled by a 't_fd' sequence when exiting "raw" mode. |
|
f98939164e91
patch 8.2.2345: no focus events in a terminal
Bram Moolenaar <Bram@vim.org>
parents:
23466
diff
changeset
|
610 If you would like to disable this feature, add the following to your .vimrc: |
|
f98939164e91
patch 8.2.2345: no focus events in a terminal
Bram Moolenaar <Bram@vim.org>
parents:
23466
diff
changeset
|
611 `set t_fd=` |
|
f98939164e91
patch 8.2.2345: no focus events in a terminal
Bram Moolenaar <Bram@vim.org>
parents:
23466
diff
changeset
|
612 `set t_fe=` |
| 25700 | 613 If your terminal does support this but Vim does not recognize the terminal, |
| 614 you may have to set the options yourself: > | |
| 615 let &t_fe = "\<Esc>[?1004h" | |
| 616 let &t_fd = "\<Esc>[?1004l" | |
| 26591 | 617 execute "set <FocusGained>=\<Esc>[I" |
| 618 execute "set <FocusLost>=\<Esc>[O" | |
| 25700 | 619 If this causes garbage to show when Vim starts up then it doesn't work. |
|
23606
f98939164e91
patch 8.2.2345: no focus events in a terminal
Bram Moolenaar <Bram@vim.org>
parents:
23466
diff
changeset
|
620 |
| 7 | 621 *termcap-colors* |
| 622 Note about colors: The 't_Co' option tells Vim the number of colors available. | |
| 623 When it is non-zero, the 't_AB' and 't_AF' options are used to set the color. | |
| 624 If one of these is not available, 't_Sb' and 't_Sf' are used. 't_me' is used | |
| 16380 | 625 to reset to the default colors. Also see 'termguicolors'. |
| 20115 | 626 When the GUI is running 't_Co' is set to 16777216. |
| 7 | 627 |
| 36 | 628 *termcap-cursor-shape* *termcap-cursor-color* |
| 6727 | 629 When Vim enters Insert mode the 't_SI' escape sequence is sent. When Vim |
| 630 enters Replace mode the 't_SR' escape sequence is sent if it is set, otherwise | |
| 29403 | 631 't_SI' is sent. When leaving Insert mode or Replace mode 't_EI' is used. |
| 632 Note: When 't_EI' is not set then 't_SI' and 't_SR' will not be sent. And | |
| 633 when 't_SI' or 't_SR' is not set then 't_EI' is sent only once. | |
| 634 | |
| 635 This can be used to change the shape or color of the cursor in Insert or | |
| 636 Replace mode. These are not standard termcap/terminfo entries, you need to set | |
| 637 them yourself. | |
| 36 | 638 Example for an xterm, this changes the color of the cursor: > |
| 639 if &term =~ "xterm" | |
| 640 let &t_SI = "\<Esc>]12;purple\x7" | |
| 6727 | 641 let &t_SR = "\<Esc>]12;red\x7" |
| 36 | 642 let &t_EI = "\<Esc>]12;blue\x7" |
| 643 endif | |
| 644 NOTE: When Vim exits the shape for Normal mode will remain. The shape from | |
| 645 before Vim started will not be restored. | |
|
30019
347cf03fee2b
patch 9.0.0347: MS-Windows: cannot set cursor shape in Windows Terminal
Bram Moolenaar <Bram@vim.org>
parents:
29885
diff
changeset
|
646 |
|
347cf03fee2b
patch 9.0.0347: MS-Windows: cannot set cursor shape in Windows Terminal
Bram Moolenaar <Bram@vim.org>
parents:
29885
diff
changeset
|
647 For Windows Terminal you can use something like this: > |
|
347cf03fee2b
patch 9.0.0347: MS-Windows: cannot set cursor shape in Windows Terminal
Bram Moolenaar <Bram@vim.org>
parents:
29885
diff
changeset
|
648 " Note: This should be set after `set termguicolors` or `set t_Co=256`. |
|
347cf03fee2b
patch 9.0.0347: MS-Windows: cannot set cursor shape in Windows Terminal
Bram Moolenaar <Bram@vim.org>
parents:
29885
diff
changeset
|
649 if &term =~ 'xterm' || &term == 'win32' |
|
347cf03fee2b
patch 9.0.0347: MS-Windows: cannot set cursor shape in Windows Terminal
Bram Moolenaar <Bram@vim.org>
parents:
29885
diff
changeset
|
650 " Use DECSCUSR escape sequences |
|
347cf03fee2b
patch 9.0.0347: MS-Windows: cannot set cursor shape in Windows Terminal
Bram Moolenaar <Bram@vim.org>
parents:
29885
diff
changeset
|
651 let &t_SI = "\e[5 q" " blink bar |
|
347cf03fee2b
patch 9.0.0347: MS-Windows: cannot set cursor shape in Windows Terminal
Bram Moolenaar <Bram@vim.org>
parents:
29885
diff
changeset
|
652 let &t_SR = "\e[3 q" " blink underline |
|
347cf03fee2b
patch 9.0.0347: MS-Windows: cannot set cursor shape in Windows Terminal
Bram Moolenaar <Bram@vim.org>
parents:
29885
diff
changeset
|
653 let &t_EI = "\e[1 q" " blink block |
|
347cf03fee2b
patch 9.0.0347: MS-Windows: cannot set cursor shape in Windows Terminal
Bram Moolenaar <Bram@vim.org>
parents:
29885
diff
changeset
|
654 let &t_ti ..= "\e[1 q" " blink block |
|
347cf03fee2b
patch 9.0.0347: MS-Windows: cannot set cursor shape in Windows Terminal
Bram Moolenaar <Bram@vim.org>
parents:
29885
diff
changeset
|
655 let &t_te ..= "\e[0 q" " default (depends on terminal, normally blink block) |
|
347cf03fee2b
patch 9.0.0347: MS-Windows: cannot set cursor shape in Windows Terminal
Bram Moolenaar <Bram@vim.org>
parents:
29885
diff
changeset
|
656 endif |
|
347cf03fee2b
patch 9.0.0347: MS-Windows: cannot set cursor shape in Windows Terminal
Bram Moolenaar <Bram@vim.org>
parents:
29885
diff
changeset
|
657 |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
658 {not available when compiled without the |+cursorshape| feature} |
| 36 | 659 |
| 7 | 660 *termcap-title* |
| 661 The 't_ts' and 't_fs' options are used to set the window title if the terminal | |
| 662 allows title setting via sending strings. They are sent before and after the | |
| 663 title string, respectively. Similar 't_IS' and 't_IE' are used to set the | |
| 664 icon text. These are Vim-internal extensions of the Unix termcap, so they | |
| 665 cannot be obtained from an external termcap. However, the builtin termcap | |
| 666 contains suitable entries for xterm and iris-ansi, so you don't need to set | |
| 667 them here. | |
| 668 *hpterm* | |
| 669 If inversion or other highlighting does not work correctly, try setting the | |
| 670 't_xs' option to a non-empty string. This makes the 't_ce' code be used to | |
| 671 remove highlighting from a line. This is required for "hpterm". Setting the | |
| 672 'weirdinvert' option has the same effect as making 't_xs' non-empty, and vice | |
| 673 versa. | |
| 674 | |
| 675 *scroll-region* | |
| 19116 | 676 Some termcaps do not include an entry for "cs" (scroll region), although the |
| 7 | 677 terminal does support it. For example: xterm on a Sun. You can use the |
| 678 builtin_xterm or define t_cs yourself. For example: > | |
| 679 :set t_cs=^V^[[%i%d;%dr | |
| 680 Where ^V is CTRL-V and ^[ is <Esc>. | |
| 681 | |
| 682 The vertical scroll region t_CV is not a standard termcap code. Vim uses it | |
| 683 internally in the GUI. But it can also be defined for a terminal, if you can | |
| 684 find one that supports it. The two arguments are the left and right column of | |
| 685 the region which to restrict the scrolling to. Just like t_cs defines the top | |
| 686 and bottom lines. Defining t_CV will make scrolling in vertically split | |
| 687 windows a lot faster. Don't set t_CV when t_da or t_db is set (text isn't | |
| 688 cleared when scrolling). | |
| 689 | |
| 690 Unfortunately it is not possible to deduce from the termcap how cursor | |
| 691 positioning should be done when using a scrolling region: Relative to the | |
| 692 beginning of the screen or relative to the beginning of the scrolling region. | |
| 19116 | 693 Most terminals use the first method. The 't_CS' option should be set to any |
| 694 string when cursor positioning is relative to the start of the scrolling | |
| 695 region. It should be set to an empty string otherwise. | |
| 7 | 696 |
| 697 Note for xterm users: The shifted cursor keys normally don't work. You can | |
| 698 make them work with the xmodmap command and some mappings in Vim. | |
| 699 | |
| 700 Give these commands in the xterm: | |
| 701 xmodmap -e "keysym Up = Up F13" | |
| 702 xmodmap -e "keysym Down = Down F16" | |
| 703 xmodmap -e "keysym Left = Left F18" | |
| 704 xmodmap -e "keysym Right = Right F19" | |
| 705 | |
| 706 And use these mappings in Vim: | |
| 707 :map <t_F3> <S-Up> | |
| 708 :map! <t_F3> <S-Up> | |
| 709 :map <t_F6> <S-Down> | |
| 710 :map! <t_F6> <S-Down> | |
| 711 :map <t_F8> <S-Left> | |
| 712 :map! <t_F8> <S-Left> | |
| 713 :map <t_F9> <S-Right> | |
| 714 :map! <t_F9> <S-Right> | |
| 715 | |
| 716 Instead of, say, <S-Up> you can use any other command that you want to use the | |
| 717 shift-cursor-up key for. (Note: To help people that have a Sun keyboard with | |
| 718 left side keys F14 is not used because it is confused with the undo key; F15 | |
| 719 is not used, because it does a window-to-front; F17 is not used, because it | |
| 720 closes the window. On other systems you can probably use them.) | |
| 721 | |
| 722 ============================================================================== | |
| 723 3. Window size *window-size* | |
| 724 | |
| 725 [This is about the size of the whole window Vim is using, not a window that is | |
| 726 created with the ":split" command.] | |
| 727 | |
| 728 If you are running Vim on an Amiga and the terminal name is "amiga" or | |
| 729 "builtin_amiga", the amiga-specific window resizing will be enabled. On Unix | |
| 730 systems three methods are tried to get the window size: | |
| 731 | |
| 732 - an ioctl call (TIOCGSIZE or TIOCGWINSZ, depends on your system) | |
| 733 - the environment variables "LINES" and "COLUMNS" | |
| 734 - from the termcap entries "li" and "co" | |
| 735 | |
| 736 If everything fails a default size of 24 lines and 80 columns is assumed. If | |
| 737 a window-resize signal is received the size will be set again. If the window | |
| 738 size is wrong you can use the 'lines' and 'columns' options to set the | |
| 739 correct values. | |
| 740 | |
| 741 One command can be used to set the screen size: | |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
7272
diff
changeset
|
742 *:mod* *:mode* *E359* |
| 7 | 743 :mod[e] [mode] |
| 744 | |
| 745 Without argument this only detects the screen size and redraws the screen. | |
| 28010 | 746 [mode] was used on MS-DOS, but it doesn't work anymore. In |Vim9| this |
| 747 command is not supported. | |
| 7 | 748 |
| 749 ============================================================================== | |
| 750 4. Slow and fast terminals *slow-fast-terminal* | |
| 751 *slow-terminal* | |
| 752 | |
| 753 If you have a fast terminal you may like to set the 'ruler' option. The | |
| 754 cursor position is shown in the status line. If you are using horizontal | |
| 755 scrolling ('wrap' option off) consider setting 'sidescroll' to a small | |
| 756 number. | |
| 757 | |
| 758 If you have a slow terminal you may want to reset the 'showcmd' option. | |
| 759 The command characters will not be shown in the status line. If the terminal | |
| 760 scrolls very slowly, set the 'scrolljump' to 5 or so. If the cursor is moved | |
| 761 off the screen (e.g., with "j") Vim will scroll 5 lines at a time. Another | |
| 762 possibility is to reduce the number of lines that Vim uses with the command | |
| 763 "z{height}<CR>". | |
| 764 | |
| 765 If the characters from the terminal are arriving with more than 1 second | |
| 766 between them you might want to set the 'timeout' and/or 'ttimeout' option. | |
| 767 See the "Options" chapter |options|. | |
| 768 | |
| 769 If your terminal does not support a scrolling region, but it does support | |
| 770 insert/delete line commands, scrolling with multiple windows may make the | |
| 771 lines jump up and down. If you don't want this set the 'ttyfast' option. | |
| 772 This will redraw the window instead of scroll it. | |
| 773 | |
| 774 If your terminal scrolls very slowly, but redrawing is not slow, set the | |
| 775 'ttyscroll' option to a small number, e.g., 3. This will make Vim redraw the | |
| 776 screen instead of scrolling, when there are more than 3 lines to be scrolled. | |
| 777 | |
| 778 If you are using a color terminal that is slow, use this command: > | |
| 779 hi NonText cterm=NONE ctermfg=NONE | |
| 780 This avoids that spaces are sent when they have different attributes. On most | |
| 781 terminals you can't see this anyway. | |
| 782 | |
| 783 If you are using Vim over a slow serial line, you might want to try running | |
| 784 Vim inside the "screen" program. Screen will optimize the terminal I/O quite | |
| 785 a bit. | |
| 786 | |
| 18972 | 787 If you are testing termcap options, but you cannot see what is happening, you |
| 788 might want to set the 'writedelay' option. When non-zero, one character is | |
| 789 sent to the terminal at a time. This makes the screen updating a lot slower, | |
| 790 making it possible to see what is happening. | |
| 7 | 791 |
| 792 ============================================================================== | |
| 793 5. Using the mouse *mouse-using* | |
| 794 | |
| 795 This section is about using the mouse on a terminal or a terminal window. How | |
| 796 to use the mouse in a GUI window is explained in |gui-mouse|. For scrolling | |
| 797 with a mouse wheel see |scroll-mouse-wheel|. | |
| 798 | |
|
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
799 Don't forget to enable the mouse with this command: > |
| 7 | 800 :set mouse=a |
| 801 Otherwise Vim won't recognize the mouse in all modes (See 'mouse'). | |
| 802 | |
| 1621 | 803 Currently the mouse is supported for Unix in an xterm window, in a *BSD |
| 18972 | 804 console with |sysmouse|, in a Linux console (with GPM |gpm-mouse|), and |
| 805 in a Windows console. | |
| 7 | 806 Mouse clicks can be used to position the cursor, select an area and paste. |
| 807 | |
| 808 These characters in the 'mouse' option tell in which situations the mouse will | |
| 809 be used by Vim: | |
| 810 n Normal mode | |
| 811 v Visual mode | |
| 812 i Insert mode | |
| 813 c Command-line mode | |
| 814 h all previous modes when in a help file | |
| 815 a all previous modes | |
| 816 r for |hit-enter| prompt | |
| 817 | |
| 818 The default for 'mouse' is empty, the mouse is not used. Normally you would | |
| 819 do: > | |
| 820 :set mouse=a | |
| 821 to start using the mouse (this is equivalent to setting 'mouse' to "nvich"). | |
| 822 If you only want to use the mouse in a few modes or also want to use it for | |
| 823 the two questions you will have to concatenate the letters for those modes. | |
| 824 For example: > | |
| 825 :set mouse=nv | |
| 826 Will make the mouse work in Normal mode and Visual mode. > | |
| 827 :set mouse=h | |
| 828 Will make the mouse work in help files only (so you can use "g<LeftMouse>" to | |
| 829 jump to tags). | |
| 830 | |
| 831 Whether the selection that is started with the mouse is in Visual mode or | |
| 832 Select mode depends on whether "mouse" is included in the 'selectmode' | |
| 833 option. | |
|
18465
d7619a9874cd
patch 8.1.2226: cannot use system copy/paste in non-xterm terminals
Bram Moolenaar <Bram@vim.org>
parents:
18299
diff
changeset
|
834 *terminal-mouse* |
| 7 | 835 In an xterm, with the currently active mode included in the 'mouse' option, |
| 836 normal mouse clicks are used by Vim, mouse clicks with the shift or ctrl key | |
| 837 pressed go to the xterm. With the currently active mode not included in | |
| 838 'mouse' all mouse clicks go to the xterm. | |
| 839 | |
|
18465
d7619a9874cd
patch 8.1.2226: cannot use system copy/paste in non-xterm terminals
Bram Moolenaar <Bram@vim.org>
parents:
18299
diff
changeset
|
840 For terminals where it is not possible to have the mouse events be used by the |
|
d7619a9874cd
patch 8.1.2226: cannot use system copy/paste in non-xterm terminals
Bram Moolenaar <Bram@vim.org>
parents:
18299
diff
changeset
|
841 terminal itself by using a modifier, a workaround is to not use mouse events |
|
d7619a9874cd
patch 8.1.2226: cannot use system copy/paste in non-xterm terminals
Bram Moolenaar <Bram@vim.org>
parents:
18299
diff
changeset
|
842 for Vim in command-line mode: > |
|
d7619a9874cd
patch 8.1.2226: cannot use system copy/paste in non-xterm terminals
Bram Moolenaar <Bram@vim.org>
parents:
18299
diff
changeset
|
843 :set mouse=nvi |
|
d7619a9874cd
patch 8.1.2226: cannot use system copy/paste in non-xterm terminals
Bram Moolenaar <Bram@vim.org>
parents:
18299
diff
changeset
|
844 Then to select text with the terminal, use ":" to go to command-line mode, |
|
d7619a9874cd
patch 8.1.2226: cannot use system copy/paste in non-xterm terminals
Bram Moolenaar <Bram@vim.org>
parents:
18299
diff
changeset
|
845 select and copy the text to the system, then press Esc. |
|
d7619a9874cd
patch 8.1.2226: cannot use system copy/paste in non-xterm terminals
Bram Moolenaar <Bram@vim.org>
parents:
18299
diff
changeset
|
846 |
|
d7619a9874cd
patch 8.1.2226: cannot use system copy/paste in non-xterm terminals
Bram Moolenaar <Bram@vim.org>
parents:
18299
diff
changeset
|
847 Another way is to temporarily use ":sh" to run a shell, copy the text, then |
|
d7619a9874cd
patch 8.1.2226: cannot use system copy/paste in non-xterm terminals
Bram Moolenaar <Bram@vim.org>
parents:
18299
diff
changeset
|
848 exit the shell. 'mouse' can remain set to "a" then. |
| 7 | 849 *xterm-clipboard* |
| 28379 | 850 In the Motif GUI version, when running in a terminal and there is |
| 7 | 851 access to the X-server (DISPLAY is set), the copy and paste will behave like |
| 852 in the GUI. If not, the middle mouse button will insert the unnamed register. | |
| 853 In that case, here is how you copy and paste a piece of text: | |
| 854 | |
| 855 Copy/paste with the mouse and Visual mode ('mouse' option must be set, see | |
| 856 above): | |
| 857 1. Press left mouse button on first letter of text, move mouse pointer to last | |
| 858 letter of the text and release the button. This will start Visual mode and | |
| 859 highlight the selected area. | |
| 860 2. Press "y" to yank the Visual text in the unnamed register. | |
| 861 3. Click the left mouse button at the insert position. | |
| 862 4. Click the middle mouse button. | |
| 863 | |
| 864 Shortcut: If the insert position is on the screen at the same time as the | |
| 865 Visual text, you can do 2, 3 and 4 all in one: Click the middle mouse button | |
| 866 at the insert position. | |
| 867 | |
| 868 Note: When the |-X| command line argument is used, Vim will not connect to the | |
| 869 X server and copy/paste to the X clipboard (selection) will not work. Use the | |
| 870 shift key with the mouse buttons to let the xterm do the selection. | |
| 871 | |
| 872 *xterm-command-server* | |
| 873 When the X-server clipboard is available, the command server described in | |
| 874 |x11-clientserver| can be enabled with the --servername command line argument. | |
| 875 | |
| 876 *xterm-copy-paste* | |
| 877 NOTE: In some (older) xterms, it's not possible to move the cursor past column | |
| 5908 | 878 95 or 223. This is an xterm problem, not Vim's. Get a newer xterm |
| 879 |color-xterm|. Also see |'ttymouse'|. | |
| 7 | 880 |
| 881 Copy/paste in xterm with (current mode NOT included in 'mouse'): | |
| 882 1. Press left mouse button on first letter of text, move mouse pointer to last | |
| 883 letter of the text and release the button. | |
| 884 2. Use normal Vim commands to put the cursor at the insert position. | |
| 885 3. Press "a" to start Insert mode. | |
| 886 4. Click the middle mouse button. | |
| 887 5. Press ESC to end Insert mode. | |
| 888 (The same can be done with anything in 'mouse' if you keep the shift key | |
| 889 pressed while using the mouse.) | |
| 890 | |
| 891 Note: if you lose the 8th bit when pasting (special characters are translated | |
| 892 into other characters), you may have to do "stty cs8 -istrip -parenb" in your | |
| 893 shell before starting Vim. | |
| 894 | |
| 895 Thus in an xterm the shift and ctrl keys cannot be used with the mouse. Mouse | |
| 896 commands requiring the CTRL modifier can be simulated by typing the "g" key | |
| 897 before using the mouse: | |
| 898 "g<LeftMouse>" is "<C-LeftMouse> (jump to tag under mouse click) | |
| 899 "g<RightMouse>" is "<C-RightMouse> ("CTRL-T") | |
| 900 | |
| 901 *mouse-mode-table* *mouse-overview* | |
| 902 A short overview of what the mouse buttons do, when 'mousemodel' is "extend": | |
| 903 | |
| 904 Normal Mode: | |
| 905 event position selection change action ~ | |
| 906 cursor window ~ | |
| 907 <LeftMouse> yes end yes | |
| 908 <C-LeftMouse> yes end yes "CTRL-]" (2) | |
| 909 <S-LeftMouse> yes no change yes "*" (2) *<S-LeftMouse>* | |
| 910 <LeftDrag> yes start or extend (1) no *<LeftDrag>* | |
| 911 <LeftRelease> yes start or extend (1) no | |
| 912 <MiddleMouse> yes if not active no put | |
| 913 <MiddleMouse> yes if active no yank and put | |
| 914 <RightMouse> yes start or extend yes | |
| 600 | 915 <A-RightMouse> yes start or extend blockw. yes *<A-RightMouse>* |
| 7 | 916 <S-RightMouse> yes no change yes "#" (2) *<S-RightMouse>* |
| 917 <C-RightMouse> no no change no "CTRL-T" | |
| 918 <RightDrag> yes extend no *<RightDrag>* | |
| 919 <RightRelease> yes extend no *<RightRelease>* | |
| 920 | |
| 921 Insert or Replace Mode: | |
| 922 event position selection change action ~ | |
| 923 cursor window ~ | |
| 924 <LeftMouse> yes (cannot be active) yes | |
| 925 <C-LeftMouse> yes (cannot be active) yes "CTRL-O^]" (2) | |
| 926 <S-LeftMouse> yes (cannot be active) yes "CTRL-O*" (2) | |
| 927 <LeftDrag> yes start or extend (1) no like CTRL-O (1) | |
| 928 <LeftRelease> yes start or extend (1) no like CTRL-O (1) | |
| 929 <MiddleMouse> no (cannot be active) no put register | |
| 930 <RightMouse> yes start or extend yes like CTRL-O | |
| 600 | 931 <A-RightMouse> yes start or extend blockw. yes |
| 7 | 932 <S-RightMouse> yes (cannot be active) yes "CTRL-O#" (2) |
| 933 <C-RightMouse> no (cannot be active) no "CTRL-O CTRL-T" | |
| 934 | |
| 935 In a help window: | |
| 936 event position selection change action ~ | |
| 937 cursor window ~ | |
| 938 <2-LeftMouse> yes (cannot be active) no "^]" (jump to help tag) | |
| 939 | |
| 940 When 'mousemodel' is "popup", these are different: | |
| 941 | |
| 942 Normal Mode: | |
| 943 event position selection change action ~ | |
| 944 cursor window ~ | |
| 945 <S-LeftMouse> yes start or extend (1) no | |
| 600 | 946 <A-LeftMouse> yes start or extend blockw. no *<A-LeftMouse>* |
| 7 | 947 <RightMouse> no popup menu no |
| 948 | |
| 949 Insert or Replace Mode: | |
| 950 event position selection change action ~ | |
| 951 cursor window ~ | |
| 952 <S-LeftMouse> yes start or extend (1) no like CTRL-O (1) | |
| 600 | 953 <A-LeftMouse> yes start or extend blockw. no |
| 7 | 954 <RightMouse> no popup menu no |
| 955 | |
| 956 (1) only if mouse pointer moved since press | |
| 957 (2) only if click is in same buffer | |
| 958 | |
| 959 Clicking the left mouse button causes the cursor to be positioned. If the | |
| 960 click is in another window that window is made the active window. When | |
| 961 editing the command-line the cursor can only be positioned on the | |
| 962 command-line. When in Insert mode Vim remains in Insert mode. If 'scrolloff' | |
| 963 is set, and the cursor is positioned within 'scrolloff' lines from the window | |
| 964 border, the text is scrolled. | |
| 965 | |
| 966 A selection can be started by pressing the left mouse button on the first | |
| 967 character, moving the mouse to the last character, then releasing the mouse | |
| 968 button. You will not always see the selection until you release the button, | |
| 18972 | 969 only in some versions (GUI, Win32) will the dragging be shown immediately. |
| 970 Note that you can make the text scroll by moving the mouse at least one | |
| 971 character in the first/last line in the window when 'scrolloff' is non-zero. | |
| 7 | 972 |
| 973 In Normal, Visual and Select mode clicking the right mouse button causes the | |
| 974 Visual area to be extended. When 'mousemodel' is "popup", the left button has | |
| 975 to be used while keeping the shift key pressed. When clicking in a window | |
| 976 which is editing another buffer, the Visual or Select mode is stopped. | |
| 977 | |
| 600 | 978 In Normal, Visual and Select mode clicking the right mouse button with the alt |
| 1121 | 979 key pressed causes the Visual area to become blockwise. When 'mousemodel' is |
| 600 | 980 "popup" the left button has to be used with the alt key. Note that this won't |
| 853 | 981 work on systems where the window manager consumes the mouse events when the |
| 982 alt key is pressed (it may move the window). | |
| 600 | 983 |
| 7 | 984 *double-click* |
| 18972 | 985 Double, triple and quadruple clicks are supported when the GUI is active, for |
| 986 Win32, and for an xterm (if the gettimeofday() function is available). For | |
| 987 selecting text, extra clicks extend the selection: | |
| 7 | 988 click select ~ |
| 989 double word or % match *<2-LeftMouse>* | |
| 990 triple line *<3-LeftMouse>* | |
| 991 quadruple rectangular block *<4-LeftMouse>* | |
| 992 Exception: In a Help window a double click jumps to help for the word that is | |
| 993 clicked on. | |
| 994 A double click on a word selects that word. 'iskeyword' is used to specify | |
| 995 which characters are included in a word. A double click on a character | |
| 996 that has a match selects until that match (like using "v%"). If the match is | |
| 997 an #if/#else/#endif block, the selection becomes linewise. | |
| 19116 | 998 For MS-Windows and xterm the time for double clicking can be set with the |
| 999 'mousetime' option. For the other systems this time is defined outside of Vim. | |
| 7 | 1000 An example, for using a double click to jump to the tag under the cursor: > |
| 27903 | 1001 :map <2-LeftMouse> :exe "tag " .. expand("<cword>")<CR> |
| 7 | 1002 |
| 1003 Dragging the mouse with a double click (button-down, button-up, button-down | |
| 1004 and then drag) will result in whole words to be selected. This continues | |
| 1005 until the button is released, at which point the selection is per character | |
| 1006 again. | |
| 1007 | |
| 1008 *gpm-mouse* | |
| 1009 The GPM mouse is only supported when the |+mouse_gpm| feature was enabled at | |
| 1010 compile time. The GPM mouse driver (Linux console) does not support quadruple | |
| 1011 clicks. | |
| 1012 | |
| 1013 In Insert mode, when a selection is started, Vim goes into Normal mode | |
| 1014 temporarily. When Visual or Select mode ends, it returns to Insert mode. | |
| 1015 This is like using CTRL-O in Insert mode. Select mode is used when the | |
| 1016 'selectmode' option contains "mouse". | |
| 1621 | 1017 *sysmouse* |
| 1018 The sysmouse is only supported when the |+mouse_sysmouse| feature was enabled | |
| 1019 at compile time. The sysmouse driver (*BSD console) does not support keyboard | |
| 1020 modifiers. | |
| 7 | 1021 |
| 1022 *drag-status-line* | |
| 1023 When working with several windows, the size of the windows can be changed by | |
| 1024 dragging the status line with the mouse. Point the mouse at a status line, | |
| 1025 press the left button, move the mouse to the new position of the status line, | |
| 1026 release the button. Just clicking the mouse in a status line makes that window | |
| 1027 the current window, without moving the cursor. If by selecting a window it | |
| 1028 will change position or size, the dragging of the status line will look | |
| 1029 confusing, but it will work (just try it). | |
| 1030 | |
| 1031 *<MiddleRelease>* *<MiddleDrag>* | |
| 1032 Mouse clicks can be mapped. The codes for mouse clicks are: | |
| 1033 code mouse button normal action ~ | |
| 1034 <LeftMouse> left pressed set cursor position | |
| 1035 <LeftDrag> left moved while pressed extend selection | |
| 1036 <LeftRelease> left released set selection end | |
| 1037 <MiddleMouse> middle pressed paste text at cursor position | |
| 1038 <MiddleDrag> middle moved while pressed - | |
| 1039 <MiddleRelease> middle released - | |
| 1040 <RightMouse> right pressed extend selection | |
| 1041 <RightDrag> right moved while pressed extend selection | |
| 1042 <RightRelease> right released set selection end | |
| 1043 <X1Mouse> X1 button pressed - *X1Mouse* | |
| 1044 <X1Drag> X1 moved while pressed - *X1Drag* | |
| 1045 <X1Release> X1 button release - *X1Release* | |
| 1046 <X2Mouse> X2 button pressed - *X2Mouse* | |
| 1047 <X2Drag> X2 moved while pressed - *X2Drag* | |
| 1048 <X2Release> X2 button release - *X2Release* | |
| 1049 | |
| 1050 The X1 and X2 buttons refer to the extra buttons found on some mice. The | |
| 1051 'Microsoft Explorer' mouse has these buttons available to the right thumb. | |
|
7272
17333ebd2bbd
commit https://github.com/vim/vim/commit/d042dc825c9b97dacd84d4728f88300da4d5b6b9
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
1052 Currently X1 and X2 only work on Win32 and X11 environments. |
| 7 | 1053 |
| 1054 Examples: > | |
| 1055 :noremap <MiddleMouse> <LeftMouse><MiddleMouse> | |
| 1056 Paste at the position of the middle mouse button click (otherwise the paste | |
| 1057 would be done at the cursor position). > | |
| 1058 | |
| 1059 :noremap <LeftRelease> <LeftRelease>y | |
| 1060 Immediately yank the selection, when using Visual mode. | |
| 1061 | |
| 1062 Note the use of ":noremap" instead of "map" to avoid a recursive mapping. | |
| 1063 > | |
| 1064 :map <X1Mouse> <C-O> | |
| 1065 :map <X2Mouse> <C-I> | |
| 1066 Map the X1 and X2 buttons to go forwards and backwards in the jump list, see | |
| 1067 |CTRL-O| and |CTRL-I|. | |
| 1068 | |
| 1069 *mouse-swap-buttons* | |
| 1070 To swap the meaning of the left and right mouse buttons: > | |
| 1071 :noremap <LeftMouse> <RightMouse> | |
| 1072 :noremap <LeftDrag> <RightDrag> | |
| 1073 :noremap <LeftRelease> <RightRelease> | |
| 1074 :noremap <RightMouse> <LeftMouse> | |
| 1075 :noremap <RightDrag> <LeftDrag> | |
| 1076 :noremap <RightRelease> <LeftRelease> | |
| 1077 :noremap g<LeftMouse> <C-RightMouse> | |
| 1078 :noremap g<RightMouse> <C-LeftMouse> | |
| 1079 :noremap! <LeftMouse> <RightMouse> | |
| 1080 :noremap! <LeftDrag> <RightDrag> | |
| 1081 :noremap! <LeftRelease> <RightRelease> | |
| 1082 :noremap! <RightMouse> <LeftMouse> | |
| 1083 :noremap! <RightDrag> <LeftDrag> | |
| 1084 :noremap! <RightRelease> <LeftRelease> | |
| 1085 < | |
| 14421 | 1086 vim:tw=78:ts=8:noet:ft=help:norl: |