diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 29 |
1 files changed, 24 insertions, 5 deletions
@@ -54,6 +54,26 @@ The plug-in will try to determine the location where Exuberant Ctags is installe :let g:easytags_cmd = '/usr/local/bin/ctags' +If you rely entirely on language-specific configuration and don't have a general ctags program, set this to the empty string. + +### The `g:easytags_languages` option + +Exuberant Ctags supports many languages and can be extended via regular expression patterns, but for some languages separate tools with ctags-compatible output exist (e.g. [jsctags] [jsctags] for Javascript). To use these, the executable and its arguments must be configured: + + let g:easytags_languages = { + \ 'language': { + \ 'cmd': g:easytags_cmd, + \ 'args': [], + \ 'fileoutput_opt': '-f', + \ 'stdout_opt': '-f-', + \ 'recurse_flag': '-R' + \ } + \} + +Each key is a special language definition. The key is in the notation of ctags in lowercase; you still need to use `xolox#easytags#map_filetypes()` to map this to Vim's filetypes, if necessary. + +Above snippets shows the defaults; you only need to specify options that differ. + ### The `g:easytags_file` option As mentioned above the plug-in will store your tags in `~/.vimtags` on UNIX and `~/_vimtags` on Windows. To change the location of this file, set the global variable `g:easytags_file`, e.g.: @@ -105,11 +125,9 @@ Note: Like the `g:easytags_always_enabled` option, if you change this option it ### The `g:easytags_updatetime_min` option -Vim has a setting which influences how often the plug-in is automatically executed. When this setting is too low, the plug-in can break. For this reason the plug-in warns you when ['updatetime'][updatetime] is lower than 4000 milliseconds. If you really want the plug-in to be executed more than once every 4 seconds (without a warning) you can lower the minimum acceptable updatetime by setting this option (number of milliseconds). - -### The `g:easytags_updatetime_autodisable` option +Vim has a setting which influences how often the plug-in is automatically executed. When this setting is too low, the plug-in can break. For this reason the plug-in compensates by keeping track of when it was last executed. You'll get one warning when the plug-in first notices the low value, after that it will shut up. The default value of this option is 4000 milliseconds (4 seconds). -Other plug-ins may lower the ['updatetime'][updatetime] value in certain contexts, e.g. insert mode in the case of the [neocomplcache][neocomplcache] plug-in. By setting this option to 1 (true) you can configure the easytags plug-in so that it doesn't give warnings about the updatetime option but instead skip updating and highlighting while the updatetime is set too low. When the updatetime is restored to a reasonable value the plug-in resumes. +If you really want the plug-in to be executed more than once every 4 seconds you can lower the minimum acceptable updatetime by setting this option (as the number of milliseconds) however note that subsecond granularity is not supported. ### The `g:easytags_auto_update` option @@ -260,7 +278,7 @@ If you have questions, bug reports, suggestions, etc. the author can be contacte ## License This software is licensed under the [MIT license](http://en.wikipedia.org/wiki/MIT_License). -© 2011 Peter Odding <<peter@peterodding.com>>. +© 2013 Peter Odding <<peter@peterodding.com>>. [canon]: http://en.wikipedia.org/wiki/Canonicalization @@ -278,6 +296,7 @@ This software is licensed under the [MIT license](http://en.wikipedia.org/wiki/M [exctags]: http://ctags.sourceforge.net/ [hlinks]: http://en.wikipedia.org/wiki/Hard_link [ide]: http://en.wikipedia.org/wiki/Integrated_development_environment +[jsctags]: https://npmjs.org/package/jsctags [messages]: http://vimdoc.sourceforge.net/htmldoc/message.html#:messages [neocomplcache]: http://www.vim.org/scripts/script.php?script_id=2620 [shell]: http://peterodding.com/code/vim/shell/ |