2011-04-12 23:17:59 +00:00
|
|
|
*togglebg.vim* For Vim version 7.3. or newer Modified: 2011 Apr 12
|
2011-04-07 21:47:34 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
TOGGLE BACKGROUND PLUGIN by Ethan Schoonover ~
|
|
|
|
|
|
2011-04-12 23:17:59 +00:00
|
|
|
Toggle Background *togglebackground*
|
|
|
|
|
*toggle-background*
|
|
|
|
|
*togglebg* *toggle-bg*
|
|
|
|
|
*togbg* *tog-bg*
|
2011-04-07 21:47:34 +00:00
|
|
|
|
|
|
|
|
Toggle Background is a simple plugin to switch between light and dark
|
|
|
|
|
background modes and reset the colorscheme. This is most useful for
|
|
|
|
|
colorschemes that support both light and dark modes and in terminals or gui
|
|
|
|
|
vim windows where the background will be properly set.
|
|
|
|
|
|
2011-04-12 23:17:59 +00:00
|
|
|
0. Usage |togglebg-usage|
|
|
|
|
|
1. Default Mapping |togglebg-default|
|
|
|
|
|
2. Changing the Mapping |togglebg-newmap|
|
|
|
|
|
3. Issues |togglebg-issues|
|
2011-04-07 21:47:34 +00:00
|
|
|
|
|
|
|
|
==============================================================================
|
2011-04-12 23:17:59 +00:00
|
|
|
0. Usage *togglebg-usage*
|
2011-04-07 21:47:34 +00:00
|
|
|
|
|
|
|
|
Press your map key(s) to activate Toggle Background, or select "Toggle
|
|
|
|
|
Background" from the 'Window' menu while in gui mode.
|
|
|
|
|
|
|
|
|
|
==============================================================================
|
2011-04-12 23:17:59 +00:00
|
|
|
1. Default Mapping *togglebg-default*
|
2011-04-07 21:47:34 +00:00
|
|
|
|
|
|
|
|
Toggle Background starts with a default mapping to function key <F5>. If you
|
|
|
|
|
are already using this in a mapping, Toggle Background will not map itself to
|
|
|
|
|
a default and you will have to map it manually in your .vimrc file, or
|
|
|
|
|
remove/change your existing <F5> mapping to another value.
|
|
|
|
|
|
|
|
|
|
==============================================================================
|
2011-04-12 23:17:59 +00:00
|
|
|
2. Changing the Mapping *togglebg-newmap*
|
2011-04-07 21:47:34 +00:00
|
|
|
|
|
|
|
|
To set your own mapping in your .vimrc file, simply add the following three
|
2011-04-12 23:17:59 +00:00
|
|
|
lines to support normal, insert and visual mode usage, changing the "<F5>"
|
|
|
|
|
value to the key or key combination you wish to use:
|
2011-04-07 21:47:34 +00:00
|
|
|
|
2011-04-12 23:17:59 +00:00
|
|
|
call togglebg#map("<F5>")
|
2011-04-07 21:47:34 +00:00
|
|
|
|
2011-04-12 23:17:59 +00:00
|
|
|
Note that you'll want to use a single function key or equivalent if you want
|
|
|
|
|
the plugin to work in all modes (normal, insert, visual).
|
|
|
|
|
|
|
|
|
|
Note also that it is important to NOT use the noremap map variants. The plugin
|
|
|
|
|
uses noremap internally.
|
2011-04-07 21:47:34 +00:00
|
|
|
|
|
|
|
|
==============================================================================
|
2011-04-12 23:17:59 +00:00
|
|
|
3. Issues *togglebg-issues*
|
2011-04-07 21:47:34 +00:00
|
|
|
|
|
|
|
|
When using the plugin during insert mode, there should be no interruption in
|
|
|
|
|
workflow. However, if you activate the plugin during REPLACE mode, you will
|
|
|
|
|
switch to insert mode.
|
|
|
|
|
|
|
|
|
|
vim:tw=78:noet:ts=8:ft=help:norl:
|
