vim-gutentags: doc/gutentags.txt annotate

annotate doc/gutentags.txt @ 46:c0f56e4d52bd

Make a bunch of advanced commands opt-in only.

author	Ludovic Chabant <ludovic@chabant.com>
date	Thu, 09 Apr 2015 21:02:25 -0700
parents	7000d598a2a7
children	7b419abf7fba

rev	line source
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	1 gutentags.txt Automatic ctags management for VIM
24 bab5f37faa1e More renaming. Ludovic Chabant <ludovic@chabant.com> parents: 22 diff changeset	2 ___ ___ ___ ___
bab5f37faa1e More renaming. Ludovic Chabant <ludovic@chabant.com> parents: 22 diff changeset	3 /\__\ /\ \ /\__\ /\ \
bab5f37faa1e More renaming. Ludovic Chabant <ludovic@chabant.com> parents: 22 diff changeset	4 /:/ _/_ \:\ \ ___ /:/ _/_ \:\ \
bab5f37faa1e More renaming. Ludovic Chabant <ludovic@chabant.com> parents: 22 diff changeset	5 /:/ /\ \ \:\ \ /\__\ /:/ /\__\ \:\ \
bab5f37faa1e More renaming. Ludovic Chabant <ludovic@chabant.com> parents: 22 diff changeset	6 /:/ /::\ \ ___ \:\ \ /:/ / /:/ /:/ _/_ _____\:\ \
bab5f37faa1e More renaming. Ludovic Chabant <ludovic@chabant.com> parents: 22 diff changeset	7 /:/__\/\:\__\ /\ \ \:\__\ /:/__/ /:/_/:/ /\__\ /::::::::\__\
bab5f37faa1e More renaming. Ludovic Chabant <ludovic@chabant.com> parents: 22 diff changeset	8 \:\ \ /:/ / \:\ \ /:/ / /::\ \ \:\/:/ /:/ / \:\~~\~~\/__/
bab5f37faa1e More renaming. Ludovic Chabant <ludovic@chabant.com> parents: 22 diff changeset	9 \:\ /:/ / \:\ /:/ / /:/\:\ \ \::/_/:/ / \:\ \
bab5f37faa1e More renaming. Ludovic Chabant <ludovic@chabant.com> parents: 22 diff changeset	10 \:\/:/ / \:\/:/ / \/__\:\ \ \:\/:/ / \:\ \
bab5f37faa1e More renaming. Ludovic Chabant <ludovic@chabant.com> parents: 22 diff changeset	11 \::/ / \::/ / \:\__\ \::/ / \:\__\
bab5f37faa1e More renaming. Ludovic Chabant <ludovic@chabant.com> parents: 22 diff changeset	12 \/__/ \/__/ \/__/ \/__/ \/__/
bab5f37faa1e More renaming. Ludovic Chabant <ludovic@chabant.com> parents: 22 diff changeset	13 ___ ___ ___
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	14 /\ \ /\__\ /\__\
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	15 ___ /::\ \ /:/ _/_ /:/ _/_
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	16 /\__\ /:/\:\ \ /:/ /\ \ /:/ /\ \
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	17 /:/ / /:/ /::\ \ /:/ /::\ \ /:/ /::\ \
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	18 /:/__/ /:/_/:/\:\__\ /:/__\/\:\__\ /:/_/:/\:\__\
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	19 /::\ \ \:\/:/ \/__/ \:\ \ /:/ / \:\/:/ /:/ /
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	20 /:/\:\ \ \::/__/ \:\ /:/ / \::/ /:/ /
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	21 \/__\:\ \ \:\ \ \:\/:/ / \/_/:/ /
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	22 \:\__\ \:\__\ \::/ / /:/ /
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	23 \/__/ \/__/ \/__/ \/__/
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	24
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	25
24 bab5f37faa1e More renaming. Ludovic Chabant <ludovic@chabant.com> parents: 22 diff changeset	26 GUTENTAGS REFERENCE MANUAL
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	27 by Ludovic Chabant
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	28
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	29 gutentags
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	30
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	31 1. Introduction \|gutentags-intro\|
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	32 2. Commands \|gutentags-commands\|
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	33 3. Status Line \|gutentags-status-line\|
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	34 4. Global Settings \|gutentags-settings\|
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	35
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	36 =============================================================================
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	37 1. Introduction gutentags-intro
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	38
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	39 Gutentags is a plugin that takes care of the much needed management of tags
7 49e3cb99ab27 Small edits. Ludovic Chabant <ludovic@chabant.com> parents: 4 diff changeset	40 files in Vim. It will (re)generate tag files as you work while staying
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	41 completely out of your way. It will even do its best to keep those tag files
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	42 out of your way too. It has no dependencies and just works.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	43
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	44 In order to generate tag files, Gutentags will have to figure out what's in
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	45 your project. To do this, it will locate well-known project root markers like
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	46 SCM folders (.git, .hg, etc.), any custom tags you define (with
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	47 \|gutentags_project_root\|), and even things you may have defined already with
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	48 other plugins, like CtrlP.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	49
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	50 If the current file you're editing is found to be in such a project, Gutentags
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	51 will make sure the tag file for that project is up to date. Then, as you work
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	52 in files in that project, it will partially re-generate the tag file. Every
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	53 time you save, it will silently, in the background, update the tags for that
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	54 file.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	55
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	56 Usually, ctags can only append tags to an existing tag file, so Gutentags
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	57 removes the tags for the current file first, to make sure the tag file is
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	58 always consistent with the source code.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	59
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	60 Also, Gutentags is clever enough to not stumble upon itself by triggering
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	61 multiple ctags processes if you save files to fast, or your project is really
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	62 big.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	63
7 49e3cb99ab27 Small edits. Ludovic Chabant <ludovic@chabant.com> parents: 4 diff changeset	64 There are some similar Vim plugins out there ("vim-tags", "vim-autotag",
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	65 "vim-automatic-ctags", etc.). They all fail on one or more of the requirements
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	66 I set for myself with Gutentags:
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	67
7 49e3cb99ab27 Small edits. Ludovic Chabant <ludovic@chabant.com> parents: 4 diff changeset	68 * No other dependency than running Vim: no Python, Ruby, or whatever.
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	69 * Cross-platform: should work on at least Mac and Windows.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	70 * Incremental tags generation: don't re-generate the whole project all the
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	71 time. This may be fine for small projects, but it doesn't scale.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	72 * External process management: if the ctags process is taking a long time,
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	73 don't run another one because I saved the file again.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	74 * Keep the tag file consistent: don't just append the current file's tags to
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	75 the tag file, otherwise you will still "see" tags for deleted or renamed
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	76 classes and functions.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	77 * Automatically create the tag file: you open something from a freshly forked
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	78 project, it should start indexing it automatically, just in Sublime Text or
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	79 Visual Studio or any other IDE.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	80
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	81
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	82 =============================================================================
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	83 2. Commands gutentags-commands
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	84
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	85 gutentags-global-commands
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	86 The following commands are always available, whatever buffer you currently
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	87 have open:
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	88
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	89 :GutentagsGenerate
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	90 :GutentagsGenerate {tagsfile}
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	91 Generates a tag file named {tagsfile}. Tags will be
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	92 generated for all the files in the same directory as
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	93 {tagsfile} and below (i.e. recursive from {tagsfile}'s
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	94 own directory).
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	95
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	96
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	97 gutentags-project-commands
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	98 The following commands are only available in buffers that have been found to
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	99 belong to a project that should be managed by Gutentags. See
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	100 \|gutentags_project_root\| for how Gutentags figures out the project a file
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	101 belongs to. When not project is found (i.e. the file is not under any of the
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	102 known project markers), Gutentags is disabled for that buffer, and the
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	103 following commands and remarks don't apply.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	104
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	105 The tag file that Gutentags creates and manages will be named after
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	106 \|gutentags_tagfile\|, relative to the project's root directory. When Gutentags
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	107 finds a valid project root, it will prepend the tag file's path to 'tags',
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	108 unless \|gutentags_auto_set_tags\| is set to 0. This is to make sure Vim will use
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	109 that file first.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	110
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	111 If a file managed by Gutentags is opened and no tag file already exists,
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	112 Gutentags will start generating it right away in the background, unless
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	113 \|gutentags_generate_on_missing\| is set to 0. If you have a large project, you
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	114 may want to know when Gutentags is generating tags: see
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	115 \|gutentags-status-line\| to display an indicator in your status line.
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	116
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	117 When a file managed by Gutentags is saved, the tag file will be incrementally
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	118 updated, i.e. references to the recently saved file are removed, and that file
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	119 is re-parsed for tags, with the result being merged into the tag file. This
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	120 makes the tag file 100% consistent with the latest changes. This doesn't
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	121 happen however if \|gutentags_generate_on_write\| is set to 0, in which case you
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	122 have to run \|GutentagsUpdate\| manually.
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	123
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	124
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	125 :GutentagsUpdate
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	126 :GutentagsUpdate
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	127 Forces an update of the current tag file with the
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	128 current buffer. If tags are already being generated,
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	129 you will be notified and the command will abort.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	130
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	131 :GutentagsUpdate!
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	132 Like \|GutentagsUpdate\|, but updates the current tags
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	133 file with the whole project instead of just the
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	134 current buffer.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	135
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	136
46 c0f56e4d52bd Make a bunch of advanced commands opt-in only. Ludovic Chabant <ludovic@chabant.com> parents: 43 diff changeset	137 Some debugging/troubleshooting commands are also available if the
c0f56e4d52bd Make a bunch of advanced commands opt-in only. Ludovic Chabant <ludovic@chabant.com> parents: 43 diff changeset	138 \|gutentags_define_advanced_commands\| global setting is set to 1.
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	139
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	140 :GutentagsToggleEnabled
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	141 :GutentagsToggleEnabled
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	142 Disables and re-enables Gutentags.
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	143 When Gutentags is disabled, it won't update your tag
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	144 file when you save a buffer. It will however still
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	145 look for project markers as you open new buffers so
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	146 that they can start working again when you re-enable
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	147 Gutentags.
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	148
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	149 GutentagsToggleTrace
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	150 :GutentagsToggleTrace
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	151 If you want to keep an eye on what Gutentags is doing,
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	152 you can enable tracing. This will show messages every
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	153 time Gutentags does something. It can get annoying
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	154 quickly, since it will require you to press a key to
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	155 dismiss those messages, but it can be useful to
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	156 troubleshoot a problem.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	157 In addition to messages in Vim, it will also make
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	158 Gutentags redirect the output of the tag generation
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	159 script to a `.log` file in the project root.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	160
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	161 :GutentagsUnlock
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	162 :GutentagsUnlock
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	163 Gutentags uses a `.lock` file to know when tag
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	164 generation is running. If something goes wrong with
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	165 that process, that lock file could be left behind. You
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	166 could just remove it manually from the root of your
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	167 project, but you can also run \|:GutentagsUnlock\| so
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	168 that Vim does it for you.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	169 If you find that you need to use this more than a
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	170 couple times ever, there's probably a bug with
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	171 Gutentags, or something otherwise wrong or unexpected
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	172 with your system. Please file a bug.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	173
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	174 =============================================================================
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	175 3. Status Line gutentags-status-line
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	176
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	177 Tag file generation can take a while if you're working on a project big
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	178 enough. In that case, you may want to know when `ctags` is running, so you
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	179 have a heads up if some of the tags aren't recognized yet.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	180
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	181 gutentags#statusline()
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	182 You can display and indicator of tag generation progress in your \|status-line\|
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	183 with the following function: >
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	184 :set statusline+=%{gutentags#statusline()}
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	185
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	186 This won't print anything unless Gutentags figures that `ctags` is running in
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	187 the background. This is done by checking a `.lock` file next to the tag file,
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	188 but there's also some optimization before that to not slow down Vim. Note that
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	189 the `.lock` file can sometimes be left around incorrectly by the background
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	190 process, and you may need to clean it up. See \|:GutentagsUnlock\|.
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	191
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	192 When Gutentags thinks `ctags` is still running, it will print the string
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	193 "TAGS" by default. You can customize it: >
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	194 :set statusline+=%{gutentags#statusline('[Generating...]')}
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	195
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	196 This will print the string "[Generating...]" when tags are being generated.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	197
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	198
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	199 =============================================================================
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	200 4. Global Settings gutentags-settings
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	201
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	202 The following settings can be defined in your \|vimrc\| to change the default
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	203 behaviour of Gutentags.
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	204
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	205 gutentags_enabled
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	206 g:gutentags_enabled
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	207 Defines whether Gutentags should be enabled. When
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	208 disabled, Gutentags will still scan for project root
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	209 markers when opening buffers. This is so that when you
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	210 re-enable Gutentags, you won't have some buffers
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	211 mysteriously working while others (those open last)
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	212 don't.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	213 Defaults to 1.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	214
43 7000d598a2a7 Documentation changes for some options that changed names. Ludovic Chabant <ludovic@chabant.com> parents: 24 diff changeset	215 gutentags_ctags_executable
7000d598a2a7 Documentation changes for some options that changed names. Ludovic Chabant <ludovic@chabant.com> parents: 24 diff changeset	216 g:gutentags_ctags_executable
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	217 Specifies the ctags executable to launch.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	218 Defaults to `ctags`.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	219
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	220 gutentags_tagfile
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	221 g:gutentags_tagfile
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	222 Specifies the name of the tag file to create. This
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	223 will be appended to the project's root. See
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	224 \|gutentags_project_root\| for how Gutentags locates the
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	225 project.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	226 Defaults to `tags`.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	227
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	228 gutentags_project_root
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	229 g:gutentags_project_root
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	230 When a buffer is loaded, Gutentags will figure out if
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	231 it's part of a project that should have tags managed
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	232 automatically. To do this, it looks for "root markers"
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	233 in the current file's directory and its parent
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	234 directories. If it finds any of those markers,
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	235 Gutentags will be enabled for the project, and a tags
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	236 file named after \|gutentags_tagfile\| will be created at
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	237 the project root.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	238 Defaults to `[]` (an empty \|List\|).
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	239 A list of default markers will always be appended to
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	240 the user-defined ones: ['.git', '.hg', '.bzr',
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	241 '_darcs'].
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	242
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	243 gutentags_exclude
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	244 g:gutentags_exclude
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	245 A list of file patterns to pass to the
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	246 \|gutentags_executable\| so that they will be excluded
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	247 from parsing for the tags generation.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	248 Defaults to `[]` (an empty \|List\|).
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	249 Patterns defined in 'wildignore' will also be given as
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	250 exclude patterns to the `ctags` executable.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	251
43 7000d598a2a7 Documentation changes for some options that changed names. Ludovic Chabant <ludovic@chabant.com> parents: 24 diff changeset	252 gutentags_ctags_options_file
7000d598a2a7 Documentation changes for some options that changed names. Ludovic Chabant <ludovic@chabant.com> parents: 24 diff changeset	253 g:gutentags_ctags_options_file
17 b73466268844 Updated documentation. Ludovic Chabant <ludovic@chabant.com> parents: 7 diff changeset	254 The path to an options file that will be passed to
b73466268844 Updated documentation. Ludovic Chabant <ludovic@chabant.com> parents: 7 diff changeset	255 the `ctags` executable with the `--options` option.
b73466268844 Updated documentation. Ludovic Chabant <ludovic@chabant.com> parents: 7 diff changeset	256 In general you can put options in a `$HOME/.ctags`
b73466268844 Updated documentation. Ludovic Chabant <ludovic@chabant.com> parents: 7 diff changeset	257 file, but this lets you specify a custom file
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	258 specifically for Vim/Gutentags.
17 b73466268844 Updated documentation. Ludovic Chabant <ludovic@chabant.com> parents: 7 diff changeset	259
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	260 gutentags_auto_set_tags
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	261 g:gutentags_auto_set_tags
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	262 If set to 1, Gutentags will automatically prepend
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	263 'tags' with the exact path to the tag file for the
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	264 current project. See \|gutentags_project_root\| for how
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	265 Gutentags locates the project.
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	266 When set to 0, Gutentags doesn't change 'tags', and
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	267 this means that whatever tag file it generates may
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	268 not be picked up by Vim. See \|tagfiles()\| to know what
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	269 tag files Vim knows about.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	270 Defaults to 1.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	271
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	272 gutentags_generate_on_missing
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	273 g:gutentags_generate_on_missing
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	274 If set to 1, Gutentags will start generating an initial
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	275 tag file if a file is open in a project where no tags
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	276 file is found. See \|gutentags_project_root\| for how
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	277 Gutentags locates the project.
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	278 When set to 0, Gutentags will only generate the first
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	279 time the file is saved (if
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	280 \|gutentags_generate_on_write\| is set to 1), or when
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	281 \|GutentagsUpdate\| or \|GutentagsGenerate\| is run.
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	282 Defaults to 1.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	283
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	284 gutentags_generate_on_write
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	285 g:gutentags_generate_on_write
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	286 If set to 1, Gutentags will update the current
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	287 project's tag file when a file inside that project is
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	288 saved. See \|gutentags_project_root\| for how Gutentags
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	289 locates the project.
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	290 When set to 0, Gutentags won't do anything on save.
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	291 This means that the project's tag file won't reflect
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	292 the latest changes, and you will have to run
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	293 \|GutentagsUpdate\| manually.
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	294 Defaults to 1.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	295
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	296 gutentags_background_update
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	297 g:gutentags_background_update
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	298 Specifies whether the process that updates the tags
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	299 file should be run in the background or in the
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	300 foreground. If run in the foreground, Vim will block
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	301 until the process is complete.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	302 Defaults to 1.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	303
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	304 gutentags_cache_dir
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	305 g:gutentags_cache_dir
20 bd136cb41034 Update documentation. Ludovic Chabant <ludovic@chabant.com> parents: 17 diff changeset	306 Specifies a directory in which to create all the tags
bd136cb41034 Update documentation. Ludovic Chabant <ludovic@chabant.com> parents: 17 diff changeset	307 files, instead of writing them at the root of each
bd136cb41034 Update documentation. Ludovic Chabant <ludovic@chabant.com> parents: 17 diff changeset	308 project. This is handy to keep tags files from
bd136cb41034 Update documentation. Ludovic Chabant <ludovic@chabant.com> parents: 17 diff changeset	309 polluting many directories all across your computer.
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	310
46 c0f56e4d52bd Make a bunch of advanced commands opt-in only. Ludovic Chabant <ludovic@chabant.com> parents: 43 diff changeset	311 gutentags_define_advanced_commands
c0f56e4d52bd Make a bunch of advanced commands opt-in only. Ludovic Chabant <ludovic@chabant.com> parents: 43 diff changeset	312 g:gutentags_define_advanced_commands
c0f56e4d52bd Make a bunch of advanced commands opt-in only. Ludovic Chabant <ludovic@chabant.com> parents: 43 diff changeset	313 Defines some advanced commands like
c0f56e4d52bd Make a bunch of advanced commands opt-in only. Ludovic Chabant <ludovic@chabant.com> parents: 43 diff changeset	314 \|GutentagsToggleEnabled\| and \|GutentagsUnlock\|.
c0f56e4d52bd Make a bunch of advanced commands opt-in only. Ludovic Chabant <ludovic@chabant.com> parents: 43 diff changeset	315
0 a3a37124558b Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	316
a3a37124558b Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	317 vim:tw=78:et:ft=help:norl:

Mercurial > vim-gutentags

annotate doc/gutentags.txt @ 46:c0f56e4d52bd