annotate runtime/doc/tagsrch.txt @ 7275:4b4ac70f5173 v7.4.943

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