diff options
Diffstat (limited to 'doc/cursorline_current.txt')
-rw-r--r-- | doc/cursorline_current.txt | 36 |
1 files changed, 31 insertions, 5 deletions
diff --git a/doc/cursorline_current.txt b/doc/cursorline_current.txt index 6a54bb6..4984fec 100644 --- a/doc/cursorline_current.txt +++ b/doc/cursorline_current.txt @@ -1,16 +1,42 @@ -*cursorline_current.txt* For Vim version 7.0 Last change: 2019 Jun 13 +*cursorline_current.txt* For Vim version 7.0 Last change: 2019 Jun 19 DESCRIPTION *cursorline_current* -This plugin tweaks the behaviour of the 'cursorline' option to enable it only -in the current window, when not in insert mode, and (if supported) when Vim -has focus. It essentially makes 'cursorline' follow the cursor in normal mode -as much as possible. It uses the global value of 'cursorline' as its default. +This plugin tweaks the behaviour of the 'cursorline' and 'cursorcolumn' +options to enable them only in the current window, when not in insert mode, +and/or when Vim has focus. + +In its default configuration, it essentially makes 'cursorline' and +'cursorcolumn' follow the cursor around in normal mode as much as possible. +It uses each window's global value of both options as its default, so setting +each option in your |vimrc| before the plugin loads should do the trick. REQUIREMENTS *cursorline_current-requirements* This plugin only loads if 'compatible' is not set. +OPTIONS *cursorline_current-options* + + *g:cursorline_current_line* +Set `g:cursorline_current_line` to 0 in your |vimrc| if you don't want +'cursorline' to follow the current window around, and instead prefer each +window to track its own state. This option defaults to 1. + + *g:cursorcolumn_current_column* +Set `g:cursorline_current_column` to 0 in your |vimrc| if you don't want +'cursorcolumn' to follow the current window around, and instead prefer each +window to track its own state. This option defaults to 1. + + *g:cursorline_current_insert* +Set `g:cursorline_current_insert` to 0 in your |vimrc| if you don't like the +cursor line switching off while you're in insert mode. This option defaults +to 1. + + *g:cursorline_current_focus* +Set `g:cursorline_current_focus` to 0 in your |vimrc| if you don't like the +cursor line switching off when Vim loses focus, which probably only works in +the GUI. This option defaults to 1. + AUTHOR *cursorline_current-author* Written and maintained by Tom Ryder <tom@sanctum.geek.nz>. |