diff options
Diffstat (limited to 'doc/togglebg.txt')
-rw-r--r-- | doc/togglebg.txt | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/doc/togglebg.txt b/doc/togglebg.txt new file mode 100644 index 0000000..5839ddc --- /dev/null +++ b/doc/togglebg.txt @@ -0,0 +1,57 @@ +*togglebg.vim* For Vim version 7.3. or newer Modified: 2011 Apr 12 + + + TOGGLE BACKGROUND PLUGIN by Ethan Schoonover ~ + +Toggle Background *togglebackground* + *toggle-background* + *togglebg* *toggle-bg* + *togbg* *tog-bg* + +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. + +0. Usage |togglebg-usage| +1. Default Mapping |togglebg-default| +2. Changing the Mapping |togglebg-newmap| +3. Issues |togglebg-issues| + +============================================================================== +0. Usage *togglebg-usage* + +Press your map key(s) to activate Toggle Background, or select "Toggle +Background" from the 'Window' menu while in gui mode. + +============================================================================== +1. Default Mapping *togglebg-default* + +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. + +============================================================================== +2. Changing the Mapping *togglebg-newmap* + +To set your own mapping in your .vimrc file, simply add the following three +lines to support normal, insert and visual mode usage, changing the "<F5>" +value to the key or key combination you wish to use: + + call togglebg#map("<F5>") + +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. + +============================================================================== +3. Issues *togglebg-issues* + +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: |