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