Mercurial > vim-gutentags
comparison doc/gutentags.txt @ 49:70423c2202c5
Ctags options files changes
* Remove the `g:gutentags_ctags_options_file` setting since it's mostly useless.
* Use the script's `-o` option to pass a `.ctags` file in the project root if it exists.
* Add documentation.
author | Ludovic Chabant <ludovic@chabant.com> |
---|---|
date | Thu, 09 Apr 2015 22:00:37 -0700 |
parents | 7b419abf7fba |
children | 9e768b83d701 |
comparison
equal
deleted
inserted
replaced
48:c1b33dc55b1c | 49:70423c2202c5 |
---|---|
30 | 30 |
31 1. Introduction |gutentags-intro| | 31 1. Introduction |gutentags-intro| |
32 2. Commands |gutentags-commands| | 32 2. Commands |gutentags-commands| |
33 3. Status Line |gutentags-status-line| | 33 3. Status Line |gutentags-status-line| |
34 4. Global Settings |gutentags-settings| | 34 4. Global Settings |gutentags-settings| |
35 5. Project Settings |gutentags-project-settings| | |
35 | 36 |
36 ============================================================================= | 37 ============================================================================= |
37 1. Introduction *gutentags-intro* | 38 1. Introduction *gutentags-intro* |
38 | 39 |
39 Gutentags is a plugin that takes care of the much needed management of tags | 40 Gutentags is a plugin that takes care of the much needed management of tags |
172 that Vim does it for you. | 173 that Vim does it for you. |
173 If you find that you need to use this more than a | 174 If you find that you need to use this more than a |
174 couple times ever, there's probably a bug with | 175 couple times ever, there's probably a bug with |
175 Gutentags, or something otherwise wrong or unexpected | 176 Gutentags, or something otherwise wrong or unexpected |
176 with your system. Please file a bug. | 177 with your system. Please file a bug. |
178 | |
177 | 179 |
178 ============================================================================= | 180 ============================================================================= |
179 3. Status Line *gutentags-status-line* | 181 3. Status Line *gutentags-status-line* |
180 | 182 |
181 Tag file generation can take a while if you're working on a project big | 183 Tag file generation can take a while if you're working on a project big |
251 from parsing for the tags generation. | 253 from parsing for the tags generation. |
252 Defaults to `[]` (an empty |List|). | 254 Defaults to `[]` (an empty |List|). |
253 Patterns defined in 'wildignore' will also be given as | 255 Patterns defined in 'wildignore' will also be given as |
254 exclude patterns to the `ctags` executable. | 256 exclude patterns to the `ctags` executable. |
255 | 257 |
256 *gutentags_ctags_options_file* | |
257 g:gutentags_ctags_options_file | |
258 The path to an options file that will be passed to | |
259 the `ctags` executable with the `--options` option. | |
260 In general you can put options in a `$HOME/.ctags` | |
261 file, but this lets you specify a custom file | |
262 specifically for Vim/Gutentags. | |
263 | |
264 *gutentags_auto_set_tags* | 258 *gutentags_auto_set_tags* |
265 g:gutentags_auto_set_tags | 259 g:gutentags_auto_set_tags |
266 If set to 1, Gutentags will automatically prepend | 260 If set to 1, Gutentags will automatically prepend |
267 'tags' with the exact path to the tag file for the | 261 'tags' with the exact path to the tag file for the |
268 current project. See |gutentags_project_root| for how | 262 current project. See |gutentags_project_root| for how |
316 g:gutentags_define_advanced_commands | 310 g:gutentags_define_advanced_commands |
317 Defines some advanced commands like | 311 Defines some advanced commands like |
318 |GutentagsToggleEnabled| and |GutentagsUnlock|. | 312 |GutentagsToggleEnabled| and |GutentagsUnlock|. |
319 | 313 |
320 | 314 |
315 ============================================================================= | |
316 5. Project Settings *gutentags-project-settings* | |
317 | |
318 Gutentags can be customized to some extent on a per-project basis with the | |
319 following files present in the project root directory: | |
320 | |
321 *gutentags-.ctags* | |
322 `.ctags`: if this file exists, Ctags will be told to load additional | |
323 command-line parameters by reading it line by line (see the Ctags | |
324 documentation for more information). | |
325 | |
326 Note that for complex reasons, Gutentags can't always run `ctags` from the | |
327 project root, so if the `.ctags` file exists, its path will actually be passed | |
328 through the `--options=` parameter. | |
329 | |
330 *gutentags-.notags* | |
331 `.notags`: if this file exists, Gutentags will be disabled completely for that | |
332 project. | |
333 | |
334 | |
321 vim:tw=78:et:ft=help:norl: | 335 vim:tw=78:et:ft=help:norl: |