path: root/doc
diff options
authorTom Ryder <tom@sanctum.geek.nz>2018-08-04 21:02:43 +1200
committerTom Ryder <tom@sanctum.geek.nz>2018-08-04 21:02:43 +1200
commit9481bd3d47f9cec47d08757e56a1942325ef989f (patch)
tree150603f487b3750939d7f39bd34c7737527a438a /doc
First versionv0.1.0
Diffstat (limited to 'doc')
1 files changed, 32 insertions, 0 deletions
diff --git a/doc/cursorline_current.txt b/doc/cursorline_current.txt
new file mode 100644
index 0000000..33f645e
--- /dev/null
+++ b/doc/cursorline_current.txt
@@ -0,0 +1,32 @@
+*cursorline_current.txt* For Vim version 7.0 Last change: 2018 Aug 4
+DESCRIPTION *cursorline_current*
+This plugin tweaks the behaviour of the 'cursorline' option to enable it only
+in the current window and when not in insert mode. It essentially makes
+'cursorline' follow the cursor in normal mode as much as possible.
+It uses the global value of 'cursorline' as its default, and should also
+correctly handle local values for windows.
+REQUIREMENTS *cursorline_current-requirements*
+This plugin only loads if 'compatible' is not set. It requires the |+autocmd|
+and |+windows| features.
+OPTIONS *cursorline_current-options*
+ *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
+AUTHOR *cursorline_current-author*
+Written and maintained by Tom Ryder <tom@sanctum.geek.nz>.
+LICENSE *cursorline_current-license*
+Licensed for distribution under the same terms as Vim itself (see |license|).
+ vim:tw=78:ts=8:ft=help:norl: