blob: 87a5d6f6d817d3f6e3f635b53fc50049968ffb8a [file] [log] [blame]
Bram Moolenaar54775062019-07-31 21:07:14 +02001*windows.txt* For Vim version 8.1. Last change: 2019 Jul 27
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
140==============================================================================
1413. Opening and closing a window *opening-window* *E36*
142
143CTRL-W s *CTRL-W_s*
144CTRL-W S *CTRL-W_S*
145CTRL-W CTRL-S *CTRL-W_CTRL-S*
Bram Moolenaar7b449342014-03-25 13:03:48 +0100146:[N]sp[lit] [++opt] [+cmd] [file] *:sp* *:split*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000147 Split current window in two. The result is two viewports on
Bram Moolenaar7b449342014-03-25 13:03:48 +0100148 the same file.
149
150 Make the new window N high (default is to use half the height
151 of the current window). Reduces the current window height to
152 create room (and others, if the 'equalalways' option is set,
153 'eadirection' isn't "hor", and one of them is higher than the
154 current or the new window).
155
156 If [file] is given it will be edited in the new window. If it
157 is not loaded in any buffer, it will be read. Else the new
158 window will use the already loaded buffer.
159
Bram Moolenaar071d4272004-06-13 20:20:40 +0000160 Note: CTRL-S does not work on all terminals and might block
161 further input, use CTRL-Q to get going again.
162 Also see |++opt| and |+cmd|.
Bram Moolenaar54775062019-07-31 21:07:14 +0200163 *E242*
164 Be careful when splitting a window in an autocommand, it may
165 mess up the window layout if this happens while making other
166 window layout changes.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000167
168CTRL-W CTRL-V *CTRL-W_CTRL-V*
169CTRL-W v *CTRL-W_v*
170:[N]vs[plit] [++opt] [+cmd] [file] *:vs* *:vsplit*
Bram Moolenaar67f71312007-08-12 14:55:56 +0000171 Like |:split|, but split vertically. The windows will be
172 spread out horizontally if
173 1. a width was not specified,
174 2. 'equalalways' is set,
175 3. 'eadirection' isn't "ver", and
Bram Moolenaarc1a11ed2008-06-24 22:09:24 +0000176 4. one of the other windows is wider than the current or new
Bram Moolenaar67f71312007-08-12 14:55:56 +0000177 window.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000178 Note: In other places CTRL-Q does the same as CTRL-V, but here
179 it doesn't!
180
181CTRL-W n *CTRL-W_n*
182CTRL-W CTRL_N *CTRL-W_CTRL-N*
183:[N]new [++opt] [+cmd] *:new*
184 Create a new window and start editing an empty file in it.
185 Make new window N high (default is to use half the existing
186 height). Reduces the current window height to create room (and
187 others, if the 'equalalways' option is set and 'eadirection'
188 isn't "hor").
189 Also see |++opt| and |+cmd|.
190 If 'fileformats' is not empty, the first format given will be
191 used for the new buffer. If 'fileformats' is empty, the
192 'fileformat' of the current buffer is used. This can be
193 overridden with the |++opt| argument.
194 Autocommands are executed in this order:
195 1. WinLeave for the current window
196 2. WinEnter for the new window
197 3. BufLeave for the current buffer
198 4. BufEnter for the new buffer
Bram Moolenaar53bfca22012-04-13 23:04:47 +0200199 This behaves like a ":split" first, and then an ":enew"
200 command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000201
202:[N]vne[w] [++opt] [+cmd] [file] *:vne* *:vnew*
203 Like |:new|, but split vertically. If 'equalalways' is set
204 and 'eadirection' isn't "ver" the windows will be spread out
205 horizontally, unless a width was specified.
206
207:[N]new [++opt] [+cmd] {file}
208:[N]sp[lit] [++opt] [+cmd] {file} *:split_f*
Bram Moolenaar53bfca22012-04-13 23:04:47 +0200209 Create a new window and start editing file {file} in it. This
210 behaves like a ":split" first, and then an ":e" command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000211 If [+cmd] is given, execute the command when the file has been
212 loaded |+cmd|.
213 Also see |++opt|.
214 Make new window N high (default is to use half the existing
215 height). Reduces the current window height to create room
216 (and others, if the 'equalalways' option is set).
217
218:[N]sv[iew] [++opt] [+cmd] {file} *:sv* *:sview* *splitview*
219 Same as ":split", but set 'readonly' option for this buffer.
220
Bram Moolenaar61da1bf2019-06-06 12:14:49 +0200221:[N]sf[ind] [++opt] [+cmd] {file} *:sf* *:sfi* *:sfind* *splitfind*
Bram Moolenaarc236c162008-07-13 17:41:49 +0000222 Same as ":split", but search for {file} in 'path' like in
223 |:find|. Doesn't split if {file} is not found.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000224
225CTRL-W CTRL-^ *CTRL-W_CTRL-^* *CTRL-W_^*
Bram Moolenaar1bbb6192018-11-10 16:02:01 +0100226CTRL-W ^ Split the current window in two and edit the alternate file.
227 When a count N is given, split the current window and edit
228 buffer N. Similar to ":sp #" and ":sp #N", but it allows the
229 other buffer to be unnamed. This command matches the behavior
230 of |CTRL-^|, except that it splits a window first.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000231
Bram Moolenaarb6e0ec62017-07-23 22:12:20 +0200232 *CTRL-W_:*
Bram Moolenaard2f3a8b2018-06-19 14:35:59 +0200233CTRL-W : Does the same as typing |:| - enter a command line. Useful in a
Bram Moolenaarb6e0ec62017-07-23 22:12:20 +0200234 terminal window, where all Vim commands must be preceded with
Bram Moolenaard2f3a8b2018-06-19 14:35:59 +0200235 CTRL-W or 'termwinkey'.
Bram Moolenaarb6e0ec62017-07-23 22:12:20 +0200236
Bram Moolenaar071d4272004-06-13 20:20:40 +0000237Note that the 'splitbelow' and 'splitright' options influence where a new
238window will appear.
239
240 *:vert* *:vertical*
241:vert[ical] {cmd}
242 Execute {cmd}. If it contains a command that splits a window,
243 it will be split vertically.
Bram Moolenaar756ec0f2007-05-05 17:59:48 +0000244 Doesn't work for |:execute| and |:normal|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000245
246:lefta[bove] {cmd} *:lefta* *:leftabove*
247:abo[veleft] {cmd} *:abo* *:aboveleft*
248 Execute {cmd}. If it contains a command that splits a window,
249 it will be opened left (vertical split) or above (horizontal
250 split) the current window. Overrules 'splitbelow' and
251 'splitright'.
Bram Moolenaar756ec0f2007-05-05 17:59:48 +0000252 Doesn't work for |:execute| and |:normal|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000253
254:rightb[elow] {cmd} *:rightb* *:rightbelow*
255:bel[owright] {cmd} *:bel* *:belowright*
256 Execute {cmd}. If it contains a command that splits a window,
257 it will be opened right (vertical split) or below (horizontal
258 split) the current window. Overrules 'splitbelow' and
259 'splitright'.
Bram Moolenaar756ec0f2007-05-05 17:59:48 +0000260 Doesn't work for |:execute| and |:normal|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000261
262 *:topleft* *E442*
263:to[pleft] {cmd}
264 Execute {cmd}. If it contains a command that splits a window,
265 it will appear at the top and occupy the full width of the Vim
266 window. When the split is vertical the window appears at the
267 far left and occupies the full height of the Vim window.
Bram Moolenaar756ec0f2007-05-05 17:59:48 +0000268 Doesn't work for |:execute| and |:normal|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000269
Bram Moolenaarbc8801c2016-08-02 21:04:33 +0200270 *:bo* *:botright*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000271:bo[tright] {cmd}
272 Execute {cmd}. If it contains a command that splits a window,
273 it will appear at the bottom and occupy the full width of the
274 Vim window. When the split is vertical the window appears at
275 the far right and occupies the full height of the Vim window.
Bram Moolenaar756ec0f2007-05-05 17:59:48 +0000276 Doesn't work for |:execute| and |:normal|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000277
278These command modifiers can be combined to make a vertically split window
279occupy the full height. Example: >
Bram Moolenaar5302d9e2011-09-14 17:55:08 +0200280 :vertical topleft split tags
Bram Moolenaar071d4272004-06-13 20:20:40 +0000281Opens a vertically split, full-height window on the "tags" file at the far
282left of the Vim window.
283
284
285Closing a window
286----------------
287
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100288:q[uit]
289:{count}q[uit]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000290CTRL-W q *CTRL-W_q*
291CTRL-W CTRL-Q *CTRL-W_CTRL-Q*
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100292 Without {count}: Quit the current window. If {count} is
293 given quit the {count} window.
294
295 When quitting the last window (not counting a help window),
296 exit Vim.
297
Bram Moolenaar071d4272004-06-13 20:20:40 +0000298 When 'hidden' is set, and there is only one window for the
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100299 current buffer, it becomes hidden. When 'hidden' is not set,
300 and there is only one window for the current buffer, and the
301 buffer was changed, the command fails.
302
Bram Moolenaared32d942014-12-06 23:33:00 +0100303 (Note: CTRL-Q does not work on all terminals).
304
305 If [count] is greater than the last window number the last
306 window will be closed: >
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100307 :1quit " quit the first window
308 :$quit " quit the last window
309 :9quit " quit the last window
Bram Moolenaar46fceaa2016-10-23 21:21:08 +0200310 " if there are fewer than 9 windows opened
311 :-quit " quit the previous window
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100312 :+quit " quit the next window
Bram Moolenaared32d942014-12-06 23:33:00 +0100313 :+2quit " quit the second next window
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100314<
315:q[uit]!
316:{count}q[uit]!
317 Without {count}: Quit the current window. If {count} is
318 given quit the {count} window.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000319
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100320 If this was the last window for a buffer, any changes to that
321 buffer are lost. When quitting the last window (not counting
322 help windows), exit Vim. The contents of the buffer are lost,
323 even when 'hidden' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000324
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100325:clo[se][!]
326:{count}clo[se][!]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000327CTRL-W c *CTRL-W_c* *:clo* *:close*
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100328 Without {count}: Close the current window. If {count} is
329 given close the {count} window.
330
331 When the 'hidden' option is set, or when the buffer was
332 changed and the [!] is used, the buffer becomes hidden (unless
333 there is another window editing it).
334
Bram Moolenaar7e8fd632006-02-18 22:14:51 +0000335 When there is only one window in the current tab page and
336 there is another tab page, this closes the current tab page.
337 |tab-page|.
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100338
Bram Moolenaar071d4272004-06-13 20:20:40 +0000339 This command fails when: *E444*
340 - There is only one window on the screen.
341 - When 'hidden' is not set, [!] is not used, the buffer has
342 changes, and there is no other window on this buffer.
343 Changes to the buffer are not written and won't get lost, so
344 this is a "safe" command.
345
346CTRL-W CTRL-C *CTRL-W_CTRL-C*
347 You might have expected that CTRL-W CTRL-C closes the current
348 window, but that does not work, because the CTRL-C cancels the
349 command.
350
351 *:hide*
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100352:hid[e]
353:{count}hid[e]
Bram Moolenaarc572da52017-08-27 16:52:01 +0200354 Without {count}: Quit the current window, unless it is the
355 last window on the screen.
356 If {count} is given quit the {count} window.
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100357
358 The buffer becomes hidden (unless there is another window
Bram Moolenaared32d942014-12-06 23:33:00 +0100359 editing it or 'bufhidden' is "unload", "delete" or "wipe").
360 If the window is the last one in the current tab page the tab
361 page is closed. |tab-page|
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100362
363 The value of 'hidden' is irrelevant for this command. Changes
364 to the buffer are not written and won't get lost, so this is a
365 "safe" command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000366
367:hid[e] {cmd} Execute {cmd} with 'hidden' is set. The previous value of
368 'hidden' is restored after {cmd} has been executed.
369 Example: >
370 :hide edit Makefile
371< This will edit "Makefile", and hide the current buffer if it
372 has any changes.
373
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100374:on[ly][!]
375:{count}on[ly][!]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000376CTRL-W o *CTRL-W_o* *E445*
377CTRL-W CTRL-O *CTRL-W_CTRL-O* *:on* *:only*
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100378 Make the current window the only one on the screen. All other
379 windows are closed. For {count} see |:quit| command.
380
Bram Moolenaar071d4272004-06-13 20:20:40 +0000381 When the 'hidden' option is set, all buffers in closed windows
382 become hidden.
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100383
Bram Moolenaar071d4272004-06-13 20:20:40 +0000384 When 'hidden' is not set, and the 'autowrite' option is set,
385 modified buffers are written. Otherwise, windows that have
386 buffers that are modified are not removed, unless the [!] is
387 given, then they become hidden. But modified buffers are
388 never abandoned, so changes cannot get lost.
389
390==============================================================================
3914. Moving cursor to other windows *window-move-cursor*
392
393CTRL-W <Down> *CTRL-W_<Down>*
394CTRL-W CTRL-J *CTRL-W_CTRL-J* *CTRL-W_j*
395CTRL-W j Move cursor to Nth window below current one. Uses the cursor
396 position to select between alternatives.
397
398CTRL-W <Up> *CTRL-W_<Up>*
399CTRL-W CTRL-K *CTRL-W_CTRL-K* *CTRL-W_k*
400CTRL-W k Move cursor to Nth window above current one. Uses the cursor
401 position to select between alternatives.
402
403CTRL-W <Left> *CTRL-W_<Left>*
404CTRL-W CTRL-H *CTRL-W_CTRL-H*
405CTRL-W <BS> *CTRL-W_<BS>* *CTRL-W_h*
406CTRL-W h Move cursor to Nth window left of current one. Uses the
407 cursor position to select between alternatives.
408
409CTRL-W <Right> *CTRL-W_<Right>*
410CTRL-W CTRL-L *CTRL-W_CTRL-L* *CTRL-W_l*
411CTRL-W l Move cursor to Nth window right of current one. Uses the
412 cursor position to select between alternatives.
413
414CTRL-W w *CTRL-W_w* *CTRL-W_CTRL-W*
415CTRL-W CTRL-W Without count: move cursor to window below/right of the
416 current one. If there is no window below or right, go to
417 top-left window.
418 With count: go to Nth window (windows are numbered from
419 top-left to bottom-right). To obtain the window number see
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100420 |bufwinnr()| and |winnr()|. When N is larger than the number
421 of windows go to the last window.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000422
423 *CTRL-W_W*
424CTRL-W W Without count: move cursor to window above/left of current
425 one. If there is no window above or left, go to bottom-right
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100426 window. With count: go to Nth window, like with CTRL-W w.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000427
428CTRL-W t *CTRL-W_t* *CTRL-W_CTRL-T*
429CTRL-W CTRL-T Move cursor to top-left window.
430
431CTRL-W b *CTRL-W_b* *CTRL-W_CTRL-B*
432CTRL-W CTRL-B Move cursor to bottom-right window.
433
434CTRL-W p *CTRL-W_p* *CTRL-W_CTRL-P*
435CTRL-W CTRL-P Go to previous (last accessed) window.
436
437 *CTRL-W_P* *E441*
438CTRL-W P Go to preview window. When there is no preview window this is
439 an error.
440 {not available when compiled without the |+quickfix| feature}
441
442If Visual mode is active and the new window is not for the same buffer, the
443Visual mode is ended. If the window is on the same buffer, the cursor
444position is set to keep the same Visual area selected.
445
446 *:winc* *:wincmd*
447These commands can also be executed with ":wincmd":
448
449:[count]winc[md] {arg}
450 Like executing CTRL-W [count] {arg}. Example: >
451 :wincmd j
452< Moves to the window below the current one.
453 This command is useful when a Normal mode cannot be used (for
454 the |CursorHold| autocommand event). Or when a Normal mode
455 command is inconvenient.
456 The count can also be a window number. Example: >
457 :exe nr . "wincmd w"
458< This goes to window "nr".
459
460==============================================================================
4615. Moving windows around *window-moving*
462
463CTRL-W r *CTRL-W_r* *CTRL-W_CTRL-R* *E443*
464CTRL-W CTRL-R Rotate windows downwards/rightwards. The first window becomes
465 the second one, the second one becomes the third one, etc.
466 The last window becomes the first window. The cursor remains
467 in the same window.
468 This only works within the row or column of windows that the
469 current window is in.
470
471 *CTRL-W_R*
472CTRL-W R Rotate windows upwards/leftwards. The second window becomes
473 the first one, the third one becomes the second one, etc. The
474 first window becomes the last window. The cursor remains in
475 the same window.
476 This only works within the row or column of windows that the
477 current window is in.
478
479CTRL-W x *CTRL-W_x* *CTRL-W_CTRL-X*
480CTRL-W CTRL-X Without count: Exchange current window with next one. If there
481 is no next window, exchange with previous window.
482 With count: Exchange current window with Nth window (first
483 window is 1). The cursor is put in the other window.
484 When vertical and horizontal window splits are mixed, the
485 exchange is only done in the row or column of windows that the
486 current window is in.
487
488The following commands can be used to change the window layout. For example,
489when there are two vertically split windows, CTRL-W K will change that in
490horizontally split windows. CTRL-W H does it the other way around.
491
492 *CTRL-W_K*
493CTRL-W K Move the current window to be at the very top, using the full
494 width of the screen. This works like closing the current
495 window and then creating another one with ":topleft split",
496 except that the current window contents is used for the new
497 window.
498
499 *CTRL-W_J*
500CTRL-W J Move the current window to be at the very bottom, using the
501 full width of the screen. This works like closing the current
502 window and then creating another one with ":botright split",
503 except that the current window contents is used for the new
504 window.
505
506 *CTRL-W_H*
507CTRL-W H Move the current window to be at the far left, using the
508 full height of the screen. This works like closing the
509 current window and then creating another one with
510 ":vert topleft split", except that the current window contents
511 is used for the new window.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000512
513 *CTRL-W_L*
514CTRL-W L Move the current window to be at the far right, using the full
515 height of the screen. This works like closing the
516 current window and then creating another one with
517 ":vert botright split", except that the current window
518 contents is used for the new window.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000519
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000520 *CTRL-W_T*
521CTRL-W T Move the current window to a new tab page. This fails if
522 there is only one window in the current tab page.
523 When a count is specified the new tab page will be opened
524 before the tab page with this index. Otherwise it comes after
525 the current tab page.
526
Bram Moolenaar071d4272004-06-13 20:20:40 +0000527==============================================================================
5286. Window resizing *window-resize*
529
530 *CTRL-W_=*
531CTRL-W = Make all windows (almost) equally high and wide, but use
532 'winheight' and 'winwidth' for the current window.
Bram Moolenaar756ec0f2007-05-05 17:59:48 +0000533 Windows with 'winfixheight' set keep their height and windows
534 with 'winfixwidth' set keep their width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000535
536:res[ize] -N *:res* *:resize* *CTRL-W_-*
537CTRL-W - Decrease current window height by N (default 1).
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200538 If used after |:vertical|: decrease width by N.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000539
540:res[ize] +N *CTRL-W_+*
541CTRL-W + Increase current window height by N (default 1).
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200542 If used after |:vertical|: increase width by N.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000543
544:res[ize] [N]
545CTRL-W CTRL-_ *CTRL-W_CTRL-_* *CTRL-W__*
546CTRL-W _ Set current window height to N (default: highest possible).
547
548z{nr}<CR> Set current window height to {nr}.
549
550 *CTRL-W_<*
551CTRL-W < Decrease current window width by N (default 1).
552
553 *CTRL-W_>*
554CTRL-W > Increase current window width by N (default 1).
555
556:vertical res[ize] [N] *:vertical-resize* *CTRL-W_bar*
557CTRL-W | Set current window width to N (default: widest possible).
558
559You can also resize a window by dragging a status line up or down with the
560mouse. Or by dragging a vertical separator line left or right. This only
561works if the version of Vim that is being used supports the mouse and the
562'mouse' option has been set to enable it.
563
564The option 'winheight' ('wh') is used to set the minimal window height of the
565current window. This option is used each time another window becomes the
566current window. If the option is '0', it is disabled. Set 'winheight' to a
567very large value, e.g., '9999', to make the current window always fill all
568available space. Set it to a reasonable value, e.g., '10', to make editing in
569the current window comfortable.
570
571The equivalent 'winwidth' ('wiw') option is used to set the minimal width of
572the current window.
573
574When the option 'equalalways' ('ea') is set, all the windows are automatically
575made the same size after splitting or closing a window. If you don't set this
576option, splitting a window will reduce the size of the current window and
577leave the other windows the same. When closing a window, the extra lines are
578given to the window above it.
579
580The 'eadirection' option limits the direction in which the 'equalalways'
581option is applied. The default "both" resizes in both directions. When the
582value is "ver" only the heights of windows are equalized. Use this when you
583have manually resized a vertically split window and want to keep this width.
584Likewise, "hor" causes only the widths of windows to be equalized.
585
586The option 'cmdheight' ('ch') is used to set the height of the command-line.
587If you are annoyed by the |hit-enter| prompt for long messages, set this
588option to 2 or 3.
589
590If there is only one window, resizing that window will also change the command
591line height. If there are several windows, resizing the current window will
592also change the height of the window below it (and sometimes the window above
593it).
594
595The minimal height and width of a window is set with 'winminheight' and
596'winminwidth'. These are hard values, a window will never become smaller.
597
598==============================================================================
5997. Argument and buffer list commands *buffer-list*
600
601 args list buffer list meaning ~
6021. :[N]argument [N] 11. :[N]buffer [N] to arg/buf N
6032. :[N]next [file ..] 12. :[N]bnext [N] to Nth next arg/buf
6043. :[N]Next [N] 13. :[N]bNext [N] to Nth previous arg/buf
6054. :[N]previous [N] 14. :[N]bprevious [N] to Nth previous arg/buf
6065. :rewind / :first 15. :brewind / :bfirst to first arg/buf
6076. :last 16. :blast to last arg/buf
6087. :all 17. :ball edit all args/buffers
609 18. :unhide edit all loaded buffers
610 19. :[N]bmod [N] to Nth modified buf
611
612 split & args list split & buffer list meaning ~
61321. :[N]sargument [N] 31. :[N]sbuffer [N] split + to arg/buf N
61422. :[N]snext [file ..] 32. :[N]sbnext [N] split + to Nth next arg/buf
61523. :[N]sNext [N] 33. :[N]sbNext [N] split + to Nth previous arg/buf
61624. :[N]sprevious [N] 34. :[N]sbprevious [N] split + to Nth previous arg/buf
61725. :srewind / :sfirst 35. :sbrewind / :sbfirst split + to first arg/buf
61826. :slast 36. :sblast split + to last arg/buf
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +000061927. :sall 37. :sball edit all args/buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +0000620 38. :sunhide edit all loaded buffers
621 39. :[N]sbmod [N] split + to Nth modified buf
622
62340. :args list of arguments
62441. :buffers list of buffers
625
626The meaning of [N] depends on the command:
Bram Moolenaar24a98a02017-09-27 22:23:55 +0200627 [N] is the number of buffers to go forward/backward on 2/12/22/32,
628 3/13/23/33, and 4/14/24/34
Bram Moolenaar071d4272004-06-13 20:20:40 +0000629 [N] is an argument number, defaulting to current argument, for 1 and 21
630 [N] is a buffer number, defaulting to current buffer, for 11 and 31
631 [N] is a count for 19 and 39
632
633Note: ":next" is an exception, because it must accept a list of file names
634for compatibility with Vi.
635
636
637The argument list and multiple windows
638--------------------------------------
639
640The current position in the argument list can be different for each window.
641Remember that when doing ":e file", the position in the argument list stays
642the same, but you are not editing the file at that position. To indicate
643this, the file message (and the title, if you have one) shows
644"(file (N) of M)", where "(N)" is the current position in the file list, and
645"M" the number of files in the file list.
646
647All the entries in the argument list are added to the buffer list. Thus, you
648can also get to them with the buffer list commands, like ":bnext".
649
650:[N]al[l][!] [N] *:al* *:all* *:sal* *:sall*
651:[N]sal[l][!] [N]
652 Rearrange the screen to open one window for each argument.
653 All other windows are closed. When a count is given, this is
654 the maximum number of windows to open.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +0000655 With the |:tab| modifier open a tab page for each argument.
656 When there are more arguments than 'tabpagemax' further ones
657 become split windows in the last tab page.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000658 When the 'hidden' option is set, all buffers in closed windows
659 become hidden.
660 When 'hidden' is not set, and the 'autowrite' option is set,
661 modified buffers are written. Otherwise, windows that have
662 buffers that are modified are not removed, unless the [!] is
663 given, then they become hidden. But modified buffers are
664 never abandoned, so changes cannot get lost.
665 [N] is the maximum number of windows to open. 'winheight'
666 also limits the number of windows opened ('winwidth' if
667 |:vertical| was prepended).
668 Buf/Win Enter/Leave autocommands are not executed for the new
669 windows here, that's only done when they are really entered.
Bram Moolenaar54775062019-07-31 21:07:14 +0200670 If autocommands change the window layout while this command is
671 busy an error will be given. *E249*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000672
673:[N]sa[rgument][!] [++opt] [+cmd] [N] *:sa* *:sargument*
674 Short for ":split | argument [N]": split window and go to Nth
675 argument. But when there is no such argument, the window is
676 not split. Also see |++opt| and |+cmd|.
677
678:[N]sn[ext][!] [++opt] [+cmd] [file ..] *:sn* *:snext*
679 Short for ":split | [N]next": split window and go to Nth next
680 argument. But when there is no next file, the window is not
681 split. Also see |++opt| and |+cmd|.
682
683:[N]spr[evious][!] [++opt] [+cmd] [N] *:spr* *:sprevious*
684:[N]sN[ext][!] [++opt] [+cmd] [N] *:sN* *:sNext*
685 Short for ":split | [N]Next": split window and go to Nth
686 previous argument. But when there is no previous file, the
687 window is not split. Also see |++opt| and |+cmd|.
688
689 *:sre* *:srewind*
690:sre[wind][!] [++opt] [+cmd]
691 Short for ":split | rewind": split window and go to first
692 argument. But when there is no argument list, the window is
693 not split. Also see |++opt| and |+cmd|.
694
695 *:sfir* *:sfirst*
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000696:sfir[st] [++opt] [+cmd]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000697 Same as ":srewind".
698
699 *:sla* *:slast*
700:sla[st][!] [++opt] [+cmd]
701 Short for ":split | last": split window and go to last
702 argument. But when there is no argument list, the window is
703 not split. Also see |++opt| and |+cmd|.
704
705 *:dr* *:drop*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000706:dr[op] [++opt] [+cmd] {file} ..
Bram Moolenaar071d4272004-06-13 20:20:40 +0000707 Edit the first {file} in a window.
708 - If the file is already open in a window change to that
709 window.
710 - If the file is not open in a window edit the file in the
711 current window. If the current buffer can't be |abandon|ed,
712 the window is split first.
Bram Moolenaar51628222016-12-01 23:03:28 +0100713 - Windows that are not in the argument list or are not full
714 width will be closed if possible.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000715 The |argument-list| is set, like with the |:next| command.
716 The purpose of this command is that it can be used from a
717 program that wants Vim to edit another file, e.g., a debugger.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000718 When using the |:tab| modifier each argument is opened in a
719 tab page. The last window is used if it's empty.
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000720 Also see |++opt| and |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000721
722==============================================================================
7238. Do a command in all buffers or windows *list-repeat*
724
725 *:windo*
Bram Moolenaara162bc52015-01-07 16:54:21 +0100726:[range]windo {cmd} Execute {cmd} in each window or if [range] is given
727 only in windows for which the window number lies in
728 the [range]. It works like doing this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000729 CTRL-W t
730 :{cmd}
731 CTRL-W w
732 :{cmd}
733 etc.
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000734< This only operates in the current tab page.
Bram Moolenaar7e8fd632006-02-18 22:14:51 +0000735 When an error is detected on one window, further
Bram Moolenaar071d4272004-06-13 20:20:40 +0000736 windows will not be visited.
737 The last window (or where an error occurred) becomes
738 the current window.
739 {cmd} can contain '|' to concatenate several commands.
740 {cmd} must not open or close windows or reorder them.
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200741
Bram Moolenaaraa23b372015-09-08 18:46:31 +0200742 Also see |:tabdo|, |:argdo|, |:bufdo|, |:cdo|, |:ldo|,
743 |:cfdo| and |:lfdo|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000744
745 *:bufdo*
Bram Moolenaara162bc52015-01-07 16:54:21 +0100746:[range]bufdo[!] {cmd} Execute {cmd} in each buffer in the buffer list or if
747 [range] is given only for buffers for which their
Bram Moolenaar681baaf2016-02-04 20:57:07 +0100748 buffer number is in the [range]. It works like doing
Bram Moolenaara162bc52015-01-07 16:54:21 +0100749 this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000750 :bfirst
751 :{cmd}
752 :bnext
753 :{cmd}
754 etc.
755< When the current file can't be |abandon|ed and the [!]
756 is not present, the command fails.
757 When an error is detected on one buffer, further
758 buffers will not be visited.
759 Unlisted buffers are skipped.
760 The last buffer (or where an error occurred) becomes
761 the current buffer.
762 {cmd} can contain '|' to concatenate several commands.
763 {cmd} must not delete buffers or add buffers to the
764 buffer list.
765 Note: While this command is executing, the Syntax
766 autocommand event is disabled by adding it to
767 'eventignore'. This considerably speeds up editing
768 each buffer.
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200769
Bram Moolenaaraa23b372015-09-08 18:46:31 +0200770 Also see |:tabdo|, |:argdo|, |:windo|, |:cdo|, |:ldo|,
771 |:cfdo| and |:lfdo|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000772
773Examples: >
774
775 :windo set nolist nofoldcolumn | normal zn
776
777This resets the 'list' option and disables folding in all windows. >
778
779 :bufdo set fileencoding= | update
780
781This resets the 'fileencoding' in each buffer and writes it if this changed
782the buffer. The result is that all buffers will use the 'encoding' encoding
783(if conversion works properly).
784
785==============================================================================
7869. Tag or file name under the cursor *window-tag*
787
788 *:sta* *:stag*
789:sta[g][!] [tagname]
790 Does ":tag[!] [tagname]" and splits the window for the found
791 tag. See also |:tag|.
792
793CTRL-W ] *CTRL-W_]* *CTRL-W_CTRL-]*
794CTRL-W CTRL-] Split current window in two. Use identifier under cursor as a
Bram Moolenaar3a991dd2014-10-02 01:41:41 +0200795 tag and jump to it in the new upper window.
796 In Visual mode uses the Visually selected text as a tag.
797 Make new window N high.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000798
799 *CTRL-W_g]*
800CTRL-W g ] Split current window in two. Use identifier under cursor as a
801 tag and perform ":tselect" on it in the new upper window.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +0200802 In Visual mode uses the Visually selected text as a tag.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000803 Make new window N high.
804
805 *CTRL-W_g_CTRL-]*
806CTRL-W g CTRL-] Split current window in two. Use identifier under cursor as a
Bram Moolenaar3a991dd2014-10-02 01:41:41 +0200807 tag and perform ":tjump" on it in the new upper window.
808 In Visual mode uses the Visually selected text as a tag.
809 Make new window N high.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000810
811CTRL-W f *CTRL-W_f* *CTRL-W_CTRL-F*
812CTRL-W CTRL-F Split current window in two. Edit file name under cursor.
Bram Moolenaar8dff8182006-04-06 20:18:50 +0000813 Like ":split gf", but window isn't split if the file does not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000814 exist.
815 Uses the 'path' variable as a list of directory names where to
816 look for the file. Also the path for current file is
817 used to search for the file name.
818 If the name is a hypertext link that looks like
819 "type://machine/path", only "/path" is used.
820 If a count is given, the count'th matching file is edited.
821 {not available when the |+file_in_path| feature was disabled
822 at compile time}
823
Bram Moolenaard1f56e62006-02-22 21:25:37 +0000824CTRL-W F *CTRL-W_F*
825 Split current window in two. Edit file name under cursor and
826 jump to the line number following the file name. See |gF| for
827 details on how the line number is obtained.
Bram Moolenaar57657d82006-04-21 22:12:41 +0000828 {not available when the |+file_in_path| feature was disabled
829 at compile time}
Bram Moolenaard1f56e62006-02-22 21:25:37 +0000830
Bram Moolenaar8dff8182006-04-06 20:18:50 +0000831CTRL-W gf *CTRL-W_gf*
832 Open a new tab page and edit the file name under the cursor.
833 Like "tab split" and "gf", but the new tab page isn't created
834 if the file does not exist.
835 {not available when the |+file_in_path| feature was disabled
836 at compile time}
837
Bram Moolenaar57657d82006-04-21 22:12:41 +0000838CTRL-W gF *CTRL-W_gF*
839 Open a new tab page and edit the file name under the cursor
840 and jump to the line number following the file name. Like
841 "tab split" and "gF", but the new tab page isn't created if
842 the file does not exist.
843 {not available when the |+file_in_path| feature was disabled
844 at compile time}
845
Bram Moolenaar26967612019-03-17 17:13:16 +0100846CTRL-W gt *CTRL-W_gt*
847 Go to next tab page, same as `gt`.
848
849CTRL-W gT *CTRL-W_gT*
850 Go to previous tab page, same as `gT`.
851
Bram Moolenaar071d4272004-06-13 20:20:40 +0000852Also see |CTRL-W_CTRL-I|: open window for an included file that includes
853the keyword under the cursor.
854
855==============================================================================
85610. The preview window *preview-window*
857
858The preview window is a special window to show (preview) another file. It is
859normally a small window used to show an include file or definition of a
860function.
861{not available when compiled without the |+quickfix| feature}
862
Bram Moolenaarc270d802006-03-11 21:29:41 +0000863There can be only one preview window (per tab page). It is created with one
864of the commands below. The 'previewheight' option can be set to specify the
865height of the preview window when it's opened. The 'previewwindow' option is
866set in the preview window to be able to recognize it. The 'winfixheight'
867option is set to have it keep the same height when opening/closing other
868windows.
Bram Moolenaar79648732019-07-18 21:43:07 +0200869 *preview-popup*
870Alternatively, a popup window can be used by setting the 'previewpopup'
871option. When set, it overrules the 'previewwindow' and 'previewheight'
872settings. The option is a comma separated list of values:
873 height maximum height of the popup
Bram Moolenaar85850f32019-07-19 22:05:51 +0200874 width maximum width of the popup
Bram Moolenaar79648732019-07-18 21:43:07 +0200875Example: >
876 :set previewpopup=height:10,width:60
877<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000878 *:pta* *:ptag*
879:pta[g][!] [tagname]
880 Does ":tag[!] [tagname]" and shows the found tag in a
881 "Preview" window without changing the current buffer or cursor
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000882 position. If a "Preview" window already exists, it is re-used
Bram Moolenaar071d4272004-06-13 20:20:40 +0000883 (like a help window is). If a new one is opened,
884 'previewheight' is used for the height of the window. See
885 also |:tag|.
886 See below for an example. |CursorHold-example|
887 Small difference from |:tag|: When [tagname] is equal to the
888 already displayed tag, the position in the matching tag list
889 is not reset. This makes the CursorHold example work after a
890 |:ptnext|.
891
892CTRL-W z *CTRL-W_z*
893CTRL-W CTRL-Z *CTRL-W_CTRL-Z* *:pc* *:pclose*
894:pc[lose][!] Close any "Preview" window currently open. When the 'hidden'
895 option is set, or when the buffer was changed and the [!] is
896 used, the buffer becomes hidden (unless there is another
897 window editing it). The command fails if any "Preview" buffer
898 cannot be closed. See also |:close|.
899
900 *:pp* *:ppop*
901:[count]pp[op][!]
902 Does ":[count]pop[!]" in the preview window. See |:pop| and
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200903 |:ptag|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000904
905CTRL-W } *CTRL-W_}*
906 Use identifier under cursor as a tag and perform a :ptag on
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000907 it. Make the new Preview window (if required) N high. If N is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000908 not given, 'previewheight' is used.
909
910CTRL-W g } *CTRL-W_g}*
911 Use identifier under cursor as a tag and perform a :ptjump on
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000912 it. Make the new Preview window (if required) N high. If N is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000913 not given, 'previewheight' is used.
914
915 *:ped* *:pedit*
916:ped[it][!] [++opt] [+cmd] {file}
917 Edit {file} in the preview window. The preview window is
918 opened like with |:ptag|. The current window and cursor
919 position isn't changed. Useful example: >
920 :pedit +/fputc /usr/include/stdio.h
921<
922 *:ps* *:psearch*
923:[range]ps[earch][!] [count] [/]pattern[/]
924 Works like |:ijump| but shows the found match in the preview
925 window. The preview window is opened like with |:ptag|. The
926 current window and cursor position isn't changed. Useful
927 example: >
928 :psearch popen
929< Like with the |:ptag| command, you can use this to
930 automatically show information about the word under the
931 cursor. This is less clever than using |:ptag|, but you don't
932 need a tags file and it will also find matches in system
933 include files. Example: >
934 :au! CursorHold *.[ch] nested exe "silent! psearch " . expand("<cword>")
935< Warning: This can be slow.
936
937Example *CursorHold-example* >
938
939 :au! CursorHold *.[ch] nested exe "silent! ptag " . expand("<cword>")
940
941This will cause a ":ptag" to be executed for the keyword under the cursor,
942when the cursor hasn't moved for the time set with 'updatetime'. The "nested"
943makes other autocommands be executed, so that syntax highlighting works in the
944preview window. The "silent!" avoids an error message when the tag could not
945be found. Also see |CursorHold|. To disable this again: >
946
947 :au! CursorHold
948
949A nice addition is to highlight the found tag, avoid the ":ptag" when there
950is no word under the cursor, and a few other things: >
951
952 :au! CursorHold *.[ch] nested call PreviewWord()
953 :func PreviewWord()
954 : if &previewwindow " don't do this in the preview window
955 : return
956 : endif
957 : let w = expand("<cword>") " get the word under cursor
958 : if w =~ '\a' " if the word contains a letter
959 :
960 : " Delete any existing highlight before showing another tag
961 : silent! wincmd P " jump to preview window
962 : if &previewwindow " if we really get there...
963 : match none " delete existing highlight
964 : wincmd p " back to old window
965 : endif
966 :
967 : " Try displaying a matching tag for the word under the cursor
968 : try
969 : exe "ptag " . w
970 : catch
971 : return
972 : endtry
973 :
974 : silent! wincmd P " jump to preview window
975 : if &previewwindow " if we really get there...
976 : if has("folding")
977 : silent! .foldopen " don't want a closed fold
978 : endif
979 : call search("$", "b") " to end of previous line
980 : let w = substitute(w, '\\', '\\\\', "")
981 : call search('\<\V' . w . '\>') " position cursor on match
982 : " Add a match highlight to the word at this position
983 : hi previewWord term=bold ctermbg=green guibg=green
984 : exe 'match previewWord "\%' . line(".") . 'l\%' . col(".") . 'c\k*"'
985 : wincmd p " back to old window
986 : endif
987 : endif
988 :endfun
989
990==============================================================================
99111. Using hidden buffers *buffer-hidden*
992
993A hidden buffer is not displayed in a window, but is still loaded into memory.
994This makes it possible to jump from file to file, without the need to read or
995write the file every time you get another buffer in a window.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000996
997 *:buffer-!*
998If the option 'hidden' ('hid') is set, abandoned buffers are kept for all
999commands that start editing another file: ":edit", ":next", ":tag", etc. The
1000commands that move through the buffer list sometimes make the current buffer
1001hidden although the 'hidden' option is not set. This happens when a buffer is
1002modified, but is forced (with '!') to be removed from a window, and
1003'autowrite' is off or the buffer can't be written.
1004
1005You can make a hidden buffer not hidden by starting to edit it with any
1006command. Or by deleting it with the ":bdelete" command.
1007
1008The 'hidden' is global, it is used for all buffers. The 'bufhidden' option
1009can be used to make an exception for a specific buffer. It can take these
1010values:
1011 <empty> Use the value of 'hidden'.
1012 hide Hide this buffer, also when 'hidden' is not set.
1013 unload Don't hide but unload this buffer, also when 'hidden'
1014 is set.
1015 delete Delete the buffer.
1016
1017 *hidden-quit*
1018When you try to quit Vim while there is a hidden, modified buffer, you will
1019get an error message and Vim will make that buffer the current buffer. You
1020can then decide to write this buffer (":wq") or quit without writing (":q!").
1021Be careful: there may be more hidden, modified buffers!
1022
1023A buffer can also be unlisted. This means it exists, but it is not in the
1024list of buffers. |unlisted-buffer|
1025
1026
Bram Moolenaard51cb702015-07-21 15:03:06 +02001027:files[!] [flags] *:files*
1028:buffers[!] [flags] *:buffers* *:ls*
1029:ls[!] [flags]
1030 Show all buffers. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001031
Bram Moolenaar97d62492012-11-15 21:28:22 +01001032 1 #h "/test/text" line 1 ~
1033 2u "asdf" line 0 ~
1034 3 %a + "version.c" line 1 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +00001035
1036 When the [!] is included the list will show unlisted buffers
1037 (the term "unlisted" is a bit confusing then...).
1038
1039 Each buffer has a unique number. That number will not change,
Bram Moolenaar0122c402015-02-03 19:13:34 +01001040 thus you can always go to a specific buffer with ":buffer N"
1041 or "N CTRL-^", where N is the buffer number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001042
Bram Moolenaarc6896e22019-05-30 22:32:34 +02001043 For the file name these special values are used:
1044 [Prompt] |prompt-buffer|
1045 [Popup] buffer of a |popup-window|
1046 [Scratch] 'buftype' is "nofile"
1047 [No Name] no file name specified
1048 For a |terminal-window| buffer the status is used.
1049
Bram Moolenaar071d4272004-06-13 20:20:40 +00001050 Indicators (chars in the same column are mutually exclusive):
1051 u an unlisted buffer (only displayed when [!] is used)
1052 |unlisted-buffer|
1053 % the buffer in the current window
1054 # the alternate buffer for ":e #" and CTRL-^
1055 a an active buffer: it is loaded and visible
1056 h a hidden buffer: It is loaded, but currently not
1057 displayed in a window |hidden-buffer|
1058 - a buffer with 'modifiable' off
1059 = a readonly buffer
Bram Moolenaarc572da52017-08-27 16:52:01 +02001060 R a terminal buffer with a running job
1061 F a terminal buffer with a finished job
Bram Moolenaar37c64c72017-09-19 22:06:03 +02001062 ? a terminal buffer without a job: `:terminal NONE`
Bram Moolenaar071d4272004-06-13 20:20:40 +00001063 + a modified buffer
1064 x a buffer with read errors
1065
Bram Moolenaard51cb702015-07-21 15:03:06 +02001066 [flags] can be a combination of the following characters,
1067 which restrict the buffers to be listed:
1068 + modified buffers
1069 - buffers with 'modifiable' off
1070 = readonly buffers
1071 a active buffers
Bram Moolenaare392eb42015-11-19 20:38:09 +01001072 u unlisted buffers (overrides the "!")
Bram Moolenaard51cb702015-07-21 15:03:06 +02001073 h hidden buffers
1074 x buffers with a read error
1075 % current buffer
1076 # alternate buffer
Bram Moolenaar0751f512018-03-29 16:37:16 +02001077 R terminal buffers with a running job
1078 F terminal buffers with a finished job
1079 ? terminal buffers without a job: `:terminal NONE`
Bram Moolenaard51cb702015-07-21 15:03:06 +02001080 Combining flags means they are "and"ed together, e.g.:
1081 h+ hidden buffers which are modified
1082 a+ active buffers which are modified
1083
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02001084 When using |:filter| the pattern is matched against the
1085 displayed buffer name, e.g.: >
1086 filter /\.vim/ ls
1087<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001088 *:bad* *:badd*
1089:bad[d] [+lnum] {fname}
1090 Add file name {fname} to the buffer list, without loading it.
1091 If "lnum" is specified, the cursor will be positioned at that
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001092 line when the buffer is first entered. Note that other
Bram Moolenaar071d4272004-06-13 20:20:40 +00001093 commands after the + will be ignored.
1094
1095:[N]bd[elete][!] *:bd* *:bdel* *:bdelete* *E516*
1096:bd[elete][!] [N]
1097 Unload buffer [N] (default: current buffer) and delete it from
1098 the buffer list. If the buffer was changed, this fails,
1099 unless when [!] is specified, in which case changes are lost.
1100 The file remains unaffected. Any windows for this buffer are
1101 closed. If buffer [N] is the current buffer, another buffer
1102 will be displayed instead. This is the most recent entry in
1103 the jump list that points into a loaded buffer.
1104 Actually, the buffer isn't completely deleted, it is removed
1105 from the buffer list |unlisted-buffer| and option values,
1106 variables and mappings/abbreviations for the buffer are
Bram Moolenaar4d84d932014-11-30 14:50:16 +01001107 cleared. Examples: >
1108 :.,$-bdelete " delete buffers from the current one to
1109 " last but one
1110 :%bdelete " delete all buffers
1111<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001112
1113:bdelete[!] {bufname} *E93* *E94*
Bram Moolenaar15142e22018-04-30 22:19:58 +02001114 Like ":bdelete[!] [N]", but buffer given by name, see
1115 |{bufname}|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001116
1117:bdelete[!] N1 N2 ...
1118 Do ":bdelete[!]" for buffer N1, N2, etc. The arguments can be
1119 buffer numbers or buffer names (but not buffer names that are
1120 a number). Insert a backslash before a space in a buffer
1121 name.
1122
1123:N,Mbdelete[!] Do ":bdelete[!]" for all buffers in the range N to M
1124 |inclusive|.
1125
1126:[N]bw[ipeout][!] *:bw* *:bwipe* *:bwipeout* *E517*
1127:bw[ipeout][!] {bufname}
1128:N,Mbw[ipeout][!]
1129:bw[ipeout][!] N1 N2 ...
Bram Moolenaardf1bdc92006-02-23 21:32:16 +00001130 Like |:bdelete|, but really delete the buffer. Everything
1131 related to the buffer is lost. All marks in this buffer
1132 become invalid, option settings are lost, etc. Don't use this
Bram Moolenaar4d84d932014-11-30 14:50:16 +01001133 unless you know what you are doing. Examples: >
1134 :.+,$bwipeout " wipe out all buffers after the current
1135 " one
1136 :%bwipeout " wipe out all buffers
1137<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001138
1139:[N]bun[load][!] *:bun* *:bunload* *E515*
1140:bun[load][!] [N]
1141 Unload buffer [N] (default: current buffer). The memory
1142 allocated for this buffer will be freed. The buffer remains
1143 in the buffer list.
1144 If the buffer was changed, this fails, unless when [!] is
1145 specified, in which case the changes are lost.
1146 Any windows for this buffer are closed. If buffer [N] is the
1147 current buffer, another buffer will be displayed instead.
1148 This is the most recent entry in the jump list that points
1149 into a loaded buffer.
1150
1151:bunload[!] {bufname}
Bram Moolenaar15142e22018-04-30 22:19:58 +02001152 Like ":bunload[!] [N]", but buffer given by name.
1153 Also see |{bufname}|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001154
1155:N,Mbunload[!] Do ":bunload[!]" for all buffers in the range N to M
1156 |inclusive|.
1157
1158:bunload[!] N1 N2 ...
1159 Do ":bunload[!]" for buffer N1, N2, etc. The arguments can be
1160 buffer numbers or buffer names (but not buffer names that are
1161 a number). Insert a backslash before a space in a buffer
1162 name.
1163
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001164:[N]b[uffer][!] [+cmd] [N] *:b* *:bu* *:buf* *:buffer* *E86*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001165 Edit buffer [N] from the buffer list. If [N] is not given,
1166 the current buffer remains being edited. See |:buffer-!| for
1167 [!]. This will also edit a buffer that is not in the buffer
1168 list, without setting the 'buflisted' flag.
Bram Moolenaar12969c02015-09-08 23:36:10 +02001169 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001170
Bram Moolenaar15142e22018-04-30 22:19:58 +02001171:[N]b[uffer][!] [+cmd] {bufname} *{bufname}*
1172 Edit buffer for {bufname} from the buffer list. A partial
1173 name also works, so long as it is unique in the list of
1174 buffers.
1175 Note that a buffer whose name is a number cannot be referenced
1176 by that name; use the buffer number instead.
1177 Insert a backslash before a space in a buffer name.
1178 See |:buffer-!| for [!].
1179 This will also edit a buffer that is not in the buffer list,
1180 without setting the 'buflisted' flag.
Bram Moolenaar12969c02015-09-08 23:36:10 +02001181 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001182
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001183:[N]sb[uffer] [+cmd] [N] *:sb* *:sbuffer*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001184 Split window and edit buffer [N] from the buffer list. If [N]
1185 is not given, the current buffer is edited. Respects the
1186 "useopen" setting of 'switchbuf' when splitting. This will
1187 also edit a buffer that is not in the buffer list, without
1188 setting the 'buflisted' flag.
Bram Moolenaar12969c02015-09-08 23:36:10 +02001189 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001190
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001191:[N]sb[uffer] [+cmd] {bufname}
Bram Moolenaar15142e22018-04-30 22:19:58 +02001192 Split window and edit buffer for |{bufname}| from the buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001193 list. This will also edit a buffer that is not in the buffer
1194 list, without setting the 'buflisted' flag.
Bram Moolenaar280f1262006-01-30 00:14:18 +00001195 Note: If what you want to do is split the buffer, make a copy
1196 under another name, you can do it this way: >
1197 :w foobar | sp #
Bram Moolenaar12969c02015-09-08 23:36:10 +02001198< Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001199
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001200:[N]bn[ext][!] [+cmd] [N] *:bn* *:bnext* *E87*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001201 Go to [N]th next buffer in buffer list. [N] defaults to one.
1202 Wraps around the end of the buffer list.
1203 See |:buffer-!| for [!].
Bram Moolenaar12969c02015-09-08 23:36:10 +02001204 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001205 If you are in a help buffer, this takes you to the next help
1206 buffer (if there is one). Similarly, if you are in a normal
1207 (non-help) buffer, this takes you to the next normal buffer.
1208 This is so that if you have invoked help, it doesn't get in
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001209 the way when you're browsing code/text buffers. The next three
Bram Moolenaar071d4272004-06-13 20:20:40 +00001210 commands also work like this.
1211
1212 *:sbn* *:sbnext*
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001213:[N]sbn[ext] [+cmd] [N]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001214 Split window and go to [N]th next buffer in buffer list.
1215 Wraps around the end of the buffer list. Uses 'switchbuf'
Bram Moolenaar12969c02015-09-08 23:36:10 +02001216 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001217
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001218:[N]bN[ext][!] [+cmd] [N] *:bN* *:bNext* *:bp* *:bprevious* *E88*
1219:[N]bp[revious][!] [+cmd] [N]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001220 Go to [N]th previous buffer in buffer list. [N] defaults to
1221 one. Wraps around the start of the buffer list.
1222 See |:buffer-!| for [!] and 'switchbuf'.
Bram Moolenaar12969c02015-09-08 23:36:10 +02001223 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001224
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001225:[N]sbN[ext] [+cmd] [N] *:sbN* *:sbNext* *:sbp* *:sbprevious*
1226:[N]sbp[revious] [+cmd] [N]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001227 Split window and go to [N]th previous buffer in buffer list.
1228 Wraps around the start of the buffer list.
1229 Uses 'switchbuf'.
Bram Moolenaar12969c02015-09-08 23:36:10 +02001230 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001231
Bram Moolenaar61da1bf2019-06-06 12:14:49 +02001232:br[ewind][!] [+cmd] *:br* *:bre* *:brewind*
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001233 Go to first buffer in buffer list. If the buffer list is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001234 empty, go to the first unlisted buffer.
1235 See |:buffer-!| for [!].
1236
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001237:bf[irst] [+cmd] *:bf* *:bfirst*
1238 Same as |:brewind|.
1239 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001240
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001241:sbr[ewind] [+cmd] *:sbr* *:sbrewind*
1242 Split window and go to first buffer in buffer list. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001243 buffer list is empty, go to the first unlisted buffer.
1244 Respects the 'switchbuf' option.
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001245 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001246
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001247:sbf[irst] [+cmd] *:sbf* *:sbfirst*
1248 Same as ":sbrewind".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001249
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001250:bl[ast][!] [+cmd] *:bl* *:blast*
1251 Go to last buffer in buffer list. If the buffer list is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001252 empty, go to the last unlisted buffer.
1253 See |:buffer-!| for [!].
1254
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001255:sbl[ast] [+cmd] *:sbl* *:sblast*
1256 Split window and go to last buffer in buffer list. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001257 buffer list is empty, go to the last unlisted buffer.
1258 Respects 'switchbuf' option.
1259
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001260:[N]bm[odified][!] [+cmd] [N] *:bm* *:bmodified* *E84*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001261 Go to [N]th next modified buffer. Note: this command also
1262 finds unlisted buffers. If there is no modified buffer the
1263 command fails.
1264
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001265:[N]sbm[odified] [+cmd] [N] *:sbm* *:sbmodified*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001266 Split window and go to [N]th next modified buffer.
1267 Respects 'switchbuf' option.
1268 Note: this command also finds buffers not in the buffer list.
1269
1270:[N]unh[ide] [N] *:unh* *:unhide* *:sun* *:sunhide*
1271:[N]sun[hide] [N]
1272 Rearrange the screen to open one window for each loaded buffer
1273 in the buffer list. When a count is given, this is the
1274 maximum number of windows to open.
1275
1276:[N]ba[ll] [N] *:ba* *:ball* *:sba* *:sball*
1277:[N]sba[ll] [N] Rearrange the screen to open one window for each buffer in
1278 the buffer list. When a count is given, this is the maximum
1279 number of windows to open. 'winheight' also limits the number
1280 of windows opened ('winwidth' if |:vertical| was prepended).
1281 Buf/Win Enter/Leave autocommands are not executed for the new
1282 windows here, that's only done when they are really entered.
Bram Moolenaar756ec0f2007-05-05 17:59:48 +00001283 When the |:tab| modifier is used new windows are opened in a
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00001284 new tab, up to 'tabpagemax'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001285
1286Note: All the commands above that start editing another buffer, keep the
1287'readonly' flag as it was. This differs from the ":edit" command, which sets
1288the 'readonly' flag each time the file is read.
1289
1290==============================================================================
129112. Special kinds of buffers *special-buffers*
1292
1293Instead of containing the text of a file, buffers can also be used for other
1294purposes. A few options can be set to change the behavior of a buffer:
1295 'bufhidden' what happens when the buffer is no longer displayed
1296 in a window.
1297 'buftype' what kind of a buffer this is
1298 'swapfile' whether the buffer will have a swap file
1299 'buflisted' buffer shows up in the buffer list
1300
1301A few useful kinds of a buffer:
1302
Bram Moolenaar280f1262006-01-30 00:14:18 +00001303quickfix Used to contain the error list or the location list. See
1304 |:cwindow| and |:lwindow|. This command sets the 'buftype'
1305 option to "quickfix". You are not supposed to change this!
1306 'swapfile' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001307
1308help Contains a help file. Will only be created with the |:help|
1309 command. The flag that indicates a help buffer is internal
1310 and can't be changed. The 'buflisted' option will be reset
1311 for a help buffer.
1312
Bram Moolenaarb6e0ec62017-07-23 22:12:20 +02001313terminal A terminal window buffer, see |terminal|. The contents cannot
1314 be read or changed until the job ends.
1315
Bram Moolenaar677ee682005-01-27 14:41:15 +00001316directory Displays directory contents. Can be used by a file explorer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001317 plugin. The buffer is created with these settings: >
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001318 :setlocal buftype=nowrite
1319 :setlocal bufhidden=delete
1320 :setlocal noswapfile
Bram Moolenaar071d4272004-06-13 20:20:40 +00001321< The buffer name is the name of the directory and is adjusted
1322 when using the |:cd| command.
1323
1324scratch Contains text that can be discarded at any time. It is kept
1325 when closing the window, it must be deleted explicitly.
1326 Settings: >
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001327 :setlocal buftype=nofile
1328 :setlocal bufhidden=hide
1329 :setlocal noswapfile
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001330< The buffer name can be used to identify the buffer, if you
1331 give it a meaningful name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001332
1333 *unlisted-buffer*
1334unlisted The buffer is not in the buffer list. It is not used for
1335 normal editing, but to show a help file, remember a file name
1336 or marks. The ":bdelete" command will also set this option,
1337 thus it doesn't completely delete the buffer. Settings: >
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001338 :setlocal nobuflisted
Bram Moolenaar071d4272004-06-13 20:20:40 +00001339<
1340
Bram Moolenaard473c8c2018-08-11 18:00:22 +02001341 vim:tw=78:ts=8:noet:ft=help:norl: