blob: d116c9f6c5c184782cead6b0610f63e096ead3a3 [file] [log] [blame]
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02001*windows.txt* For Vim version 7.4. Last change: 2014 Sep 23
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Editing with multiple windows and buffers. *windows* *buffers*
8
9The commands which have been added to use multiple windows and buffers are
10explained here. Additionally, there are explanations for commands that work
11differently when used in combination with more than one window.
12
13The basics are explained in chapter 7 and 8 of the user manual |usr_07.txt|
14|usr_08.txt|.
15
161. Introduction |windows-intro|
172. Starting Vim |windows-starting|
183. Opening and closing a window |opening-window|
194. Moving cursor to other windows |window-move-cursor|
205. Moving windows around |window-moving|
216. Window resizing |window-resize|
227. Argument and buffer list commands |buffer-list|
238. Do a command in all buffers or windows |list-repeat|
249. Tag or file name under the cursor |window-tag|
2510. The preview window |preview-window|
2611. Using hidden buffers |buffer-hidden|
2712. Special kinds of buffers |special-buffers|
28
29{Vi does not have any of these commands}
30{not able to use multiple windows when the |+windows| feature was disabled at
31compile time}
32{not able to use vertically split windows when the |+vertsplit| feature was
33disabled at compile time}
34
35==============================================================================
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000361. Introduction *windows-intro* *window*
Bram Moolenaar071d4272004-06-13 20:20:40 +000037
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +010038Summary:
39 A buffer is the in-memory text of a file.
40 A window is a viewport on a buffer.
41 A tab page is a collection of windows.
42
Bram Moolenaar071d4272004-06-13 20:20:40 +000043A window is a viewport onto a buffer. You can use multiple windows on one
44buffer, or several windows on different buffers.
45
46A buffer is a file loaded into memory for editing. The original file remains
47unchanged until you write the buffer to the file.
48
49A buffer can be in one of three states:
50
51 *active-buffer*
52active: The buffer is displayed in a window. If there is a file for this
53 buffer, it has been read into the buffer. The buffer may have been
54 modified since then and thus be different from the file.
55 *hidden-buffer*
56hidden: The buffer is not displayed. If there is a file for this buffer, it
57 has been read into the buffer. Otherwise it's the same as an active
58 buffer, you just can't see it.
59 *inactive-buffer*
60inactive: The buffer is not displayed and does not contain anything. Options
61 for the buffer are remembered if the file was once loaded. It can
62 contain marks from the |viminfo| file. But the buffer doesn't
63 contain text.
64
65In a table:
66
67state displayed loaded ":buffers" ~
68 in window shows ~
69active yes yes 'a'
70hidden no yes 'h'
71inactive no no ' '
72
73Note: All CTRL-W commands can also be executed with |:wincmd|, for those
74places where a Normal mode command can't be used or is inconvenient.
75
Bram Moolenaar7e8fd632006-02-18 22:14:51 +000076The main Vim window can hold several split windows. There are also tab pages
77|tab-page|, each of which can hold multiple windows.
78
Bram Moolenaar071d4272004-06-13 20:20:40 +000079==============================================================================
802. Starting Vim *windows-starting*
81
82By default, Vim starts with one window, just like Vi.
83
84The "-o" and "-O" arguments to Vim can be used to open a window for each file
85in the argument list. The "-o" argument will split the windows horizontally;
86the "-O" argument will split the windows vertically. If both "-o" and "-O"
87are given, the last one encountered will be used to determine the split
88orientation. For example, this will open three windows, split horizontally: >
89 vim -o file1 file2 file3
90
91"-oN", where N is a decimal number, opens N windows split horizontally. If
92there are more file names than windows, only N windows are opened and some
93files do not get a window. If there are more windows than file names, the
94last few windows will be editing empty buffers. Similarly, "-ON" opens N
95windows split vertically, with the same restrictions.
96
97If there are many file names, the windows will become very small. You might
98want to set the 'winheight' and/or 'winwidth' options to create a workable
99situation.
100
101Buf/Win Enter/Leave |autocommand|s are not executed when opening the new
102windows and reading the files, that's only done when they are really entered.
103
104 *status-line*
105A status line will be used to separate windows. The 'laststatus' option tells
106when the last window also has a status line:
107 'laststatus' = 0 never a status line
108 'laststatus' = 1 status line if there is more than one window
109 'laststatus' = 2 always a status line
110
111You can change the contents of the status line with the 'statusline' option.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000112This option can be local to the window, so that you can have a different
113status line in each window.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000114
115Normally, inversion is used to display the status line. This can be changed
116with the 's' character in the 'highlight' option. For example, "sb" sets it to
117bold characters. If no highlighting is used for the status line ("sn"), the
118'^' character is used for the current window, and '=' for other windows. If
119the mouse is supported and enabled with the 'mouse' option, a status line can
120be dragged to resize windows.
121
122Note: If you expect your status line to be in reverse video and it isn't,
123check if the 'highlight' option contains "si". In version 3.0, this meant to
124invert the status line. Now it should be "sr", reverse the status line, as
125"si" now stands for italic! If italic is not available on your terminal, the
126status line is inverted anyway; you will only see this problem on terminals
127that have termcap codes for italics.
128
129==============================================================================
1303. Opening and closing a window *opening-window* *E36*
131
132CTRL-W s *CTRL-W_s*
133CTRL-W S *CTRL-W_S*
134CTRL-W CTRL-S *CTRL-W_CTRL-S*
Bram Moolenaar7b449342014-03-25 13:03:48 +0100135:[N]sp[lit] [++opt] [+cmd] [file] *:sp* *:split*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000136 Split current window in two. The result is two viewports on
Bram Moolenaar7b449342014-03-25 13:03:48 +0100137 the same file.
138
139 Make the new window N high (default is to use half the height
140 of the current window). Reduces the current window height to
141 create room (and others, if the 'equalalways' option is set,
142 'eadirection' isn't "hor", and one of them is higher than the
143 current or the new window).
144
145 If [file] is given it will be edited in the new window. If it
146 is not loaded in any buffer, it will be read. Else the new
147 window will use the already loaded buffer.
148
Bram Moolenaar071d4272004-06-13 20:20:40 +0000149 Note: CTRL-S does not work on all terminals and might block
150 further input, use CTRL-Q to get going again.
151 Also see |++opt| and |+cmd|.
152
153CTRL-W CTRL-V *CTRL-W_CTRL-V*
154CTRL-W v *CTRL-W_v*
155:[N]vs[plit] [++opt] [+cmd] [file] *:vs* *:vsplit*
Bram Moolenaar67f71312007-08-12 14:55:56 +0000156 Like |:split|, but split vertically. The windows will be
157 spread out horizontally if
158 1. a width was not specified,
159 2. 'equalalways' is set,
160 3. 'eadirection' isn't "ver", and
Bram Moolenaarc1a11ed2008-06-24 22:09:24 +0000161 4. one of the other windows is wider than the current or new
Bram Moolenaar67f71312007-08-12 14:55:56 +0000162 window.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000163 Note: In other places CTRL-Q does the same as CTRL-V, but here
164 it doesn't!
165
166CTRL-W n *CTRL-W_n*
167CTRL-W CTRL_N *CTRL-W_CTRL-N*
168:[N]new [++opt] [+cmd] *:new*
169 Create a new window and start editing an empty file in it.
170 Make new window N high (default is to use half the existing
171 height). Reduces the current window height to create room (and
172 others, if the 'equalalways' option is set and 'eadirection'
173 isn't "hor").
174 Also see |++opt| and |+cmd|.
175 If 'fileformats' is not empty, the first format given will be
176 used for the new buffer. If 'fileformats' is empty, the
177 'fileformat' of the current buffer is used. This can be
178 overridden with the |++opt| argument.
179 Autocommands are executed in this order:
180 1. WinLeave for the current window
181 2. WinEnter for the new window
182 3. BufLeave for the current buffer
183 4. BufEnter for the new buffer
Bram Moolenaar53bfca22012-04-13 23:04:47 +0200184 This behaves like a ":split" first, and then an ":enew"
185 command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000186
187:[N]vne[w] [++opt] [+cmd] [file] *:vne* *:vnew*
188 Like |:new|, but split vertically. If 'equalalways' is set
189 and 'eadirection' isn't "ver" the windows will be spread out
190 horizontally, unless a width was specified.
191
192:[N]new [++opt] [+cmd] {file}
193:[N]sp[lit] [++opt] [+cmd] {file} *:split_f*
Bram Moolenaar53bfca22012-04-13 23:04:47 +0200194 Create a new window and start editing file {file} in it. This
195 behaves like a ":split" first, and then an ":e" command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000196 If [+cmd] is given, execute the command when the file has been
197 loaded |+cmd|.
198 Also see |++opt|.
199 Make new window N high (default is to use half the existing
200 height). Reduces the current window height to create room
201 (and others, if the 'equalalways' option is set).
202
203:[N]sv[iew] [++opt] [+cmd] {file} *:sv* *:sview* *splitview*
204 Same as ":split", but set 'readonly' option for this buffer.
205
206:[N]sf[ind] [++opt] [+cmd] {file} *:sf* *:sfind* *splitfind*
Bram Moolenaarc236c162008-07-13 17:41:49 +0000207 Same as ":split", but search for {file} in 'path' like in
208 |:find|. Doesn't split if {file} is not found.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000209
210CTRL-W CTRL-^ *CTRL-W_CTRL-^* *CTRL-W_^*
211CTRL-W ^ Does ":split #", split window in two and edit alternate file.
212 When a count is given, it becomes ":split #N", split window
213 and edit buffer N.
214
215Note that the 'splitbelow' and 'splitright' options influence where a new
216window will appear.
217
218 *:vert* *:vertical*
219:vert[ical] {cmd}
220 Execute {cmd}. If it contains a command that splits a window,
221 it will be split vertically.
Bram Moolenaar756ec0f2007-05-05 17:59:48 +0000222 Doesn't work for |:execute| and |:normal|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000223
224:lefta[bove] {cmd} *:lefta* *:leftabove*
225:abo[veleft] {cmd} *:abo* *:aboveleft*
226 Execute {cmd}. If it contains a command that splits a window,
227 it will be opened left (vertical split) or above (horizontal
228 split) the current window. Overrules 'splitbelow' and
229 'splitright'.
Bram Moolenaar756ec0f2007-05-05 17:59:48 +0000230 Doesn't work for |:execute| and |:normal|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000231
232:rightb[elow] {cmd} *:rightb* *:rightbelow*
233:bel[owright] {cmd} *:bel* *:belowright*
234 Execute {cmd}. If it contains a command that splits a window,
235 it will be opened right (vertical split) or below (horizontal
236 split) the current window. Overrules 'splitbelow' and
237 'splitright'.
Bram Moolenaar756ec0f2007-05-05 17:59:48 +0000238 Doesn't work for |:execute| and |:normal|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000239
240 *:topleft* *E442*
241:to[pleft] {cmd}
242 Execute {cmd}. If it contains a command that splits a window,
243 it will appear at the top and occupy the full width of the Vim
244 window. When the split is vertical the window appears at the
245 far left and occupies the full height of the Vim window.
Bram Moolenaar756ec0f2007-05-05 17:59:48 +0000246 Doesn't work for |:execute| and |:normal|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000247
248 *:botright*
249:bo[tright] {cmd}
250 Execute {cmd}. If it contains a command that splits a window,
251 it will appear at the bottom and occupy the full width of the
252 Vim window. When the split is vertical the window appears at
253 the far right and occupies the full height of the Vim window.
Bram Moolenaar756ec0f2007-05-05 17:59:48 +0000254 Doesn't work for |:execute| and |:normal|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000255
256These command modifiers can be combined to make a vertically split window
257occupy the full height. Example: >
Bram Moolenaar5302d9e2011-09-14 17:55:08 +0200258 :vertical topleft split tags
Bram Moolenaar071d4272004-06-13 20:20:40 +0000259Opens a vertically split, full-height window on the "tags" file at the far
260left of the Vim window.
261
262
263Closing a window
264----------------
265
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100266:q[uit]
267:{count}q[uit]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000268CTRL-W q *CTRL-W_q*
269CTRL-W CTRL-Q *CTRL-W_CTRL-Q*
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100270 Without {count}: Quit the current window. If {count} is
271 given quit the {count} window.
272
273 When quitting the last window (not counting a help window),
274 exit Vim.
275
Bram Moolenaar071d4272004-06-13 20:20:40 +0000276 When 'hidden' is set, and there is only one window for the
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100277 current buffer, it becomes hidden. When 'hidden' is not set,
278 and there is only one window for the current buffer, and the
279 buffer was changed, the command fails.
280
281 (Note: CTRL-Q does not
282 work on all terminals). If [count] is greater than
283 the last window number the last window will be closed: >
284 :1quit " quit the first window
285 :$quit " quit the last window
286 :9quit " quit the last window
287 " if there are less than 9 windows opened
288 :-quit " quit the previews window
289 :+quit " quit the next window
290 :+2quit " will also work as expected
291<
292:q[uit]!
293:{count}q[uit]!
294 Without {count}: Quit the current window. If {count} is
295 given quit the {count} window.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000296
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100297 If this was the last window for a buffer, any changes to that
298 buffer are lost. When quitting the last window (not counting
299 help windows), exit Vim. The contents of the buffer are lost,
300 even when 'hidden' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000301
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100302:clo[se][!]
303:{count}clo[se][!]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000304CTRL-W c *CTRL-W_c* *:clo* *:close*
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100305 Without {count}: Close the current window. If {count} is
306 given close the {count} window.
307
308 When the 'hidden' option is set, or when the buffer was
309 changed and the [!] is used, the buffer becomes hidden (unless
310 there is another window editing it).
311
Bram Moolenaar7e8fd632006-02-18 22:14:51 +0000312 When there is only one window in the current tab page and
313 there is another tab page, this closes the current tab page.
314 |tab-page|.
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100315
Bram Moolenaar071d4272004-06-13 20:20:40 +0000316 This command fails when: *E444*
317 - There is only one window on the screen.
318 - When 'hidden' is not set, [!] is not used, the buffer has
319 changes, and there is no other window on this buffer.
320 Changes to the buffer are not written and won't get lost, so
321 this is a "safe" command.
322
323CTRL-W CTRL-C *CTRL-W_CTRL-C*
324 You might have expected that CTRL-W CTRL-C closes the current
325 window, but that does not work, because the CTRL-C cancels the
326 command.
327
328 *:hide*
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100329:hid[e]
330:{count}hid[e]
331 Quit the current window, unless it is the last window on the
332 screen. For {count} see |:quit| command.
333
334 The buffer becomes hidden (unless there is another window
335 editing it or 'bufhidden' is "unload" or "delete"). If the
336 window is the last one in the current tab page the tab page is
337 closed. |tab-page|
338
339 The value of 'hidden' is irrelevant for this command. Changes
340 to the buffer are not written and won't get lost, so this is a
341 "safe" command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000342
343:hid[e] {cmd} Execute {cmd} with 'hidden' is set. The previous value of
344 'hidden' is restored after {cmd} has been executed.
345 Example: >
346 :hide edit Makefile
347< This will edit "Makefile", and hide the current buffer if it
348 has any changes.
349
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100350:on[ly][!]
351:{count}on[ly][!]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000352CTRL-W o *CTRL-W_o* *E445*
353CTRL-W CTRL-O *CTRL-W_CTRL-O* *:on* *:only*
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100354 Make the current window the only one on the screen. All other
355 windows are closed. For {count} see |:quit| command.
356
Bram Moolenaar071d4272004-06-13 20:20:40 +0000357 When the 'hidden' option is set, all buffers in closed windows
358 become hidden.
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100359
Bram Moolenaar071d4272004-06-13 20:20:40 +0000360 When 'hidden' is not set, and the 'autowrite' option is set,
361 modified buffers are written. Otherwise, windows that have
362 buffers that are modified are not removed, unless the [!] is
363 given, then they become hidden. But modified buffers are
364 never abandoned, so changes cannot get lost.
365
366==============================================================================
3674. Moving cursor to other windows *window-move-cursor*
368
369CTRL-W <Down> *CTRL-W_<Down>*
370CTRL-W CTRL-J *CTRL-W_CTRL-J* *CTRL-W_j*
371CTRL-W j Move cursor to Nth window below current one. Uses the cursor
372 position to select between alternatives.
373
374CTRL-W <Up> *CTRL-W_<Up>*
375CTRL-W CTRL-K *CTRL-W_CTRL-K* *CTRL-W_k*
376CTRL-W k Move cursor to Nth window above current one. Uses the cursor
377 position to select between alternatives.
378
379CTRL-W <Left> *CTRL-W_<Left>*
380CTRL-W CTRL-H *CTRL-W_CTRL-H*
381CTRL-W <BS> *CTRL-W_<BS>* *CTRL-W_h*
382CTRL-W h Move cursor to Nth window left of current one. Uses the
383 cursor position to select between alternatives.
384
385CTRL-W <Right> *CTRL-W_<Right>*
386CTRL-W CTRL-L *CTRL-W_CTRL-L* *CTRL-W_l*
387CTRL-W l Move cursor to Nth window right of current one. Uses the
388 cursor position to select between alternatives.
389
390CTRL-W w *CTRL-W_w* *CTRL-W_CTRL-W*
391CTRL-W CTRL-W Without count: move cursor to window below/right of the
392 current one. If there is no window below or right, go to
393 top-left window.
394 With count: go to Nth window (windows are numbered from
395 top-left to bottom-right). To obtain the window number see
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100396 |bufwinnr()| and |winnr()|. When N is larger than the number
397 of windows go to the last window.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000398
399 *CTRL-W_W*
400CTRL-W W Without count: move cursor to window above/left of current
401 one. If there is no window above or left, go to bottom-right
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100402 window. With count: go to Nth window, like with CTRL-W w.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000403
404CTRL-W t *CTRL-W_t* *CTRL-W_CTRL-T*
405CTRL-W CTRL-T Move cursor to top-left window.
406
407CTRL-W b *CTRL-W_b* *CTRL-W_CTRL-B*
408CTRL-W CTRL-B Move cursor to bottom-right window.
409
410CTRL-W p *CTRL-W_p* *CTRL-W_CTRL-P*
411CTRL-W CTRL-P Go to previous (last accessed) window.
412
413 *CTRL-W_P* *E441*
414CTRL-W P Go to preview window. When there is no preview window this is
415 an error.
416 {not available when compiled without the |+quickfix| feature}
417
418If Visual mode is active and the new window is not for the same buffer, the
419Visual mode is ended. If the window is on the same buffer, the cursor
420position is set to keep the same Visual area selected.
421
422 *:winc* *:wincmd*
423These commands can also be executed with ":wincmd":
424
425:[count]winc[md] {arg}
426 Like executing CTRL-W [count] {arg}. Example: >
427 :wincmd j
428< Moves to the window below the current one.
429 This command is useful when a Normal mode cannot be used (for
430 the |CursorHold| autocommand event). Or when a Normal mode
431 command is inconvenient.
432 The count can also be a window number. Example: >
433 :exe nr . "wincmd w"
434< This goes to window "nr".
435
436==============================================================================
4375. Moving windows around *window-moving*
438
439CTRL-W r *CTRL-W_r* *CTRL-W_CTRL-R* *E443*
440CTRL-W CTRL-R Rotate windows downwards/rightwards. The first window becomes
441 the second one, the second one becomes the third one, etc.
442 The last window becomes the first window. The cursor remains
443 in the same window.
444 This only works within the row or column of windows that the
445 current window is in.
446
447 *CTRL-W_R*
448CTRL-W R Rotate windows upwards/leftwards. The second window becomes
449 the first one, the third one becomes the second one, etc. The
450 first window becomes the last window. The cursor remains in
451 the same window.
452 This only works within the row or column of windows that the
453 current window is in.
454
455CTRL-W x *CTRL-W_x* *CTRL-W_CTRL-X*
456CTRL-W CTRL-X Without count: Exchange current window with next one. If there
457 is no next window, exchange with previous window.
458 With count: Exchange current window with Nth window (first
459 window is 1). The cursor is put in the other window.
460 When vertical and horizontal window splits are mixed, the
461 exchange is only done in the row or column of windows that the
462 current window is in.
463
464The following commands can be used to change the window layout. For example,
465when there are two vertically split windows, CTRL-W K will change that in
466horizontally split windows. CTRL-W H does it the other way around.
467
468 *CTRL-W_K*
469CTRL-W K Move the current window to be at the very top, using the full
470 width of the screen. This works like closing the current
471 window and then creating another one with ":topleft split",
472 except that the current window contents is used for the new
473 window.
474
475 *CTRL-W_J*
476CTRL-W J Move the current window to be at the very bottom, using the
477 full width of the screen. This works like closing the current
478 window and then creating another one with ":botright split",
479 except that the current window contents is used for the new
480 window.
481
482 *CTRL-W_H*
483CTRL-W H Move the current window to be at the far left, using the
484 full height of the screen. This works like closing the
485 current window and then creating another one with
486 ":vert topleft split", except that the current window contents
487 is used for the new window.
Bram Moolenaardb84e452010-08-15 13:50:43 +0200488 {not available when compiled without the |+vertsplit| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000489
490 *CTRL-W_L*
491CTRL-W L Move the current window to be at the far right, using the full
492 height of the screen. This works like closing the
493 current window and then creating another one with
494 ":vert botright split", except that the current window
495 contents is used for the new window.
Bram Moolenaardb84e452010-08-15 13:50:43 +0200496 {not available when compiled without the |+vertsplit| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000497
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000498 *CTRL-W_T*
499CTRL-W T Move the current window to a new tab page. This fails if
500 there is only one window in the current tab page.
501 When a count is specified the new tab page will be opened
502 before the tab page with this index. Otherwise it comes after
503 the current tab page.
504
Bram Moolenaar071d4272004-06-13 20:20:40 +0000505==============================================================================
5066. Window resizing *window-resize*
507
508 *CTRL-W_=*
509CTRL-W = Make all windows (almost) equally high and wide, but use
510 'winheight' and 'winwidth' for the current window.
Bram Moolenaar756ec0f2007-05-05 17:59:48 +0000511 Windows with 'winfixheight' set keep their height and windows
512 with 'winfixwidth' set keep their width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000513
514:res[ize] -N *:res* *:resize* *CTRL-W_-*
515CTRL-W - Decrease current window height by N (default 1).
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200516 If used after |:vertical|: decrease width by N.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000517
518:res[ize] +N *CTRL-W_+*
519CTRL-W + Increase current window height by N (default 1).
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200520 If used after |:vertical|: increase width by N.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000521
522:res[ize] [N]
523CTRL-W CTRL-_ *CTRL-W_CTRL-_* *CTRL-W__*
524CTRL-W _ Set current window height to N (default: highest possible).
525
526z{nr}<CR> Set current window height to {nr}.
527
528 *CTRL-W_<*
529CTRL-W < Decrease current window width by N (default 1).
530
531 *CTRL-W_>*
532CTRL-W > Increase current window width by N (default 1).
533
534:vertical res[ize] [N] *:vertical-resize* *CTRL-W_bar*
535CTRL-W | Set current window width to N (default: widest possible).
536
537You can also resize a window by dragging a status line up or down with the
538mouse. Or by dragging a vertical separator line left or right. This only
539works if the version of Vim that is being used supports the mouse and the
540'mouse' option has been set to enable it.
541
542The option 'winheight' ('wh') is used to set the minimal window height of the
543current window. This option is used each time another window becomes the
544current window. If the option is '0', it is disabled. Set 'winheight' to a
545very large value, e.g., '9999', to make the current window always fill all
546available space. Set it to a reasonable value, e.g., '10', to make editing in
547the current window comfortable.
548
549The equivalent 'winwidth' ('wiw') option is used to set the minimal width of
550the current window.
551
552When the option 'equalalways' ('ea') is set, all the windows are automatically
553made the same size after splitting or closing a window. If you don't set this
554option, splitting a window will reduce the size of the current window and
555leave the other windows the same. When closing a window, the extra lines are
556given to the window above it.
557
558The 'eadirection' option limits the direction in which the 'equalalways'
559option is applied. The default "both" resizes in both directions. When the
560value is "ver" only the heights of windows are equalized. Use this when you
561have manually resized a vertically split window and want to keep this width.
562Likewise, "hor" causes only the widths of windows to be equalized.
563
564The option 'cmdheight' ('ch') is used to set the height of the command-line.
565If you are annoyed by the |hit-enter| prompt for long messages, set this
566option to 2 or 3.
567
568If there is only one window, resizing that window will also change the command
569line height. If there are several windows, resizing the current window will
570also change the height of the window below it (and sometimes the window above
571it).
572
573The minimal height and width of a window is set with 'winminheight' and
574'winminwidth'. These are hard values, a window will never become smaller.
575
576==============================================================================
5777. Argument and buffer list commands *buffer-list*
578
579 args list buffer list meaning ~
5801. :[N]argument [N] 11. :[N]buffer [N] to arg/buf N
5812. :[N]next [file ..] 12. :[N]bnext [N] to Nth next arg/buf
5823. :[N]Next [N] 13. :[N]bNext [N] to Nth previous arg/buf
5834. :[N]previous [N] 14. :[N]bprevious [N] to Nth previous arg/buf
5845. :rewind / :first 15. :brewind / :bfirst to first arg/buf
5856. :last 16. :blast to last arg/buf
5867. :all 17. :ball edit all args/buffers
587 18. :unhide edit all loaded buffers
588 19. :[N]bmod [N] to Nth modified buf
589
590 split & args list split & buffer list meaning ~
59121. :[N]sargument [N] 31. :[N]sbuffer [N] split + to arg/buf N
59222. :[N]snext [file ..] 32. :[N]sbnext [N] split + to Nth next arg/buf
59323. :[N]sNext [N] 33. :[N]sbNext [N] split + to Nth previous arg/buf
59424. :[N]sprevious [N] 34. :[N]sbprevious [N] split + to Nth previous arg/buf
59525. :srewind / :sfirst 35. :sbrewind / :sbfirst split + to first arg/buf
59626. :slast 36. :sblast split + to last arg/buf
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +000059727. :sall 37. :sball edit all args/buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +0000598 38. :sunhide edit all loaded buffers
599 39. :[N]sbmod [N] split + to Nth modified buf
600
60140. :args list of arguments
60241. :buffers list of buffers
603
604The meaning of [N] depends on the command:
605 [N] is number of buffers to go forward/backward on ?2, ?3, and ?4
606 [N] is an argument number, defaulting to current argument, for 1 and 21
607 [N] is a buffer number, defaulting to current buffer, for 11 and 31
608 [N] is a count for 19 and 39
609
610Note: ":next" is an exception, because it must accept a list of file names
611for compatibility with Vi.
612
613
614The argument list and multiple windows
615--------------------------------------
616
617The current position in the argument list can be different for each window.
618Remember that when doing ":e file", the position in the argument list stays
619the same, but you are not editing the file at that position. To indicate
620this, the file message (and the title, if you have one) shows
621"(file (N) of M)", where "(N)" is the current position in the file list, and
622"M" the number of files in the file list.
623
624All the entries in the argument list are added to the buffer list. Thus, you
625can also get to them with the buffer list commands, like ":bnext".
626
627:[N]al[l][!] [N] *:al* *:all* *:sal* *:sall*
628:[N]sal[l][!] [N]
629 Rearrange the screen to open one window for each argument.
630 All other windows are closed. When a count is given, this is
631 the maximum number of windows to open.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +0000632 With the |:tab| modifier open a tab page for each argument.
633 When there are more arguments than 'tabpagemax' further ones
634 become split windows in the last tab page.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000635 When the 'hidden' option is set, all buffers in closed windows
636 become hidden.
637 When 'hidden' is not set, and the 'autowrite' option is set,
638 modified buffers are written. Otherwise, windows that have
639 buffers that are modified are not removed, unless the [!] is
640 given, then they become hidden. But modified buffers are
641 never abandoned, so changes cannot get lost.
642 [N] is the maximum number of windows to open. 'winheight'
643 also limits the number of windows opened ('winwidth' if
644 |:vertical| was prepended).
645 Buf/Win Enter/Leave autocommands are not executed for the new
646 windows here, that's only done when they are really entered.
647
648:[N]sa[rgument][!] [++opt] [+cmd] [N] *:sa* *:sargument*
649 Short for ":split | argument [N]": split window and go to Nth
650 argument. But when there is no such argument, the window is
651 not split. Also see |++opt| and |+cmd|.
652
653:[N]sn[ext][!] [++opt] [+cmd] [file ..] *:sn* *:snext*
654 Short for ":split | [N]next": split window and go to Nth next
655 argument. But when there is no next file, the window is not
656 split. Also see |++opt| and |+cmd|.
657
658:[N]spr[evious][!] [++opt] [+cmd] [N] *:spr* *:sprevious*
659:[N]sN[ext][!] [++opt] [+cmd] [N] *:sN* *:sNext*
660 Short for ":split | [N]Next": split window and go to Nth
661 previous argument. But when there is no previous file, the
662 window is not split. Also see |++opt| and |+cmd|.
663
664 *:sre* *:srewind*
665:sre[wind][!] [++opt] [+cmd]
666 Short for ":split | rewind": split window and go to first
667 argument. But when there is no argument list, the window is
668 not split. Also see |++opt| and |+cmd|.
669
670 *:sfir* *:sfirst*
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000671:sfir[st] [++opt] [+cmd]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000672 Same as ":srewind".
673
674 *:sla* *:slast*
675:sla[st][!] [++opt] [+cmd]
676 Short for ":split | last": split window and go to last
677 argument. But when there is no argument list, the window is
678 not split. Also see |++opt| and |+cmd|.
679
680 *:dr* *:drop*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000681:dr[op] [++opt] [+cmd] {file} ..
Bram Moolenaar071d4272004-06-13 20:20:40 +0000682 Edit the first {file} in a window.
683 - If the file is already open in a window change to that
684 window.
685 - If the file is not open in a window edit the file in the
686 current window. If the current buffer can't be |abandon|ed,
687 the window is split first.
688 The |argument-list| is set, like with the |:next| command.
689 The purpose of this command is that it can be used from a
690 program that wants Vim to edit another file, e.g., a debugger.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000691 When using the |:tab| modifier each argument is opened in a
692 tab page. The last window is used if it's empty.
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000693 Also see |++opt| and |+cmd|.
Bram Moolenaardb84e452010-08-15 13:50:43 +0200694 {only available when compiled with a GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000695
696==============================================================================
6978. Do a command in all buffers or windows *list-repeat*
698
699 *:windo*
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000700:windo {cmd} Execute {cmd} in each window.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000701 It works like doing this: >
702 CTRL-W t
703 :{cmd}
704 CTRL-W w
705 :{cmd}
706 etc.
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000707< This only operates in the current tab page.
Bram Moolenaar7e8fd632006-02-18 22:14:51 +0000708 When an error is detected on one window, further
Bram Moolenaar071d4272004-06-13 20:20:40 +0000709 windows will not be visited.
710 The last window (or where an error occurred) becomes
711 the current window.
712 {cmd} can contain '|' to concatenate several commands.
713 {cmd} must not open or close windows or reorder them.
714 {not in Vi} {not available when compiled without the
715 |+listcmds| feature}
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000716 Also see |:tabdo|, |:argdo| and |:bufdo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000717
718 *:bufdo*
719:bufdo[!] {cmd} Execute {cmd} in each buffer in the buffer list.
720 It works like doing this: >
721 :bfirst
722 :{cmd}
723 :bnext
724 :{cmd}
725 etc.
726< When the current file can't be |abandon|ed and the [!]
727 is not present, the command fails.
728 When an error is detected on one buffer, further
729 buffers will not be visited.
730 Unlisted buffers are skipped.
731 The last buffer (or where an error occurred) becomes
732 the current buffer.
733 {cmd} can contain '|' to concatenate several commands.
734 {cmd} must not delete buffers or add buffers to the
735 buffer list.
736 Note: While this command is executing, the Syntax
737 autocommand event is disabled by adding it to
738 'eventignore'. This considerably speeds up editing
739 each buffer.
740 {not in Vi} {not available when compiled without the
741 |+listcmds| feature}
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000742 Also see |:tabdo|, |:argdo| and |:windo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000743
744Examples: >
745
746 :windo set nolist nofoldcolumn | normal zn
747
748This resets the 'list' option and disables folding in all windows. >
749
750 :bufdo set fileencoding= | update
751
752This resets the 'fileencoding' in each buffer and writes it if this changed
753the buffer. The result is that all buffers will use the 'encoding' encoding
754(if conversion works properly).
755
756==============================================================================
7579. Tag or file name under the cursor *window-tag*
758
759 *:sta* *:stag*
760:sta[g][!] [tagname]
761 Does ":tag[!] [tagname]" and splits the window for the found
762 tag. See also |:tag|.
763
764CTRL-W ] *CTRL-W_]* *CTRL-W_CTRL-]*
765CTRL-W CTRL-] Split current window in two. Use identifier under cursor as a
Bram Moolenaar3a991dd2014-10-02 01:41:41 +0200766 tag and jump to it in the new upper window.
767 In Visual mode uses the Visually selected text as a tag.
768 Make new window N high.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000769
770 *CTRL-W_g]*
771CTRL-W g ] Split current window in two. Use identifier under cursor as a
772 tag and perform ":tselect" on it in the new upper window.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +0200773 In Visual mode uses the Visually selected text as a tag.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000774 Make new window N high.
775
776 *CTRL-W_g_CTRL-]*
777CTRL-W g CTRL-] Split current window in two. Use identifier under cursor as a
Bram Moolenaar3a991dd2014-10-02 01:41:41 +0200778 tag and perform ":tjump" on it in the new upper window.
779 In Visual mode uses the Visually selected text as a tag.
780 Make new window N high.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000781
782CTRL-W f *CTRL-W_f* *CTRL-W_CTRL-F*
783CTRL-W CTRL-F Split current window in two. Edit file name under cursor.
Bram Moolenaar8dff8182006-04-06 20:18:50 +0000784 Like ":split gf", but window isn't split if the file does not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000785 exist.
786 Uses the 'path' variable as a list of directory names where to
787 look for the file. Also the path for current file is
788 used to search for the file name.
789 If the name is a hypertext link that looks like
790 "type://machine/path", only "/path" is used.
791 If a count is given, the count'th matching file is edited.
792 {not available when the |+file_in_path| feature was disabled
793 at compile time}
794
Bram Moolenaard1f56e62006-02-22 21:25:37 +0000795CTRL-W F *CTRL-W_F*
796 Split current window in two. Edit file name under cursor and
797 jump to the line number following the file name. See |gF| for
798 details on how the line number is obtained.
Bram Moolenaar57657d82006-04-21 22:12:41 +0000799 {not available when the |+file_in_path| feature was disabled
800 at compile time}
Bram Moolenaard1f56e62006-02-22 21:25:37 +0000801
Bram Moolenaar8dff8182006-04-06 20:18:50 +0000802CTRL-W gf *CTRL-W_gf*
803 Open a new tab page and edit the file name under the cursor.
804 Like "tab split" and "gf", but the new tab page isn't created
805 if the file does not exist.
806 {not available when the |+file_in_path| feature was disabled
807 at compile time}
808
Bram Moolenaar57657d82006-04-21 22:12:41 +0000809CTRL-W gF *CTRL-W_gF*
810 Open a new tab page and edit the file name under the cursor
811 and jump to the line number following the file name. Like
812 "tab split" and "gF", but the new tab page isn't created if
813 the file does not exist.
814 {not available when the |+file_in_path| feature was disabled
815 at compile time}
816
Bram Moolenaar071d4272004-06-13 20:20:40 +0000817Also see |CTRL-W_CTRL-I|: open window for an included file that includes
818the keyword under the cursor.
819
820==============================================================================
82110. The preview window *preview-window*
822
823The preview window is a special window to show (preview) another file. It is
824normally a small window used to show an include file or definition of a
825function.
826{not available when compiled without the |+quickfix| feature}
827
Bram Moolenaarc270d802006-03-11 21:29:41 +0000828There can be only one preview window (per tab page). It is created with one
829of the commands below. The 'previewheight' option can be set to specify the
830height of the preview window when it's opened. The 'previewwindow' option is
831set in the preview window to be able to recognize it. The 'winfixheight'
832option is set to have it keep the same height when opening/closing other
833windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000834
835 *:pta* *:ptag*
836:pta[g][!] [tagname]
837 Does ":tag[!] [tagname]" and shows the found tag in a
838 "Preview" window without changing the current buffer or cursor
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000839 position. If a "Preview" window already exists, it is re-used
Bram Moolenaar071d4272004-06-13 20:20:40 +0000840 (like a help window is). If a new one is opened,
841 'previewheight' is used for the height of the window. See
842 also |:tag|.
843 See below for an example. |CursorHold-example|
844 Small difference from |:tag|: When [tagname] is equal to the
845 already displayed tag, the position in the matching tag list
846 is not reset. This makes the CursorHold example work after a
847 |:ptnext|.
848
849CTRL-W z *CTRL-W_z*
850CTRL-W CTRL-Z *CTRL-W_CTRL-Z* *:pc* *:pclose*
851:pc[lose][!] Close any "Preview" window currently open. When the 'hidden'
852 option is set, or when the buffer was changed and the [!] is
853 used, the buffer becomes hidden (unless there is another
854 window editing it). The command fails if any "Preview" buffer
855 cannot be closed. See also |:close|.
856
857 *:pp* *:ppop*
858:[count]pp[op][!]
859 Does ":[count]pop[!]" in the preview window. See |:pop| and
860 |:ptag|. {not in Vi}
861
862CTRL-W } *CTRL-W_}*
863 Use identifier under cursor as a tag and perform a :ptag on
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000864 it. Make the new Preview window (if required) N high. If N is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000865 not given, 'previewheight' is used.
866
867CTRL-W g } *CTRL-W_g}*
868 Use identifier under cursor as a tag and perform a :ptjump on
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000869 it. Make the new Preview window (if required) N high. If N is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000870 not given, 'previewheight' is used.
871
872 *:ped* *:pedit*
873:ped[it][!] [++opt] [+cmd] {file}
874 Edit {file} in the preview window. The preview window is
875 opened like with |:ptag|. The current window and cursor
876 position isn't changed. Useful example: >
877 :pedit +/fputc /usr/include/stdio.h
878<
879 *:ps* *:psearch*
880:[range]ps[earch][!] [count] [/]pattern[/]
881 Works like |:ijump| but shows the found match in the preview
882 window. The preview window is opened like with |:ptag|. The
883 current window and cursor position isn't changed. Useful
884 example: >
885 :psearch popen
886< Like with the |:ptag| command, you can use this to
887 automatically show information about the word under the
888 cursor. This is less clever than using |:ptag|, but you don't
889 need a tags file and it will also find matches in system
890 include files. Example: >
891 :au! CursorHold *.[ch] nested exe "silent! psearch " . expand("<cword>")
892< Warning: This can be slow.
893
894Example *CursorHold-example* >
895
896 :au! CursorHold *.[ch] nested exe "silent! ptag " . expand("<cword>")
897
898This will cause a ":ptag" to be executed for the keyword under the cursor,
899when the cursor hasn't moved for the time set with 'updatetime'. The "nested"
900makes other autocommands be executed, so that syntax highlighting works in the
901preview window. The "silent!" avoids an error message when the tag could not
902be found. Also see |CursorHold|. To disable this again: >
903
904 :au! CursorHold
905
906A nice addition is to highlight the found tag, avoid the ":ptag" when there
907is no word under the cursor, and a few other things: >
908
909 :au! CursorHold *.[ch] nested call PreviewWord()
910 :func PreviewWord()
911 : if &previewwindow " don't do this in the preview window
912 : return
913 : endif
914 : let w = expand("<cword>") " get the word under cursor
915 : if w =~ '\a' " if the word contains a letter
916 :
917 : " Delete any existing highlight before showing another tag
918 : silent! wincmd P " jump to preview window
919 : if &previewwindow " if we really get there...
920 : match none " delete existing highlight
921 : wincmd p " back to old window
922 : endif
923 :
924 : " Try displaying a matching tag for the word under the cursor
925 : try
926 : exe "ptag " . w
927 : catch
928 : return
929 : endtry
930 :
931 : silent! wincmd P " jump to preview window
932 : if &previewwindow " if we really get there...
933 : if has("folding")
934 : silent! .foldopen " don't want a closed fold
935 : endif
936 : call search("$", "b") " to end of previous line
937 : let w = substitute(w, '\\', '\\\\', "")
938 : call search('\<\V' . w . '\>') " position cursor on match
939 : " Add a match highlight to the word at this position
940 : hi previewWord term=bold ctermbg=green guibg=green
941 : exe 'match previewWord "\%' . line(".") . 'l\%' . col(".") . 'c\k*"'
942 : wincmd p " back to old window
943 : endif
944 : endif
945 :endfun
946
947==============================================================================
94811. Using hidden buffers *buffer-hidden*
949
950A hidden buffer is not displayed in a window, but is still loaded into memory.
951This makes it possible to jump from file to file, without the need to read or
952write the file every time you get another buffer in a window.
953{not available when compiled without the |+listcmds| feature}
954
955 *:buffer-!*
956If the option 'hidden' ('hid') is set, abandoned buffers are kept for all
957commands that start editing another file: ":edit", ":next", ":tag", etc. The
958commands that move through the buffer list sometimes make the current buffer
959hidden although the 'hidden' option is not set. This happens when a buffer is
960modified, but is forced (with '!') to be removed from a window, and
961'autowrite' is off or the buffer can't be written.
962
963You can make a hidden buffer not hidden by starting to edit it with any
964command. Or by deleting it with the ":bdelete" command.
965
966The 'hidden' is global, it is used for all buffers. The 'bufhidden' option
967can be used to make an exception for a specific buffer. It can take these
968values:
969 <empty> Use the value of 'hidden'.
970 hide Hide this buffer, also when 'hidden' is not set.
971 unload Don't hide but unload this buffer, also when 'hidden'
972 is set.
973 delete Delete the buffer.
974
975 *hidden-quit*
976When you try to quit Vim while there is a hidden, modified buffer, you will
977get an error message and Vim will make that buffer the current buffer. You
978can then decide to write this buffer (":wq") or quit without writing (":q!").
979Be careful: there may be more hidden, modified buffers!
980
981A buffer can also be unlisted. This means it exists, but it is not in the
982list of buffers. |unlisted-buffer|
983
984
985:files[!] *:files*
986:buffers[!] *:buffers* *:ls*
987:ls[!] Show all buffers. Example:
988
Bram Moolenaar97d62492012-11-15 21:28:22 +0100989 1 #h "/test/text" line 1 ~
990 2u "asdf" line 0 ~
991 3 %a + "version.c" line 1 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000992
993 When the [!] is included the list will show unlisted buffers
994 (the term "unlisted" is a bit confusing then...).
995
996 Each buffer has a unique number. That number will not change,
997 so you can always go to a specific buffer with ":buffer N" or
998 "N CTRL-^", where N is the buffer number.
999
1000 Indicators (chars in the same column are mutually exclusive):
1001 u an unlisted buffer (only displayed when [!] is used)
1002 |unlisted-buffer|
1003 % the buffer in the current window
1004 # the alternate buffer for ":e #" and CTRL-^
1005 a an active buffer: it is loaded and visible
1006 h a hidden buffer: It is loaded, but currently not
1007 displayed in a window |hidden-buffer|
1008 - a buffer with 'modifiable' off
1009 = a readonly buffer
1010 + a modified buffer
1011 x a buffer with read errors
1012
1013 *:bad* *:badd*
1014:bad[d] [+lnum] {fname}
1015 Add file name {fname} to the buffer list, without loading it.
1016 If "lnum" is specified, the cursor will be positioned at that
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001017 line when the buffer is first entered. Note that other
Bram Moolenaar071d4272004-06-13 20:20:40 +00001018 commands after the + will be ignored.
1019
1020:[N]bd[elete][!] *:bd* *:bdel* *:bdelete* *E516*
1021:bd[elete][!] [N]
1022 Unload buffer [N] (default: current buffer) and delete it from
1023 the buffer list. If the buffer was changed, this fails,
1024 unless when [!] is specified, in which case changes are lost.
1025 The file remains unaffected. Any windows for this buffer are
1026 closed. If buffer [N] is the current buffer, another buffer
1027 will be displayed instead. This is the most recent entry in
1028 the jump list that points into a loaded buffer.
1029 Actually, the buffer isn't completely deleted, it is removed
1030 from the buffer list |unlisted-buffer| and option values,
1031 variables and mappings/abbreviations for the buffer are
1032 cleared.
1033
1034:bdelete[!] {bufname} *E93* *E94*
1035 Like ":bdelete[!] [N]", but buffer given by name. Note that a
1036 buffer whose name is a number cannot be referenced by that
1037 name; use the buffer number instead. Insert a backslash
1038 before a space in a buffer name.
1039
1040:bdelete[!] N1 N2 ...
1041 Do ":bdelete[!]" for buffer N1, N2, etc. The arguments can be
1042 buffer numbers or buffer names (but not buffer names that are
1043 a number). Insert a backslash before a space in a buffer
1044 name.
1045
1046:N,Mbdelete[!] Do ":bdelete[!]" for all buffers in the range N to M
1047 |inclusive|.
1048
1049:[N]bw[ipeout][!] *:bw* *:bwipe* *:bwipeout* *E517*
1050:bw[ipeout][!] {bufname}
1051:N,Mbw[ipeout][!]
1052:bw[ipeout][!] N1 N2 ...
Bram Moolenaardf1bdc92006-02-23 21:32:16 +00001053 Like |:bdelete|, but really delete the buffer. Everything
1054 related to the buffer is lost. All marks in this buffer
1055 become invalid, option settings are lost, etc. Don't use this
1056 unless you know what you are doing.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001057
1058:[N]bun[load][!] *:bun* *:bunload* *E515*
1059:bun[load][!] [N]
1060 Unload buffer [N] (default: current buffer). The memory
1061 allocated for this buffer will be freed. The buffer remains
1062 in the buffer list.
1063 If the buffer was changed, this fails, unless when [!] is
1064 specified, in which case the changes are lost.
1065 Any windows for this buffer are closed. If buffer [N] is the
1066 current buffer, another buffer will be displayed instead.
1067 This is the most recent entry in the jump list that points
1068 into a loaded buffer.
1069
1070:bunload[!] {bufname}
1071 Like ":bunload[!] [N]", but buffer given by name. Note that a
1072 buffer whose name is a number cannot be referenced by that
1073 name; use the buffer number instead. Insert a backslash
1074 before a space in a buffer name.
1075
1076:N,Mbunload[!] Do ":bunload[!]" for all buffers in the range N to M
1077 |inclusive|.
1078
1079:bunload[!] N1 N2 ...
1080 Do ":bunload[!]" for buffer N1, N2, etc. The arguments can be
1081 buffer numbers or buffer names (but not buffer names that are
1082 a number). Insert a backslash before a space in a buffer
1083 name.
1084
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001085:[N]b[uffer][!] [+cmd] [N] *:b* *:bu* *:buf* *:buffer* *E86*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001086 Edit buffer [N] from the buffer list. If [N] is not given,
1087 the current buffer remains being edited. See |:buffer-!| for
1088 [!]. This will also edit a buffer that is not in the buffer
1089 list, without setting the 'buflisted' flag.
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001090 Also see ||+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001091
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001092:[N]b[uffer][!] [+cmd] {bufname}
Bram Moolenaarc1a11ed2008-06-24 22:09:24 +00001093 Edit buffer for {bufname} from the buffer list. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00001094 |:buffer-!| for [!]. This will also edit a buffer that is not
1095 in the buffer list, without setting the 'buflisted' flag.
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001096 Also see ||+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001097
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001098:[N]sb[uffer] [+cmd] [N] *:sb* *:sbuffer*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001099 Split window and edit buffer [N] from the buffer list. If [N]
1100 is not given, the current buffer is edited. Respects the
1101 "useopen" setting of 'switchbuf' when splitting. This will
1102 also edit a buffer that is not in the buffer list, without
1103 setting the 'buflisted' flag.
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001104 Also see ||+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001105
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001106:[N]sb[uffer] [+cmd] {bufname}
Bram Moolenaarc1a11ed2008-06-24 22:09:24 +00001107 Split window and edit buffer for {bufname} from the buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001108 list. This will also edit a buffer that is not in the buffer
1109 list, without setting the 'buflisted' flag.
Bram Moolenaar280f1262006-01-30 00:14:18 +00001110 Note: If what you want to do is split the buffer, make a copy
1111 under another name, you can do it this way: >
1112 :w foobar | sp #
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001113< Also see ||+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001114
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001115:[N]bn[ext][!] [+cmd] [N] *:bn* *:bnext* *E87*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001116 Go to [N]th next buffer in buffer list. [N] defaults to one.
1117 Wraps around the end of the buffer list.
1118 See |:buffer-!| for [!].
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001119 Also see ||+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001120 If you are in a help buffer, this takes you to the next help
1121 buffer (if there is one). Similarly, if you are in a normal
1122 (non-help) buffer, this takes you to the next normal buffer.
1123 This is so that if you have invoked help, it doesn't get in
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001124 the way when you're browsing code/text buffers. The next three
Bram Moolenaar071d4272004-06-13 20:20:40 +00001125 commands also work like this.
1126
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001127
Bram Moolenaar071d4272004-06-13 20:20:40 +00001128 *:sbn* *:sbnext*
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001129:[N]sbn[ext] [+cmd] [N]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001130 Split window and go to [N]th next buffer in buffer list.
1131 Wraps around the end of the buffer list. Uses 'switchbuf'
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001132 Also see ||+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001133
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001134:[N]bN[ext][!] [+cmd] [N] *:bN* *:bNext* *:bp* *:bprevious* *E88*
1135:[N]bp[revious][!] [+cmd] [N]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001136 Go to [N]th previous buffer in buffer list. [N] defaults to
1137 one. Wraps around the start of the buffer list.
1138 See |:buffer-!| for [!] and 'switchbuf'.
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001139 Also see ||+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001140
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001141:[N]sbN[ext] [+cmd] [N] *:sbN* *:sbNext* *:sbp* *:sbprevious*
1142:[N]sbp[revious] [+cmd] [N]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001143 Split window and go to [N]th previous buffer in buffer list.
1144 Wraps around the start of the buffer list.
1145 Uses 'switchbuf'.
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001146 Also see ||+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001147
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001148:br[ewind][!] [+cmd] *:br* *:brewind*
1149 Go to first buffer in buffer list. If the buffer list is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001150 empty, go to the first unlisted buffer.
1151 See |:buffer-!| for [!].
1152
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001153:bf[irst] [+cmd] *:bf* *:bfirst*
1154 Same as |:brewind|.
1155 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001156
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001157:sbr[ewind] [+cmd] *:sbr* *:sbrewind*
1158 Split window and go to first buffer in buffer list. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001159 buffer list is empty, go to the first unlisted buffer.
1160 Respects the 'switchbuf' option.
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001161 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001162
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001163:sbf[irst] [+cmd] *:sbf* *:sbfirst*
1164 Same as ":sbrewind".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001165
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001166:bl[ast][!] [+cmd] *:bl* *:blast*
1167 Go to last buffer in buffer list. If the buffer list is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001168 empty, go to the last unlisted buffer.
1169 See |:buffer-!| for [!].
1170
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001171:sbl[ast] [+cmd] *:sbl* *:sblast*
1172 Split window and go to last buffer in buffer list. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001173 buffer list is empty, go to the last unlisted buffer.
1174 Respects 'switchbuf' option.
1175
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001176:[N]bm[odified][!] [+cmd] [N] *:bm* *:bmodified* *E84*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001177 Go to [N]th next modified buffer. Note: this command also
1178 finds unlisted buffers. If there is no modified buffer the
1179 command fails.
1180
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001181:[N]sbm[odified] [+cmd] [N] *:sbm* *:sbmodified*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001182 Split window and go to [N]th next modified buffer.
1183 Respects 'switchbuf' option.
1184 Note: this command also finds buffers not in the buffer list.
1185
1186:[N]unh[ide] [N] *:unh* *:unhide* *:sun* *:sunhide*
1187:[N]sun[hide] [N]
1188 Rearrange the screen to open one window for each loaded buffer
1189 in the buffer list. When a count is given, this is the
1190 maximum number of windows to open.
1191
1192:[N]ba[ll] [N] *:ba* *:ball* *:sba* *:sball*
1193:[N]sba[ll] [N] Rearrange the screen to open one window for each buffer in
1194 the buffer list. When a count is given, this is the maximum
1195 number of windows to open. 'winheight' also limits the number
1196 of windows opened ('winwidth' if |:vertical| was prepended).
1197 Buf/Win Enter/Leave autocommands are not executed for the new
1198 windows here, that's only done when they are really entered.
Bram Moolenaar756ec0f2007-05-05 17:59:48 +00001199 When the |:tab| modifier is used new windows are opened in a
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00001200 new tab, up to 'tabpagemax'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001201
1202Note: All the commands above that start editing another buffer, keep the
1203'readonly' flag as it was. This differs from the ":edit" command, which sets
1204the 'readonly' flag each time the file is read.
1205
1206==============================================================================
120712. Special kinds of buffers *special-buffers*
1208
1209Instead of containing the text of a file, buffers can also be used for other
1210purposes. A few options can be set to change the behavior of a buffer:
1211 'bufhidden' what happens when the buffer is no longer displayed
1212 in a window.
1213 'buftype' what kind of a buffer this is
1214 'swapfile' whether the buffer will have a swap file
1215 'buflisted' buffer shows up in the buffer list
1216
1217A few useful kinds of a buffer:
1218
Bram Moolenaar280f1262006-01-30 00:14:18 +00001219quickfix Used to contain the error list or the location list. See
1220 |:cwindow| and |:lwindow|. This command sets the 'buftype'
1221 option to "quickfix". You are not supposed to change this!
1222 'swapfile' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001223
1224help Contains a help file. Will only be created with the |:help|
1225 command. The flag that indicates a help buffer is internal
1226 and can't be changed. The 'buflisted' option will be reset
1227 for a help buffer.
1228
Bram Moolenaar677ee682005-01-27 14:41:15 +00001229directory Displays directory contents. Can be used by a file explorer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001230 plugin. The buffer is created with these settings: >
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001231 :setlocal buftype=nowrite
1232 :setlocal bufhidden=delete
1233 :setlocal noswapfile
Bram Moolenaar071d4272004-06-13 20:20:40 +00001234< The buffer name is the name of the directory and is adjusted
1235 when using the |:cd| command.
1236
1237scratch Contains text that can be discarded at any time. It is kept
1238 when closing the window, it must be deleted explicitly.
1239 Settings: >
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001240 :setlocal buftype=nofile
1241 :setlocal bufhidden=hide
1242 :setlocal noswapfile
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001243< The buffer name can be used to identify the buffer, if you
1244 give it a meaningful name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001245
1246 *unlisted-buffer*
1247unlisted The buffer is not in the buffer list. It is not used for
1248 normal editing, but to show a help file, remember a file name
1249 or marks. The ":bdelete" command will also set this option,
1250 thus it doesn't completely delete the buffer. Settings: >
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001251 :setlocal nobuflisted
Bram Moolenaar071d4272004-06-13 20:20:40 +00001252<
1253
1254 vim:tw=78:ts=8:ft=help:norl: