blob: 8862d0a4006b01b4d627df973ed93b87b4b2434c [file] [log] [blame]
Bram Moolenaar0e6adf82021-12-16 14:41:10 +00001*term.txt* For Vim version 8.2. Last change: 2021 Dec 08
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*
46Which builtin terminals are available depends on a few defines in feature.h,
47which need to be set at compile time:
48 define output of ":version" terminals builtin ~
49NO_BUILTIN_TCAPS -builtin_terms none
50SOME_BUILTIN_TCAPS +builtin_terms most common ones (default)
51ALL_BUILTIN_TCAPS ++builtin_terms all available
52
53You can see a list of available builtin terminals with ":set term=xxx" (when
54not running the GUI). Also see |+builtin_terms|.
55
56If the termcap code is included Vim will try to get the strings for the
57terminal you are using from the termcap file and the builtin termcaps. Both
58are always used, if an entry for the terminal you are using is present. Which
59one is used first depends on the 'ttybuiltin' option:
60
61'ttybuiltin' on 1: builtin termcap 2: external termcap
62'ttybuiltin' off 1: external termcap 2: builtin termcap
63
64If an option is missing in one of them, it will be obtained from the other
65one. If an option is present in both, the one first encountered is used.
66
67Which external termcap file is used varies from system to system and may
68depend on the environment variables "TERMCAP" and "TERMPATH". See "man
69tgetent".
70
71Settings depending on terminal *term-dependent-settings*
72
73If you want to set options or mappings, depending on the terminal name, you
74can do this best in your .vimrc. Example: >
75
76 if &term == "xterm"
77 ... xterm maps and settings ...
78 elseif &term =~ "vt10."
79 ... vt100, vt102 maps and settings ...
80 endif
81<
82 *raw-terminal-mode*
83For normal editing the terminal will be put into "raw" mode. The strings
Bram Moolenaar171a9212019-10-12 21:08:59 +020084defined with 't_ti', 't_TI' and 't_ks' will be sent to the terminal. Normally
85this puts the terminal in a state where the termcap codes are valid and
86activates the cursor and function keys.
87When Vim exits the terminal will be put back into the mode it was before Vim
88started. The strings defined with 't_te', 't_TE' and 't_ke' will be sent to
89the terminal. On the Amiga, with commands that execute an external command
90(e.g., "!!"), the terminal will be put into Normal mode for a moment. This
91means that you can stop the output to the screen by hitting a printing key.
92Output resumes when you hit <BS>.
93
94Note: When 't_ti' is not empty, Vim assumes that it causes switching to the
95alternate screen. This may slightly change what happens when executing a
96shell command or exiting Vim. To avoid this use 't_TI' and 't_TE'.
Bram Moolenaar071d4272004-06-13 20:20:40 +000097
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
297==============================================================================
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002982. Terminal options *terminal-options* *termcap-options* *E436*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000299
300The terminal options can be set just like normal options. But they are not
301shown with the ":set all" command. Instead use ":set termcap".
302
303It is always possible to change individual strings by setting the
304appropriate option. For example: >
305 :set t_ce=^V^[[K (CTRL-V, <Esc>, [, K)
306
Bram Moolenaar071d4272004-06-13 20:20:40 +0000307The options are listed below. The associated termcap code is always equal to
308the last two characters of the option name. Only one termcap code is
309required: Cursor motion, 't_cm'.
310
Bram Moolenaar494838a2015-02-10 19:20:37 +0100311The options 't_da', 't_db', 't_ms', 't_xs', 't_xn' represent flags in the
312termcap. When the termcap flag is present, the option will be set to "y".
313But any non-empty string means that the flag is set. An empty string means
314that the flag is not set. 't_CS' works like this too, but it isn't a termcap
315flag.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000316
Bram Moolenaar214641f2017-03-05 17:04:09 +0100317OUTPUT CODES *terminal-output-codes*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000318 option meaning ~
319
320 t_AB set background color (ANSI) *t_AB* *'t_AB'*
321 t_AF set foreground color (ANSI) *t_AF* *'t_AF'*
322 t_AL add number of blank lines *t_AL* *'t_AL'*
323 t_al add new blank line *t_al* *'t_al'*
324 t_bc backspace character *t_bc* *'t_bc'*
325 t_cd clear to end of screen *t_cd* *'t_cd'*
326 t_ce clear to end of line *t_ce* *'t_ce'*
327 t_cl clear screen *t_cl* *'t_cl'*
328 t_cm cursor motion (required!) *E437* *t_cm* *'t_cm'*
329 t_Co number of colors *t_Co* *'t_Co'*
330 t_CS if non-empty, cursor relative to scroll region *t_CS* *'t_CS'*
331 t_cs define scrolling region *t_cs* *'t_cs'*
332 t_CV define vertical scrolling region *t_CV* *'t_CV'*
333 t_da if non-empty, lines from above scroll down *t_da* *'t_da'*
334 t_db if non-empty, lines from below scroll up *t_db* *'t_db'*
335 t_DL delete number of lines *t_DL* *'t_DL'*
336 t_dl delete line *t_dl* *'t_dl'*
337 t_fs set window title end (from status line) *t_fs* *'t_fs'*
338 t_ke exit "keypad transmit" mode *t_ke* *'t_ke'*
339 t_ks start "keypad transmit" mode *t_ks* *'t_ks'*
340 t_le move cursor one char left *t_le* *'t_le'*
341 t_mb blinking mode *t_mb* *'t_mb'*
342 t_md bold mode *t_md* *'t_md'*
343 t_me Normal mode (undoes t_mr, t_mb, t_md and color) *t_me* *'t_me'*
344 t_mr reverse (invert) mode *t_mr* *'t_mr'*
345 *t_ms* *'t_ms'*
346 t_ms if non-empty, cursor can be moved in standout/inverse mode
347 t_nd non destructive space character *t_nd* *'t_nd'*
348 t_op reset to original color pair *t_op* *'t_op'*
349 t_RI cursor number of chars right *t_RI* *'t_RI'*
350 t_Sb set background color *t_Sb* *'t_Sb'*
351 t_Sf set foreground color *t_Sf* *'t_Sf'*
352 t_se standout end *t_se* *'t_se'*
353 t_so standout mode *t_so* *'t_so'*
354 t_sr scroll reverse (backward) *t_sr* *'t_sr'*
Bram Moolenaar171a9212019-10-12 21:08:59 +0200355 t_te end of "termcap" mode *t_te* *'t_te'*
356 t_ti put terminal into "termcap" mode *t_ti* *'t_ti'*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000357 t_ts set window title start (to status line) *t_ts* *'t_ts'*
358 t_ue underline end *t_ue* *'t_ue'*
359 t_us underline mode *t_us* *'t_us'*
360 t_ut clearing uses the current background color *t_ut* *'t_ut'*
361 t_vb visual bell *t_vb* *'t_vb'*
362 t_ve cursor visible *t_ve* *'t_ve'*
363 t_vi cursor invisible *t_vi* *'t_vi'*
Bram Moolenaarc572da52017-08-27 16:52:01 +0200364 t_vs cursor very visible (blink) *t_vs* *'t_vs'*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000365 *t_xs* *'t_xs'*
366 t_xs if non-empty, standout not erased by overwriting (hpterm)
Bram Moolenaar494838a2015-02-10 19:20:37 +0100367 *t_xn* *'t_xn'*
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100368 t_xn if non-empty, writing a character at the last screen cell
369 does not cause scrolling
Bram Moolenaar071d4272004-06-13 20:20:40 +0000370 t_ZH italics mode *t_ZH* *'t_ZH'*
371 t_ZR italics end *t_ZR* *'t_ZR'*
372
373Added by Vim (there are no standard codes for these):
Bram Moolenaare023e882020-05-31 16:42:30 +0200374 t_AU set underline color (ANSI) *t_AU* *'t_AU'*
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200375 t_Ce undercurl end *t_Ce* *'t_Ce'*
376 t_Cs undercurl mode *t_Cs* *'t_Cs'*
377 t_Te strikethrough end *t_Te* *'t_Te'*
378 t_Ts strikethrough mode *t_Ts* *'t_Ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000379 t_IS set icon text start *t_IS* *'t_IS'*
380 t_IE set icon text end *t_IE* *'t_IE'*
381 t_WP set window position (Y, X) in pixels *t_WP* *'t_WP'*
Bram Moolenaar94237492017-04-23 18:40:21 +0200382 t_GP get window position (Y, X) in pixels *t_GP* *'t_GP'*
Bram Moolenaarb6e0ec62017-07-23 22:12:20 +0200383 t_WS set window size (height, width in cells) *t_WS* *'t_WS'*
Bram Moolenaarc572da52017-08-27 16:52:01 +0200384 t_VS cursor normally visible (no blink) *t_VS* *'t_VS'*
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000385 t_SI start insert mode (bar cursor shape) *t_SI* *'t_SI'*
Bram Moolenaar1e7813a2015-03-31 18:31:03 +0200386 t_SR start replace mode (underline cursor shape) *t_SR* *'t_SR'*
387 t_EI end insert or replace mode (block cursor shape) *t_EI* *'t_EI'*
Bram Moolenaarac6e65f2005-08-29 22:25:38 +0000388 |termcap-cursor-shape|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000389 t_RV request terminal version string (for xterm) *t_RV* *'t_RV'*
Bram Moolenaar2a953fc2019-01-26 17:41:47 +0100390 The response is stored in |v:termresponse|
391 |xterm-8bit| |'ttymouse'| |xterm-codes|
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100392 t_u7 request cursor position (for xterm) *t_u7* *'t_u7'*
393 see |'ambiwidth'|
Bram Moolenaar2a953fc2019-01-26 17:41:47 +0100394 The response is stored in |v:termu7resp|
Bram Moolenaar01164a62017-11-02 22:58:42 +0100395 t_RF request terminal foreground color *t_RF* *'t_RF'*
Bram Moolenaar2a953fc2019-01-26 17:41:47 +0100396 The response is stored in |v:termrfgresp|
Bram Moolenaar979243b2015-06-26 19:35:49 +0200397 t_RB request terminal background color *t_RB* *'t_RB'*
Bram Moolenaar2a953fc2019-01-26 17:41:47 +0100398 The response is stored in |v:termrbgresp|
Bram Moolenaar8a633e32016-04-21 21:10:14 +0200399 t_8f set foreground color (R, G, B) *t_8f* *'t_8f'*
400 |xterm-true-color|
401 t_8b set background color (R, G, B) *t_8b* *'t_8b'*
402 |xterm-true-color|
Bram Moolenaare023e882020-05-31 16:42:30 +0200403 t_8u set underline color (R, G, B) *t_8u* *'t_8u'*
Bram Moolenaarec2da362017-01-21 20:04:22 +0100404 t_BE enable bracketed paste mode *t_BE* *'t_BE'*
405 |xterm-bracketed-paste|
406 t_BD disable bracketed paste mode *t_BD* *'t_BD'*
407 |xterm-bracketed-paste|
Bram Moolenaarc572da52017-08-27 16:52:01 +0200408 t_SC set cursor color start *t_SC* *'t_SC'*
409 t_EC set cursor color end *t_EC* *'t_EC'*
410 t_SH set cursor shape *t_SH* *'t_SH'*
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200411 t_RC request terminal cursor blinking *t_RC* *'t_RC'*
Bram Moolenaar2a953fc2019-01-26 17:41:47 +0100412 The response is stored in |v:termblinkresp|
Bram Moolenaarc572da52017-08-27 16:52:01 +0200413 t_RS request terminal cursor style *t_RS* *'t_RS'*
Bram Moolenaar2a953fc2019-01-26 17:41:47 +0100414 The response is stored in |v:termstyleresp|
Bram Moolenaar40385db2018-08-07 22:31:44 +0200415 t_ST save window title to stack *t_ST* *'t_ST'*
416 t_RT restore window title from stack *t_RT* *'t_RT'*
417 t_Si save icon text to stack *t_Si* *'t_Si'*
418 t_Ri restore icon text from stack *t_Ri* *'t_Ri'*
Bram Moolenaar171a9212019-10-12 21:08:59 +0200419 t_TE end of "raw" mode *t_TE* *'t_TE'*
420 t_TI put terminal into "raw" mode *t_TI* *'t_TI'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +0100421 t_fe enable focus-event tracking *t_fe* *'t_fe'*
Bram Moolenaar681fc3f2021-01-14 17:35:21 +0100422 |xterm-focus-event|
Bram Moolenaar2346a632021-06-13 19:02:49 +0200423 t_fd disable focus-event tracking *t_fd* *'t_fd'*
424 |xterm-focus-event|
Bram Moolenaarc572da52017-08-27 16:52:01 +0200425
426Some codes have a start, middle and end part. The start and end are defined
427by the termcap option, the middle part is text.
428 set title text: t_ts {title text} t_fs
429 set icon text: t_IS {icon text} t_IE
430 set cursor color: t_SC {color name} t_EC
431
432t_SH must take one argument:
433 0, 1 or none blinking block cursor
434 2 block cursor
435 3 blinking underline cursor
436 4 underline cursor
437 5 blinking vertical bar cursor
438 6 vertical bar cursor
439
440t_RS is sent only if the response to t_RV has been received. It is not used
441on Mac OS when Terminal.app could be recognized from the termresponse.
442
Bram Moolenaar071d4272004-06-13 20:20:40 +0000443
Bram Moolenaar214641f2017-03-05 17:04:09 +0100444KEY CODES *terminal-key-codes*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000445Note: Use the <> form if possible
446
447 option name meaning ~
448
449 t_ku <Up> arrow up *t_ku* *'t_ku'*
450 t_kd <Down> arrow down *t_kd* *'t_kd'*
451 t_kr <Right> arrow right *t_kr* *'t_kr'*
452 t_kl <Left> arrow left *t_kl* *'t_kl'*
Bram Moolenaarbc7aa852005-03-06 23:38:09 +0000453 <xUp> alternate arrow up *<xUp>*
454 <xDown> alternate arrow down *<xDown>*
455 <xRight> alternate arrow right *<xRight>*
456 <xLeft> alternate arrow left *<xLeft>*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000457 <S-Up> shift arrow up
458 <S-Down> shift arrow down
459 t_%i <S-Right> shift arrow right *t_%i* *'t_%i'*
460 t_#4 <S-Left> shift arrow left *t_#4* *'t_#4'*
461 t_k1 <F1> function key 1 *t_k1* *'t_k1'*
462 <xF1> alternate F1 *<xF1>*
463 t_k2 <F2> function key 2 *<F2>* *t_k2* *'t_k2'*
464 <xF2> alternate F2 *<xF2>*
465 t_k3 <F3> function key 3 *<F3>* *t_k3* *'t_k3'*
466 <xF3> alternate F3 *<xF3>*
467 t_k4 <F4> function key 4 *<F4>* *t_k4* *'t_k4'*
468 <xF4> alternate F4 *<xF4>*
469 t_k5 <F5> function key 5 *<F5>* *t_k5* *'t_k5'*
470 t_k6 <F6> function key 6 *<F6>* *t_k6* *'t_k6'*
471 t_k7 <F7> function key 7 *<F7>* *t_k7* *'t_k7'*
472 t_k8 <F8> function key 8 *<F8>* *t_k8* *'t_k8'*
473 t_k9 <F9> function key 9 *<F9>* *t_k9* *'t_k9'*
474 t_k; <F10> function key 10 *<F10>* *t_k;* *'t_k;'*
Bram Moolenaarad3b3662013-05-17 18:14:19 +0200475 t_F1 <F11> function key 11 *<F11>* *t_F1* *'t_F1'*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000476 t_F2 <F12> function key 12 *<F12>* *t_F2* *'t_F2'*
477 t_F3 <F13> function key 13 *<F13>* *t_F3* *'t_F3'*
478 t_F4 <F14> function key 14 *<F14>* *t_F4* *'t_F4'*
479 t_F5 <F15> function key 15 *<F15>* *t_F5* *'t_F5'*
480 t_F6 <F16> function key 16 *<F16>* *t_F6* *'t_F6'*
481 t_F7 <F17> function key 17 *<F17>* *t_F7* *'t_F7'*
482 t_F8 <F18> function key 18 *<F18>* *t_F8* *'t_F8'*
483 t_F9 <F19> function key 19 *<F19>* *t_F9* *'t_F9'*
484 <S-F1> shifted function key 1
485 <S-xF1> alternate <S-F1> *<S-xF1>*
486 <S-F2> shifted function key 2 *<S-F2>*
487 <S-xF2> alternate <S-F2> *<S-xF2>*
488 <S-F3> shifted function key 3 *<S-F3>*
489 <S-xF3> alternate <S-F3> *<S-xF3>*
490 <S-F4> shifted function key 4 *<S-F4>*
491 <S-xF4> alternate <S-F4> *<S-xF4>*
492 <S-F5> shifted function key 5 *<S-F5>*
493 <S-F6> shifted function key 6 *<S-F6>*
494 <S-F7> shifted function key 7 *<S-F7>*
495 <S-F8> shifted function key 8 *<S-F8>*
496 <S-F9> shifted function key 9 *<S-F9>*
497 <S-F10> shifted function key 10 *<S-F10>*
498 <S-F11> shifted function key 11 *<S-F11>*
499 <S-F12> shifted function key 12 *<S-F12>*
500 t_%1 <Help> help key *t_%1* *'t_%1'*
501 t_&8 <Undo> undo key *t_&8* *'t_&8'*
502 t_kI <Insert> insert key *t_kI* *'t_kI'*
503 t_kD <Del> delete key *t_kD* *'t_kD'*
504 t_kb <BS> backspace key *t_kb* *'t_kb'*
Bram Moolenaarad3b3662013-05-17 18:14:19 +0200505 t_kB <S-Tab> back-tab (shift-tab) *<S-Tab>* *t_kB* *'t_kB'*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000506 t_kh <Home> home key *t_kh* *'t_kh'*
Bram Moolenaarad3b3662013-05-17 18:14:19 +0200507 t_#2 <S-Home> shifted home key *<S-Home>* *t_#2* *'t_#2'*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000508 <xHome> alternate home key *<xHome>*
509 t_@7 <End> end key *t_@7* *'t_@7'*
510 t_*7 <S-End> shifted end key *<S-End>* *t_star7* *'t_star7'*
511 <xEnd> alternate end key *<xEnd>*
512 t_kP <PageUp> page-up key *t_kP* *'t_kP'*
513 t_kN <PageDown> page-down key *t_kN* *'t_kN'*
514 t_K1 <kHome> keypad home key *t_K1* *'t_K1'*
515 t_K4 <kEnd> keypad end key *t_K4* *'t_K4'*
516 t_K3 <kPageUp> keypad page-up key *t_K3* *'t_K3'*
517 t_K5 <kPageDown> keypad page-down key *t_K5* *'t_K5'*
518 t_K6 <kPlus> keypad plus key *<kPlus>* *t_K6* *'t_K6'*
519 t_K7 <kMinus> keypad minus key *<kMinus>* *t_K7* *'t_K7'*
Bram Moolenaarad3b3662013-05-17 18:14:19 +0200520 t_K8 <kDivide> keypad divide *<kDivide>* *t_K8* *'t_K8'*
521 t_K9 <kMultiply> keypad multiply *<kMultiply>* *t_K9* *'t_K9'*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000522 t_KA <kEnter> keypad enter key *<kEnter>* *t_KA* *'t_KA'*
523 t_KB <kPoint> keypad decimal point *<kPoint>* *t_KB* *'t_KB'*
524 t_KC <k0> keypad 0 *<k0>* *t_KC* *'t_KC'*
525 t_KD <k1> keypad 1 *<k1>* *t_KD* *'t_KD'*
526 t_KE <k2> keypad 2 *<k2>* *t_KE* *'t_KE'*
527 t_KF <k3> keypad 3 *<k3>* *t_KF* *'t_KF'*
528 t_KG <k4> keypad 4 *<k4>* *t_KG* *'t_KG'*
529 t_KH <k5> keypad 5 *<k5>* *t_KH* *'t_KH'*
530 t_KI <k6> keypad 6 *<k6>* *t_KI* *'t_KI'*
531 t_KJ <k7> keypad 7 *<k7>* *t_KJ* *'t_KJ'*
532 t_KK <k8> keypad 8 *<k8>* *t_KK* *'t_KK'*
533 t_KL <k9> keypad 9 *<k9>* *t_KL* *'t_KL'*
534 <Mouse> leader of mouse code *<Mouse>*
Bram Moolenaar214641f2017-03-05 17:04:09 +0100535 *t_PS* *'t_PS'*
536 t_PS start of bracketed paste |xterm-bracketed-paste|
537 t_PE end of bracketed paste |xterm-bracketed-paste| *t_PE* *'t_PE'*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000538
539Note about t_so and t_mr: When the termcap entry "so" is not present the
540entry for "mr" is used. And vice versa. The same is done for "se" and "me".
541If your terminal supports both inversion and standout mode, you can see two
542different modes. If your terminal supports only one of the modes, both will
543look the same.
544
Bram Moolenaar009b2592004-10-24 19:18:58 +0000545 *keypad-comma*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000546The keypad keys, when they are not mapped, behave like the equivalent normal
Bram Moolenaar009b2592004-10-24 19:18:58 +0000547key. There is one exception: if you have a comma on the keypad instead of a
548decimal point, Vim will use a dot anyway. Use these mappings to fix that: >
549 :noremap <kPoint> ,
550 :noremap! <kPoint> ,
551< *xterm-codes*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000552There is a special trick to obtain the key codes which currently only works
553for xterm. When |t_RV| is defined and a response is received which indicates
554an xterm with patchlevel 141 or higher, Vim uses special escape sequences to
555request the key codes directly from the xterm. The responses are used to
556adjust the various t_ codes. This avoids the problem that the xterm can
557produce different codes, depending on the mode it is in (8-bit, VT102,
558VT220, etc.). The result is that codes like <xF1> are no longer needed.
559Note: This is only done on startup. If the xterm options are changed after
Bram Moolenaar8a94d872015-01-25 13:02:57 +0100560Vim has started, the escape sequences may not be recognized anymore.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000561
Bram Moolenaar8a633e32016-04-21 21:10:14 +0200562 *xterm-true-color*
563Vim supports using true colors in the terminal (taken from |highlight-guifg|
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100564and |highlight-guibg|), given that the terminal supports this. To make this
Bram Moolenaar61be73b2016-04-29 22:59:22 +0200565work the 'termguicolors' option needs to be set.
Bram Moolenaar64d8e252016-09-06 22:12:34 +0200566See https://gist.github.com/XVilka/8346728 for a list of terminals that
567support true colors.
Bram Moolenaar8a633e32016-04-21 21:10:14 +0200568
Bram Moolenaar61be73b2016-04-29 22:59:22 +0200569Sometimes setting 'termguicolors' is not enough and one has to set the |t_8f|
570and |t_8b| options explicitly. Default values of these options are
571"^[[38;2;%lu;%lu;%lum" and "^[[48;2;%lu;%lu;%lum" respectively, but it is only
572set when `$TERM` is `xterm`. Some terminals accept the same sequences, but
573with all semicolons replaced by colons (this is actually more compatible, but
574less widely supported): >
Bram Moolenaar64d8e252016-09-06 22:12:34 +0200575 let &t_8f = "\<Esc>[38:2:%lu:%lu:%lum"
576 let &t_8b = "\<Esc>[48:2:%lu:%lu:%lum"
Bram Moolenaar61be73b2016-04-29 22:59:22 +0200577
578These options contain printf strings, with |printf()| (actually, its C
579equivalent hence `l` modifier) invoked with the t_ option value and three
580unsigned long integers that may have any value between 0 and 255 (inclusive)
581representing red, green and blue colors respectively.
Bram Moolenaar8a633e32016-04-21 21:10:14 +0200582
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100583 *xterm-resize*
584Window resizing with xterm only works if the allowWindowOps resource is
585enabled. On some systems and versions of xterm it's disabled by default
586because someone thought it would be a security issue. It's not clear if this
587is actually the case.
588
589To overrule the default, put this line in your ~/.Xdefaults or
590~/.Xresources:
591>
592 XTerm*allowWindowOps: true
593
594And run "xrdb -merge .Xresources" to make it effective. You can check the
595value with the context menu (right mouse button while CTRL key is pressed),
596there should be a tick at allow-window-ops.
597
Bram Moolenaar681fc3f2021-01-14 17:35:21 +0100598 *xterm-focus-event*
599Some terminals including xterm support the focus event tracking feature.
600If this feature is enabled by the 't_fe' sequence, special key sequences are
601sent from the terminal to Vim every time the terminal gains or loses focus.
602Vim fires focus events (|FocusGained|/|FocusLost|) by handling them accordingly.
603Focus event tracking is disabled by a 't_fd' sequence when exiting "raw" mode.
604If you would like to disable this feature, add the following to your .vimrc:
605 `set t_fd=`
606 `set t_fe=`
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200607If your terminal does support this but Vim does not recognize the terminal,
608you may have to set the options yourself: >
609 let &t_fe = "\<Esc>[?1004h"
610 let &t_fd = "\<Esc>[?1004l"
Bram Moolenaar0e6adf82021-12-16 14:41:10 +0000611 execute "set <FocusGained>=\<Esc>[I"
612 execute "set <FocusLost>=\<Esc>[O"
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200613If this causes garbage to show when Vim starts up then it doesn't work.
Bram Moolenaar681fc3f2021-01-14 17:35:21 +0100614
Bram Moolenaar071d4272004-06-13 20:20:40 +0000615 *termcap-colors*
616Note about colors: The 't_Co' option tells Vim the number of colors available.
617When it is non-zero, the 't_AB' and 't_AF' options are used to set the color.
618If one of these is not available, 't_Sb' and 't_Sf' are used. 't_me' is used
Bram Moolenaar911ead12019-04-21 00:03:35 +0200619to reset to the default colors. Also see 'termguicolors'.
Bram Moolenaar2c7f8c52020-04-20 19:52:53 +0200620When the GUI is running 't_Co' is set to 16777216.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000621
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000622 *termcap-cursor-shape* *termcap-cursor-color*
Bram Moolenaar1e7813a2015-03-31 18:31:03 +0200623When Vim enters Insert mode the 't_SI' escape sequence is sent. When Vim
624enters Replace mode the 't_SR' escape sequence is sent if it is set, otherwise
625't_SI' is sent. When leaving Insert mode or Replace mode 't_EI' is used. This
626can be used to change the shape or color of the cursor in Insert or Replace
627mode. These are not standard termcap/terminfo entries, you need to set them
628yourself.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000629Example for an xterm, this changes the color of the cursor: >
630 if &term =~ "xterm"
631 let &t_SI = "\<Esc>]12;purple\x7"
Bram Moolenaar1e7813a2015-03-31 18:31:03 +0200632 let &t_SR = "\<Esc>]12;red\x7"
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000633 let &t_EI = "\<Esc>]12;blue\x7"
634 endif
635NOTE: When Vim exits the shape for Normal mode will remain. The shape from
636before Vim started will not be restored.
Bram Moolenaardb84e452010-08-15 13:50:43 +0200637{not available when compiled without the |+cursorshape| feature}
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000638
Bram Moolenaar071d4272004-06-13 20:20:40 +0000639 *termcap-title*
640The 't_ts' and 't_fs' options are used to set the window title if the terminal
641allows title setting via sending strings. They are sent before and after the
642title string, respectively. Similar 't_IS' and 't_IE' are used to set the
643icon text. These are Vim-internal extensions of the Unix termcap, so they
644cannot be obtained from an external termcap. However, the builtin termcap
645contains suitable entries for xterm and iris-ansi, so you don't need to set
646them here.
647 *hpterm*
648If inversion or other highlighting does not work correctly, try setting the
649't_xs' option to a non-empty string. This makes the 't_ce' code be used to
650remove highlighting from a line. This is required for "hpterm". Setting the
651'weirdinvert' option has the same effect as making 't_xs' non-empty, and vice
652versa.
653
654 *scroll-region*
Bram Moolenaar8024f932020-01-14 19:29:13 +0100655Some termcaps do not include an entry for "cs" (scroll region), although the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000656terminal does support it. For example: xterm on a Sun. You can use the
657builtin_xterm or define t_cs yourself. For example: >
658 :set t_cs=^V^[[%i%d;%dr
659Where ^V is CTRL-V and ^[ is <Esc>.
660
661The vertical scroll region t_CV is not a standard termcap code. Vim uses it
662internally in the GUI. But it can also be defined for a terminal, if you can
663find one that supports it. The two arguments are the left and right column of
664the region which to restrict the scrolling to. Just like t_cs defines the top
665and bottom lines. Defining t_CV will make scrolling in vertically split
666windows a lot faster. Don't set t_CV when t_da or t_db is set (text isn't
667cleared when scrolling).
668
669Unfortunately it is not possible to deduce from the termcap how cursor
670positioning should be done when using a scrolling region: Relative to the
671beginning of the screen or relative to the beginning of the scrolling region.
Bram Moolenaar8024f932020-01-14 19:29:13 +0100672Most terminals use the first method. The 't_CS' option should be set to any
673string when cursor positioning is relative to the start of the scrolling
674region. It should be set to an empty string otherwise.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000675
676Note for xterm users: The shifted cursor keys normally don't work. You can
677 make them work with the xmodmap command and some mappings in Vim.
678
679 Give these commands in the xterm:
680 xmodmap -e "keysym Up = Up F13"
681 xmodmap -e "keysym Down = Down F16"
682 xmodmap -e "keysym Left = Left F18"
683 xmodmap -e "keysym Right = Right F19"
684
685 And use these mappings in Vim:
686 :map <t_F3> <S-Up>
687 :map! <t_F3> <S-Up>
688 :map <t_F6> <S-Down>
689 :map! <t_F6> <S-Down>
690 :map <t_F8> <S-Left>
691 :map! <t_F8> <S-Left>
692 :map <t_F9> <S-Right>
693 :map! <t_F9> <S-Right>
694
695Instead of, say, <S-Up> you can use any other command that you want to use the
696shift-cursor-up key for. (Note: To help people that have a Sun keyboard with
697left side keys F14 is not used because it is confused with the undo key; F15
698is not used, because it does a window-to-front; F17 is not used, because it
699closes the window. On other systems you can probably use them.)
700
701==============================================================================
7023. Window size *window-size*
703
704[This is about the size of the whole window Vim is using, not a window that is
705created with the ":split" command.]
706
707If you are running Vim on an Amiga and the terminal name is "amiga" or
708"builtin_amiga", the amiga-specific window resizing will be enabled. On Unix
709systems three methods are tried to get the window size:
710
711- an ioctl call (TIOCGSIZE or TIOCGWINSZ, depends on your system)
712- the environment variables "LINES" and "COLUMNS"
713- from the termcap entries "li" and "co"
714
715If everything fails a default size of 24 lines and 80 columns is assumed. If
716a window-resize signal is received the size will be set again. If the window
717size is wrong you can use the 'lines' and 'columns' options to set the
718correct values.
719
720One command can be used to set the screen size:
721
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +0200722 *:mod* *:mode* *E359*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000723:mod[e] [mode]
724
725Without argument this only detects the screen size and redraws the screen.
Bram Moolenaar8024f932020-01-14 19:29:13 +0100726[mode] was used on MS-DOS, but it doesn't work anymore.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000727
728==============================================================================
7294. Slow and fast terminals *slow-fast-terminal*
730 *slow-terminal*
731
732If you have a fast terminal you may like to set the 'ruler' option. The
733cursor position is shown in the status line. If you are using horizontal
734scrolling ('wrap' option off) consider setting 'sidescroll' to a small
735number.
736
737If you have a slow terminal you may want to reset the 'showcmd' option.
738The command characters will not be shown in the status line. If the terminal
739scrolls very slowly, set the 'scrolljump' to 5 or so. If the cursor is moved
740off the screen (e.g., with "j") Vim will scroll 5 lines at a time. Another
741possibility is to reduce the number of lines that Vim uses with the command
742"z{height}<CR>".
743
744If the characters from the terminal are arriving with more than 1 second
745between them you might want to set the 'timeout' and/or 'ttimeout' option.
746See the "Options" chapter |options|.
747
748If your terminal does not support a scrolling region, but it does support
749insert/delete line commands, scrolling with multiple windows may make the
750lines jump up and down. If you don't want this set the 'ttyfast' option.
751This will redraw the window instead of scroll it.
752
753If your terminal scrolls very slowly, but redrawing is not slow, set the
754'ttyscroll' option to a small number, e.g., 3. This will make Vim redraw the
755screen instead of scrolling, when there are more than 3 lines to be scrolled.
756
757If you are using a color terminal that is slow, use this command: >
758 hi NonText cterm=NONE ctermfg=NONE
759This avoids that spaces are sent when they have different attributes. On most
760terminals you can't see this anyway.
761
762If you are using Vim over a slow serial line, you might want to try running
763Vim inside the "screen" program. Screen will optimize the terminal I/O quite
764a bit.
765
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100766If you are testing termcap options, but you cannot see what is happening, you
767might want to set the 'writedelay' option. When non-zero, one character is
768sent to the terminal at a time. This makes the screen updating a lot slower,
769making it possible to see what is happening.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000770
771==============================================================================
7725. Using the mouse *mouse-using*
773
774This section is about using the mouse on a terminal or a terminal window. How
775to use the mouse in a GUI window is explained in |gui-mouse|. For scrolling
776with a mouse wheel see |scroll-mouse-wheel|.
777
Bram Moolenaar06b5d512010-05-22 15:37:44 +0200778Don't forget to enable the mouse with this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000779 :set mouse=a
780Otherwise Vim won't recognize the mouse in all modes (See 'mouse').
781
Bram Moolenaar446cb832008-06-24 21:56:24 +0000782Currently the mouse is supported for Unix in an xterm window, in a *BSD
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100783console with |sysmouse|, in a Linux console (with GPM |gpm-mouse|), and
784in a Windows console.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000785Mouse clicks can be used to position the cursor, select an area and paste.
786
787These characters in the 'mouse' option tell in which situations the mouse will
788be used by Vim:
789 n Normal mode
790 v Visual mode
791 i Insert mode
792 c Command-line mode
793 h all previous modes when in a help file
794 a all previous modes
795 r for |hit-enter| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +0000796
797The default for 'mouse' is empty, the mouse is not used. Normally you would
798do: >
799 :set mouse=a
800to start using the mouse (this is equivalent to setting 'mouse' to "nvich").
801If you only want to use the mouse in a few modes or also want to use it for
802the two questions you will have to concatenate the letters for those modes.
803For example: >
804 :set mouse=nv
805Will make the mouse work in Normal mode and Visual mode. >
806 :set mouse=h
807Will make the mouse work in help files only (so you can use "g<LeftMouse>" to
808jump to tags).
809
810Whether the selection that is started with the mouse is in Visual mode or
811Select mode depends on whether "mouse" is included in the 'selectmode'
812option.
Bram Moolenaar5b418992019-10-27 18:50:25 +0100813 *terminal-mouse*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000814In an xterm, with the currently active mode included in the 'mouse' option,
815normal mouse clicks are used by Vim, mouse clicks with the shift or ctrl key
816pressed go to the xterm. With the currently active mode not included in
817'mouse' all mouse clicks go to the xterm.
818
Bram Moolenaar5b418992019-10-27 18:50:25 +0100819For terminals where it is not possible to have the mouse events be used by the
820terminal itself by using a modifier, a workaround is to not use mouse events
821for Vim in command-line mode: >
822 :set mouse=nvi
823Then to select text with the terminal, use ":" to go to command-line mode,
824select and copy the text to the system, then press Esc.
825
826Another way is to temporarily use ":sh" to run a shell, copy the text, then
827exit the shell. 'mouse' can remain set to "a" then.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000828 *xterm-clipboard*
829In the Athena and Motif GUI versions, when running in a terminal and there is
830access to the X-server (DISPLAY is set), the copy and paste will behave like
831in the GUI. If not, the middle mouse button will insert the unnamed register.
832In that case, here is how you copy and paste a piece of text:
833
834Copy/paste with the mouse and Visual mode ('mouse' option must be set, see
835above):
8361. Press left mouse button on first letter of text, move mouse pointer to last
837 letter of the text and release the button. This will start Visual mode and
838 highlight the selected area.
8392. Press "y" to yank the Visual text in the unnamed register.
8403. Click the left mouse button at the insert position.
8414. Click the middle mouse button.
842
843Shortcut: If the insert position is on the screen at the same time as the
844Visual text, you can do 2, 3 and 4 all in one: Click the middle mouse button
845at the insert position.
846
847Note: When the |-X| command line argument is used, Vim will not connect to the
848X server and copy/paste to the X clipboard (selection) will not work. Use the
849shift key with the mouse buttons to let the xterm do the selection.
850
851 *xterm-command-server*
852When the X-server clipboard is available, the command server described in
853|x11-clientserver| can be enabled with the --servername command line argument.
854
855 *xterm-copy-paste*
856NOTE: In some (older) xterms, it's not possible to move the cursor past column
Bram Moolenaare968e362014-05-13 20:23:24 +020085795 or 223. This is an xterm problem, not Vim's. Get a newer xterm
858|color-xterm|. Also see |'ttymouse'|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000859
860Copy/paste in xterm with (current mode NOT included in 'mouse'):
8611. Press left mouse button on first letter of text, move mouse pointer to last
862 letter of the text and release the button.
8632. Use normal Vim commands to put the cursor at the insert position.
8643. Press "a" to start Insert mode.
8654. Click the middle mouse button.
8665. Press ESC to end Insert mode.
867(The same can be done with anything in 'mouse' if you keep the shift key
868pressed while using the mouse.)
869
870Note: if you lose the 8th bit when pasting (special characters are translated
871into other characters), you may have to do "stty cs8 -istrip -parenb" in your
872shell before starting Vim.
873
874Thus in an xterm the shift and ctrl keys cannot be used with the mouse. Mouse
875commands requiring the CTRL modifier can be simulated by typing the "g" key
876before using the mouse:
877 "g<LeftMouse>" is "<C-LeftMouse> (jump to tag under mouse click)
878 "g<RightMouse>" is "<C-RightMouse> ("CTRL-T")
879
880 *mouse-mode-table* *mouse-overview*
881A short overview of what the mouse buttons do, when 'mousemodel' is "extend":
882
883Normal Mode:
884event position selection change action ~
885 cursor window ~
886<LeftMouse> yes end yes
887<C-LeftMouse> yes end yes "CTRL-]" (2)
888<S-LeftMouse> yes no change yes "*" (2) *<S-LeftMouse>*
889<LeftDrag> yes start or extend (1) no *<LeftDrag>*
890<LeftRelease> yes start or extend (1) no
891<MiddleMouse> yes if not active no put
892<MiddleMouse> yes if active no yank and put
893<RightMouse> yes start or extend yes
Bram Moolenaar38f18252005-12-14 22:04:43 +0000894<A-RightMouse> yes start or extend blockw. yes *<A-RightMouse>*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000895<S-RightMouse> yes no change yes "#" (2) *<S-RightMouse>*
896<C-RightMouse> no no change no "CTRL-T"
897<RightDrag> yes extend no *<RightDrag>*
898<RightRelease> yes extend no *<RightRelease>*
899
900Insert or Replace Mode:
901event position selection change action ~
902 cursor window ~
903<LeftMouse> yes (cannot be active) yes
904<C-LeftMouse> yes (cannot be active) yes "CTRL-O^]" (2)
905<S-LeftMouse> yes (cannot be active) yes "CTRL-O*" (2)
906<LeftDrag> yes start or extend (1) no like CTRL-O (1)
907<LeftRelease> yes start or extend (1) no like CTRL-O (1)
908<MiddleMouse> no (cannot be active) no put register
909<RightMouse> yes start or extend yes like CTRL-O
Bram Moolenaar38f18252005-12-14 22:04:43 +0000910<A-RightMouse> yes start or extend blockw. yes
Bram Moolenaar071d4272004-06-13 20:20:40 +0000911<S-RightMouse> yes (cannot be active) yes "CTRL-O#" (2)
912<C-RightMouse> no (cannot be active) no "CTRL-O CTRL-T"
913
914In a help window:
915event position selection change action ~
916 cursor window ~
917<2-LeftMouse> yes (cannot be active) no "^]" (jump to help tag)
918
919When 'mousemodel' is "popup", these are different:
920
921Normal Mode:
922event position selection change action ~
923 cursor window ~
924<S-LeftMouse> yes start or extend (1) no
Bram Moolenaar38f18252005-12-14 22:04:43 +0000925<A-LeftMouse> yes start or extend blockw. no *<A-LeftMouse>*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000926<RightMouse> no popup menu no
927
928Insert or Replace Mode:
929event position selection change action ~
930 cursor window ~
931<S-LeftMouse> yes start or extend (1) no like CTRL-O (1)
Bram Moolenaar38f18252005-12-14 22:04:43 +0000932<A-LeftMouse> yes start or extend blockw. no
Bram Moolenaar071d4272004-06-13 20:20:40 +0000933<RightMouse> no popup menu no
934
935(1) only if mouse pointer moved since press
936(2) only if click is in same buffer
937
938Clicking the left mouse button causes the cursor to be positioned. If the
939click is in another window that window is made the active window. When
940editing the command-line the cursor can only be positioned on the
941command-line. When in Insert mode Vim remains in Insert mode. If 'scrolloff'
942is set, and the cursor is positioned within 'scrolloff' lines from the window
943border, the text is scrolled.
944
945A selection can be started by pressing the left mouse button on the first
946character, moving the mouse to the last character, then releasing the mouse
947button. You will not always see the selection until you release the button,
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100948only in some versions (GUI, Win32) will the dragging be shown immediately.
949Note that you can make the text scroll by moving the mouse at least one
950character in the first/last line in the window when 'scrolloff' is non-zero.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000951
952In Normal, Visual and Select mode clicking the right mouse button causes the
953Visual area to be extended. When 'mousemodel' is "popup", the left button has
954to be used while keeping the shift key pressed. When clicking in a window
955which is editing another buffer, the Visual or Select mode is stopped.
956
Bram Moolenaar38f18252005-12-14 22:04:43 +0000957In Normal, Visual and Select mode clicking the right mouse button with the alt
Bram Moolenaar9964e462007-05-05 17:54:07 +0000958key pressed causes the Visual area to become blockwise. When 'mousemodel' is
Bram Moolenaar38f18252005-12-14 22:04:43 +0000959"popup" the left button has to be used with the alt key. Note that this won't
Bram Moolenaar06a89a52006-04-29 22:01:03 +0000960work on systems where the window manager consumes the mouse events when the
961alt key is pressed (it may move the window).
Bram Moolenaar38f18252005-12-14 22:04:43 +0000962
Bram Moolenaar071d4272004-06-13 20:20:40 +0000963 *double-click*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100964Double, triple and quadruple clicks are supported when the GUI is active, for
965Win32, and for an xterm (if the gettimeofday() function is available). For
966selecting text, extra clicks extend the selection:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000967 click select ~
968 double word or % match *<2-LeftMouse>*
969 triple line *<3-LeftMouse>*
970 quadruple rectangular block *<4-LeftMouse>*
971Exception: In a Help window a double click jumps to help for the word that is
972clicked on.
973A double click on a word selects that word. 'iskeyword' is used to specify
974which characters are included in a word. A double click on a character
975that has a match selects until that match (like using "v%"). If the match is
976an #if/#else/#endif block, the selection becomes linewise.
Bram Moolenaar8024f932020-01-14 19:29:13 +0100977For MS-Windows and xterm the time for double clicking can be set with the
978'mousetime' option. For the other systems this time is defined outside of Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000979An example, for using a double click to jump to the tag under the cursor: >
980 :map <2-LeftMouse> :exe "tag ". expand("<cword>")<CR>
981
982Dragging the mouse with a double click (button-down, button-up, button-down
983and then drag) will result in whole words to be selected. This continues
984until the button is released, at which point the selection is per character
985again.
986
987 *gpm-mouse*
988The GPM mouse is only supported when the |+mouse_gpm| feature was enabled at
989compile time. The GPM mouse driver (Linux console) does not support quadruple
990clicks.
991
992In Insert mode, when a selection is started, Vim goes into Normal mode
993temporarily. When Visual or Select mode ends, it returns to Insert mode.
994This is like using CTRL-O in Insert mode. Select mode is used when the
995'selectmode' option contains "mouse".
Bram Moolenaar446cb832008-06-24 21:56:24 +0000996 *sysmouse*
997The sysmouse is only supported when the |+mouse_sysmouse| feature was enabled
998at compile time. The sysmouse driver (*BSD console) does not support keyboard
999modifiers.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001000
1001 *drag-status-line*
1002When working with several windows, the size of the windows can be changed by
1003dragging the status line with the mouse. Point the mouse at a status line,
1004press the left button, move the mouse to the new position of the status line,
1005release the button. Just clicking the mouse in a status line makes that window
1006the current window, without moving the cursor. If by selecting a window it
1007will change position or size, the dragging of the status line will look
1008confusing, but it will work (just try it).
1009
1010 *<MiddleRelease>* *<MiddleDrag>*
1011Mouse clicks can be mapped. The codes for mouse clicks are:
1012 code mouse button normal action ~
1013 <LeftMouse> left pressed set cursor position
1014 <LeftDrag> left moved while pressed extend selection
1015 <LeftRelease> left released set selection end
1016 <MiddleMouse> middle pressed paste text at cursor position
1017 <MiddleDrag> middle moved while pressed -
1018 <MiddleRelease> middle released -
1019 <RightMouse> right pressed extend selection
1020 <RightDrag> right moved while pressed extend selection
1021 <RightRelease> right released set selection end
1022 <X1Mouse> X1 button pressed - *X1Mouse*
1023 <X1Drag> X1 moved while pressed - *X1Drag*
1024 <X1Release> X1 button release - *X1Release*
1025 <X2Mouse> X2 button pressed - *X2Mouse*
1026 <X2Drag> X2 moved while pressed - *X2Drag*
1027 <X2Release> X2 button release - *X2Release*
1028
1029The X1 and X2 buttons refer to the extra buttons found on some mice. The
1030'Microsoft Explorer' mouse has these buttons available to the right thumb.
Bram Moolenaard042dc82015-11-24 19:18:36 +01001031Currently X1 and X2 only work on Win32 and X11 environments.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001032
1033Examples: >
1034 :noremap <MiddleMouse> <LeftMouse><MiddleMouse>
1035Paste at the position of the middle mouse button click (otherwise the paste
1036would be done at the cursor position). >
1037
1038 :noremap <LeftRelease> <LeftRelease>y
1039Immediately yank the selection, when using Visual mode.
1040
1041Note the use of ":noremap" instead of "map" to avoid a recursive mapping.
1042>
1043 :map <X1Mouse> <C-O>
1044 :map <X2Mouse> <C-I>
1045Map the X1 and X2 buttons to go forwards and backwards in the jump list, see
1046|CTRL-O| and |CTRL-I|.
1047
1048 *mouse-swap-buttons*
1049To swap the meaning of the left and right mouse buttons: >
1050 :noremap <LeftMouse> <RightMouse>
1051 :noremap <LeftDrag> <RightDrag>
1052 :noremap <LeftRelease> <RightRelease>
1053 :noremap <RightMouse> <LeftMouse>
1054 :noremap <RightDrag> <LeftDrag>
1055 :noremap <RightRelease> <LeftRelease>
1056 :noremap g<LeftMouse> <C-RightMouse>
1057 :noremap g<RightMouse> <C-LeftMouse>
1058 :noremap! <LeftMouse> <RightMouse>
1059 :noremap! <LeftDrag> <RightDrag>
1060 :noremap! <LeftRelease> <RightRelease>
1061 :noremap! <RightMouse> <LeftMouse>
1062 :noremap! <RightDrag> <LeftDrag>
1063 :noremap! <RightRelease> <LeftRelease>
1064<
Bram Moolenaar91f84f62018-07-29 15:07:52 +02001065 vim:tw=78:ts=8:noet:ft=help:norl: