2013-07-01 19:49:40 -04:00
|
|
|
|
*airline.txt* Lean and mean statusline that's light as air
|
2013-07-01 07:33:26 -04:00
|
|
|
|
|
|
|
|
|
==============================================================================
|
2013-07-15 10:45:47 -04:00
|
|
|
|
INTRODUCTION *airline*
|
2013-07-01 07:33:26 -04:00
|
|
|
|
|
2013-08-02 08:11:53 -04:00
|
|
|
|
vim-airline is a fast and lightweight alternative to powerline, written
|
|
|
|
|
in 100% vimscript with no outside dependencies.
|
2013-07-01 07:33:26 -04:00
|
|
|
|
|
2013-08-02 08:11:53 -04:00
|
|
|
|
==============================================================================
|
|
|
|
|
FEATURES *airline-features*
|
|
|
|
|
|
|
|
|
|
* tiny core written with extensibility in mind.
|
|
|
|
|
* integrates with many popular plugins.
|
2013-07-31 16:07:14 -04:00
|
|
|
|
* looks good with regular fonts, and provides configuration points so you
|
2013-07-07 23:12:05 -04:00
|
|
|
|
can use unicode or powerline symbols.
|
2013-08-02 08:11:53 -04:00
|
|
|
|
* optimized for speed; it loads in 1ms.
|
2013-07-31 16:07:14 -04:00
|
|
|
|
* fully customizable; if you know a little |statusline| syntax you can
|
2013-07-07 23:12:05 -04:00
|
|
|
|
tweak it to your needs.
|
2013-07-31 16:07:14 -04:00
|
|
|
|
* trivial to write colorschemes; for a minimal theme you need to edit
|
|
|
|
|
9 lines of colors. (please send pull requests)
|
2013-07-01 07:33:26 -04:00
|
|
|
|
|
|
|
|
|
==============================================================================
|
|
|
|
|
NAME *airline-name*
|
|
|
|
|
|
2013-07-22 17:23:41 -04:00
|
|
|
|
Where did the name come from?
|
2013-07-01 07:33:26 -04:00
|
|
|
|
|
2013-07-10 09:48:13 -04:00
|
|
|
|
I wrote this on an airplane, and since it's light as air it turned out to be a
|
2013-07-01 07:33:26 -04:00
|
|
|
|
good name :-)
|
|
|
|
|
|
|
|
|
|
==============================================================================
|
2013-07-01 19:49:40 -04:00
|
|
|
|
CONFIGURATION *airline-configuration*
|
2013-07-01 07:33:26 -04:00
|
|
|
|
|
2013-07-10 09:48:13 -04:00
|
|
|
|
There are a couple configuration values available (shown with their default
|
2013-07-01 07:33:26 -04:00
|
|
|
|
values):
|
|
|
|
|
|
2013-07-01 23:48:50 -04:00
|
|
|
|
* the separator used on the left side
|
2013-07-01 07:33:26 -04:00
|
|
|
|
>
|
|
|
|
|
let g:airline_left_sep='>'
|
|
|
|
|
<
|
|
|
|
|
|
2013-07-01 23:48:50 -04:00
|
|
|
|
* the separator used on the right side
|
2013-07-01 07:33:26 -04:00
|
|
|
|
>
|
2013-07-02 05:49:06 -04:00
|
|
|
|
let g:airline_right_sep='<'
|
2013-07-01 07:33:26 -04:00
|
|
|
|
<
|
|
|
|
|
|
2013-07-18 01:56:29 -04:00
|
|
|
|
* enable/disable fugitive/lawrencium integration
|
2013-07-01 07:33:26 -04:00
|
|
|
|
>
|
2013-07-27 18:15:00 -04:00
|
|
|
|
let g:airline_enable_branch=1
|
2013-07-01 07:33:26 -04:00
|
|
|
|
<
|
|
|
|
|
|
|
|
|
|
* enable/disable syntastic integration
|
|
|
|
|
>
|
|
|
|
|
let g:airline_enable_syntastic=1
|
|
|
|
|
<
|
|
|
|
|
|
2013-07-31 16:07:14 -04:00
|
|
|
|
* enable/disable tagbar integration
|
|
|
|
|
>
|
|
|
|
|
let g:airline_enable_tagbar=1
|
|
|
|
|
<
|
|
|
|
|
|
2013-07-22 17:23:41 -04:00
|
|
|
|
* enable modified detection
|
|
|
|
|
>
|
|
|
|
|
let g:airline_detect_modified=1
|
|
|
|
|
<
|
|
|
|
|
|
|
|
|
|
* enable paste detection
|
|
|
|
|
>
|
|
|
|
|
let g:airline_detect_paste=1
|
|
|
|
|
<
|
2013-07-24 07:35:31 -04:00
|
|
|
|
* enable iminsert detection
|
|
|
|
|
>
|
|
|
|
|
let g:airline_detect_iminsert=1
|
2013-07-22 17:23:41 -04:00
|
|
|
|
|
2013-07-15 16:19:26 -04:00
|
|
|
|
* change the default theme
|
2013-07-01 07:33:26 -04:00
|
|
|
|
>
|
2013-07-05 20:15:52 -04:00
|
|
|
|
let g:airline_theme='dark'
|
2013-07-01 07:33:26 -04:00
|
|
|
|
<
|
|
|
|
|
|
|
|
|
|
* enable/disable usage of patched powerline font symbols
|
|
|
|
|
>
|
|
|
|
|
let g:airline_powerline_fonts=0
|
|
|
|
|
<
|
|
|
|
|
|
2013-07-04 11:39:49 -04:00
|
|
|
|
* define the set of text to display for each mode.
|
|
|
|
|
>
|
|
|
|
|
let g:airline_mode_map = {} " see source for current list
|
|
|
|
|
<
|
|
|
|
|
|
2013-07-02 07:04:36 -04:00
|
|
|
|
* define the set of filename match queries which excludes a window from having
|
|
|
|
|
its statusline modified
|
2013-07-02 07:00:31 -04:00
|
|
|
|
>
|
2013-07-02 07:04:36 -04:00
|
|
|
|
let g:airline_exclude_filenames = [] " see source for current list
|
2013-07-02 07:00:31 -04:00
|
|
|
|
<
|
|
|
|
|
|
|
|
|
|
* define the set of filetypes which are excluded from having its window
|
|
|
|
|
statusline modified
|
|
|
|
|
>
|
|
|
|
|
let g:airline_exclude_filetypes = [] " see source for current list
|
|
|
|
|
<
|
2013-07-07 20:38:19 -04:00
|
|
|
|
|
2013-07-14 15:44:16 -04:00
|
|
|
|
* defines whether the preview window should be excluded from have its window
|
|
|
|
|
statusline modified (may help with plugins which use the preview window
|
|
|
|
|
heavily)
|
|
|
|
|
>
|
|
|
|
|
let g:airline_exclude_preview = 0
|
|
|
|
|
<
|
|
|
|
|
|
2013-07-15 16:19:26 -04:00
|
|
|
|
==============================================================================
|
|
|
|
|
COMMANDS *airline-commands*
|
|
|
|
|
|
|
|
|
|
:AirlineTheme {theme-name} *:AirlineTheme*
|
|
|
|
|
Displays or changes the current theme.
|
|
|
|
|
|
2013-07-01 19:49:40 -04:00
|
|
|
|
==============================================================================
|
|
|
|
|
CUSTOMIZATION *airline-customization*
|
|
|
|
|
|
2013-07-10 09:48:13 -04:00
|
|
|
|
The following are some unicode symbols for customizing the left/right
|
|
|
|
|
separators, as well as the powerline font glyths.
|
2013-07-01 19:49:40 -04:00
|
|
|
|
|
|
|
|
|
>
|
|
|
|
|
" unicode symbols
|
|
|
|
|
let g:airline_left_sep = '»'
|
|
|
|
|
let g:airline_left_sep = '▶'
|
|
|
|
|
let g:airline_right_sep = '«'
|
|
|
|
|
let g:airline_right_sep = '◀'
|
|
|
|
|
let g:airline_linecolumn_prefix = '␊ '
|
|
|
|
|
let g:airline_linecolumn_prefix = ' '
|
2013-07-02 07:00:31 -04:00
|
|
|
|
let g:airline_linecolumn_prefix = '¶ '
|
2013-07-27 18:15:00 -04:00
|
|
|
|
let g:airline_branch_prefix = '⎇ '
|
2013-07-06 14:22:34 -04:00
|
|
|
|
let g:airline_paste_symbol = 'ρ'
|
2013-07-06 14:30:21 -04:00
|
|
|
|
let g:airline_paste_symbol = 'Þ'
|
|
|
|
|
let g:airline_paste_symbol = '∥'
|
2013-07-01 19:49:40 -04:00
|
|
|
|
|
|
|
|
|
" powerline symbols
|
|
|
|
|
let g:airline_left_sep = ''
|
2013-07-07 20:38:19 -04:00
|
|
|
|
let g:airline_left_alt_sep = ''
|
2013-07-17 22:28:21 -04:00
|
|
|
|
let g:airline_right_sep = ''
|
|
|
|
|
let g:airline_right_alt_sep = ''
|
2013-07-27 18:15:00 -04:00
|
|
|
|
let g:airline_branch_prefix = ' '
|
2013-07-01 19:49:40 -04:00
|
|
|
|
let g:airline_readonly_symbol = ''
|
|
|
|
|
let g:airline_linecolumn_prefix = ' '
|
2013-07-17 15:09:18 -04:00
|
|
|
|
|
|
|
|
|
" old vim-powerline symbols
|
|
|
|
|
let g:airline_left_sep = '⮀'
|
|
|
|
|
let g:airline_left_alt_sep = '⮁'
|
|
|
|
|
let g:airline_right_sep = '⮂'
|
|
|
|
|
let g:airline_right_alt_sep = '⮃'
|
2013-07-27 18:15:00 -04:00
|
|
|
|
let g:airline_branch_prefix = '⭠'
|
2013-07-17 15:09:18 -04:00
|
|
|
|
let g:airline_readonly_symbol = '⭤'
|
|
|
|
|
let g:airline_linecolumn_prefix = '⭡'
|
2013-07-01 19:49:40 -04:00
|
|
|
|
<
|
|
|
|
|
|
2013-07-10 09:48:13 -04:00
|
|
|
|
For more intricate customizations, you can replace the predefined sections
|
2013-07-06 13:01:21 -04:00
|
|
|
|
with the usual statusline syntax.
|
2013-07-04 11:39:49 -04:00
|
|
|
|
|
|
|
|
|
>
|
2013-07-07 20:38:19 -04:00
|
|
|
|
" here are the the default values
|
2013-07-15 16:19:26 -04:00
|
|
|
|
let g:airline_section_a (the mode/paste indicator)
|
2013-07-18 01:56:29 -04:00
|
|
|
|
let g:airline_section_b (the fugitive/lawrencium branch indicator)
|
2013-07-07 21:00:14 -04:00
|
|
|
|
let g:airline_section_c (bufferline or filename)
|
2013-08-02 13:56:12 -04:00
|
|
|
|
let g:airline_section_gutter (syntastic, readonly flag, tagbar)
|
2013-07-07 21:00:14 -04:00
|
|
|
|
let g:airline_section_x (filetype)
|
|
|
|
|
let g:airline_section_y (fileencoding, fileformat)
|
|
|
|
|
let g:airline_section_z (percentage, line number, column number)
|
2013-07-07 23:12:05 -04:00
|
|
|
|
|
2013-07-27 18:15:00 -04:00
|
|
|
|
" here is an example of how you could replace the branch indicator with
|
2013-07-07 23:12:05 -04:00
|
|
|
|
" the current working directory, followed by the filename.
|
|
|
|
|
let g:airline_section_b = '%{getcwd()}'
|
|
|
|
|
let g:airline_section_c = '%t'
|
2013-07-04 11:39:49 -04:00
|
|
|
|
<
|
|
|
|
|
|
2013-07-10 09:48:13 -04:00
|
|
|
|
If there is a particular plugin or filetype that is not supported, you can
|
|
|
|
|
extend it by adding a function reference to the global array. Here is an
|
|
|
|
|
example that you could add to your vimrc:
|
|
|
|
|
>
|
|
|
|
|
function! MyPlugin()
|
|
|
|
|
if &filetype == 'MyPluginFileType'
|
|
|
|
|
let w:airline_section_a = 'MyPlugin'
|
|
|
|
|
let w:airline_section_b = '%f'
|
|
|
|
|
let w:airline_section_c = '%{MyPlugin#function()}'
|
|
|
|
|
endif
|
|
|
|
|
endfunction
|
|
|
|
|
call add(g:airline_window_override_funcrefs, function('MyPlugin'))
|
|
|
|
|
<
|
2013-07-10 15:55:55 -04:00
|
|
|
|
|
2013-07-25 18:48:15 -04:00
|
|
|
|
In a similar fashion, you can define a function to exclude a window from
|
|
|
|
|
having its statusline modified.
|
|
|
|
|
>
|
|
|
|
|
function! ExcludeFoo()
|
|
|
|
|
return &filetype == 'FooType'
|
|
|
|
|
endfunction
|
|
|
|
|
call add(g:airline_exclude_funcrefs, function('ExcludeFoo'))
|
|
|
|
|
<
|
|
|
|
|
|
2013-07-23 23:00:23 -04:00
|
|
|
|
==============================================================================
|
|
|
|
|
WRITING THEMES *airline-themes*
|
|
|
|
|
|
|
|
|
|
Themes are written "close to the metal" -- you will need to know some basic
|
|
|
|
|
VimL syntax to write a theme, but if you're written in any programming
|
|
|
|
|
language it will be easy to pick up. Have a look at the dark.vim theme
|
|
|
|
|
where it is fully documented.
|
|
|
|
|
|
2013-07-20 09:24:15 -04:00
|
|
|
|
==============================================================================
|
|
|
|
|
TROUBLESHOOTING *airline-troubleshooting*
|
|
|
|
|
|
|
|
|
|
Solutions to common problems can be found FAQ section in the Wiki:
|
|
|
|
|
<https://github.com/bling/vim-airline/wiki/FAQ>
|
|
|
|
|
|
2013-07-01 07:33:26 -04:00
|
|
|
|
==============================================================================
|
|
|
|
|
CONTRIBUTIONS *airline-contributions*
|
|
|
|
|
|
2013-07-15 10:45:47 -04:00
|
|
|
|
Contributions and pull requests are welcome.
|
2013-07-01 07:33:26 -04:00
|
|
|
|
|
|
|
|
|
==============================================================================
|
|
|
|
|
LICENSE *airline-license*
|
|
|
|
|
|
2013-08-02 13:56:12 -04:00
|
|
|
|
MIT license. Copyright © 2013 Bailey Ling.
|
2013-07-15 10:45:47 -04:00
|
|
|
|
|
2013-07-01 07:33:26 -04:00
|
|
|
|
|
|
|
|
|
vim:tw=78:ts=8:ft=help:norl:
|