blob: 50ba187ab96921d51e1048a52f40bd35565763d7 [file] [log] [blame]
Bram Moolenaar86b48162022-12-06 18:20:10 +00001*term.txt* For Vim version 9.0. Last change: 2022 Dec 01
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Terminal information *terminal-info*
8
9Vim uses information about the terminal you are using to fill the screen and
10recognize what keys you hit. If this information is not correct, the screen
11may be messed up or keys may not be recognized. The actions which have to be
12performed on the screen are accomplished by outputting a string of
13characters. Special keys produce a string of characters. These strings are
14stored in the terminal options, see |terminal-options|.
15
16NOTE: Most of this is not used when running the |GUI|.
17
181. Startup |startup-terminal|
192. Terminal options |terminal-options|
203. Window size |window-size|
214. Slow and fast terminals |slow-fast-terminal|
225. Using the mouse |mouse-using|
23
24==============================================================================
251. Startup *startup-terminal*
26
27When Vim is started a default terminal type is assumed. For the Amiga this is
Bram Moolenaar5666fcd2019-12-26 14:35:26 +010028a standard CLI window, for MS-Windows the pc terminal, for Unix an ansi
29terminal. A few other terminal types are always available, see below
30|builtin-terms|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000031
32You can give the terminal name with the '-T' Vim argument. If it is not given
33Vim will try to get the name from the TERM environment variable.
34
35 *termcap* *terminfo* *E557* *E558* *E559*
36On 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,
38the choice whether to use terminfo or termcap is done automatically. When
39running Vim the output of ":version" will show |+terminfo| if terminfo is
40used. Also see |xterm-screens|.
41
42On non-Unix systems a termcap is only available if Vim was compiled with
43TERMCAP defined.
44
45 *builtin-terms* *builtin_terms*
Bram Moolenaar2ee347f2022-08-26 17:53:44 +010046A number of builtin terminals are available. Since patch 9.0.0280 there is no
47difference between Vim versions. You can see a list of available builtin
48terminals in the error message you get for `:set term=xxx` (when not running
Bram Moolenaar7dd54322022-08-26 18:01:12 +010049the GUI). Also see |++builtin_terms|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000050
51If the termcap code is included Vim will try to get the strings for the
52terminal you are using from the termcap file and the builtin termcaps. Both
53are always used, if an entry for the terminal you are using is present. Which
54one 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
59If an option is missing in one of them, it will be obtained from the other
60one. If an option is present in both, the one first encountered is used.
61
62Which external termcap file is used varies from system to system and may
63depend on the environment variables "TERMCAP" and "TERMPATH". See "man
64tgetent".
65
66Settings depending on terminal *term-dependent-settings*
67
68If you want to set options or mappings, depending on the terminal name, you
69can 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*
78For normal editing the terminal will be put into "raw" mode. The strings
Bram Moolenaar171a9212019-10-12 21:08:59 +020079defined with 't_ti', 't_TI' and 't_ks' will be sent to the terminal. Normally
80this puts the terminal in a state where the termcap codes are valid and
81activates the cursor and function keys.
82When Vim exits the terminal will be put back into the mode it was before Vim
83started. The strings defined with 't_te', 't_TE' and 't_ke' will be sent to
84the terminal. On the Amiga, with commands that execute an external command
85(e.g., "!!"), the terminal will be put into Normal mode for a moment. This
86means that you can stop the output to the screen by hitting a printing key.
87Output resumes when you hit <BS>.
88
89Note: When 't_ti' is not empty, Vim assumes that it causes switching to the
90alternate screen. This may slightly change what happens when executing a
91shell command or exiting Vim. To avoid this use 't_TI' and 't_TE'.
Bram Moolenaar071d4272004-06-13 20:20:40 +000092
Bram Moolenaar733a69b2022-12-01 12:03:47 +000093Vim will try to detect what keyboard protocol the terminal is using with the
94't_RK' termcap entry. This is sent after 't_TI', but only when there is no
95work to do (no typeahead and no pending commands). That is to avoid the
96response to end up in a shell command or arrive after Vim exits.
97
Bram Moolenaarec2da362017-01-21 20:04:22 +010098 *xterm-bracketed-paste*
99When the 't_BE' option is set then 't_BE' will be sent to the
100terminal when entering "raw" mode and 't_BD' when leaving "raw" mode. The
101terminal is then expected to put 't_PS' before pasted text and 't_PE' after
102pasted text. This way Vim can separate text that is pasted from characters
103that are typed. The pasted text is handled like when the middle mouse button
Bram Moolenaarfd8983b2017-02-02 22:21:29 +0100104is used, it is inserted literally and not interpreted as commands.
105
106When the cursor is in the first column, the pasted text will be inserted
107before it. Otherwise the pasted text is appended after the cursor position.
108This means one cannot paste after the first column. Unfortunately Vim does
109not have a way to tell where the mouse pointer was.
Bram Moolenaarec2da362017-01-21 20:04:22 +0100110
111Note that in some situations Vim will not recognize the bracketed paste and
112you will get the raw text. In other situations Vim will only get the first
Bram Moolenaar690afe12017-01-28 18:34:47 +0100113pasted character and drop the rest, e.g. when using the "r" command. If you
114have a problem with this, disable bracketed paste by putting this in your
115.vimrc: >
116 set t_BE=
117If this is done while Vim is running the 't_BD' will be sent to the terminal
118to disable bracketed paste.
Bram Moolenaarec2da362017-01-21 20:04:22 +0100119
Bram Moolenaard2f3a8b2018-06-19 14:35:59 +0200120If your terminal supports bracketed paste, but the options are not set
121automatically, you can try using something like this: >
122
123 if &term =~ "screen"
124 let &t_BE = "\e[?2004h"
125 let &t_BD = "\e[?2004l"
126 exec "set t_PS=\e[200~"
127 exec "set t_PE=\e[201~"
128 endif
129<
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200130 *tmux-integration*
131If you experience issues when running Vim inside tmux, here are a few hints.
132You can comment-out parts if something doesn't work (it may depend on the
133terminal that tmux is running in): >
134
135 if !has('gui_running') && &term =~ '^\%(screen\|tmux\)'
136 " Better mouse support, see :help 'ttymouse'
137 set ttymouse=sgr
138
139 " Enable true colors, see :help xterm-true-color
140 let &termguicolors = v:true
141 let &t_8f = "\<Esc>[38;2;%lu;%lu;%lum"
142 let &t_8b = "\<Esc>[48;2;%lu;%lu;%lum"
143
144 " Enable bracketed paste mode, see :help xterm-bracketed-paste
145 let &t_BE = "\<Esc>[?2004h"
146 let &t_BD = "\<Esc>[?2004l"
147 let &t_PS = "\<Esc>[200~"
148 let &t_PE = "\<Esc>[201~"
149
150 " Enable focus event tracking, see :help xterm-focus-event
151 let &t_fe = "\<Esc>[?1004h"
152 let &t_fd = "\<Esc>[?1004l"
Bram Moolenaar0e6adf82021-12-16 14:41:10 +0000153 execute "set <FocusGained>=\<Esc>[I"
154 execute "set <FocusLost>=\<Esc>[O"
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200155
Bram Moolenaar47003982021-12-05 21:54:04 +0000156 " Enable modified arrow keys, see :help arrow_modifiers
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200157 execute "silent! set <xUp>=\<Esc>[@;*A"
158 execute "silent! set <xDown>=\<Esc>[@;*B"
159 execute "silent! set <xRight>=\<Esc>[@;*C"
160 execute "silent! set <xLeft>=\<Esc>[@;*D"
161 endif
162<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000163 *cs7-problem*
164Note: If the terminal settings are changed after running Vim, you might have
165an illegal combination of settings. This has been reported on Solaris 2.5
166with "stty cs8 parenb", which is restored as "stty cs7 parenb". Use
167"stty cs8 -parenb -istrip" instead, this is restored correctly.
168
169Some termcap entries are wrong in the sense that after sending 't_ks' the
170cursor keys send codes different from the codes defined in the termcap. To
171avoid this you can set 't_ks' (and 't_ke') to empty strings. This must be
172done during initialization (see |initialization|), otherwise it's too late.
173
174Some termcap entries assume that the highest bit is always reset. For
175example: The cursor-up entry for the Amiga could be ":ku=\E[A:". But the
176Amiga really sends "\233A". This works fine if the highest bit is reset,
177e.g., when using an Amiga over a serial line. If the cursor keys don't work,
178try the entry ":ku=\233A:".
179
180Some termcap entries have the entry ":ku=\E[A:". But the Amiga really sends
181"\233A". On output "\E[" and "\233" are often equivalent, on input they
182aren't. You will have to change the termcap entry, or change the key code with
183the :set command to fix this.
184
185Many cursor key codes start with an <Esc>. Vim must find out if this is a
186single hit of the <Esc> key or the start of a cursor key sequence. It waits
187for a next character to arrive. If it does not arrive within one second a
188single <Esc> is assumed. On very slow systems this may fail, causing cursor
189keys not to work sometimes. If you discover this problem reset the 'timeout'
190option. Vim will wait for the next character to arrive after an <Esc>. If
191you want to enter a single <Esc> you must type it twice. Resetting the
192'esckeys' option avoids this problem in Insert mode, but you lose the
193possibility to use cursor and function keys in Insert mode.
194
195On the Amiga the recognition of window resizing is activated only when the
196terminal name is "amiga" or "builtin_amiga".
197
198Some terminals have confusing codes for the cursor keys. The televideo 925 is
199such a terminal. It sends a CTRL-H for cursor-left. This would make it
200impossible to distinguish a backspace and cursor-left. To avoid this problem
201CTRL-H is never recognized as cursor-left.
202
203 *vt100-cursor-keys* *xterm-cursor-keys*
204Other terminals (e.g., vt100 and xterm) have cursor keys that send <Esc>OA,
205<Esc>OB, etc. Unfortunately these are valid commands in insert mode: Stop
206insert, Open a new line above the new one, start inserting 'A', 'B', etc.
207Instead of performing these commands Vim will erroneously recognize this typed
208key sequence as a cursor key movement. To avoid this and make Vim do what you
209want in either case you could use these settings: >
210 :set notimeout " don't timeout on mappings
211 :set ttimeout " do timeout on terminal key codes
212 :set timeoutlen=100 " timeout after 100 msec
Bram Moolenaar446cb832008-06-24 21:56:24 +0000213This requires the key-codes to be sent within 100 msec in order to recognize
Bram Moolenaar071d4272004-06-13 20:20:40 +0000214them as a cursor key. When you type you normally are not that fast, so they
215are recognized as individual typed commands, even though Vim receives the same
216sequence of bytes.
217
218 *vt100-function-keys* *xterm-function-keys*
219An xterm can send function keys F1 to F4 in two modes: vt100 compatible or
Bram Moolenaar19a09a12005-03-04 23:39:37 +0000220not. Because Vim may not know what the xterm is sending, both types of keys
Bram Moolenaar071d4272004-06-13 20:20:40 +0000221are recognized. The same happens for the <Home> and <End> keys.
222 normal vt100 ~
223 <F1> t_k1 <Esc>[11~ <xF1> <Esc>OP *<xF1>-xterm*
224 <F2> t_k2 <Esc>[12~ <xF2> <Esc>OQ *<xF2>-xterm*
225 <F3> t_k3 <Esc>[13~ <xF3> <Esc>OR *<xF3>-xterm*
226 <F4> t_k4 <Esc>[14~ <xF4> <Esc>OS *<xF4>-xterm*
227 <Home> t_kh <Esc>[7~ <xHome> <Esc>OH *<xHome>-xterm*
228 <End> t_@7 <Esc>[4~ <xEnd> <Esc>OF *<xEnd>-xterm*
229
230When Vim starts, <xF1> is mapped to <F1>, <xF2> to <F2> etc. This means that
231by default both codes do the same thing. If you make a mapping for <xF2>,
232because your terminal does have two keys, the default mapping is overwritten,
233thus you can use the <F2> and <xF2> keys for something different.
234
235 *xterm-shifted-keys*
236Newer versions of xterm support shifted function keys and special keys. Vim
237recognizes most of them. Use ":set termcap" to check which are supported and
238what the codes are. Mostly these are not in a termcap, they are only
239supported by the builtin_xterm termcap.
240
Bram Moolenaar19a09a12005-03-04 23:39:37 +0000241 *xterm-modifier-keys*
242Newer versions of xterm support Alt and Ctrl for most function keys. To avoid
243having to add all combinations of Alt, Ctrl and Shift for every key a special
244sequence is recognized at the end of a termcap entry: ";*X". The "X" can be
245any character, often '~' is used. The ";*" stands for an optional modifier
246argument. ";2" is Shift, ";3" is Alt, ";5" is Ctrl and ";9" is Meta (when
247it's different from Alt). They can be combined. Examples: >
248 :set <F8>=^[[19;*~
249 :set <Home>=^[[1;*H
250Another speciality about these codes is that they are not overwritten by
251another code. That is to avoid that the codes obtained from xterm directly
252|t_RV| overwrite them.
Bram Moolenaar4d8c96d2020-12-29 20:53:33 +0100253
254Another special value is a termcap entry ending in "@;*X". This is for cursor
255keys, which either use "CSI X" or "CSI 1 ; modifier X". Thus the "@"
256stands for either "1" if a modifier follows, or nothing.
Bram Moolenaar47003982021-12-05 21:54:04 +0000257 *arrow_modifiers*
258Several terminal emulators (alacritty, gnome, konsole, etc.) send special
259codes for keys with modifiers, but these do not have an entry in the
260termcap/terminfo database. You can make them work by adding a few lines in
261your vimrc. For example, to make the Control modifier work with arrow keys
262for the gnome terminal: >
263 if &term =~ 'gnome'
264 execute "set <xUp>=\<Esc>[@;*A"
265 execute "set <xDown>=\<Esc>[@;*B"
266 execute "set <xRight>=\<Esc>[@;*C"
267 execute "set <xLeft>=\<Esc>[@;*D"
268 endif
269< *xterm-scroll-region*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000270The default termcap entry for xterm on Sun and other platforms does not
271contain the entry for scroll regions. Add ":cs=\E[%i%d;%dr:" to the xterm
272entry in /etc/termcap and everything should work.
273
274 *xterm-end-home-keys*
275On some systems (at least on FreeBSD with XFree86 3.1.2) the codes that the
276<End> and <Home> keys send contain a <Nul> character. To make these keys send
277the proper key code, add these lines to your ~/.Xdefaults file:
278
279*VT100.Translations: #override \n\
280 <Key>Home: string("0x1b") string("[7~") \n\
281 <Key>End: string("0x1b") string("[8~")
282
283 *xterm-8bit* *xterm-8-bit*
284Xterm can be run in a mode where it uses 8-bit escape sequences. The CSI code
285is used instead of <Esc>[. The advantage is that an <Esc> can quickly be
286recognized in Insert mode, because it can't be confused with the start of a
287special key.
288For the builtin termcap entries, Vim checks if the 'term' option contains
289"8bit" anywhere. It then uses 8-bit characters for the termcap entries, the
290mouse and a few other things. You would normally set $TERM in your shell to
291"xterm-8bit" and Vim picks this up and adjusts to the 8-bit setting
292automatically.
293When Vim receives a response to the |t_RV| (request version) sequence and it
294starts with CSI, it assumes that the terminal is in 8-bit mode and will
295convert all key sequences to their 8-bit variants.
296
Bram Moolenaar731d0072022-12-18 17:47:18 +0000297 *xterm-kitty* *kitty-terminal*
298The Kitty terminal is a special case. Mainly because it works different from
299most other terminals, but also because, instead of trying the fit in and make
300it behave like other terminals by default, it dictates how applications need
301to work when using Kitty. This makes it very difficult for Vim to work in a
302Kitty terminal. Some exceptions have been hard coded, but it is not at all
303nice to have to make exceptions for one specific terminal.
304
305One of the problems is that the value for $TERM is set to "xterm-kitty". For
306Vim this is an indication that the terminal is xterm-compatible and the
307builtin xterm termcap entries should be used. Many other terminals depend on
308this. However, Kitty is not fully xterm compatible. The author suggested to
309ignore the "xterm-" prefix and use the terminfo entry anyway, but that
310conflicts with what is needed for other terminals. Therefore Vim removes the
311"xterm-" prefix from "xterm-kitty" when it comes from $TERM.
312
313Note that using the kitty keyboard protocol is a separate feature, see
314|kitty-keyboard-protocol|.
315
316
Bram Moolenaar071d4272004-06-13 20:20:40 +0000317==============================================================================
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003182. Terminal options *terminal-options* *termcap-options* *E436*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000319
320The terminal options can be set just like normal options. But they are not
321shown with the ":set all" command. Instead use ":set termcap".
322
323It is always possible to change individual strings by setting the
324appropriate option. For example: >
325 :set t_ce=^V^[[K (CTRL-V, <Esc>, [, K)
326
Bram Moolenaar071d4272004-06-13 20:20:40 +0000327The options are listed below. The associated termcap code is always equal to
328the last two characters of the option name. Only one termcap code is
329required: Cursor motion, 't_cm'.
330
Bram Moolenaar494838a2015-02-10 19:20:37 +0100331The options 't_da', 't_db', 't_ms', 't_xs', 't_xn' represent flags in the
332termcap. When the termcap flag is present, the option will be set to "y".
333But any non-empty string means that the flag is set. An empty string means
334that the flag is not set. 't_CS' works like this too, but it isn't a termcap
335flag.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000336
Bram Moolenaar214641f2017-03-05 17:04:09 +0100337OUTPUT CODES *terminal-output-codes*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000338 option meaning ~
339
340 t_AB set background color (ANSI) *t_AB* *'t_AB'*
341 t_AF set foreground color (ANSI) *t_AF* *'t_AF'*
342 t_AL add number of blank lines *t_AL* *'t_AL'*
343 t_al add new blank line *t_al* *'t_al'*
344 t_bc backspace character *t_bc* *'t_bc'*
345 t_cd clear to end of screen *t_cd* *'t_cd'*
346 t_ce clear to end of line *t_ce* *'t_ce'*
347 t_cl clear screen *t_cl* *'t_cl'*
348 t_cm cursor motion (required!) *E437* *t_cm* *'t_cm'*
349 t_Co number of colors *t_Co* *'t_Co'*
350 t_CS if non-empty, cursor relative to scroll region *t_CS* *'t_CS'*
351 t_cs define scrolling region *t_cs* *'t_cs'*
352 t_CV define vertical scrolling region *t_CV* *'t_CV'*
353 t_da if non-empty, lines from above scroll down *t_da* *'t_da'*
354 t_db if non-empty, lines from below scroll up *t_db* *'t_db'*
355 t_DL delete number of lines *t_DL* *'t_DL'*
356 t_dl delete line *t_dl* *'t_dl'*
357 t_fs set window title end (from status line) *t_fs* *'t_fs'*
358 t_ke exit "keypad transmit" mode *t_ke* *'t_ke'*
359 t_ks start "keypad transmit" mode *t_ks* *'t_ks'*
360 t_le move cursor one char left *t_le* *'t_le'*
361 t_mb blinking mode *t_mb* *'t_mb'*
362 t_md bold mode *t_md* *'t_md'*
363 t_me Normal mode (undoes t_mr, t_mb, t_md and color) *t_me* *'t_me'*
364 t_mr reverse (invert) mode *t_mr* *'t_mr'*
365 *t_ms* *'t_ms'*
366 t_ms if non-empty, cursor can be moved in standout/inverse mode
367 t_nd non destructive space character *t_nd* *'t_nd'*
368 t_op reset to original color pair *t_op* *'t_op'*
369 t_RI cursor number of chars right *t_RI* *'t_RI'*
370 t_Sb set background color *t_Sb* *'t_Sb'*
371 t_Sf set foreground color *t_Sf* *'t_Sf'*
372 t_se standout end *t_se* *'t_se'*
373 t_so standout mode *t_so* *'t_so'*
374 t_sr scroll reverse (backward) *t_sr* *'t_sr'*
Bram Moolenaar171a9212019-10-12 21:08:59 +0200375 t_te end of "termcap" mode *t_te* *'t_te'*
376 t_ti put terminal into "termcap" mode *t_ti* *'t_ti'*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000377 t_ts set window title start (to status line) *t_ts* *'t_ts'*
378 t_ue underline end *t_ue* *'t_ue'*
379 t_us underline mode *t_us* *'t_us'*
380 t_ut clearing uses the current background color *t_ut* *'t_ut'*
381 t_vb visual bell *t_vb* *'t_vb'*
382 t_ve cursor visible *t_ve* *'t_ve'*
383 t_vi cursor invisible *t_vi* *'t_vi'*
Bram Moolenaarc572da52017-08-27 16:52:01 +0200384 t_vs cursor very visible (blink) *t_vs* *'t_vs'*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000385 *t_xs* *'t_xs'*
386 t_xs if non-empty, standout not erased by overwriting (hpterm)
Bram Moolenaar494838a2015-02-10 19:20:37 +0100387 *t_xn* *'t_xn'*
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100388 t_xn if non-empty, writing a character at the last screen cell
389 does not cause scrolling
Bram Moolenaar071d4272004-06-13 20:20:40 +0000390 t_ZH italics mode *t_ZH* *'t_ZH'*
391 t_ZR italics end *t_ZR* *'t_ZR'*
392
393Added by Vim (there are no standard codes for these):
Bram Moolenaare023e882020-05-31 16:42:30 +0200394 t_AU set underline color (ANSI) *t_AU* *'t_AU'*
Bram Moolenaar84f54632022-06-29 18:39:11 +0100395 t_Ce undercurl and underline end *t_Ce* *'t_Ce'*
396 t_Cs undercurl (curly underline) mode *t_Cs* *'t_Cs'*
397 t_Us double underline mode *t_Us* *'t_Us'*
398 t_ds dotted underline mode *t_ds* *'t_ds'*
399 t_Ds dashed underline mode *t_Ds* *'t_Ds'*
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200400 t_Te strikethrough end *t_Te* *'t_Te'*
401 t_Ts strikethrough mode *t_Ts* *'t_Ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000402 t_IS set icon text start *t_IS* *'t_IS'*
403 t_IE set icon text end *t_IE* *'t_IE'*
404 t_WP set window position (Y, X) in pixels *t_WP* *'t_WP'*
Bram Moolenaar94237492017-04-23 18:40:21 +0200405 t_GP get window position (Y, X) in pixels *t_GP* *'t_GP'*
Bram Moolenaarb6e0ec62017-07-23 22:12:20 +0200406 t_WS set window size (height, width in cells) *t_WS* *'t_WS'*
Bram Moolenaarc572da52017-08-27 16:52:01 +0200407 t_VS cursor normally visible (no blink) *t_VS* *'t_VS'*
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000408 t_SI start insert mode (bar cursor shape) *t_SI* *'t_SI'*
Bram Moolenaar1e7813a2015-03-31 18:31:03 +0200409 t_SR start replace mode (underline cursor shape) *t_SR* *'t_SR'*
410 t_EI end insert or replace mode (block cursor shape) *t_EI* *'t_EI'*
Bram Moolenaarac6e65f2005-08-29 22:25:38 +0000411 |termcap-cursor-shape|
Bram Moolenaarce001a32022-04-27 15:25:03 +0100412 t_RV request terminal version string (works for *t_RV* *'t_RV'*
413 xterm and other terminal emulators) The
414 response is stored in |v:termresponse| |xterm-8bit|
415 |'ttymouse'| |xterm-codes|
Bram Moolenaar733a69b2022-12-01 12:03:47 +0000416 t_RK request terminal keyboard protocol state; *t_RK* *'t_RK'*
417 sent after |t_TI|
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100418 t_u7 request cursor position (for xterm) *t_u7* *'t_u7'*
419 see |'ambiwidth'|
Bram Moolenaar2a953fc2019-01-26 17:41:47 +0100420 The response is stored in |v:termu7resp|
Bram Moolenaar01164a62017-11-02 22:58:42 +0100421 t_RF request terminal foreground color *t_RF* *'t_RF'*
Bram Moolenaar2a953fc2019-01-26 17:41:47 +0100422 The response is stored in |v:termrfgresp|
Bram Moolenaar979243b2015-06-26 19:35:49 +0200423 t_RB request terminal background color *t_RB* *'t_RB'*
Bram Moolenaar2a953fc2019-01-26 17:41:47 +0100424 The response is stored in |v:termrbgresp|
Bram Moolenaar8a633e32016-04-21 21:10:14 +0200425 t_8f set foreground color (R, G, B) *t_8f* *'t_8f'*
426 |xterm-true-color|
427 t_8b set background color (R, G, B) *t_8b* *'t_8b'*
428 |xterm-true-color|
Bram Moolenaare023e882020-05-31 16:42:30 +0200429 t_8u set underline color (R, G, B) *t_8u* *'t_8u'*
Bram Moolenaarec2da362017-01-21 20:04:22 +0100430 t_BE enable bracketed paste mode *t_BE* *'t_BE'*
431 |xterm-bracketed-paste|
432 t_BD disable bracketed paste mode *t_BD* *'t_BD'*
433 |xterm-bracketed-paste|
Bram Moolenaarc572da52017-08-27 16:52:01 +0200434 t_SC set cursor color start *t_SC* *'t_SC'*
435 t_EC set cursor color end *t_EC* *'t_EC'*
436 t_SH set cursor shape *t_SH* *'t_SH'*
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200437 t_RC request terminal cursor blinking *t_RC* *'t_RC'*
Bram Moolenaar2a953fc2019-01-26 17:41:47 +0100438 The response is stored in |v:termblinkresp|
Bram Moolenaarc572da52017-08-27 16:52:01 +0200439 t_RS request terminal cursor style *t_RS* *'t_RS'*
Bram Moolenaar2a953fc2019-01-26 17:41:47 +0100440 The response is stored in |v:termstyleresp|
Bram Moolenaar40385db2018-08-07 22:31:44 +0200441 t_ST save window title to stack *t_ST* *'t_ST'*
442 t_RT restore window title from stack *t_RT* *'t_RT'*
443 t_Si save icon text to stack *t_Si* *'t_Si'*
444 t_Ri restore icon text from stack *t_Ri* *'t_Ri'*
Bram Moolenaar171a9212019-10-12 21:08:59 +0200445 t_TE end of "raw" mode *t_TE* *'t_TE'*
446 t_TI put terminal into "raw" mode *t_TI* *'t_TI'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +0100447 t_fe enable focus-event tracking *t_fe* *'t_fe'*
Bram Moolenaar681fc3f2021-01-14 17:35:21 +0100448 |xterm-focus-event|
Bram Moolenaar2346a632021-06-13 19:02:49 +0200449 t_fd disable focus-event tracking *t_fd* *'t_fd'*
450 |xterm-focus-event|
Bram Moolenaarc572da52017-08-27 16:52:01 +0200451
452Some codes have a start, middle and end part. The start and end are defined
453by the termcap option, the middle part is text.
454 set title text: t_ts {title text} t_fs
455 set icon text: t_IS {icon text} t_IE
456 set cursor color: t_SC {color name} t_EC
457
458t_SH must take one argument:
459 0, 1 or none blinking block cursor
460 2 block cursor
461 3 blinking underline cursor
462 4 underline cursor
463 5 blinking vertical bar cursor
464 6 vertical bar cursor
465
466t_RS is sent only if the response to t_RV has been received. It is not used
467on Mac OS when Terminal.app could be recognized from the termresponse.
468
Bram Moolenaar071d4272004-06-13 20:20:40 +0000469
Bram Moolenaar214641f2017-03-05 17:04:09 +0100470KEY CODES *terminal-key-codes*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000471Note: Use the <> form if possible
472
473 option name meaning ~
474
475 t_ku <Up> arrow up *t_ku* *'t_ku'*
476 t_kd <Down> arrow down *t_kd* *'t_kd'*
477 t_kr <Right> arrow right *t_kr* *'t_kr'*
478 t_kl <Left> arrow left *t_kl* *'t_kl'*
Bram Moolenaarbc7aa852005-03-06 23:38:09 +0000479 <xUp> alternate arrow up *<xUp>*
480 <xDown> alternate arrow down *<xDown>*
481 <xRight> alternate arrow right *<xRight>*
482 <xLeft> alternate arrow left *<xLeft>*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000483 <S-Up> shift arrow up
484 <S-Down> shift arrow down
485 t_%i <S-Right> shift arrow right *t_%i* *'t_%i'*
486 t_#4 <S-Left> shift arrow left *t_#4* *'t_#4'*
487 t_k1 <F1> function key 1 *t_k1* *'t_k1'*
488 <xF1> alternate F1 *<xF1>*
489 t_k2 <F2> function key 2 *<F2>* *t_k2* *'t_k2'*
490 <xF2> alternate F2 *<xF2>*
491 t_k3 <F3> function key 3 *<F3>* *t_k3* *'t_k3'*
492 <xF3> alternate F3 *<xF3>*
493 t_k4 <F4> function key 4 *<F4>* *t_k4* *'t_k4'*
494 <xF4> alternate F4 *<xF4>*
495 t_k5 <F5> function key 5 *<F5>* *t_k5* *'t_k5'*
496 t_k6 <F6> function key 6 *<F6>* *t_k6* *'t_k6'*
497 t_k7 <F7> function key 7 *<F7>* *t_k7* *'t_k7'*
498 t_k8 <F8> function key 8 *<F8>* *t_k8* *'t_k8'*
499 t_k9 <F9> function key 9 *<F9>* *t_k9* *'t_k9'*
500 t_k; <F10> function key 10 *<F10>* *t_k;* *'t_k;'*
Bram Moolenaarad3b3662013-05-17 18:14:19 +0200501 t_F1 <F11> function key 11 *<F11>* *t_F1* *'t_F1'*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000502 t_F2 <F12> function key 12 *<F12>* *t_F2* *'t_F2'*
503 t_F3 <F13> function key 13 *<F13>* *t_F3* *'t_F3'*
504 t_F4 <F14> function key 14 *<F14>* *t_F4* *'t_F4'*
505 t_F5 <F15> function key 15 *<F15>* *t_F5* *'t_F5'*
506 t_F6 <F16> function key 16 *<F16>* *t_F6* *'t_F6'*
507 t_F7 <F17> function key 17 *<F17>* *t_F7* *'t_F7'*
508 t_F8 <F18> function key 18 *<F18>* *t_F8* *'t_F8'*
509 t_F9 <F19> function key 19 *<F19>* *t_F9* *'t_F9'*
510 <S-F1> shifted function key 1
511 <S-xF1> alternate <S-F1> *<S-xF1>*
512 <S-F2> shifted function key 2 *<S-F2>*
513 <S-xF2> alternate <S-F2> *<S-xF2>*
514 <S-F3> shifted function key 3 *<S-F3>*
515 <S-xF3> alternate <S-F3> *<S-xF3>*
516 <S-F4> shifted function key 4 *<S-F4>*
517 <S-xF4> alternate <S-F4> *<S-xF4>*
518 <S-F5> shifted function key 5 *<S-F5>*
519 <S-F6> shifted function key 6 *<S-F6>*
520 <S-F7> shifted function key 7 *<S-F7>*
521 <S-F8> shifted function key 8 *<S-F8>*
522 <S-F9> shifted function key 9 *<S-F9>*
523 <S-F10> shifted function key 10 *<S-F10>*
524 <S-F11> shifted function key 11 *<S-F11>*
525 <S-F12> shifted function key 12 *<S-F12>*
526 t_%1 <Help> help key *t_%1* *'t_%1'*
527 t_&8 <Undo> undo key *t_&8* *'t_&8'*
528 t_kI <Insert> insert key *t_kI* *'t_kI'*
529 t_kD <Del> delete key *t_kD* *'t_kD'*
530 t_kb <BS> backspace key *t_kb* *'t_kb'*
Bram Moolenaarad3b3662013-05-17 18:14:19 +0200531 t_kB <S-Tab> back-tab (shift-tab) *<S-Tab>* *t_kB* *'t_kB'*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000532 t_kh <Home> home key *t_kh* *'t_kh'*
Bram Moolenaarad3b3662013-05-17 18:14:19 +0200533 t_#2 <S-Home> shifted home key *<S-Home>* *t_#2* *'t_#2'*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000534 <xHome> alternate home key *<xHome>*
535 t_@7 <End> end key *t_@7* *'t_@7'*
536 t_*7 <S-End> shifted end key *<S-End>* *t_star7* *'t_star7'*
537 <xEnd> alternate end key *<xEnd>*
538 t_kP <PageUp> page-up key *t_kP* *'t_kP'*
539 t_kN <PageDown> page-down key *t_kN* *'t_kN'*
540 t_K1 <kHome> keypad home key *t_K1* *'t_K1'*
541 t_K4 <kEnd> keypad end key *t_K4* *'t_K4'*
542 t_K3 <kPageUp> keypad page-up key *t_K3* *'t_K3'*
543 t_K5 <kPageDown> keypad page-down key *t_K5* *'t_K5'*
544 t_K6 <kPlus> keypad plus key *<kPlus>* *t_K6* *'t_K6'*
545 t_K7 <kMinus> keypad minus key *<kMinus>* *t_K7* *'t_K7'*
Bram Moolenaarad3b3662013-05-17 18:14:19 +0200546 t_K8 <kDivide> keypad divide *<kDivide>* *t_K8* *'t_K8'*
547 t_K9 <kMultiply> keypad multiply *<kMultiply>* *t_K9* *'t_K9'*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000548 t_KA <kEnter> keypad enter key *<kEnter>* *t_KA* *'t_KA'*
549 t_KB <kPoint> keypad decimal point *<kPoint>* *t_KB* *'t_KB'*
550 t_KC <k0> keypad 0 *<k0>* *t_KC* *'t_KC'*
551 t_KD <k1> keypad 1 *<k1>* *t_KD* *'t_KD'*
552 t_KE <k2> keypad 2 *<k2>* *t_KE* *'t_KE'*
553 t_KF <k3> keypad 3 *<k3>* *t_KF* *'t_KF'*
554 t_KG <k4> keypad 4 *<k4>* *t_KG* *'t_KG'*
555 t_KH <k5> keypad 5 *<k5>* *t_KH* *'t_KH'*
556 t_KI <k6> keypad 6 *<k6>* *t_KI* *'t_KI'*
557 t_KJ <k7> keypad 7 *<k7>* *t_KJ* *'t_KJ'*
558 t_KK <k8> keypad 8 *<k8>* *t_KK* *'t_KK'*
559 t_KL <k9> keypad 9 *<k9>* *t_KL* *'t_KL'*
560 <Mouse> leader of mouse code *<Mouse>*
Bram Moolenaar214641f2017-03-05 17:04:09 +0100561 *t_PS* *'t_PS'*
562 t_PS start of bracketed paste |xterm-bracketed-paste|
563 t_PE end of bracketed paste |xterm-bracketed-paste| *t_PE* *'t_PE'*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000564
565Note about t_so and t_mr: When the termcap entry "so" is not present the
566entry for "mr" is used. And vice versa. The same is done for "se" and "me".
567If your terminal supports both inversion and standout mode, you can see two
568different modes. If your terminal supports only one of the modes, both will
569look the same.
570
Bram Moolenaar009b2592004-10-24 19:18:58 +0000571 *keypad-comma*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000572The keypad keys, when they are not mapped, behave like the equivalent normal
Bram Moolenaar009b2592004-10-24 19:18:58 +0000573key. There is one exception: if you have a comma on the keypad instead of a
574decimal point, Vim will use a dot anyway. Use these mappings to fix that: >
575 :noremap <kPoint> ,
576 :noremap! <kPoint> ,
577< *xterm-codes*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000578There is a special trick to obtain the key codes which currently only works
579for xterm. When |t_RV| is defined and a response is received which indicates
580an xterm with patchlevel 141 or higher, Vim uses special escape sequences to
581request the key codes directly from the xterm. The responses are used to
582adjust the various t_ codes. This avoids the problem that the xterm can
583produce different codes, depending on the mode it is in (8-bit, VT102,
584VT220, etc.). The result is that codes like <xF1> are no longer needed.
Bram Moolenaar6f79e612021-12-21 09:12:23 +0000585
586One of the codes that can change is 't_Co', the number of colors. This will
587trigger a redraw. If this is a problem, reset the 'xtermcodes' option as
588early as possible: >
589 set noxtermcodes
590
591Note: Requesting the key codes is only done on startup. If the xterm options
592are changed after Vim has started, the escape sequences may not be recognized
593anymore.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000594
Bram Moolenaar8a633e32016-04-21 21:10:14 +0200595 *xterm-true-color*
596Vim supports using true colors in the terminal (taken from |highlight-guifg|
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100597and |highlight-guibg|), given that the terminal supports this. To make this
Bram Moolenaar61be73b2016-04-29 22:59:22 +0200598work the 'termguicolors' option needs to be set.
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +0100599See https://github.com/termstandard/colors for a list of terminals that
Bram Moolenaar64d8e252016-09-06 22:12:34 +0200600support true colors.
Bram Moolenaar8a633e32016-04-21 21:10:14 +0200601
Bram Moolenaar61be73b2016-04-29 22:59:22 +0200602Sometimes setting 'termguicolors' is not enough and one has to set the |t_8f|
603and |t_8b| options explicitly. Default values of these options are
604"^[[38;2;%lu;%lu;%lum" and "^[[48;2;%lu;%lu;%lum" respectively, but it is only
605set when `$TERM` is `xterm`. Some terminals accept the same sequences, but
606with all semicolons replaced by colons (this is actually more compatible, but
607less widely supported): >
Bram Moolenaar64d8e252016-09-06 22:12:34 +0200608 let &t_8f = "\<Esc>[38:2:%lu:%lu:%lum"
609 let &t_8b = "\<Esc>[48:2:%lu:%lu:%lum"
Bram Moolenaar61be73b2016-04-29 22:59:22 +0200610
611These options contain printf strings, with |printf()| (actually, its C
612equivalent hence `l` modifier) invoked with the t_ option value and three
613unsigned long integers that may have any value between 0 and 255 (inclusive)
614representing red, green and blue colors respectively.
Bram Moolenaar8a633e32016-04-21 21:10:14 +0200615
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100616 *xterm-resize*
617Window resizing with xterm only works if the allowWindowOps resource is
618enabled. On some systems and versions of xterm it's disabled by default
619because someone thought it would be a security issue. It's not clear if this
620is actually the case.
621
622To overrule the default, put this line in your ~/.Xdefaults or
623~/.Xresources:
624>
625 XTerm*allowWindowOps: true
626
627And run "xrdb -merge .Xresources" to make it effective. You can check the
628value with the context menu (right mouse button while CTRL key is pressed),
629there should be a tick at allow-window-ops.
630
Bram Moolenaar681fc3f2021-01-14 17:35:21 +0100631 *xterm-focus-event*
632Some terminals including xterm support the focus event tracking feature.
633If this feature is enabled by the 't_fe' sequence, special key sequences are
634sent from the terminal to Vim every time the terminal gains or loses focus.
635Vim fires focus events (|FocusGained|/|FocusLost|) by handling them accordingly.
636Focus event tracking is disabled by a 't_fd' sequence when exiting "raw" mode.
637If you would like to disable this feature, add the following to your .vimrc:
638 `set t_fd=`
639 `set t_fe=`
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200640If your terminal does support this but Vim does not recognize the terminal,
641you may have to set the options yourself: >
642 let &t_fe = "\<Esc>[?1004h"
643 let &t_fd = "\<Esc>[?1004l"
Bram Moolenaar0e6adf82021-12-16 14:41:10 +0000644 execute "set <FocusGained>=\<Esc>[I"
645 execute "set <FocusLost>=\<Esc>[O"
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200646If this causes garbage to show when Vim starts up then it doesn't work.
Bram Moolenaar681fc3f2021-01-14 17:35:21 +0100647
Bram Moolenaar071d4272004-06-13 20:20:40 +0000648 *termcap-colors*
649Note about colors: The 't_Co' option tells Vim the number of colors available.
650When it is non-zero, the 't_AB' and 't_AF' options are used to set the color.
651If one of these is not available, 't_Sb' and 't_Sf' are used. 't_me' is used
Bram Moolenaar911ead12019-04-21 00:03:35 +0200652to reset to the default colors. Also see 'termguicolors'.
Bram Moolenaar2c7f8c52020-04-20 19:52:53 +0200653When the GUI is running 't_Co' is set to 16777216.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000654
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000655 *termcap-cursor-shape* *termcap-cursor-color*
Bram Moolenaar1e7813a2015-03-31 18:31:03 +0200656When Vim enters Insert mode the 't_SI' escape sequence is sent. When Vim
657enters Replace mode the 't_SR' escape sequence is sent if it is set, otherwise
Bram Moolenaar5ed11532022-07-06 13:18:11 +0100658't_SI' is sent. When leaving Insert mode or Replace mode 't_EI' is used.
659Note: When 't_EI' is not set then 't_SI' and 't_SR' will not be sent. And
660when 't_SI' or 't_SR' is not set then 't_EI' is sent only once.
661
662This can be used to change the shape or color of the cursor in Insert or
663Replace mode. These are not standard termcap/terminfo entries, you need to set
664them yourself.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000665Example for an xterm, this changes the color of the cursor: >
666 if &term =~ "xterm"
667 let &t_SI = "\<Esc>]12;purple\x7"
Bram Moolenaar1e7813a2015-03-31 18:31:03 +0200668 let &t_SR = "\<Esc>]12;red\x7"
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000669 let &t_EI = "\<Esc>]12;blue\x7"
670 endif
671NOTE: When Vim exits the shape for Normal mode will remain. The shape from
672before Vim started will not be restored.
K.Takatadf5320c2022-09-01 13:20:16 +0100673
674For Windows Terminal you can use something like this: >
675 " Note: This should be set after `set termguicolors` or `set t_Co=256`.
676 if &term =~ 'xterm' || &term == 'win32'
677 " Use DECSCUSR escape sequences
678 let &t_SI = "\e[5 q" " blink bar
679 let &t_SR = "\e[3 q" " blink underline
680 let &t_EI = "\e[1 q" " blink block
681 let &t_ti ..= "\e[1 q" " blink block
682 let &t_te ..= "\e[0 q" " default (depends on terminal, normally blink block)
683 endif
684
Bram Moolenaardb84e452010-08-15 13:50:43 +0200685{not available when compiled without the |+cursorshape| feature}
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000686
Bram Moolenaar071d4272004-06-13 20:20:40 +0000687 *termcap-title*
688The 't_ts' and 't_fs' options are used to set the window title if the terminal
689allows title setting via sending strings. They are sent before and after the
690title string, respectively. Similar 't_IS' and 't_IE' are used to set the
691icon text. These are Vim-internal extensions of the Unix termcap, so they
692cannot be obtained from an external termcap. However, the builtin termcap
693contains suitable entries for xterm and iris-ansi, so you don't need to set
694them here.
695 *hpterm*
696If inversion or other highlighting does not work correctly, try setting the
697't_xs' option to a non-empty string. This makes the 't_ce' code be used to
698remove highlighting from a line. This is required for "hpterm". Setting the
699'weirdinvert' option has the same effect as making 't_xs' non-empty, and vice
700versa.
701
702 *scroll-region*
Bram Moolenaar8024f932020-01-14 19:29:13 +0100703Some termcaps do not include an entry for "cs" (scroll region), although the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000704terminal does support it. For example: xterm on a Sun. You can use the
705builtin_xterm or define t_cs yourself. For example: >
706 :set t_cs=^V^[[%i%d;%dr
707Where ^V is CTRL-V and ^[ is <Esc>.
708
709The vertical scroll region t_CV is not a standard termcap code. Vim uses it
710internally in the GUI. But it can also be defined for a terminal, if you can
711find one that supports it. The two arguments are the left and right column of
712the region which to restrict the scrolling to. Just like t_cs defines the top
713and bottom lines. Defining t_CV will make scrolling in vertically split
714windows a lot faster. Don't set t_CV when t_da or t_db is set (text isn't
715cleared when scrolling).
716
717Unfortunately it is not possible to deduce from the termcap how cursor
718positioning should be done when using a scrolling region: Relative to the
719beginning of the screen or relative to the beginning of the scrolling region.
Bram Moolenaar8024f932020-01-14 19:29:13 +0100720Most terminals use the first method. The 't_CS' option should be set to any
721string when cursor positioning is relative to the start of the scrolling
722region. It should be set to an empty string otherwise.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000723
724Note for xterm users: The shifted cursor keys normally don't work. You can
725 make them work with the xmodmap command and some mappings in Vim.
726
727 Give these commands in the xterm:
728 xmodmap -e "keysym Up = Up F13"
729 xmodmap -e "keysym Down = Down F16"
730 xmodmap -e "keysym Left = Left F18"
731 xmodmap -e "keysym Right = Right F19"
732
733 And use these mappings in Vim:
734 :map <t_F3> <S-Up>
735 :map! <t_F3> <S-Up>
736 :map <t_F6> <S-Down>
737 :map! <t_F6> <S-Down>
738 :map <t_F8> <S-Left>
739 :map! <t_F8> <S-Left>
740 :map <t_F9> <S-Right>
741 :map! <t_F9> <S-Right>
742
743Instead of, say, <S-Up> you can use any other command that you want to use the
744shift-cursor-up key for. (Note: To help people that have a Sun keyboard with
745left side keys F14 is not used because it is confused with the undo key; F15
746is not used, because it does a window-to-front; F17 is not used, because it
747closes the window. On other systems you can probably use them.)
748
749==============================================================================
7503. Window size *window-size*
751
752[This is about the size of the whole window Vim is using, not a window that is
753created with the ":split" command.]
754
755If you are running Vim on an Amiga and the terminal name is "amiga" or
756"builtin_amiga", the amiga-specific window resizing will be enabled. On Unix
757systems three methods are tried to get the window size:
758
759- an ioctl call (TIOCGSIZE or TIOCGWINSZ, depends on your system)
760- the environment variables "LINES" and "COLUMNS"
761- from the termcap entries "li" and "co"
762
763If everything fails a default size of 24 lines and 80 columns is assumed. If
764a window-resize signal is received the size will be set again. If the window
765size is wrong you can use the 'lines' and 'columns' options to set the
766correct values.
767
768One command can be used to set the screen size:
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +0200769 *:mod* *:mode* *E359*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000770:mod[e] [mode]
771
772Without argument this only detects the screen size and redraws the screen.
Bram Moolenaar1588bc82022-03-08 21:35:07 +0000773[mode] was used on MS-DOS, but it doesn't work anymore. In |Vim9| this
774command is not supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000775
776==============================================================================
7774. Slow and fast terminals *slow-fast-terminal*
778 *slow-terminal*
779
780If you have a fast terminal you may like to set the 'ruler' option. The
781cursor position is shown in the status line. If you are using horizontal
782scrolling ('wrap' option off) consider setting 'sidescroll' to a small
783number.
784
785If you have a slow terminal you may want to reset the 'showcmd' option.
786The command characters will not be shown in the status line. If the terminal
787scrolls very slowly, set the 'scrolljump' to 5 or so. If the cursor is moved
788off the screen (e.g., with "j") Vim will scroll 5 lines at a time. Another
789possibility is to reduce the number of lines that Vim uses with the command
790"z{height}<CR>".
791
792If the characters from the terminal are arriving with more than 1 second
793between them you might want to set the 'timeout' and/or 'ttimeout' option.
794See the "Options" chapter |options|.
795
796If your terminal does not support a scrolling region, but it does support
797insert/delete line commands, scrolling with multiple windows may make the
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +0000798lines jump up and down. This would happen if the 'ttyfast' option has been
799reset. Check that with: >
800 verbose set ttyfast?
Bram Moolenaar071d4272004-06-13 20:20:40 +0000801
802If your terminal scrolls very slowly, but redrawing is not slow, set the
803'ttyscroll' option to a small number, e.g., 3. This will make Vim redraw the
804screen instead of scrolling, when there are more than 3 lines to be scrolled.
805
806If you are using a color terminal that is slow, use this command: >
807 hi NonText cterm=NONE ctermfg=NONE
808This avoids that spaces are sent when they have different attributes. On most
809terminals you can't see this anyway.
810
811If you are using Vim over a slow serial line, you might want to try running
812Vim inside the "screen" program. Screen will optimize the terminal I/O quite
813a bit.
814
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100815If you are testing termcap options, but you cannot see what is happening, you
816might want to set the 'writedelay' option. When non-zero, one character is
817sent to the terminal at a time. This makes the screen updating a lot slower,
818making it possible to see what is happening.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000819
820==============================================================================
8215. Using the mouse *mouse-using*
822
823This section is about using the mouse on a terminal or a terminal window. How
824to use the mouse in a GUI window is explained in |gui-mouse|. For scrolling
825with a mouse wheel see |scroll-mouse-wheel|.
826
Bram Moolenaar06b5d512010-05-22 15:37:44 +0200827Don't forget to enable the mouse with this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000828 :set mouse=a
829Otherwise Vim won't recognize the mouse in all modes (See 'mouse').
830
Bram Moolenaar446cb832008-06-24 21:56:24 +0000831Currently the mouse is supported for Unix in an xterm window, in a *BSD
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100832console with |sysmouse|, in a Linux console (with GPM |gpm-mouse|), and
833in a Windows console.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000834Mouse clicks can be used to position the cursor, select an area and paste.
835
836These characters in the 'mouse' option tell in which situations the mouse will
837be used by Vim:
838 n Normal mode
839 v Visual mode
840 i Insert mode
841 c Command-line mode
842 h all previous modes when in a help file
843 a all previous modes
844 r for |hit-enter| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +0000845
846The default for 'mouse' is empty, the mouse is not used. Normally you would
847do: >
848 :set mouse=a
849to start using the mouse (this is equivalent to setting 'mouse' to "nvich").
850If you only want to use the mouse in a few modes or also want to use it for
851the two questions you will have to concatenate the letters for those modes.
852For example: >
853 :set mouse=nv
854Will make the mouse work in Normal mode and Visual mode. >
855 :set mouse=h
856Will make the mouse work in help files only (so you can use "g<LeftMouse>" to
857jump to tags).
858
859Whether the selection that is started with the mouse is in Visual mode or
860Select mode depends on whether "mouse" is included in the 'selectmode'
861option.
Bram Moolenaar5b418992019-10-27 18:50:25 +0100862 *terminal-mouse*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000863In an xterm, with the currently active mode included in the 'mouse' option,
864normal mouse clicks are used by Vim, mouse clicks with the shift or ctrl key
865pressed go to the xterm. With the currently active mode not included in
866'mouse' all mouse clicks go to the xterm.
867
Bram Moolenaar5b418992019-10-27 18:50:25 +0100868For terminals where it is not possible to have the mouse events be used by the
869terminal itself by using a modifier, a workaround is to not use mouse events
870for Vim in command-line mode: >
871 :set mouse=nvi
872Then to select text with the terminal, use ":" to go to command-line mode,
873select and copy the text to the system, then press Esc.
874
875Another way is to temporarily use ":sh" to run a shell, copy the text, then
876exit the shell. 'mouse' can remain set to "a" then.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000877 *xterm-clipboard*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100878In the Motif GUI version, when running in a terminal and there is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000879access to the X-server (DISPLAY is set), the copy and paste will behave like
880in the GUI. If not, the middle mouse button will insert the unnamed register.
881In that case, here is how you copy and paste a piece of text:
882
883Copy/paste with the mouse and Visual mode ('mouse' option must be set, see
884above):
8851. Press left mouse button on first letter of text, move mouse pointer to last
886 letter of the text and release the button. This will start Visual mode and
887 highlight the selected area.
8882. Press "y" to yank the Visual text in the unnamed register.
8893. Click the left mouse button at the insert position.
8904. Click the middle mouse button.
891
892Shortcut: If the insert position is on the screen at the same time as the
893Visual text, you can do 2, 3 and 4 all in one: Click the middle mouse button
894at the insert position.
895
896Note: When the |-X| command line argument is used, Vim will not connect to the
897X server and copy/paste to the X clipboard (selection) will not work. Use the
898shift key with the mouse buttons to let the xterm do the selection.
899
900 *xterm-command-server*
901When the X-server clipboard is available, the command server described in
902|x11-clientserver| can be enabled with the --servername command line argument.
903
904 *xterm-copy-paste*
905NOTE: In some (older) xterms, it's not possible to move the cursor past column
Bram Moolenaare968e362014-05-13 20:23:24 +020090695 or 223. This is an xterm problem, not Vim's. Get a newer xterm
907|color-xterm|. Also see |'ttymouse'|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000908
909Copy/paste in xterm with (current mode NOT included in 'mouse'):
9101. Press left mouse button on first letter of text, move mouse pointer to last
911 letter of the text and release the button.
9122. Use normal Vim commands to put the cursor at the insert position.
9133. Press "a" to start Insert mode.
9144. Click the middle mouse button.
9155. Press ESC to end Insert mode.
916(The same can be done with anything in 'mouse' if you keep the shift key
917pressed while using the mouse.)
918
919Note: if you lose the 8th bit when pasting (special characters are translated
920into other characters), you may have to do "stty cs8 -istrip -parenb" in your
921shell before starting Vim.
922
923Thus in an xterm the shift and ctrl keys cannot be used with the mouse. Mouse
924commands requiring the CTRL modifier can be simulated by typing the "g" key
925before using the mouse:
926 "g<LeftMouse>" is "<C-LeftMouse> (jump to tag under mouse click)
927 "g<RightMouse>" is "<C-RightMouse> ("CTRL-T")
928
929 *mouse-mode-table* *mouse-overview*
930A short overview of what the mouse buttons do, when 'mousemodel' is "extend":
931
932Normal Mode:
933event position selection change action ~
934 cursor window ~
935<LeftMouse> yes end yes
936<C-LeftMouse> yes end yes "CTRL-]" (2)
937<S-LeftMouse> yes no change yes "*" (2) *<S-LeftMouse>*
938<LeftDrag> yes start or extend (1) no *<LeftDrag>*
939<LeftRelease> yes start or extend (1) no
940<MiddleMouse> yes if not active no put
941<MiddleMouse> yes if active no yank and put
942<RightMouse> yes start or extend yes
Bram Moolenaar38f18252005-12-14 22:04:43 +0000943<A-RightMouse> yes start or extend blockw. yes *<A-RightMouse>*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000944<S-RightMouse> yes no change yes "#" (2) *<S-RightMouse>*
945<C-RightMouse> no no change no "CTRL-T"
946<RightDrag> yes extend no *<RightDrag>*
947<RightRelease> yes extend no *<RightRelease>*
948
949Insert or Replace Mode:
950event position selection change action ~
951 cursor window ~
952<LeftMouse> yes (cannot be active) yes
953<C-LeftMouse> yes (cannot be active) yes "CTRL-O^]" (2)
954<S-LeftMouse> yes (cannot be active) yes "CTRL-O*" (2)
955<LeftDrag> yes start or extend (1) no like CTRL-O (1)
956<LeftRelease> yes start or extend (1) no like CTRL-O (1)
957<MiddleMouse> no (cannot be active) no put register
958<RightMouse> yes start or extend yes like CTRL-O
Bram Moolenaar38f18252005-12-14 22:04:43 +0000959<A-RightMouse> yes start or extend blockw. yes
Bram Moolenaar071d4272004-06-13 20:20:40 +0000960<S-RightMouse> yes (cannot be active) yes "CTRL-O#" (2)
961<C-RightMouse> no (cannot be active) no "CTRL-O CTRL-T"
962
963In a help window:
964event position selection change action ~
965 cursor window ~
966<2-LeftMouse> yes (cannot be active) no "^]" (jump to help tag)
967
968When 'mousemodel' is "popup", these are different:
969
970Normal Mode:
971event position selection change action ~
972 cursor window ~
973<S-LeftMouse> yes start or extend (1) no
Bram Moolenaar38f18252005-12-14 22:04:43 +0000974<A-LeftMouse> yes start or extend blockw. no *<A-LeftMouse>*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000975<RightMouse> no popup menu no
976
977Insert or Replace Mode:
978event position selection change action ~
979 cursor window ~
980<S-LeftMouse> yes start or extend (1) no like CTRL-O (1)
Bram Moolenaar38f18252005-12-14 22:04:43 +0000981<A-LeftMouse> yes start or extend blockw. no
Bram Moolenaar071d4272004-06-13 20:20:40 +0000982<RightMouse> no popup menu no
983
984(1) only if mouse pointer moved since press
985(2) only if click is in same buffer
986
987Clicking the left mouse button causes the cursor to be positioned. If the
988click is in another window that window is made the active window. When
989editing the command-line the cursor can only be positioned on the
990command-line. When in Insert mode Vim remains in Insert mode. If 'scrolloff'
991is set, and the cursor is positioned within 'scrolloff' lines from the window
992border, the text is scrolled.
993
994A selection can be started by pressing the left mouse button on the first
995character, moving the mouse to the last character, then releasing the mouse
996button. You will not always see the selection until you release the button,
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100997only in some versions (GUI, Win32) will the dragging be shown immediately.
998Note that you can make the text scroll by moving the mouse at least one
999character in the first/last line in the window when 'scrolloff' is non-zero.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001000
1001In Normal, Visual and Select mode clicking the right mouse button causes the
1002Visual area to be extended. When 'mousemodel' is "popup", the left button has
1003to be used while keeping the shift key pressed. When clicking in a window
1004which is editing another buffer, the Visual or Select mode is stopped.
1005
Bram Moolenaar38f18252005-12-14 22:04:43 +00001006In Normal, Visual and Select mode clicking the right mouse button with the alt
Bram Moolenaar9964e462007-05-05 17:54:07 +00001007key pressed causes the Visual area to become blockwise. When 'mousemodel' is
Bram Moolenaar38f18252005-12-14 22:04:43 +00001008"popup" the left button has to be used with the alt key. Note that this won't
Bram Moolenaar06a89a52006-04-29 22:01:03 +00001009work on systems where the window manager consumes the mouse events when the
1010alt key is pressed (it may move the window).
Bram Moolenaar38f18252005-12-14 22:04:43 +00001011
Bram Moolenaar071d4272004-06-13 20:20:40 +00001012 *double-click*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001013Double, triple and quadruple clicks are supported when the GUI is active, for
1014Win32, and for an xterm (if the gettimeofday() function is available). For
1015selecting text, extra clicks extend the selection:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001016 click select ~
1017 double word or % match *<2-LeftMouse>*
1018 triple line *<3-LeftMouse>*
1019 quadruple rectangular block *<4-LeftMouse>*
1020Exception: In a Help window a double click jumps to help for the word that is
1021clicked on.
1022A double click on a word selects that word. 'iskeyword' is used to specify
1023which characters are included in a word. A double click on a character
1024that has a match selects until that match (like using "v%"). If the match is
1025an #if/#else/#endif block, the selection becomes linewise.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001026For MS-Windows and xterm the time for double clicking can be set with the
1027'mousetime' option. For the other systems this time is defined outside of Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001028An example, for using a double click to jump to the tag under the cursor: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001029 :map <2-LeftMouse> :exe "tag " .. expand("<cword>")<CR>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001030
1031Dragging the mouse with a double click (button-down, button-up, button-down
1032and then drag) will result in whole words to be selected. This continues
1033until the button is released, at which point the selection is per character
1034again.
1035
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01001036For scrolling with the mouse see |scroll-mouse-wheel|.
1037
Bram Moolenaar071d4272004-06-13 20:20:40 +00001038 *gpm-mouse*
1039The GPM mouse is only supported when the |+mouse_gpm| feature was enabled at
1040compile time. The GPM mouse driver (Linux console) does not support quadruple
1041clicks.
1042
1043In Insert mode, when a selection is started, Vim goes into Normal mode
1044temporarily. When Visual or Select mode ends, it returns to Insert mode.
1045This is like using CTRL-O in Insert mode. Select mode is used when the
1046'selectmode' option contains "mouse".
Bram Moolenaar446cb832008-06-24 21:56:24 +00001047 *sysmouse*
1048The sysmouse is only supported when the |+mouse_sysmouse| feature was enabled
1049at compile time. The sysmouse driver (*BSD console) does not support keyboard
1050modifiers.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001051
1052 *drag-status-line*
1053When working with several windows, the size of the windows can be changed by
1054dragging the status line with the mouse. Point the mouse at a status line,
1055press the left button, move the mouse to the new position of the status line,
1056release the button. Just clicking the mouse in a status line makes that window
1057the current window, without moving the cursor. If by selecting a window it
1058will change position or size, the dragging of the status line will look
1059confusing, but it will work (just try it).
1060
1061 *<MiddleRelease>* *<MiddleDrag>*
1062Mouse clicks can be mapped. The codes for mouse clicks are:
1063 code mouse button normal action ~
1064 <LeftMouse> left pressed set cursor position
1065 <LeftDrag> left moved while pressed extend selection
1066 <LeftRelease> left released set selection end
1067 <MiddleMouse> middle pressed paste text at cursor position
1068 <MiddleDrag> middle moved while pressed -
1069 <MiddleRelease> middle released -
1070 <RightMouse> right pressed extend selection
1071 <RightDrag> right moved while pressed extend selection
1072 <RightRelease> right released set selection end
1073 <X1Mouse> X1 button pressed - *X1Mouse*
1074 <X1Drag> X1 moved while pressed - *X1Drag*
1075 <X1Release> X1 button release - *X1Release*
1076 <X2Mouse> X2 button pressed - *X2Mouse*
1077 <X2Drag> X2 moved while pressed - *X2Drag*
1078 <X2Release> X2 button release - *X2Release*
1079
1080The X1 and X2 buttons refer to the extra buttons found on some mice. The
1081'Microsoft Explorer' mouse has these buttons available to the right thumb.
Bram Moolenaard042dc82015-11-24 19:18:36 +01001082Currently X1 and X2 only work on Win32 and X11 environments.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001083
1084Examples: >
1085 :noremap <MiddleMouse> <LeftMouse><MiddleMouse>
1086Paste at the position of the middle mouse button click (otherwise the paste
1087would be done at the cursor position). >
1088
1089 :noremap <LeftRelease> <LeftRelease>y
1090Immediately yank the selection, when using Visual mode.
1091
1092Note the use of ":noremap" instead of "map" to avoid a recursive mapping.
1093>
1094 :map <X1Mouse> <C-O>
1095 :map <X2Mouse> <C-I>
1096Map the X1 and X2 buttons to go forwards and backwards in the jump list, see
1097|CTRL-O| and |CTRL-I|.
1098
1099 *mouse-swap-buttons*
1100To swap the meaning of the left and right mouse buttons: >
1101 :noremap <LeftMouse> <RightMouse>
1102 :noremap <LeftDrag> <RightDrag>
1103 :noremap <LeftRelease> <RightRelease>
1104 :noremap <RightMouse> <LeftMouse>
1105 :noremap <RightDrag> <LeftDrag>
1106 :noremap <RightRelease> <LeftRelease>
1107 :noremap g<LeftMouse> <C-RightMouse>
1108 :noremap g<RightMouse> <C-LeftMouse>
1109 :noremap! <LeftMouse> <RightMouse>
1110 :noremap! <LeftDrag> <RightDrag>
1111 :noremap! <LeftRelease> <RightRelease>
1112 :noremap! <RightMouse> <LeftMouse>
1113 :noremap! <RightDrag> <LeftDrag>
1114 :noremap! <RightRelease> <LeftRelease>
1115<
Bram Moolenaar91f84f62018-07-29 15:07:52 +02001116 vim:tw=78:ts=8:noet:ft=help:norl: