ats-vim/doc/ats.txt

47 lines
1.5 KiB
Text
Raw Normal View History

2017-12-23 15:38:19 -05:00
*ats* ATS environment for vim
2017-12-23 15:36:00 -05:00
=====================================================================
CONTENTS *ATSContents*
1. Usage ............................................. ❘ATSUsage❘
2. Config ........................................... ❘ATSConfig❘
=====================================================================
Section 1: Usage *ATSUsage*
By default, ats-vim provides one command, viz.
:Format *:Format*
2017-12-23 15:38:19 -05:00
Run atsfmt on current file and reload with changes, e.g. >
2017-12-23 15:36:00 -05:00
:Format
<
======================================================================
Section 2: Config *ATSConfig*
----------------------------------------------------------------------
2017-12-23 20:52:41 -05:00
*'g:ats_use_ctags'*
2017-12-23 15:36:00 -05:00
Values: 0, 1
Default: 0
2017-12-23 20:52:41 -05:00
When set to 1, ctags will be called on each file write to index the
current project. >
let g:ats_use_ctags=1
<
*'g:ats_autoformat'*
Values: 0, 1
2017-12-23 15:36:00 -05:00
When set to 1, the current buffer will be formatted every time it is
2017-12-23 15:38:19 -05:00
written to. >
2017-12-23 20:52:41 -05:00
let g:ats_autoformat=0
2017-12-23 15:36:00 -05:00
<
2017-12-23 17:24:07 -05:00
*ClearATS*
If you would like to bind a key to clear error messages use something
like the following in your .vimrc: >
au BufNewFile,BufRead *.*ats nmap <Leader>h <Plug>Clear
<