blob: 8e8b0bb3d588c35f132755c863d28de44c1a88f8 [file] [log] [blame]
Bram Moolenaarc572da52017-08-27 16:52:01 +02001*windows.txt* For Vim version 8.0. Last change: 2017 Aug 21
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]
Bram Moolenaarc572da52017-08-27 16:52:01 +0200347 Without {count}: Quit the current window, unless it is the
348 last window on the screen.
349 If {count} is given quit the {count} window.
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100350
351 The buffer becomes hidden (unless there is another window
Bram Moolenaared32d942014-12-06 23:33:00 +0100352 editing it or 'bufhidden' is "unload", "delete" or "wipe").
353 If the window is the last one in the current tab page the tab
354 page is closed. |tab-page|
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100355
356 The value of 'hidden' is irrelevant for this command. Changes
357 to the buffer are not written and won't get lost, so this is a
358 "safe" command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000359
360:hid[e] {cmd} Execute {cmd} with 'hidden' is set. The previous value of
361 'hidden' is restored after {cmd} has been executed.
362 Example: >
363 :hide edit Makefile
364< This will edit "Makefile", and hide the current buffer if it
365 has any changes.
366
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100367:on[ly][!]
368:{count}on[ly][!]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000369CTRL-W o *CTRL-W_o* *E445*
370CTRL-W CTRL-O *CTRL-W_CTRL-O* *:on* *:only*
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100371 Make the current window the only one on the screen. All other
372 windows are closed. For {count} see |:quit| command.
373
Bram Moolenaar071d4272004-06-13 20:20:40 +0000374 When the 'hidden' option is set, all buffers in closed windows
375 become hidden.
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100376
Bram Moolenaar071d4272004-06-13 20:20:40 +0000377 When 'hidden' is not set, and the 'autowrite' option is set,
378 modified buffers are written. Otherwise, windows that have
379 buffers that are modified are not removed, unless the [!] is
380 given, then they become hidden. But modified buffers are
381 never abandoned, so changes cannot get lost.
382
383==============================================================================
3844. Moving cursor to other windows *window-move-cursor*
385
386CTRL-W <Down> *CTRL-W_<Down>*
387CTRL-W CTRL-J *CTRL-W_CTRL-J* *CTRL-W_j*
388CTRL-W j Move cursor to Nth window below current one. Uses the cursor
389 position to select between alternatives.
390
391CTRL-W <Up> *CTRL-W_<Up>*
392CTRL-W CTRL-K *CTRL-W_CTRL-K* *CTRL-W_k*
393CTRL-W k Move cursor to Nth window above current one. Uses the cursor
394 position to select between alternatives.
395
396CTRL-W <Left> *CTRL-W_<Left>*
397CTRL-W CTRL-H *CTRL-W_CTRL-H*
398CTRL-W <BS> *CTRL-W_<BS>* *CTRL-W_h*
399CTRL-W h Move cursor to Nth window left of current one. Uses the
400 cursor position to select between alternatives.
401
402CTRL-W <Right> *CTRL-W_<Right>*
403CTRL-W CTRL-L *CTRL-W_CTRL-L* *CTRL-W_l*
404CTRL-W l Move cursor to Nth window right of current one. Uses the
405 cursor position to select between alternatives.
406
407CTRL-W w *CTRL-W_w* *CTRL-W_CTRL-W*
408CTRL-W CTRL-W Without count: move cursor to window below/right of the
409 current one. If there is no window below or right, go to
410 top-left window.
411 With count: go to Nth window (windows are numbered from
412 top-left to bottom-right). To obtain the window number see
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100413 |bufwinnr()| and |winnr()|. When N is larger than the number
414 of windows go to the last window.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000415
416 *CTRL-W_W*
417CTRL-W W Without count: move cursor to window above/left of current
418 one. If there is no window above or left, go to bottom-right
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100419 window. With count: go to Nth window, like with CTRL-W w.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000420
421CTRL-W t *CTRL-W_t* *CTRL-W_CTRL-T*
422CTRL-W CTRL-T Move cursor to top-left window.
423
424CTRL-W b *CTRL-W_b* *CTRL-W_CTRL-B*
425CTRL-W CTRL-B Move cursor to bottom-right window.
426
427CTRL-W p *CTRL-W_p* *CTRL-W_CTRL-P*
428CTRL-W CTRL-P Go to previous (last accessed) window.
429
430 *CTRL-W_P* *E441*
431CTRL-W P Go to preview window. When there is no preview window this is
432 an error.
433 {not available when compiled without the |+quickfix| feature}
434
435If Visual mode is active and the new window is not for the same buffer, the
436Visual mode is ended. If the window is on the same buffer, the cursor
437position is set to keep the same Visual area selected.
438
439 *:winc* *:wincmd*
440These commands can also be executed with ":wincmd":
441
442:[count]winc[md] {arg}
443 Like executing CTRL-W [count] {arg}. Example: >
444 :wincmd j
445< Moves to the window below the current one.
446 This command is useful when a Normal mode cannot be used (for
447 the |CursorHold| autocommand event). Or when a Normal mode
448 command is inconvenient.
449 The count can also be a window number. Example: >
450 :exe nr . "wincmd w"
451< This goes to window "nr".
452
453==============================================================================
4545. Moving windows around *window-moving*
455
456CTRL-W r *CTRL-W_r* *CTRL-W_CTRL-R* *E443*
457CTRL-W CTRL-R Rotate windows downwards/rightwards. The first window becomes
458 the second one, the second one becomes the third one, etc.
459 The last window becomes the first window. The cursor remains
460 in the same window.
461 This only works within the row or column of windows that the
462 current window is in.
463
464 *CTRL-W_R*
465CTRL-W R Rotate windows upwards/leftwards. The second window becomes
466 the first one, the third one becomes the second one, etc. The
467 first window becomes the last window. The cursor remains in
468 the same window.
469 This only works within the row or column of windows that the
470 current window is in.
471
472CTRL-W x *CTRL-W_x* *CTRL-W_CTRL-X*
473CTRL-W CTRL-X Without count: Exchange current window with next one. If there
474 is no next window, exchange with previous window.
475 With count: Exchange current window with Nth window (first
476 window is 1). The cursor is put in the other window.
477 When vertical and horizontal window splits are mixed, the
478 exchange is only done in the row or column of windows that the
479 current window is in.
480
481The following commands can be used to change the window layout. For example,
482when there are two vertically split windows, CTRL-W K will change that in
483horizontally split windows. CTRL-W H does it the other way around.
484
485 *CTRL-W_K*
486CTRL-W K Move the current window to be at the very top, using the full
487 width of the screen. This works like closing the current
488 window and then creating another one with ":topleft split",
489 except that the current window contents is used for the new
490 window.
491
492 *CTRL-W_J*
493CTRL-W J Move the current window to be at the very bottom, using the
494 full width of the screen. This works like closing the current
495 window and then creating another one with ":botright split",
496 except that the current window contents is used for the new
497 window.
498
499 *CTRL-W_H*
500CTRL-W H Move the current window to be at the far left, using the
501 full height of the screen. This works like closing the
502 current window and then creating another one with
503 ":vert topleft split", except that the current window contents
504 is used for the new window.
Bram Moolenaardb84e452010-08-15 13:50:43 +0200505 {not available when compiled without the |+vertsplit| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000506
507 *CTRL-W_L*
508CTRL-W L Move the current window to be at the far right, using the full
509 height of the screen. This works like closing the
510 current window and then creating another one with
511 ":vert botright split", except that the current window
512 contents is used for the new window.
Bram Moolenaardb84e452010-08-15 13:50:43 +0200513 {not available when compiled without the |+vertsplit| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000514
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000515 *CTRL-W_T*
516CTRL-W T Move the current window to a new tab page. This fails if
517 there is only one window in the current tab page.
518 When a count is specified the new tab page will be opened
519 before the tab page with this index. Otherwise it comes after
520 the current tab page.
521
Bram Moolenaar071d4272004-06-13 20:20:40 +0000522==============================================================================
5236. Window resizing *window-resize*
524
525 *CTRL-W_=*
526CTRL-W = Make all windows (almost) equally high and wide, but use
527 'winheight' and 'winwidth' for the current window.
Bram Moolenaar756ec0f2007-05-05 17:59:48 +0000528 Windows with 'winfixheight' set keep their height and windows
529 with 'winfixwidth' set keep their width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000530
531:res[ize] -N *:res* *:resize* *CTRL-W_-*
532CTRL-W - Decrease current window height by N (default 1).
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200533 If used after |:vertical|: decrease width by N.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000534
535:res[ize] +N *CTRL-W_+*
536CTRL-W + Increase current window height by N (default 1).
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200537 If used after |:vertical|: increase width by N.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000538
539:res[ize] [N]
540CTRL-W CTRL-_ *CTRL-W_CTRL-_* *CTRL-W__*
541CTRL-W _ Set current window height to N (default: highest possible).
542
543z{nr}<CR> Set current window height to {nr}.
544
545 *CTRL-W_<*
546CTRL-W < Decrease current window width by N (default 1).
547
548 *CTRL-W_>*
549CTRL-W > Increase current window width by N (default 1).
550
551:vertical res[ize] [N] *:vertical-resize* *CTRL-W_bar*
552CTRL-W | Set current window width to N (default: widest possible).
553
554You can also resize a window by dragging a status line up or down with the
555mouse. Or by dragging a vertical separator line left or right. This only
556works if the version of Vim that is being used supports the mouse and the
557'mouse' option has been set to enable it.
558
559The option 'winheight' ('wh') is used to set the minimal window height of the
560current window. This option is used each time another window becomes the
561current window. If the option is '0', it is disabled. Set 'winheight' to a
562very large value, e.g., '9999', to make the current window always fill all
563available space. Set it to a reasonable value, e.g., '10', to make editing in
564the current window comfortable.
565
566The equivalent 'winwidth' ('wiw') option is used to set the minimal width of
567the current window.
568
569When the option 'equalalways' ('ea') is set, all the windows are automatically
570made the same size after splitting or closing a window. If you don't set this
571option, splitting a window will reduce the size of the current window and
572leave the other windows the same. When closing a window, the extra lines are
573given to the window above it.
574
575The 'eadirection' option limits the direction in which the 'equalalways'
576option is applied. The default "both" resizes in both directions. When the
577value is "ver" only the heights of windows are equalized. Use this when you
578have manually resized a vertically split window and want to keep this width.
579Likewise, "hor" causes only the widths of windows to be equalized.
580
581The option 'cmdheight' ('ch') is used to set the height of the command-line.
582If you are annoyed by the |hit-enter| prompt for long messages, set this
583option to 2 or 3.
584
585If there is only one window, resizing that window will also change the command
586line height. If there are several windows, resizing the current window will
587also change the height of the window below it (and sometimes the window above
588it).
589
590The minimal height and width of a window is set with 'winminheight' and
591'winminwidth'. These are hard values, a window will never become smaller.
592
593==============================================================================
5947. Argument and buffer list commands *buffer-list*
595
596 args list buffer list meaning ~
5971. :[N]argument [N] 11. :[N]buffer [N] to arg/buf N
5982. :[N]next [file ..] 12. :[N]bnext [N] to Nth next arg/buf
5993. :[N]Next [N] 13. :[N]bNext [N] to Nth previous arg/buf
6004. :[N]previous [N] 14. :[N]bprevious [N] to Nth previous arg/buf
6015. :rewind / :first 15. :brewind / :bfirst to first arg/buf
6026. :last 16. :blast to last arg/buf
6037. :all 17. :ball edit all args/buffers
604 18. :unhide edit all loaded buffers
605 19. :[N]bmod [N] to Nth modified buf
606
607 split & args list split & buffer list meaning ~
60821. :[N]sargument [N] 31. :[N]sbuffer [N] split + to arg/buf N
60922. :[N]snext [file ..] 32. :[N]sbnext [N] split + to Nth next arg/buf
61023. :[N]sNext [N] 33. :[N]sbNext [N] split + to Nth previous arg/buf
61124. :[N]sprevious [N] 34. :[N]sbprevious [N] split + to Nth previous arg/buf
61225. :srewind / :sfirst 35. :sbrewind / :sbfirst split + to first arg/buf
61326. :slast 36. :sblast split + to last arg/buf
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +000061427. :sall 37. :sball edit all args/buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +0000615 38. :sunhide edit all loaded buffers
616 39. :[N]sbmod [N] split + to Nth modified buf
617
61840. :args list of arguments
61941. :buffers list of buffers
620
621The meaning of [N] depends on the command:
622 [N] is number of buffers to go forward/backward on ?2, ?3, and ?4
623 [N] is an argument number, defaulting to current argument, for 1 and 21
624 [N] is a buffer number, defaulting to current buffer, for 11 and 31
625 [N] is a count for 19 and 39
626
627Note: ":next" is an exception, because it must accept a list of file names
628for compatibility with Vi.
629
630
631The argument list and multiple windows
632--------------------------------------
633
634The current position in the argument list can be different for each window.
635Remember that when doing ":e file", the position in the argument list stays
636the same, but you are not editing the file at that position. To indicate
637this, the file message (and the title, if you have one) shows
638"(file (N) of M)", where "(N)" is the current position in the file list, and
639"M" the number of files in the file list.
640
641All the entries in the argument list are added to the buffer list. Thus, you
642can also get to them with the buffer list commands, like ":bnext".
643
644:[N]al[l][!] [N] *:al* *:all* *:sal* *:sall*
645:[N]sal[l][!] [N]
646 Rearrange the screen to open one window for each argument.
647 All other windows are closed. When a count is given, this is
648 the maximum number of windows to open.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +0000649 With the |:tab| modifier open a tab page for each argument.
650 When there are more arguments than 'tabpagemax' further ones
651 become split windows in the last tab page.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000652 When the 'hidden' option is set, all buffers in closed windows
653 become hidden.
654 When 'hidden' is not set, and the 'autowrite' option is set,
655 modified buffers are written. Otherwise, windows that have
656 buffers that are modified are not removed, unless the [!] is
657 given, then they become hidden. But modified buffers are
658 never abandoned, so changes cannot get lost.
659 [N] is the maximum number of windows to open. 'winheight'
660 also limits the number of windows opened ('winwidth' if
661 |:vertical| was prepended).
662 Buf/Win Enter/Leave autocommands are not executed for the new
663 windows here, that's only done when they are really entered.
664
665:[N]sa[rgument][!] [++opt] [+cmd] [N] *:sa* *:sargument*
666 Short for ":split | argument [N]": split window and go to Nth
667 argument. But when there is no such argument, the window is
668 not split. Also see |++opt| and |+cmd|.
669
670:[N]sn[ext][!] [++opt] [+cmd] [file ..] *:sn* *:snext*
671 Short for ":split | [N]next": split window and go to Nth next
672 argument. But when there is no next file, the window is not
673 split. Also see |++opt| and |+cmd|.
674
675:[N]spr[evious][!] [++opt] [+cmd] [N] *:spr* *:sprevious*
676:[N]sN[ext][!] [++opt] [+cmd] [N] *:sN* *:sNext*
677 Short for ":split | [N]Next": split window and go to Nth
678 previous argument. But when there is no previous file, the
679 window is not split. Also see |++opt| and |+cmd|.
680
681 *:sre* *:srewind*
682:sre[wind][!] [++opt] [+cmd]
683 Short for ":split | rewind": split window and go to first
684 argument. But when there is no argument list, the window is
685 not split. Also see |++opt| and |+cmd|.
686
687 *:sfir* *:sfirst*
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000688:sfir[st] [++opt] [+cmd]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000689 Same as ":srewind".
690
691 *:sla* *:slast*
692:sla[st][!] [++opt] [+cmd]
693 Short for ":split | last": split window and go to last
694 argument. But when there is no argument list, the window is
695 not split. Also see |++opt| and |+cmd|.
696
697 *:dr* *:drop*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000698:dr[op] [++opt] [+cmd] {file} ..
Bram Moolenaar071d4272004-06-13 20:20:40 +0000699 Edit the first {file} in a window.
700 - If the file is already open in a window change to that
701 window.
702 - If the file is not open in a window edit the file in the
703 current window. If the current buffer can't be |abandon|ed,
704 the window is split first.
Bram Moolenaar51628222016-12-01 23:03:28 +0100705 - Windows that are not in the argument list or are not full
706 width will be closed if possible.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000707 The |argument-list| is set, like with the |:next| command.
708 The purpose of this command is that it can be used from a
709 program that wants Vim to edit another file, e.g., a debugger.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000710 When using the |:tab| modifier each argument is opened in a
711 tab page. The last window is used if it's empty.
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000712 Also see |++opt| and |+cmd|.
Bram Moolenaardb84e452010-08-15 13:50:43 +0200713 {only available when compiled with a GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000714
715==============================================================================
7168. Do a command in all buffers or windows *list-repeat*
717
718 *:windo*
Bram Moolenaara162bc52015-01-07 16:54:21 +0100719:[range]windo {cmd} Execute {cmd} in each window or if [range] is given
720 only in windows for which the window number lies in
721 the [range]. It works like doing this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000722 CTRL-W t
723 :{cmd}
724 CTRL-W w
725 :{cmd}
726 etc.
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000727< This only operates in the current tab page.
Bram Moolenaar7e8fd632006-02-18 22:14:51 +0000728 When an error is detected on one window, further
Bram Moolenaar071d4272004-06-13 20:20:40 +0000729 windows will not be visited.
730 The last window (or where an error occurred) becomes
731 the current window.
732 {cmd} can contain '|' to concatenate several commands.
733 {cmd} must not open or close windows or reorder them.
734 {not in Vi} {not available when compiled without the
735 |+listcmds| feature}
Bram Moolenaaraa23b372015-09-08 18:46:31 +0200736 Also see |:tabdo|, |:argdo|, |:bufdo|, |:cdo|, |:ldo|,
737 |:cfdo| and |:lfdo|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000738
739 *:bufdo*
Bram Moolenaara162bc52015-01-07 16:54:21 +0100740:[range]bufdo[!] {cmd} Execute {cmd} in each buffer in the buffer list or if
741 [range] is given only for buffers for which their
Bram Moolenaar681baaf2016-02-04 20:57:07 +0100742 buffer number is in the [range]. It works like doing
Bram Moolenaara162bc52015-01-07 16:54:21 +0100743 this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000744 :bfirst
745 :{cmd}
746 :bnext
747 :{cmd}
748 etc.
749< When the current file can't be |abandon|ed and the [!]
750 is not present, the command fails.
751 When an error is detected on one buffer, further
752 buffers will not be visited.
753 Unlisted buffers are skipped.
754 The last buffer (or where an error occurred) becomes
755 the current buffer.
756 {cmd} can contain '|' to concatenate several commands.
757 {cmd} must not delete buffers or add buffers to the
758 buffer list.
759 Note: While this command is executing, the Syntax
760 autocommand event is disabled by adding it to
761 'eventignore'. This considerably speeds up editing
762 each buffer.
763 {not in Vi} {not available when compiled without the
764 |+listcmds| feature}
Bram Moolenaaraa23b372015-09-08 18:46:31 +0200765 Also see |:tabdo|, |:argdo|, |:windo|, |:cdo|, |:ldo|,
766 |:cfdo| and |:lfdo|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000767
768Examples: >
769
770 :windo set nolist nofoldcolumn | normal zn
771
772This resets the 'list' option and disables folding in all windows. >
773
774 :bufdo set fileencoding= | update
775
776This resets the 'fileencoding' in each buffer and writes it if this changed
777the buffer. The result is that all buffers will use the 'encoding' encoding
778(if conversion works properly).
779
780==============================================================================
7819. Tag or file name under the cursor *window-tag*
782
783 *:sta* *:stag*
784:sta[g][!] [tagname]
785 Does ":tag[!] [tagname]" and splits the window for the found
786 tag. See also |:tag|.
787
788CTRL-W ] *CTRL-W_]* *CTRL-W_CTRL-]*
789CTRL-W CTRL-] Split current window in two. Use identifier under cursor as a
Bram Moolenaar3a991dd2014-10-02 01:41:41 +0200790 tag and jump to it in the new upper window.
791 In Visual mode uses the Visually selected text as a tag.
792 Make new window N high.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000793
794 *CTRL-W_g]*
795CTRL-W g ] Split current window in two. Use identifier under cursor as a
796 tag and perform ":tselect" on it in the new upper window.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +0200797 In Visual mode uses the Visually selected text as a tag.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000798 Make new window N high.
799
800 *CTRL-W_g_CTRL-]*
801CTRL-W g CTRL-] Split current window in two. Use identifier under cursor as a
Bram Moolenaar3a991dd2014-10-02 01:41:41 +0200802 tag and perform ":tjump" on it in the new upper window.
803 In Visual mode uses the Visually selected text as a tag.
804 Make new window N high.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000805
806CTRL-W f *CTRL-W_f* *CTRL-W_CTRL-F*
807CTRL-W CTRL-F Split current window in two. Edit file name under cursor.
Bram Moolenaar8dff8182006-04-06 20:18:50 +0000808 Like ":split gf", but window isn't split if the file does not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000809 exist.
810 Uses the 'path' variable as a list of directory names where to
811 look for the file. Also the path for current file is
812 used to search for the file name.
813 If the name is a hypertext link that looks like
814 "type://machine/path", only "/path" is used.
815 If a count is given, the count'th matching file is edited.
816 {not available when the |+file_in_path| feature was disabled
817 at compile time}
818
Bram Moolenaard1f56e62006-02-22 21:25:37 +0000819CTRL-W F *CTRL-W_F*
820 Split current window in two. Edit file name under cursor and
821 jump to the line number following the file name. See |gF| for
822 details on how the line number is obtained.
Bram Moolenaar57657d82006-04-21 22:12:41 +0000823 {not available when the |+file_in_path| feature was disabled
824 at compile time}
Bram Moolenaard1f56e62006-02-22 21:25:37 +0000825
Bram Moolenaar8dff8182006-04-06 20:18:50 +0000826CTRL-W gf *CTRL-W_gf*
827 Open a new tab page and edit the file name under the cursor.
828 Like "tab split" and "gf", but the new tab page isn't created
829 if the file does not exist.
830 {not available when the |+file_in_path| feature was disabled
831 at compile time}
832
Bram Moolenaar57657d82006-04-21 22:12:41 +0000833CTRL-W gF *CTRL-W_gF*
834 Open a new tab page and edit the file name under the cursor
835 and jump to the line number following the file name. Like
836 "tab split" and "gF", but the new tab page isn't created if
837 the file does not exist.
838 {not available when the |+file_in_path| feature was disabled
839 at compile time}
840
Bram Moolenaar071d4272004-06-13 20:20:40 +0000841Also see |CTRL-W_CTRL-I|: open window for an included file that includes
842the keyword under the cursor.
843
844==============================================================================
84510. The preview window *preview-window*
846
847The preview window is a special window to show (preview) another file. It is
848normally a small window used to show an include file or definition of a
849function.
850{not available when compiled without the |+quickfix| feature}
851
Bram Moolenaarc270d802006-03-11 21:29:41 +0000852There can be only one preview window (per tab page). It is created with one
853of the commands below. The 'previewheight' option can be set to specify the
854height of the preview window when it's opened. The 'previewwindow' option is
855set in the preview window to be able to recognize it. The 'winfixheight'
856option is set to have it keep the same height when opening/closing other
857windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000858
859 *:pta* *:ptag*
860:pta[g][!] [tagname]
861 Does ":tag[!] [tagname]" and shows the found tag in a
862 "Preview" window without changing the current buffer or cursor
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000863 position. If a "Preview" window already exists, it is re-used
Bram Moolenaar071d4272004-06-13 20:20:40 +0000864 (like a help window is). If a new one is opened,
865 'previewheight' is used for the height of the window. See
866 also |:tag|.
867 See below for an example. |CursorHold-example|
868 Small difference from |:tag|: When [tagname] is equal to the
869 already displayed tag, the position in the matching tag list
870 is not reset. This makes the CursorHold example work after a
871 |:ptnext|.
872
873CTRL-W z *CTRL-W_z*
874CTRL-W CTRL-Z *CTRL-W_CTRL-Z* *:pc* *:pclose*
875:pc[lose][!] Close any "Preview" window currently open. When the 'hidden'
876 option is set, or when the buffer was changed and the [!] is
877 used, the buffer becomes hidden (unless there is another
878 window editing it). The command fails if any "Preview" buffer
879 cannot be closed. See also |:close|.
880
881 *:pp* *:ppop*
882:[count]pp[op][!]
883 Does ":[count]pop[!]" in the preview window. See |:pop| and
884 |:ptag|. {not in Vi}
885
886CTRL-W } *CTRL-W_}*
887 Use identifier under cursor as a tag and perform a :ptag on
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000888 it. Make the new Preview window (if required) N high. If N is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000889 not given, 'previewheight' is used.
890
891CTRL-W g } *CTRL-W_g}*
892 Use identifier under cursor as a tag and perform a :ptjump on
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000893 it. Make the new Preview window (if required) N high. If N is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000894 not given, 'previewheight' is used.
895
896 *:ped* *:pedit*
897:ped[it][!] [++opt] [+cmd] {file}
898 Edit {file} in the preview window. The preview window is
899 opened like with |:ptag|. The current window and cursor
900 position isn't changed. Useful example: >
901 :pedit +/fputc /usr/include/stdio.h
902<
903 *:ps* *:psearch*
904:[range]ps[earch][!] [count] [/]pattern[/]
905 Works like |:ijump| but shows the found match in the preview
906 window. The preview window is opened like with |:ptag|. The
907 current window and cursor position isn't changed. Useful
908 example: >
909 :psearch popen
910< Like with the |:ptag| command, you can use this to
911 automatically show information about the word under the
912 cursor. This is less clever than using |:ptag|, but you don't
913 need a tags file and it will also find matches in system
914 include files. Example: >
915 :au! CursorHold *.[ch] nested exe "silent! psearch " . expand("<cword>")
916< Warning: This can be slow.
917
918Example *CursorHold-example* >
919
920 :au! CursorHold *.[ch] nested exe "silent! ptag " . expand("<cword>")
921
922This will cause a ":ptag" to be executed for the keyword under the cursor,
923when the cursor hasn't moved for the time set with 'updatetime'. The "nested"
924makes other autocommands be executed, so that syntax highlighting works in the
925preview window. The "silent!" avoids an error message when the tag could not
926be found. Also see |CursorHold|. To disable this again: >
927
928 :au! CursorHold
929
930A nice addition is to highlight the found tag, avoid the ":ptag" when there
931is no word under the cursor, and a few other things: >
932
933 :au! CursorHold *.[ch] nested call PreviewWord()
934 :func PreviewWord()
935 : if &previewwindow " don't do this in the preview window
936 : return
937 : endif
938 : let w = expand("<cword>") " get the word under cursor
939 : if w =~ '\a' " if the word contains a letter
940 :
941 : " Delete any existing highlight before showing another tag
942 : silent! wincmd P " jump to preview window
943 : if &previewwindow " if we really get there...
944 : match none " delete existing highlight
945 : wincmd p " back to old window
946 : endif
947 :
948 : " Try displaying a matching tag for the word under the cursor
949 : try
950 : exe "ptag " . w
951 : catch
952 : return
953 : endtry
954 :
955 : silent! wincmd P " jump to preview window
956 : if &previewwindow " if we really get there...
957 : if has("folding")
958 : silent! .foldopen " don't want a closed fold
959 : endif
960 : call search("$", "b") " to end of previous line
961 : let w = substitute(w, '\\', '\\\\', "")
962 : call search('\<\V' . w . '\>') " position cursor on match
963 : " Add a match highlight to the word at this position
964 : hi previewWord term=bold ctermbg=green guibg=green
965 : exe 'match previewWord "\%' . line(".") . 'l\%' . col(".") . 'c\k*"'
966 : wincmd p " back to old window
967 : endif
968 : endif
969 :endfun
970
971==============================================================================
97211. Using hidden buffers *buffer-hidden*
973
974A hidden buffer is not displayed in a window, but is still loaded into memory.
975This makes it possible to jump from file to file, without the need to read or
976write the file every time you get another buffer in a window.
977{not available when compiled without the |+listcmds| feature}
978
979 *:buffer-!*
980If the option 'hidden' ('hid') is set, abandoned buffers are kept for all
981commands that start editing another file: ":edit", ":next", ":tag", etc. The
982commands that move through the buffer list sometimes make the current buffer
983hidden although the 'hidden' option is not set. This happens when a buffer is
984modified, but is forced (with '!') to be removed from a window, and
985'autowrite' is off or the buffer can't be written.
986
987You can make a hidden buffer not hidden by starting to edit it with any
988command. Or by deleting it with the ":bdelete" command.
989
990The 'hidden' is global, it is used for all buffers. The 'bufhidden' option
991can be used to make an exception for a specific buffer. It can take these
992values:
993 <empty> Use the value of 'hidden'.
994 hide Hide this buffer, also when 'hidden' is not set.
995 unload Don't hide but unload this buffer, also when 'hidden'
996 is set.
997 delete Delete the buffer.
998
999 *hidden-quit*
1000When you try to quit Vim while there is a hidden, modified buffer, you will
1001get an error message and Vim will make that buffer the current buffer. You
1002can then decide to write this buffer (":wq") or quit without writing (":q!").
1003Be careful: there may be more hidden, modified buffers!
1004
1005A buffer can also be unlisted. This means it exists, but it is not in the
1006list of buffers. |unlisted-buffer|
1007
1008
Bram Moolenaard51cb702015-07-21 15:03:06 +02001009:files[!] [flags] *:files*
1010:buffers[!] [flags] *:buffers* *:ls*
1011:ls[!] [flags]
1012 Show all buffers. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001013
Bram Moolenaar97d62492012-11-15 21:28:22 +01001014 1 #h "/test/text" line 1 ~
1015 2u "asdf" line 0 ~
1016 3 %a + "version.c" line 1 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +00001017
1018 When the [!] is included the list will show unlisted buffers
1019 (the term "unlisted" is a bit confusing then...).
1020
1021 Each buffer has a unique number. That number will not change,
Bram Moolenaar0122c402015-02-03 19:13:34 +01001022 thus you can always go to a specific buffer with ":buffer N"
1023 or "N CTRL-^", where N is the buffer number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001024
1025 Indicators (chars in the same column are mutually exclusive):
1026 u an unlisted buffer (only displayed when [!] is used)
1027 |unlisted-buffer|
1028 % the buffer in the current window
1029 # the alternate buffer for ":e #" and CTRL-^
1030 a an active buffer: it is loaded and visible
1031 h a hidden buffer: It is loaded, but currently not
1032 displayed in a window |hidden-buffer|
1033 - a buffer with 'modifiable' off
1034 = a readonly buffer
Bram Moolenaarc572da52017-08-27 16:52:01 +02001035 R a terminal buffer with a running job
1036 F a terminal buffer with a finished job
Bram Moolenaar071d4272004-06-13 20:20:40 +00001037 + a modified buffer
1038 x a buffer with read errors
1039
Bram Moolenaard51cb702015-07-21 15:03:06 +02001040 [flags] can be a combination of the following characters,
1041 which restrict the buffers to be listed:
1042 + modified buffers
1043 - buffers with 'modifiable' off
1044 = readonly buffers
1045 a active buffers
Bram Moolenaare392eb42015-11-19 20:38:09 +01001046 u unlisted buffers (overrides the "!")
Bram Moolenaard51cb702015-07-21 15:03:06 +02001047 h hidden buffers
1048 x buffers with a read error
1049 % current buffer
1050 # alternate buffer
1051 Combining flags means they are "and"ed together, e.g.:
1052 h+ hidden buffers which are modified
1053 a+ active buffers which are modified
1054
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02001055 When using |:filter| the pattern is matched against the
1056 displayed buffer name, e.g.: >
1057 filter /\.vim/ ls
1058<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001059 *:bad* *:badd*
1060:bad[d] [+lnum] {fname}
1061 Add file name {fname} to the buffer list, without loading it.
1062 If "lnum" is specified, the cursor will be positioned at that
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001063 line when the buffer is first entered. Note that other
Bram Moolenaar071d4272004-06-13 20:20:40 +00001064 commands after the + will be ignored.
1065
1066:[N]bd[elete][!] *:bd* *:bdel* *:bdelete* *E516*
1067:bd[elete][!] [N]
1068 Unload buffer [N] (default: current buffer) and delete it from
1069 the buffer list. If the buffer was changed, this fails,
1070 unless when [!] is specified, in which case changes are lost.
1071 The file remains unaffected. Any windows for this buffer are
1072 closed. If buffer [N] is the current buffer, another buffer
1073 will be displayed instead. This is the most recent entry in
1074 the jump list that points into a loaded buffer.
1075 Actually, the buffer isn't completely deleted, it is removed
1076 from the buffer list |unlisted-buffer| and option values,
1077 variables and mappings/abbreviations for the buffer are
Bram Moolenaar4d84d932014-11-30 14:50:16 +01001078 cleared. Examples: >
1079 :.,$-bdelete " delete buffers from the current one to
1080 " last but one
1081 :%bdelete " delete all buffers
1082<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001083
1084:bdelete[!] {bufname} *E93* *E94*
1085 Like ":bdelete[!] [N]", but buffer given by name. Note that a
1086 buffer whose name is a number cannot be referenced by that
1087 name; use the buffer number instead. Insert a backslash
1088 before a space in a buffer name.
1089
1090:bdelete[!] N1 N2 ...
1091 Do ":bdelete[!]" for buffer N1, N2, etc. The arguments can be
1092 buffer numbers or buffer names (but not buffer names that are
1093 a number). Insert a backslash before a space in a buffer
1094 name.
1095
1096:N,Mbdelete[!] Do ":bdelete[!]" for all buffers in the range N to M
1097 |inclusive|.
1098
1099:[N]bw[ipeout][!] *:bw* *:bwipe* *:bwipeout* *E517*
1100:bw[ipeout][!] {bufname}
1101:N,Mbw[ipeout][!]
1102:bw[ipeout][!] N1 N2 ...
Bram Moolenaardf1bdc92006-02-23 21:32:16 +00001103 Like |:bdelete|, but really delete the buffer. Everything
1104 related to the buffer is lost. All marks in this buffer
1105 become invalid, option settings are lost, etc. Don't use this
Bram Moolenaar4d84d932014-11-30 14:50:16 +01001106 unless you know what you are doing. Examples: >
1107 :.+,$bwipeout " wipe out all buffers after the current
1108 " one
1109 :%bwipeout " wipe out all buffers
1110<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001111
1112:[N]bun[load][!] *:bun* *:bunload* *E515*
1113:bun[load][!] [N]
1114 Unload buffer [N] (default: current buffer). The memory
1115 allocated for this buffer will be freed. The buffer remains
1116 in the buffer list.
1117 If the buffer was changed, this fails, unless when [!] is
1118 specified, in which case the changes are lost.
1119 Any windows for this buffer are closed. If buffer [N] is the
1120 current buffer, another buffer will be displayed instead.
1121 This is the most recent entry in the jump list that points
1122 into a loaded buffer.
1123
1124:bunload[!] {bufname}
1125 Like ":bunload[!] [N]", but buffer given by name. Note that a
1126 buffer whose name is a number cannot be referenced by that
1127 name; use the buffer number instead. Insert a backslash
1128 before a space in a buffer name.
1129
1130:N,Mbunload[!] Do ":bunload[!]" for all buffers in the range N to M
1131 |inclusive|.
1132
1133:bunload[!] N1 N2 ...
1134 Do ":bunload[!]" for buffer N1, N2, etc. The arguments can be
1135 buffer numbers or buffer names (but not buffer names that are
1136 a number). Insert a backslash before a space in a buffer
1137 name.
1138
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001139:[N]b[uffer][!] [+cmd] [N] *:b* *:bu* *:buf* *:buffer* *E86*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001140 Edit buffer [N] from the buffer list. If [N] is not given,
1141 the current buffer remains being edited. See |:buffer-!| for
1142 [!]. This will also edit a buffer that is not in the buffer
1143 list, without setting the 'buflisted' flag.
Bram Moolenaar12969c02015-09-08 23:36:10 +02001144 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001145
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001146:[N]b[uffer][!] [+cmd] {bufname}
Bram Moolenaarc1a11ed2008-06-24 22:09:24 +00001147 Edit buffer for {bufname} from the buffer list. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00001148 |:buffer-!| for [!]. This will also edit a buffer that is not
1149 in the buffer list, without setting the 'buflisted' flag.
Bram Moolenaar12969c02015-09-08 23:36:10 +02001150 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001151
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001152:[N]sb[uffer] [+cmd] [N] *:sb* *:sbuffer*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001153 Split window and edit buffer [N] from the buffer list. If [N]
1154 is not given, the current buffer is edited. Respects the
1155 "useopen" setting of 'switchbuf' when splitting. This will
1156 also edit a buffer that is not in the buffer list, without
1157 setting the 'buflisted' flag.
Bram Moolenaar12969c02015-09-08 23:36:10 +02001158 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001159
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001160:[N]sb[uffer] [+cmd] {bufname}
Bram Moolenaarc1a11ed2008-06-24 22:09:24 +00001161 Split window and edit buffer for {bufname} from the buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001162 list. This will also edit a buffer that is not in the buffer
1163 list, without setting the 'buflisted' flag.
Bram Moolenaar280f1262006-01-30 00:14:18 +00001164 Note: If what you want to do is split the buffer, make a copy
1165 under another name, you can do it this way: >
1166 :w foobar | sp #
Bram Moolenaar12969c02015-09-08 23:36:10 +02001167< Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001168
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001169:[N]bn[ext][!] [+cmd] [N] *:bn* *:bnext* *E87*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001170 Go to [N]th next buffer in buffer list. [N] defaults to one.
1171 Wraps around the end of the buffer list.
1172 See |:buffer-!| for [!].
Bram Moolenaar12969c02015-09-08 23:36:10 +02001173 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001174 If you are in a help buffer, this takes you to the next help
1175 buffer (if there is one). Similarly, if you are in a normal
1176 (non-help) buffer, this takes you to the next normal buffer.
1177 This is so that if you have invoked help, it doesn't get in
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001178 the way when you're browsing code/text buffers. The next three
Bram Moolenaar071d4272004-06-13 20:20:40 +00001179 commands also work like this.
1180
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001181
Bram Moolenaar071d4272004-06-13 20:20:40 +00001182 *:sbn* *:sbnext*
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001183:[N]sbn[ext] [+cmd] [N]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001184 Split window and go to [N]th next buffer in buffer list.
1185 Wraps around the end of the buffer list. Uses 'switchbuf'
Bram Moolenaar12969c02015-09-08 23:36:10 +02001186 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001187
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001188:[N]bN[ext][!] [+cmd] [N] *:bN* *:bNext* *:bp* *:bprevious* *E88*
1189:[N]bp[revious][!] [+cmd] [N]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001190 Go to [N]th previous buffer in buffer list. [N] defaults to
1191 one. Wraps around the start of the buffer list.
1192 See |:buffer-!| for [!] and 'switchbuf'.
Bram Moolenaar12969c02015-09-08 23:36:10 +02001193 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001194
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001195:[N]sbN[ext] [+cmd] [N] *:sbN* *:sbNext* *:sbp* *:sbprevious*
1196:[N]sbp[revious] [+cmd] [N]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001197 Split window and go to [N]th previous buffer in buffer list.
1198 Wraps around the start of the buffer list.
1199 Uses 'switchbuf'.
Bram Moolenaar12969c02015-09-08 23:36:10 +02001200 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001201
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001202:br[ewind][!] [+cmd] *:br* *:brewind*
1203 Go to first buffer in buffer list. If the buffer list is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001204 empty, go to the first unlisted buffer.
1205 See |:buffer-!| for [!].
1206
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001207:bf[irst] [+cmd] *:bf* *:bfirst*
1208 Same as |:brewind|.
1209 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001210
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001211:sbr[ewind] [+cmd] *:sbr* *:sbrewind*
1212 Split window and go to first buffer in buffer list. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001213 buffer list is empty, go to the first unlisted buffer.
1214 Respects the 'switchbuf' option.
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001215 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001216
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001217:sbf[irst] [+cmd] *:sbf* *:sbfirst*
1218 Same as ":sbrewind".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001219
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001220:bl[ast][!] [+cmd] *:bl* *:blast*
1221 Go to last buffer in buffer list. If the buffer list is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001222 empty, go to the last unlisted buffer.
1223 See |:buffer-!| for [!].
1224
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001225:sbl[ast] [+cmd] *:sbl* *:sblast*
1226 Split window and go to last buffer in buffer list. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001227 buffer list is empty, go to the last unlisted buffer.
1228 Respects 'switchbuf' option.
1229
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001230:[N]bm[odified][!] [+cmd] [N] *:bm* *:bmodified* *E84*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001231 Go to [N]th next modified buffer. Note: this command also
1232 finds unlisted buffers. If there is no modified buffer the
1233 command fails.
1234
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001235:[N]sbm[odified] [+cmd] [N] *:sbm* *:sbmodified*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001236 Split window and go to [N]th next modified buffer.
1237 Respects 'switchbuf' option.
1238 Note: this command also finds buffers not in the buffer list.
1239
1240:[N]unh[ide] [N] *:unh* *:unhide* *:sun* *:sunhide*
1241:[N]sun[hide] [N]
1242 Rearrange the screen to open one window for each loaded buffer
1243 in the buffer list. When a count is given, this is the
1244 maximum number of windows to open.
1245
1246:[N]ba[ll] [N] *:ba* *:ball* *:sba* *:sball*
1247:[N]sba[ll] [N] Rearrange the screen to open one window for each buffer in
1248 the buffer list. When a count is given, this is the maximum
1249 number of windows to open. 'winheight' also limits the number
1250 of windows opened ('winwidth' if |:vertical| was prepended).
1251 Buf/Win Enter/Leave autocommands are not executed for the new
1252 windows here, that's only done when they are really entered.
Bram Moolenaar756ec0f2007-05-05 17:59:48 +00001253 When the |:tab| modifier is used new windows are opened in a
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00001254 new tab, up to 'tabpagemax'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001255
1256Note: All the commands above that start editing another buffer, keep the
1257'readonly' flag as it was. This differs from the ":edit" command, which sets
1258the 'readonly' flag each time the file is read.
1259
1260==============================================================================
126112. Special kinds of buffers *special-buffers*
1262
1263Instead of containing the text of a file, buffers can also be used for other
1264purposes. A few options can be set to change the behavior of a buffer:
1265 'bufhidden' what happens when the buffer is no longer displayed
1266 in a window.
1267 'buftype' what kind of a buffer this is
1268 'swapfile' whether the buffer will have a swap file
1269 'buflisted' buffer shows up in the buffer list
1270
1271A few useful kinds of a buffer:
1272
Bram Moolenaar280f1262006-01-30 00:14:18 +00001273quickfix Used to contain the error list or the location list. See
1274 |:cwindow| and |:lwindow|. This command sets the 'buftype'
1275 option to "quickfix". You are not supposed to change this!
1276 'swapfile' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001277
1278help Contains a help file. Will only be created with the |:help|
1279 command. The flag that indicates a help buffer is internal
1280 and can't be changed. The 'buflisted' option will be reset
1281 for a help buffer.
1282
Bram Moolenaarb6e0ec62017-07-23 22:12:20 +02001283terminal A terminal window buffer, see |terminal|. The contents cannot
1284 be read or changed until the job ends.
1285
Bram Moolenaar677ee682005-01-27 14:41:15 +00001286directory Displays directory contents. Can be used by a file explorer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001287 plugin. The buffer is created with these settings: >
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001288 :setlocal buftype=nowrite
1289 :setlocal bufhidden=delete
1290 :setlocal noswapfile
Bram Moolenaar071d4272004-06-13 20:20:40 +00001291< The buffer name is the name of the directory and is adjusted
1292 when using the |:cd| command.
1293
1294scratch Contains text that can be discarded at any time. It is kept
1295 when closing the window, it must be deleted explicitly.
1296 Settings: >
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001297 :setlocal buftype=nofile
1298 :setlocal bufhidden=hide
1299 :setlocal noswapfile
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001300< The buffer name can be used to identify the buffer, if you
1301 give it a meaningful name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001302
1303 *unlisted-buffer*
1304unlisted The buffer is not in the buffer list. It is not used for
1305 normal editing, but to show a help file, remember a file name
1306 or marks. The ":bdelete" command will also set this option,
1307 thus it doesn't completely delete the buffer. Settings: >
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001308 :setlocal nobuflisted
Bram Moolenaar071d4272004-06-13 20:20:40 +00001309<
1310
1311 vim:tw=78:ts=8:ft=help:norl: