blob: 2d96b043b6504b87f3ecb275145fdaa0d44f437a [file] [log] [blame]
Bram Moolenaareb490412022-06-28 13:44:46 +01001*windows.txt* For Vim version 9.0. Last change: 2022 May 11
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
Bram Moolenaar071d4272004-06-13 20:20:40 +000029{not able to use multiple windows when the |+windows| feature was disabled at
30compile time}
Bram Moolenaar071d4272004-06-13 20:20:40 +000031
32==============================================================================
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000331. Introduction *windows-intro* *window*
Bram Moolenaar071d4272004-06-13 20:20:40 +000034
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +010035Summary:
36 A buffer is the in-memory text of a file.
37 A window is a viewport on a buffer.
38 A tab page is a collection of windows.
39
Bram Moolenaar071d4272004-06-13 20:20:40 +000040A window is a viewport onto a buffer. You can use multiple windows on one
41buffer, or several windows on different buffers.
42
43A buffer is a file loaded into memory for editing. The original file remains
44unchanged until you write the buffer to the file.
45
46A buffer can be in one of three states:
47
48 *active-buffer*
49active: The buffer is displayed in a window. If there is a file for this
50 buffer, it has been read into the buffer. The buffer may have been
51 modified since then and thus be different from the file.
52 *hidden-buffer*
53hidden: The buffer is not displayed. If there is a file for this buffer, it
54 has been read into the buffer. Otherwise it's the same as an active
55 buffer, you just can't see it.
56 *inactive-buffer*
57inactive: The buffer is not displayed and does not contain anything. Options
58 for the buffer are remembered if the file was once loaded. It can
59 contain marks from the |viminfo| file. But the buffer doesn't
60 contain text.
61
62In a table:
63
64state displayed loaded ":buffers" ~
65 in window shows ~
66active yes yes 'a'
67hidden no yes 'h'
68inactive no no ' '
69
70Note: All CTRL-W commands can also be executed with |:wincmd|, for those
71places where a Normal mode command can't be used or is inconvenient.
72
Bram Moolenaar7e8fd632006-02-18 22:14:51 +000073The main Vim window can hold several split windows. There are also tab pages
74|tab-page|, each of which can hold multiple windows.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +020075 *window-ID* *winid* *windowid*
Bram Moolenaarc95a3022016-06-12 23:01:46 +020076Each window has a unique identifier called the window ID. This identifier
77will not change within a Vim session. The |win_getid()| and |win_id2tabwin()|
78functions can be used to convert between the window/tab number and the
79identifier. There is also the window number, which may change whenever
80windows are opened or closed, see |winnr()|.
Bram Moolenaarba3ff532018-11-04 14:45:49 +010081The window number is only valid in one specific tab. The window ID is valid
82across tabs. For most functions that take a window ID or a window number, the
83window number only applies to the current tab, while the window ID can refer
84to a window in any tab.
Bram Moolenaarc95a3022016-06-12 23:01:46 +020085
86Each buffer has a unique number and the number will not change within a Vim
87session. The |bufnr()| and |bufname()| functions can be used to convert
88between a buffer name and the buffer number.
89
Bram Moolenaar071d4272004-06-13 20:20:40 +000090==============================================================================
912. Starting Vim *windows-starting*
92
93By default, Vim starts with one window, just like Vi.
94
95The "-o" and "-O" arguments to Vim can be used to open a window for each file
96in the argument list. The "-o" argument will split the windows horizontally;
97the "-O" argument will split the windows vertically. If both "-o" and "-O"
98are given, the last one encountered will be used to determine the split
99orientation. For example, this will open three windows, split horizontally: >
100 vim -o file1 file2 file3
101
102"-oN", where N is a decimal number, opens N windows split horizontally. If
103there are more file names than windows, only N windows are opened and some
104files do not get a window. If there are more windows than file names, the
105last few windows will be editing empty buffers. Similarly, "-ON" opens N
106windows split vertically, with the same restrictions.
107
108If there are many file names, the windows will become very small. You might
109want to set the 'winheight' and/or 'winwidth' options to create a workable
110situation.
111
112Buf/Win Enter/Leave |autocommand|s are not executed when opening the new
113windows and reading the files, that's only done when they are really entered.
114
115 *status-line*
116A status line will be used to separate windows. The 'laststatus' option tells
117when the last window also has a status line:
118 'laststatus' = 0 never a status line
119 'laststatus' = 1 status line if there is more than one window
120 'laststatus' = 2 always a status line
121
122You can change the contents of the status line with the 'statusline' option.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000123This option can be local to the window, so that you can have a different
124status line in each window.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000125
126Normally, inversion is used to display the status line. This can be changed
127with the 's' character in the 'highlight' option. For example, "sb" sets it to
128bold characters. If no highlighting is used for the status line ("sn"), the
129'^' character is used for the current window, and '=' for other windows. If
130the mouse is supported and enabled with the 'mouse' option, a status line can
131be dragged to resize windows.
132
133Note: If you expect your status line to be in reverse video and it isn't,
134check if the 'highlight' option contains "si". In version 3.0, this meant to
135invert the status line. Now it should be "sr", reverse the status line, as
136"si" now stands for italic! If italic is not available on your terminal, the
137status line is inverted anyway; you will only see this problem on terminals
138that have termcap codes for italics.
139
Bram Moolenaar65e0d772020-06-14 17:29:55 +0200140 *filler-lines*
Bram Moolenaara98f8a22021-02-13 18:24:23 +0100141The lines after the last buffer line in a window are called filler lines. By
142default, these lines start with a tilde (~) character. The 'eob' item in the
143'fillchars' option can be used to change this character. By default, these
144characters are highlighted as NonText (|hl-NonText|). The EndOfBuffer
145highlight group (|hl-EndOfBuffer|) can be used to change the highlighting of
146the filler characters.
Bram Moolenaar65e0d772020-06-14 17:29:55 +0200147
Bram Moolenaar071d4272004-06-13 20:20:40 +0000148==============================================================================
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00001493. Opening and closing a window *opening-window*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000150
151CTRL-W s *CTRL-W_s*
152CTRL-W S *CTRL-W_S*
153CTRL-W CTRL-S *CTRL-W_CTRL-S*
Bram Moolenaar7b449342014-03-25 13:03:48 +0100154:[N]sp[lit] [++opt] [+cmd] [file] *:sp* *:split*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000155 Split current window in two. The result is two viewports on
Bram Moolenaar7b449342014-03-25 13:03:48 +0100156 the same file.
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100157
Bram Moolenaar7b449342014-03-25 13:03:48 +0100158 Make the new window N high (default is to use half the height
159 of the current window). Reduces the current window height to
160 create room (and others, if the 'equalalways' option is set,
161 'eadirection' isn't "hor", and one of them is higher than the
162 current or the new window).
163
164 If [file] is given it will be edited in the new window. If it
165 is not loaded in any buffer, it will be read. Else the new
166 window will use the already loaded buffer.
167
Bram Moolenaar071d4272004-06-13 20:20:40 +0000168 Note: CTRL-S does not work on all terminals and might block
169 further input, use CTRL-Q to get going again.
170 Also see |++opt| and |+cmd|.
Bram Moolenaara2baa732022-02-04 16:09:54 +0000171 *E242* *E1159*
Bram Moolenaar54775062019-07-31 21:07:14 +0200172 Be careful when splitting a window in an autocommand, it may
173 mess up the window layout if this happens while making other
174 window layout changes.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000175
176CTRL-W CTRL-V *CTRL-W_CTRL-V*
177CTRL-W v *CTRL-W_v*
178:[N]vs[plit] [++opt] [+cmd] [file] *:vs* *:vsplit*
Bram Moolenaar67f71312007-08-12 14:55:56 +0000179 Like |:split|, but split vertically. The windows will be
180 spread out horizontally if
181 1. a width was not specified,
182 2. 'equalalways' is set,
183 3. 'eadirection' isn't "ver", and
Bram Moolenaarc1a11ed2008-06-24 22:09:24 +0000184 4. one of the other windows is wider than the current or new
Bram Moolenaar67f71312007-08-12 14:55:56 +0000185 window.
Bram Moolenaarfd999452022-08-24 18:30:14 +0100186 If N was given make the new window N columns wide, if
187 possible.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000188 Note: In other places CTRL-Q does the same as CTRL-V, but here
189 it doesn't!
190
191CTRL-W n *CTRL-W_n*
192CTRL-W CTRL_N *CTRL-W_CTRL-N*
193:[N]new [++opt] [+cmd] *:new*
194 Create a new window and start editing an empty file in it.
195 Make new window N high (default is to use half the existing
196 height). Reduces the current window height to create room (and
197 others, if the 'equalalways' option is set and 'eadirection'
198 isn't "hor").
199 Also see |++opt| and |+cmd|.
200 If 'fileformats' is not empty, the first format given will be
201 used for the new buffer. If 'fileformats' is empty, the
202 'fileformat' of the current buffer is used. This can be
203 overridden with the |++opt| argument.
204 Autocommands are executed in this order:
205 1. WinLeave for the current window
206 2. WinEnter for the new window
207 3. BufLeave for the current buffer
208 4. BufEnter for the new buffer
Bram Moolenaar53bfca22012-04-13 23:04:47 +0200209 This behaves like a ":split" first, and then an ":enew"
210 command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000211
Bram Moolenaar071d4272004-06-13 20:20:40 +0000212:[N]new [++opt] [+cmd] {file}
213:[N]sp[lit] [++opt] [+cmd] {file} *:split_f*
Bram Moolenaar53bfca22012-04-13 23:04:47 +0200214 Create a new window and start editing file {file} in it. This
Bram Moolenaar942db232021-02-13 18:14:48 +0100215 behaves almost like a ":split" first, and then an ":edit"
216 command, but the alternate file name in the original window is
217 set to {file}.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000218 If [+cmd] is given, execute the command when the file has been
219 loaded |+cmd|.
220 Also see |++opt|.
221 Make new window N high (default is to use half the existing
222 height). Reduces the current window height to create room
223 (and others, if the 'equalalways' option is set).
224
Bram Moolenaar4072ba52020-12-23 13:56:35 +0100225:[N]vne[w] [++opt] [+cmd] [file] *:vne* *:vnew*
226 Like |:new|, but split vertically. If 'equalalways' is set
227 and 'eadirection' isn't "ver" the windows will be spread out
228 horizontally, unless a width was specified.
229
Bram Moolenaarff781552020-03-19 20:37:11 +0100230:[N]sv[iew] [++opt] [+cmd] [file] *:sv* *:sview* *splitview*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000231 Same as ":split", but set 'readonly' option for this buffer.
232
Bram Moolenaar61da1bf2019-06-06 12:14:49 +0200233:[N]sf[ind] [++opt] [+cmd] {file} *:sf* *:sfi* *:sfind* *splitfind*
Bram Moolenaarc236c162008-07-13 17:41:49 +0000234 Same as ":split", but search for {file} in 'path' like in
235 |:find|. Doesn't split if {file} is not found.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000236
237CTRL-W CTRL-^ *CTRL-W_CTRL-^* *CTRL-W_^*
Bram Moolenaar1bbb6192018-11-10 16:02:01 +0100238CTRL-W ^ Split the current window in two and edit the alternate file.
239 When a count N is given, split the current window and edit
240 buffer N. Similar to ":sp #" and ":sp #N", but it allows the
241 other buffer to be unnamed. This command matches the behavior
242 of |CTRL-^|, except that it splits a window first.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000243
Bram Moolenaarb6e0ec62017-07-23 22:12:20 +0200244 *CTRL-W_:*
Bram Moolenaard2f3a8b2018-06-19 14:35:59 +0200245CTRL-W : Does the same as typing |:| - enter a command line. Useful in a
Bram Moolenaarb6e0ec62017-07-23 22:12:20 +0200246 terminal window, where all Vim commands must be preceded with
Bram Moolenaard2f3a8b2018-06-19 14:35:59 +0200247 CTRL-W or 'termwinkey'.
Bram Moolenaarb6e0ec62017-07-23 22:12:20 +0200248
Bram Moolenaar071d4272004-06-13 20:20:40 +0000249Note that the 'splitbelow' and 'splitright' options influence where a new
250window will appear.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000251 *E36*
252Creating a window will fail if there is not enough room. Every window needs
253at least one screen line and column, sometimes more. Options 'winminheight'
254and 'winminwidth' are relevant.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000255
256 *:vert* *:vertical*
257:vert[ical] {cmd}
258 Execute {cmd}. If it contains a command that splits a window,
Bram Moolenaar21c3a802022-08-31 17:49:14 +0100259 it will be split vertically. For `vertical wincmd =` windows
Bram Moolenaar0daafaa2022-09-04 17:45:43 +0100260 will be equalized only vertically.
Bram Moolenaar756ec0f2007-05-05 17:59:48 +0000261 Doesn't work for |:execute| and |:normal|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000262
Bram Moolenaar21c3a802022-08-31 17:49:14 +0100263 *:hor* *:horizontal*
264:hor[izontal] {cmd}
265 Execute {cmd}. Currently only makes a difference for
Bram Moolenaar0daafaa2022-09-04 17:45:43 +0100266 `horizontal wincmd =`, which will equalize windows only
Bram Moolenaar21c3a802022-08-31 17:49:14 +0100267 horizontally.
268
Bram Moolenaar071d4272004-06-13 20:20:40 +0000269:lefta[bove] {cmd} *:lefta* *:leftabove*
270:abo[veleft] {cmd} *:abo* *:aboveleft*
271 Execute {cmd}. If it contains a command that splits a window,
272 it will be opened left (vertical split) or above (horizontal
273 split) the current window. Overrules 'splitbelow' and
274 'splitright'.
Bram Moolenaar756ec0f2007-05-05 17:59:48 +0000275 Doesn't work for |:execute| and |:normal|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000276
277:rightb[elow] {cmd} *:rightb* *:rightbelow*
278:bel[owright] {cmd} *:bel* *:belowright*
279 Execute {cmd}. If it contains a command that splits a window,
280 it will be opened right (vertical split) or below (horizontal
281 split) the current window. Overrules 'splitbelow' and
282 'splitright'.
Bram Moolenaar756ec0f2007-05-05 17:59:48 +0000283 Doesn't work for |:execute| and |:normal|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000284
285 *:topleft* *E442*
286:to[pleft] {cmd}
287 Execute {cmd}. If it contains a command that splits a window,
288 it will appear at the top and occupy the full width of the Vim
289 window. When the split is vertical the window appears at the
290 far left and occupies the full height of the Vim window.
Bram Moolenaar756ec0f2007-05-05 17:59:48 +0000291 Doesn't work for |:execute| and |:normal|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000292
Bram Moolenaarbc8801c2016-08-02 21:04:33 +0200293 *:bo* *:botright*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000294:bo[tright] {cmd}
295 Execute {cmd}. If it contains a command that splits a window,
296 it will appear at the bottom and occupy the full width of the
297 Vim window. When the split is vertical the window appears at
298 the far right and occupies the full height of the Vim window.
Bram Moolenaar756ec0f2007-05-05 17:59:48 +0000299 Doesn't work for |:execute| and |:normal|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000300
301These command modifiers can be combined to make a vertically split window
302occupy the full height. Example: >
Bram Moolenaar5302d9e2011-09-14 17:55:08 +0200303 :vertical topleft split tags
Bram Moolenaar071d4272004-06-13 20:20:40 +0000304Opens a vertically split, full-height window on the "tags" file at the far
305left of the Vim window.
306
307
308Closing a window
309----------------
310
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100311:q[uit]
Bram Moolenaar6c391a72021-09-09 21:55:11 +0200312:{count}q[uit] *:count_quit*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000313CTRL-W q *CTRL-W_q*
314CTRL-W CTRL-Q *CTRL-W_CTRL-Q*
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100315 Without {count}: Quit the current window. If {count} is
316 given quit the {count} window.
Bram Moolenaar47e13952020-05-12 22:49:12 +0200317 *edit-window*
318 When quitting the last edit window (not counting help or
319 preview windows), exit Vim.
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100320
Bram Moolenaar071d4272004-06-13 20:20:40 +0000321 When 'hidden' is set, and there is only one window for the
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100322 current buffer, it becomes hidden. When 'hidden' is not set,
323 and there is only one window for the current buffer, and the
324 buffer was changed, the command fails.
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100325
Bram Moolenaared32d942014-12-06 23:33:00 +0100326 (Note: CTRL-Q does not work on all terminals).
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100327
Bram Moolenaared32d942014-12-06 23:33:00 +0100328 If [count] is greater than the last window number the last
329 window will be closed: >
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100330 :1quit " quit the first window
331 :$quit " quit the last window
332 :9quit " quit the last window
Bram Moolenaar46fceaa2016-10-23 21:21:08 +0200333 " if there are fewer than 9 windows opened
334 :-quit " quit the previous window
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100335 :+quit " quit the next window
Bram Moolenaared32d942014-12-06 23:33:00 +0100336 :+2quit " quit the second next window
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100337<
Bram Moolenaar47e13952020-05-12 22:49:12 +0200338 When closing a help window, and this is not the only window,
339 Vim will try to restore the previous window layout, see
340 |:helpclose|.
Bram Moolenaar96f45c02019-10-26 19:53:45 +0200341
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100342:q[uit]!
343:{count}q[uit]!
344 Without {count}: Quit the current window. If {count} is
345 given quit the {count} window.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000346
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100347 If this was the last window for a buffer, any changes to that
348 buffer are lost. When quitting the last window (not counting
349 help windows), exit Vim. The contents of the buffer are lost,
350 even when 'hidden' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000351
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100352:clo[se][!]
353:{count}clo[se][!]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000354CTRL-W c *CTRL-W_c* *:clo* *:close*
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100355 Without {count}: Close the current window. If {count} is
356 given close the {count} window.
357
358 When the 'hidden' option is set, or when the buffer was
359 changed and the [!] is used, the buffer becomes hidden (unless
360 there is another window editing it).
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100361
Bram Moolenaar47e13952020-05-12 22:49:12 +0200362 When there is only one |edit-window| in the current tab page
363 and there is another tab page, this closes the current tab
364 page. |tab-page|.
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100365
Bram Moolenaar071d4272004-06-13 20:20:40 +0000366 This command fails when: *E444*
367 - There is only one window on the screen.
368 - When 'hidden' is not set, [!] is not used, the buffer has
369 changes, and there is no other window on this buffer.
370 Changes to the buffer are not written and won't get lost, so
371 this is a "safe" command.
372
373CTRL-W CTRL-C *CTRL-W_CTRL-C*
374 You might have expected that CTRL-W CTRL-C closes the current
375 window, but that does not work, because the CTRL-C cancels the
376 command.
377
378 *:hide*
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100379:hid[e]
380:{count}hid[e]
Bram Moolenaarc572da52017-08-27 16:52:01 +0200381 Without {count}: Quit the current window, unless it is the
382 last window on the screen.
383 If {count} is given quit the {count} window.
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100384
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100385 The buffer becomes hidden (unless there is another window
Bram Moolenaared32d942014-12-06 23:33:00 +0100386 editing it or 'bufhidden' is "unload", "delete" or "wipe").
387 If the window is the last one in the current tab page the tab
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100388 page is closed. |tab-page|
389
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100390 The value of 'hidden' is irrelevant for this command. Changes
391 to the buffer are not written and won't get lost, so this is a
392 "safe" command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000393
394:hid[e] {cmd} Execute {cmd} with 'hidden' is set. The previous value of
395 'hidden' is restored after {cmd} has been executed.
396 Example: >
397 :hide edit Makefile
398< This will edit "Makefile", and hide the current buffer if it
399 has any changes.
400
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100401:on[ly][!]
402:{count}on[ly][!]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000403CTRL-W o *CTRL-W_o* *E445*
404CTRL-W CTRL-O *CTRL-W_CTRL-O* *:on* *:only*
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100405 Make the current window the only one on the screen. All other
Bram Moolenaar6c391a72021-09-09 21:55:11 +0200406 windows are closed. For {count} see the `:quit` command
407 above |:count_quit|.
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100408
Bram Moolenaar071d4272004-06-13 20:20:40 +0000409 When the 'hidden' option is set, all buffers in closed windows
410 become hidden.
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100411
Bram Moolenaar071d4272004-06-13 20:20:40 +0000412 When 'hidden' is not set, and the 'autowrite' option is set,
413 modified buffers are written. Otherwise, windows that have
414 buffers that are modified are not removed, unless the [!] is
415 given, then they become hidden. But modified buffers are
416 never abandoned, so changes cannot get lost.
417
418==============================================================================
4194. Moving cursor to other windows *window-move-cursor*
420
421CTRL-W <Down> *CTRL-W_<Down>*
422CTRL-W CTRL-J *CTRL-W_CTRL-J* *CTRL-W_j*
423CTRL-W j Move cursor to Nth window below current one. Uses the cursor
424 position to select between alternatives.
425
426CTRL-W <Up> *CTRL-W_<Up>*
427CTRL-W CTRL-K *CTRL-W_CTRL-K* *CTRL-W_k*
428CTRL-W k Move cursor to Nth window above current one. Uses the cursor
429 position to select between alternatives.
430
431CTRL-W <Left> *CTRL-W_<Left>*
432CTRL-W CTRL-H *CTRL-W_CTRL-H*
433CTRL-W <BS> *CTRL-W_<BS>* *CTRL-W_h*
434CTRL-W h Move cursor to Nth window left of current one. Uses the
435 cursor position to select between alternatives.
436
437CTRL-W <Right> *CTRL-W_<Right>*
438CTRL-W CTRL-L *CTRL-W_CTRL-L* *CTRL-W_l*
439CTRL-W l Move cursor to Nth window right of current one. Uses the
440 cursor position to select between alternatives.
441
442CTRL-W w *CTRL-W_w* *CTRL-W_CTRL-W*
443CTRL-W CTRL-W Without count: move cursor to window below/right of the
444 current one. If there is no window below or right, go to
445 top-left window.
446 With count: go to Nth window (windows are numbered from
447 top-left to bottom-right). To obtain the window number see
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100448 |bufwinnr()| and |winnr()|. When N is larger than the number
449 of windows go to the last window.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000450
451 *CTRL-W_W*
452CTRL-W W Without count: move cursor to window above/left of current
453 one. If there is no window above or left, go to bottom-right
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100454 window. With count: go to Nth window, like with CTRL-W w.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000455
456CTRL-W t *CTRL-W_t* *CTRL-W_CTRL-T*
457CTRL-W CTRL-T Move cursor to top-left window.
458
459CTRL-W b *CTRL-W_b* *CTRL-W_CTRL-B*
460CTRL-W CTRL-B Move cursor to bottom-right window.
461
462CTRL-W p *CTRL-W_p* *CTRL-W_CTRL-P*
463CTRL-W CTRL-P Go to previous (last accessed) window.
464
465 *CTRL-W_P* *E441*
466CTRL-W P Go to preview window. When there is no preview window this is
467 an error.
468 {not available when compiled without the |+quickfix| feature}
469
470If Visual mode is active and the new window is not for the same buffer, the
471Visual mode is ended. If the window is on the same buffer, the cursor
472position is set to keep the same Visual area selected.
473
474 *:winc* *:wincmd*
475These commands can also be executed with ":wincmd":
476
477:[count]winc[md] {arg}
478 Like executing CTRL-W [count] {arg}. Example: >
479 :wincmd j
480< Moves to the window below the current one.
481 This command is useful when a Normal mode cannot be used (for
482 the |CursorHold| autocommand event). Or when a Normal mode
483 command is inconvenient.
484 The count can also be a window number. Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +0000485 :exe nr .. "wincmd w"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000486< This goes to window "nr".
487
488==============================================================================
4895. Moving windows around *window-moving*
490
491CTRL-W r *CTRL-W_r* *CTRL-W_CTRL-R* *E443*
492CTRL-W CTRL-R Rotate windows downwards/rightwards. The first window becomes
493 the second one, the second one becomes the third one, etc.
494 The last window becomes the first window. The cursor remains
495 in the same window.
496 This only works within the row or column of windows that the
497 current window is in.
498
499 *CTRL-W_R*
500CTRL-W R Rotate windows upwards/leftwards. The second window becomes
501 the first one, the third one becomes the second one, etc. The
502 first window becomes the last window. The cursor remains in
503 the same window.
504 This only works within the row or column of windows that the
505 current window is in.
506
507CTRL-W x *CTRL-W_x* *CTRL-W_CTRL-X*
508CTRL-W CTRL-X Without count: Exchange current window with next one. If there
509 is no next window, exchange with previous window.
510 With count: Exchange current window with Nth window (first
511 window is 1). The cursor is put in the other window.
512 When vertical and horizontal window splits are mixed, the
513 exchange is only done in the row or column of windows that the
514 current window is in.
515
516The following commands can be used to change the window layout. For example,
517when there are two vertically split windows, CTRL-W K will change that in
518horizontally split windows. CTRL-W H does it the other way around.
519
520 *CTRL-W_K*
521CTRL-W K Move the current window to be at the very top, using the full
522 width of the screen. This works like closing the current
523 window and then creating another one with ":topleft split",
524 except that the current window contents is used for the new
525 window.
526
527 *CTRL-W_J*
528CTRL-W J Move the current window to be at the very bottom, using the
529 full width of the screen. This works like closing the current
530 window and then creating another one with ":botright split",
531 except that the current window contents is used for the new
532 window.
533
534 *CTRL-W_H*
535CTRL-W H Move the current window to be at the far left, using the
536 full height of the screen. This works like closing the
537 current window and then creating another one with
Bram Moolenaar56994d22021-04-17 16:31:09 +0200538 `:vert topleft split`, except that the current window contents
Bram Moolenaar071d4272004-06-13 20:20:40 +0000539 is used for the new window.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000540
541 *CTRL-W_L*
542CTRL-W L Move the current window to be at the far right, using the full
543 height of the screen. This works like closing the
544 current window and then creating another one with
Bram Moolenaar56994d22021-04-17 16:31:09 +0200545 `:vert botright split`, except that the current window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000546 contents is used for the new window.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000547
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000548 *CTRL-W_T*
549CTRL-W T Move the current window to a new tab page. This fails if
550 there is only one window in the current tab page.
551 When a count is specified the new tab page will be opened
552 before the tab page with this index. Otherwise it comes after
553 the current tab page.
554
Bram Moolenaar071d4272004-06-13 20:20:40 +0000555==============================================================================
5566. Window resizing *window-resize*
557
558 *CTRL-W_=*
559CTRL-W = Make all windows (almost) equally high and wide, but use
560 'winheight' and 'winwidth' for the current window.
Bram Moolenaar756ec0f2007-05-05 17:59:48 +0000561 Windows with 'winfixheight' set keep their height and windows
562 with 'winfixwidth' set keep their width.
Bram Moolenaar21c3a802022-08-31 17:49:14 +0100563 To equalize only vertically (make window equally high) use
Bram Moolenaar76db9e02022-11-09 21:21:04 +0000564 `vertical wincmd =`.
Bram Moolenaar21c3a802022-08-31 17:49:14 +0100565 To equalize only horizontally (make window equally wide) use
Bram Moolenaar76db9e02022-11-09 21:21:04 +0000566 `horizontal wincmd =`.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000567
568:res[ize] -N *:res* *:resize* *CTRL-W_-*
569CTRL-W - Decrease current window height by N (default 1).
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200570 If used after |:vertical|: decrease width by N.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000571
572:res[ize] +N *CTRL-W_+*
573CTRL-W + Increase current window height by N (default 1).
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200574 If used after |:vertical|: increase width by N.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000575
576:res[ize] [N]
577CTRL-W CTRL-_ *CTRL-W_CTRL-_* *CTRL-W__*
578CTRL-W _ Set current window height to N (default: highest possible).
579
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +0100580:{winnr}res[ize] [+-]N
581 Like `:resize` above, but apply the size to window {winnr}
582 instead of the current window.
583
Bram Moolenaar071d4272004-06-13 20:20:40 +0000584z{nr}<CR> Set current window height to {nr}.
585
586 *CTRL-W_<*
587CTRL-W < Decrease current window width by N (default 1).
588
589 *CTRL-W_>*
590CTRL-W > Increase current window width by N (default 1).
591
Bram Moolenaar56994d22021-04-17 16:31:09 +0200592:vert[ical] res[ize] [N] *:vertical-resize* *CTRL-W_bar*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000593CTRL-W | Set current window width to N (default: widest possible).
594
595You can also resize a window by dragging a status line up or down with the
596mouse. Or by dragging a vertical separator line left or right. This only
597works if the version of Vim that is being used supports the mouse and the
598'mouse' option has been set to enable it.
599
600The option 'winheight' ('wh') is used to set the minimal window height of the
601current window. This option is used each time another window becomes the
602current window. If the option is '0', it is disabled. Set 'winheight' to a
603very large value, e.g., '9999', to make the current window always fill all
604available space. Set it to a reasonable value, e.g., '10', to make editing in
605the current window comfortable.
606
607The equivalent 'winwidth' ('wiw') option is used to set the minimal width of
608the current window.
609
610When the option 'equalalways' ('ea') is set, all the windows are automatically
611made the same size after splitting or closing a window. If you don't set this
612option, splitting a window will reduce the size of the current window and
613leave the other windows the same. When closing a window, the extra lines are
614given to the window above it.
615
616The 'eadirection' option limits the direction in which the 'equalalways'
617option is applied. The default "both" resizes in both directions. When the
618value is "ver" only the heights of windows are equalized. Use this when you
619have manually resized a vertically split window and want to keep this width.
620Likewise, "hor" causes only the widths of windows to be equalized.
621
622The option 'cmdheight' ('ch') is used to set the height of the command-line.
623If you are annoyed by the |hit-enter| prompt for long messages, set this
624option to 2 or 3.
625
626If there is only one window, resizing that window will also change the command
627line height. If there are several windows, resizing the current window will
628also change the height of the window below it (and sometimes the window above
629it).
630
631The minimal height and width of a window is set with 'winminheight' and
632'winminwidth'. These are hard values, a window will never become smaller.
633
634==============================================================================
6357. Argument and buffer list commands *buffer-list*
636
637 args list buffer list meaning ~
6381. :[N]argument [N] 11. :[N]buffer [N] to arg/buf N
6392. :[N]next [file ..] 12. :[N]bnext [N] to Nth next arg/buf
6403. :[N]Next [N] 13. :[N]bNext [N] to Nth previous arg/buf
6414. :[N]previous [N] 14. :[N]bprevious [N] to Nth previous arg/buf
6425. :rewind / :first 15. :brewind / :bfirst to first arg/buf
6436. :last 16. :blast to last arg/buf
6447. :all 17. :ball edit all args/buffers
645 18. :unhide edit all loaded buffers
646 19. :[N]bmod [N] to Nth modified buf
647
648 split & args list split & buffer list meaning ~
64921. :[N]sargument [N] 31. :[N]sbuffer [N] split + to arg/buf N
65022. :[N]snext [file ..] 32. :[N]sbnext [N] split + to Nth next arg/buf
65123. :[N]sNext [N] 33. :[N]sbNext [N] split + to Nth previous arg/buf
65224. :[N]sprevious [N] 34. :[N]sbprevious [N] split + to Nth previous arg/buf
65325. :srewind / :sfirst 35. :sbrewind / :sbfirst split + to first arg/buf
65426. :slast 36. :sblast split + to last arg/buf
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +000065527. :sall 37. :sball edit all args/buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +0000656 38. :sunhide edit all loaded buffers
657 39. :[N]sbmod [N] split + to Nth modified buf
658
65940. :args list of arguments
66041. :buffers list of buffers
661
662The meaning of [N] depends on the command:
Bram Moolenaar24a98a02017-09-27 22:23:55 +0200663 [N] is the number of buffers to go forward/backward on 2/12/22/32,
664 3/13/23/33, and 4/14/24/34
Bram Moolenaar071d4272004-06-13 20:20:40 +0000665 [N] is an argument number, defaulting to current argument, for 1 and 21
666 [N] is a buffer number, defaulting to current buffer, for 11 and 31
667 [N] is a count for 19 and 39
668
669Note: ":next" is an exception, because it must accept a list of file names
670for compatibility with Vi.
671
672
673The argument list and multiple windows
674--------------------------------------
675
676The current position in the argument list can be different for each window.
677Remember that when doing ":e file", the position in the argument list stays
678the same, but you are not editing the file at that position. To indicate
679this, the file message (and the title, if you have one) shows
680"(file (N) of M)", where "(N)" is the current position in the file list, and
681"M" the number of files in the file list.
682
683All the entries in the argument list are added to the buffer list. Thus, you
684can also get to them with the buffer list commands, like ":bnext".
685
686:[N]al[l][!] [N] *:al* *:all* *:sal* *:sall*
687:[N]sal[l][!] [N]
688 Rearrange the screen to open one window for each argument.
689 All other windows are closed. When a count is given, this is
690 the maximum number of windows to open.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +0000691 With the |:tab| modifier open a tab page for each argument.
692 When there are more arguments than 'tabpagemax' further ones
693 become split windows in the last tab page.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000694 When the 'hidden' option is set, all buffers in closed windows
695 become hidden.
696 When 'hidden' is not set, and the 'autowrite' option is set,
697 modified buffers are written. Otherwise, windows that have
698 buffers that are modified are not removed, unless the [!] is
699 given, then they become hidden. But modified buffers are
700 never abandoned, so changes cannot get lost.
701 [N] is the maximum number of windows to open. 'winheight'
702 also limits the number of windows opened ('winwidth' if
703 |:vertical| was prepended).
704 Buf/Win Enter/Leave autocommands are not executed for the new
705 windows here, that's only done when they are really entered.
Bram Moolenaar54775062019-07-31 21:07:14 +0200706 If autocommands change the window layout while this command is
707 busy an error will be given. *E249*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000708
709:[N]sa[rgument][!] [++opt] [+cmd] [N] *:sa* *:sargument*
710 Short for ":split | argument [N]": split window and go to Nth
711 argument. But when there is no such argument, the window is
712 not split. Also see |++opt| and |+cmd|.
713
714:[N]sn[ext][!] [++opt] [+cmd] [file ..] *:sn* *:snext*
715 Short for ":split | [N]next": split window and go to Nth next
716 argument. But when there is no next file, the window is not
717 split. Also see |++opt| and |+cmd|.
718
719:[N]spr[evious][!] [++opt] [+cmd] [N] *:spr* *:sprevious*
720:[N]sN[ext][!] [++opt] [+cmd] [N] *:sN* *:sNext*
721 Short for ":split | [N]Next": split window and go to Nth
722 previous argument. But when there is no previous file, the
723 window is not split. Also see |++opt| and |+cmd|.
724
725 *:sre* *:srewind*
726:sre[wind][!] [++opt] [+cmd]
727 Short for ":split | rewind": split window and go to first
728 argument. But when there is no argument list, the window is
729 not split. Also see |++opt| and |+cmd|.
730
731 *:sfir* *:sfirst*
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000732:sfir[st] [++opt] [+cmd]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000733 Same as ":srewind".
734
735 *:sla* *:slast*
736:sla[st][!] [++opt] [+cmd]
737 Short for ":split | last": split window and go to last
738 argument. But when there is no argument list, the window is
739 not split. Also see |++opt| and |+cmd|.
740
741 *:dr* *:drop*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000742:dr[op] [++opt] [+cmd] {file} ..
Bram Moolenaar071d4272004-06-13 20:20:40 +0000743 Edit the first {file} in a window.
744 - If the file is already open in a window change to that
745 window.
746 - If the file is not open in a window edit the file in the
747 current window. If the current buffer can't be |abandon|ed,
748 the window is split first.
Bram Moolenaar51628222016-12-01 23:03:28 +0100749 - Windows that are not in the argument list or are not full
750 width will be closed if possible.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000751 The |argument-list| is set, like with the |:next| command.
752 The purpose of this command is that it can be used from a
753 program that wants Vim to edit another file, e.g., a debugger.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000754 When using the |:tab| modifier each argument is opened in a
755 tab page. The last window is used if it's empty.
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000756 Also see |++opt| and |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000757
758==============================================================================
7598. Do a command in all buffers or windows *list-repeat*
760
761 *:windo*
Bram Moolenaara162bc52015-01-07 16:54:21 +0100762:[range]windo {cmd} Execute {cmd} in each window or if [range] is given
763 only in windows for which the window number lies in
764 the [range]. It works like doing this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000765 CTRL-W t
766 :{cmd}
767 CTRL-W w
768 :{cmd}
769 etc.
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000770< This only operates in the current tab page.
Bram Moolenaar7e8fd632006-02-18 22:14:51 +0000771 When an error is detected on one window, further
Bram Moolenaar071d4272004-06-13 20:20:40 +0000772 windows will not be visited.
773 The last window (or where an error occurred) becomes
774 the current window.
775 {cmd} can contain '|' to concatenate several commands.
776 {cmd} must not open or close windows or reorder them.
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200777
Bram Moolenaaraa23b372015-09-08 18:46:31 +0200778 Also see |:tabdo|, |:argdo|, |:bufdo|, |:cdo|, |:ldo|,
779 |:cfdo| and |:lfdo|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000780
781 *:bufdo*
Bram Moolenaara162bc52015-01-07 16:54:21 +0100782:[range]bufdo[!] {cmd} Execute {cmd} in each buffer in the buffer list or if
783 [range] is given only for buffers for which their
Bram Moolenaar681baaf2016-02-04 20:57:07 +0100784 buffer number is in the [range]. It works like doing
Bram Moolenaara162bc52015-01-07 16:54:21 +0100785 this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000786 :bfirst
787 :{cmd}
788 :bnext
789 :{cmd}
790 etc.
791< When the current file can't be |abandon|ed and the [!]
792 is not present, the command fails.
793 When an error is detected on one buffer, further
794 buffers will not be visited.
795 Unlisted buffers are skipped.
796 The last buffer (or where an error occurred) becomes
797 the current buffer.
798 {cmd} can contain '|' to concatenate several commands.
799 {cmd} must not delete buffers or add buffers to the
800 buffer list.
801 Note: While this command is executing, the Syntax
802 autocommand event is disabled by adding it to
803 'eventignore'. This considerably speeds up editing
804 each buffer.
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200805
Bram Moolenaaraa23b372015-09-08 18:46:31 +0200806 Also see |:tabdo|, |:argdo|, |:windo|, |:cdo|, |:ldo|,
807 |:cfdo| and |:lfdo|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000808
809Examples: >
810
Bram Moolenaardad44732021-03-31 20:07:33 +0200811 :windo set nolist foldcolumn=0 | normal! zn
Bram Moolenaar071d4272004-06-13 20:20:40 +0000812
813This resets the 'list' option and disables folding in all windows. >
814
815 :bufdo set fileencoding= | update
816
817This resets the 'fileencoding' in each buffer and writes it if this changed
818the buffer. The result is that all buffers will use the 'encoding' encoding
Bram Moolenaardad44732021-03-31 20:07:33 +0200819(if conversion succeeds).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000820
821==============================================================================
8229. Tag or file name under the cursor *window-tag*
823
824 *:sta* *:stag*
825:sta[g][!] [tagname]
826 Does ":tag[!] [tagname]" and splits the window for the found
827 tag. See also |:tag|.
828
829CTRL-W ] *CTRL-W_]* *CTRL-W_CTRL-]*
830CTRL-W CTRL-] Split current window in two. Use identifier under cursor as a
Bram Moolenaar3a991dd2014-10-02 01:41:41 +0200831 tag and jump to it in the new upper window.
832 In Visual mode uses the Visually selected text as a tag.
833 Make new window N high.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000834
835 *CTRL-W_g]*
836CTRL-W g ] Split current window in two. Use identifier under cursor as a
837 tag and perform ":tselect" on it in the new upper window.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +0200838 In Visual mode uses the Visually selected text as a tag.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000839 Make new window N high.
840
841 *CTRL-W_g_CTRL-]*
842CTRL-W g CTRL-] Split current window in two. Use identifier under cursor as a
Bram Moolenaar3a991dd2014-10-02 01:41:41 +0200843 tag and perform ":tjump" on it in the new upper window.
844 In Visual mode uses the Visually selected text as a tag.
845 Make new window N high.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000846
847CTRL-W f *CTRL-W_f* *CTRL-W_CTRL-F*
848CTRL-W CTRL-F Split current window in two. Edit file name under cursor.
Bram Moolenaar8dff8182006-04-06 20:18:50 +0000849 Like ":split gf", but window isn't split if the file does not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000850 exist.
851 Uses the 'path' variable as a list of directory names where to
852 look for the file. Also the path for current file is
853 used to search for the file name.
854 If the name is a hypertext link that looks like
855 "type://machine/path", only "/path" is used.
856 If a count is given, the count'th matching file is edited.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000857
Bram Moolenaard1f56e62006-02-22 21:25:37 +0000858CTRL-W F *CTRL-W_F*
859 Split current window in two. Edit file name under cursor and
860 jump to the line number following the file name. See |gF| for
861 details on how the line number is obtained.
862
Bram Moolenaar8dff8182006-04-06 20:18:50 +0000863CTRL-W gf *CTRL-W_gf*
864 Open a new tab page and edit the file name under the cursor.
865 Like "tab split" and "gf", but the new tab page isn't created
866 if the file does not exist.
Bram Moolenaar8dff8182006-04-06 20:18:50 +0000867
Bram Moolenaar57657d82006-04-21 22:12:41 +0000868CTRL-W gF *CTRL-W_gF*
869 Open a new tab page and edit the file name under the cursor
870 and jump to the line number following the file name. Like
871 "tab split" and "gF", but the new tab page isn't created if
872 the file does not exist.
Bram Moolenaar57657d82006-04-21 22:12:41 +0000873
Bram Moolenaar26967612019-03-17 17:13:16 +0100874CTRL-W gt *CTRL-W_gt*
875 Go to next tab page, same as `gt`.
876
877CTRL-W gT *CTRL-W_gT*
878 Go to previous tab page, same as `gT`.
879
Bram Moolenaar071d4272004-06-13 20:20:40 +0000880Also see |CTRL-W_CTRL-I|: open window for an included file that includes
881the keyword under the cursor.
882
883==============================================================================
88410. The preview window *preview-window*
885
886The preview window is a special window to show (preview) another file. It is
887normally a small window used to show an include file or definition of a
888function.
889{not available when compiled without the |+quickfix| feature}
890
Bram Moolenaarc270d802006-03-11 21:29:41 +0000891There can be only one preview window (per tab page). It is created with one
892of the commands below. The 'previewheight' option can be set to specify the
893height of the preview window when it's opened. The 'previewwindow' option is
894set in the preview window to be able to recognize it. The 'winfixheight'
895option is set to have it keep the same height when opening/closing other
896windows.
Bram Moolenaar79648732019-07-18 21:43:07 +0200897 *preview-popup*
898Alternatively, a popup window can be used by setting the 'previewpopup'
899option. When set, it overrules the 'previewwindow' and 'previewheight'
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100900settings. The option is a comma-separated list of values:
Bram Moolenaar79648732019-07-18 21:43:07 +0200901 height maximum height of the popup
Bram Moolenaar85850f32019-07-19 22:05:51 +0200902 width maximum width of the popup
Bram Moolenaar06fe74a2019-08-31 16:20:32 +0200903 highlight highlight group of the popup (default is Pmenu)
Bram Moolenaar79648732019-07-18 21:43:07 +0200904Example: >
905 :set previewpopup=height:10,width:60
Bram Moolenaar2debf1c2019-08-04 20:44:19 +0200906
907A few peculiarities:
908- If the file is in a buffer already, it will be re-used. This will allow for
909 editing the file while it's visible in the popup window.
910- No ATTENTION dialog will be used, since you can't edit the file in the popup
911 window. However, if you later open the same buffer in a normal window, you
912 may not notice it's edited elsewhere. And when then using ":edit" to
913 trigger the ATTENTION and responding "A" for Abort, the preview window will
914 become empty.
915
Bram Moolenaar071d4272004-06-13 20:20:40 +0000916 *:pta* *:ptag*
917:pta[g][!] [tagname]
918 Does ":tag[!] [tagname]" and shows the found tag in a
919 "Preview" window without changing the current buffer or cursor
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000920 position. If a "Preview" window already exists, it is re-used
Bram Moolenaar071d4272004-06-13 20:20:40 +0000921 (like a help window is). If a new one is opened,
922 'previewheight' is used for the height of the window. See
923 also |:tag|.
924 See below for an example. |CursorHold-example|
925 Small difference from |:tag|: When [tagname] is equal to the
926 already displayed tag, the position in the matching tag list
927 is not reset. This makes the CursorHold example work after a
928 |:ptnext|.
929
930CTRL-W z *CTRL-W_z*
931CTRL-W CTRL-Z *CTRL-W_CTRL-Z* *:pc* *:pclose*
932:pc[lose][!] Close any "Preview" window currently open. When the 'hidden'
933 option is set, or when the buffer was changed and the [!] is
934 used, the buffer becomes hidden (unless there is another
935 window editing it). The command fails if any "Preview" buffer
936 cannot be closed. See also |:close|.
937
938 *:pp* *:ppop*
939:[count]pp[op][!]
940 Does ":[count]pop[!]" in the preview window. See |:pop| and
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200941 |:ptag|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000942
943CTRL-W } *CTRL-W_}*
944 Use identifier under cursor as a tag and perform a :ptag on
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000945 it. Make the new Preview window (if required) N high. If N is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000946 not given, 'previewheight' is used.
947
948CTRL-W g } *CTRL-W_g}*
949 Use identifier under cursor as a tag and perform a :ptjump on
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000950 it. Make the new Preview window (if required) N high. If N is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000951 not given, 'previewheight' is used.
952
953 *:ped* *:pedit*
954:ped[it][!] [++opt] [+cmd] {file}
955 Edit {file} in the preview window. The preview window is
956 opened like with |:ptag|. The current window and cursor
957 position isn't changed. Useful example: >
958 :pedit +/fputc /usr/include/stdio.h
959<
960 *:ps* *:psearch*
961:[range]ps[earch][!] [count] [/]pattern[/]
962 Works like |:ijump| but shows the found match in the preview
963 window. The preview window is opened like with |:ptag|. The
964 current window and cursor position isn't changed. Useful
965 example: >
966 :psearch popen
967< Like with the |:ptag| command, you can use this to
968 automatically show information about the word under the
969 cursor. This is less clever than using |:ptag|, but you don't
970 need a tags file and it will also find matches in system
971 include files. Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +0000972 :au! CursorHold *.[ch] ++nested exe "silent! psearch " .. expand("<cword>")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000973< Warning: This can be slow.
974
975Example *CursorHold-example* >
976
Bram Moolenaarc51cf032022-02-26 12:25:45 +0000977 :au! CursorHold *.[ch] ++nested exe "silent! ptag " .. expand("<cword>")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000978
979This will cause a ":ptag" to be executed for the keyword under the cursor,
980when the cursor hasn't moved for the time set with 'updatetime'. The "nested"
981makes other autocommands be executed, so that syntax highlighting works in the
982preview window. The "silent!" avoids an error message when the tag could not
983be found. Also see |CursorHold|. To disable this again: >
984
985 :au! CursorHold
986
987A nice addition is to highlight the found tag, avoid the ":ptag" when there
988is no word under the cursor, and a few other things: >
989
Bram Moolenaar1c6737b2020-09-07 22:18:52 +0200990 :au! CursorHold *.[ch] ++nested call PreviewWord()
Bram Moolenaar071d4272004-06-13 20:20:40 +0000991 :func PreviewWord()
992 : if &previewwindow " don't do this in the preview window
993 : return
994 : endif
995 : let w = expand("<cword>") " get the word under cursor
996 : if w =~ '\a' " if the word contains a letter
997 :
998 : " Delete any existing highlight before showing another tag
999 : silent! wincmd P " jump to preview window
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001000 : if &previewwindow " if we really get there...
Bram Moolenaar071d4272004-06-13 20:20:40 +00001001 : match none " delete existing highlight
1002 : wincmd p " back to old window
1003 : endif
1004 :
1005 : " Try displaying a matching tag for the word under the cursor
1006 : try
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001007 : exe "ptag " .. w
Bram Moolenaar071d4272004-06-13 20:20:40 +00001008 : catch
1009 : return
1010 : endtry
1011 :
1012 : silent! wincmd P " jump to preview window
1013 : if &previewwindow " if we really get there...
1014 : if has("folding")
1015 : silent! .foldopen " don't want a closed fold
1016 : endif
1017 : call search("$", "b") " to end of previous line
1018 : let w = substitute(w, '\\', '\\\\', "")
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001019 : call search('\<\V' .. w .. '\>') " position cursor on match
Bram Moolenaar071d4272004-06-13 20:20:40 +00001020 : " Add a match highlight to the word at this position
1021 : hi previewWord term=bold ctermbg=green guibg=green
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001022 : exe 'match previewWord "\%' .. line(".") .. 'l\%' .. col(".") .. 'c\k*"'
Bram Moolenaar071d4272004-06-13 20:20:40 +00001023 : wincmd p " back to old window
1024 : endif
1025 : endif
1026 :endfun
1027
1028==============================================================================
102911. Using hidden buffers *buffer-hidden*
1030
1031A hidden buffer is not displayed in a window, but is still loaded into memory.
1032This makes it possible to jump from file to file, without the need to read or
1033write the file every time you get another buffer in a window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001034
1035 *:buffer-!*
1036If the option 'hidden' ('hid') is set, abandoned buffers are kept for all
1037commands that start editing another file: ":edit", ":next", ":tag", etc. The
1038commands that move through the buffer list sometimes make the current buffer
1039hidden although the 'hidden' option is not set. This happens when a buffer is
1040modified, but is forced (with '!') to be removed from a window, and
1041'autowrite' is off or the buffer can't be written.
1042
1043You can make a hidden buffer not hidden by starting to edit it with any
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01001044command, or by deleting it with the ":bdelete" command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001045
1046The 'hidden' is global, it is used for all buffers. The 'bufhidden' option
1047can be used to make an exception for a specific buffer. It can take these
1048values:
1049 <empty> Use the value of 'hidden'.
1050 hide Hide this buffer, also when 'hidden' is not set.
1051 unload Don't hide but unload this buffer, also when 'hidden'
1052 is set.
1053 delete Delete the buffer.
1054
1055 *hidden-quit*
1056When you try to quit Vim while there is a hidden, modified buffer, you will
1057get an error message and Vim will make that buffer the current buffer. You
1058can then decide to write this buffer (":wq") or quit without writing (":q!").
1059Be careful: there may be more hidden, modified buffers!
1060
1061A buffer can also be unlisted. This means it exists, but it is not in the
1062list of buffers. |unlisted-buffer|
1063
1064
Bram Moolenaard51cb702015-07-21 15:03:06 +02001065:files[!] [flags] *:files*
1066:buffers[!] [flags] *:buffers* *:ls*
1067:ls[!] [flags]
1068 Show all buffers. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001069
Bram Moolenaar97d62492012-11-15 21:28:22 +01001070 1 #h "/test/text" line 1 ~
1071 2u "asdf" line 0 ~
1072 3 %a + "version.c" line 1 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +00001073
1074 When the [!] is included the list will show unlisted buffers
1075 (the term "unlisted" is a bit confusing then...).
1076
1077 Each buffer has a unique number. That number will not change,
Bram Moolenaar0122c402015-02-03 19:13:34 +01001078 thus you can always go to a specific buffer with ":buffer N"
1079 or "N CTRL-^", where N is the buffer number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001080
Bram Moolenaarc6896e22019-05-30 22:32:34 +02001081 For the file name these special values are used:
1082 [Prompt] |prompt-buffer|
1083 [Popup] buffer of a |popup-window|
1084 [Scratch] 'buftype' is "nofile"
1085 [No Name] no file name specified
1086 For a |terminal-window| buffer the status is used.
1087
Bram Moolenaar071d4272004-06-13 20:20:40 +00001088 Indicators (chars in the same column are mutually exclusive):
1089 u an unlisted buffer (only displayed when [!] is used)
1090 |unlisted-buffer|
1091 % the buffer in the current window
1092 # the alternate buffer for ":e #" and CTRL-^
1093 a an active buffer: it is loaded and visible
1094 h a hidden buffer: It is loaded, but currently not
1095 displayed in a window |hidden-buffer|
1096 - a buffer with 'modifiable' off
1097 = a readonly buffer
Bram Moolenaarc572da52017-08-27 16:52:01 +02001098 R a terminal buffer with a running job
1099 F a terminal buffer with a finished job
Bram Moolenaar37c64c72017-09-19 22:06:03 +02001100 ? a terminal buffer without a job: `:terminal NONE`
Bram Moolenaar071d4272004-06-13 20:20:40 +00001101 + a modified buffer
1102 x a buffer with read errors
1103
Bram Moolenaard51cb702015-07-21 15:03:06 +02001104 [flags] can be a combination of the following characters,
1105 which restrict the buffers to be listed:
1106 + modified buffers
1107 - buffers with 'modifiable' off
1108 = readonly buffers
1109 a active buffers
Bram Moolenaare392eb42015-11-19 20:38:09 +01001110 u unlisted buffers (overrides the "!")
Bram Moolenaard51cb702015-07-21 15:03:06 +02001111 h hidden buffers
1112 x buffers with a read error
1113 % current buffer
1114 # alternate buffer
Bram Moolenaar0751f512018-03-29 16:37:16 +02001115 R terminal buffers with a running job
1116 F terminal buffers with a finished job
1117 ? terminal buffers without a job: `:terminal NONE`
Bram Moolenaar52410572019-10-27 05:12:45 +01001118 t show time last used and sort buffers
Bram Moolenaard51cb702015-07-21 15:03:06 +02001119 Combining flags means they are "and"ed together, e.g.:
1120 h+ hidden buffers which are modified
1121 a+ active buffers which are modified
1122
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02001123 When using |:filter| the pattern is matched against the
1124 displayed buffer name, e.g.: >
1125 filter /\.vim/ ls
1126<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001127 *:bad* *:badd*
1128:bad[d] [+lnum] {fname}
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02001129 Add file name {fname} to the buffer list, without loading it,
1130 if it wasn't listed yet. If the buffer was previously
1131 deleted, not wiped, it will be made listed again.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001132 If "lnum" is specified, the cursor will be positioned at that
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001133 line when the buffer is first entered. Note that other
Bram Moolenaar071d4272004-06-13 20:20:40 +00001134 commands after the + will be ignored.
1135
Bram Moolenaar59d8e562020-11-07 18:41:10 +01001136 *:balt*
1137:balt [+lnum] {fname}
1138 Like `:badd` and also set the alternate file for the current
1139 window to {fname}.
1140
Bram Moolenaar071d4272004-06-13 20:20:40 +00001141:[N]bd[elete][!] *:bd* *:bdel* *:bdelete* *E516*
1142:bd[elete][!] [N]
1143 Unload buffer [N] (default: current buffer) and delete it from
1144 the buffer list. If the buffer was changed, this fails,
1145 unless when [!] is specified, in which case changes are lost.
1146 The file remains unaffected. Any windows for this buffer are
1147 closed. If buffer [N] is the current buffer, another buffer
1148 will be displayed instead. This is the most recent entry in
1149 the jump list that points into a loaded buffer.
1150 Actually, the buffer isn't completely deleted, it is removed
1151 from the buffer list |unlisted-buffer| and option values,
1152 variables and mappings/abbreviations for the buffer are
Bram Moolenaar4d84d932014-11-30 14:50:16 +01001153 cleared. Examples: >
1154 :.,$-bdelete " delete buffers from the current one to
1155 " last but one
1156 :%bdelete " delete all buffers
1157<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001158
1159:bdelete[!] {bufname} *E93* *E94*
Bram Moolenaar15142e22018-04-30 22:19:58 +02001160 Like ":bdelete[!] [N]", but buffer given by name, see
1161 |{bufname}|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001162
1163:bdelete[!] N1 N2 ...
1164 Do ":bdelete[!]" for buffer N1, N2, etc. The arguments can be
1165 buffer numbers or buffer names (but not buffer names that are
1166 a number). Insert a backslash before a space in a buffer
1167 name.
1168
1169:N,Mbdelete[!] Do ":bdelete[!]" for all buffers in the range N to M
1170 |inclusive|.
1171
1172:[N]bw[ipeout][!] *:bw* *:bwipe* *:bwipeout* *E517*
1173:bw[ipeout][!] {bufname}
1174:N,Mbw[ipeout][!]
1175:bw[ipeout][!] N1 N2 ...
Bram Moolenaardf1bdc92006-02-23 21:32:16 +00001176 Like |:bdelete|, but really delete the buffer. Everything
1177 related to the buffer is lost. All marks in this buffer
1178 become invalid, option settings are lost, etc. Don't use this
Bram Moolenaar4d84d932014-11-30 14:50:16 +01001179 unless you know what you are doing. Examples: >
1180 :.+,$bwipeout " wipe out all buffers after the current
1181 " one
1182 :%bwipeout " wipe out all buffers
1183<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001184
1185:[N]bun[load][!] *:bun* *:bunload* *E515*
1186:bun[load][!] [N]
1187 Unload buffer [N] (default: current buffer). The memory
1188 allocated for this buffer will be freed. The buffer remains
1189 in the buffer list.
1190 If the buffer was changed, this fails, unless when [!] is
1191 specified, in which case the changes are lost.
1192 Any windows for this buffer are closed. If buffer [N] is the
1193 current buffer, another buffer will be displayed instead.
1194 This is the most recent entry in the jump list that points
1195 into a loaded buffer.
1196
1197:bunload[!] {bufname}
Bram Moolenaar15142e22018-04-30 22:19:58 +02001198 Like ":bunload[!] [N]", but buffer given by name.
1199 Also see |{bufname}|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001200
1201:N,Mbunload[!] Do ":bunload[!]" for all buffers in the range N to M
1202 |inclusive|.
1203
1204:bunload[!] N1 N2 ...
1205 Do ":bunload[!]" for buffer N1, N2, etc. The arguments can be
1206 buffer numbers or buffer names (but not buffer names that are
1207 a number). Insert a backslash before a space in a buffer
1208 name.
1209
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001210:[N]b[uffer][!] [+cmd] [N] *:b* *:bu* *:buf* *:buffer* *E86*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001211 Edit buffer [N] from the buffer list. If [N] is not given,
1212 the current buffer remains being edited. See |:buffer-!| for
1213 [!]. This will also edit a buffer that is not in the buffer
1214 list, without setting the 'buflisted' flag.
Bram Moolenaar47003982021-12-05 21:54:04 +00001215 The notation with single quotes does not work here,
1216 `:buf 12'345'` uses 12'345 as a buffer name.
Bram Moolenaar12969c02015-09-08 23:36:10 +02001217 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001218
Bram Moolenaar15142e22018-04-30 22:19:58 +02001219:[N]b[uffer][!] [+cmd] {bufname} *{bufname}*
1220 Edit buffer for {bufname} from the buffer list. A partial
1221 name also works, so long as it is unique in the list of
1222 buffers.
1223 Note that a buffer whose name is a number cannot be referenced
1224 by that name; use the buffer number instead.
1225 Insert a backslash before a space in a buffer name.
1226 See |:buffer-!| for [!].
1227 This will also edit a buffer that is not in the buffer list,
1228 without setting the 'buflisted' flag.
Bram Moolenaar12969c02015-09-08 23:36:10 +02001229 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001230
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001231:[N]sb[uffer] [+cmd] [N] *:sb* *:sbuffer*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001232 Split window and edit buffer [N] from the buffer list. If [N]
1233 is not given, the current buffer is edited. Respects the
1234 "useopen" setting of 'switchbuf' when splitting. This will
1235 also edit a buffer that is not in the buffer list, without
1236 setting the 'buflisted' flag.
Bram Moolenaar12969c02015-09-08 23:36:10 +02001237 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001238
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001239:[N]sb[uffer] [+cmd] {bufname}
Bram Moolenaar15142e22018-04-30 22:19:58 +02001240 Split window and edit buffer for |{bufname}| from the buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001241 list. This will also edit a buffer that is not in the buffer
1242 list, without setting the 'buflisted' flag.
Bram Moolenaar280f1262006-01-30 00:14:18 +00001243 Note: If what you want to do is split the buffer, make a copy
1244 under another name, you can do it this way: >
1245 :w foobar | sp #
Bram Moolenaar12969c02015-09-08 23:36:10 +02001246< Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001247
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001248:[N]bn[ext][!] [+cmd] [N] *:bn* *:bnext* *E87*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001249 Go to [N]th next buffer in buffer list. [N] defaults to one.
1250 Wraps around the end of the buffer list.
1251 See |:buffer-!| for [!].
Bram Moolenaar12969c02015-09-08 23:36:10 +02001252 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001253 If you are in a help buffer, this takes you to the next help
1254 buffer (if there is one). Similarly, if you are in a normal
1255 (non-help) buffer, this takes you to the next normal buffer.
1256 This is so that if you have invoked help, it doesn't get in
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001257 the way when you're browsing code/text buffers. The next three
Bram Moolenaar071d4272004-06-13 20:20:40 +00001258 commands also work like this.
1259
1260 *:sbn* *:sbnext*
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001261:[N]sbn[ext] [+cmd] [N]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001262 Split window and go to [N]th next buffer in buffer list.
1263 Wraps around the end of the buffer list. Uses 'switchbuf'
Bram Moolenaar12969c02015-09-08 23:36:10 +02001264 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001265
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001266:[N]bN[ext][!] [+cmd] [N] *:bN* *:bNext* *:bp* *:bprevious* *E88*
1267:[N]bp[revious][!] [+cmd] [N]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001268 Go to [N]th previous buffer in buffer list. [N] defaults to
1269 one. Wraps around the start of the buffer list.
1270 See |:buffer-!| for [!] and 'switchbuf'.
Bram Moolenaar12969c02015-09-08 23:36:10 +02001271 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001272
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001273:[N]sbN[ext] [+cmd] [N] *:sbN* *:sbNext* *:sbp* *:sbprevious*
1274:[N]sbp[revious] [+cmd] [N]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001275 Split window and go to [N]th previous buffer in buffer list.
1276 Wraps around the start of the buffer list.
1277 Uses 'switchbuf'.
Bram Moolenaar12969c02015-09-08 23:36:10 +02001278 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001279
Bram Moolenaar61da1bf2019-06-06 12:14:49 +02001280:br[ewind][!] [+cmd] *:br* *:bre* *:brewind*
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001281 Go to first buffer in buffer list. If the buffer list is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001282 empty, go to the first unlisted buffer.
1283 See |:buffer-!| for [!].
1284
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001285:bf[irst] [+cmd] *:bf* *:bfirst*
1286 Same as |:brewind|.
1287 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001288
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001289:sbr[ewind] [+cmd] *:sbr* *:sbrewind*
1290 Split window and go to first buffer in buffer list. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001291 buffer list is empty, go to the first unlisted buffer.
1292 Respects the 'switchbuf' option.
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001293 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001294
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001295:sbf[irst] [+cmd] *:sbf* *:sbfirst*
1296 Same as ":sbrewind".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001297
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001298:bl[ast][!] [+cmd] *:bl* *:blast*
1299 Go to last buffer in buffer list. If the buffer list is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001300 empty, go to the last unlisted buffer.
1301 See |:buffer-!| for [!].
1302
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001303:sbl[ast] [+cmd] *:sbl* *:sblast*
1304 Split window and go to last buffer in buffer list. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001305 buffer list is empty, go to the last unlisted buffer.
1306 Respects 'switchbuf' option.
1307
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001308:[N]bm[odified][!] [+cmd] [N] *:bm* *:bmodified* *E84*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001309 Go to [N]th next modified buffer. Note: this command also
1310 finds unlisted buffers. If there is no modified buffer the
1311 command fails.
1312
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001313:[N]sbm[odified] [+cmd] [N] *:sbm* *:sbmodified*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001314 Split window and go to [N]th next modified buffer.
1315 Respects 'switchbuf' option.
1316 Note: this command also finds buffers not in the buffer list.
1317
1318:[N]unh[ide] [N] *:unh* *:unhide* *:sun* *:sunhide*
1319:[N]sun[hide] [N]
1320 Rearrange the screen to open one window for each loaded buffer
1321 in the buffer list. When a count is given, this is the
1322 maximum number of windows to open.
1323
1324:[N]ba[ll] [N] *:ba* *:ball* *:sba* *:sball*
1325:[N]sba[ll] [N] Rearrange the screen to open one window for each buffer in
1326 the buffer list. When a count is given, this is the maximum
1327 number of windows to open. 'winheight' also limits the number
1328 of windows opened ('winwidth' if |:vertical| was prepended).
1329 Buf/Win Enter/Leave autocommands are not executed for the new
1330 windows here, that's only done when they are really entered.
Bram Moolenaar756ec0f2007-05-05 17:59:48 +00001331 When the |:tab| modifier is used new windows are opened in a
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00001332 new tab, up to 'tabpagemax'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001333
1334Note: All the commands above that start editing another buffer, keep the
1335'readonly' flag as it was. This differs from the ":edit" command, which sets
1336the 'readonly' flag each time the file is read.
1337
1338==============================================================================
133912. Special kinds of buffers *special-buffers*
1340
1341Instead of containing the text of a file, buffers can also be used for other
1342purposes. A few options can be set to change the behavior of a buffer:
1343 'bufhidden' what happens when the buffer is no longer displayed
1344 in a window.
1345 'buftype' what kind of a buffer this is
1346 'swapfile' whether the buffer will have a swap file
1347 'buflisted' buffer shows up in the buffer list
1348
1349A few useful kinds of a buffer:
1350
Bram Moolenaar280f1262006-01-30 00:14:18 +00001351quickfix Used to contain the error list or the location list. See
1352 |:cwindow| and |:lwindow|. This command sets the 'buftype'
1353 option to "quickfix". You are not supposed to change this!
1354 'swapfile' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001355
1356help Contains a help file. Will only be created with the |:help|
1357 command. The flag that indicates a help buffer is internal
1358 and can't be changed. The 'buflisted' option will be reset
1359 for a help buffer.
1360
Bram Moolenaarb6e0ec62017-07-23 22:12:20 +02001361terminal A terminal window buffer, see |terminal|. The contents cannot
1362 be read or changed until the job ends.
1363
Bram Moolenaar677ee682005-01-27 14:41:15 +00001364directory Displays directory contents. Can be used by a file explorer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001365 plugin. The buffer is created with these settings: >
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001366 :setlocal buftype=nowrite
1367 :setlocal bufhidden=delete
1368 :setlocal noswapfile
Bram Moolenaar071d4272004-06-13 20:20:40 +00001369< The buffer name is the name of the directory and is adjusted
1370 when using the |:cd| command.
1371
Yegappan Lakshmanand1a8d652021-11-03 21:56:45 +00001372 *scratch-buffer*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001373scratch Contains text that can be discarded at any time. It is kept
1374 when closing the window, it must be deleted explicitly.
1375 Settings: >
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001376 :setlocal buftype=nofile
1377 :setlocal bufhidden=hide
1378 :setlocal noswapfile
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001379< The buffer name can be used to identify the buffer, if you
1380 give it a meaningful name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001381
1382 *unlisted-buffer*
1383unlisted The buffer is not in the buffer list. It is not used for
1384 normal editing, but to show a help file, remember a file name
1385 or marks. The ":bdelete" command will also set this option,
1386 thus it doesn't completely delete the buffer. Settings: >
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001387 :setlocal nobuflisted
Bram Moolenaar071d4272004-06-13 20:20:40 +00001388<
1389
Bram Moolenaard473c8c2018-08-11 18:00:22 +02001390 vim:tw=78:ts=8:noet:ft=help:norl: