path: root/vim/doc/detect_background.txt
diff options
authorTom Ryder <tom@sanctum.geek.nz>2017-11-12 22:41:23 +1300
committerTom Ryder <tom@sanctum.geek.nz>2017-11-12 22:41:23 +1300
commit9e31143b66cc44a93f3e369b671ace64e38bb8a5 (patch)
treee105daedd523f4301ca55e013736813c548d1fd3 /vim/doc/detect_background.txt
parentd82c507a79c6dd1aeb9dfaaab261846a6e8dabb1 (diff)
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
--- a/vim/doc/detect_background.txt
+++ b/vim/doc/detect_background.txt
@@ -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 <tom@sanctum.geek.nz>
-License: Same terms as Vim itself (see |license|)
+DESCRIPTION *detect_background*
-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
+REQUIREMENTS *detect_background-requirements*
+This plugin is only available if 'compatible' is not set.
+AUTHOR *detect_background-author*
+Written and maintained by Tom Ryder <tom@sanctum.geek.nz>.
+LICENSE *detect_background-license*
+Licensed for distribution under the same terms as Vim itself (see |license|).
+DISTRIBUTION *detect_background-distribution*
+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
+ vim:tw=78:ts=8:ft=help:norl: