diff runtime/doc/term.txt @ 36:125e80798a85 v7.0021

updated for version 7.0021
author vimboss
date Thu, 09 Dec 2004 21:34:53 +0000
parents f6033dcbaf31
children 7fd70926e2e1
line wrap: on
line diff
--- a/runtime/doc/term.txt
+++ b/runtime/doc/term.txt
@@ -1,4 +1,4 @@
-*term.txt*      For Vim version 7.0aa.  Last change: 2004 Oct 20
+*term.txt*      For Vim version 7.0aa.  Last change: 2004 Dec 07
 
 
 		  VIM REFERENCE MANUAL    by Bram Moolenaar
@@ -275,6 +275,8 @@ Added by Vim (there are no standard code
 	t_IE	set icon text end				*t_IE* *'t_IE'*
 	t_WP	set window position (Y, X) in pixels		*t_WP* *'t_WP'*
 	t_WS	set window size (height, width) in characters	*t_WS* *'t_WS'*
+	t_SI    start insert mode (bar cursor shape)            *t_SI* *'t_SI'*
+	t_EI    end insert mode (block cursor shape)            *t_EI* *'t_EI'*
 	t_RV	request terminal version string (for xterm)	*t_RV* *'t_RV'*
 		|xterm-8bit| |v:termresponse| |'ttymouse'| |xterm-codes|
 
@@ -395,6 +397,19 @@ When it is non-zero, the 't_AB' and 't_A
 If one of these is not available, 't_Sb' and 't_Sf' are used.  't_me' is used
 to reset to the default colors.
 
+				*termcap-cursor-shape* *termcap-cursor-color*
+When Vim enters Insert mode the 't_SI' escape sequence is sent.  When leaving
+Insert mode 't_EI' is used.  But only if both are defined.  This can be used
+to change the shape or color of the cursor in Insert mode.  These are not
+standard termcap/terminfo entries, you need to set them yourself.
+Example for an xterm, this changes the color of the cursor: >
+    if &term =~ "xterm"
+	let &t_SI = "\<Esc>]12;purple\x7"
+	let &t_EI = "\<Esc>]12;blue\x7"
+    endif
+NOTE: When Vim exits the shape for Normal mode will remain.  The shape from
+before Vim started will not be restored.
+
 							*termcap-title*
 The 't_ts' and 't_fs' options are used to set the window title if the terminal
 allows title setting via sending strings.  They are sent before and after the