|author||Tom Ryder <email@example.com>||2017-11-12 22:41:23 +1300|
|committer||Tom Ryder <firstname.lastname@example.org>||2017-11-12 22:41:23 +1300|
Apply boilerplate to Vim plugin docs
The DESCRIPTION heading for each of these is filled out now, but some of them probably need a bit more explanation. The mail_mutt.txt plugin is good, though.
Diffstat (limited to 'vim/doc/detect_background.txt')
1 files changed, 22 insertions, 6 deletions
diff --git a/vim/doc/detect_background.txt b/vim/doc/detect_background.txt
index ed122aee..55992288 100644
@@ -1,9 +1,8 @@
-*detect_background.txt* Figure out 'background' with a bias towards "dark"
+*detect_background.txt* For Vim version 7.0 Last change: 2017 November 12
-Author: Tom Ryder <email@example.com>
-License: Same terms as Vim itself (see |license|)
-The detect_background#DetectBackground() function provided by this plugin
+The |detect_background#DetectBackground()| function provided by this plugin
inspects the $COLORFGBG environment variable to determine whether the user is
using a terminal with a light background, and returns the word "dark" or
"light" accordingly, for use in setting 'background'.
@@ -15,6 +14,23 @@ hints otherwise.
Note that this plugin does not inspect the value of the $TERM environment
variable or the |'term'| option at all, nor the |'t_RB'| option.
-This plugin lives in Tom Ryder's "dotfiles" suite, and will eventually be spun
+This plugin is only available if 'compatible' is not set.
+Written and maintained by Tom Ryder <firstname.lastname@example.org>.
+Licensed for distribution under the same terms as Vim itself (see |license|).
+This plugin lives in Tom Ryder's "dotfiles" suite, and may eventually be spun
off into a separate distribution as it solidifies and this documentation
+improves. See <https://sanctum.geek.nz/cgit/dotfiles.git/about/> for more