vim

Fork of vim, an acceptable text editor
git clone git://git.laack.co/vim.git
Log | Files | Refs | README | LICENSE

term.txt (56821B)


      1 *term.txt*	For Vim version 9.2.  Last change: 2026 Sep 10
      2 
      3 
      4 		  VIM REFERENCE MANUAL	  by Bram Moolenaar
      5 
      6 
      7 Terminal information					*terminal-info*
      8 
      9 Vim uses information about the terminal you are using to fill the screen and
     10 recognize what keys you hit.  If this information is not correct, the screen
     11 may be messed up or keys may not be recognized.  The actions which have to be
     12 performed on the screen are accomplished by outputting a string of
     13 characters.  Special keys produce a string of characters.  These strings are
     14 stored in the terminal options, see |terminal-options|.
     15 
     16 NOTE: Most of this is not used when running the |GUI|.
     17 
     18 1. Startup			|startup-terminal|
     19 2. Terminal options		|terminal-options|
     20 3. Window size			|window-size|
     21 4. Slow and fast terminals	|slow-fast-terminal|
     22 5. Using the mouse		|mouse-using|
     23 
     24 ==============================================================================
     25 1. Startup						*startup-terminal*
     26 
     27 When Vim is started a default terminal type is assumed.  For the Amiga this is
     28 a standard CLI window, for MS-Windows the pc terminal, for Unix an ansi
     29 terminal.  A few other terminal types are always available, see below
     30 |builtin-terms|.
     31 
     32 You can give the terminal name with the '-T' Vim argument.  If it is not given
     33 Vim will try to get the name from the TERM environment variable.
     34 
     35 				*termcap* *terminfo* *E557* *E558* *E559*
     36 On 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,
     38 the choice whether to use terminfo or termcap is done automatically.  When
     39 running Vim the output of ":version" will show |+terminfo| if terminfo is
     40 used.  Also see |xterm-screens|.
     41 
     42 On non-Unix systems a termcap is only available if Vim was compiled with
     43 TERMCAP defined.
     44 
     45 					*builtin-terms* *builtin_terms*
     46 A number of builtin terminals are available.  Since patch 9.0.0280 there is no
     47 difference between Vim versions.  You can see a list of available builtin
     48 terminals in the error message you get for `:set term=xxx` (when not running
     49 the GUI).  Also see |++builtin_terms|.
     50 
     51 If the termcap code is included Vim will try to get the strings for the
     52 terminal you are using from the termcap file and the builtin termcaps.  Both
     53 are always used, if an entry for the terminal you are using is present.  Which
     54 one is used first depends on the 'ttybuiltin' option:
     55 
     56 'ttybuiltin' on		1: builtin termcap	2: external termcap
     57 'ttybuiltin' off	1: external termcap	2: builtin termcap
     58 
     59 If an option is missing in one of them, it will be obtained from the other
     60 one.  If an option is present in both, the one first encountered is used.
     61 
     62 Which external termcap file is used varies from system to system and may
     63 depend on the environment variables "TERMCAP" and "TERMPATH".  See "man
     64 tgetent".
     65 
     66 Settings depending on terminal			*term-dependent-settings*
     67 
     68 If you want to set options or mappings, depending on the terminal name, you
     69 can do this best in your .vimrc.  Example: >
     70 
     71    if &term == "xterm"
     72      ... xterm maps and settings ...
     73    elseif &term =~ "vt10."
     74      ... vt100, vt102 maps and settings ...
     75    endif
     76 <
     77 						*raw-terminal-mode*
     78 For normal editing the terminal will be put into "raw" mode.  The strings
     79 defined with 't_ti', 't_TI' and 't_ks' will be sent to the terminal.  Normally
     80 this puts the terminal in a state where the termcap codes are valid and
     81 activates the cursor and function keys.
     82 When Vim exits the terminal will be put back into the mode it was before Vim
     83 started.  The strings defined with 't_te', 't_TE' and 't_ke' will be sent to
     84 the terminal.  On the Amiga, with commands that execute an external command
     85 (e.g., "!!"), the terminal will be put into Normal mode for a moment.  This
     86 means that you can stop the output to the screen by hitting a printing key.
     87 Output resumes when you hit <BS>.
     88 
     89 Note: When 't_ti' is not empty, Vim assumes that it causes switching to the
     90 alternate screen.  This may slightly change what happens when executing a
     91 shell command or exiting Vim.  To avoid this use 't_TI' and 't_TE' (but make
     92 sure to add to them, not overwrite).
     93 
     94 Vim will try to detect what keyboard protocol the terminal is using with the
     95 't_RK' termcap entry.  This is sent after 't_TI', but only when there is no
     96 work to do (no typeahead and no pending commands).  That is to avoid the
     97 response to end up in a shell command or arrive after Vim exits.
     98 
     99 						*xterm-bracketed-paste*
    100 When the 't_BE' option is set then 't_BE' will be sent to the
    101 terminal when entering "raw" mode and 't_BD' when leaving "raw" mode.  The
    102 terminal is then expected to put 't_PS' before pasted text and 't_PE' after
    103 pasted text.  This way Vim can separate text that is pasted from characters
    104 that are typed.  The pasted text is handled like when the middle mouse button
    105 is used, it is inserted literally and not interpreted as commands.
    106 
    107 Please note: while bracketed paste is trying to prevent nasty side-effects
    108 from pasting (like the CTRL-C or <ESC> key), it's not a guaranteed security
    109 measure because different terminals may implement this mode slightly
    110 differently.  You should still be careful with what you paste into Vim.
    111 
    112 When the cursor is in the first column, the pasted text will be inserted
    113 before it.  Otherwise the pasted text is appended after the cursor position.
    114 This means one cannot paste after the first column.  Unfortunately Vim does
    115 not have a way to tell where the mouse pointer was.
    116 
    117 Note that in some situations Vim will not recognize the bracketed paste and
    118 you will get the raw text.  In other situations Vim will only get the first
    119 pasted character and drop the rest, e.g. when using the "r" command.  If you
    120 have a problem with this, disable bracketed paste by putting this in your
    121 .vimrc: >
    122 	set t_BE=
    123 If this is done while Vim is running the 't_BD' will be sent to the terminal
    124 to disable bracketed paste.
    125 
    126 If |t_PS| or |t_PE| is not set, then |t_BE| will not be used.  This is to make
    127 sure that bracketed paste is not enabled when the escape codes surrounding
    128 pasted text cannot be recognized.
    129 
    130 Note: bracketed paste mode will be disabled, when the 'esckeys' option is not
    131 set (also when the 'compatible' option is set).
    132 
    133 If your terminal supports bracketed paste, but the options are not set
    134 automatically, you can try using something like this: >
    135 
    136 	if &term =~ "screen"
    137 	  let &t_BE = "\e[?2004h"
    138 	  let &t_BD = "\e[?2004l"
    139 	  exec "set t_PS=\e[200~"
    140 	  exec "set t_PE=\e[201~"
    141 	endif
    142 
    143 The terminfo entries "BE", "BD", "PS" and "PE" were added in ncurses version
    144 6.4, early 2023, for some terminals.  If you have this version then you may
    145 not have to manually configure your terminal.
    146 
    147 							*tmux-integration*
    148 If you experience issues when running Vim inside tmux, here are a few hints.
    149 You can comment-out parts if something doesn't work (it may depend on the
    150 terminal that tmux is running in): >
    151 
    152     if !has('gui_running') && &term =~ '^\%(screen\|tmux\)'
    153         " Better mouse support, see  :help 'ttymouse'
    154         set ttymouse=sgr
    155 
    156         " Enable true colors, see  :help xterm-true-color
    157         let &termguicolors = v:true
    158         let &t_8f = "\<Esc>[38;2;%lu;%lu;%lum"
    159         let &t_8b = "\<Esc>[48;2;%lu;%lu;%lum"
    160 
    161         " Enable bracketed paste mode, see  :help xterm-bracketed-paste
    162         let &t_BE = "\<Esc>[?2004h"
    163         let &t_BD = "\<Esc>[?2004l"
    164         let &t_PS = "\<Esc>[200~"
    165         let &t_PE = "\<Esc>[201~"
    166 
    167         " Enable focus event tracking, see  :help xterm-focus-event
    168         let &t_fe = "\<Esc>[?1004h"
    169         let &t_fd = "\<Esc>[?1004l"
    170 	execute "set <FocusGained>=\<Esc>[I"
    171         execute "set <FocusLost>=\<Esc>[O"
    172 
    173         " Enable modified arrow keys, see  :help arrow_modifiers
    174         execute "silent! set <xUp>=\<Esc>[@;*A"
    175         execute "silent! set <xDown>=\<Esc>[@;*B"
    176         execute "silent! set <xRight>=\<Esc>[@;*C"
    177         execute "silent! set <xLeft>=\<Esc>[@;*D"
    178     endif
    179 <
    180 							*cs7-problem*
    181 Note: If the terminal settings are changed after running Vim, you might have
    182 an illegal combination of settings.  This has been reported on Solaris 2.5
    183 with "stty cs8 parenb", which is restored as "stty cs7 parenb".  Use
    184 "stty cs8 -parenb -istrip" instead, this is restored correctly.
    185 
    186 Some termcap entries are wrong in the sense that after sending 't_ks' the
    187 cursor keys send codes different from the codes defined in the termcap.  To
    188 avoid this you can set 't_ks' (and 't_ke') to empty strings.  This must be
    189 done during initialization (see |initialization|), otherwise it's too late.
    190 
    191 Some termcap entries assume that the highest bit is always reset.  For
    192 example: The cursor-up entry for the Amiga could be ":ku=\E[A:".  But the
    193 Amiga really sends "\233A".  This works fine if the highest bit is reset,
    194 e.g., when using an Amiga over a serial line.  If the cursor keys don't work,
    195 try the entry ":ku=\233A:".
    196 
    197 Some termcap entries have the entry ":ku=\E[A:".  But the Amiga really sends
    198 "\233A".  On output "\E[" and "\233" are often equivalent, on input they
    199 aren't.  You will have to change the termcap entry, or change the key code
    200 with the :set command to fix this.
    201 
    202 Many cursor key codes start with an <Esc>.  Vim must find out if this is a
    203 single hit of the <Esc> key or the start of a cursor key sequence.  It waits
    204 for a next character to arrive.  If it does not arrive within one second a
    205 single <Esc> is assumed.  On very slow systems this may fail, causing cursor
    206 keys not to work sometimes.  If you discover this problem reset the 'timeout'
    207 option.  Vim will wait for the next character to arrive after an <Esc>.  If
    208 you want to enter a single <Esc> you must type it twice.  Resetting the
    209 'esckeys' option avoids this problem in Insert mode, but you lose the
    210 possibility to use cursor and function keys in Insert mode.
    211 
    212 On the Amiga the recognition of window resizing is activated only when the
    213 terminal name is "amiga" or "builtin_amiga".
    214 
    215 Some terminals have confusing codes for the cursor keys.  The televideo 925 is
    216 such a terminal.  It sends a CTRL-H for cursor-left.  This would make it
    217 impossible to distinguish a backspace and cursor-left.  To avoid this problem
    218 CTRL-H is never recognized as cursor-left.
    219 
    220 					*vt100-cursor-keys* *xterm-cursor-keys*
    221 Other terminals (e.g., vt100 and xterm) have cursor keys that send <Esc>OA,
    222 <Esc>OB, etc.  Unfortunately these are valid commands in insert mode: Stop
    223 insert, Open a new line above the new one, start inserting 'A', 'B', etc.
    224 Instead of performing these commands Vim will erroneously recognize this typed
    225 key sequence as a cursor key movement.  To avoid this and make Vim do what you
    226 want in either case you could use these settings: >
    227 	:set notimeout		" don't timeout on mappings
    228 	:set ttimeout		" do timeout on terminal key codes
    229 	:set timeoutlen=100	" timeout after 100 msec
    230 This requires the key-codes to be sent within 100 msec in order to recognize
    231 them as a cursor key.  When you type you normally are not that fast, so they
    232 are recognized as individual typed commands, even though Vim receives the same
    233 sequence of bytes.
    234 
    235 				*vt100-function-keys* *xterm-function-keys*
    236 An xterm can send function keys F1 to F4 in two modes: vt100 compatible or
    237 not.  Because Vim may not know what the xterm is sending, both types of keys
    238 are recognized.  The same happens for the <Home> and <End> keys.
    239 			normal			vt100 ~
    240 	<F1>	t_k1	<Esc>[11~	<xF1>	<Esc>OP	    *<xF1>-xterm*
    241 	<F2>	t_k2	<Esc>[12~	<xF2>	<Esc>OQ	    *<xF2>-xterm*
    242 	<F3>	t_k3	<Esc>[13~	<xF3>	<Esc>OR	    *<xF3>-xterm*
    243 	<F4>	t_k4	<Esc>[14~	<xF4>	<Esc>OS	    *<xF4>-xterm*
    244 	<Home>	t_kh	<Esc>[7~	<xHome>	<Esc>OH	    *<xHome>-xterm*
    245 	<End>	t_@7	<Esc>[4~	<xEnd>	<Esc>OF	    *<xEnd>-xterm*
    246 
    247 When Vim starts, <xF1> is mapped to <F1>, <xF2> to <F2> etc.  This means that
    248 by default both codes do the same thing.  If you make a mapping for <xF2>,
    249 because your terminal does have two keys, the default mapping is overwritten,
    250 thus you can use the <F2> and <xF2> keys for something different.
    251 
    252 							*xterm-shifted-keys*
    253 Newer versions of xterm support shifted function keys and special keys.  Vim
    254 recognizes most of them.  Use ":set termcap" to check which are supported and
    255 what the codes are.  Mostly these are not in a termcap, they are only
    256 supported by the builtin_xterm termcap.
    257 
    258 							*xterm-modifier-keys*
    259 Newer versions of xterm support Alt and Ctrl for most function keys.  To avoid
    260 having to add all combinations of Alt, Ctrl and Shift for every key a special
    261 sequence is recognized at the end of a termcap entry: ";*X".  The "X" can be
    262 any character, often '~' is used.  The ";*" stands for an optional modifier
    263 argument.  ";2" is Shift, ";3" is Alt, ";5" is Ctrl and ";9" is Meta (when
    264 it's different from Alt).  They can be combined.  Examples: >
    265 	:set <F8>=^[[19;*~
    266 	:set <Home>=^[[1;*H
    267 Another speciality about these codes is that they are not overwritten by
    268 another code.  That is to avoid that the codes obtained from xterm directly
    269 |t_RV| overwrite them.
    270 
    271 Another special value is a termcap entry ending in "@;*X".  This is for cursor
    272 keys, which either use "CSI X" or "CSI 1 ; modifier X".  Thus the "@"
    273 stands for either "1" if a modifier follows, or nothing.
    274 							*arrow_modifiers*
    275 Several terminal emulators (alacritty, gnome, konsole, etc.) send special
    276 codes for keys with modifiers, but these do not have an entry in the
    277 termcap/terminfo database.  You can make them work by adding a few lines in
    278 your vimrc.  For example, to make the Control modifier work with arrow keys
    279 for the gnome terminal: >
    280 	if &term =~ 'gnome'
    281 	   execute "set <xUp>=\<Esc>[@;*A"
    282 	   execute "set <xDown>=\<Esc>[@;*B"
    283 	   execute "set <xRight>=\<Esc>[@;*C"
    284 	   execute "set <xLeft>=\<Esc>[@;*D"
    285 	endif
    286 <							*xterm-scroll-region*
    287 The default termcap entry for xterm on Sun and other platforms does not
    288 contain the entry for scroll regions.  Add ":cs=\E[%i%d;%dr:" to the xterm
    289 entry in /etc/termcap and everything should work.
    290 
    291 							*xterm-end-home-keys*
    292 On some systems (at least on FreeBSD with XFree86 3.1.2) the codes that the
    293 <End> and <Home> keys send contain a <Nul> character.  To make these keys send
    294 the proper key code, add these lines to your ~/.Xdefaults file:
    295 >
    296 	*VT100.Translations:		#override \n\
    297 			<Key>Home: string("0x1b") string("[7~") \n\
    298 			<Key>End: string("0x1b") string("[8~")
    299 <
    300 						*xterm-8bit* *xterm-8-bit*
    301 Xterm can be run in a mode where it uses 8-bit escape sequences.  The CSI code
    302 is used instead of <Esc>[.  The advantage is that an <Esc> can quickly be
    303 recognized in Insert mode, because it can't be confused with the start of a
    304 special key.
    305 For the builtin termcap entries, Vim checks if the 'term' option contains
    306 "8bit" anywhere.  It then uses 8-bit characters for the termcap entries, the
    307 mouse and a few other things.  You would normally set $TERM in your shell to
    308 "xterm-8bit" and Vim picks this up and adjusts to the 8-bit setting
    309 automatically.
    310 When Vim receives a response to the |t_RV| (request version) sequence and it
    311 starts with CSI, it assumes that the terminal is in 8-bit mode and will
    312 convert all key sequences to their 8-bit variants.
    313 
    314 						*xterm-terminfo-entries*
    315 For some time the terminfo entries were insufficient to describe all the
    316 features that Vim can use.  The builtin xterm termcap entries did have these,
    317 with the result that several terminals that were similar enough to xterm took
    318 advantage of these by prefixing "xterm-" to the terminal name in $TERM.
    319 
    320 This leads to problems, because quite often these terminals are not 100%
    321 compatible with xterm.  At the start of 2023 several entries have been added
    322 to the terminfo database to make it possible to use these features without
    323 using the "xterm" workaround.  These are the relevant entries (so far):
    324 
    325 	name	xterm value	description ~
    326 	RV	"\033[>c"	Request version |t_RV|
    327 
    328 	BE	"\033[?2004h"	enable bracketed paste mode |t_BE|
    329 	BD	"\033[?2004l"	disable bracketed paste mode |t_BD|
    330 	PS	"\033[200~"	pasted text start |t_PS|
    331 	PE	"\033[201~"	pasted text end |t_PE|
    332 
    333 	XM	"\033[?1006;1004;1000%?%p1%{1}%=%th%el%;"
    334 				mouse enable / disable |t_XM|
    335 	FE	"\033[?1004h"	enable focus event tracking |t_fe|
    336 	FD	"\033[?1004l"	disable focus event tracking |t_fd|
    337 
    338 The "XM" entry includes "1006" to enable SGR style mouse reporting.  This
    339 supports columns above 223.  It also includes "1004" which enables focus
    340 reporting.
    341 Note: As of 2023, the "1004" is currently not used by Vim itself, instead
    342 it is recommended to set focus reporting independently of mouse tracking by
    343 the |t_fe| and |t_fd| entries, as ncurses also starts to use with the latest
    344 versions (and will then also end up in terminfo/termcap).
    345 
    346 						*xterm-kitty* *kitty-terminal*
    347 The Kitty terminal is a special case.  Mainly because it works differently
    348 from most other terminals, but also because, instead of trying to fit in and
    349 make it behave like other terminals by default, it dictates how applications
    350 need to work when using Kitty.  This makes it very difficult for Vim to work
    351 in a Kitty terminal.  Some exceptions have been hard coded, but it is not at
    352 all nice to have to make exceptions for one specific terminal.
    353 
    354 One of the problems is that the value for $TERM is set to "xterm-kitty".  For
    355 Vim this is an indication that the terminal is xterm-compatible and the
    356 builtin xterm termcap entries should be used.  Many other terminals depend on
    357 this.  However, Kitty is not fully xterm compatible.  The author suggested to
    358 ignore the "xterm-" prefix and use the terminfo entry anyway, so that is what
    359 happens now, the builtin xterm termcap entries are not used.  However, the
    360 t_RV is set, otherwise other things would not work, such as automatically
    361 setting 'ttymouse' to "sgr" (at least until |t_XM| is being used for this).
    362 
    363 It is not clear why kitty sets $TERM to "xterm-kitty", the terminal isn't
    364 really xterm compatible.  "kitty" would be more appropriate, but a terminfo
    365 entry with that name is not widespread.
    366 
    367 Note that using the kitty keyboard protocol is a separate feature, see
    368 |kitty-keyboard-protocol|.
    369 
    370 
    371 ==============================================================================
    372 2. Terminal options		*terminal-options* *termcap-options* *E436*
    373 
    374 The terminal options can be set just like normal options.  But they are not
    375 shown with the ":set all" command.  Instead use ":set termcap".
    376 
    377 It is always possible to change individual strings by setting the
    378 appropriate option.  For example: >
    379 	:set t_ce=^V^[[K	(CTRL-V, <Esc>, [, K)
    380 
    381 The options are listed below.  The associated termcap code is always equal to
    382 the last two characters of the option name.  Only one termcap code is
    383 required: Cursor motion, 't_cm'.
    384 
    385 The options 't_da', 't_db', 't_ms', 't_xs', 't_xn', 't_xo' represent flags in
    386 the termcap.  When the termcap flag is present, the option will be set to "y".
    387 But any non-empty string means that the flag is set.  An empty string means
    388 that the flag is not set.  't_CS' works like this too, but it isn't a termcap
    389 flag.
    390 
    391 OUTPUT CODES						*terminal-output-codes*
    392 	option	meaning	~
    393 
    394 	t_AB	set background color (ANSI)			*t_AB* *'t_AB'*
    395 	t_AF	set foreground color (ANSI)			*t_AF* *'t_AF'*
    396 	t_AL	add number of blank lines			*t_AL* *'t_AL'*
    397 	t_al	add new blank line				*t_al* *'t_al'*
    398 	t_bc	backspace character				*t_bc* *'t_bc'*
    399 	t_cd	clear to end of screen				*t_cd* *'t_cd'*
    400 	t_ce	clear to end of line				*t_ce* *'t_ce'*
    401 	t_cl	clear screen					*t_cl* *'t_cl'*
    402 	t_cm	cursor motion (required!)		  *E437* *t_cm* *'t_cm'*
    403 	t_Co	number of colors				*t_Co* *'t_Co'*
    404 	t_CS	if non-empty, cursor relative to scroll region	*t_CS* *'t_CS'*
    405 	t_cs	define scrolling region				*t_cs* *'t_cs'*
    406 	t_CV	define vertical scrolling region		*t_CV* *'t_CV'*
    407 	t_da	if non-empty, lines from above scroll down	*t_da* *'t_da'*
    408 	t_db	if non-empty, lines from below scroll up	*t_db* *'t_db'*
    409 	t_DL	delete number of lines				*t_DL* *'t_DL'*
    410 	t_dl	delete line					*t_dl* *'t_dl'*
    411 	t_fs	set window title end (from status line)		*t_fs* *'t_fs'*
    412 	t_ke	exit "keypad transmit" mode			*t_ke* *'t_ke'*
    413 	t_ks	start "keypad transmit" mode			*t_ks* *'t_ks'*
    414 	t_le	move cursor one char left			*t_le* *'t_le'*
    415 	t_mb	blinking mode					*t_mb* *'t_mb'*
    416 	t_md	bold mode					*t_md* *'t_md'*
    417 	t_me	Normal mode (undoes t_mr, t_mb, t_md and color)	*t_me* *'t_me'*
    418 	t_mr	reverse (invert) mode				*t_mr* *'t_mr'*
    419 								*t_ms* *'t_ms'*
    420 	t_ms	if non-empty, cursor can be moved in standout/inverse mode
    421 	t_nd	non destructive space character			*t_nd* *'t_nd'*
    422 	t_op	reset to original color pair			*t_op* *'t_op'*
    423 	t_RI	cursor number of chars right			*t_RI* *'t_RI'*
    424 	t_Sb	set background color				*t_Sb* *'t_Sb'*
    425 	t_Sf	set foreground color				*t_Sf* *'t_Sf'*
    426 	t_se	standout end					*t_se* *'t_se'*
    427 	t_so	standout mode					*t_so* *'t_so'*
    428 	t_sr	scroll reverse (backward)			*t_sr* *'t_sr'*
    429 	t_te	end of "termcap" mode				*t_te* *'t_te'*
    430 	t_ti	put terminal into "termcap" mode		*t_ti* *'t_ti'*
    431 	t_ts	set window title start (to status line)		*t_ts* *'t_ts'*
    432 	t_ue	underline end					*t_ue* *'t_ue'*
    433 	t_us	underline mode					*t_us* *'t_us'*
    434 	t_ut	clearing uses the current background color	*t_ut* *'t_ut'*
    435 	t_vb	visual bell					*t_vb* *'t_vb'*
    436 	t_ve	cursor visible					*t_ve* *'t_ve'*
    437 	t_vi	cursor invisible				*t_vi* *'t_vi'*
    438 	t_vs	cursor very visible (blink)			*t_vs* *'t_vs'*
    439 								*t_xs* *'t_xs'*
    440 	t_xs	if non-empty, standout not erased by overwriting (hpterm)
    441 								*t_xn* *'t_xn'*
    442 	t_xn	if non-empty, writing a character at the last screen cell
    443 		does not cause scrolling
    444 								*t_xo* *'t_xo'*
    445 	t_xo	if non-empty, terminal uses xon/xoff handshaking, mapping
    446 		CTRL-S will not be possible then, since it is used for flow
    447 		control (used by vt420 terminal).  Setting this flag has only
    448 		an effect when starting Vim.
    449 	t_ZH	italics mode					*t_ZH* *'t_ZH'*
    450 	t_ZR	italics end					*t_ZR* *'t_ZR'*
    451 
    452 Added by Vim (there are no standard codes for these):
    453 	t_AU	set underline color (ANSI)			*t_AU* *'t_AU'*
    454 	t_Ce	undercurl and underline end			*t_Ce* *'t_Ce'*
    455 	t_Cs	undercurl (curly underline) mode		*t_Cs* *'t_Cs'*
    456 	t_CF	set alternate font (using index 0 - 10)		*t_CF* *'t_CF'*
    457 	t_Us	double underline mode				*t_Us* *'t_Us'*
    458 	t_ds	dotted underline mode				*t_ds* *'t_ds'*
    459 	t_Ds	dashed underline mode				*t_Ds* *'t_Ds'*
    460 	t_Te	strikethrough end				*t_Te* *'t_Te'*
    461 	t_Ts	strikethrough mode				*t_Ts* *'t_Ts'*
    462 	t_IS	set icon text start				*t_IS* *'t_IS'*
    463 	t_IE	set icon text end				*t_IE* *'t_IE'*
    464 	t_WP	set window position (Y, X) in pixels		*t_WP* *'t_WP'*
    465 	t_GP	get window position (Y, X) in pixels		*t_GP* *'t_GP'*
    466 	t_WS	set window size (height, width in cells)	*t_WS* *'t_WS'*
    467 	t_VS	cursor normally visible (no blink)		*t_VS* *'t_VS'*
    468 	t_SI	start insert mode (bar cursor shape)		*t_SI* *'t_SI'*
    469 	t_SR	start replace mode (underline cursor shape)	*t_SR* *'t_SR'*
    470 	t_EI	end insert or replace mode (block cursor shape)	*t_EI* *'t_EI'*
    471 		|termcap-cursor-shape|
    472 	t_RV	request terminal version string (works for	*t_RV* *'t_RV'*
    473 		xterm and other terminal emulators)  The
    474 		response is stored in |v:termresponse| |xterm-8bit|
    475 		'ttymouse' |xterm-codes|
    476 	t_XM	enable/disable mouse reporting,			*t_XM* *'t_XM'*
    477 		see |mouse-reporting| below
    478 	t_RK	request terminal keyboard protocol state;	*t_RK* *'t_RK'*
    479 		sent after |t_TI|
    480 	t_u7	request cursor position (for xterm)		*t_u7* *'t_u7'*
    481 		see 'ambiwidth'
    482 		The response is stored in |v:termu7resp|
    483 	t_RF	request terminal foreground color		*t_RF* *'t_RF'*
    484 		The response is stored in |v:termrfgresp|
    485 	t_RB	request terminal background color		*t_RB* *'t_RB'*
    486 		The response is stored in |v:termrbgresp|
    487 	t_8f	set foreground color (R, G, B)			*t_8f* *'t_8f'*
    488 		|xterm-true-color|
    489 	t_8b	set background color (R, G, B)			*t_8b* *'t_8b'*
    490 		|xterm-true-color|
    491 	t_8u	set underline color (R, G, B)			*t_8u* *'t_8u'*
    492 	t_BE	enable bracketed paste mode			*t_BE* *'t_BE'*
    493 		|xterm-bracketed-paste|
    494 	t_BD	disable bracketed paste mode			*t_BD* *'t_BD'*
    495 		|xterm-bracketed-paste|
    496 	t_SC	set cursor color start				*t_SC* *'t_SC'*
    497 	t_EC	set cursor color end				*t_EC* *'t_EC'*
    498 	t_SH	set cursor shape				*t_SH* *'t_SH'*
    499 	t_RC	request terminal cursor blinking		*t_RC* *'t_RC'*
    500 		The response is stored in |v:termblinkresp|
    501 	t_RS	request terminal cursor style			*t_RS* *'t_RS'*
    502 		The response is stored in |v:termstyleresp|
    503 	t_ST	save window title to stack			*t_ST* *'t_ST'*
    504 	t_RT	restore window title from stack			*t_RT* *'t_RT'*
    505 	t_Si	save icon text to stack				*t_Si* *'t_Si'*
    506 	t_Ri	restore icon text from stack			*t_Ri* *'t_Ri'*
    507 	t_TE	end of "raw" mode				*t_TE* *'t_TE'*
    508 	t_TI	put terminal into "raw" mode			*t_TI* *'t_TI'*
    509 	t_fe	enable focus-event tracking			*t_fe* *'t_fe'*
    510 		|xterm-focus-event|
    511 	t_fd	disable focus-event tracking			*t_fd* *'t_fd'*
    512 		|xterm-focus-event|
    513 	t_BS	begin synchronized update			*t_BS* *'t_BS'*
    514 		see 'termsync'
    515 	t_ES	end synchronized update				*t_ES* *'t_ES'*
    516 		see 'termsync'
    517 
    518 Some codes have a start, middle and end part.  The start and end are defined
    519 by the termcap option, the middle part is text.
    520 	set title text:     t_ts {title text} t_fs
    521 	set icon text:      t_IS {icon text} t_IE
    522 	set cursor color:   t_SC  {color name}  t_EC
    523 
    524 t_SH must take one argument:
    525 	0, 1 or none	blinking block cursor
    526 	2		block cursor
    527 	3		blinking underline cursor
    528 	4		underline cursor
    529 	5		blinking vertical bar cursor
    530 	6		vertical bar cursor
    531 
    532 t_RS is sent only if the response to t_RV has been received.  It is not used
    533 on Mac OS when Terminal.app could be recognized from the termresponse.
    534 
    535 The t_BS and t_ES are not stored in the termcap, but are instead set to the
    536 following default values on startup:
    537 	t_BS		"\033[?2026h"
    538 	t_ES		"\033[?2026l"
    539 
    540 							*mouse-reporting*
    541 Many terminals can report mouse clicks and some can report mouse movement and
    542 dragging.  Vim needs to know what codes are being used for this.
    543 
    544 The "XM" terminfo/termcap entry is used for this.  Vim also has the 'ttymouse'
    545 option to specify the mouse protocol being used.  See the option for the
    546 possible values.
    547 
    548 If Vim can read the "XM" terminfo/termcap entry then it will be used for
    549 enabling and disabling the mouse reporting.  If it is missing, then the value
    550 from 'ttymouse' is used to decide how to do this.
    551 
    552 If the "XM" entry exists and the first number is "1006" then 'ttymouse' will
    553 be set to "sgr", unless it was already set earlier.
    554 
    555 
    556 KEY CODES						*terminal-key-codes*
    557 Note: Use the <> form if possible
    558 
    559 	option	name		meaning	~
    560 
    561 	t_ku	<Up>		arrow up			*t_ku* *'t_ku'*
    562 	t_kd	<Down>		arrow down			*t_kd* *'t_kd'*
    563 	t_kr	<Right>		arrow right			*t_kr* *'t_kr'*
    564 	t_kl	<Left>		arrow left			*t_kl* *'t_kl'*
    565 		<xUp>		alternate arrow up		*<xUp>*
    566 		<xDown>		alternate arrow down		*<xDown>*
    567 		<xRight>	alternate arrow right		*<xRight>*
    568 		<xLeft>		alternate arrow left		*<xLeft>*
    569 		<S-Up>		shift arrow up
    570 		<S-Down>	shift arrow down
    571 	t_%i	<S-Right>	shift arrow right		*t_%i* *'t_%i'*
    572 	t_#4	<S-Left>	shift arrow left		*t_#4* *'t_#4'*
    573 	t_k1	<F1>		function key 1			*t_k1* *'t_k1'*
    574 		<xF1>		alternate F1			*<xF1>*
    575 	t_k2	<F2>		function key 2		*<F2>*	*t_k2* *'t_k2'*
    576 		<xF2>		alternate F2			*<xF2>*
    577 	t_k3	<F3>		function key 3		*<F3>*	*t_k3* *'t_k3'*
    578 		<xF3>		alternate F3			*<xF3>*
    579 	t_k4	<F4>		function key 4		*<F4>*	*t_k4* *'t_k4'*
    580 		<xF4>		alternate F4			*<xF4>*
    581 	t_k5	<F5>		function key 5		*<F5>*	*t_k5* *'t_k5'*
    582 	t_k6	<F6>		function key 6		*<F6>*	*t_k6* *'t_k6'*
    583 	t_k7	<F7>		function key 7		*<F7>*	*t_k7* *'t_k7'*
    584 	t_k8	<F8>		function key 8		*<F8>*	*t_k8* *'t_k8'*
    585 	t_k9	<F9>		function key 9		*<F9>*	*t_k9* *'t_k9'*
    586 	t_k;	<F10>		function key 10		*<F10>*	*t_k;* *'t_k;'*
    587 	t_F1	<F11>		function key 11		*<F11>*	*t_F1* *'t_F1'*
    588 	t_F2	<F12>		function key 12		*<F12>*	*t_F2* *'t_F2'*
    589 	t_F3	<F13>		function key 13		*<F13>*	*t_F3* *'t_F3'*
    590 	t_F4	<F14>		function key 14		*<F14>*	*t_F4* *'t_F4'*
    591 	t_F5	<F15>		function key 15		*<F15>*	*t_F5* *'t_F5'*
    592 	t_F6	<F16>		function key 16		*<F16>*	*t_F6* *'t_F6'*
    593 	t_F7	<F17>		function key 17		*<F17>*	*t_F7* *'t_F7'*
    594 	t_F8	<F18>		function key 18		*<F18>*	*t_F8* *'t_F8'*
    595 	t_F9	<F19>		function key 19		*<F19>*	*t_F9* *'t_F9'*
    596 		<S-F1>		shifted function key 1
    597 		<S-xF1>		alternate <S-F1>		*<S-xF1>*
    598 		<S-F2>		shifted function key 2		*<S-F2>*
    599 		<S-xF2>		alternate <S-F2>		*<S-xF2>*
    600 		<S-F3>		shifted function key 3		*<S-F3>*
    601 		<S-xF3>		alternate <S-F3>		*<S-xF3>*
    602 		<S-F4>		shifted function key 4		*<S-F4>*
    603 		<S-xF4>		alternate <S-F4>		*<S-xF4>*
    604 		<S-F5>		shifted function key 5		*<S-F5>*
    605 		<S-F6>		shifted function key 6		*<S-F6>*
    606 		<S-F7>		shifted function key 7		*<S-F7>*
    607 		<S-F8>		shifted function key 8		*<S-F8>*
    608 		<S-F9>		shifted function key 9		*<S-F9>*
    609 		<S-F10>		shifted function key 10		*<S-F10>*
    610 		<S-F11>		shifted function key 11		*<S-F11>*
    611 		<S-F12>		shifted function key 12		*<S-F12>*
    612 	t_%1	<Help>		help key			*t_%1* *'t_%1'*
    613 	t_&8	<Undo>		undo key			*t_&8* *'t_&8'*
    614 	t_kI	<Insert>	insert key			*t_kI* *'t_kI'*
    615 		<kInsert>	keypad insert key
    616 	t_kD	<Del>		delete key			*t_kD* *'t_kD'*
    617 	t_kb	<BS>		backspace key			*t_kb* *'t_kb'*
    618 	t_kB	<S-Tab>		back-tab (shift-tab)  *<S-Tab>*	*t_kB* *'t_kB'*
    619 	t_kh	<Home>		home key			*t_kh* *'t_kh'*
    620 	t_#2	<S-Home>	shifted home key     *<S-Home>*	*t_#2* *'t_#2'*
    621 		<xHome>		alternate home key		*<xHome>*
    622 	t_@7	<End>		end key				*t_@7* *'t_@7'*
    623 	t_*7	<S-End>		shifted end key	*<S-End>* *t_star7* *'t_star7'*
    624 		<xEnd>		alternate end key		*<xEnd>*
    625 	t_kP	<PageUp>	page-up key			*t_kP* *'t_kP'*
    626 	t_kN	<PageDown>	page-down key			*t_kN* *'t_kN'*
    627 	t_K1	<kHome>		keypad home key			*t_K1* *'t_K1'*
    628 	t_K4	<kEnd>		keypad end key			*t_K4* *'t_K4'*
    629 	t_K3	<kPageUp>	keypad page-up key		*t_K3* *'t_K3'*
    630 	t_K5	<kPageDown>	keypad page-down key		*t_K5* *'t_K5'*
    631 	t_K6	<kPlus>		keypad plus key	      *<kPlus>*	*t_K6* *'t_K6'*
    632 	t_K7	<kMinus>	keypad minus key     *<kMinus>*	*t_K7* *'t_K7'*
    633 	t_K8	<kDivide>	keypad divide	    *<kDivide>*	*t_K8* *'t_K8'*
    634 	t_K9	<kMultiply>	keypad multiply   *<kMultiply>*	*t_K9* *'t_K9'*
    635 	t_KA	<kEnter>	keypad enter key     *<kEnter>*	*t_KA* *'t_KA'*
    636 	t_KB	<kPoint>	keypad decimal point *<kPoint>*	*t_KB* *'t_KB'*
    637 	t_KC	<k0>		keypad 0		 *<k0>*	*t_KC* *'t_KC'*
    638 	t_KD	<k1>		keypad 1		 *<k1>*	*t_KD* *'t_KD'*
    639 	t_KE	<k2>		keypad 2		 *<k2>*	*t_KE* *'t_KE'*
    640 	t_KF	<k3>		keypad 3		 *<k3>*	*t_KF* *'t_KF'*
    641 	t_KG	<k4>		keypad 4		 *<k4>*	*t_KG* *'t_KG'*
    642 	t_KH	<k5>		keypad 5		 *<k5>*	*t_KH* *'t_KH'*
    643 	t_KI	<k6>		keypad 6		 *<k6>*	*t_KI* *'t_KI'*
    644 	t_KJ	<k7>		keypad 7		 *<k7>*	*t_KJ* *'t_KJ'*
    645 	t_KK	<k8>		keypad 8		 *<k8>*	*t_KK* *'t_KK'*
    646 	t_KL	<k9>		keypad 9		 *<k9>*	*t_KL* *'t_KL'*
    647 		<Mouse>		leader of mouse code		*<Mouse>*
    648 
    649 	t_PS	<PasteStart>	start of bracketed paste	*t_PS* *'t_PS'*
    650 				|xterm-bracketed-paste|
    651 	t_PE	<PasteEnd>	end of bracketed paste		*t_PE* *'t_PE'*
    652 				|xterm-bracketed-paste|
    653 		<FocusGained>	Vim window got focus (internal only)
    654 		<FocusLost>	Vim window lost focus (internal only)
    655 
    656 Note about t_so and t_mr: When the termcap entry "so" is not present the
    657 entry for "mr" is used.  And vice versa.  The same is done for "se" and "me".
    658 If your terminal supports both inversion and standout mode, you can see two
    659 different modes.  If your terminal supports only one of the modes, both will
    660 look the same.
    661 
    662 							*keypad-comma*
    663 The keypad keys, when they are not mapped, behave like the equivalent normal
    664 key.  There is one exception: if you have a comma on the keypad instead of a
    665 decimal point, Vim will use a dot anyway.  Use these mappings to fix that: >
    666 	:noremap <kPoint> ,
    667 	:noremap! <kPoint> ,
    668 <							*xterm-codes*
    669 There is a special trick to obtain the key codes which currently only works
    670 for xterm.  When |t_RV| is defined and a response is received which indicates
    671 an xterm with patchlevel 141 or higher, Vim uses special escape sequences to
    672 request the key codes directly from the xterm.  The responses are used to
    673 adjust the various t_ codes.  This avoids the problem that the xterm can
    674 produce different codes, depending on the mode it is in (8-bit, VT102,
    675 VT220, etc.).  The result is that codes like <xF1> are no longer needed.
    676 
    677 One of the codes that can change is 't_Co', the number of colors.  This will
    678 trigger a redraw.  If this is a problem, reset the 'xtermcodes' option as
    679 early as possible: >
    680 	set noxtermcodes
    681 
    682 Note: Requesting the key codes is only done on startup.  If the xterm options
    683 are changed after Vim has started, the escape sequences may not be recognized
    684 anymore.
    685 
    686 							*xterm-true-color*
    687 Vim supports using true colors in the terminal (taken from |highlight-guifg|
    688 and |highlight-guibg|), given that the terminal supports this.  To make this
    689 work the 'termguicolors' option needs to be set.
    690 See https://github.com/termstandard/colors for a list of terminals that
    691 support true colors.
    692 
    693 The entry of a direct color terminal, such as "xterm-direct", has 16777216
    694 colors.  Then 't_Co' is 16777216 and |terminalprops()| reports "rgb" as 'y'.
    695 Vim does not set 'termguicolors' by itself.  To have it set for such a
    696 terminal, put this in the vimrc: >
    697 	if get(terminalprops(), 'rgb', 'n')  == 'y'
    698 	  set termguicolors
    699 	endif
    700 <
    701 
    702 For telling the terminal what RGB color to use the |t_8f|, |t_8b|, and |t_8u|
    703 termcap entries are used.  These are set by default to values that work for
    704 most terminals.  If that does not work for your terminal you can set them
    705 manually.  The default values are set like this: >
    706 	 let &t_8f = "\<Esc>[38;2;%lu;%lu;%lum"
    707 	 let &t_8b = "\<Esc>[48;2;%lu;%lu;%lum"
    708 	 let &t_8u = "\<Esc>[58;2;%lu;%lu;%lum"
    709 
    710 Some terminals accept similar sequences, with semicolons replaced by colons
    711 and an extra colon after the number 2 (this is conformant to the ISO 8613-6
    712 standard, but less widely supported): >
    713 	 let &t_8f = "\<Esc>[38:2::%lu:%lu:%lum"
    714 	 let &t_8b = "\<Esc>[48:2::%lu:%lu:%lum"
    715 	 let &t_8u = "\<Esc>[58:2::%lu:%lu:%lum"
    716 
    717 These options contain printf strings, with |printf()| (actually, its C
    718 equivalent hence `l` modifier) invoked with the t_ option value and three
    719 unsigned long integers that may have any value between 0 and 255 (inclusive)
    720 representing red, green and blue colors respectively.
    721 
    722 							*xterm-resize*
    723 Window resizing with xterm only works if the allowWindowOps resource is
    724 enabled.  On some systems and versions of xterm it's disabled by default
    725 because someone thought it would be a security issue.  It's not clear if this
    726 is actually the case.
    727 
    728 To overrule the default, put this line in your ~/.Xdefaults or
    729 ~/.Xresources:
    730 >
    731 	XTerm*allowWindowOps:		true
    732 
    733 And run "xrdb -merge .Xresources" to make it effective.  You can check the
    734 value with the context menu (right mouse button while CTRL key is pressed),
    735 there should be a tick at allow-window-ops.
    736 
    737 							*xterm-focus-event*
    738 Some terminals including xterm support the focus event tracking feature.
    739 If this feature is enabled by the 't_fe' sequence, special key sequences are
    740 sent from the terminal to Vim every time the terminal gains or loses focus.
    741 Vim fires focus events (|FocusGained|/|FocusLost|) by handling them accordingly.
    742 Focus event tracking is disabled by a 't_fd' sequence when exiting "raw" mode.
    743 If you would like to disable this feature, add the following to your .vimrc: >
    744 	set t_fd=
    745 	set t_fe=
    746 If your terminal does support this but Vim does not recognize the terminal,
    747 you may have to set the options yourself: >
    748 	let &t_fe = "\<Esc>[?1004h"
    749 	let &t_fd = "\<Esc>[?1004l"
    750 	execute "set <FocusGained>=\<Esc>[I"
    751         execute "set <FocusLost>=\<Esc>[O"
    752 If this causes garbage to show when Vim starts up then it doesn't work.
    753 
    754 							*termcap-colors*
    755 Note about colors: The 't_Co' option tells Vim the number of colors available.
    756 When it is non-zero, the 't_AB' and 't_AF' options are used to set the color.
    757 If one of these is not available, 't_Sb' and 't_Sf' are used.  't_me' is used
    758 to reset to the default colors.  Also see 'termguicolors'.
    759 When the GUI is running 't_Co' is set to 16777216.
    760 
    761 				*termcap-cursor-shape* *termcap-cursor-color*
    762 When Vim enters Insert mode the 't_SI' escape sequence is sent.  When Vim
    763 enters Replace mode the 't_SR' escape sequence is sent if it is set, otherwise
    764 't_SI' is sent.  When leaving Insert mode or Replace mode 't_EI' is used.
    765 Note: When 't_EI' is not set then 't_SI' and 't_SR' will not be sent.  And
    766 when 't_SI' or 't_SR' is not set then 't_EI' is sent only once.
    767 
    768 This can be used to change the shape or color of the cursor in Insert or
    769 Replace mode.  These are not standard termcap/terminfo entries, you need to
    770 set them yourself.
    771 Example for an xterm, this changes the color of the cursor: >
    772     if &term =~ "xterm"
    773 	let &t_SI = "\<Esc>]12;purple\x7"
    774 	let &t_SR = "\<Esc>]12;red\x7"
    775 	let &t_EI = "\<Esc>]12;blue\x7"
    776     endif
    777 NOTE: When Vim exits the shape for Normal mode will remain.  The shape from
    778 before Vim started will not be restored.
    779 
    780 For Windows Terminal you can use something like this: >
    781     " Note: This should be set after `set termguicolors` or `set t_Co=256`.
    782     if &term =~ 'xterm' || &term == 'win32'
    783 	" Use DECSCUSR escape sequences
    784 	let &t_SI = "\e[5 q"    " blink bar
    785 	let &t_SR = "\e[3 q"    " blink underline
    786 	let &t_EI = "\e[1 q"    " blink block
    787 	let &t_ti ..= "\e[1 q"  " blink block
    788 	let &t_te ..= "\e[0 q"  " default (depends on terminal, normally blink
    789 				" block)
    790     endif
    791 
    792 {not available when compiled without the |+cursorshape| feature}
    793 
    794 							*termcap-title*
    795 The 't_ts' and 't_fs' options are used to set the window title if the terminal
    796 allows title setting via sending strings.  They are sent before and after the
    797 title string, respectively.  Similar 't_IS' and 't_IE'  are used to set the
    798 icon text.  These are Vim-internal extensions of the Unix termcap, so they
    799 cannot be obtained from an external termcap.  However, the builtin termcap
    800 contains suitable entries for xterm and iris-ansi, so you don't need to set
    801 them here.
    802 							*hpterm*
    803 If inversion or other highlighting does not work correctly, try setting the
    804 't_xs' option to a non-empty string.  This makes the 't_ce' code be used to
    805 remove highlighting from a line.  This is required for "hpterm".  Setting the
    806 'weirdinvert' option has the same effect as making 't_xs' non-empty, and vice
    807 versa.
    808 
    809 							*scroll-region*
    810 Some termcaps do not include an entry for "cs" (scroll region), although the
    811 terminal does support it.  For example: xterm on a Sun.  You can use the
    812 builtin_xterm or define t_cs yourself.  For example: >
    813 	:set t_cs=^V^[[%i%d;%dr
    814 Where ^V is CTRL-V and ^[ is <Esc>.
    815 
    816 The vertical scroll region t_CV is not a standard termcap code.  Vim uses it
    817 internally in the GUI.  But it can also be defined for a terminal, if you can
    818 find one that supports it.  The two arguments are the left and right column of
    819 the region which to restrict the scrolling to.  Just like t_cs defines the top
    820 and bottom lines.  Defining t_CV will make scrolling in vertically split
    821 windows a lot faster.  Don't set t_CV when t_da or t_db is set (text isn't
    822 cleared when scrolling).
    823 
    824 Unfortunately it is not possible to deduce from the termcap how cursor
    825 positioning should be done when using a scrolling region: Relative to the
    826 beginning of the screen or relative to the beginning of the scrolling region.
    827 Most terminals use the first method.  The 't_CS' option should be set to any
    828 string when cursor positioning is relative to the start of the scrolling
    829 region.  It should be set to an empty string otherwise.
    830 
    831 Note for xterm users: The shifted cursor keys normally don't work.  You can
    832 	make them work with the xmodmap command and some mappings in Vim.
    833 
    834 	Give these commands in the xterm: >
    835 		xmodmap -e "keysym Up = Up F13"
    836 		xmodmap -e "keysym Down = Down F16"
    837 		xmodmap -e "keysym Left = Left F18"
    838 		xmodmap -e "keysym Right = Right F19"
    839 <
    840 	And use these mappings in Vim: >
    841 		:map <t_F3> <S-Up>
    842 		:map! <t_F3> <S-Up>
    843 		:map <t_F6> <S-Down>
    844 		:map! <t_F6> <S-Down>
    845 		:map <t_F8> <S-Left>
    846 		:map! <t_F8> <S-Left>
    847 		:map <t_F9> <S-Right>
    848 		:map! <t_F9> <S-Right>
    849 
    850 Instead of, say, <S-Up> you can use any other command that you want to use the
    851 shift-cursor-up key for.  (Note: To help people that have a Sun keyboard with
    852 left side keys F14 is not used because it is confused with the undo key; F15
    853 is not used, because it does a window-to-front; F17 is not used, because it
    854 closes the window.  On other systems you can probably use them.)
    855 
    856 ==============================================================================
    857 3. Window size						*window-size*
    858 
    859 [This is about the size of the whole window Vim is using, not a window that is
    860 created with the ":split" command.]
    861 
    862 If you are running Vim on an Amiga and the terminal name is "amiga" or
    863 "builtin_amiga", the amiga-specific window resizing will be enabled.  On Unix
    864 systems three methods are tried to get the window size:
    865 
    866 - an ioctl call (TIOCGSIZE or TIOCGWINSZ, depends on your system)
    867 - the environment variables "LINES" and "COLUMNS"
    868 - from the termcap entries "li" and "co"
    869 
    870 If everything fails a default size of 24 lines and 80 columns is assumed.  If
    871 a window-resize signal is received the size will be set again.  If the window
    872 size is wrong you can use the 'lines' and 'columns' options to set the
    873 correct values.
    874 
    875 One command can be used to set the screen size:
    876 						*:mod* *:mode* *E359*
    877 :mod[e] [mode]
    878 
    879 Without argument this only detects the screen size and redraws the screen.
    880 [mode] was used on MS-DOS, but it doesn't work anymore.  In |Vim9| this
    881 command is not supported.
    882 
    883 ==============================================================================
    884 4. Slow and fast terminals			*slow-fast-terminal*
    885 						*slow-terminal*
    886 
    887 If you have a fast terminal you may like to set the 'ruler' option.  The
    888 cursor position is shown in the status line.  If you are using horizontal
    889 scrolling ('wrap' option off) consider setting 'sidescroll' to a small
    890 number.
    891 
    892 If you have a slow terminal you may want to reset the 'showcmd' option.
    893 The command characters will not be shown in the status line.  If the terminal
    894 scrolls very slowly, set the 'scrolljump' to 5 or so.  If the cursor is moved
    895 off the screen (e.g., with "j") Vim will scroll 5 lines at a time.  Another
    896 possibility is to reduce the number of lines that Vim uses with the command
    897 "z{height}<CR>".
    898 
    899 If the characters from the terminal are arriving with more than 1 second
    900 between them you might want to set the 'timeout' and/or 'ttimeout' option.
    901 See the "Options" chapter |options|.
    902 
    903 If your terminal does not support a scrolling region, but it does support
    904 insert/delete line commands, scrolling with multiple windows may make the
    905 lines jump up and down.  This would happen if the 'ttyfast' option has been
    906 reset.  Check that with: >
    907 	verbose set ttyfast?
    908 
    909 If your terminal scrolls very slowly, but redrawing is not slow, set the
    910 'ttyscroll' option to a small number, e.g., 3.  This will make Vim redraw the
    911 screen instead of scrolling, when there are more than 3 lines to be scrolled.
    912 
    913 If you are using a color terminal that is slow, use this command: >
    914 	hi NonText cterm=NONE ctermfg=NONE
    915 This avoids that spaces are sent when they have different attributes.  On most
    916 terminals you can't see this anyway.
    917 
    918 If you are using Vim over a slow serial line, you might want to try running
    919 Vim inside the "screen" program.  Screen will optimize the terminal I/O quite
    920 a bit.
    921 
    922 If you are testing termcap options, but you cannot see what is happening, you
    923 might want to set the 'writedelay' option.  When non-zero, one character is
    924 sent to the terminal at a time.  This makes the screen updating a lot slower,
    925 making it possible to see what is happening.
    926 
    927 ==============================================================================
    928 5. Using the mouse					*mouse-using*
    929 
    930 This section is about using the mouse on a terminal or a terminal window.  How
    931 to use the mouse in a GUI window is explained in |gui-mouse|.  For scrolling
    932 with a mouse wheel see |scroll-mouse-wheel|.
    933 
    934 Don't forget to enable the mouse with this command: >
    935 	:set mouse=a
    936 Otherwise Vim won't recognize the mouse in all modes (See 'mouse').
    937 
    938 Currently the mouse is supported for Unix in an xterm window, in a *BSD
    939 console with |sysmouse|, in a Linux console (with GPM |gpm-mouse|), and
    940 in a Windows console.
    941 Mouse clicks can be used to position the cursor, select an area and paste.
    942 
    943 These characters in the 'mouse' option tell in which situations the mouse will
    944 be used by Vim:
    945 		n	Normal mode
    946 		v	Visual mode
    947 		i	Insert mode
    948 		c	Command-line mode
    949 		h	all previous modes when in a help file
    950 		a	all previous modes
    951 		r	for |hit-enter| prompt
    952 
    953 The default for 'mouse' is empty, the mouse is not used.  Normally you would
    954 do: >
    955 	:set mouse=a
    956 to start using the mouse (this is equivalent to setting 'mouse' to "nvich").
    957 If you only want to use the mouse in a few modes or also want to use it for
    958 the two questions you will have to concatenate the letters for those modes.
    959 For example: >
    960 	:set mouse=nv
    961 Will make the mouse work in Normal mode and Visual mode. >
    962 	:set mouse=h
    963 Will make the mouse work in help files only (so you can use "g<LeftMouse>" to
    964 jump to tags).
    965 
    966 Whether the selection that is started with the mouse is in Visual mode or
    967 Select mode depends on whether "mouse" is included in the 'selectmode'
    968 option.
    969 							*terminal-mouse*
    970 In an xterm, with the currently active mode included in the 'mouse' option,
    971 normal mouse clicks are used by Vim, mouse clicks with the shift or ctrl key
    972 pressed go to the xterm.  With the currently active mode not included in
    973 'mouse' all mouse clicks go to the xterm.
    974 
    975 For terminals where it is not possible to have the mouse events be used by the
    976 terminal itself by using a modifier, a workaround is to not use mouse events
    977 for Vim in command-line mode: >
    978 	:set mouse=nvi
    979 Then to select text with the terminal, use ":" to go to command-line mode,
    980 select and copy the text to the system, then press Esc.
    981 
    982 Another way is to temporarily use ":sh" to run a shell, copy the text, then
    983 exit the shell.  'mouse' can remain set to "a" then.
    984 							*xterm-clipboard*
    985 In the Motif GUI version, when running in a terminal and there is
    986 access to the X-server (DISPLAY is set), the copy and paste will behave like
    987 in the GUI.  If not, the middle mouse button will insert the unnamed register.
    988 In that case, here is how you copy and paste a piece of text:
    989 
    990 Copy/paste with the mouse and Visual mode ('mouse' option must be set, see
    991 above):
    992 1. Press left mouse button on first letter of text, move mouse pointer to last
    993    letter of the text and release the button.  This will start Visual mode and
    994    highlight the selected area.
    995 2. Press "y" to yank the Visual text in the unnamed register.
    996 3. Click the left mouse button at the insert position.
    997 4. Click the middle mouse button.
    998 
    999 Shortcut: If the insert position is on the screen at the same time as the
   1000 Visual text, you can do 2, 3 and 4 all in one: Click the middle mouse button
   1001 at the insert position.
   1002 
   1003 Note: When the |-X| command line argument is used, Vim will not connect to the
   1004 X server and copy/paste to the X clipboard (selection) will not work.  Use the
   1005 shift key with the mouse buttons to let the xterm do the selection.
   1006 
   1007 							*xterm-command-server*
   1008 When the X-server clipboard is available, the command server described in
   1009 |x11-clientserver| can be enabled with the --servername command line argument.
   1010 
   1011 							*xterm-copy-paste*
   1012 NOTE: In some (older) xterms, it's not possible to move the cursor past column
   1013 95 or 223.  This is an xterm problem, not Vim's.  Get a newer xterm
   1014 |color-xterm|.  Also see 'ttymouse'.
   1015 
   1016 Copy/paste in xterm with (current mode NOT included in 'mouse'):
   1017 1. Press left mouse button on first letter of text, move mouse pointer to last
   1018    letter of the text and release the button.
   1019 2. Use normal Vim commands to put the cursor at the insert position.
   1020 3. Press "a" to start Insert mode.
   1021 4. Click the middle mouse button.
   1022 5. Press ESC to end Insert mode.
   1023 (The same can be done with anything in 'mouse' if you keep the shift key
   1024 pressed while using the mouse.)
   1025 
   1026 Note: if you lose the 8th bit when pasting (special characters are translated
   1027 into other characters), you may have to do "stty cs8 -istrip -parenb" in your
   1028 shell before starting Vim.
   1029 
   1030 Thus in an xterm the shift and ctrl keys cannot be used with the mouse.  Mouse
   1031 commands requiring the CTRL modifier can be simulated by typing the "g" key
   1032 before using the mouse:
   1033 	"g<LeftMouse>"	is "<C-LeftMouse>	(jump to tag under mouse click)
   1034 	"g<RightMouse>" is "<C-RightMouse>	("CTRL-T")
   1035 
   1036 					*mouse-mode-table* *mouse-overview*
   1037 A short overview of what the mouse buttons do, when 'mousemodel' is "extend":
   1038 
   1039 Normal Mode:
   1040 event	      position	   selection	  change  action	~
   1041 	       cursor			  window		~
   1042 <LeftMouse>     yes	     end	    yes
   1043 <C-LeftMouse>   yes	     end	    yes	   "CTRL-]" (2)
   1044 <S-LeftMouse>   yes	  no change	    yes	   "*" (2)    *<S-LeftMouse>*
   1045 <LeftDrag>      yes	start or extend (1) no		      *<LeftDrag>*
   1046 <LeftRelease>   yes	start or extend (1) no
   1047 <MiddleMouse>   yes	  if not active     no	   put
   1048 <MiddleMouse>   yes	  if active	    no	   yank and put
   1049 <RightMouse>    yes	start or extend     yes
   1050 <A-RightMouse>  yes start or extend blockw. yes		      *<A-RightMouse>*
   1051 <S-RightMouse>  yes	   no change	    yes	   "#" (2)    *<S-RightMouse>*
   1052 <C-RightMouse>  no	   no change	    no	   "CTRL-T"
   1053 <RightDrag>     yes	    extend	    no		      *<RightDrag>*
   1054 <RightRelease>  yes	    extend	    no		      *<RightRelease>*
   1055 
   1056 Insert or Replace Mode:
   1057 event	      position	   selection	  change  action	~
   1058 	       cursor			  window		~
   1059 <LeftMouse>     yes     (cannot be active)  yes
   1060 <C-LeftMouse>   yes     (cannot be active)  yes	   "CTRL-O^]" (2)
   1061 <S-LeftMouse>   yes     (cannot be active)  yes	   "CTRL-O*" (2)
   1062 <LeftDrag>      yes     start or extend (1) no	   like CTRL-O (1)
   1063 <LeftRelease>   yes     start or extend (1) no	   like CTRL-O (1)
   1064 <MiddleMouse>   no      (cannot be active)  no	   put register
   1065 <RightMouse>    yes     start or extend	    yes	   like CTRL-O
   1066 <A-RightMouse>  yes start or extend blockw. yes
   1067 <S-RightMouse>  yes     (cannot be active)  yes	   "CTRL-O#" (2)
   1068 <C-RightMouse>  no	(cannot be active)  no	   "CTRL-O CTRL-T"
   1069 
   1070 In a help window:
   1071 event	      position	   selection	  change  action	~
   1072 	       cursor			  window		~
   1073 <2-LeftMouse>   yes     (cannot be active)  no	   "^]" (jump to help tag)
   1074 
   1075 When 'mousemodel' is "popup", these are different:
   1076 
   1077 Normal Mode:
   1078 event	      position	   selection	  change  action	~
   1079 	       cursor			  window		~
   1080 <S-LeftMouse>	yes	start or extend (1) no
   1081 <A-LeftMouse>   yes start or extend blockw. no		      *<A-LeftMouse>*
   1082 <RightMouse>	no	popup menu	    no
   1083 
   1084 Insert or Replace Mode:
   1085 event	      position	   selection	  change  action	~
   1086 	       cursor			  window		~
   1087 <S-LeftMouse>   yes     start or extend (1) no	   like CTRL-O (1)
   1088 <A-LeftMouse>   yes start or extend blockw. no
   1089 <RightMouse>    no	popup menu	    no
   1090 
   1091 (1) only if mouse pointer moved since press
   1092 (2) only if click is in same buffer
   1093 
   1094 Clicking the left mouse button causes the cursor to be positioned.  If the
   1095 click is in another window that window is made the active window.  When
   1096 editing the command-line the cursor can only be positioned on the
   1097 command-line.  When in Insert mode Vim remains in Insert mode.  If 'scrolloff'
   1098 is set, and the cursor is positioned within 'scrolloff' lines from the window
   1099 border, the text is scrolled.
   1100 
   1101 A selection can be started by pressing the left mouse button on the first
   1102 character, moving the mouse to the last character, then releasing the mouse
   1103 button.  You will not always see the selection until you release the button,
   1104 only in some versions (GUI, Win32) will the dragging be shown immediately.
   1105 Note that you can make the text scroll by moving the mouse at least one
   1106 character in the first/last line in the window when 'scrolloff' is non-zero.
   1107 
   1108 In Normal, Visual and Select mode clicking the right mouse button causes the
   1109 Visual area to be extended.  When 'mousemodel' is "popup", the left button has
   1110 to be used while keeping the shift key pressed.  When clicking in a window
   1111 which is editing another buffer, the Visual or Select mode is stopped.
   1112 
   1113 In Normal, Visual and Select mode clicking the right mouse button with the alt
   1114 key pressed causes the Visual area to become blockwise.  When 'mousemodel' is
   1115 "popup" the left button has to be used with the alt key.  Note that this won't
   1116 work on systems where the window manager consumes the mouse events when the
   1117 alt key is pressed (it may move the window).
   1118 
   1119 							*double-click*
   1120 Double, triple and quadruple clicks are supported when the GUI is active, for
   1121 Win32, and for an xterm (if the gettimeofday() function is available).  For
   1122 selecting text, extra clicks extend the selection:
   1123 	click		select ~
   1124 	double		word or % match		*<2-LeftMouse>*
   1125 	triple		line			*<3-LeftMouse>*
   1126 	quadruple	rectangular block	*<4-LeftMouse>*
   1127 Exception: In a Help window a double click jumps to help for the word that is
   1128 clicked on.
   1129 A double click on a word selects that word.  'iskeyword' is used to specify
   1130 which characters are included in a word.  A double click on a character
   1131 that has a match selects until that match (like using "v%").  If the match is
   1132 an #if/#else/#endif block, the selection becomes linewise.
   1133 For MS-Windows and xterm the time for double clicking can be set with the
   1134 'mousetime' option.  For the other systems this time is defined outside of
   1135 Vim.
   1136 An example, for using a double click to jump to the tag under the cursor: >
   1137 	:map <2-LeftMouse> :exe "tag " .. expand("<cword>")<CR>
   1138 
   1139 Dragging the mouse with a double click (button-down, button-up, button-down
   1140 and then drag) will result in whole words to be selected.  This continues
   1141 until the button is released, at which point the selection is per character
   1142 again.
   1143 
   1144 For scrolling with the mouse see |scroll-mouse-wheel|.
   1145 
   1146 							*gpm-mouse*
   1147 The GPM mouse is only supported when the |+mouse_gpm| feature was enabled at
   1148 compile time.  The GPM mouse driver (Linux console) does not support quadruple
   1149 clicks.
   1150 
   1151 In Insert mode, when a selection is started, Vim goes into Normal mode
   1152 temporarily.  When Visual or Select mode ends, it returns to Insert mode.
   1153 This is like using CTRL-O in Insert mode.  Select mode is used when the
   1154 'selectmode' option contains "mouse".
   1155 							*sysmouse*
   1156 The sysmouse is only supported when the |+mouse_sysmouse| feature was enabled
   1157 at compile time.  The sysmouse driver (*BSD console) does not support keyboard
   1158 modifiers.
   1159 
   1160 							*drag-status-line*
   1161 When working with several windows, the size of the windows can be changed by
   1162 dragging the status line with the mouse.  Point the mouse at a status line,
   1163 press the left button, move the mouse to the new position of the status line,
   1164 release the button.  Just clicking the mouse in a status line makes that
   1165 window the current window, without moving the cursor.  If by selecting a
   1166 window it will change position or size, the dragging of the status line will
   1167 look confusing, but it will work (just try it).
   1168 
   1169 					*<MiddleRelease>* *<MiddleDrag>*
   1170 Mouse clicks can be mapped.  The codes for mouse clicks are:
   1171      code	    mouse button	      normal action	~
   1172  <LeftMouse>	 left pressed		    set cursor position
   1173  <LeftDrag>	 left moved while pressed   extend selection
   1174  <LeftRelease>	 left released		    set selection end
   1175  <MiddleMouse>	 middle pressed		    paste text at cursor position
   1176  <MiddleDrag>	 middle moved while pressed -
   1177  <MiddleRelease> middle released	    -
   1178  <RightMouse>	 right pressed		    extend selection
   1179  <RightDrag>	 right moved while pressed  extend selection
   1180  <RightRelease>  right released		    set selection end
   1181  <X1Mouse>	 X1 button pressed	    -			*X1Mouse*
   1182  <X1Drag>	 X1 moved while pressed	    -			*X1Drag*
   1183  <X1Release>	 X1 button release	    -			*X1Release*
   1184  <X2Mouse>	 X2 button pressed	    -			*X2Mouse*
   1185  <X2Drag>	 X2 moved while pressed     -			*X2Drag*
   1186  <X2Release>	 X2 button release	    -			*X2Release*
   1187 
   1188 The X1 and X2 buttons refer to the extra buttons found on some mice.  The
   1189 'Microsoft Explorer' mouse has these buttons available to the right thumb.
   1190 Currently, X1 and X2 work only on Win32 and X11 environments, and in terminals
   1191 that support xterm-like mouse functionality.
   1192 
   1193 Examples: >
   1194 	:noremap <MiddleMouse> <LeftMouse><MiddleMouse>
   1195 Paste at the position of the middle mouse button click (otherwise the paste
   1196 would be done at the cursor position). >
   1197 
   1198 	:noremap <LeftRelease> <LeftRelease>y
   1199 Immediately yank the selection, when using Visual mode.
   1200 
   1201 Note the use of ":noremap" instead of "map" to avoid a recursive mapping.
   1202 >
   1203 	:map <X1Mouse> <C-O>
   1204 	:map <X2Mouse> <C-I>
   1205 Map the X1 and X2 buttons to go forwards and backwards in the jump list, see
   1206 |CTRL-O| and |CTRL-I|.
   1207 
   1208 						*mouse-swap-buttons*
   1209 To swap the meaning of the left and right mouse buttons: >
   1210 	:noremap	<LeftMouse>	<RightMouse>
   1211 	:noremap	<LeftDrag>	<RightDrag>
   1212 	:noremap	<LeftRelease>	<RightRelease>
   1213 	:noremap	<RightMouse>	<LeftMouse>
   1214 	:noremap	<RightDrag>	<LeftDrag>
   1215 	:noremap	<RightRelease>	<LeftRelease>
   1216 	:noremap	g<LeftMouse>	<C-RightMouse>
   1217 	:noremap	g<RightMouse>	<C-LeftMouse>
   1218 	:noremap!	<LeftMouse>	<RightMouse>
   1219 	:noremap!	<LeftDrag>	<RightDrag>
   1220 	:noremap!	<LeftRelease>	<RightRelease>
   1221 	:noremap!	<RightMouse>	<LeftMouse>
   1222 	:noremap!	<RightDrag>	<LeftDrag>
   1223 	:noremap!	<RightRelease>	<LeftRelease>
   1224 <
   1225  vim:tw=78:ts=8:noet:ft=help:norl: