blob: d3cf69e42f698bec38c49390d4a041e3d5777308 [file] [log] [blame]
Bram Moolenaarb6e0ec62017-07-23 22:12:20 +02001*windows.txt* For Vim version 8.0. Last change: 2017 Jul 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.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +020078 *window-ID* *winid* *windowid*
Bram Moolenaarc95a3022016-06-12 23:01:46 +020079Each window has a unique identifier called the window ID. This identifier
80will not change within a Vim session. The |win_getid()| and |win_id2tabwin()|
81functions can be used to convert between the window/tab number and the
82identifier. There is also the window number, which may change whenever
83windows are opened or closed, see |winnr()|.
84
85Each buffer has a unique number and the number will not change within a Vim
86session. The |bufnr()| and |bufname()| functions can be used to convert
87between a buffer name and the buffer number.
88
Bram Moolenaar071d4272004-06-13 20:20:40 +000089==============================================================================
902. Starting Vim *windows-starting*
91
92By default, Vim starts with one window, just like Vi.
93
94The "-o" and "-O" arguments to Vim can be used to open a window for each file
95in the argument list. The "-o" argument will split the windows horizontally;
96the "-O" argument will split the windows vertically. If both "-o" and "-O"
97are given, the last one encountered will be used to determine the split
98orientation. For example, this will open three windows, split horizontally: >
99 vim -o file1 file2 file3
100
101"-oN", where N is a decimal number, opens N windows split horizontally. If
102there are more file names than windows, only N windows are opened and some
103files do not get a window. If there are more windows than file names, the
104last few windows will be editing empty buffers. Similarly, "-ON" opens N
105windows split vertically, with the same restrictions.
106
107If there are many file names, the windows will become very small. You might
108want to set the 'winheight' and/or 'winwidth' options to create a workable
109situation.
110
111Buf/Win Enter/Leave |autocommand|s are not executed when opening the new
112windows and reading the files, that's only done when they are really entered.
113
114 *status-line*
115A status line will be used to separate windows. The 'laststatus' option tells
116when the last window also has a status line:
117 'laststatus' = 0 never a status line
118 'laststatus' = 1 status line if there is more than one window
119 'laststatus' = 2 always a status line
120
121You can change the contents of the status line with the 'statusline' option.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000122This option can be local to the window, so that you can have a different
123status line in each window.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000124
125Normally, inversion is used to display the status line. This can be changed
126with the 's' character in the 'highlight' option. For example, "sb" sets it to
127bold characters. If no highlighting is used for the status line ("sn"), the
128'^' character is used for the current window, and '=' for other windows. If
129the mouse is supported and enabled with the 'mouse' option, a status line can
130be dragged to resize windows.
131
132Note: If you expect your status line to be in reverse video and it isn't,
133check if the 'highlight' option contains "si". In version 3.0, this meant to
134invert the status line. Now it should be "sr", reverse the status line, as
135"si" now stands for italic! If italic is not available on your terminal, the
136status line is inverted anyway; you will only see this problem on terminals
137that have termcap codes for italics.
138
139==============================================================================
1403. Opening and closing a window *opening-window* *E36*
141
142CTRL-W s *CTRL-W_s*
143CTRL-W S *CTRL-W_S*
144CTRL-W CTRL-S *CTRL-W_CTRL-S*
Bram Moolenaar7b449342014-03-25 13:03:48 +0100145:[N]sp[lit] [++opt] [+cmd] [file] *:sp* *:split*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000146 Split current window in two. The result is two viewports on
Bram Moolenaar7b449342014-03-25 13:03:48 +0100147 the same file.
148
149 Make the new window N high (default is to use half the height
150 of the current window). Reduces the current window height to
151 create room (and others, if the 'equalalways' option is set,
152 'eadirection' isn't "hor", and one of them is higher than the
153 current or the new window).
154
155 If [file] is given it will be edited in the new window. If it
156 is not loaded in any buffer, it will be read. Else the new
157 window will use the already loaded buffer.
158
Bram Moolenaar071d4272004-06-13 20:20:40 +0000159 Note: CTRL-S does not work on all terminals and might block
160 further input, use CTRL-Q to get going again.
161 Also see |++opt| and |+cmd|.
162
163CTRL-W CTRL-V *CTRL-W_CTRL-V*
164CTRL-W v *CTRL-W_v*
165:[N]vs[plit] [++opt] [+cmd] [file] *:vs* *:vsplit*
Bram Moolenaar67f71312007-08-12 14:55:56 +0000166 Like |:split|, but split vertically. The windows will be
167 spread out horizontally if
168 1. a width was not specified,
169 2. 'equalalways' is set,
170 3. 'eadirection' isn't "ver", and
Bram Moolenaarc1a11ed2008-06-24 22:09:24 +0000171 4. one of the other windows is wider than the current or new
Bram Moolenaar67f71312007-08-12 14:55:56 +0000172 window.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000173 Note: In other places CTRL-Q does the same as CTRL-V, but here
174 it doesn't!
175
176CTRL-W n *CTRL-W_n*
177CTRL-W CTRL_N *CTRL-W_CTRL-N*
178:[N]new [++opt] [+cmd] *:new*
179 Create a new window and start editing an empty file in it.
180 Make new window N high (default is to use half the existing
181 height). Reduces the current window height to create room (and
182 others, if the 'equalalways' option is set and 'eadirection'
183 isn't "hor").
184 Also see |++opt| and |+cmd|.
185 If 'fileformats' is not empty, the first format given will be
186 used for the new buffer. If 'fileformats' is empty, the
187 'fileformat' of the current buffer is used. This can be
188 overridden with the |++opt| argument.
189 Autocommands are executed in this order:
190 1. WinLeave for the current window
191 2. WinEnter for the new window
192 3. BufLeave for the current buffer
193 4. BufEnter for the new buffer
Bram Moolenaar53bfca22012-04-13 23:04:47 +0200194 This behaves like a ":split" first, and then an ":enew"
195 command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000196
197:[N]vne[w] [++opt] [+cmd] [file] *:vne* *:vnew*
198 Like |:new|, but split vertically. If 'equalalways' is set
199 and 'eadirection' isn't "ver" the windows will be spread out
200 horizontally, unless a width was specified.
201
202:[N]new [++opt] [+cmd] {file}
203:[N]sp[lit] [++opt] [+cmd] {file} *:split_f*
Bram Moolenaar53bfca22012-04-13 23:04:47 +0200204 Create a new window and start editing file {file} in it. This
205 behaves like a ":split" first, and then an ":e" command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000206 If [+cmd] is given, execute the command when the file has been
207 loaded |+cmd|.
208 Also see |++opt|.
209 Make new window N high (default is to use half the existing
210 height). Reduces the current window height to create room
211 (and others, if the 'equalalways' option is set).
212
213:[N]sv[iew] [++opt] [+cmd] {file} *:sv* *:sview* *splitview*
214 Same as ":split", but set 'readonly' option for this buffer.
215
216:[N]sf[ind] [++opt] [+cmd] {file} *:sf* *:sfind* *splitfind*
Bram Moolenaarc236c162008-07-13 17:41:49 +0000217 Same as ":split", but search for {file} in 'path' like in
218 |:find|. Doesn't split if {file} is not found.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000219
220CTRL-W CTRL-^ *CTRL-W_CTRL-^* *CTRL-W_^*
221CTRL-W ^ Does ":split #", split window in two and edit alternate file.
222 When a count is given, it becomes ":split #N", split window
223 and edit buffer N.
224
Bram Moolenaarb6e0ec62017-07-23 22:12:20 +0200225 *CTRL-W_:*
226CTRL-W : Does the same as typing |:| : edit a command line. Useful in a
227 terminal window, where all Vim commands must be preceded with
228 CTRL-W or 'termkey'.
229
Bram Moolenaar071d4272004-06-13 20:20:40 +0000230Note that the 'splitbelow' and 'splitright' options influence where a new
231window will appear.
232
233 *:vert* *:vertical*
234:vert[ical] {cmd}
235 Execute {cmd}. If it contains a command that splits a window,
236 it will be split vertically.
Bram Moolenaar756ec0f2007-05-05 17:59:48 +0000237 Doesn't work for |:execute| and |:normal|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000238
239:lefta[bove] {cmd} *:lefta* *:leftabove*
240:abo[veleft] {cmd} *:abo* *:aboveleft*
241 Execute {cmd}. If it contains a command that splits a window,
242 it will be opened left (vertical split) or above (horizontal
243 split) the current window. Overrules 'splitbelow' and
244 'splitright'.
Bram Moolenaar756ec0f2007-05-05 17:59:48 +0000245 Doesn't work for |:execute| and |:normal|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000246
247:rightb[elow] {cmd} *:rightb* *:rightbelow*
248:bel[owright] {cmd} *:bel* *:belowright*
249 Execute {cmd}. If it contains a command that splits a window,
250 it will be opened right (vertical split) or below (horizontal
251 split) the current window. Overrules 'splitbelow' and
252 'splitright'.
Bram Moolenaar756ec0f2007-05-05 17:59:48 +0000253 Doesn't work for |:execute| and |:normal|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000254
255 *:topleft* *E442*
256:to[pleft] {cmd}
257 Execute {cmd}. If it contains a command that splits a window,
258 it will appear at the top and occupy the full width of the Vim
259 window. When the split is vertical the window appears at the
260 far left and occupies the full height of the Vim window.
Bram Moolenaar756ec0f2007-05-05 17:59:48 +0000261 Doesn't work for |:execute| and |:normal|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000262
Bram Moolenaarbc8801c2016-08-02 21:04:33 +0200263 *:bo* *:botright*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000264:bo[tright] {cmd}
265 Execute {cmd}. If it contains a command that splits a window,
266 it will appear at the bottom and occupy the full width of the
267 Vim window. When the split is vertical the window appears at
268 the far right and occupies the full height of the Vim window.
Bram Moolenaar756ec0f2007-05-05 17:59:48 +0000269 Doesn't work for |:execute| and |:normal|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000270
271These command modifiers can be combined to make a vertically split window
272occupy the full height. Example: >
Bram Moolenaar5302d9e2011-09-14 17:55:08 +0200273 :vertical topleft split tags
Bram Moolenaar071d4272004-06-13 20:20:40 +0000274Opens a vertically split, full-height window on the "tags" file at the far
275left of the Vim window.
276
277
278Closing a window
279----------------
280
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100281:q[uit]
282:{count}q[uit]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000283CTRL-W q *CTRL-W_q*
284CTRL-W CTRL-Q *CTRL-W_CTRL-Q*
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100285 Without {count}: Quit the current window. If {count} is
286 given quit the {count} window.
287
288 When quitting the last window (not counting a help window),
289 exit Vim.
290
Bram Moolenaar071d4272004-06-13 20:20:40 +0000291 When 'hidden' is set, and there is only one window for the
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100292 current buffer, it becomes hidden. When 'hidden' is not set,
293 and there is only one window for the current buffer, and the
294 buffer was changed, the command fails.
295
Bram Moolenaared32d942014-12-06 23:33:00 +0100296 (Note: CTRL-Q does not work on all terminals).
297
298 If [count] is greater than the last window number the last
299 window will be closed: >
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100300 :1quit " quit the first window
301 :$quit " quit the last window
302 :9quit " quit the last window
Bram Moolenaar46fceaa2016-10-23 21:21:08 +0200303 " if there are fewer than 9 windows opened
304 :-quit " quit the previous window
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100305 :+quit " quit the next window
Bram Moolenaared32d942014-12-06 23:33:00 +0100306 :+2quit " quit the second next window
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100307<
308:q[uit]!
309:{count}q[uit]!
310 Without {count}: Quit the current window. If {count} is
311 given quit the {count} window.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000312
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100313 If this was the last window for a buffer, any changes to that
314 buffer are lost. When quitting the last window (not counting
315 help windows), exit Vim. The contents of the buffer are lost,
316 even when 'hidden' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000317
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100318:clo[se][!]
319:{count}clo[se][!]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000320CTRL-W c *CTRL-W_c* *:clo* *:close*
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100321 Without {count}: Close the current window. If {count} is
322 given close the {count} window.
323
324 When the 'hidden' option is set, or when the buffer was
325 changed and the [!] is used, the buffer becomes hidden (unless
326 there is another window editing it).
327
Bram Moolenaar7e8fd632006-02-18 22:14:51 +0000328 When there is only one window in the current tab page and
329 there is another tab page, this closes the current tab page.
330 |tab-page|.
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100331
Bram Moolenaar071d4272004-06-13 20:20:40 +0000332 This command fails when: *E444*
333 - There is only one window on the screen.
334 - When 'hidden' is not set, [!] is not used, the buffer has
335 changes, and there is no other window on this buffer.
336 Changes to the buffer are not written and won't get lost, so
337 this is a "safe" command.
338
339CTRL-W CTRL-C *CTRL-W_CTRL-C*
340 You might have expected that CTRL-W CTRL-C closes the current
341 window, but that does not work, because the CTRL-C cancels the
342 command.
343
344 *:hide*
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100345:hid[e]
346:{count}hid[e]
347 Quit the current window, unless it is the last window on the
348 screen. For {count} see |:quit| command.
349
350 The buffer becomes hidden (unless there is another window
Bram Moolenaared32d942014-12-06 23:33:00 +0100351 editing it or 'bufhidden' is "unload", "delete" or "wipe").
352 If the window is the last one in the current tab page the tab
353 page is closed. |tab-page|
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100354
355 The value of 'hidden' is irrelevant for this command. Changes
356 to the buffer are not written and won't get lost, so this is a
357 "safe" command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000358
359:hid[e] {cmd} Execute {cmd} with 'hidden' is set. The previous value of
360 'hidden' is restored after {cmd} has been executed.
361 Example: >
362 :hide edit Makefile
363< This will edit "Makefile", and hide the current buffer if it
364 has any changes.
365
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100366:on[ly][!]
367:{count}on[ly][!]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000368CTRL-W o *CTRL-W_o* *E445*
369CTRL-W CTRL-O *CTRL-W_CTRL-O* *:on* *:only*
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100370 Make the current window the only one on the screen. All other
371 windows are closed. For {count} see |:quit| command.
372
Bram Moolenaar071d4272004-06-13 20:20:40 +0000373 When the 'hidden' option is set, all buffers in closed windows
374 become hidden.
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100375
Bram Moolenaar071d4272004-06-13 20:20:40 +0000376 When 'hidden' is not set, and the 'autowrite' option is set,
377 modified buffers are written. Otherwise, windows that have
378 buffers that are modified are not removed, unless the [!] is
379 given, then they become hidden. But modified buffers are
380 never abandoned, so changes cannot get lost.
381
382==============================================================================
3834. Moving cursor to other windows *window-move-cursor*
384
385CTRL-W <Down> *CTRL-W_<Down>*
386CTRL-W CTRL-J *CTRL-W_CTRL-J* *CTRL-W_j*
387CTRL-W j Move cursor to Nth window below current one. Uses the cursor
388 position to select between alternatives.
389
390CTRL-W <Up> *CTRL-W_<Up>*
391CTRL-W CTRL-K *CTRL-W_CTRL-K* *CTRL-W_k*
392CTRL-W k Move cursor to Nth window above current one. Uses the cursor
393 position to select between alternatives.
394
395CTRL-W <Left> *CTRL-W_<Left>*
396CTRL-W CTRL-H *CTRL-W_CTRL-H*
397CTRL-W <BS> *CTRL-W_<BS>* *CTRL-W_h*
398CTRL-W h Move cursor to Nth window left of current one. Uses the
399 cursor position to select between alternatives.
400
401CTRL-W <Right> *CTRL-W_<Right>*
402CTRL-W CTRL-L *CTRL-W_CTRL-L* *CTRL-W_l*
403CTRL-W l Move cursor to Nth window right of current one. Uses the
404 cursor position to select between alternatives.
405
406CTRL-W w *CTRL-W_w* *CTRL-W_CTRL-W*
407CTRL-W CTRL-W Without count: move cursor to window below/right of the
408 current one. If there is no window below or right, go to
409 top-left window.
410 With count: go to Nth window (windows are numbered from
411 top-left to bottom-right). To obtain the window number see
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100412 |bufwinnr()| and |winnr()|. When N is larger than the number
413 of windows go to the last window.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000414
415 *CTRL-W_W*
416CTRL-W W Without count: move cursor to window above/left of current
417 one. If there is no window above or left, go to bottom-right
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100418 window. With count: go to Nth window, like with CTRL-W w.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000419
420CTRL-W t *CTRL-W_t* *CTRL-W_CTRL-T*
421CTRL-W CTRL-T Move cursor to top-left window.
422
423CTRL-W b *CTRL-W_b* *CTRL-W_CTRL-B*
424CTRL-W CTRL-B Move cursor to bottom-right window.
425
426CTRL-W p *CTRL-W_p* *CTRL-W_CTRL-P*
427CTRL-W CTRL-P Go to previous (last accessed) window.
428
429 *CTRL-W_P* *E441*
430CTRL-W P Go to preview window. When there is no preview window this is
431 an error.
432 {not available when compiled without the |+quickfix| feature}
433
434If Visual mode is active and the new window is not for the same buffer, the
435Visual mode is ended. If the window is on the same buffer, the cursor
436position is set to keep the same Visual area selected.
437
438 *:winc* *:wincmd*
439These commands can also be executed with ":wincmd":
440
441:[count]winc[md] {arg}
442 Like executing CTRL-W [count] {arg}. Example: >
443 :wincmd j
444< Moves to the window below the current one.
445 This command is useful when a Normal mode cannot be used (for
446 the |CursorHold| autocommand event). Or when a Normal mode
447 command is inconvenient.
448 The count can also be a window number. Example: >
449 :exe nr . "wincmd w"
450< This goes to window "nr".
451
452==============================================================================
4535. Moving windows around *window-moving*
454
455CTRL-W r *CTRL-W_r* *CTRL-W_CTRL-R* *E443*
456CTRL-W CTRL-R Rotate windows downwards/rightwards. The first window becomes
457 the second one, the second one becomes the third one, etc.
458 The last window becomes the first window. The cursor remains
459 in the same window.
460 This only works within the row or column of windows that the
461 current window is in.
462
463 *CTRL-W_R*
464CTRL-W R Rotate windows upwards/leftwards. The second window becomes
465 the first one, the third one becomes the second one, etc. The
466 first window becomes the last window. The cursor remains in
467 the same window.
468 This only works within the row or column of windows that the
469 current window is in.
470
471CTRL-W x *CTRL-W_x* *CTRL-W_CTRL-X*
472CTRL-W CTRL-X Without count: Exchange current window with next one. If there
473 is no next window, exchange with previous window.
474 With count: Exchange current window with Nth window (first
475 window is 1). The cursor is put in the other window.
476 When vertical and horizontal window splits are mixed, the
477 exchange is only done in the row or column of windows that the
478 current window is in.
479
480The following commands can be used to change the window layout. For example,
481when there are two vertically split windows, CTRL-W K will change that in
482horizontally split windows. CTRL-W H does it the other way around.
483
484 *CTRL-W_K*
485CTRL-W K Move the current window to be at the very top, using the full
486 width of the screen. This works like closing the current
487 window and then creating another one with ":topleft split",
488 except that the current window contents is used for the new
489 window.
490
491 *CTRL-W_J*
492CTRL-W J Move the current window to be at the very bottom, using the
493 full width of the screen. This works like closing the current
494 window and then creating another one with ":botright split",
495 except that the current window contents is used for the new
496 window.
497
498 *CTRL-W_H*
499CTRL-W H Move the current window to be at the far left, using the
500 full height of the screen. This works like closing the
501 current window and then creating another one with
502 ":vert topleft split", except that the current window contents
503 is used for the new window.
Bram Moolenaardb84e452010-08-15 13:50:43 +0200504 {not available when compiled without the |+vertsplit| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000505
506 *CTRL-W_L*
507CTRL-W L Move the current window to be at the far right, using the full
508 height of the screen. This works like closing the
509 current window and then creating another one with
510 ":vert botright split", except that the current window
511 contents is used for the new window.
Bram Moolenaardb84e452010-08-15 13:50:43 +0200512 {not available when compiled without the |+vertsplit| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000513
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000514 *CTRL-W_T*
515CTRL-W T Move the current window to a new tab page. This fails if
516 there is only one window in the current tab page.
517 When a count is specified the new tab page will be opened
518 before the tab page with this index. Otherwise it comes after
519 the current tab page.
520
Bram Moolenaar071d4272004-06-13 20:20:40 +0000521==============================================================================
5226. Window resizing *window-resize*
523
524 *CTRL-W_=*
525CTRL-W = Make all windows (almost) equally high and wide, but use
526 'winheight' and 'winwidth' for the current window.
Bram Moolenaar756ec0f2007-05-05 17:59:48 +0000527 Windows with 'winfixheight' set keep their height and windows
528 with 'winfixwidth' set keep their width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000529
530:res[ize] -N *:res* *:resize* *CTRL-W_-*
531CTRL-W - Decrease current window height by N (default 1).
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200532 If used after |:vertical|: decrease width by N.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000533
534:res[ize] +N *CTRL-W_+*
535CTRL-W + Increase current window height by N (default 1).
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200536 If used after |:vertical|: increase width by N.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000537
538:res[ize] [N]
539CTRL-W CTRL-_ *CTRL-W_CTRL-_* *CTRL-W__*
540CTRL-W _ Set current window height to N (default: highest possible).
541
542z{nr}<CR> Set current window height to {nr}.
543
544 *CTRL-W_<*
545CTRL-W < Decrease current window width by N (default 1).
546
547 *CTRL-W_>*
548CTRL-W > Increase current window width by N (default 1).
549
550:vertical res[ize] [N] *:vertical-resize* *CTRL-W_bar*
551CTRL-W | Set current window width to N (default: widest possible).
552
553You can also resize a window by dragging a status line up or down with the
554mouse. Or by dragging a vertical separator line left or right. This only
555works if the version of Vim that is being used supports the mouse and the
556'mouse' option has been set to enable it.
557
558The option 'winheight' ('wh') is used to set the minimal window height of the
559current window. This option is used each time another window becomes the
560current window. If the option is '0', it is disabled. Set 'winheight' to a
561very large value, e.g., '9999', to make the current window always fill all
562available space. Set it to a reasonable value, e.g., '10', to make editing in
563the current window comfortable.
564
565The equivalent 'winwidth' ('wiw') option is used to set the minimal width of
566the current window.
567
568When the option 'equalalways' ('ea') is set, all the windows are automatically
569made the same size after splitting or closing a window. If you don't set this
570option, splitting a window will reduce the size of the current window and
571leave the other windows the same. When closing a window, the extra lines are
572given to the window above it.
573
574The 'eadirection' option limits the direction in which the 'equalalways'
575option is applied. The default "both" resizes in both directions. When the
576value is "ver" only the heights of windows are equalized. Use this when you
577have manually resized a vertically split window and want to keep this width.
578Likewise, "hor" causes only the widths of windows to be equalized.
579
580The option 'cmdheight' ('ch') is used to set the height of the command-line.
581If you are annoyed by the |hit-enter| prompt for long messages, set this
582option to 2 or 3.
583
584If there is only one window, resizing that window will also change the command
585line height. If there are several windows, resizing the current window will
586also change the height of the window below it (and sometimes the window above
587it).
588
589The minimal height and width of a window is set with 'winminheight' and
590'winminwidth'. These are hard values, a window will never become smaller.
591
592==============================================================================
5937. Argument and buffer list commands *buffer-list*
594
595 args list buffer list meaning ~
5961. :[N]argument [N] 11. :[N]buffer [N] to arg/buf N
5972. :[N]next [file ..] 12. :[N]bnext [N] to Nth next arg/buf
5983. :[N]Next [N] 13. :[N]bNext [N] to Nth previous arg/buf
5994. :[N]previous [N] 14. :[N]bprevious [N] to Nth previous arg/buf
6005. :rewind / :first 15. :brewind / :bfirst to first arg/buf
6016. :last 16. :blast to last arg/buf
6027. :all 17. :ball edit all args/buffers
603 18. :unhide edit all loaded buffers
604 19. :[N]bmod [N] to Nth modified buf
605
606 split & args list split & buffer list meaning ~
60721. :[N]sargument [N] 31. :[N]sbuffer [N] split + to arg/buf N
60822. :[N]snext [file ..] 32. :[N]sbnext [N] split + to Nth next arg/buf
60923. :[N]sNext [N] 33. :[N]sbNext [N] split + to Nth previous arg/buf
61024. :[N]sprevious [N] 34. :[N]sbprevious [N] split + to Nth previous arg/buf
61125. :srewind / :sfirst 35. :sbrewind / :sbfirst split + to first arg/buf
61226. :slast 36. :sblast split + to last arg/buf
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +000061327. :sall 37. :sball edit all args/buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +0000614 38. :sunhide edit all loaded buffers
615 39. :[N]sbmod [N] split + to Nth modified buf
616
61740. :args list of arguments
61841. :buffers list of buffers
619
620The meaning of [N] depends on the command:
621 [N] is number of buffers to go forward/backward on ?2, ?3, and ?4
622 [N] is an argument number, defaulting to current argument, for 1 and 21
623 [N] is a buffer number, defaulting to current buffer, for 11 and 31
624 [N] is a count for 19 and 39
625
626Note: ":next" is an exception, because it must accept a list of file names
627for compatibility with Vi.
628
629
630The argument list and multiple windows
631--------------------------------------
632
633The current position in the argument list can be different for each window.
634Remember that when doing ":e file", the position in the argument list stays
635the same, but you are not editing the file at that position. To indicate
636this, the file message (and the title, if you have one) shows
637"(file (N) of M)", where "(N)" is the current position in the file list, and
638"M" the number of files in the file list.
639
640All the entries in the argument list are added to the buffer list. Thus, you
641can also get to them with the buffer list commands, like ":bnext".
642
643:[N]al[l][!] [N] *:al* *:all* *:sal* *:sall*
644:[N]sal[l][!] [N]
645 Rearrange the screen to open one window for each argument.
646 All other windows are closed. When a count is given, this is
647 the maximum number of windows to open.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +0000648 With the |:tab| modifier open a tab page for each argument.
649 When there are more arguments than 'tabpagemax' further ones
650 become split windows in the last tab page.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000651 When the 'hidden' option is set, all buffers in closed windows
652 become hidden.
653 When 'hidden' is not set, and the 'autowrite' option is set,
654 modified buffers are written. Otherwise, windows that have
655 buffers that are modified are not removed, unless the [!] is
656 given, then they become hidden. But modified buffers are
657 never abandoned, so changes cannot get lost.
658 [N] is the maximum number of windows to open. 'winheight'
659 also limits the number of windows opened ('winwidth' if
660 |:vertical| was prepended).
661 Buf/Win Enter/Leave autocommands are not executed for the new
662 windows here, that's only done when they are really entered.
663
664:[N]sa[rgument][!] [++opt] [+cmd] [N] *:sa* *:sargument*
665 Short for ":split | argument [N]": split window and go to Nth
666 argument. But when there is no such argument, the window is
667 not split. Also see |++opt| and |+cmd|.
668
669:[N]sn[ext][!] [++opt] [+cmd] [file ..] *:sn* *:snext*
670 Short for ":split | [N]next": split window and go to Nth next
671 argument. But when there is no next file, the window is not
672 split. Also see |++opt| and |+cmd|.
673
674:[N]spr[evious][!] [++opt] [+cmd] [N] *:spr* *:sprevious*
675:[N]sN[ext][!] [++opt] [+cmd] [N] *:sN* *:sNext*
676 Short for ":split | [N]Next": split window and go to Nth
677 previous argument. But when there is no previous file, the
678 window is not split. Also see |++opt| and |+cmd|.
679
680 *:sre* *:srewind*
681:sre[wind][!] [++opt] [+cmd]
682 Short for ":split | rewind": split window and go to first
683 argument. But when there is no argument list, the window is
684 not split. Also see |++opt| and |+cmd|.
685
686 *:sfir* *:sfirst*
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000687:sfir[st] [++opt] [+cmd]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000688 Same as ":srewind".
689
690 *:sla* *:slast*
691:sla[st][!] [++opt] [+cmd]
692 Short for ":split | last": split window and go to last
693 argument. But when there is no argument list, the window is
694 not split. Also see |++opt| and |+cmd|.
695
696 *:dr* *:drop*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000697:dr[op] [++opt] [+cmd] {file} ..
Bram Moolenaar071d4272004-06-13 20:20:40 +0000698 Edit the first {file} in a window.
699 - If the file is already open in a window change to that
700 window.
701 - If the file is not open in a window edit the file in the
702 current window. If the current buffer can't be |abandon|ed,
703 the window is split first.
Bram Moolenaar51628222016-12-01 23:03:28 +0100704 - Windows that are not in the argument list or are not full
705 width will be closed if possible.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000706 The |argument-list| is set, like with the |:next| command.
707 The purpose of this command is that it can be used from a
708 program that wants Vim to edit another file, e.g., a debugger.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000709 When using the |:tab| modifier each argument is opened in a
710 tab page. The last window is used if it's empty.
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000711 Also see |++opt| and |+cmd|.
Bram Moolenaardb84e452010-08-15 13:50:43 +0200712 {only available when compiled with a GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000713
714==============================================================================
7158. Do a command in all buffers or windows *list-repeat*
716
717 *:windo*
Bram Moolenaara162bc52015-01-07 16:54:21 +0100718:[range]windo {cmd} Execute {cmd} in each window or if [range] is given
719 only in windows for which the window number lies in
720 the [range]. It works like doing this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000721 CTRL-W t
722 :{cmd}
723 CTRL-W w
724 :{cmd}
725 etc.
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000726< This only operates in the current tab page.
Bram Moolenaar7e8fd632006-02-18 22:14:51 +0000727 When an error is detected on one window, further
Bram Moolenaar071d4272004-06-13 20:20:40 +0000728 windows will not be visited.
729 The last window (or where an error occurred) becomes
730 the current window.
731 {cmd} can contain '|' to concatenate several commands.
732 {cmd} must not open or close windows or reorder them.
733 {not in Vi} {not available when compiled without the
734 |+listcmds| feature}
Bram Moolenaaraa23b372015-09-08 18:46:31 +0200735 Also see |:tabdo|, |:argdo|, |:bufdo|, |:cdo|, |:ldo|,
736 |:cfdo| and |:lfdo|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000737
738 *:bufdo*
Bram Moolenaara162bc52015-01-07 16:54:21 +0100739:[range]bufdo[!] {cmd} Execute {cmd} in each buffer in the buffer list or if
740 [range] is given only for buffers for which their
Bram Moolenaar681baaf2016-02-04 20:57:07 +0100741 buffer number is in the [range]. It works like doing
Bram Moolenaara162bc52015-01-07 16:54:21 +0100742 this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000743 :bfirst
744 :{cmd}
745 :bnext
746 :{cmd}
747 etc.
748< When the current file can't be |abandon|ed and the [!]
749 is not present, the command fails.
750 When an error is detected on one buffer, further
751 buffers will not be visited.
752 Unlisted buffers are skipped.
753 The last buffer (or where an error occurred) becomes
754 the current buffer.
755 {cmd} can contain '|' to concatenate several commands.
756 {cmd} must not delete buffers or add buffers to the
757 buffer list.
758 Note: While this command is executing, the Syntax
759 autocommand event is disabled by adding it to
760 'eventignore'. This considerably speeds up editing
761 each buffer.
762 {not in Vi} {not available when compiled without the
763 |+listcmds| feature}
Bram Moolenaaraa23b372015-09-08 18:46:31 +0200764 Also see |:tabdo|, |:argdo|, |:windo|, |:cdo|, |:ldo|,
765 |:cfdo| and |:lfdo|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000766
767Examples: >
768
769 :windo set nolist nofoldcolumn | normal zn
770
771This resets the 'list' option and disables folding in all windows. >
772
773 :bufdo set fileencoding= | update
774
775This resets the 'fileencoding' in each buffer and writes it if this changed
776the buffer. The result is that all buffers will use the 'encoding' encoding
777(if conversion works properly).
778
779==============================================================================
7809. Tag or file name under the cursor *window-tag*
781
782 *:sta* *:stag*
783:sta[g][!] [tagname]
784 Does ":tag[!] [tagname]" and splits the window for the found
785 tag. See also |:tag|.
786
787CTRL-W ] *CTRL-W_]* *CTRL-W_CTRL-]*
788CTRL-W CTRL-] Split current window in two. Use identifier under cursor as a
Bram Moolenaar3a991dd2014-10-02 01:41:41 +0200789 tag and jump to it in the new upper window.
790 In Visual mode uses the Visually selected text as a tag.
791 Make new window N high.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000792
793 *CTRL-W_g]*
794CTRL-W g ] Split current window in two. Use identifier under cursor as a
795 tag and perform ":tselect" on it in the new upper window.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +0200796 In Visual mode uses the Visually selected text as a tag.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000797 Make new window N high.
798
799 *CTRL-W_g_CTRL-]*
800CTRL-W g CTRL-] Split current window in two. Use identifier under cursor as a
Bram Moolenaar3a991dd2014-10-02 01:41:41 +0200801 tag and perform ":tjump" on it in the new upper window.
802 In Visual mode uses the Visually selected text as a tag.
803 Make new window N high.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000804
805CTRL-W f *CTRL-W_f* *CTRL-W_CTRL-F*
806CTRL-W CTRL-F Split current window in two. Edit file name under cursor.
Bram Moolenaar8dff8182006-04-06 20:18:50 +0000807 Like ":split gf", but window isn't split if the file does not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000808 exist.
809 Uses the 'path' variable as a list of directory names where to
810 look for the file. Also the path for current file is
811 used to search for the file name.
812 If the name is a hypertext link that looks like
813 "type://machine/path", only "/path" is used.
814 If a count is given, the count'th matching file is edited.
815 {not available when the |+file_in_path| feature was disabled
816 at compile time}
817
Bram Moolenaard1f56e62006-02-22 21:25:37 +0000818CTRL-W F *CTRL-W_F*
819 Split current window in two. Edit file name under cursor and
820 jump to the line number following the file name. See |gF| for
821 details on how the line number is obtained.
Bram Moolenaar57657d82006-04-21 22:12:41 +0000822 {not available when the |+file_in_path| feature was disabled
823 at compile time}
Bram Moolenaard1f56e62006-02-22 21:25:37 +0000824
Bram Moolenaar8dff8182006-04-06 20:18:50 +0000825CTRL-W gf *CTRL-W_gf*
826 Open a new tab page and edit the file name under the cursor.
827 Like "tab split" and "gf", but the new tab page isn't created
828 if the file does not exist.
829 {not available when the |+file_in_path| feature was disabled
830 at compile time}
831
Bram Moolenaar57657d82006-04-21 22:12:41 +0000832CTRL-W gF *CTRL-W_gF*
833 Open a new tab page and edit the file name under the cursor
834 and jump to the line number following the file name. Like
835 "tab split" and "gF", but the new tab page isn't created if
836 the file does not exist.
837 {not available when the |+file_in_path| feature was disabled
838 at compile time}
839
Bram Moolenaar071d4272004-06-13 20:20:40 +0000840Also see |CTRL-W_CTRL-I|: open window for an included file that includes
841the keyword under the cursor.
842
843==============================================================================
84410. The preview window *preview-window*
845
846The preview window is a special window to show (preview) another file. It is
847normally a small window used to show an include file or definition of a
848function.
849{not available when compiled without the |+quickfix| feature}
850
Bram Moolenaarc270d802006-03-11 21:29:41 +0000851There can be only one preview window (per tab page). It is created with one
852of the commands below. The 'previewheight' option can be set to specify the
853height of the preview window when it's opened. The 'previewwindow' option is
854set in the preview window to be able to recognize it. The 'winfixheight'
855option is set to have it keep the same height when opening/closing other
856windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000857
858 *:pta* *:ptag*
859:pta[g][!] [tagname]
860 Does ":tag[!] [tagname]" and shows the found tag in a
861 "Preview" window without changing the current buffer or cursor
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000862 position. If a "Preview" window already exists, it is re-used
Bram Moolenaar071d4272004-06-13 20:20:40 +0000863 (like a help window is). If a new one is opened,
864 'previewheight' is used for the height of the window. See
865 also |:tag|.
866 See below for an example. |CursorHold-example|
867 Small difference from |:tag|: When [tagname] is equal to the
868 already displayed tag, the position in the matching tag list
869 is not reset. This makes the CursorHold example work after a
870 |:ptnext|.
871
872CTRL-W z *CTRL-W_z*
873CTRL-W CTRL-Z *CTRL-W_CTRL-Z* *:pc* *:pclose*
874:pc[lose][!] Close any "Preview" window currently open. When the 'hidden'
875 option is set, or when the buffer was changed and the [!] is
876 used, the buffer becomes hidden (unless there is another
877 window editing it). The command fails if any "Preview" buffer
878 cannot be closed. See also |:close|.
879
880 *:pp* *:ppop*
881:[count]pp[op][!]
882 Does ":[count]pop[!]" in the preview window. See |:pop| and
883 |:ptag|. {not in Vi}
884
885CTRL-W } *CTRL-W_}*
886 Use identifier under cursor as a tag and perform a :ptag on
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000887 it. Make the new Preview window (if required) N high. If N is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000888 not given, 'previewheight' is used.
889
890CTRL-W g } *CTRL-W_g}*
891 Use identifier under cursor as a tag and perform a :ptjump on
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000892 it. Make the new Preview window (if required) N high. If N is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000893 not given, 'previewheight' is used.
894
895 *:ped* *:pedit*
896:ped[it][!] [++opt] [+cmd] {file}
897 Edit {file} in the preview window. The preview window is
898 opened like with |:ptag|. The current window and cursor
899 position isn't changed. Useful example: >
900 :pedit +/fputc /usr/include/stdio.h
901<
902 *:ps* *:psearch*
903:[range]ps[earch][!] [count] [/]pattern[/]
904 Works like |:ijump| but shows the found match in the preview
905 window. The preview window is opened like with |:ptag|. The
906 current window and cursor position isn't changed. Useful
907 example: >
908 :psearch popen
909< Like with the |:ptag| command, you can use this to
910 automatically show information about the word under the
911 cursor. This is less clever than using |:ptag|, but you don't
912 need a tags file and it will also find matches in system
913 include files. Example: >
914 :au! CursorHold *.[ch] nested exe "silent! psearch " . expand("<cword>")
915< Warning: This can be slow.
916
917Example *CursorHold-example* >
918
919 :au! CursorHold *.[ch] nested exe "silent! ptag " . expand("<cword>")
920
921This will cause a ":ptag" to be executed for the keyword under the cursor,
922when the cursor hasn't moved for the time set with 'updatetime'. The "nested"
923makes other autocommands be executed, so that syntax highlighting works in the
924preview window. The "silent!" avoids an error message when the tag could not
925be found. Also see |CursorHold|. To disable this again: >
926
927 :au! CursorHold
928
929A nice addition is to highlight the found tag, avoid the ":ptag" when there
930is no word under the cursor, and a few other things: >
931
932 :au! CursorHold *.[ch] nested call PreviewWord()
933 :func PreviewWord()
934 : if &previewwindow " don't do this in the preview window
935 : return
936 : endif
937 : let w = expand("<cword>") " get the word under cursor
938 : if w =~ '\a' " if the word contains a letter
939 :
940 : " Delete any existing highlight before showing another tag
941 : silent! wincmd P " jump to preview window
942 : if &previewwindow " if we really get there...
943 : match none " delete existing highlight
944 : wincmd p " back to old window
945 : endif
946 :
947 : " Try displaying a matching tag for the word under the cursor
948 : try
949 : exe "ptag " . w
950 : catch
951 : return
952 : endtry
953 :
954 : silent! wincmd P " jump to preview window
955 : if &previewwindow " if we really get there...
956 : if has("folding")
957 : silent! .foldopen " don't want a closed fold
958 : endif
959 : call search("$", "b") " to end of previous line
960 : let w = substitute(w, '\\', '\\\\', "")
961 : call search('\<\V' . w . '\>') " position cursor on match
962 : " Add a match highlight to the word at this position
963 : hi previewWord term=bold ctermbg=green guibg=green
964 : exe 'match previewWord "\%' . line(".") . 'l\%' . col(".") . 'c\k*"'
965 : wincmd p " back to old window
966 : endif
967 : endif
968 :endfun
969
970==============================================================================
97111. Using hidden buffers *buffer-hidden*
972
973A hidden buffer is not displayed in a window, but is still loaded into memory.
974This makes it possible to jump from file to file, without the need to read or
975write the file every time you get another buffer in a window.
976{not available when compiled without the |+listcmds| feature}
977
978 *:buffer-!*
979If the option 'hidden' ('hid') is set, abandoned buffers are kept for all
980commands that start editing another file: ":edit", ":next", ":tag", etc. The
981commands that move through the buffer list sometimes make the current buffer
982hidden although the 'hidden' option is not set. This happens when a buffer is
983modified, but is forced (with '!') to be removed from a window, and
984'autowrite' is off or the buffer can't be written.
985
986You can make a hidden buffer not hidden by starting to edit it with any
987command. Or by deleting it with the ":bdelete" command.
988
989The 'hidden' is global, it is used for all buffers. The 'bufhidden' option
990can be used to make an exception for a specific buffer. It can take these
991values:
992 <empty> Use the value of 'hidden'.
993 hide Hide this buffer, also when 'hidden' is not set.
994 unload Don't hide but unload this buffer, also when 'hidden'
995 is set.
996 delete Delete the buffer.
997
998 *hidden-quit*
999When you try to quit Vim while there is a hidden, modified buffer, you will
1000get an error message and Vim will make that buffer the current buffer. You
1001can then decide to write this buffer (":wq") or quit without writing (":q!").
1002Be careful: there may be more hidden, modified buffers!
1003
1004A buffer can also be unlisted. This means it exists, but it is not in the
1005list of buffers. |unlisted-buffer|
1006
1007
Bram Moolenaard51cb702015-07-21 15:03:06 +02001008:files[!] [flags] *:files*
1009:buffers[!] [flags] *:buffers* *:ls*
1010:ls[!] [flags]
1011 Show all buffers. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001012
Bram Moolenaar97d62492012-11-15 21:28:22 +01001013 1 #h "/test/text" line 1 ~
1014 2u "asdf" line 0 ~
1015 3 %a + "version.c" line 1 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +00001016
1017 When the [!] is included the list will show unlisted buffers
1018 (the term "unlisted" is a bit confusing then...).
1019
1020 Each buffer has a unique number. That number will not change,
Bram Moolenaar0122c402015-02-03 19:13:34 +01001021 thus you can always go to a specific buffer with ":buffer N"
1022 or "N CTRL-^", where N is the buffer number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001023
1024 Indicators (chars in the same column are mutually exclusive):
1025 u an unlisted buffer (only displayed when [!] is used)
1026 |unlisted-buffer|
1027 % the buffer in the current window
1028 # the alternate buffer for ":e #" and CTRL-^
1029 a an active buffer: it is loaded and visible
1030 h a hidden buffer: It is loaded, but currently not
1031 displayed in a window |hidden-buffer|
1032 - a buffer with 'modifiable' off
1033 = a readonly buffer
1034 + a modified buffer
1035 x a buffer with read errors
1036
Bram Moolenaard51cb702015-07-21 15:03:06 +02001037 [flags] can be a combination of the following characters,
1038 which restrict the buffers to be listed:
1039 + modified buffers
1040 - buffers with 'modifiable' off
1041 = readonly buffers
1042 a active buffers
Bram Moolenaare392eb42015-11-19 20:38:09 +01001043 u unlisted buffers (overrides the "!")
Bram Moolenaard51cb702015-07-21 15:03:06 +02001044 h hidden buffers
1045 x buffers with a read error
1046 % current buffer
1047 # alternate buffer
1048 Combining flags means they are "and"ed together, e.g.:
1049 h+ hidden buffers which are modified
1050 a+ active buffers which are modified
1051
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02001052 When using |:filter| the pattern is matched against the
1053 displayed buffer name, e.g.: >
1054 filter /\.vim/ ls
1055<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001056 *:bad* *:badd*
1057:bad[d] [+lnum] {fname}
1058 Add file name {fname} to the buffer list, without loading it.
1059 If "lnum" is specified, the cursor will be positioned at that
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001060 line when the buffer is first entered. Note that other
Bram Moolenaar071d4272004-06-13 20:20:40 +00001061 commands after the + will be ignored.
1062
1063:[N]bd[elete][!] *:bd* *:bdel* *:bdelete* *E516*
1064:bd[elete][!] [N]
1065 Unload buffer [N] (default: current buffer) and delete it from
1066 the buffer list. If the buffer was changed, this fails,
1067 unless when [!] is specified, in which case changes are lost.
1068 The file remains unaffected. Any windows for this buffer are
1069 closed. If buffer [N] is the current buffer, another buffer
1070 will be displayed instead. This is the most recent entry in
1071 the jump list that points into a loaded buffer.
1072 Actually, the buffer isn't completely deleted, it is removed
1073 from the buffer list |unlisted-buffer| and option values,
1074 variables and mappings/abbreviations for the buffer are
Bram Moolenaar4d84d932014-11-30 14:50:16 +01001075 cleared. Examples: >
1076 :.,$-bdelete " delete buffers from the current one to
1077 " last but one
1078 :%bdelete " delete all buffers
1079<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001080
1081:bdelete[!] {bufname} *E93* *E94*
1082 Like ":bdelete[!] [N]", but buffer given by name. Note that a
1083 buffer whose name is a number cannot be referenced by that
1084 name; use the buffer number instead. Insert a backslash
1085 before a space in a buffer name.
1086
1087:bdelete[!] N1 N2 ...
1088 Do ":bdelete[!]" for buffer N1, N2, etc. The arguments can be
1089 buffer numbers or buffer names (but not buffer names that are
1090 a number). Insert a backslash before a space in a buffer
1091 name.
1092
1093:N,Mbdelete[!] Do ":bdelete[!]" for all buffers in the range N to M
1094 |inclusive|.
1095
1096:[N]bw[ipeout][!] *:bw* *:bwipe* *:bwipeout* *E517*
1097:bw[ipeout][!] {bufname}
1098:N,Mbw[ipeout][!]
1099:bw[ipeout][!] N1 N2 ...
Bram Moolenaardf1bdc92006-02-23 21:32:16 +00001100 Like |:bdelete|, but really delete the buffer. Everything
1101 related to the buffer is lost. All marks in this buffer
1102 become invalid, option settings are lost, etc. Don't use this
Bram Moolenaar4d84d932014-11-30 14:50:16 +01001103 unless you know what you are doing. Examples: >
1104 :.+,$bwipeout " wipe out all buffers after the current
1105 " one
1106 :%bwipeout " wipe out all buffers
1107<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001108
1109:[N]bun[load][!] *:bun* *:bunload* *E515*
1110:bun[load][!] [N]
1111 Unload buffer [N] (default: current buffer). The memory
1112 allocated for this buffer will be freed. The buffer remains
1113 in the buffer list.
1114 If the buffer was changed, this fails, unless when [!] is
1115 specified, in which case the changes are lost.
1116 Any windows for this buffer are closed. If buffer [N] is the
1117 current buffer, another buffer will be displayed instead.
1118 This is the most recent entry in the jump list that points
1119 into a loaded buffer.
1120
1121:bunload[!] {bufname}
1122 Like ":bunload[!] [N]", but buffer given by name. Note that a
1123 buffer whose name is a number cannot be referenced by that
1124 name; use the buffer number instead. Insert a backslash
1125 before a space in a buffer name.
1126
1127:N,Mbunload[!] Do ":bunload[!]" for all buffers in the range N to M
1128 |inclusive|.
1129
1130:bunload[!] N1 N2 ...
1131 Do ":bunload[!]" for buffer N1, N2, etc. The arguments can be
1132 buffer numbers or buffer names (but not buffer names that are
1133 a number). Insert a backslash before a space in a buffer
1134 name.
1135
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001136:[N]b[uffer][!] [+cmd] [N] *:b* *:bu* *:buf* *:buffer* *E86*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001137 Edit buffer [N] from the buffer list. If [N] is not given,
1138 the current buffer remains being edited. See |:buffer-!| for
1139 [!]. This will also edit a buffer that is not in the buffer
1140 list, without setting the 'buflisted' flag.
Bram Moolenaar12969c02015-09-08 23:36:10 +02001141 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001142
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001143:[N]b[uffer][!] [+cmd] {bufname}
Bram Moolenaarc1a11ed2008-06-24 22:09:24 +00001144 Edit buffer for {bufname} from the buffer list. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00001145 |:buffer-!| for [!]. This will also edit a buffer that is not
1146 in the buffer list, without setting the 'buflisted' flag.
Bram Moolenaar12969c02015-09-08 23:36:10 +02001147 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001148
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001149:[N]sb[uffer] [+cmd] [N] *:sb* *:sbuffer*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001150 Split window and edit buffer [N] from the buffer list. If [N]
1151 is not given, the current buffer is edited. Respects the
1152 "useopen" setting of 'switchbuf' when splitting. This will
1153 also edit a buffer that is not in the buffer list, without
1154 setting the 'buflisted' flag.
Bram Moolenaar12969c02015-09-08 23:36:10 +02001155 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001156
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001157:[N]sb[uffer] [+cmd] {bufname}
Bram Moolenaarc1a11ed2008-06-24 22:09:24 +00001158 Split window and edit buffer for {bufname} from the buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001159 list. This will also edit a buffer that is not in the buffer
1160 list, without setting the 'buflisted' flag.
Bram Moolenaar280f1262006-01-30 00:14:18 +00001161 Note: If what you want to do is split the buffer, make a copy
1162 under another name, you can do it this way: >
1163 :w foobar | sp #
Bram Moolenaar12969c02015-09-08 23:36:10 +02001164< Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001165
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001166:[N]bn[ext][!] [+cmd] [N] *:bn* *:bnext* *E87*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001167 Go to [N]th next buffer in buffer list. [N] defaults to one.
1168 Wraps around the end of the buffer list.
1169 See |:buffer-!| for [!].
Bram Moolenaar12969c02015-09-08 23:36:10 +02001170 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001171 If you are in a help buffer, this takes you to the next help
1172 buffer (if there is one). Similarly, if you are in a normal
1173 (non-help) buffer, this takes you to the next normal buffer.
1174 This is so that if you have invoked help, it doesn't get in
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001175 the way when you're browsing code/text buffers. The next three
Bram Moolenaar071d4272004-06-13 20:20:40 +00001176 commands also work like this.
1177
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001178
Bram Moolenaar071d4272004-06-13 20:20:40 +00001179 *:sbn* *:sbnext*
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001180:[N]sbn[ext] [+cmd] [N]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001181 Split window and go to [N]th next buffer in buffer list.
1182 Wraps around the end of the buffer list. Uses 'switchbuf'
Bram Moolenaar12969c02015-09-08 23:36:10 +02001183 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001184
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001185:[N]bN[ext][!] [+cmd] [N] *:bN* *:bNext* *:bp* *:bprevious* *E88*
1186:[N]bp[revious][!] [+cmd] [N]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001187 Go to [N]th previous buffer in buffer list. [N] defaults to
1188 one. Wraps around the start of the buffer list.
1189 See |:buffer-!| for [!] and 'switchbuf'.
Bram Moolenaar12969c02015-09-08 23:36:10 +02001190 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001191
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001192:[N]sbN[ext] [+cmd] [N] *:sbN* *:sbNext* *:sbp* *:sbprevious*
1193:[N]sbp[revious] [+cmd] [N]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001194 Split window and go to [N]th previous buffer in buffer list.
1195 Wraps around the start of the buffer list.
1196 Uses 'switchbuf'.
Bram Moolenaar12969c02015-09-08 23:36:10 +02001197 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001198
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001199:br[ewind][!] [+cmd] *:br* *:brewind*
1200 Go to first buffer in buffer list. If the buffer list is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001201 empty, go to the first unlisted buffer.
1202 See |:buffer-!| for [!].
1203
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001204:bf[irst] [+cmd] *:bf* *:bfirst*
1205 Same as |:brewind|.
1206 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001207
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001208:sbr[ewind] [+cmd] *:sbr* *:sbrewind*
1209 Split window and go to first buffer in buffer list. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001210 buffer list is empty, go to the first unlisted buffer.
1211 Respects the 'switchbuf' option.
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001212 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001213
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001214:sbf[irst] [+cmd] *:sbf* *:sbfirst*
1215 Same as ":sbrewind".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001216
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001217:bl[ast][!] [+cmd] *:bl* *:blast*
1218 Go to last buffer in buffer list. If the buffer list is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001219 empty, go to the last unlisted buffer.
1220 See |:buffer-!| for [!].
1221
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001222:sbl[ast] [+cmd] *:sbl* *:sblast*
1223 Split window and go to last buffer in buffer list. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001224 buffer list is empty, go to the last unlisted buffer.
1225 Respects 'switchbuf' option.
1226
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001227:[N]bm[odified][!] [+cmd] [N] *:bm* *:bmodified* *E84*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001228 Go to [N]th next modified buffer. Note: this command also
1229 finds unlisted buffers. If there is no modified buffer the
1230 command fails.
1231
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001232:[N]sbm[odified] [+cmd] [N] *:sbm* *:sbmodified*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001233 Split window and go to [N]th next modified buffer.
1234 Respects 'switchbuf' option.
1235 Note: this command also finds buffers not in the buffer list.
1236
1237:[N]unh[ide] [N] *:unh* *:unhide* *:sun* *:sunhide*
1238:[N]sun[hide] [N]
1239 Rearrange the screen to open one window for each loaded buffer
1240 in the buffer list. When a count is given, this is the
1241 maximum number of windows to open.
1242
1243:[N]ba[ll] [N] *:ba* *:ball* *:sba* *:sball*
1244:[N]sba[ll] [N] Rearrange the screen to open one window for each buffer in
1245 the buffer list. When a count is given, this is the maximum
1246 number of windows to open. 'winheight' also limits the number
1247 of windows opened ('winwidth' if |:vertical| was prepended).
1248 Buf/Win Enter/Leave autocommands are not executed for the new
1249 windows here, that's only done when they are really entered.
Bram Moolenaar756ec0f2007-05-05 17:59:48 +00001250 When the |:tab| modifier is used new windows are opened in a
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00001251 new tab, up to 'tabpagemax'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001252
1253Note: All the commands above that start editing another buffer, keep the
1254'readonly' flag as it was. This differs from the ":edit" command, which sets
1255the 'readonly' flag each time the file is read.
1256
1257==============================================================================
125812. Special kinds of buffers *special-buffers*
1259
1260Instead of containing the text of a file, buffers can also be used for other
1261purposes. A few options can be set to change the behavior of a buffer:
1262 'bufhidden' what happens when the buffer is no longer displayed
1263 in a window.
1264 'buftype' what kind of a buffer this is
1265 'swapfile' whether the buffer will have a swap file
1266 'buflisted' buffer shows up in the buffer list
1267
1268A few useful kinds of a buffer:
1269
Bram Moolenaar280f1262006-01-30 00:14:18 +00001270quickfix Used to contain the error list or the location list. See
1271 |:cwindow| and |:lwindow|. This command sets the 'buftype'
1272 option to "quickfix". You are not supposed to change this!
1273 'swapfile' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001274
1275help Contains a help file. Will only be created with the |:help|
1276 command. The flag that indicates a help buffer is internal
1277 and can't be changed. The 'buflisted' option will be reset
1278 for a help buffer.
1279
Bram Moolenaarb6e0ec62017-07-23 22:12:20 +02001280terminal A terminal window buffer, see |terminal|. The contents cannot
1281 be read or changed until the job ends.
1282
Bram Moolenaar677ee682005-01-27 14:41:15 +00001283directory Displays directory contents. Can be used by a file explorer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001284 plugin. The buffer is created with these settings: >
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001285 :setlocal buftype=nowrite
1286 :setlocal bufhidden=delete
1287 :setlocal noswapfile
Bram Moolenaar071d4272004-06-13 20:20:40 +00001288< The buffer name is the name of the directory and is adjusted
1289 when using the |:cd| command.
1290
1291scratch Contains text that can be discarded at any time. It is kept
1292 when closing the window, it must be deleted explicitly.
1293 Settings: >
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001294 :setlocal buftype=nofile
1295 :setlocal bufhidden=hide
1296 :setlocal noswapfile
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001297< The buffer name can be used to identify the buffer, if you
1298 give it a meaningful name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001299
1300 *unlisted-buffer*
1301unlisted The buffer is not in the buffer list. It is not used for
1302 normal editing, but to show a help file, remember a file name
1303 or marks. The ":bdelete" command will also set this option,
1304 thus it doesn't completely delete the buffer. Settings: >
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001305 :setlocal nobuflisted
Bram Moolenaar071d4272004-06-13 20:20:40 +00001306<
1307
1308 vim:tw=78:ts=8:ft=help:norl: