vim/vim-indent-guides
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Updated the readme and help file (again)

Browse Source
This commit is contained in:
Nate Kane 2010-12-29 21:29:13 +10:00
parent 9712a19ba9
commit a7d8f3dce7
2 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.markdown
View File

@ -22,26 +22,26 @@ Alternatively if you have [Pathogen](http://www.vim.org/scripts/script.php?scrip
The default mapping to toggle the plugin is `<Leader>ig` The default mapping to toggle the plugin is `<Leader>ig`
### Setting custom indent colors ### Setting custom indent colors
Here's an example of how to use custom colors instead of the ones the plugin automatically generates for you. Add this to your `.vimrc` file: Here's an example of how to define custom colors instead using of the ones the plugin automatically generates for you. Add this to your `.vimrc` file:
let g:indent_guides_auto_colors = 0 let g:indent_guides_auto_colors = 0
autocmd VimEnter,Colorscheme * :hi IndentGuidesOdd guibg=red ctermbg=3 autocmd VimEnter,Colorscheme * :hi IndentGuidesOdd guibg=red ctermbg=3
autocmd VimEnter,Colorscheme * :hi IndentGuidesEven guibg=green ctermbg=4 autocmd VimEnter,Colorscheme * :hi IndentGuidesEven guibg=green ctermbg=4
### Terminal Vim ### Terminal Vim
At the moment Terminal Vim only has basic support. This means is that colors won't be automatically calculated based on your colorscheme. Instead some preset colors are used depending on whether `set background=` is set to `dark` or `light`. At the moment Terminal Vim only has basic support. This means is that colors won't be automatically calculated based on your colorscheme. Instead, some preset colors are used depending on whether `background` is set to `dark` or `light`.
When `set background=dark` is used, the following highlight colors will be defined: When `set background=dark` is used, the following highlight colors will be defined:
hi IndentGuidesEven ctermbg=darkgrey hi IndentGuidesEven ctermbg=darkgrey
hi IndentGuidesOdd ctermbg=black hi IndentGuidesOdd ctermbg=black
When `set background=light` is used, the following highlight colors will be defined: Alternatively, when `set background=light` is used, the following highlight colors will be defined:
hi IndentGuidesEven ctermbg=lightgrey hi IndentGuidesEven ctermbg=lightgrey
hi IndentGuidesOdd ctermbg=white hi IndentGuidesOdd ctermbg=white
If for some reason it's defining light highlight colors instead of dark ones or vice versa, the first thing you should check is that `set background=` is being set correctly for your colorscheme. Sometimes it's best to manually set the `background` value in your `.vimrc`, for example: If for some reason it's incorrectly defining light highlight colors instead of dark ones or vice versa, the first thing you should check is that the `background` value is being set correctly for your colorscheme. Sometimes it's best to manually set the `background` value in your `.vimrc`, for example:
colorscheme desert256 colorscheme desert256
set background=dark set background=dark

18
doc/indent_guides.txt
View File

@ -111,9 +111,9 @@ example:
5. TERMINAL VIM *indent-guides-terminal-vim* 5. TERMINAL VIM *indent-guides-terminal-vim*
At the moment Terminal Vim only has basic support. This means is that colors At the moment Terminal Vim only has basic support. This means is that colors
won't be automatically calculated based on your colorscheme. Instead some won't be automatically calculated based on your colorscheme. Instead, some
preset colors are used depending on whether `set background=` is set to `dark` preset colors are used depending on whether `background` is set to `dark` or
or `light`. `light`.
When `set background=dark` is used, the following highlight colors will be When `set background=dark` is used, the following highlight colors will be
defined: defined:
@ -122,17 +122,17 @@ defined:
hi IndentGuidesOdd ctermbg=black hi IndentGuidesOdd ctermbg=black
< <
When `set background=light` is used, the following highlight colors will be Alternatively, when `set background=light` is used, the following highlight
defined: colors will be defined:
> >
hi IndentGuidesEven ctermbg=lightgrey hi IndentGuidesEven ctermbg=lightgrey
hi IndentGuidesOdd ctermbg=white hi IndentGuidesOdd ctermbg=white
< <
If for some reason it's defining light highlight colors instead of dark ones If for some reason it's incorrectly defining light highlight colors instead of
or vice versa, the first thing you should check is that `set background=` is dark ones or vice versa, the first thing you should check is that the
being set correctly for your colorscheme. Sometimes it's best to manually set `background` value is being set correctly for your colorscheme. Sometimes it's
the `background` value in your .vimrc, for example: best to manually set the `background` value in your `.vimrc`, for example:
> >
colorscheme desert256 colorscheme desert256
set background=dark set background=dark