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