Update 2024-12-15 14:45 OpenBSD/amd64-t14

.vim/pack/plugins/start/vim-cursorword/doc/cursorword.txt

@@ -0,0 +1,72 @@
+*cursorword.txt*	Underlines the word under the cursor
+
+Author: itchyny (https://github.com/itchyny)
+License: MIT License
+Repository: https://github.com/itchyny/vim-cursorword
+Last Change: 2022/11/17 18:55:06.
+
+CONTENTS					*cursorword-contents*
+
+Introduction				|cursorword-introduction|
+Options					|cursorword-options|
+Changelog				|cursorword-changelog|
+
+==============================================================================
+INTRODUCTION					*cursorword-introduction*
+This *cursorword* plugin underlines the word under the cursor. That's it.
+
+While we are coding, we always pay attention to the variable under the cursor.
+Where did we define the variable? In which statement do we use the variable?
+Searching the variable using |star| or |#| is a simple solution to highlight all
+the places the variable is used. However, it costs too much time to highlight
+a word, move around to check the places and clear the highlight.  This plugin
+|cursorword| provides you the modest underlines for the variables under the
+cursor to let you know all the places the variable is used at a glance without
+stopping coding.
+
+The brightest plugin (https://github.com/osyo-manga/vim-brightest) is a nice
+plugin to fulfill highlights of the word under the cursor. However, it uses
+too long codes and is too slow. I had been using the plugin for a while but I
+could not bear the slowness caused by brightest on the cursor motions. This is
+why I created |cursorword|. I think that a plugin which is running all the time
+should be coded with the performance efficiency in mind. When we publish a
+plugin which stays running in all buffers, we should be aware that it will use
+much resource of all the users.
+
+The code of |cursorword| is very tiny. It's very tiny that |cursorword| runs ten
+times faster than brightest. Instead of its efficiency, |cursorword| is totally
+unconfigurable. But you will find this plugin just comfortable; the modest
+underlines are enough for us. A good configurable plugin would have many
+options that users can configure almost all the features. But be relaxed and
+imagine, do we need such a lot of options for a plugin to highlight the word
+under the cursor? Most people would never need such a lot of options. We
+should not implement features for a few power users at the sacrifice of the
+performance of the software. Keep your software small for the happiness of
+most users. Too much configurability makes your software dirty and causes
+unwanted slowness on many users. We have to rethink what good configurability
+is and for what kind of software such configurability is required.
+
+==============================================================================
+OPTIONS						*cursorword-options*
+
+	g:cursorword				*g:cursorword*
+		Set this variable to 0 to disable this plugin globally.
+
+	b:cursorword				*b:cursorword*
+		If you set this variable to 0, the plugin stops highlighting
+		the word under the cursor in the buffer. This variable has
+		priority over |g:cursorword|.
+
+	g:cursorword_highlight			*g:cursorword_highlight*
+		Set this variable to 0 to disable the default highlighting
+		style. If you set this variable to 0, you need to define your
+		own style for the CursorWord |highlight-groups|.
+
+	g:cursorword_delay			*g:cursorword_delay*
+		The delay duration in milliseconds for setting the word
+		highlight after cursor motions. When the value is set to 0, the
+		plugin highlights the word synchronously, but there is a
+		performance sacrifice. The default value is 50.
+
+==============================================================================
+vim:tw=78:sw=4:ts=8:ft=help:norl:noet: