diff options
| author | Tom Ryder <tom@sanctum.geek.nz> | 2017-11-04 17:57:39 +1300 |
|---|---|---|
| committer | Tom Ryder <tom@sanctum.geek.nz> | 2017-11-04 17:59:54 +1300 |
| commit | dae845727dbb3a7f91137d85d322ee475d604289 (patch) | |
| tree | 4fe5abe81f0ce3087dc38ec69a9cad36222b840a /vim/doc/detect_background.txt | |
| parent | Use same comment boilerplate for custom plugins (diff) | |
| download | dotfiles-dae845727dbb3a7f91137d85d322ee475d604289.tar.gz dotfiles-dae845727dbb3a7f91137d85d322ee475d604289.zip | |
Add short documentation for new custom plugins
I'm using the plugin_name.txt syntax suggested by the Vim documentation.
That may change in future as I study plugins written by experienced
authors like Tim Pope.
There will almost certainly be a lot more detail to add to each of
these.
Diffstat (limited to 'vim/doc/detect_background.txt')
| -rw-r--r-- | vim/doc/detect_background.txt | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/vim/doc/detect_background.txt b/vim/doc/detect_background.txt new file mode 100644 index 00000000..ad42221c --- /dev/null +++ b/vim/doc/detect_background.txt @@ -0,0 +1,14 @@ +*detect_background.txt* Figure out 'background' with a bias towards "dark" + +Author: Tom Ryder <tom@sanctum.geek.nz> +License: Same terms as Vim itself (see |license|) + +This plugin inspects the $COLORFGBG environment variable to determine whether +the user is using a terminal with a light background. It reverses Vim's +built-in attempts to do this, which have the opposite default. + +It does not inspect the value of the $TERM variable or |'term'| at all. + +This plugin lives in Tom Ryder's "dotfiles" suite, and will eventually be spun +off into a separate distribution as it solidifies and this documentation +improves. |