blob: fba493c7071eae32a7312acc1f2590c423c55bd1 [file] [log] [blame]
Bram Moolenaar19a09a12005-03-04 23:39:37 +00001*term.txt* For Vim version 7.0aa. Last change: 2005 Mar 04
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
142This requires the key-codes to be sent within 100msec in order to recognize
143them 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==============================================================================
2112. Terminal options *terminal-options* *E436*
212
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
227The options 't_da', 't_db', 't_ms', 't_xs' represent flags in the termcap.
228When the termcap flag is present, the option will be set to "y". But any
229non-empty string means that the flag is set. An empty string means that the
230flag is not set. 't_CS' works like this too, but it isn't a termcap flag.
231
232OUTPUT CODES
233 option meaning ~
234
235 t_AB set background color (ANSI) *t_AB* *'t_AB'*
236 t_AF set foreground color (ANSI) *t_AF* *'t_AF'*
237 t_AL add number of blank lines *t_AL* *'t_AL'*
238 t_al add new blank line *t_al* *'t_al'*
239 t_bc backspace character *t_bc* *'t_bc'*
240 t_cd clear to end of screen *t_cd* *'t_cd'*
241 t_ce clear to end of line *t_ce* *'t_ce'*
242 t_cl clear screen *t_cl* *'t_cl'*
243 t_cm cursor motion (required!) *E437* *t_cm* *'t_cm'*
244 t_Co number of colors *t_Co* *'t_Co'*
245 t_CS if non-empty, cursor relative to scroll region *t_CS* *'t_CS'*
246 t_cs define scrolling region *t_cs* *'t_cs'*
247 t_CV define vertical scrolling region *t_CV* *'t_CV'*
248 t_da if non-empty, lines from above scroll down *t_da* *'t_da'*
249 t_db if non-empty, lines from below scroll up *t_db* *'t_db'*
250 t_DL delete number of lines *t_DL* *'t_DL'*
251 t_dl delete line *t_dl* *'t_dl'*
252 t_fs set window title end (from status line) *t_fs* *'t_fs'*
253 t_ke exit "keypad transmit" mode *t_ke* *'t_ke'*
254 t_ks start "keypad transmit" mode *t_ks* *'t_ks'*
255 t_le move cursor one char left *t_le* *'t_le'*
256 t_mb blinking mode *t_mb* *'t_mb'*
257 t_md bold mode *t_md* *'t_md'*
258 t_me Normal mode (undoes t_mr, t_mb, t_md and color) *t_me* *'t_me'*
259 t_mr reverse (invert) mode *t_mr* *'t_mr'*
260 *t_ms* *'t_ms'*
261 t_ms if non-empty, cursor can be moved in standout/inverse mode
262 t_nd non destructive space character *t_nd* *'t_nd'*
263 t_op reset to original color pair *t_op* *'t_op'*
264 t_RI cursor number of chars right *t_RI* *'t_RI'*
265 t_Sb set background color *t_Sb* *'t_Sb'*
266 t_Sf set foreground color *t_Sf* *'t_Sf'*
267 t_se standout end *t_se* *'t_se'*
268 t_so standout mode *t_so* *'t_so'*
269 t_sr scroll reverse (backward) *t_sr* *'t_sr'*
270 t_te out of "termcap" mode *t_te* *'t_te'*
271 t_ti put terminal in "termcap" mode *t_ti* *'t_ti'*
272 t_ts set window title start (to status line) *t_ts* *'t_ts'*
273 t_ue underline end *t_ue* *'t_ue'*
274 t_us underline mode *t_us* *'t_us'*
275 t_ut clearing uses the current background color *t_ut* *'t_ut'*
276 t_vb visual bell *t_vb* *'t_vb'*
277 t_ve cursor visible *t_ve* *'t_ve'*
278 t_vi cursor invisible *t_vi* *'t_vi'*
279 t_vs cursor very visible *t_vs* *'t_vs'*
280 *t_xs* *'t_xs'*
281 t_xs if non-empty, standout not erased by overwriting (hpterm)
282 t_ZH italics mode *t_ZH* *'t_ZH'*
283 t_ZR italics end *t_ZR* *'t_ZR'*
284
285Added by Vim (there are no standard codes for these):
286 t_IS set icon text start *t_IS* *'t_IS'*
287 t_IE set icon text end *t_IE* *'t_IE'*
288 t_WP set window position (Y, X) in pixels *t_WP* *'t_WP'*
289 t_WS set window size (height, width) in characters *t_WS* *'t_WS'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000290 t_SI start insert mode (bar cursor shape) *t_SI* *'t_SI'*
291 t_EI end insert mode (block cursor shape) *t_EI* *'t_EI'*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000292 t_RV request terminal version string (for xterm) *t_RV* *'t_RV'*
293 |xterm-8bit| |v:termresponse| |'ttymouse'| |xterm-codes|
294
295KEY CODES
296Note: Use the <> form if possible
297
298 option name meaning ~
299
300 t_ku <Up> arrow up *t_ku* *'t_ku'*
301 t_kd <Down> arrow down *t_kd* *'t_kd'*
302 t_kr <Right> arrow right *t_kr* *'t_kr'*
303 t_kl <Left> arrow left *t_kl* *'t_kl'*
304 <S-Up> shift arrow up
305 <S-Down> shift arrow down
306 t_%i <S-Right> shift arrow right *t_%i* *'t_%i'*
307 t_#4 <S-Left> shift arrow left *t_#4* *'t_#4'*
308 t_k1 <F1> function key 1 *t_k1* *'t_k1'*
309 <xF1> alternate F1 *<xF1>*
310 t_k2 <F2> function key 2 *<F2>* *t_k2* *'t_k2'*
311 <xF2> alternate F2 *<xF2>*
312 t_k3 <F3> function key 3 *<F3>* *t_k3* *'t_k3'*
313 <xF3> alternate F3 *<xF3>*
314 t_k4 <F4> function key 4 *<F4>* *t_k4* *'t_k4'*
315 <xF4> alternate F4 *<xF4>*
316 t_k5 <F5> function key 5 *<F5>* *t_k5* *'t_k5'*
317 t_k6 <F6> function key 6 *<F6>* *t_k6* *'t_k6'*
318 t_k7 <F7> function key 7 *<F7>* *t_k7* *'t_k7'*
319 t_k8 <F8> function key 8 *<F8>* *t_k8* *'t_k8'*
320 t_k9 <F9> function key 9 *<F9>* *t_k9* *'t_k9'*
321 t_k; <F10> function key 10 *<F10>* *t_k;* *'t_k;'*
322 t_F1 <F11> function key 11 *<F11>* *t_F1* *'t_F1'*
323 t_F2 <F12> function key 12 *<F12>* *t_F2* *'t_F2'*
324 t_F3 <F13> function key 13 *<F13>* *t_F3* *'t_F3'*
325 t_F4 <F14> function key 14 *<F14>* *t_F4* *'t_F4'*
326 t_F5 <F15> function key 15 *<F15>* *t_F5* *'t_F5'*
327 t_F6 <F16> function key 16 *<F16>* *t_F6* *'t_F6'*
328 t_F7 <F17> function key 17 *<F17>* *t_F7* *'t_F7'*
329 t_F8 <F18> function key 18 *<F18>* *t_F8* *'t_F8'*
330 t_F9 <F19> function key 19 *<F19>* *t_F9* *'t_F9'*
331 <S-F1> shifted function key 1
332 <S-xF1> alternate <S-F1> *<S-xF1>*
333 <S-F2> shifted function key 2 *<S-F2>*
334 <S-xF2> alternate <S-F2> *<S-xF2>*
335 <S-F3> shifted function key 3 *<S-F3>*
336 <S-xF3> alternate <S-F3> *<S-xF3>*
337 <S-F4> shifted function key 4 *<S-F4>*
338 <S-xF4> alternate <S-F4> *<S-xF4>*
339 <S-F5> shifted function key 5 *<S-F5>*
340 <S-F6> shifted function key 6 *<S-F6>*
341 <S-F7> shifted function key 7 *<S-F7>*
342 <S-F8> shifted function key 8 *<S-F8>*
343 <S-F9> shifted function key 9 *<S-F9>*
344 <S-F10> shifted function key 10 *<S-F10>*
345 <S-F11> shifted function key 11 *<S-F11>*
346 <S-F12> shifted function key 12 *<S-F12>*
347 t_%1 <Help> help key *t_%1* *'t_%1'*
348 t_&8 <Undo> undo key *t_&8* *'t_&8'*
349 t_kI <Insert> insert key *t_kI* *'t_kI'*
350 t_kD <Del> delete key *t_kD* *'t_kD'*
351 t_kb <BS> backspace key *t_kb* *'t_kb'*
352 t_kB <S-Tab> back-tab (shift-tab) *<S-Tab>* *t_kB* *'t_kB'*
353 t_kh <Home> home key *t_kh* *'t_kh'*
354 t_#2 <S-Home> shifted home key *<S-Home>* *t_#2* *'t_#2'*
355 <xHome> alternate home key *<xHome>*
356 t_@7 <End> end key *t_@7* *'t_@7'*
357 t_*7 <S-End> shifted end key *<S-End>* *t_star7* *'t_star7'*
358 <xEnd> alternate end key *<xEnd>*
359 t_kP <PageUp> page-up key *t_kP* *'t_kP'*
360 t_kN <PageDown> page-down key *t_kN* *'t_kN'*
361 t_K1 <kHome> keypad home key *t_K1* *'t_K1'*
362 t_K4 <kEnd> keypad end key *t_K4* *'t_K4'*
363 t_K3 <kPageUp> keypad page-up key *t_K3* *'t_K3'*
364 t_K5 <kPageDown> keypad page-down key *t_K5* *'t_K5'*
365 t_K6 <kPlus> keypad plus key *<kPlus>* *t_K6* *'t_K6'*
366 t_K7 <kMinus> keypad minus key *<kMinus>* *t_K7* *'t_K7'*
367 t_K8 <kDivide> keypad divide *<kDivide>* *t_K8* *'t_K8'*
368 t_K9 <kMultiply> keypad multiply *<kMultiply>* *t_K9* *'t_K9'*
369 t_KA <kEnter> keypad enter key *<kEnter>* *t_KA* *'t_KA'*
370 t_KB <kPoint> keypad decimal point *<kPoint>* *t_KB* *'t_KB'*
371 t_KC <k0> keypad 0 *<k0>* *t_KC* *'t_KC'*
372 t_KD <k1> keypad 1 *<k1>* *t_KD* *'t_KD'*
373 t_KE <k2> keypad 2 *<k2>* *t_KE* *'t_KE'*
374 t_KF <k3> keypad 3 *<k3>* *t_KF* *'t_KF'*
375 t_KG <k4> keypad 4 *<k4>* *t_KG* *'t_KG'*
376 t_KH <k5> keypad 5 *<k5>* *t_KH* *'t_KH'*
377 t_KI <k6> keypad 6 *<k6>* *t_KI* *'t_KI'*
378 t_KJ <k7> keypad 7 *<k7>* *t_KJ* *'t_KJ'*
379 t_KK <k8> keypad 8 *<k8>* *t_KK* *'t_KK'*
380 t_KL <k9> keypad 9 *<k9>* *t_KL* *'t_KL'*
381 <Mouse> leader of mouse code *<Mouse>*
382
383Note about t_so and t_mr: When the termcap entry "so" is not present the
384entry for "mr" is used. And vice versa. The same is done for "se" and "me".
385If your terminal supports both inversion and standout mode, you can see two
386different modes. If your terminal supports only one of the modes, both will
387look the same.
388
Bram Moolenaar009b2592004-10-24 19:18:58 +0000389 *keypad-comma*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000390The keypad keys, when they are not mapped, behave like the equivalent normal
Bram Moolenaar009b2592004-10-24 19:18:58 +0000391key. There is one exception: if you have a comma on the keypad instead of a
392decimal point, Vim will use a dot anyway. Use these mappings to fix that: >
393 :noremap <kPoint> ,
394 :noremap! <kPoint> ,
395< *xterm-codes*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000396There is a special trick to obtain the key codes which currently only works
397for xterm. When |t_RV| is defined and a response is received which indicates
398an xterm with patchlevel 141 or higher, Vim uses special escape sequences to
399request the key codes directly from the xterm. The responses are used to
400adjust the various t_ codes. This avoids the problem that the xterm can
401produce different codes, depending on the mode it is in (8-bit, VT102,
402VT220, etc.). The result is that codes like <xF1> are no longer needed.
403Note: This is only done on startup. If the xterm options are changed after
404Vim has started, the escape sequences may not be recognized any more.
405
406 *termcap-colors*
407Note about colors: The 't_Co' option tells Vim the number of colors available.
408When it is non-zero, the 't_AB' and 't_AF' options are used to set the color.
409If one of these is not available, 't_Sb' and 't_Sf' are used. 't_me' is used
410to reset to the default colors.
411
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000412 *termcap-cursor-shape* *termcap-cursor-color*
413When Vim enters Insert mode the 't_SI' escape sequence is sent. When leaving
414Insert mode 't_EI' is used. But only if both are defined. This can be used
415to change the shape or color of the cursor in Insert mode. These are not
416standard termcap/terminfo entries, you need to set them yourself.
417Example for an xterm, this changes the color of the cursor: >
418 if &term =~ "xterm"
419 let &t_SI = "\<Esc>]12;purple\x7"
420 let &t_EI = "\<Esc>]12;blue\x7"
421 endif
422NOTE: When Vim exits the shape for Normal mode will remain. The shape from
423before Vim started will not be restored.
424
Bram Moolenaar071d4272004-06-13 20:20:40 +0000425 *termcap-title*
426The 't_ts' and 't_fs' options are used to set the window title if the terminal
427allows title setting via sending strings. They are sent before and after the
428title string, respectively. Similar 't_IS' and 't_IE' are used to set the
429icon text. These are Vim-internal extensions of the Unix termcap, so they
430cannot be obtained from an external termcap. However, the builtin termcap
431contains suitable entries for xterm and iris-ansi, so you don't need to set
432them here.
433 *hpterm*
434If inversion or other highlighting does not work correctly, try setting the
435't_xs' option to a non-empty string. This makes the 't_ce' code be used to
436remove highlighting from a line. This is required for "hpterm". Setting the
437'weirdinvert' option has the same effect as making 't_xs' non-empty, and vice
438versa.
439
440 *scroll-region*
441Some termcaps do not include an entry for 'cs' (scroll region), although the
442terminal does support it. For example: xterm on a Sun. You can use the
443builtin_xterm or define t_cs yourself. For example: >
444 :set t_cs=^V^[[%i%d;%dr
445Where ^V is CTRL-V and ^[ is <Esc>.
446
447The vertical scroll region t_CV is not a standard termcap code. Vim uses it
448internally in the GUI. But it can also be defined for a terminal, if you can
449find one that supports it. The two arguments are the left and right column of
450the region which to restrict the scrolling to. Just like t_cs defines the top
451and bottom lines. Defining t_CV will make scrolling in vertically split
452windows a lot faster. Don't set t_CV when t_da or t_db is set (text isn't
453cleared when scrolling).
454
455Unfortunately it is not possible to deduce from the termcap how cursor
456positioning should be done when using a scrolling region: Relative to the
457beginning of the screen or relative to the beginning of the scrolling region.
458Most terminals use the first method. A known exception is the MS-DOS console
459(pcterm). The 't_CS' option should be set to any string when cursor
460positioning is relative to the start of the scrolling region. It should be
461set to an empty string otherwise. It defaults to "yes" when 'term' is
462"pcterm".
463
464Note for xterm users: The shifted cursor keys normally don't work. You can
465 make them work with the xmodmap command and some mappings in Vim.
466
467 Give these commands in the xterm:
468 xmodmap -e "keysym Up = Up F13"
469 xmodmap -e "keysym Down = Down F16"
470 xmodmap -e "keysym Left = Left F18"
471 xmodmap -e "keysym Right = Right F19"
472
473 And use these mappings in Vim:
474 :map <t_F3> <S-Up>
475 :map! <t_F3> <S-Up>
476 :map <t_F6> <S-Down>
477 :map! <t_F6> <S-Down>
478 :map <t_F8> <S-Left>
479 :map! <t_F8> <S-Left>
480 :map <t_F9> <S-Right>
481 :map! <t_F9> <S-Right>
482
483Instead of, say, <S-Up> you can use any other command that you want to use the
484shift-cursor-up key for. (Note: To help people that have a Sun keyboard with
485left side keys F14 is not used because it is confused with the undo key; F15
486is not used, because it does a window-to-front; F17 is not used, because it
487closes the window. On other systems you can probably use them.)
488
489==============================================================================
4903. Window size *window-size*
491
492[This is about the size of the whole window Vim is using, not a window that is
493created with the ":split" command.]
494
495If you are running Vim on an Amiga and the terminal name is "amiga" or
496"builtin_amiga", the amiga-specific window resizing will be enabled. On Unix
497systems three methods are tried to get the window size:
498
499- an ioctl call (TIOCGSIZE or TIOCGWINSZ, depends on your system)
500- the environment variables "LINES" and "COLUMNS"
501- from the termcap entries "li" and "co"
502
503If everything fails a default size of 24 lines and 80 columns is assumed. If
504a window-resize signal is received the size will be set again. If the window
505size is wrong you can use the 'lines' and 'columns' options to set the
506correct values.
507
508One command can be used to set the screen size:
509
510 *:mod* *:mode* *E359* *E362*
511:mod[e] [mode]
512
513Without argument this only detects the screen size and redraws the screen.
514With MS-DOS it is possible to switch screen mode. [mode] can be one of these
515values:
516 "bw40" 40 columns black&white
517 "c40" 40 columns color
518 "bw80" 80 columns black&white
519 "c80" 80 columns color (most people use this)
520 "mono" 80 columns monochrome
521 "c4350" 43 or 50 lines EGA/VGA mode
522 number mode number to use, depends on your video card
523
524==============================================================================
5254. Slow and fast terminals *slow-fast-terminal*
526 *slow-terminal*
527
528If you have a fast terminal you may like to set the 'ruler' option. The
529cursor position is shown in the status line. If you are using horizontal
530scrolling ('wrap' option off) consider setting 'sidescroll' to a small
531number.
532
533If you have a slow terminal you may want to reset the 'showcmd' option.
534The command characters will not be shown in the status line. If the terminal
535scrolls very slowly, set the 'scrolljump' to 5 or so. If the cursor is moved
536off the screen (e.g., with "j") Vim will scroll 5 lines at a time. Another
537possibility is to reduce the number of lines that Vim uses with the command
538"z{height}<CR>".
539
540If the characters from the terminal are arriving with more than 1 second
541between them you might want to set the 'timeout' and/or 'ttimeout' option.
542See the "Options" chapter |options|.
543
544If your terminal does not support a scrolling region, but it does support
545insert/delete line commands, scrolling with multiple windows may make the
546lines jump up and down. If you don't want this set the 'ttyfast' option.
547This will redraw the window instead of scroll it.
548
549If your terminal scrolls very slowly, but redrawing is not slow, set the
550'ttyscroll' option to a small number, e.g., 3. This will make Vim redraw the
551screen instead of scrolling, when there are more than 3 lines to be scrolled.
552
553If you are using a color terminal that is slow, use this command: >
554 hi NonText cterm=NONE ctermfg=NONE
555This avoids that spaces are sent when they have different attributes. On most
556terminals you can't see this anyway.
557
558If you are using Vim over a slow serial line, you might want to try running
559Vim inside the "screen" program. Screen will optimize the terminal I/O quite
560a bit.
561
562If you are testing termcap options, but you cannot see what is happening,
563you might want to set the 'writedelay' option. When non-zero, one character
564is sent to the terminal at a time (does not work for MS-DOS). This makes the
565screen updating a lot slower, making it possible to see what is happening.
566
567==============================================================================
5685. Using the mouse *mouse-using*
569
570This section is about using the mouse on a terminal or a terminal window. How
571to use the mouse in a GUI window is explained in |gui-mouse|. For scrolling
572with a mouse wheel see |scroll-mouse-wheel|.
573
574Don't forget to enable the mouse with this commands: >
575 :set mouse=a
576Otherwise Vim won't recognize the mouse in all modes (See 'mouse').
577
578Currently the mouse is supported for Unix in an xterm window, in a Linux
579console (with GPM |gpm-mouse|), for MS-DOS and in a Windows console.
580Mouse clicks can be used to position the cursor, select an area and paste.
581
582These characters in the 'mouse' option tell in which situations the mouse will
583be used by Vim:
584 n Normal mode
585 v Visual mode
586 i Insert mode
587 c Command-line mode
588 h all previous modes when in a help file
589 a all previous modes
590 r for |hit-enter| prompt
591 A auto-select in Visual mode
592
593The default for 'mouse' is empty, the mouse is not used. Normally you would
594do: >
595 :set mouse=a
596to start using the mouse (this is equivalent to setting 'mouse' to "nvich").
597If you only want to use the mouse in a few modes or also want to use it for
598the two questions you will have to concatenate the letters for those modes.
599For example: >
600 :set mouse=nv
601Will make the mouse work in Normal mode and Visual mode. >
602 :set mouse=h
603Will make the mouse work in help files only (so you can use "g<LeftMouse>" to
604jump to tags).
605
606Whether the selection that is started with the mouse is in Visual mode or
607Select mode depends on whether "mouse" is included in the 'selectmode'
608option.
609
610In an xterm, with the currently active mode included in the 'mouse' option,
611normal mouse clicks are used by Vim, mouse clicks with the shift or ctrl key
612pressed go to the xterm. With the currently active mode not included in
613'mouse' all mouse clicks go to the xterm.
614
615 *xterm-clipboard*
616In the Athena and Motif GUI versions, when running in a terminal and there is
617access to the X-server (DISPLAY is set), the copy and paste will behave like
618in the GUI. If not, the middle mouse button will insert the unnamed register.
619In that case, here is how you copy and paste a piece of text:
620
621Copy/paste with the mouse and Visual mode ('mouse' option must be set, see
622above):
6231. Press left mouse button on first letter of text, move mouse pointer to last
624 letter of the text and release the button. This will start Visual mode and
625 highlight the selected area.
6262. Press "y" to yank the Visual text in the unnamed register.
6273. Click the left mouse button at the insert position.
6284. Click the middle mouse button.
629
630Shortcut: If the insert position is on the screen at the same time as the
631Visual text, you can do 2, 3 and 4 all in one: Click the middle mouse button
632at the insert position.
633
634Note: When the |-X| command line argument is used, Vim will not connect to the
635X server and copy/paste to the X clipboard (selection) will not work. Use the
636shift key with the mouse buttons to let the xterm do the selection.
637
638 *xterm-command-server*
639When the X-server clipboard is available, the command server described in
640|x11-clientserver| can be enabled with the --servername command line argument.
641
642 *xterm-copy-paste*
643NOTE: In some (older) xterms, it's not possible to move the cursor past column
64495. This is an xterm problem, not Vim's. Get a newer xterm |color-xterm|.
645
646Copy/paste in xterm with (current mode NOT included in 'mouse'):
6471. Press left mouse button on first letter of text, move mouse pointer to last
648 letter of the text and release the button.
6492. Use normal Vim commands to put the cursor at the insert position.
6503. Press "a" to start Insert mode.
6514. Click the middle mouse button.
6525. Press ESC to end Insert mode.
653(The same can be done with anything in 'mouse' if you keep the shift key
654pressed while using the mouse.)
655
656Note: if you lose the 8th bit when pasting (special characters are translated
657into other characters), you may have to do "stty cs8 -istrip -parenb" in your
658shell before starting Vim.
659
660Thus in an xterm the shift and ctrl keys cannot be used with the mouse. Mouse
661commands requiring the CTRL modifier can be simulated by typing the "g" key
662before using the mouse:
663 "g<LeftMouse>" is "<C-LeftMouse> (jump to tag under mouse click)
664 "g<RightMouse>" is "<C-RightMouse> ("CTRL-T")
665
666 *mouse-mode-table* *mouse-overview*
667A short overview of what the mouse buttons do, when 'mousemodel' is "extend":
668
669Normal Mode:
670event position selection change action ~
671 cursor window ~
672<LeftMouse> yes end yes
673<C-LeftMouse> yes end yes "CTRL-]" (2)
674<S-LeftMouse> yes no change yes "*" (2) *<S-LeftMouse>*
675<LeftDrag> yes start or extend (1) no *<LeftDrag>*
676<LeftRelease> yes start or extend (1) no
677<MiddleMouse> yes if not active no put
678<MiddleMouse> yes if active no yank and put
679<RightMouse> yes start or extend yes
680<S-RightMouse> yes no change yes "#" (2) *<S-RightMouse>*
681<C-RightMouse> no no change no "CTRL-T"
682<RightDrag> yes extend no *<RightDrag>*
683<RightRelease> yes extend no *<RightRelease>*
684
685Insert or Replace Mode:
686event position selection change action ~
687 cursor window ~
688<LeftMouse> yes (cannot be active) yes
689<C-LeftMouse> yes (cannot be active) yes "CTRL-O^]" (2)
690<S-LeftMouse> yes (cannot be active) yes "CTRL-O*" (2)
691<LeftDrag> yes start or extend (1) no like CTRL-O (1)
692<LeftRelease> yes start or extend (1) no like CTRL-O (1)
693<MiddleMouse> no (cannot be active) no put register
694<RightMouse> yes start or extend yes like CTRL-O
695<S-RightMouse> yes (cannot be active) yes "CTRL-O#" (2)
696<C-RightMouse> no (cannot be active) no "CTRL-O CTRL-T"
697
698In a help window:
699event position selection change action ~
700 cursor window ~
701<2-LeftMouse> yes (cannot be active) no "^]" (jump to help tag)
702
703When 'mousemodel' is "popup", these are different:
704
705Normal Mode:
706event position selection change action ~
707 cursor window ~
708<S-LeftMouse> yes start or extend (1) no
709<RightMouse> no popup menu no
710
711Insert or Replace Mode:
712event position selection change action ~
713 cursor window ~
714<S-LeftMouse> yes start or extend (1) no like CTRL-O (1)
715<RightMouse> no popup menu no
716
717(1) only if mouse pointer moved since press
718(2) only if click is in same buffer
719
720Clicking the left mouse button causes the cursor to be positioned. If the
721click is in another window that window is made the active window. When
722editing the command-line the cursor can only be positioned on the
723command-line. When in Insert mode Vim remains in Insert mode. If 'scrolloff'
724is set, and the cursor is positioned within 'scrolloff' lines from the window
725border, the text is scrolled.
726
727A selection can be started by pressing the left mouse button on the first
728character, moving the mouse to the last character, then releasing the mouse
729button. You will not always see the selection until you release the button,
730only in some versions (GUI, MS-DOS, WIN32) will the dragging be shown
731immediately. Note that you can make the text scroll by moving the mouse at
732least one character in the first/last line in the window when 'scrolloff' is
733non-zero.
734
735In Normal, Visual and Select mode clicking the right mouse button causes the
736Visual area to be extended. When 'mousemodel' is "popup", the left button has
737to be used while keeping the shift key pressed. When clicking in a window
738which is editing another buffer, the Visual or Select mode is stopped.
739
740 *double-click*
741Double, triple and quadruple clicks are supported when the GUI is active,
742for MS-DOS and Win32, and for an xterm (if the gettimeofday() function is
743available). For selecting text, extra clicks extend the selection:
744 click select ~
745 double word or % match *<2-LeftMouse>*
746 triple line *<3-LeftMouse>*
747 quadruple rectangular block *<4-LeftMouse>*
748Exception: In a Help window a double click jumps to help for the word that is
749clicked on.
750A double click on a word selects that word. 'iskeyword' is used to specify
751which characters are included in a word. A double click on a character
752that has a match selects until that match (like using "v%"). If the match is
753an #if/#else/#endif block, the selection becomes linewise.
754For MS-DOS and xterm the time for double clicking can be set with the
755'mousetime' option. For the other systems this time is defined outside of
756Vim.
757An example, for using a double click to jump to the tag under the cursor: >
758 :map <2-LeftMouse> :exe "tag ". expand("<cword>")<CR>
759
760Dragging the mouse with a double click (button-down, button-up, button-down
761and then drag) will result in whole words to be selected. This continues
762until the button is released, at which point the selection is per character
763again.
764
765 *gpm-mouse*
766The GPM mouse is only supported when the |+mouse_gpm| feature was enabled at
767compile time. The GPM mouse driver (Linux console) does not support quadruple
768clicks.
769
770In Insert mode, when a selection is started, Vim goes into Normal mode
771temporarily. When Visual or Select mode ends, it returns to Insert mode.
772This is like using CTRL-O in Insert mode. Select mode is used when the
773'selectmode' option contains "mouse".
774
775 *drag-status-line*
776When working with several windows, the size of the windows can be changed by
777dragging the status line with the mouse. Point the mouse at a status line,
778press the left button, move the mouse to the new position of the status line,
779release the button. Just clicking the mouse in a status line makes that window
780the current window, without moving the cursor. If by selecting a window it
781will change position or size, the dragging of the status line will look
782confusing, but it will work (just try it).
783
784 *<MiddleRelease>* *<MiddleDrag>*
785Mouse clicks can be mapped. The codes for mouse clicks are:
786 code mouse button normal action ~
787 <LeftMouse> left pressed set cursor position
788 <LeftDrag> left moved while pressed extend selection
789 <LeftRelease> left released set selection end
790 <MiddleMouse> middle pressed paste text at cursor position
791 <MiddleDrag> middle moved while pressed -
792 <MiddleRelease> middle released -
793 <RightMouse> right pressed extend selection
794 <RightDrag> right moved while pressed extend selection
795 <RightRelease> right released set selection end
796 <X1Mouse> X1 button pressed - *X1Mouse*
797 <X1Drag> X1 moved while pressed - *X1Drag*
798 <X1Release> X1 button release - *X1Release*
799 <X2Mouse> X2 button pressed - *X2Mouse*
800 <X2Drag> X2 moved while pressed - *X2Drag*
801 <X2Release> X2 button release - *X2Release*
802
803The X1 and X2 buttons refer to the extra buttons found on some mice. The
804'Microsoft Explorer' mouse has these buttons available to the right thumb.
805Currently X1 and X2 only work on Win32 environments.
806
807Examples: >
808 :noremap <MiddleMouse> <LeftMouse><MiddleMouse>
809Paste at the position of the middle mouse button click (otherwise the paste
810would be done at the cursor position). >
811
812 :noremap <LeftRelease> <LeftRelease>y
813Immediately yank the selection, when using Visual mode.
814
815Note the use of ":noremap" instead of "map" to avoid a recursive mapping.
816>
817 :map <X1Mouse> <C-O>
818 :map <X2Mouse> <C-I>
819Map the X1 and X2 buttons to go forwards and backwards in the jump list, see
820|CTRL-O| and |CTRL-I|.
821
822 *mouse-swap-buttons*
823To swap the meaning of the left and right mouse buttons: >
824 :noremap <LeftMouse> <RightMouse>
825 :noremap <LeftDrag> <RightDrag>
826 :noremap <LeftRelease> <RightRelease>
827 :noremap <RightMouse> <LeftMouse>
828 :noremap <RightDrag> <LeftDrag>
829 :noremap <RightRelease> <LeftRelease>
830 :noremap g<LeftMouse> <C-RightMouse>
831 :noremap g<RightMouse> <C-LeftMouse>
832 :noremap! <LeftMouse> <RightMouse>
833 :noremap! <LeftDrag> <RightDrag>
834 :noremap! <LeftRelease> <RightRelease>
835 :noremap! <RightMouse> <LeftMouse>
836 :noremap! <RightDrag> <LeftDrag>
837 :noremap! <RightRelease> <LeftRelease>
838<
839 vim:tw=78:ts=8:ft=help:norl: