|
56
|
1 *tagsrch.txt* For Vim version 7.0aa. Last change: 2005 Jan 02
|
|
7
|
2
|
|
|
3
|
|
|
4 VIM REFERENCE MANUAL by Bram Moolenaar
|
|
|
5
|
|
|
6
|
|
|
7 Tags and special searches *tags-and-searches*
|
|
|
8
|
|
|
9 See section |29.1| of the user manual for an introduction.
|
|
|
10
|
|
|
11 1. Jump to a tag |tag-commands|
|
|
|
12 2. Tag stack |tag-stack|
|
|
|
13 3. Tag match list |tag-matchlist|
|
|
|
14 4. Tags details |tag-details|
|
|
|
15 5. Tags file format |tags-file-format|
|
|
|
16 6. Include file searches |include-search|
|
|
|
17
|
|
|
18 ==============================================================================
|
|
|
19 1. Jump to a tag *tag-commands*
|
|
|
20
|
|
|
21 *tag* *tags*
|
|
|
22 A tag is an identifier that appears in a "tags" file. It is a sort of label
|
|
|
23 that can be jumped to. For example: In C programs each function name can be
|
|
|
24 used as a tag. The "tags" file has to be generated by a program like ctags,
|
|
|
25 before the tag commands can be used.
|
|
|
26
|
|
|
27 With the ":tag" command the cursor will be positioned on the tag. With the
|
|
|
28 CTRL-] command, the keyword on which the cursor is standing is used as the
|
|
|
29 tag. If the cursor is not on a keyword, the first keyword to the right of the
|
|
|
30 cursor is used.
|
|
|
31
|
|
|
32 The ":tag" command works very well for C programs. If you see a call to a
|
|
|
33 function and wonder what that function does, position the cursor inside of the
|
|
|
34 function name and hit CTRL-]. This will bring you to the function definition.
|
|
|
35 An easy way back is with the CTRL-T command. Also read about the tag stack
|
|
|
36 below.
|
|
|
37
|
|
|
38 *:ta* *:tag* *E426* *E429*
|
|
|
39 :ta[g][!] {ident} Jump to the definition of {ident}, using the
|
|
|
40 information in the tags file(s). Put {ident} in the
|
|
|
41 tag stack. See |tag-!| for [!].
|
|
|
42 {ident} can be a regexp pattern, see |tag-regexp|.
|
|
|
43 When there are several matching tags for {ident}, the
|
|
|
44 first one is jumped to. |:tnext|.
|
|
|
45
|
|
|
46 g<LeftMouse> *g<LeftMouse>*
|
|
|
47 <C-LeftMouse> *<C-LeftMouse>* *CTRL-]*
|
|
|
48 CTRL-] Jump to the definition of the keyword under the
|
|
|
49 cursor. Same as ":tag {ident}", where {ident} is the
|
|
|
50 keyword under or after cursor. {Vi: identifier after
|
|
|
51 the cursor}
|
|
|
52
|
|
|
53 *v_CTRL-]*
|
|
|
54 {Visual}CTRL-] Same as ":tag {ident}", where {ident} is the text that
|
|
|
55 is highlighted. {not in Vi}
|
|
|
56
|
|
|
57 *telnet-CTRL-]*
|
|
|
58 CTRL-] is the default telnet escape key. When you type CTRL-] to jump to a
|
|
|
59 tag, you will get the telnet prompt instead. Most versions of telnet allow
|
|
|
60 changing or disabling the default escape key. See the telnet man page. You
|
|
|
61 can 'telnet -E {Hostname}' to disable the escape character, or 'telnet -e
|
|
|
62 {EscapeCharacter} {Hostname}' to specify another escape character. If
|
|
56
|
63 possible, try to use "ssh" instead of "telnet" to avoid this problem.
|
|
7
|
64
|
|
|
65 *tag-priority*
|
|
|
66 When there are multiple matches for a tag, this priority is used:
|
|
|
67 1. "FSC" A full matching static tag for the current file.
|
|
|
68 2. "F C" A full matching global tag for the current file.
|
|
|
69 3. "F " A full matching global tag for another file.
|
|
|
70 4. "FS " A full matching static tag for another file.
|
|
|
71 5. " SC" An ignore-case matching static tag for the current file.
|
|
|
72 6. " C" An ignore-case matching global tag for the current file.
|
|
|
73 7. " " An ignore-case matching global tag for another file.
|
|
|
74 8. " S " An ignore-case matching static tag for another file.
|
|
|
75
|
|
|
76 Note that when the current file changes, the priority list is mostly not
|
|
|
77 changed, to avoid confusion when using ":tnext". It is changed when using
|
|
|
78 ":tag {ident}".
|
|
|
79
|
|
|
80 The ignore-case matches are not found for a ":tag" command when the
|
|
|
81 'ignorecase' option is off. They are found when a pattern is used (starting
|
|
|
82 with a "/") and for ":tselect", also when 'ignorecase' is off. Note that
|
|
|
83 using ignore-case tag searching disables binary searching in the tags file,
|
|
|
84 which causes a slowdown. This can be avoided by fold-case sorting the tag
|
|
|
85 file. See the 'tagbsearch' option for an explanation.
|
|
|
86
|
|
|
87 ==============================================================================
|
|
|
88 2. Tag stack *tag-stack* *tagstack* *E425*
|
|
|
89
|
|
|
90 On the tag stack is remembered which tags you jumped to, and from where.
|
|
|
91 Tags are only pushed onto the stack when the 'tagstack' option is set.
|
|
|
92
|
|
|
93 g<RightMouse> *g<RightMouse>*
|
|
|
94 <C-RightMouse> *<C-RightMouse>* *CTRL-T*
|
|
|
95 CTRL-T Jump to [count] older entry in the tag stack
|
|
|
96 (default 1). {not in Vi}
|
|
|
97
|
|
|
98 *:po* *:pop* *E555* *E556*
|
|
|
99 :[count]po[p][!] Jump to [count] older entry in tag stack (default 1).
|
|
|
100 See |tag-!| for [!]. {not in Vi}
|
|
|
101
|
|
|
102 :[count]ta[g][!] Jump to [count] newer entry in tag stack (default 1).
|
|
|
103 See |tag-!| for [!]. {not in Vi}
|
|
|
104
|
|
|
105 *:tags*
|
|
|
106 :tags Show the contents of the tag stack. The active
|
|
|
107 entry is marked with a '>'. {not in Vi}
|
|
|
108
|
|
|
109 The output of ":tags" looks like this:
|
|
|
110
|
|
|
111 # TO tag FROM line in file/line
|
|
|
112 1 1 main 1 harddisk2:text/vim/test
|
|
|
113 > 2 2 FuncA 58 i = FuncA(10);
|
|
|
114 3 1 FuncC 357 harddisk2:text/vim/src/amiga.c
|
|
|
115
|
|
|
116 This list shows the tags that you jumped to and the cursor position before
|
|
|
117 that jump. The older tags are at the top, the newer at the bottom.
|
|
|
118
|
|
|
119 The '>' points to the active entry. This is the tag that will be used by the
|
|
|
120 next ":tag" command. The CTRL-T and ":pop" command will use the position
|
|
|
121 above the active entry.
|
|
|
122
|
|
|
123 Below the "TO" is the number of the current match in the match list. Note
|
|
|
124 that this doesn't change when using ":pop" or ":tag".
|
|
|
125
|
|
|
126 The line number and file name are remembered to be able to get back to where
|
|
|
127 you were before the tag command. The line number will be correct, also when
|
|
|
128 deleting/inserting lines, unless this was done by another program (e.g.
|
|
|
129 another instance of Vim).
|
|
|
130
|
|
|
131 For the current file, the "file/line" column shows the text at the position.
|
|
|
132 An indent is removed and a long line is truncated to fit in the window.
|
|
|
133
|
|
|
134 You can jump to previously used tags with several commands. Some examples:
|
|
|
135
|
|
|
136 ":pop" or CTRL-T to position before previous tag
|
|
|
137 {count}CTRL-T to position before {count} older tag
|
|
|
138 ":tag" to newer tag
|
|
|
139 ":0tag" to last used tag
|
|
|
140
|
|
|
141 The most obvious way to use this is while browsing through the call graph of
|
|
|
142 a program. Consider the following call graph:
|
|
|
143
|
|
|
144 main ---> FuncA ---> FuncC
|
|
|
145 ---> FuncB
|
|
|
146
|
|
|
147 (Explanation: main calls FuncA and FuncB; FuncA calls FuncC).
|
|
|
148 You can get from main to FuncA by using CTRL-] on the call to FuncA. Then
|
|
|
149 you can CTRL-] to get to FuncC. If you now want to go back to main you can
|
|
|
150 use CTRL-T twice. Then you can CTRL-] to FuncB.
|
|
|
151
|
|
|
152 If you issue a ":ta {ident}" or CTRL-] command, this tag is inserted at the
|
|
|
153 current position in the stack. If the stack was full (it can hold up to 20
|
|
|
154 entries), the oldest entry is deleted and the older entries shift one
|
|
|
155 position up (their index number is decremented by one). If the last used
|
|
|
156 entry was not at the bottom, the entries below the last used one are
|
|
|
157 deleted. This means that an old branch in the call graph is lost. After the
|
|
|
158 commands explained above the tag stack will look like this:
|
|
|
159
|
|
|
160 # TO tag FROM line in file
|
|
|
161 1 main 1 harddisk2:text/vim/test
|
|
|
162 2 FuncB 59 harddisk2:text/vim/src/main.c
|
|
|
163
|
|
|
164 *E73*
|
|
|
165 When you try to use the tag stack while it doesn't contain anything you will
|
|
|
166 get an error message.
|
|
|
167
|
|
|
168 ==============================================================================
|
|
|
169 3. Tag match list *tag-matchlist* *E427* *E428*
|
|
|
170
|
|
|
171 When there are several matching tags, these commands can be used to jump
|
|
|
172 between them. Note that these command don't change the tag stack, they keep
|
|
|
173 the same entry.
|
|
|
174
|
|
|
175 *:ts* *:tselect*
|
|
|
176 :ts[elect][!] [ident] List the tags that match [ident], using the
|
|
|
177 information in the tags file(s).
|
|
|
178 When [ident] is not given, the last tag name from the
|
|
|
179 tag stack is used.
|
|
|
180 With a '>' in the first column is indicated which is
|
|
|
181 the current position in the list (if there is one).
|
|
|
182 [ident] can be a regexp pattern, see |tag-regexp|.
|
|
|
183 See |tag-priority| for the priorities used in the
|
|
|
184 listing. {not in Vi}
|
|
|
185 Example output:
|
|
|
186
|
|
|
187 >
|
|
|
188 nr pri kind tag file
|
|
|
189 1 F f mch_delay os_amiga.c
|
|
|
190 mch_delay(msec, ignoreinput)
|
|
|
191 > 2 F f mch_delay os_msdos.c
|
|
|
192 mch_delay(msec, ignoreinput)
|
|
|
193 3 F f mch_delay os_unix.c
|
|
|
194 mch_delay(msec, ignoreinput)
|
|
|
195 Enter nr of choice (<CR> to abort):
|
|
|
196 <
|
|
|
197 See |tag-priority| for the "pri" column. Note that
|
|
|
198 this depends on the current file, thus using
|
|
|
199 ":tselect xxx" can produce different results.
|
|
|
200 The "kind" column gives the kind of tag, if this was
|
|
|
201 included in the tags file.
|
|
|
202 The "info" column shows information that could be
|
|
|
203 found in the tags file. It depends on the program
|
|
|
204 that produced the tags file.
|
|
|
205 When the list is long, you may get the |more-prompt|.
|
|
|
206 If you already see the tag you want to use, you can
|
|
|
207 type 'q' and enter the number.
|
|
|
208
|
|
|
209 *:sts* *:stselect*
|
|
|
210 :sts[elect][!] [ident] Does ":tselect[!] [ident]" and splits the window for
|
|
|
211 the selected tag. {not in Vi}
|
|
|
212
|
|
|
213 *g]*
|
|
|
214 g] Like CTRL-], but use ":tselect" instead of ":tag".
|
|
|
215 {not in Vi}
|
|
|
216
|
|
|
217 *v_g]*
|
|
|
218 {Visual}g] Same as "g]", but use the highlighted text as the
|
|
|
219 identifier. {not in Vi}
|
|
|
220
|
|
|
221 *:tj* *:tjump*
|
|
|
222 :tj[ump][!] [ident] Like ":tselect", but jump to the tag directly when
|
|
|
223 there is only one match. {not in Vi}
|
|
|
224
|
|
|
225 *:stj* *:stjump*
|
|
|
226 :stj[ump][!] [ident] Does ":tjump[!] [ident]" and splits the window for the
|
|
|
227 selected tag. {not in Vi}
|
|
|
228
|
|
|
229 *g_CTRL-]*
|
|
|
230 g CTRL-] Like CTRL-], but use ":tjump" instead of ":tag".
|
|
|
231 {not in Vi}
|
|
|
232
|
|
|
233 *v_g_CTRL-]*
|
|
|
234 {Visual}g CTRL-] Same as "g CTRL-]", but use the highlighted text as
|
|
|
235 the identifier. {not in Vi}
|
|
|
236
|
|
|
237 *:tn* *:tnext*
|
|
|
238 :[count]tn[ext][!] Jump to [count] next matching tag (default 1). See
|
|
|
239 |tag-!| for [!]. {not in Vi}
|
|
|
240
|
|
|
241 *:tp* *:tprevious*
|
|
|
242 :[count]tp[revious][!] Jump to [count] previous matching tag (default 1).
|
|
|
243 See |tag-!| for [!]. {not in Vi}
|
|
|
244
|
|
|
245 *:tN* *:tNext*
|
|
|
246 :[count]tN[ext][!] Same as ":tprevious". {not in Vi}
|
|
|
247
|
|
|
248 *:tr* *:trewind*
|
|
|
249 :[count]tr[ewind][!] Jump to first matching tag. If [count] is given, jump
|
|
|
250 to [count]th matching tag. See |tag-!| for [!]. {not
|
|
|
251 in Vi}
|
|
|
252
|
|
|
253 *:tf* *:tfirst*
|
|
|
254 :[count]tf[irst][!] Same as ":trewind". {not in Vi}
|
|
|
255
|
|
|
256 *:tl* *:tlast*
|
|
|
257 :tl[ast][!] Jump to last matching tag. See |tag-!| for [!]. {not
|
|
|
258 in Vi}
|
|
|
259
|
|
|
260
|
|
|
261 When there is no other message, Vim shows which matching tag has been jumped
|
|
|
262 to, and the number of matching tags: >
|
|
|
263 tag 1 of 3 or more
|
|
|
264 The " or more" is used to indicate that Vim didn't try all the tags files yet.
|
|
|
265 When using ":tnext" a few times, or with ":tlast", more matches may be found.
|
|
|
266
|
|
|
267 When you didn't see this message because of some other message, or you just
|
|
|
268 want to know where you are, this command will show it again (and jump to the
|
|
|
269 same tag as last time): >
|
|
|
270 :0tn
|
|
|
271 <
|
|
|
272 *tag-skip-file*
|
|
|
273 When a matching tag is found for which the file doesn't exist, this match is
|
|
|
274 skipped and the next matching tag is used. Vim reports this, to notify you of
|
|
|
275 missing files. When the end of the list of matches has been reached, an error
|
|
|
276 message is given.
|
|
|
277
|
|
|
278 The tag match list can also be used in the preview window. The commands are
|
|
|
279 the same as above, with a "p" prepended.
|
|
|
280 {not available when compiled without the |+quickfix| feature}
|
|
|
281
|
|
|
282 *:pts* *:ptselect*
|
|
|
283 :pts[elect][!] [ident] Does ":tselect[!] [ident]" and shows the new tag in a
|
|
|
284 "Preview" window. See |:ptag| for more info.
|
|
|
285 {not in Vi}
|
|
|
286
|
|
|
287 *:ptj* *:ptjump*
|
|
|
288 :ptj[ump][!] [ident] Does ":tjump[!] [ident]" and shows the new tag in a
|
|
|
289 "Preview" window. See |:ptag| for more info.
|
|
|
290 {not in Vi}
|
|
|
291
|
|
|
292 *:ptn* *:ptnext*
|
|
|
293 :[count]ptn[ext][!] ":tnext" in the preview window. See |:ptag|.
|
|
|
294 {not in Vi}
|
|
|
295
|
|
|
296 *:ptp* *:ptprevious*
|
|
|
297 :[count]ptp[revious][!] ":tprevious" in the preview window. See |:ptag|.
|
|
|
298 {not in Vi}
|
|
|
299
|
|
|
300 *:ptN* *:ptNext*
|
|
|
301 :[count]ptN[ext][!] Same as ":ptprevious". {not in Vi}
|
|
|
302
|
|
|
303 *:ptr* *:ptrewind*
|
|
|
304 :[count]ptr[ewind][!] ":trewind" in the preview window. See |:ptag|.
|
|
|
305 {not in Vi}
|
|
|
306
|
|
|
307 *:ptf* *:ptfirst*
|
|
|
308 :[count]ptf[irst][!] Same as ":ptrewind". {not in Vi}
|
|
|
309
|
|
|
310 *:ptl* *:ptlast*
|
|
|
311 :ptl[ast][!] ":tlast" in the preview window. See |:ptag|.
|
|
|
312 {not in Vi}
|
|
|
313
|
|
|
314 ==============================================================================
|
|
|
315 4. Tags details *tag-details*
|
|
|
316
|
|
|
317 *static-tag*
|
|
|
318 A static tag is a tag that is defined for a specific file. In a C program
|
|
|
319 this could be a static function.
|
|
|
320
|
|
|
321 In Vi jumping to a tag sets the current search pattern. This means that
|
|
|
322 the "n" command after jumping to a tag does not search for the same pattern
|
|
|
323 that it did before jumping to the tag. Vim does not do this as we consider it
|
|
|
324 to be a bug. You can still find the tag search pattern in the search history.
|
|
|
325 If you really want the old Vi behavior, set the 't' flag in 'cpoptions'.
|
|
|
326
|
|
|
327 *tag-binary-search*
|
|
|
328 Vim uses binary searching in the tags file to find the desired tag quickly
|
|
|
329 (when enabled at compile time |+tag_binary|). But this only works if the
|
|
|
330 tags file was sorted on ASCII byte value. Therefore, if no match was found,
|
|
|
331 another try is done with a linear search. If you only want the linear search,
|
|
|
332 reset the 'tagbsearch' option. Or better: Sort the tags file!
|
|
|
333
|
|
|
334 Note that the binary searching is disabled when not looking for a tag with a
|
|
|
335 specific name. This happens when ignoring case and when a regular expression
|
|
|
336 is used that doesn't start with a fixed string. Tag searching can be a lot
|
|
|
337 slower then. The former can be avoided by case-fold sorting the tags file.
|
|
|
338 See 'tagbsearch' for details.
|
|
|
339
|
|
|
340 *tag-regexp*
|
|
|
341 The ":tag" and "tselect" commands accept a regular expression argument. See
|
|
|
342 |pattern| for the special characters that can be used.
|
|
|
343 When the argument starts with '/', it is used as a pattern. If the argument
|
|
|
344 does not start with '/', it is taken literally, as a full tag name.
|
|
|
345 Examples: >
|
|
|
346 :tag main
|
|
|
347 < jumps to the tag "main" that has the highest priority. >
|
|
|
348 :tag /^get
|
|
|
349 < jumps to the tag that starts with "get" and has the highest priority. >
|
|
|
350 :tag /norm
|
|
|
351 < lists all the tags that contain "norm", including "id_norm".
|
|
|
352 When the argument both exists literally, and match when used as a regexp, a
|
|
|
353 literal match has a higher priority. For example, ":tag /open" matches "open"
|
|
|
354 before "open_file" and "file_open".
|
|
|
355
|
|
|
356 *tag-!*
|
|
|
357 If the tag is in the current file this will always work. Otherwise the
|
|
|
358 performed actions depend on whether the current file was changed, whether a !
|
|
|
359 is added to the command and on the 'autowrite' option:
|
|
|
360
|
|
|
361 tag in file autowrite ~
|
|
|
362 current file changed ! option action ~
|
|
|
363 -----------------------------------------------------------------------------
|
|
|
364 yes x x x goto tag
|
|
|
365 no no x x read other file, goto tag
|
|
|
366 no yes yes x abandon current file, read other file, goto
|
|
|
367 tag
|
|
|
368 no yes no on write current file, read other file, goto
|
|
|
369 tag
|
|
|
370 no yes no off fail
|
|
|
371 -----------------------------------------------------------------------------
|
|
|
372
|
|
|
373 - If the tag is in the current file, the command will always work.
|
|
|
374 - If the tag is in another file and the current file was not changed, the
|
|
|
375 other file will be made the current file and read into the buffer.
|
|
|
376 - If the tag is in another file, the current file was changed and a ! is
|
|
|
377 added to the command, the changes to the current file are lost, the other
|
|
|
378 file will be made the current file and read into the buffer.
|
|
|
379 - If the tag is in another file, the current file was changed and the
|
|
|
380 'autowrite' option is on, the current file will be written, the other
|
|
|
381 file will be made the current file and read into the buffer.
|
|
|
382 - If the tag is in another file, the current file was changed and the
|
|
|
383 'autowrite' option is off, the command will fail. If you want to save
|
|
|
384 the changes, use the ":w" command and then use ":tag" without an argument.
|
|
|
385 This works because the tag is put on the stack anyway. If you want to lose
|
|
|
386 the changes you can use the ":tag!" command.
|
|
|
387
|
|
|
388 *tag-security*
|
|
|
389 Note that Vim forbids some commands, for security reasons. This works like
|
|
|
390 using the 'secure' option for exrc/vimrc files in the current directory. See
|
|
|
391 |trojan-horse| and |sandbox|.
|
|
|
392 When the {tagaddress} changes a buffer, you will get a warning message:
|
|
|
393 "WARNING: tag command changed a buffer!!!"
|
|
|
394 In a future version changing the buffer will be impossible. All this for
|
|
|
395 security reasons: Somebody might hide a nasty command in the tags file, which
|
|
|
396 would otherwise go unnoticed. Example: >
|
|
|
397 :$d|/tag-function-name/
|
|
|
398 {this security prevention is not present in Vi}.
|
|
|
399
|
|
|
400 In Vi the ":tag" command sets the last search pattern when the tag is searched
|
|
|
401 for. In Vim this is not done, the previous search pattern is still remembered,
|
|
|
402 unless the 't' flag is present in 'cpoptions'. The search pattern is always
|
|
|
403 put in the search history, so you can modify it if searching fails.
|
|
|
404
|
|
|
405 *emacs-tags* *emacs_tags* *E430*
|
|
|
406 Emacs style tag files are only supported if Vim was compiled with the
|
|
|
407 |+emacs_tags| feature enabled. Sorry, there is no explanation about Emacs tag
|
|
|
408 files here, it is only supported for backwards compatibility :-).
|
|
|
409
|
|
|
410 *tags-option*
|
|
|
411 The 'tags' option is a list of file names. Each of these files is searched
|
|
|
412 for the tag. This can be used to use a different tags file than the default
|
|
|
413 file "tags". It can also be used to access a common tags file.
|
|
|
414
|
|
|
415 The next file in the list is not used when:
|
|
|
416 - A matching static tag for the current buffer has been found.
|
|
|
417 - A matching global tag has been found.
|
|
|
418 This also depends on the 'ignorecase' option. If it is off, and the tags file
|
|
|
419 only has a match without matching case, the next tags file is searched for a
|
|
|
420 match with matching case. If no tag with matching case is found, the first
|
|
|
421 match without matching case is used. If 'ignorecase' is on, and a matching
|
|
|
422 global tag with or without matching case is found, this one is used, no
|
|
|
423 further tags files are searched.
|
|
|
424
|
|
|
425 When a tag file name starts with "./", the '.' is replaced with the path of
|
|
|
426 the current file. This makes it possible to use a tags file in the directory
|
|
|
427 where the current file is (no matter what the current directory is). The idea
|
|
|
428 of using "./" is that you can define which tag file is searched first: In the
|
|
|
429 current directory ("tags,./tags") or in the directory of the current file
|
|
|
430 ("./tags,tags").
|
|
|
431
|
|
|
432 For example: >
|
|
|
433 :set tags=./tags,tags,/home/user/commontags
|
|
|
434
|
|
|
435 In this example the tag will first be searched for in the file "tags" in the
|
|
|
436 directory where the current file is. Next the "tags" file in the current
|
|
|
437 directory. If it is not found there, then the file "/home/user/commontags"
|
|
|
438 will be searched for the tag.
|
|
|
439
|
|
|
440 This can be switched off by including the 'd' flag in 'cpoptions', to make
|
|
|
441 it Vi compatible. "./tags" will than be the tags file in the current
|
|
|
442 directory, instead of the tags file in the directory where the current file
|
|
|
443 is.
|
|
|
444
|
|
|
445 Instead of the comma a space may be used. Then a backslash is required for
|
|
|
446 the space to be included in the string option: >
|
|
|
447 :set tags=tags\ /home/user/commontags
|
|
|
448
|
|
|
449 To include a space in a file name use three backslashes. To include a comma
|
|
|
450 in a file name use two backslashes. For example, use: >
|
|
|
451 :set tags=tag\\\ file,/home/user/common\\,tags
|
|
|
452
|
|
|
453 for the files "tag file" and "/home/user/common,tags". The 'tags' option will
|
|
|
454 have the value "tag\ file,/home/user/common\,tags".
|
|
|
455
|
|
|
456 If the 'tagrelative' option is on (which is the default) and using a tag file
|
|
|
457 in another directory, file names in that tag file are relative to the
|
|
|
458 directory where the tag file is.
|
|
|
459
|
|
|
460 ==============================================================================
|
|
|
461 5. Tags file format *tags-file-format* *E431*
|
|
|
462
|
|
|
463 *ctags* *jtags*
|
|
|
464 A tags file can be created with an external command, for example "ctags". It
|
|
|
465 will contain a tag for each function. Some versions of "ctags" will also make
|
|
|
466 a tag for each "#defined" macro, typedefs, enums, etc.
|
|
|
467
|
|
|
468 Some programs that generate tags files:
|
|
|
469 ctags As found on most Unix systems. Only supports C. Only
|
|
|
470 does the basic work.
|
|
20
|
471 *Exuberant_ctags*
|
|
7
|
472 exuberant ctags This a very good one. It works for C, C++, Java,
|
|
|
473 Fortran, Eiffel and others. It can generate tags for
|
|
|
474 many items. See http://ctags.sourceforge.net.
|
|
|
475 etags Connected to Emacs. Supports many languages.
|
|
|
476 JTags For Java, in Java. It can be found at
|
|
|
477 http://www.fleiner.com/jtags/.
|
|
|
478 ptags.py For Python, in Python. Found in your Python source
|
|
|
479 directory at Tools/scripts/ptags.py.
|
|
|
480 ptags For Perl, in Perl. It can be found at
|
|
|
481 http://www.eleves.ens.fr:8080/home/nthiery/Tags/.
|
|
|
482 gnatxref For Ada. See http://www.gnuada.org/. gnatxref is
|
|
|
483 part of the gnat package.
|
|
|
484
|
|
|
485
|
|
|
486 The lines in the tags file must have one of these three formats:
|
|
|
487
|
|
|
488 1. {tagname} {TAB} {tagfile} {TAB} {tagaddress}
|
|
|
489 2. {tagfile}:{tagname} {TAB} {tagfile} {TAB} {tagaddress}
|
|
|
490 3. {tagname} {TAB} {tagfile} {TAB} {tagaddress} {term} {field} ..
|
|
|
491
|
|
|
492 The first is a normal tag, which is completely compatible with Vi. It is the
|
|
|
493 only format produced by traditional ctags implementations. This is often used
|
|
|
494 for functions that are global, also referenced in other files.
|
|
|
495
|
|
|
496 The lines in the tags file can end in <LF> or <CR><LF>. On the Macintosh <CR>
|
|
|
497 also works. The <CR> and <NL> characters can never appear inside a line.
|
|
|
498
|
|
|
499 *tag-old-static*
|
|
|
500 The second format is for a static tag only. It is obsolete now, replaced by
|
|
|
501 the third format. It is only supported by Elvis 1.x and Vim and a few
|
|
|
502 versions of ctags. A static tag is often used for functions that are local,
|
|
|
503 only referenced in the file {tagfile}. Note that for the static tag, the two
|
|
|
504 occurrences of {tagfile} must be exactly the same. Also see |tags-option|
|
|
|
505 below, for how static tags are used.
|
|
|
506
|
|
|
507 The third format is new. It includes additional information in optional
|
|
|
508 fields at the end of each line. It is backwards compatible with Vi. It is
|
|
|
509 only supported by new versions of ctags (such as Exuberant ctags).
|
|
|
510
|
|
|
511 {tagname} The identifier. Normally the name of a function, but it can
|
|
|
512 be any identifier. It cannot contain a <Tab>.
|
|
|
513 {TAB} One <Tab> character. Note: previous versions allowed any
|
|
|
514 white space here. This has been abandoned to allow spaces in
|
|
|
515 {tagfile}. It can be re-enabled by including the
|
|
|
516 |+tag_any_white| feature at compile time. *tag-any-white*
|
|
|
517 {tagfile} The file that contains the definition of {tagname}. It can
|
|
|
518 have an absolute or relative path. It may contain environment
|
|
|
519 variables and wildcards (although the use of wildcards is
|
|
|
520 doubtful). It cannot contain a <Tab>.
|
|
|
521 {tagaddress} The Ex command that positions the cursor on the tag. It can
|
|
|
522 be any Ex command, although restrictions apply (see
|
|
|
523 |tag-security|). Posix only allows line numbers and search
|
|
|
524 commands, which are mostly used.
|
|
|
525 {term} ;" The two characters semicolon and double quote. This is
|
|
|
526 interpreted by Vi as the start of a comment, which makes the
|
|
|
527 following be ignored. This is for backwards compatibility
|
|
|
528 with Vi, it ignores the following fields.
|
|
|
529 {field} .. A list of optional fields. Each field has the form:
|
|
|
530
|
|
|
531 <Tab>{fieldname}:{value}
|
|
|
532
|
|
|
533 The {fieldname} identifies the field, and can only contain
|
|
|
534 alphabetical characters [a-zA-Z].
|
|
|
535 The {value} is any string, but cannot contain a <Tab>.
|
|
|
536 These characters are special:
|
|
|
537 "\t" stands for a <Tab>
|
|
|
538 "\r" stands for a <CR>
|
|
|
539 "\n" stands for a <NL>
|
|
|
540 "\\" stands for a single '\' character
|
|
|
541
|
|
|
542 There is one field that doesn't have a ':'. This is the kind
|
|
|
543 of the tag. It is handled like it was preceded with "kind:".
|
|
|
544 See the documentation of ctags for the kinds it produces.
|
|
|
545
|
|
|
546 The only other field currently recognized by Vim is "file:"
|
|
|
547 (with an empty value). It is used for a static tag.
|
|
|
548
|
|
|
549 The first lines in the tags file can contain lines that start with
|
|
|
550 !_TAG_
|
|
|
551 These are sorted to the first lines, only rare tags that start with "!" can
|
|
|
552 sort to before them. Vim recognizes two items. The first one is the line
|
|
|
553 that indicates if the file was sorted. When this line is found, Vim uses
|
|
|
554 binary searching for the tags file:
|
|
|
555 !_TAG_FILE_SORTED<Tab>1<Tab>{anything} ~
|
|
|
556
|
|
|
557 A tag file may be case-fold sorted to avoid a linear search when 'ignorecase'
|
|
|
558 is on. See 'tagbsearch' for details. The value '2' should be used then:
|
|
|
559 !_TAG_FILE_SORTED<Tab>2<Tab>{anything} ~
|
|
|
560
|
|
|
561 The other tag that Vim recognizes, but only when compiled with the
|
|
|
562 |+multi_byte| feature, is the encoding of the tags file:
|
|
|
563 !_TAG_FILE_ENCODING<Tab>utf-8<Tab>{anything} ~
|
|
|
564 Here "utf-8" is the encoding used for the tags. Vim will then convert the tag
|
|
|
565 being searched for from 'encoding' to the encoding of the tags file. And when
|
|
|
566 listing tags the reverse happens. When the conversion fails the unconverted
|
|
|
567 tag is used.
|
|
|
568
|
|
|
569 *tag-search*
|
|
|
570 The command can be any Ex command, but often it is a search command.
|
|
|
571 Examples:
|
|
|
572 tag1 file1 /^main(argc, argv)/ ~
|
|
|
573 tag2 file2 108 ~
|
|
|
574
|
|
|
575 The command is always executed with 'magic' not set. The only special
|
|
|
576 characters in a search pattern are "^" (begin-of-line) and "$" (<EOL>).
|
|
|
577 See |pattern|. Note that you must put a backslash before each backslash in
|
|
|
578 the search text. This is for backwards compatibility with Vi.
|
|
|
579
|
|
|
580 *E434* *E435*
|
|
|
581 If the command is a normal search command (it starts and ends with "/" or
|
|
|
582 "?"), some special handling is done:
|
|
|
583 - Searching starts on line 1 of the file.
|
|
|
584 The direction of the search is forward for "/", backward for "?".
|
|
|
585 Note that 'wrapscan' does not matter, the whole file is always searched. {Vi
|
|
|
586 does use 'wrapscan', which caused tags sometimes not be found). {Vi starts
|
|
|
587 searching in line 2 of another file. It does not find a tag in line 1 of
|
|
|
588 another file when 'wrapscan' is not set}
|
|
|
589 - If the search fails, another try is done ignoring case. If that fails too,
|
|
|
590 a search is done for:
|
|
|
591 "^tagname[ \t]*("
|
|
|
592 (the tag with '^' prepended and "[ \t]*(" appended). When using function
|
|
|
593 names, this will find the function name when it is in column 0. This will
|
|
|
594 help when the arguments to the function have changed since the tags file was
|
|
|
595 made. If this search also fails another search is done with:
|
|
|
596 "^[#a-zA-Z_].*\<tagname[ \t]*("
|
|
|
597 This means: A line starting with '#' or an identifier and containing the tag
|
|
|
598 followed by white space and a '('. This will find macro names and function
|
|
|
599 names with a type prepended. {the extra searches are not in Vi}.
|
|
|
600
|
|
|
601 ==============================================================================
|
|
|
602 6. Include file searches *include-search* *definition-search*
|
|
|
603 *E387* *E388* *E389*
|
|
|
604
|
|
|
605 These commands look for a string in the current file and in all encountered
|
|
|
606 included files (recursively). This can be used to find the definition of a
|
|
|
607 variable, function or macro. If you only want to search in the current
|
|
|
608 buffer, use the commands listed at |pattern-searches|.
|
|
|
609
|
|
|
610 These commands are not available when the |+find_in_path| feature was disabled
|
|
|
611 at compile time.
|
|
|
612
|
|
|
613 When a line is encountered that includes another file, that file is searched
|
|
|
614 before continuing in the current buffer. Files included by included files are
|
|
|
615 also searched. When an include file could not be found it is silently
|
|
|
616 ignored. Use the |:checkpath| command to discover which files could not be
|
|
|
617 found, possibly your 'path' option is not set up correctly. Note: the
|
|
|
618 included file is searched, not a buffer that may be editing that file. Only
|
|
|
619 for the current file the lines in the buffer are used.
|
|
|
620
|
|
|
621 The string can be any keyword or a defined macro. For the keyword any match
|
|
|
622 will be found. For defined macros only lines that match with the 'define'
|
|
|
623 option will be found. The default is "^#\s*define", which is for C programs.
|
|
|
624 For other languages you probably want to change this. See 'define' for an
|
|
|
625 example for C++. The string cannot contain an end-of-line, only matches
|
|
|
626 within a line are found.
|
|
|
627
|
|
|
628 When a match is found for a defined macro, the displaying of lines continues
|
|
|
629 with the next line when a line ends in a backslash.
|
|
|
630
|
|
|
631 The commands that start with "[" start searching from the start of the current
|
|
|
632 file. The commands that start with "]" start at the current cursor position.
|
|
|
633
|
|
|
634 The 'include' option is used to define a line that includes another file. The
|
|
|
635 default is "\^#\s*include", which is for C programs. Note: Vim does not
|
|
|
636 recognize C syntax, if the 'include' option matches a line inside
|
|
|
637 "#ifdef/#endif" or inside a comment, it is searched anyway. The 'isfname'
|
|
|
638 option is used to recognize the file name that comes after the matched
|
|
|
639 pattern.
|
|
|
640
|
|
|
641 The 'path' option is used to find the directory for the include files that
|
|
|
642 do not have an absolute path.
|
|
|
643
|
|
|
644 The 'comments' option is used for the commands that display a single line or
|
|
|
645 jump to a line. It defines patterns that may start a comment. Those lines
|
|
|
646 are ignored for the search, unless [!] is used. One exception: When the line
|
|
|
647 matches the pattern "^# *define" it is not considered to be a comment.
|
|
|
648
|
|
|
649 If you want to list matches, and then select one to jump to, you could use a
|
|
|
650 mapping to do that for you. Here is an example: >
|
|
|
651
|
|
|
652 :map <F4> [I:let nr = input("Which one: ")<Bar>exe "normal " . nr ."[\t"<CR>
|
|
|
653 <
|
|
|
654 *[i*
|
|
|
655 [i Display the first line that contains the keyword
|
|
|
656 under the cursor. The search starts at the beginning
|
|
|
657 of the file. Lines that look like a comment are
|
|
|
658 ignored (see 'comments' option). If a count is given,
|
|
|
659 the count'th matching line is displayed, and comment
|
|
|
660 lines are not ignored. {not in Vi}
|
|
|
661
|
|
|
662 *]i*
|
|
|
663 ]i like "[i", but start at the current cursor position.
|
|
|
664 {not in Vi}
|
|
|
665
|
|
|
666 *:is* *:isearch*
|
|
|
667 :[range]is[earch][!] [count] [/]pattern[/]
|
|
|
668 Like "[i" and "]i", but search in [range] lines
|
|
|
669 (default: whole file).
|
|
|
670 See |:search-args| for [/] and [!]. {not in Vi}
|
|
|
671
|
|
|
672 *[I*
|
|
|
673 [I Display all lines that contain the keyword under the
|
|
|
674 cursor. Filenames and line numbers are displayed
|
|
|
675 for the found lines. The search starts at the
|
|
|
676 beginning of the file. {not in Vi}
|
|
|
677
|
|
|
678 *]I*
|
|
|
679 ]I like "[I", but start at the current cursor position.
|
|
|
680 {not in Vi}
|
|
|
681
|
|
|
682 *:il* *:ilist*
|
|
|
683 :[range]il[ist][!] [/]pattern[/]
|
|
|
684 Like "[I" and "]I", but search in [range] lines
|
|
|
685 (default: whole file).
|
|
|
686 See |:search-args| for [/] and [!]. {not in Vi}
|
|
|
687
|
|
|
688 *[_CTRL-I*
|
|
|
689 [ CTRL-I Jump to the first line that contains the keyword
|
|
|
690 under the cursor. The search starts at the beginning
|
|
|
691 of the file. Lines that look like a comment are
|
|
|
692 ignored (see 'comments' option). If a count is given,
|
|
|
693 the count'th matching line is jumped to, and comment
|
|
|
694 lines are not ignored. {not in Vi}
|
|
|
695
|
|
|
696 *]_CTRL-I*
|
|
|
697 ] CTRL-I like "[ CTRL-I", but start at the current cursor
|
|
|
698 position. {not in Vi}
|
|
|
699
|
|
|
700 *:ij* *:ijump*
|
|
|
701 :[range]ij[ump][!] [count] [/]pattern[/]
|
|
|
702 Like "[ CTRL-I" and "] CTRL-I", but search in
|
|
|
703 [range] lines (default: whole file).
|
|
|
704 See |:search-args| for [/] and [!]. {not in Vi}
|
|
|
705
|
|
|
706 CTRL-W CTRL-I *CTRL-W_CTRL-I* *CTRL-W_i*
|
|
|
707 CTRL-W i Open a new window, with the cursor on the first line
|
|
|
708 that contains the keyword under the cursor. The
|
|
|
709 search starts at the beginning of the file. Lines
|
|
|
710 that look like a comment line are ignored (see
|
|
|
711 'comments' option). If a count is given, the count'th
|
|
|
712 matching line is jumped to, and comment lines are not
|
|
|
713 ignored. {not in Vi}
|
|
|
714
|
|
|
715 *:isp* *:isplit*
|
|
|
716 :[range]isp[lit][!] [count] [/]pattern[/]
|
|
|
717 Like "CTRL-W i" and "CTRL-W i", but search in
|
|
|
718 [range] lines (default: whole file).
|
|
|
719 See |:search-args| for [/] and [!]. {not in Vi}
|
|
|
720
|
|
|
721 *[d*
|
|
|
722 [d Display the first macro definition that contains the
|
|
|
723 macro under the cursor. The search starts from the
|
|
|
724 beginning of the file. If a count is given, the
|
|
|
725 count'th matching line is displayed. {not in Vi}
|
|
|
726
|
|
|
727 *]d*
|
|
|
728 ]d like "[d", but start at the current cursor position.
|
|
|
729 {not in Vi}
|
|
|
730
|
|
|
731 *:ds* *:dsearch*
|
|
|
732 :[range]ds[earch][!] [count] [/]string[/]
|
|
|
733 Like "[d" and "]d", but search in [range] lines
|
|
|
734 (default: whole file).
|
|
|
735 See |:search-args| for [/] and [!]. {not in Vi}
|
|
|
736
|
|
|
737 *[D*
|
|
|
738 [D Display all macro definitions that contain the macro
|
|
|
739 under the cursor. Filenames and line numbers are
|
|
|
740 displayed for the found lines. The search starts
|
|
|
741 from the beginning of the file. {not in Vi}
|
|
|
742
|
|
|
743 *]D*
|
|
|
744 ]D like "[D", but start at the current cursor position.
|
|
|
745 {not in Vi}
|
|
|
746
|
|
|
747 *:dl* *:dlist*
|
|
|
748 :[range]dl[ist][!] [/]string[/]
|
|
|
749 Like "[D" and "]D", but search in [range] lines
|
|
|
750 (default: whole file).
|
|
|
751 See |:search-args| for [/] and [!]. {not in Vi}
|
|
|
752
|
|
|
753 *[_CTRL-D*
|
|
|
754 [ CTRL-D Jump to the first macro definition that contains the
|
|
|
755 keyword under the cursor. The search starts from
|
|
|
756 the beginning of the file. If a count is given, the
|
|
|
757 count'th matching line is jumped to. {not in Vi}
|
|
|
758
|
|
|
759 *]_CTRL-D*
|
|
|
760 ] CTRL-D like "[ CTRL-D", but start at the current cursor
|
|
|
761 position. {not in Vi}
|
|
|
762
|
|
|
763 *:dj* *:djump*
|
|
|
764 :[range]dj[ump][!] [count] [/]string[/]
|
|
|
765 Like "[ CTRL-D" and "] CTRL-D", but search in
|
|
|
766 [range] lines (default: whole file).
|
|
|
767 See |:search-args| for [/] and [!]. {not in Vi}
|
|
|
768
|
|
|
769 CTRL-W CTRL-D *CTRL-W_CTRL-D* *CTRL-W_d*
|
|
|
770 CTRL-W d Open a new window, with the cursor on the first
|
|
|
771 macro definition line that contains the keyword
|
|
|
772 under the cursor. The search starts from the
|
|
|
773 beginning of the file. If a count is given, the
|
|
|
774 count'th matching line is jumped to. {not in Vi}
|
|
|
775
|
|
|
776 *:dsp* *:dsplit*
|
|
|
777 :[range]dsp[lit][!] [count] [/]string[/]
|
|
|
778 Like "CTRL-W d", but search in [range] lines
|
|
|
779 (default: whole file).
|
|
|
780 See |:search-args| for [/] and [!]. {not in Vi}
|
|
|
781
|
|
|
782 *:che* *:checkpath*
|
|
|
783 :che[ckpath] List all the included files that could not be found.
|
|
|
784 {not in Vi}
|
|
|
785
|
|
|
786 :che[ckpath]! List all the included files. {not in Vi}
|
|
|
787
|
|
|
788 *:search-args*
|
|
|
789 Common arguments for the commands above:
|
|
|
790 [!] When included, find matches in lines that are recognized as comments.
|
|
|
791 When excluded, a match is ignored when the line is recognized as a
|
|
|
792 comment (according to 'comments'), or the match is in a C comment (after
|
|
|
793 "//" or inside /* */). Note that a match may be missed if a line is
|
|
|
794 recognized as a comment, but the comment ends halfway the line.
|
|
|
795 And if the line is a comment, but it is not recognized (according to
|
|
|
796 'comments') a match may be found in it anyway. Example: >
|
|
|
797 /* comment
|
|
|
798 foobar */
|
|
|
799 < A match for "foobar" is found, because this line is not recognized as a
|
|
|
800 comment (even though syntax highlighting does recognize it).
|
|
|
801 Note: Since a macro definition mostly doesn't look like a comment, the
|
|
|
802 [!] makes no difference for ":dlist", ":dsearch" and ":djump".
|
|
|
803 [/] A pattern can be surrounded by '/'. Without '/' only whole words are
|
|
|
804 matched, using the pattern "\<pattern\>". Only after the second '/' a
|
|
|
805 next command can be appended with '|'. Example: >
|
|
|
806 :isearch /string/ | echo "the last one"
|
|
|
807 < For a ":djump", ":dsplit", ":dlist" and ":dsearch" command the pattern
|
|
|
808 is used as a literal string, not as a search pattern.
|
|
|
809
|
|
|
810 vim:tw=78:ts=8:ft=help:norl:
|
