blob: 13f648f1919186e08645a4106266d41f96371921 [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,
259 it will be split vertically.
Bram Moolenaar756ec0f2007-05-05 17:59:48 +0000260 Doesn't work for |:execute| and |:normal|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000261
262:lefta[bove] {cmd} *:lefta* *:leftabove*
263:abo[veleft] {cmd} *:abo* *:aboveleft*
264 Execute {cmd}. If it contains a command that splits a window,
265 it will be opened left (vertical split) or above (horizontal
266 split) the current window. Overrules 'splitbelow' and
267 'splitright'.
Bram Moolenaar756ec0f2007-05-05 17:59:48 +0000268 Doesn't work for |:execute| and |:normal|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000269
270:rightb[elow] {cmd} *:rightb* *:rightbelow*
271:bel[owright] {cmd} *:bel* *:belowright*
272 Execute {cmd}. If it contains a command that splits a window,
273 it will be opened right (vertical split) or below (horizontal
274 split) the current window. Overrules 'splitbelow' and
275 'splitright'.
Bram Moolenaar756ec0f2007-05-05 17:59:48 +0000276 Doesn't work for |:execute| and |:normal|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000277
278 *:topleft* *E442*
279:to[pleft] {cmd}
280 Execute {cmd}. If it contains a command that splits a window,
281 it will appear at the top and occupy the full width of the Vim
282 window. When the split is vertical the window appears at the
283 far left and occupies the full height of the Vim window.
Bram Moolenaar756ec0f2007-05-05 17:59:48 +0000284 Doesn't work for |:execute| and |:normal|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000285
Bram Moolenaarbc8801c2016-08-02 21:04:33 +0200286 *:bo* *:botright*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000287:bo[tright] {cmd}
288 Execute {cmd}. If it contains a command that splits a window,
289 it will appear at the bottom and occupy the full width of the
290 Vim window. When the split is vertical the window appears at
291 the far right and occupies the full height of the Vim window.
Bram Moolenaar756ec0f2007-05-05 17:59:48 +0000292 Doesn't work for |:execute| and |:normal|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000293
294These command modifiers can be combined to make a vertically split window
295occupy the full height. Example: >
Bram Moolenaar5302d9e2011-09-14 17:55:08 +0200296 :vertical topleft split tags
Bram Moolenaar071d4272004-06-13 20:20:40 +0000297Opens a vertically split, full-height window on the "tags" file at the far
298left of the Vim window.
299
300
301Closing a window
302----------------
303
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100304:q[uit]
Bram Moolenaar6c391a72021-09-09 21:55:11 +0200305:{count}q[uit] *:count_quit*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000306CTRL-W q *CTRL-W_q*
307CTRL-W CTRL-Q *CTRL-W_CTRL-Q*
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100308 Without {count}: Quit the current window. If {count} is
309 given quit the {count} window.
Bram Moolenaar47e13952020-05-12 22:49:12 +0200310 *edit-window*
311 When quitting the last edit window (not counting help or
312 preview windows), exit Vim.
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100313
Bram Moolenaar071d4272004-06-13 20:20:40 +0000314 When 'hidden' is set, and there is only one window for the
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100315 current buffer, it becomes hidden. When 'hidden' is not set,
316 and there is only one window for the current buffer, and the
317 buffer was changed, the command fails.
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100318
Bram Moolenaared32d942014-12-06 23:33:00 +0100319 (Note: CTRL-Q does not work on all terminals).
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100320
Bram Moolenaared32d942014-12-06 23:33:00 +0100321 If [count] is greater than the last window number the last
322 window will be closed: >
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100323 :1quit " quit the first window
324 :$quit " quit the last window
325 :9quit " quit the last window
Bram Moolenaar46fceaa2016-10-23 21:21:08 +0200326 " if there are fewer than 9 windows opened
327 :-quit " quit the previous window
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100328 :+quit " quit the next window
Bram Moolenaared32d942014-12-06 23:33:00 +0100329 :+2quit " quit the second next window
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100330<
Bram Moolenaar47e13952020-05-12 22:49:12 +0200331 When closing a help window, and this is not the only window,
332 Vim will try to restore the previous window layout, see
333 |:helpclose|.
Bram Moolenaar96f45c02019-10-26 19:53:45 +0200334
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100335:q[uit]!
336:{count}q[uit]!
337 Without {count}: Quit the current window. If {count} is
338 given quit the {count} window.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000339
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100340 If this was the last window for a buffer, any changes to that
341 buffer are lost. When quitting the last window (not counting
342 help windows), exit Vim. The contents of the buffer are lost,
343 even when 'hidden' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000344
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100345:clo[se][!]
346:{count}clo[se][!]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000347CTRL-W c *CTRL-W_c* *:clo* *:close*
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100348 Without {count}: Close the current window. If {count} is
349 given close the {count} window.
350
351 When the 'hidden' option is set, or when the buffer was
352 changed and the [!] is used, the buffer becomes hidden (unless
353 there is another window editing it).
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100354
Bram Moolenaar47e13952020-05-12 22:49:12 +0200355 When there is only one |edit-window| in the current tab page
356 and there is another tab page, this closes the current tab
357 page. |tab-page|.
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100358
Bram Moolenaar071d4272004-06-13 20:20:40 +0000359 This command fails when: *E444*
360 - There is only one window on the screen.
361 - When 'hidden' is not set, [!] is not used, the buffer has
362 changes, and there is no other window on this buffer.
363 Changes to the buffer are not written and won't get lost, so
364 this is a "safe" command.
365
366CTRL-W CTRL-C *CTRL-W_CTRL-C*
367 You might have expected that CTRL-W CTRL-C closes the current
368 window, but that does not work, because the CTRL-C cancels the
369 command.
370
371 *:hide*
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100372:hid[e]
373:{count}hid[e]
Bram Moolenaarc572da52017-08-27 16:52:01 +0200374 Without {count}: Quit the current window, unless it is the
375 last window on the screen.
376 If {count} is given quit the {count} window.
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100377
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100378 The buffer becomes hidden (unless there is another window
Bram Moolenaared32d942014-12-06 23:33:00 +0100379 editing it or 'bufhidden' is "unload", "delete" or "wipe").
380 If the window is the last one in the current tab page the tab
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100381 page is closed. |tab-page|
382
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100383 The value of 'hidden' is irrelevant for this command. Changes
384 to the buffer are not written and won't get lost, so this is a
385 "safe" command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000386
387:hid[e] {cmd} Execute {cmd} with 'hidden' is set. The previous value of
388 'hidden' is restored after {cmd} has been executed.
389 Example: >
390 :hide edit Makefile
391< This will edit "Makefile", and hide the current buffer if it
392 has any changes.
393
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100394:on[ly][!]
395:{count}on[ly][!]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000396CTRL-W o *CTRL-W_o* *E445*
397CTRL-W CTRL-O *CTRL-W_CTRL-O* *:on* *:only*
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100398 Make the current window the only one on the screen. All other
Bram Moolenaar6c391a72021-09-09 21:55:11 +0200399 windows are closed. For {count} see the `:quit` command
400 above |:count_quit|.
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100401
Bram Moolenaar071d4272004-06-13 20:20:40 +0000402 When the 'hidden' option is set, all buffers in closed windows
403 become hidden.
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100404
Bram Moolenaar071d4272004-06-13 20:20:40 +0000405 When 'hidden' is not set, and the 'autowrite' option is set,
406 modified buffers are written. Otherwise, windows that have
407 buffers that are modified are not removed, unless the [!] is
408 given, then they become hidden. But modified buffers are
409 never abandoned, so changes cannot get lost.
410
411==============================================================================
4124. Moving cursor to other windows *window-move-cursor*
413
414CTRL-W <Down> *CTRL-W_<Down>*
415CTRL-W CTRL-J *CTRL-W_CTRL-J* *CTRL-W_j*
416CTRL-W j Move cursor to Nth window below current one. Uses the cursor
417 position to select between alternatives.
418
419CTRL-W <Up> *CTRL-W_<Up>*
420CTRL-W CTRL-K *CTRL-W_CTRL-K* *CTRL-W_k*
421CTRL-W k Move cursor to Nth window above current one. Uses the cursor
422 position to select between alternatives.
423
424CTRL-W <Left> *CTRL-W_<Left>*
425CTRL-W CTRL-H *CTRL-W_CTRL-H*
426CTRL-W <BS> *CTRL-W_<BS>* *CTRL-W_h*
427CTRL-W h Move cursor to Nth window left of current one. Uses the
428 cursor position to select between alternatives.
429
430CTRL-W <Right> *CTRL-W_<Right>*
431CTRL-W CTRL-L *CTRL-W_CTRL-L* *CTRL-W_l*
432CTRL-W l Move cursor to Nth window right of current one. Uses the
433 cursor position to select between alternatives.
434
435CTRL-W w *CTRL-W_w* *CTRL-W_CTRL-W*
436CTRL-W CTRL-W Without count: move cursor to window below/right of the
437 current one. If there is no window below or right, go to
438 top-left window.
439 With count: go to Nth window (windows are numbered from
440 top-left to bottom-right). To obtain the window number see
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100441 |bufwinnr()| and |winnr()|. When N is larger than the number
442 of windows go to the last window.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000443
444 *CTRL-W_W*
445CTRL-W W Without count: move cursor to window above/left of current
446 one. If there is no window above or left, go to bottom-right
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100447 window. With count: go to Nth window, like with CTRL-W w.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000448
449CTRL-W t *CTRL-W_t* *CTRL-W_CTRL-T*
450CTRL-W CTRL-T Move cursor to top-left window.
451
452CTRL-W b *CTRL-W_b* *CTRL-W_CTRL-B*
453CTRL-W CTRL-B Move cursor to bottom-right window.
454
455CTRL-W p *CTRL-W_p* *CTRL-W_CTRL-P*
456CTRL-W CTRL-P Go to previous (last accessed) window.
457
458 *CTRL-W_P* *E441*
459CTRL-W P Go to preview window. When there is no preview window this is
460 an error.
461 {not available when compiled without the |+quickfix| feature}
462
463If Visual mode is active and the new window is not for the same buffer, the
464Visual mode is ended. If the window is on the same buffer, the cursor
465position is set to keep the same Visual area selected.
466
467 *:winc* *:wincmd*
468These commands can also be executed with ":wincmd":
469
470:[count]winc[md] {arg}
471 Like executing CTRL-W [count] {arg}. Example: >
472 :wincmd j
473< Moves to the window below the current one.
474 This command is useful when a Normal mode cannot be used (for
475 the |CursorHold| autocommand event). Or when a Normal mode
476 command is inconvenient.
477 The count can also be a window number. Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +0000478 :exe nr .. "wincmd w"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000479< This goes to window "nr".
480
481==============================================================================
4825. Moving windows around *window-moving*
483
484CTRL-W r *CTRL-W_r* *CTRL-W_CTRL-R* *E443*
485CTRL-W CTRL-R Rotate windows downwards/rightwards. The first window becomes
486 the second one, the second one becomes the third one, etc.
487 The last window becomes the first window. The cursor remains
488 in the same window.
489 This only works within the row or column of windows that the
490 current window is in.
491
492 *CTRL-W_R*
493CTRL-W R Rotate windows upwards/leftwards. The second window becomes
494 the first one, the third one becomes the second one, etc. The
495 first window becomes the last window. The cursor remains in
496 the same window.
497 This only works within the row or column of windows that the
498 current window is in.
499
500CTRL-W x *CTRL-W_x* *CTRL-W_CTRL-X*
501CTRL-W CTRL-X Without count: Exchange current window with next one. If there
502 is no next window, exchange with previous window.
503 With count: Exchange current window with Nth window (first
504 window is 1). The cursor is put in the other window.
505 When vertical and horizontal window splits are mixed, the
506 exchange is only done in the row or column of windows that the
507 current window is in.
508
509The following commands can be used to change the window layout. For example,
510when there are two vertically split windows, CTRL-W K will change that in
511horizontally split windows. CTRL-W H does it the other way around.
512
513 *CTRL-W_K*
514CTRL-W K Move the current window to be at the very top, using the full
515 width of the screen. This works like closing the current
516 window and then creating another one with ":topleft split",
517 except that the current window contents is used for the new
518 window.
519
520 *CTRL-W_J*
521CTRL-W J Move the current window to be at the very bottom, using the
522 full width of the screen. This works like closing the current
523 window and then creating another one with ":botright split",
524 except that the current window contents is used for the new
525 window.
526
527 *CTRL-W_H*
528CTRL-W H Move the current window to be at the far left, using the
529 full height of the screen. This works like closing the
530 current window and then creating another one with
Bram Moolenaar56994d22021-04-17 16:31:09 +0200531 `:vert topleft split`, except that the current window contents
Bram Moolenaar071d4272004-06-13 20:20:40 +0000532 is used for the new window.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000533
534 *CTRL-W_L*
535CTRL-W L Move the current window to be at the far right, using the full
536 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 botright split`, except that the current window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000539 contents is used for the new window.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000540
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000541 *CTRL-W_T*
542CTRL-W T Move the current window to a new tab page. This fails if
543 there is only one window in the current tab page.
544 When a count is specified the new tab page will be opened
545 before the tab page with this index. Otherwise it comes after
546 the current tab page.
547
Bram Moolenaar071d4272004-06-13 20:20:40 +0000548==============================================================================
5496. Window resizing *window-resize*
550
551 *CTRL-W_=*
552CTRL-W = Make all windows (almost) equally high and wide, but use
553 'winheight' and 'winwidth' for the current window.
Bram Moolenaar756ec0f2007-05-05 17:59:48 +0000554 Windows with 'winfixheight' set keep their height and windows
555 with 'winfixwidth' set keep their width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000556
557:res[ize] -N *:res* *:resize* *CTRL-W_-*
558CTRL-W - Decrease current window height by N (default 1).
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200559 If used after |:vertical|: decrease width by N.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000560
561:res[ize] +N *CTRL-W_+*
562CTRL-W + Increase current window height by N (default 1).
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200563 If used after |:vertical|: increase width by N.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000564
565:res[ize] [N]
566CTRL-W CTRL-_ *CTRL-W_CTRL-_* *CTRL-W__*
567CTRL-W _ Set current window height to N (default: highest possible).
568
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +0100569:{winnr}res[ize] [+-]N
570 Like `:resize` above, but apply the size to window {winnr}
571 instead of the current window.
572
Bram Moolenaar071d4272004-06-13 20:20:40 +0000573z{nr}<CR> Set current window height to {nr}.
574
575 *CTRL-W_<*
576CTRL-W < Decrease current window width by N (default 1).
577
578 *CTRL-W_>*
579CTRL-W > Increase current window width by N (default 1).
580
Bram Moolenaar56994d22021-04-17 16:31:09 +0200581:vert[ical] res[ize] [N] *:vertical-resize* *CTRL-W_bar*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000582CTRL-W | Set current window width to N (default: widest possible).
583
584You can also resize a window by dragging a status line up or down with the
585mouse. Or by dragging a vertical separator line left or right. This only
586works if the version of Vim that is being used supports the mouse and the
587'mouse' option has been set to enable it.
588
589The option 'winheight' ('wh') is used to set the minimal window height of the
590current window. This option is used each time another window becomes the
591current window. If the option is '0', it is disabled. Set 'winheight' to a
592very large value, e.g., '9999', to make the current window always fill all
593available space. Set it to a reasonable value, e.g., '10', to make editing in
594the current window comfortable.
595
596The equivalent 'winwidth' ('wiw') option is used to set the minimal width of
597the current window.
598
599When the option 'equalalways' ('ea') is set, all the windows are automatically
600made the same size after splitting or closing a window. If you don't set this
601option, splitting a window will reduce the size of the current window and
602leave the other windows the same. When closing a window, the extra lines are
603given to the window above it.
604
605The 'eadirection' option limits the direction in which the 'equalalways'
606option is applied. The default "both" resizes in both directions. When the
607value is "ver" only the heights of windows are equalized. Use this when you
608have manually resized a vertically split window and want to keep this width.
609Likewise, "hor" causes only the widths of windows to be equalized.
610
611The option 'cmdheight' ('ch') is used to set the height of the command-line.
612If you are annoyed by the |hit-enter| prompt for long messages, set this
613option to 2 or 3.
614
615If there is only one window, resizing that window will also change the command
616line height. If there are several windows, resizing the current window will
617also change the height of the window below it (and sometimes the window above
618it).
619
620The minimal height and width of a window is set with 'winminheight' and
621'winminwidth'. These are hard values, a window will never become smaller.
622
623==============================================================================
6247. Argument and buffer list commands *buffer-list*
625
626 args list buffer list meaning ~
6271. :[N]argument [N] 11. :[N]buffer [N] to arg/buf N
6282. :[N]next [file ..] 12. :[N]bnext [N] to Nth next arg/buf
6293. :[N]Next [N] 13. :[N]bNext [N] to Nth previous arg/buf
6304. :[N]previous [N] 14. :[N]bprevious [N] to Nth previous arg/buf
6315. :rewind / :first 15. :brewind / :bfirst to first arg/buf
6326. :last 16. :blast to last arg/buf
6337. :all 17. :ball edit all args/buffers
634 18. :unhide edit all loaded buffers
635 19. :[N]bmod [N] to Nth modified buf
636
637 split & args list split & buffer list meaning ~
63821. :[N]sargument [N] 31. :[N]sbuffer [N] split + to arg/buf N
63922. :[N]snext [file ..] 32. :[N]sbnext [N] split + to Nth next arg/buf
64023. :[N]sNext [N] 33. :[N]sbNext [N] split + to Nth previous arg/buf
64124. :[N]sprevious [N] 34. :[N]sbprevious [N] split + to Nth previous arg/buf
64225. :srewind / :sfirst 35. :sbrewind / :sbfirst split + to first arg/buf
64326. :slast 36. :sblast split + to last arg/buf
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +000064427. :sall 37. :sball edit all args/buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +0000645 38. :sunhide edit all loaded buffers
646 39. :[N]sbmod [N] split + to Nth modified buf
647
64840. :args list of arguments
64941. :buffers list of buffers
650
651The meaning of [N] depends on the command:
Bram Moolenaar24a98a02017-09-27 22:23:55 +0200652 [N] is the number of buffers to go forward/backward on 2/12/22/32,
653 3/13/23/33, and 4/14/24/34
Bram Moolenaar071d4272004-06-13 20:20:40 +0000654 [N] is an argument number, defaulting to current argument, for 1 and 21
655 [N] is a buffer number, defaulting to current buffer, for 11 and 31
656 [N] is a count for 19 and 39
657
658Note: ":next" is an exception, because it must accept a list of file names
659for compatibility with Vi.
660
661
662The argument list and multiple windows
663--------------------------------------
664
665The current position in the argument list can be different for each window.
666Remember that when doing ":e file", the position in the argument list stays
667the same, but you are not editing the file at that position. To indicate
668this, the file message (and the title, if you have one) shows
669"(file (N) of M)", where "(N)" is the current position in the file list, and
670"M" the number of files in the file list.
671
672All the entries in the argument list are added to the buffer list. Thus, you
673can also get to them with the buffer list commands, like ":bnext".
674
675:[N]al[l][!] [N] *:al* *:all* *:sal* *:sall*
676:[N]sal[l][!] [N]
677 Rearrange the screen to open one window for each argument.
678 All other windows are closed. When a count is given, this is
679 the maximum number of windows to open.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +0000680 With the |:tab| modifier open a tab page for each argument.
681 When there are more arguments than 'tabpagemax' further ones
682 become split windows in the last tab page.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000683 When the 'hidden' option is set, all buffers in closed windows
684 become hidden.
685 When 'hidden' is not set, and the 'autowrite' option is set,
686 modified buffers are written. Otherwise, windows that have
687 buffers that are modified are not removed, unless the [!] is
688 given, then they become hidden. But modified buffers are
689 never abandoned, so changes cannot get lost.
690 [N] is the maximum number of windows to open. 'winheight'
691 also limits the number of windows opened ('winwidth' if
692 |:vertical| was prepended).
693 Buf/Win Enter/Leave autocommands are not executed for the new
694 windows here, that's only done when they are really entered.
Bram Moolenaar54775062019-07-31 21:07:14 +0200695 If autocommands change the window layout while this command is
696 busy an error will be given. *E249*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000697
698:[N]sa[rgument][!] [++opt] [+cmd] [N] *:sa* *:sargument*
699 Short for ":split | argument [N]": split window and go to Nth
700 argument. But when there is no such argument, the window is
701 not split. Also see |++opt| and |+cmd|.
702
703:[N]sn[ext][!] [++opt] [+cmd] [file ..] *:sn* *:snext*
704 Short for ":split | [N]next": split window and go to Nth next
705 argument. But when there is no next file, the window is not
706 split. Also see |++opt| and |+cmd|.
707
708:[N]spr[evious][!] [++opt] [+cmd] [N] *:spr* *:sprevious*
709:[N]sN[ext][!] [++opt] [+cmd] [N] *:sN* *:sNext*
710 Short for ":split | [N]Next": split window and go to Nth
711 previous argument. But when there is no previous file, the
712 window is not split. Also see |++opt| and |+cmd|.
713
714 *:sre* *:srewind*
715:sre[wind][!] [++opt] [+cmd]
716 Short for ":split | rewind": split window and go to first
717 argument. But when there is no argument list, the window is
718 not split. Also see |++opt| and |+cmd|.
719
720 *:sfir* *:sfirst*
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000721:sfir[st] [++opt] [+cmd]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000722 Same as ":srewind".
723
724 *:sla* *:slast*
725:sla[st][!] [++opt] [+cmd]
726 Short for ":split | last": split window and go to last
727 argument. But when there is no argument list, the window is
728 not split. Also see |++opt| and |+cmd|.
729
730 *:dr* *:drop*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000731:dr[op] [++opt] [+cmd] {file} ..
Bram Moolenaar071d4272004-06-13 20:20:40 +0000732 Edit the first {file} in a window.
733 - If the file is already open in a window change to that
734 window.
735 - If the file is not open in a window edit the file in the
736 current window. If the current buffer can't be |abandon|ed,
737 the window is split first.
Bram Moolenaar51628222016-12-01 23:03:28 +0100738 - Windows that are not in the argument list or are not full
739 width will be closed if possible.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000740 The |argument-list| is set, like with the |:next| command.
741 The purpose of this command is that it can be used from a
742 program that wants Vim to edit another file, e.g., a debugger.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000743 When using the |:tab| modifier each argument is opened in a
744 tab page. The last window is used if it's empty.
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000745 Also see |++opt| and |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000746
747==============================================================================
7488. Do a command in all buffers or windows *list-repeat*
749
750 *:windo*
Bram Moolenaara162bc52015-01-07 16:54:21 +0100751:[range]windo {cmd} Execute {cmd} in each window or if [range] is given
752 only in windows for which the window number lies in
753 the [range]. It works like doing this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000754 CTRL-W t
755 :{cmd}
756 CTRL-W w
757 :{cmd}
758 etc.
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000759< This only operates in the current tab page.
Bram Moolenaar7e8fd632006-02-18 22:14:51 +0000760 When an error is detected on one window, further
Bram Moolenaar071d4272004-06-13 20:20:40 +0000761 windows will not be visited.
762 The last window (or where an error occurred) becomes
763 the current window.
764 {cmd} can contain '|' to concatenate several commands.
765 {cmd} must not open or close windows or reorder them.
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200766
Bram Moolenaaraa23b372015-09-08 18:46:31 +0200767 Also see |:tabdo|, |:argdo|, |:bufdo|, |:cdo|, |:ldo|,
768 |:cfdo| and |:lfdo|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000769
770 *:bufdo*
Bram Moolenaara162bc52015-01-07 16:54:21 +0100771:[range]bufdo[!] {cmd} Execute {cmd} in each buffer in the buffer list or if
772 [range] is given only for buffers for which their
Bram Moolenaar681baaf2016-02-04 20:57:07 +0100773 buffer number is in the [range]. It works like doing
Bram Moolenaara162bc52015-01-07 16:54:21 +0100774 this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000775 :bfirst
776 :{cmd}
777 :bnext
778 :{cmd}
779 etc.
780< When the current file can't be |abandon|ed and the [!]
781 is not present, the command fails.
782 When an error is detected on one buffer, further
783 buffers will not be visited.
784 Unlisted buffers are skipped.
785 The last buffer (or where an error occurred) becomes
786 the current buffer.
787 {cmd} can contain '|' to concatenate several commands.
788 {cmd} must not delete buffers or add buffers to the
789 buffer list.
790 Note: While this command is executing, the Syntax
791 autocommand event is disabled by adding it to
792 'eventignore'. This considerably speeds up editing
793 each buffer.
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200794
Bram Moolenaaraa23b372015-09-08 18:46:31 +0200795 Also see |:tabdo|, |:argdo|, |:windo|, |:cdo|, |:ldo|,
796 |:cfdo| and |:lfdo|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000797
798Examples: >
799
Bram Moolenaardad44732021-03-31 20:07:33 +0200800 :windo set nolist foldcolumn=0 | normal! zn
Bram Moolenaar071d4272004-06-13 20:20:40 +0000801
802This resets the 'list' option and disables folding in all windows. >
803
804 :bufdo set fileencoding= | update
805
806This resets the 'fileencoding' in each buffer and writes it if this changed
807the buffer. The result is that all buffers will use the 'encoding' encoding
Bram Moolenaardad44732021-03-31 20:07:33 +0200808(if conversion succeeds).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000809
810==============================================================================
8119. Tag or file name under the cursor *window-tag*
812
813 *:sta* *:stag*
814:sta[g][!] [tagname]
815 Does ":tag[!] [tagname]" and splits the window for the found
816 tag. See also |:tag|.
817
818CTRL-W ] *CTRL-W_]* *CTRL-W_CTRL-]*
819CTRL-W CTRL-] Split current window in two. Use identifier under cursor as a
Bram Moolenaar3a991dd2014-10-02 01:41:41 +0200820 tag and jump to it in the new upper window.
821 In Visual mode uses the Visually selected text as a tag.
822 Make new window N high.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000823
824 *CTRL-W_g]*
825CTRL-W g ] Split current window in two. Use identifier under cursor as a
826 tag and perform ":tselect" on it in the new upper window.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +0200827 In Visual mode uses the Visually selected text as a tag.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000828 Make new window N high.
829
830 *CTRL-W_g_CTRL-]*
831CTRL-W g CTRL-] Split current window in two. Use identifier under cursor as a
Bram Moolenaar3a991dd2014-10-02 01:41:41 +0200832 tag and perform ":tjump" on it in the new upper window.
833 In Visual mode uses the Visually selected text as a tag.
834 Make new window N high.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000835
836CTRL-W f *CTRL-W_f* *CTRL-W_CTRL-F*
837CTRL-W CTRL-F Split current window in two. Edit file name under cursor.
Bram Moolenaar8dff8182006-04-06 20:18:50 +0000838 Like ":split gf", but window isn't split if the file does not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000839 exist.
840 Uses the 'path' variable as a list of directory names where to
841 look for the file. Also the path for current file is
842 used to search for the file name.
843 If the name is a hypertext link that looks like
844 "type://machine/path", only "/path" is used.
845 If a count is given, the count'th matching file is edited.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000846
Bram Moolenaard1f56e62006-02-22 21:25:37 +0000847CTRL-W F *CTRL-W_F*
848 Split current window in two. Edit file name under cursor and
849 jump to the line number following the file name. See |gF| for
850 details on how the line number is obtained.
851
Bram Moolenaar8dff8182006-04-06 20:18:50 +0000852CTRL-W gf *CTRL-W_gf*
853 Open a new tab page and edit the file name under the cursor.
854 Like "tab split" and "gf", but the new tab page isn't created
855 if the file does not exist.
Bram Moolenaar8dff8182006-04-06 20:18:50 +0000856
Bram Moolenaar57657d82006-04-21 22:12:41 +0000857CTRL-W gF *CTRL-W_gF*
858 Open a new tab page and edit the file name under the cursor
859 and jump to the line number following the file name. Like
860 "tab split" and "gF", but the new tab page isn't created if
861 the file does not exist.
Bram Moolenaar57657d82006-04-21 22:12:41 +0000862
Bram Moolenaar26967612019-03-17 17:13:16 +0100863CTRL-W gt *CTRL-W_gt*
864 Go to next tab page, same as `gt`.
865
866CTRL-W gT *CTRL-W_gT*
867 Go to previous tab page, same as `gT`.
868
Bram Moolenaar071d4272004-06-13 20:20:40 +0000869Also see |CTRL-W_CTRL-I|: open window for an included file that includes
870the keyword under the cursor.
871
872==============================================================================
87310. The preview window *preview-window*
874
875The preview window is a special window to show (preview) another file. It is
876normally a small window used to show an include file or definition of a
877function.
878{not available when compiled without the |+quickfix| feature}
879
Bram Moolenaarc270d802006-03-11 21:29:41 +0000880There can be only one preview window (per tab page). It is created with one
881of the commands below. The 'previewheight' option can be set to specify the
882height of the preview window when it's opened. The 'previewwindow' option is
883set in the preview window to be able to recognize it. The 'winfixheight'
884option is set to have it keep the same height when opening/closing other
885windows.
Bram Moolenaar79648732019-07-18 21:43:07 +0200886 *preview-popup*
887Alternatively, a popup window can be used by setting the 'previewpopup'
888option. When set, it overrules the 'previewwindow' and 'previewheight'
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100889settings. The option is a comma-separated list of values:
Bram Moolenaar79648732019-07-18 21:43:07 +0200890 height maximum height of the popup
Bram Moolenaar85850f32019-07-19 22:05:51 +0200891 width maximum width of the popup
Bram Moolenaar06fe74a2019-08-31 16:20:32 +0200892 highlight highlight group of the popup (default is Pmenu)
Bram Moolenaar79648732019-07-18 21:43:07 +0200893Example: >
894 :set previewpopup=height:10,width:60
Bram Moolenaar2debf1c2019-08-04 20:44:19 +0200895
896A few peculiarities:
897- If the file is in a buffer already, it will be re-used. This will allow for
898 editing the file while it's visible in the popup window.
899- No ATTENTION dialog will be used, since you can't edit the file in the popup
900 window. However, if you later open the same buffer in a normal window, you
901 may not notice it's edited elsewhere. And when then using ":edit" to
902 trigger the ATTENTION and responding "A" for Abort, the preview window will
903 become empty.
904
Bram Moolenaar071d4272004-06-13 20:20:40 +0000905 *:pta* *:ptag*
906:pta[g][!] [tagname]
907 Does ":tag[!] [tagname]" and shows the found tag in a
908 "Preview" window without changing the current buffer or cursor
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000909 position. If a "Preview" window already exists, it is re-used
Bram Moolenaar071d4272004-06-13 20:20:40 +0000910 (like a help window is). If a new one is opened,
911 'previewheight' is used for the height of the window. See
912 also |:tag|.
913 See below for an example. |CursorHold-example|
914 Small difference from |:tag|: When [tagname] is equal to the
915 already displayed tag, the position in the matching tag list
916 is not reset. This makes the CursorHold example work after a
917 |:ptnext|.
918
919CTRL-W z *CTRL-W_z*
920CTRL-W CTRL-Z *CTRL-W_CTRL-Z* *:pc* *:pclose*
921:pc[lose][!] Close any "Preview" window currently open. When the 'hidden'
922 option is set, or when the buffer was changed and the [!] is
923 used, the buffer becomes hidden (unless there is another
924 window editing it). The command fails if any "Preview" buffer
925 cannot be closed. See also |:close|.
926
927 *:pp* *:ppop*
928:[count]pp[op][!]
929 Does ":[count]pop[!]" in the preview window. See |:pop| and
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200930 |:ptag|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000931
932CTRL-W } *CTRL-W_}*
933 Use identifier under cursor as a tag and perform a :ptag on
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000934 it. Make the new Preview window (if required) N high. If N is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000935 not given, 'previewheight' is used.
936
937CTRL-W g } *CTRL-W_g}*
938 Use identifier under cursor as a tag and perform a :ptjump on
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000939 it. Make the new Preview window (if required) N high. If N is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000940 not given, 'previewheight' is used.
941
942 *:ped* *:pedit*
943:ped[it][!] [++opt] [+cmd] {file}
944 Edit {file} in the preview window. The preview window is
945 opened like with |:ptag|. The current window and cursor
946 position isn't changed. Useful example: >
947 :pedit +/fputc /usr/include/stdio.h
948<
949 *:ps* *:psearch*
950:[range]ps[earch][!] [count] [/]pattern[/]
951 Works like |:ijump| but shows the found match in the preview
952 window. The preview window is opened like with |:ptag|. The
953 current window and cursor position isn't changed. Useful
954 example: >
955 :psearch popen
956< Like with the |:ptag| command, you can use this to
957 automatically show information about the word under the
958 cursor. This is less clever than using |:ptag|, but you don't
959 need a tags file and it will also find matches in system
960 include files. Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +0000961 :au! CursorHold *.[ch] ++nested exe "silent! psearch " .. expand("<cword>")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000962< Warning: This can be slow.
963
964Example *CursorHold-example* >
965
Bram Moolenaarc51cf032022-02-26 12:25:45 +0000966 :au! CursorHold *.[ch] ++nested exe "silent! ptag " .. expand("<cword>")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000967
968This will cause a ":ptag" to be executed for the keyword under the cursor,
969when the cursor hasn't moved for the time set with 'updatetime'. The "nested"
970makes other autocommands be executed, so that syntax highlighting works in the
971preview window. The "silent!" avoids an error message when the tag could not
972be found. Also see |CursorHold|. To disable this again: >
973
974 :au! CursorHold
975
976A nice addition is to highlight the found tag, avoid the ":ptag" when there
977is no word under the cursor, and a few other things: >
978
Bram Moolenaar1c6737b2020-09-07 22:18:52 +0200979 :au! CursorHold *.[ch] ++nested call PreviewWord()
Bram Moolenaar071d4272004-06-13 20:20:40 +0000980 :func PreviewWord()
981 : if &previewwindow " don't do this in the preview window
982 : return
983 : endif
984 : let w = expand("<cword>") " get the word under cursor
985 : if w =~ '\a' " if the word contains a letter
986 :
987 : " Delete any existing highlight before showing another tag
988 : silent! wincmd P " jump to preview window
Bram Moolenaarc51cf032022-02-26 12:25:45 +0000989 : if &previewwindow " if we really get there...
Bram Moolenaar071d4272004-06-13 20:20:40 +0000990 : match none " delete existing highlight
991 : wincmd p " back to old window
992 : endif
993 :
994 : " Try displaying a matching tag for the word under the cursor
995 : try
Bram Moolenaarc51cf032022-02-26 12:25:45 +0000996 : exe "ptag " .. w
Bram Moolenaar071d4272004-06-13 20:20:40 +0000997 : catch
998 : return
999 : endtry
1000 :
1001 : silent! wincmd P " jump to preview window
1002 : if &previewwindow " if we really get there...
1003 : if has("folding")
1004 : silent! .foldopen " don't want a closed fold
1005 : endif
1006 : call search("$", "b") " to end of previous line
1007 : let w = substitute(w, '\\', '\\\\', "")
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001008 : call search('\<\V' .. w .. '\>') " position cursor on match
Bram Moolenaar071d4272004-06-13 20:20:40 +00001009 : " Add a match highlight to the word at this position
1010 : hi previewWord term=bold ctermbg=green guibg=green
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001011 : exe 'match previewWord "\%' .. line(".") .. 'l\%' .. col(".") .. 'c\k*"'
Bram Moolenaar071d4272004-06-13 20:20:40 +00001012 : wincmd p " back to old window
1013 : endif
1014 : endif
1015 :endfun
1016
1017==============================================================================
101811. Using hidden buffers *buffer-hidden*
1019
1020A hidden buffer is not displayed in a window, but is still loaded into memory.
1021This makes it possible to jump from file to file, without the need to read or
1022write the file every time you get another buffer in a window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001023
1024 *:buffer-!*
1025If the option 'hidden' ('hid') is set, abandoned buffers are kept for all
1026commands that start editing another file: ":edit", ":next", ":tag", etc. The
1027commands that move through the buffer list sometimes make the current buffer
1028hidden although the 'hidden' option is not set. This happens when a buffer is
1029modified, but is forced (with '!') to be removed from a window, and
1030'autowrite' is off or the buffer can't be written.
1031
1032You can make a hidden buffer not hidden by starting to edit it with any
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01001033command, or by deleting it with the ":bdelete" command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001034
1035The 'hidden' is global, it is used for all buffers. The 'bufhidden' option
1036can be used to make an exception for a specific buffer. It can take these
1037values:
1038 <empty> Use the value of 'hidden'.
1039 hide Hide this buffer, also when 'hidden' is not set.
1040 unload Don't hide but unload this buffer, also when 'hidden'
1041 is set.
1042 delete Delete the buffer.
1043
1044 *hidden-quit*
1045When you try to quit Vim while there is a hidden, modified buffer, you will
1046get an error message and Vim will make that buffer the current buffer. You
1047can then decide to write this buffer (":wq") or quit without writing (":q!").
1048Be careful: there may be more hidden, modified buffers!
1049
1050A buffer can also be unlisted. This means it exists, but it is not in the
1051list of buffers. |unlisted-buffer|
1052
1053
Bram Moolenaard51cb702015-07-21 15:03:06 +02001054:files[!] [flags] *:files*
1055:buffers[!] [flags] *:buffers* *:ls*
1056:ls[!] [flags]
1057 Show all buffers. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001058
Bram Moolenaar97d62492012-11-15 21:28:22 +01001059 1 #h "/test/text" line 1 ~
1060 2u "asdf" line 0 ~
1061 3 %a + "version.c" line 1 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +00001062
1063 When the [!] is included the list will show unlisted buffers
1064 (the term "unlisted" is a bit confusing then...).
1065
1066 Each buffer has a unique number. That number will not change,
Bram Moolenaar0122c402015-02-03 19:13:34 +01001067 thus you can always go to a specific buffer with ":buffer N"
1068 or "N CTRL-^", where N is the buffer number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001069
Bram Moolenaarc6896e22019-05-30 22:32:34 +02001070 For the file name these special values are used:
1071 [Prompt] |prompt-buffer|
1072 [Popup] buffer of a |popup-window|
1073 [Scratch] 'buftype' is "nofile"
1074 [No Name] no file name specified
1075 For a |terminal-window| buffer the status is used.
1076
Bram Moolenaar071d4272004-06-13 20:20:40 +00001077 Indicators (chars in the same column are mutually exclusive):
1078 u an unlisted buffer (only displayed when [!] is used)
1079 |unlisted-buffer|
1080 % the buffer in the current window
1081 # the alternate buffer for ":e #" and CTRL-^
1082 a an active buffer: it is loaded and visible
1083 h a hidden buffer: It is loaded, but currently not
1084 displayed in a window |hidden-buffer|
1085 - a buffer with 'modifiable' off
1086 = a readonly buffer
Bram Moolenaarc572da52017-08-27 16:52:01 +02001087 R a terminal buffer with a running job
1088 F a terminal buffer with a finished job
Bram Moolenaar37c64c72017-09-19 22:06:03 +02001089 ? a terminal buffer without a job: `:terminal NONE`
Bram Moolenaar071d4272004-06-13 20:20:40 +00001090 + a modified buffer
1091 x a buffer with read errors
1092
Bram Moolenaard51cb702015-07-21 15:03:06 +02001093 [flags] can be a combination of the following characters,
1094 which restrict the buffers to be listed:
1095 + modified buffers
1096 - buffers with 'modifiable' off
1097 = readonly buffers
1098 a active buffers
Bram Moolenaare392eb42015-11-19 20:38:09 +01001099 u unlisted buffers (overrides the "!")
Bram Moolenaard51cb702015-07-21 15:03:06 +02001100 h hidden buffers
1101 x buffers with a read error
1102 % current buffer
1103 # alternate buffer
Bram Moolenaar0751f512018-03-29 16:37:16 +02001104 R terminal buffers with a running job
1105 F terminal buffers with a finished job
1106 ? terminal buffers without a job: `:terminal NONE`
Bram Moolenaar52410572019-10-27 05:12:45 +01001107 t show time last used and sort buffers
Bram Moolenaard51cb702015-07-21 15:03:06 +02001108 Combining flags means they are "and"ed together, e.g.:
1109 h+ hidden buffers which are modified
1110 a+ active buffers which are modified
1111
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02001112 When using |:filter| the pattern is matched against the
1113 displayed buffer name, e.g.: >
1114 filter /\.vim/ ls
1115<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001116 *:bad* *:badd*
1117:bad[d] [+lnum] {fname}
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02001118 Add file name {fname} to the buffer list, without loading it,
1119 if it wasn't listed yet. If the buffer was previously
1120 deleted, not wiped, it will be made listed again.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001121 If "lnum" is specified, the cursor will be positioned at that
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001122 line when the buffer is first entered. Note that other
Bram Moolenaar071d4272004-06-13 20:20:40 +00001123 commands after the + will be ignored.
1124
Bram Moolenaar59d8e562020-11-07 18:41:10 +01001125 *:balt*
1126:balt [+lnum] {fname}
1127 Like `:badd` and also set the alternate file for the current
1128 window to {fname}.
1129
Bram Moolenaar071d4272004-06-13 20:20:40 +00001130:[N]bd[elete][!] *:bd* *:bdel* *:bdelete* *E516*
1131:bd[elete][!] [N]
1132 Unload buffer [N] (default: current buffer) and delete it from
1133 the buffer list. If the buffer was changed, this fails,
1134 unless when [!] is specified, in which case changes are lost.
1135 The file remains unaffected. Any windows for this buffer are
1136 closed. If buffer [N] is the current buffer, another buffer
1137 will be displayed instead. This is the most recent entry in
1138 the jump list that points into a loaded buffer.
1139 Actually, the buffer isn't completely deleted, it is removed
1140 from the buffer list |unlisted-buffer| and option values,
1141 variables and mappings/abbreviations for the buffer are
Bram Moolenaar4d84d932014-11-30 14:50:16 +01001142 cleared. Examples: >
1143 :.,$-bdelete " delete buffers from the current one to
1144 " last but one
1145 :%bdelete " delete all buffers
1146<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001147
1148:bdelete[!] {bufname} *E93* *E94*
Bram Moolenaar15142e22018-04-30 22:19:58 +02001149 Like ":bdelete[!] [N]", but buffer given by name, see
1150 |{bufname}|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001151
1152:bdelete[!] N1 N2 ...
1153 Do ":bdelete[!]" for buffer N1, N2, etc. The arguments can be
1154 buffer numbers or buffer names (but not buffer names that are
1155 a number). Insert a backslash before a space in a buffer
1156 name.
1157
1158:N,Mbdelete[!] Do ":bdelete[!]" for all buffers in the range N to M
1159 |inclusive|.
1160
1161:[N]bw[ipeout][!] *:bw* *:bwipe* *:bwipeout* *E517*
1162:bw[ipeout][!] {bufname}
1163:N,Mbw[ipeout][!]
1164:bw[ipeout][!] N1 N2 ...
Bram Moolenaardf1bdc92006-02-23 21:32:16 +00001165 Like |:bdelete|, but really delete the buffer. Everything
1166 related to the buffer is lost. All marks in this buffer
1167 become invalid, option settings are lost, etc. Don't use this
Bram Moolenaar4d84d932014-11-30 14:50:16 +01001168 unless you know what you are doing. Examples: >
1169 :.+,$bwipeout " wipe out all buffers after the current
1170 " one
1171 :%bwipeout " wipe out all buffers
1172<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001173
1174:[N]bun[load][!] *:bun* *:bunload* *E515*
1175:bun[load][!] [N]
1176 Unload buffer [N] (default: current buffer). The memory
1177 allocated for this buffer will be freed. The buffer remains
1178 in the buffer list.
1179 If the buffer was changed, this fails, unless when [!] is
1180 specified, in which case the changes are lost.
1181 Any windows for this buffer are closed. If buffer [N] is the
1182 current buffer, another buffer will be displayed instead.
1183 This is the most recent entry in the jump list that points
1184 into a loaded buffer.
1185
1186:bunload[!] {bufname}
Bram Moolenaar15142e22018-04-30 22:19:58 +02001187 Like ":bunload[!] [N]", but buffer given by name.
1188 Also see |{bufname}|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001189
1190:N,Mbunload[!] Do ":bunload[!]" for all buffers in the range N to M
1191 |inclusive|.
1192
1193:bunload[!] N1 N2 ...
1194 Do ":bunload[!]" for buffer N1, N2, etc. The arguments can be
1195 buffer numbers or buffer names (but not buffer names that are
1196 a number). Insert a backslash before a space in a buffer
1197 name.
1198
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001199:[N]b[uffer][!] [+cmd] [N] *:b* *:bu* *:buf* *:buffer* *E86*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001200 Edit buffer [N] from the buffer list. If [N] is not given,
1201 the current buffer remains being edited. See |:buffer-!| for
1202 [!]. This will also edit a buffer that is not in the buffer
1203 list, without setting the 'buflisted' flag.
Bram Moolenaar47003982021-12-05 21:54:04 +00001204 The notation with single quotes does not work here,
1205 `:buf 12'345'` uses 12'345 as a buffer name.
Bram Moolenaar12969c02015-09-08 23:36:10 +02001206 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001207
Bram Moolenaar15142e22018-04-30 22:19:58 +02001208:[N]b[uffer][!] [+cmd] {bufname} *{bufname}*
1209 Edit buffer for {bufname} from the buffer list. A partial
1210 name also works, so long as it is unique in the list of
1211 buffers.
1212 Note that a buffer whose name is a number cannot be referenced
1213 by that name; use the buffer number instead.
1214 Insert a backslash before a space in a buffer name.
1215 See |:buffer-!| for [!].
1216 This will also edit a buffer that is not in the buffer list,
1217 without setting the 'buflisted' flag.
Bram Moolenaar12969c02015-09-08 23:36:10 +02001218 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001219
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001220:[N]sb[uffer] [+cmd] [N] *:sb* *:sbuffer*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001221 Split window and edit buffer [N] from the buffer list. If [N]
1222 is not given, the current buffer is edited. Respects the
1223 "useopen" setting of 'switchbuf' when splitting. This will
1224 also edit a buffer that is not in the buffer list, without
1225 setting the 'buflisted' flag.
Bram Moolenaar12969c02015-09-08 23:36:10 +02001226 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001227
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001228:[N]sb[uffer] [+cmd] {bufname}
Bram Moolenaar15142e22018-04-30 22:19:58 +02001229 Split window and edit buffer for |{bufname}| from the buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001230 list. This will also edit a buffer that is not in the buffer
1231 list, without setting the 'buflisted' flag.
Bram Moolenaar280f1262006-01-30 00:14:18 +00001232 Note: If what you want to do is split the buffer, make a copy
1233 under another name, you can do it this way: >
1234 :w foobar | sp #
Bram Moolenaar12969c02015-09-08 23:36:10 +02001235< Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001236
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001237:[N]bn[ext][!] [+cmd] [N] *:bn* *:bnext* *E87*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001238 Go to [N]th next buffer in buffer list. [N] defaults to one.
1239 Wraps around the end of the buffer list.
1240 See |:buffer-!| for [!].
Bram Moolenaar12969c02015-09-08 23:36:10 +02001241 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001242 If you are in a help buffer, this takes you to the next help
1243 buffer (if there is one). Similarly, if you are in a normal
1244 (non-help) buffer, this takes you to the next normal buffer.
1245 This is so that if you have invoked help, it doesn't get in
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001246 the way when you're browsing code/text buffers. The next three
Bram Moolenaar071d4272004-06-13 20:20:40 +00001247 commands also work like this.
1248
1249 *:sbn* *:sbnext*
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001250:[N]sbn[ext] [+cmd] [N]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001251 Split window and go to [N]th next buffer in buffer list.
1252 Wraps around the end of the buffer list. Uses 'switchbuf'
Bram Moolenaar12969c02015-09-08 23:36:10 +02001253 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001254
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001255:[N]bN[ext][!] [+cmd] [N] *:bN* *:bNext* *:bp* *:bprevious* *E88*
1256:[N]bp[revious][!] [+cmd] [N]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001257 Go to [N]th previous buffer in buffer list. [N] defaults to
1258 one. Wraps around the start of the buffer list.
1259 See |:buffer-!| for [!] and 'switchbuf'.
Bram Moolenaar12969c02015-09-08 23:36:10 +02001260 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001261
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001262:[N]sbN[ext] [+cmd] [N] *:sbN* *:sbNext* *:sbp* *:sbprevious*
1263:[N]sbp[revious] [+cmd] [N]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001264 Split window and go to [N]th previous buffer in buffer list.
1265 Wraps around the start of the buffer list.
1266 Uses 'switchbuf'.
Bram Moolenaar12969c02015-09-08 23:36:10 +02001267 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001268
Bram Moolenaar61da1bf2019-06-06 12:14:49 +02001269:br[ewind][!] [+cmd] *:br* *:bre* *:brewind*
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001270 Go to first buffer in buffer list. If the buffer list is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001271 empty, go to the first unlisted buffer.
1272 See |:buffer-!| for [!].
1273
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001274:bf[irst] [+cmd] *:bf* *:bfirst*
1275 Same as |:brewind|.
1276 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001277
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001278:sbr[ewind] [+cmd] *:sbr* *:sbrewind*
1279 Split window and go to first buffer in buffer list. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001280 buffer list is empty, go to the first unlisted buffer.
1281 Respects the 'switchbuf' option.
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001282 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001283
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001284:sbf[irst] [+cmd] *:sbf* *:sbfirst*
1285 Same as ":sbrewind".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001286
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001287:bl[ast][!] [+cmd] *:bl* *:blast*
1288 Go to last buffer in buffer list. If the buffer list is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001289 empty, go to the last unlisted buffer.
1290 See |:buffer-!| for [!].
1291
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001292:sbl[ast] [+cmd] *:sbl* *:sblast*
1293 Split window and go to last buffer in buffer list. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001294 buffer list is empty, go to the last unlisted buffer.
1295 Respects 'switchbuf' option.
1296
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001297:[N]bm[odified][!] [+cmd] [N] *:bm* *:bmodified* *E84*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001298 Go to [N]th next modified buffer. Note: this command also
1299 finds unlisted buffers. If there is no modified buffer the
1300 command fails.
1301
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001302:[N]sbm[odified] [+cmd] [N] *:sbm* *:sbmodified*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001303 Split window and go to [N]th next modified buffer.
1304 Respects 'switchbuf' option.
1305 Note: this command also finds buffers not in the buffer list.
1306
1307:[N]unh[ide] [N] *:unh* *:unhide* *:sun* *:sunhide*
1308:[N]sun[hide] [N]
1309 Rearrange the screen to open one window for each loaded buffer
1310 in the buffer list. When a count is given, this is the
1311 maximum number of windows to open.
1312
1313:[N]ba[ll] [N] *:ba* *:ball* *:sba* *:sball*
1314:[N]sba[ll] [N] Rearrange the screen to open one window for each buffer in
1315 the buffer list. When a count is given, this is the maximum
1316 number of windows to open. 'winheight' also limits the number
1317 of windows opened ('winwidth' if |:vertical| was prepended).
1318 Buf/Win Enter/Leave autocommands are not executed for the new
1319 windows here, that's only done when they are really entered.
Bram Moolenaar756ec0f2007-05-05 17:59:48 +00001320 When the |:tab| modifier is used new windows are opened in a
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00001321 new tab, up to 'tabpagemax'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001322
1323Note: All the commands above that start editing another buffer, keep the
1324'readonly' flag as it was. This differs from the ":edit" command, which sets
1325the 'readonly' flag each time the file is read.
1326
1327==============================================================================
132812. Special kinds of buffers *special-buffers*
1329
1330Instead of containing the text of a file, buffers can also be used for other
1331purposes. A few options can be set to change the behavior of a buffer:
1332 'bufhidden' what happens when the buffer is no longer displayed
1333 in a window.
1334 'buftype' what kind of a buffer this is
1335 'swapfile' whether the buffer will have a swap file
1336 'buflisted' buffer shows up in the buffer list
1337
1338A few useful kinds of a buffer:
1339
Bram Moolenaar280f1262006-01-30 00:14:18 +00001340quickfix Used to contain the error list or the location list. See
1341 |:cwindow| and |:lwindow|. This command sets the 'buftype'
1342 option to "quickfix". You are not supposed to change this!
1343 'swapfile' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001344
1345help Contains a help file. Will only be created with the |:help|
1346 command. The flag that indicates a help buffer is internal
1347 and can't be changed. The 'buflisted' option will be reset
1348 for a help buffer.
1349
Bram Moolenaarb6e0ec62017-07-23 22:12:20 +02001350terminal A terminal window buffer, see |terminal|. The contents cannot
1351 be read or changed until the job ends.
1352
Bram Moolenaar677ee682005-01-27 14:41:15 +00001353directory Displays directory contents. Can be used by a file explorer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001354 plugin. The buffer is created with these settings: >
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001355 :setlocal buftype=nowrite
1356 :setlocal bufhidden=delete
1357 :setlocal noswapfile
Bram Moolenaar071d4272004-06-13 20:20:40 +00001358< The buffer name is the name of the directory and is adjusted
1359 when using the |:cd| command.
1360
Yegappan Lakshmanand1a8d652021-11-03 21:56:45 +00001361 *scratch-buffer*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001362scratch Contains text that can be discarded at any time. It is kept
1363 when closing the window, it must be deleted explicitly.
1364 Settings: >
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001365 :setlocal buftype=nofile
1366 :setlocal bufhidden=hide
1367 :setlocal noswapfile
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001368< The buffer name can be used to identify the buffer, if you
1369 give it a meaningful name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001370
1371 *unlisted-buffer*
1372unlisted The buffer is not in the buffer list. It is not used for
1373 normal editing, but to show a help file, remember a file name
1374 or marks. The ":bdelete" command will also set this option,
1375 thus it doesn't completely delete the buffer. Settings: >
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001376 :setlocal nobuflisted
Bram Moolenaar071d4272004-06-13 20:20:40 +00001377<
1378
Bram Moolenaard473c8c2018-08-11 18:00:22 +02001379 vim:tw=78:ts=8:noet:ft=help:norl: