|
825
|
1 *tabpage.txt* For Vim version 7.0d. Last change: 2006 Apr 09
|
|
674
|
2
|
|
|
3
|
|
|
4 VIM REFERENCE MANUAL by Bram Moolenaar
|
|
|
5
|
|
|
6
|
|
675
|
7 Editing with windows in multiple tab pages. *tab-page* *tabpage*
|
|
674
|
8
|
|
|
9 The commands which have been added to use multiple tab pages are explained
|
|
|
10 here. Additionally, there are explanations for commands that work differently
|
|
|
11 when used in combination with more than one tab page.
|
|
|
12
|
|
678
|
13 1. Introduction |tab-page-intro|
|
|
|
14 2. Commands |tab-page-commands|
|
|
|
15 3. Other items |tab-page-other|
|
|
|
16 4. Setting 'tabline' |setting-tabline|
|
|
686
|
17 5. Setting 'guitablabel' |setting-guitablabel|
|
|
674
|
18
|
|
|
19 {Vi does not have any of these commands}
|
|
|
20 {not able to use multiple tab pages when the |+windows| feature was disabled
|
|
|
21 at compile time}
|
|
|
22
|
|
|
23 ==============================================================================
|
|
|
24 1. Introduction *tab-page-intro*
|
|
|
25
|
|
|
26 A tab page holds one or more windows. You can easily switch between tab
|
|
|
27 pages, so that you have several collections of windows to work on different
|
|
|
28 things.
|
|
|
29
|
|
|
30 Usually you will see a list of labels at the top of the Vim window, one for
|
|
|
31 each tab page. With the mouse you can click on the label to jump to that tab
|
|
|
32 page. There are other ways to move between tab pages, see below.
|
|
|
33
|
|
|
34 Most commands work only in the current tab page. That includes the |CTRL-W|
|
|
698
|
35 commands, |:windo|, |:all| and |:ball| (when not using the |:tab| modifier).
|
|
|
36 The commands that are aware of other tab pages than the current one are
|
|
|
37 mentioned below.
|
|
674
|
38
|
|
|
39 Tabs are also a nice way to edit a buffer temporarily without changing the
|
|
|
40 current window layout. Open a new tab page, do whatever you want to do and
|
|
|
41 close the tab page.
|
|
|
42
|
|
|
43 ==============================================================================
|
|
|
44 2. Commands *tab-page-commands*
|
|
|
45
|
|
|
46 OPENING A NEW TAB PAGE:
|
|
|
47
|
|
|
48 When starting Vim "vim -p filename ..." opens each file argument in a separate
|
|
698
|
49 tab page (up to 'tabpagemax'). |-p|
|
|
674
|
50
|
|
706
|
51 A double click with the mouse in the non-GUI tab pages line opens a new, empty
|
|
|
52 tab page. It is placed left of the position of the click. The first click
|
|
|
53 may select another tab page first, causing an extra screen update.
|
|
|
54
|
|
|
55 In the GUI tab pages line you can use the right mouse button to open menu.
|
|
|
56 |tabline-menu|.
|
|
682
|
57
|
|
|
58 :tabe[dit] *:tabe* *:tabedit* *:tabnew*
|
|
|
59 :tabnew Open a new tab page with an empty window, after the current
|
|
|
60 tab page.
|
|
674
|
61
|
|
|
62 :tabe[dit] [++opt] [+cmd] {file}
|
|
682
|
63 :tabnew [++opt] [+cmd] {file}
|
|
674
|
64 Open a new tab page and edit {file}, like with |:edit|.
|
|
|
65
|
|
675
|
66 :tabf[ind] [++opt] [+cmd] {file} *:tabf* *:tabfind*
|
|
674
|
67 Open a new tab page and edit {file} in 'path', like with
|
|
|
68 |:find|.
|
|
|
69 {not available when the |+file_in_path| feature was disabled
|
|
|
70 at compile time}
|
|
|
71
|
|
682
|
72 :[count]tab {cmd} *:tab*
|
|
|
73 Execute {cmd} and when it opens a new window open a new tab
|
|
|
74 page instead. Doesn't work for |:diffsplit| or |:diffpatch|.
|
|
|
75 When [count] is omitted the tab page appears after the current
|
|
|
76 one. When [count] is specified the new tab page comes after
|
|
|
77 tab page [count]. Use ":0tab cmd" to get the new tab page as
|
|
|
78 the first one. Examples: >
|
|
|
79 :tab split " opens current buffer in new tab page
|
|
|
80 :tab help gt " opens tab page with help for "gt"
|
|
|
81
|
|
820
|
82 CTRL-W gf Open a new tab page and edit the file name under the cursor.
|
|
|
83 See |CTRL-W_gf|.
|
|
|
84
|
|
674
|
85
|
|
|
86 CLOSING A TAB PAGE:
|
|
|
87
|
|
682
|
88 Closing the last window of a tab page closes the tab page too, unless there is
|
|
|
89 only one tab page.
|
|
674
|
90
|
|
|
91 Using the mouse: If the tab page line is displayed you can click in the "X" at
|
|
682
|
92 the top right to close the current tab page. A custom |'tabline'| may show
|
|
|
93 something else.
|
|
674
|
94
|
|
|
95 *:tabc* *:tabclose*
|
|
|
96 :tabc[lose][!] Close current tab page.
|
|
|
97 This command fails when:
|
|
|
98 - There is only one tab page on the screen. *E784*
|
|
|
99 - When 'hidden' is not set, [!] is not used, a buffer has
|
|
|
100 changes, and there is no other window on this buffer.
|
|
|
101 Changes to the buffer are not written and won't get lost, so
|
|
|
102 this is a "safe" command.
|
|
|
103
|
|
|
104 :tabc[lose][!] {count}
|
|
|
105 Close tab page {count}. Fails in the same way as ':tabclose"
|
|
|
106 above.
|
|
|
107
|
|
|
108 *:tabo* *:tabonly*
|
|
|
109 :tabo[nly][!] Close all other tab pages.
|
|
|
110 When the 'hidden' option is set, all buffers in closed windows
|
|
|
111 become hidden.
|
|
|
112 When 'hidden' is not set, and the 'autowrite' option is set,
|
|
|
113 modified buffers are written. Otherwise, windows that have
|
|
|
114 buffers that are modified are not removed, unless the [!] is
|
|
|
115 given, then they become hidden. But modified buffers are
|
|
|
116 never abandoned, so changes cannot get lost.
|
|
|
117
|
|
|
118
|
|
|
119 SWITCHING TO ANOTHER TAB PAGE:
|
|
|
120
|
|
|
121 Using the mouse: If the tab page line is displayed you can click in a tab page
|
|
682
|
122 label to switch to that tab page. Click where there is no label to go to the
|
|
|
123 next tab page. |'tabline'|
|
|
674
|
124
|
|
819
|
125 :tabn[ext] *:tabn* *:tabnext* *gt*
|
|
|
126 gt *CTRL-<PageDown>* *<C-PageDown>*
|
|
|
127 <C-PageDown> Go to the next tab page. Wraps around from the last to the
|
|
674
|
128 first one.
|
|
|
129
|
|
682
|
130 :tabn[ext] {count}
|
|
819
|
131 {count}gt *CTRL-<PageUp>* *<C-PageUp>*
|
|
|
132 <C-PageUp> Go to tab page {count}. The first tab page has number one.
|
|
674
|
133
|
|
|
134
|
|
682
|
135 :tabp[revious] *:tabp* *:tabprevious* *gT*
|
|
|
136 :tabN[ext] *:tabN* *:tabNext*
|
|
|
137 gT Go to the previous tab page. Wraps around from the first one
|
|
|
138 to the last one.
|
|
|
139
|
|
|
140 :tabp[revious] {count}
|
|
|
141 :tabN[ext] {count}
|
|
|
142 {count}gT Go {count} tab pages back. Wraps around from the first one
|
|
|
143 to the last one.
|
|
|
144
|
|
685
|
145 :tabr[ewind] *:tabfir* *:tabfirst* *:tabr* *:tabrewind*
|
|
686
|
146 :tabfir[st] Go to the first tab page.
|
|
685
|
147
|
|
|
148 *:tabl* *:tablast*
|
|
|
149 :tabl[ast] Go to the last tab page.
|
|
|
150
|
|
682
|
151
|
|
674
|
152 Other commands:
|
|
|
153 *:tabs*
|
|
682
|
154 :tabs List the tab pages and the windows they contain.
|
|
|
155 Shows a ">" for the current window.
|
|
|
156 Shows a "+" for modified buffers.
|
|
|
157
|
|
|
158
|
|
|
159 REORDERING TAB PAGES:
|
|
|
160
|
|
|
161 *:tabm* *:tabmove*
|
|
|
162 :tabmove N Move the current tab page to after tab page N. Use zero to
|
|
|
163 make the current tab page the first one. Without N the tab
|
|
|
164 page is made the last one.
|
|
674
|
165
|
|
685
|
166
|
|
|
167 LOOPING OVER TAB PAGES:
|
|
|
168
|
|
|
169 *:tabd* *:tabdo*
|
|
|
170 :tabd[o] {cmd} Execute {cmd} in each tab page.
|
|
|
171 It works like doing this: >
|
|
|
172 :tabfirst
|
|
|
173 :{cmd}
|
|
|
174 :tabnext
|
|
|
175 :{cmd}
|
|
|
176 etc.
|
|
|
177 < This only operates in the current window of each tab page.
|
|
|
178 When an error is detected on one tab page, further tab pages
|
|
|
179 will not be visited.
|
|
|
180 The last tab page (or where an error occurred) becomes the
|
|
|
181 current tab page.
|
|
|
182 {cmd} can contain '|' to concatenate several commands.
|
|
|
183 {cmd} must not open or close tab pages or reorder them.
|
|
|
184 {not in Vi} {not available when compiled without the
|
|
|
185 |+listcmds| feature}
|
|
|
186 Also see |:windo|, |:argdo| and |:bufdo|.
|
|
|
187
|
|
674
|
188 ==============================================================================
|
|
|
189 3. Other items *tab-page-other*
|
|
|
190
|
|
706
|
191 *tabline-menu*
|
|
|
192 The GUI tab pages line has a popup menu. It is accessed with a right click.
|
|
|
193 The entries are:
|
|
|
194 Close Close the tab page under the mouse pointer. The
|
|
|
195 current one if there is no label under the mouse
|
|
|
196 pointer.
|
|
|
197 New Tab Open a tab page, editing an empty buffer. It appears
|
|
|
198 to the left of the mouse pointer.
|
|
|
199 Open Tab... Like "New Tab" and additionaly use a file selector to
|
|
|
200 select a file to edit.
|
|
|
201
|
|
674
|
202 Diff mode works per tab page. You can see the diffs between several files
|
|
|
203 within one tab page. Other tab pages can show differences between other
|
|
|
204 files.
|
|
|
205
|
|
819
|
206 Variables local to a tab page start with "t:". |tabpage-variable|
|
|
|
207
|
|
824
|
208 Currently there is only one option local to a tab page: 'cmdheight'.
|
|
|
209
|
|
675
|
210 The TabLeave and TabEnter autocommand events can be used to do something when
|
|
|
211 switching from one tab page to another. The exact order depends on what you
|
|
|
212 are doing. When creating a new tab page this works as if you create a new
|
|
|
213 window on the same buffer and then edit another buffer. Thus ":tabnew"
|
|
|
214 triggers:
|
|
|
215 WinLeave leave current window
|
|
|
216 TabLeave leave current tab page
|
|
|
217 TabEnter enter new tab page
|
|
|
218 WinEnter enter window in new tab page
|
|
|
219 BufLeave leave current buffer
|
|
|
220 BufEnter enter new empty buffer
|
|
|
221
|
|
678
|
222 When switching to another tab page the order is:
|
|
675
|
223 BufLeave
|
|
|
224 WinLeave
|
|
|
225 TabLeave
|
|
|
226 TabEnter
|
|
|
227 WinEnter
|
|
|
228 BufEnter
|
|
674
|
229
|
|
678
|
230 ==============================================================================
|
|
|
231 4. Setting 'tabline' *setting-tabline*
|
|
|
232
|
|
686
|
233 The 'tabline' option specifies what the line with tab pages labels looks like.
|
|
|
234 It is only used when there is no GUI tab line.
|
|
|
235
|
|
678
|
236 You can use the 'showtabline' option to specify when you want the line with
|
|
|
237 tab page labels to appear: never, when there is more than one tab page or
|
|
|
238 always.
|
|
|
239
|
|
|
240 The highlighting of the tab pages line is set with the groups TabLine
|
|
|
241 TabLineSel and TabLineFill. |hl-TabLine| |hl-TabLineSel| |hl-TabLineFill|
|
|
|
242
|
|
|
243 The 'tabline' option allows you to define your preferred way to tab pages
|
|
|
244 labels. This isn't easy, thus an example will be given here.
|
|
|
245
|
|
|
246 For basics see the 'statusline' option. The same items can be used in the
|
|
|
247 'tabline' option. Additionally, the |tabpagebuflist()|, |tabpagenr()| and
|
|
|
248 |tabpagewinnr()| functions are useful.
|
|
|
249
|
|
|
250 Since the number of tab labels will vary, you need to use an expresion for the
|
|
|
251 whole option. Something like: >
|
|
|
252 :set tabline=%!MyTabLine()
|
|
|
253
|
|
|
254 Then define the MyTabLine() function to list all the tab pages labels. A
|
|
|
255 convenient method is to split it in two parts: First go over all the tab
|
|
|
256 pages and define labels for them. Then get the label for each tab page. >
|
|
|
257
|
|
|
258 function MyTabLine()
|
|
|
259 let s = ''
|
|
|
260 for i in range(tabpagenr('$'))
|
|
681
|
261 " select the highlighting
|
|
678
|
262 if i + 1 == tabpagenr()
|
|
|
263 let s .= '%#TabLineSel#'
|
|
|
264 else
|
|
|
265 let s .= '%#TabLine#'
|
|
|
266 endif
|
|
681
|
267
|
|
|
268 " set the tab page number (for mouse clicks)
|
|
|
269 let s .= '%' . (i + 1) . 'T'
|
|
|
270
|
|
|
271 " the label is made by MyTabLabel()
|
|
678
|
272 let s .= ' %{MyTabLabel(' . (i + 1) . ')} '
|
|
|
273 endfor
|
|
681
|
274
|
|
|
275 " after the last tab fill with TabLineFill and reset tab page nr
|
|
|
276 let s .= '%#TabLineFill#%T'
|
|
|
277
|
|
|
278 " right-align the label to close the current tab page
|
|
|
279 if tabpagenr('$') > 1
|
|
|
280 let s .= '%=%#TabLine#%999Xclose'
|
|
|
281 endif
|
|
|
282
|
|
678
|
283 return s
|
|
|
284 endfunction
|
|
|
285
|
|
|
286 Now the MyTabLabel() function is called for each tab page to get its label. >
|
|
|
287
|
|
|
288 function MyTabLabel(n)
|
|
|
289 let buflist = tabpagebuflist(a:n)
|
|
|
290 let winnr = tabpagewinnr(a:n)
|
|
|
291 return bufname(buflist[winnr - 1])
|
|
|
292 endfunction
|
|
|
293
|
|
|
294 This is just a simplistic example that results in a tab pages line that
|
|
|
295 resembles the default, but without adding a + for a modified buffer or
|
|
|
296 trunctating the names. You will want to reduce the width of labels in a
|
|
|
297 clever way when there is not enough room. Check the 'columns' option for the
|
|
681
|
298 space available.
|
|
674
|
299
|
|
686
|
300 ==============================================================================
|
|
|
301 5. Setting 'guitablabel' *setting-guitablabel*
|
|
|
302
|
|
|
303 When the GUI tab pages line is displayed, 'guitablabel' can be used to
|
|
|
304 specify the label to display for each tab page. Unlike 'tabline', which
|
|
|
305 specifies the whole tab pages line at once, 'guitablabel' is used for each
|
|
|
306 label separately.
|
|
|
307
|
|
|
308 See the 'statusline' option for the format of the value.
|
|
|
309
|
|
|
310 The "%N" item can be used for the current tab page number. The |v:lnum|
|
|
690
|
311 variable is also set to this number when 'guitablabel' is evaluated.
|
|
|
312 The items that use a file name refer to the current window of the tab page.
|
|
686
|
313
|
|
|
314 Note that syntax highlighting is not used for 'guitablabel'. The %T and %X
|
|
690
|
315 items are also ignored.
|
|
686
|
316
|
|
690
|
317 A simple example that puts the tab page number and the buffer name in the
|
|
|
318 label: >
|
|
686
|
319 :set guitablabel=%N\ %f
|
|
|
320
|
|
|
321 An example that resembles the default: Show the number of windows in the tab
|
|
|
322 page and a '+' if there is a modifed buffer: >
|
|
|
323
|
|
690
|
324 function GuiTabLabel()
|
|
686
|
325 let label = ''
|
|
|
326 let bufnrlist = tabpagebuflist(v:lnum)
|
|
|
327
|
|
|
328 " Add '+' if one of the buffers in the tab page is modified
|
|
|
329 for bufnr in bufnrlist
|
|
|
330 if getbufvar(bufnr, "&modified")
|
|
|
331 let label = '+'
|
|
|
332 break
|
|
|
333 endif
|
|
|
334 endfor
|
|
|
335
|
|
|
336 " Append the number of windows in the tab page if more than one
|
|
|
337 let wincount = tabpagewinnr(v:lnum, '$')
|
|
|
338 if wincount > 1
|
|
|
339 let label .= wincount
|
|
|
340 endif
|
|
|
341 if label != ''
|
|
|
342 let label .= ' '
|
|
|
343 endif
|
|
|
344
|
|
|
345 " Append the buffer name
|
|
|
346 return label . bufname(bufnrlist[tabpagewinnr(v:lnum) - 1])
|
|
|
347 endfunction
|
|
690
|
348
|
|
686
|
349 set guitablabel=%{GuiTabLabel()}
|
|
690
|
350
|
|
|
351 Note that the function must be defined before setting the option, otherwise
|
|
|
352 you get an error message for the function not being known.
|
|
|
353
|
|
686
|
354
|
|
674
|
355 vim:tw=78:ts=8:ft=help:norl:
|
