Mercurial > vim-gutentags

comparison doc/gutentags.txt @ 204:30ac3583c902

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Re-arrange documentation of settings per module. Add missing settings.
author Ludovic Chabant <ludovic@chabant.com>
date Sat, 31 Mar 2018 19:23:51 -0700
parents b50b6d0f82dd
children 20bfab5b054f
comparison
equal deleted inserted replaced
203:6e96ddda0fd3 204:30ac3583c902
238 loaded and will keep track of what happened while it 238 loaded and will keep track of what happened while it
239 was disabled. However, |gutentags_dont_load| only 239 was disabled. However, |gutentags_dont_load| only
240 works on Vim startup and will prevent Gutentags from 240 works on Vim startup and will prevent Gutentags from
241 loading at all, as if it wasn't there. 241 loading at all, as if it wasn't there.
242 242
243 *gutentags_ctags_executable* 243 *gutentags_modules*
244 g:gutentags_ctags_executable 244 g:gutentags_modules
245 Specifies the ctags executable to launch. 245 A list of modules to load with Gutentags. Each module
246 Defaults to `ctags`. 246 is responsible for generating a specific type of tags
247 247 file.
248 *gutentags_ctags_executable_{filetype}* 248 Valid values are:
249 g:gutentags_ctags_executable_{type} 249
250 Specifies the ctags executable to launch for a project 250 - `ctags`: generates a `tags` file using
251 of type {type}. See |gutentags_project_info| for more 251 a `ctags`-compatible program like Exhuberant Ctags
252 information. 252 or Universal Ctags.
253 IMPORTANT: please see |gutentags-ctags-requirements|. 253
254 Example: > 254 - `cscope`: generates a code database file using
255 let g:gutentags_ctags_executable_ruby = 'foobar' 255 `cscope`.
256 < 256
257 257 - `gtags_cscope`: same as `cscope` but uses GNU's
258 *gutentags_ctags_tagfile* 258 `gtags` executable and database.
259 g:gutentags_ctags_tagfile 259
260 Specifies the name of the tag file to create. This 260 Defaults to `[ctags]`.
261 will be appended to the project's root. See
262 |gutentags_project_root| for how Gutentags locates the
263 project.
264 Defaults to `tags`.
265 261
266 *gutentags_project_root* 262 *gutentags_project_root*
267 g:gutentags_project_root 263 g:gutentags_project_root
268 When a buffer is loaded, Gutentags will figure out if 264 When a buffer is loaded, Gutentags will figure out if
269 it's part of a project that should have tags managed 265 it's part of a project that should have tags managed
313 returns a string value (the project's root directory). 309 returns a string value (the project's root directory).
314 Defaults to `''`. 310 Defaults to `''`.
315 Note: when set, the called implementation will most 311 Note: when set, the called implementation will most
316 likely ignore |g:gutentags_project_root|. 312 likely ignore |g:gutentags_project_root|.
317 313
318 *gutentags_ctags_exclude*
319 g:gutentags_ctags_exclude
320 A list of file patterns to pass to the
321 |gutentags_ctags_executable| so that they will be
322 excluded from parsing for the tags generation.
323 See also |gutentags_ctags_exclude_wildignore|.
324 Defaults to `[]` (an empty |List|).
325
326 *gutentags_ctags_exclude_wildignore*
327 g:gutentags_ctags_exclude_wildignore
328 When 1, Gutentags will automatically pass your
329 'wildignore' file patterns to the
330 |gutentags_ctags_executable| so that they are ignored.
331 Set also |gutentags_ctags_exclude| to pass custom
332 patterns.
333 Defaults to 1.
334
335 *gutentags_ctags_auto_set_tags*
336 g:gutentags_ctags_auto_set_tags
337 If set to 1, Gutentags will automatically prepend
338 'tags' with the exact path to the tag file for the
339 current project. See |gutentags_project_root| for how
340 Gutentags locates the project.
341 When set to 0, Gutentags doesn't change 'tags', and
342 this means that whatever tag file it generates may
343 not be picked up by Vim. See |tagfiles()| to know what
344 tag files Vim knows about.
345 Defaults to 1.
346
347 *gutentags_generate_on_missing* 314 *gutentags_generate_on_missing*
348 g:gutentags_generate_on_missing 315 g:gutentags_generate_on_missing
349 If set to 1, Gutentags will start generating an initial 316 If set to 1, Gutentags will start generating an initial
350 tag file if a file is open in a project where no tags 317 tag file if a file is open in a project where no tags
351 file is found. See |gutentags_project_root| for how 318 file is found. See |gutentags_project_root| for how
511 < 478 <
512 Note: If a custom ctags executable is specified, it 479 Note: If a custom ctags executable is specified, it
513 must support the '-L' command line option in order to 480 must support the '-L' command line option in order to
514 read the list of files to be examined. 481 read the list of files to be examined.
515 482
483
484 The following settings are valid for the `ctags` module.
485
486 *gutentags_ctags_executable*
487 g:gutentags_ctags_executable
488 Specifies the ctags executable to launch.
489 Defaults to `ctags`.
490
491 *gutentags_ctags_executable_{filetype}*
492 g:gutentags_ctags_executable_{type}
493 Specifies the ctags executable to launch for a project
494 of type {type}. See |gutentags_project_info| for more
495 information.
496 IMPORTANT: please see |gutentags-ctags-requirements|.
497 Example: >
498 let g:gutentags_ctags_executable_ruby = 'foobar'
499 <
500
501 *gutentags_ctags_tagfile*
502 g:gutentags_ctags_tagfile
503 Specifies the name of the tag file to create. This
504 will be appended to the project's root. See
505 |gutentags_project_root| for how Gutentags locates the
506 project.
507 Defaults to `tags`.
508
509 *gutentags_ctags_exclude*
510 g:gutentags_ctags_exclude
511 A list of file patterns to pass to the
512 |gutentags_ctags_executable| so that they will be
513 excluded from parsing for the tags generation.
514 See also |gutentags_ctags_exclude_wildignore|.
515 Defaults to `[]` (an empty |List|).
516
517 *gutentags_ctags_exclude_wildignore*
518 g:gutentags_ctags_exclude_wildignore
519 When 1, Gutentags will automatically pass your
520 'wildignore' file patterns to the
521 |gutentags_ctags_executable| so that they are ignored.
522 Set also |gutentags_ctags_exclude| to pass custom
523 patterns.
524 Defaults to 1.
525
526 *gutentags_ctags_auto_set_tags*
527 g:gutentags_ctags_auto_set_tags
528 If set to 1, Gutentags will automatically prepend
529 'tags' with the exact path to the tag file for the
530 current project. See |gutentags_project_root| for how
531 Gutentags locates the project.
532 When set to 0, Gutentags doesn't change 'tags', and
533 this means that whatever tag file it generates may
534 not be picked up by Vim. See |tagfiles()| to know what
535 tag files Vim knows about.
536 Defaults to 1.
537
538 *gutentags_ctags_extra_args*
539 g:gutentags_ctags_extra_args
540 A list of arguments to pass to `ctags`.
541 Defaults to `[]`.
542
543 *gutentags_ctags_post_process_cmd*
544 g:gutentags_ctags_post_process_cmd
545 If defined, the tags generation script will run the
546 command with an argument that points to a temporary
547 copy of the tags file. If the post-process step is
548 modifying the tags file, it needs to do so in-place.
549 This is useful for cleaning up a tags file that may
550 contain tags with non-ASCII names that somehow upsets
551 Vim.
552 Defaults to `""` (an empty |String|).
553
554
555 The following settings are valid for the `cscope` module.
556
557 *gutentags_cscope_executable*
558 g:gutentags_cscope_executable
559 Specifies the name or path of the `cscope` executable
560 to use to generate the code database.
561 Defaults to `"cscope"`.
562
563 *gutentags_auto_add_cscope*
564 g:gutentags_auto_add_cscope
565 If set to 1, Gutentags will automatically add the
566 generated code database to Vim by running `:cs add`
567 (see |:cscope|).
568 Defaults to 1.
569
570
571 The following settings are valid for the `gtags_cscope` module.
572
573 *gutentags_gtags_executable*
574 g:gutentags_gtags_executable
575 Specifies the name or path of the `gtags` executable
576 to use to generate the code database.
577 Default to `"gtags"`.
578
579 *gutentags_gtags_options_file*
580 g:gutentags_gtags_options_file
581 The name of a file that will be looked for in
582 a project root directory. The file is expected to
583 contain `gtags` options (one per line).
584 Defaults to `".gutgtags"`.
585
586 *gutentags_auto_add_gtags_cscope*
587 g:gutentags_auto_add_gtags_cscope
588 If set to 1, Gutentags will automatically add the
589 generated code database to Vim by running `:cs add`
590 (see |:cscope|).
591 Defaults to 1.
592
516 ============================================================================= 593 =============================================================================
517 5. Project Settings *gutentags-project-settings* 594 5. Project Settings *gutentags-project-settings*
518 595
519 Gutentags can be customized to some extent on a per-project basis with the 596 Gutentags can be customized to some extent on a per-project basis with the
520 following files present in the project root directory: 597 following files present in the project root directory: