aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorPeter Odding <peter@peterodding.com>2014-11-21 22:35:26 +0100
committerPeter Odding <peter@peterodding.com>2014-11-21 22:35:26 +0100
commit8925dc699830e8e018efb36c60b14596b065fe9c (patch)
tree21fe2a3dd7fc43a3e560f626d260f7877b35b50b /doc
parent075ffe9054dd71f8c2f26fe9cfa4fd5200e6af96 (diff)
downloadvim-easytags-8925dc699830e8e018efb36c60b14596b065fe9c.tar.gz
Improve handling & docs of g:easytags_opts option (issue #98)
Diffstat (limited to 'doc')
-rw-r--r--doc/easytags.txt9
1 files changed, 8 insertions, 1 deletions
diff --git a/doc/easytags.txt b/doc/easytags.txt
index 6c1a5a6..913b020 100644
--- a/doc/easytags.txt
+++ b/doc/easytags.txt
@@ -194,7 +194,14 @@ If you need to pass custom command line option(s) to the program specified by
|g:easytags_cmd| you can set this option to a list of strings to be passed to
Exuberant Ctags. Make sure to only use options that are valid in any context,
for example the concatenation of |g:easytags_cmd|, |g:easytags_opts| and
-'--list-languages' should work as expected.
+'--list-languages' should work as expected. Here's an example:
+>
+ :let g:easytags_opts = ['--options=$VIM\ctags\ctags.cnf']
+<
+The example above (based on [issue 98] [98]) overrides the location of
+Exuberant Ctags' configuration file. As you can see the command line option(s)
+may contain environment variables, these will be expanded before passing the
+options to Exuberant Ctags (to make sure it works in all environments).
-------------------------------------------------------------------------------
The *g:easytags_async* option