blob: 813de1b664579d9365bc35ec36012f9effb4ebaf [file] [log] [blame]
Bram Moolenaar96f45c02019-10-26 19:53:45 +02001*windows.txt* For Vim version 8.1. Last change: 2019 Oct 18
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<
Bram Moolenaar96f45c02019-10-26 19:53:45 +0200315 When closing a help window, Vim will try to restore the
316 previous window layout |:helpclose|.
317
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100318:q[uit]!
319:{count}q[uit]!
320 Without {count}: Quit the current window. If {count} is
321 given quit the {count} window.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000322
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100323 If this was the last window for a buffer, any changes to that
324 buffer are lost. When quitting the last window (not counting
325 help windows), exit Vim. The contents of the buffer are lost,
326 even when 'hidden' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000327
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100328:clo[se][!]
329:{count}clo[se][!]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000330CTRL-W c *CTRL-W_c* *:clo* *:close*
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100331 Without {count}: Close the current window. If {count} is
332 given close the {count} window.
333
334 When the 'hidden' option is set, or when the buffer was
335 changed and the [!] is used, the buffer becomes hidden (unless
336 there is another window editing it).
337
Bram Moolenaar7e8fd632006-02-18 22:14:51 +0000338 When there is only one window in the current tab page and
339 there is another tab page, this closes the current tab page.
340 |tab-page|.
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100341
Bram Moolenaar071d4272004-06-13 20:20:40 +0000342 This command fails when: *E444*
343 - There is only one window on the screen.
344 - When 'hidden' is not set, [!] is not used, the buffer has
345 changes, and there is no other window on this buffer.
346 Changes to the buffer are not written and won't get lost, so
347 this is a "safe" command.
348
349CTRL-W CTRL-C *CTRL-W_CTRL-C*
350 You might have expected that CTRL-W CTRL-C closes the current
351 window, but that does not work, because the CTRL-C cancels the
352 command.
353
354 *:hide*
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100355:hid[e]
356:{count}hid[e]
Bram Moolenaarc572da52017-08-27 16:52:01 +0200357 Without {count}: Quit the current window, unless it is the
358 last window on the screen.
359 If {count} is given quit the {count} window.
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100360
361 The buffer becomes hidden (unless there is another window
Bram Moolenaared32d942014-12-06 23:33:00 +0100362 editing it or 'bufhidden' is "unload", "delete" or "wipe").
363 If the window is the last one in the current tab page the tab
364 page is closed. |tab-page|
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100365
366 The value of 'hidden' is irrelevant for this command. Changes
367 to the buffer are not written and won't get lost, so this is a
368 "safe" command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000369
370:hid[e] {cmd} Execute {cmd} with 'hidden' is set. The previous value of
371 'hidden' is restored after {cmd} has been executed.
372 Example: >
373 :hide edit Makefile
374< This will edit "Makefile", and hide the current buffer if it
375 has any changes.
376
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100377:on[ly][!]
378:{count}on[ly][!]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000379CTRL-W o *CTRL-W_o* *E445*
380CTRL-W CTRL-O *CTRL-W_CTRL-O* *:on* *:only*
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100381 Make the current window the only one on the screen. All other
382 windows are closed. For {count} see |:quit| command.
383
Bram Moolenaar071d4272004-06-13 20:20:40 +0000384 When the 'hidden' option is set, all buffers in closed windows
385 become hidden.
Bram Moolenaarb96a7f32014-11-27 16:22:48 +0100386
Bram Moolenaar071d4272004-06-13 20:20:40 +0000387 When 'hidden' is not set, and the 'autowrite' option is set,
388 modified buffers are written. Otherwise, windows that have
389 buffers that are modified are not removed, unless the [!] is
390 given, then they become hidden. But modified buffers are
391 never abandoned, so changes cannot get lost.
392
393==============================================================================
3944. Moving cursor to other windows *window-move-cursor*
395
396CTRL-W <Down> *CTRL-W_<Down>*
397CTRL-W CTRL-J *CTRL-W_CTRL-J* *CTRL-W_j*
398CTRL-W j Move cursor to Nth window below current one. Uses the cursor
399 position to select between alternatives.
400
401CTRL-W <Up> *CTRL-W_<Up>*
402CTRL-W CTRL-K *CTRL-W_CTRL-K* *CTRL-W_k*
403CTRL-W k Move cursor to Nth window above current one. Uses the cursor
404 position to select between alternatives.
405
406CTRL-W <Left> *CTRL-W_<Left>*
407CTRL-W CTRL-H *CTRL-W_CTRL-H*
408CTRL-W <BS> *CTRL-W_<BS>* *CTRL-W_h*
409CTRL-W h Move cursor to Nth window left of current one. Uses the
410 cursor position to select between alternatives.
411
412CTRL-W <Right> *CTRL-W_<Right>*
413CTRL-W CTRL-L *CTRL-W_CTRL-L* *CTRL-W_l*
414CTRL-W l Move cursor to Nth window right of current one. Uses the
415 cursor position to select between alternatives.
416
417CTRL-W w *CTRL-W_w* *CTRL-W_CTRL-W*
418CTRL-W CTRL-W Without count: move cursor to window below/right of the
419 current one. If there is no window below or right, go to
420 top-left window.
421 With count: go to Nth window (windows are numbered from
422 top-left to bottom-right). To obtain the window number see
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100423 |bufwinnr()| and |winnr()|. When N is larger than the number
424 of windows go to the last window.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000425
426 *CTRL-W_W*
427CTRL-W W Without count: move cursor to window above/left of current
428 one. If there is no window above or left, go to bottom-right
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100429 window. With count: go to Nth window, like with CTRL-W w.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000430
431CTRL-W t *CTRL-W_t* *CTRL-W_CTRL-T*
432CTRL-W CTRL-T Move cursor to top-left window.
433
434CTRL-W b *CTRL-W_b* *CTRL-W_CTRL-B*
435CTRL-W CTRL-B Move cursor to bottom-right window.
436
437CTRL-W p *CTRL-W_p* *CTRL-W_CTRL-P*
438CTRL-W CTRL-P Go to previous (last accessed) window.
439
440 *CTRL-W_P* *E441*
441CTRL-W P Go to preview window. When there is no preview window this is
442 an error.
443 {not available when compiled without the |+quickfix| feature}
444
445If Visual mode is active and the new window is not for the same buffer, the
446Visual mode is ended. If the window is on the same buffer, the cursor
447position is set to keep the same Visual area selected.
448
449 *:winc* *:wincmd*
450These commands can also be executed with ":wincmd":
451
452:[count]winc[md] {arg}
453 Like executing CTRL-W [count] {arg}. Example: >
454 :wincmd j
455< Moves to the window below the current one.
456 This command is useful when a Normal mode cannot be used (for
457 the |CursorHold| autocommand event). Or when a Normal mode
458 command is inconvenient.
459 The count can also be a window number. Example: >
460 :exe nr . "wincmd w"
461< This goes to window "nr".
462
463==============================================================================
4645. Moving windows around *window-moving*
465
466CTRL-W r *CTRL-W_r* *CTRL-W_CTRL-R* *E443*
467CTRL-W CTRL-R Rotate windows downwards/rightwards. The first window becomes
468 the second one, the second one becomes the third one, etc.
469 The last window becomes the first window. The cursor remains
470 in the same window.
471 This only works within the row or column of windows that the
472 current window is in.
473
474 *CTRL-W_R*
475CTRL-W R Rotate windows upwards/leftwards. The second window becomes
476 the first one, the third one becomes the second one, etc. The
477 first window becomes the last window. The cursor remains in
478 the same window.
479 This only works within the row or column of windows that the
480 current window is in.
481
482CTRL-W x *CTRL-W_x* *CTRL-W_CTRL-X*
483CTRL-W CTRL-X Without count: Exchange current window with next one. If there
484 is no next window, exchange with previous window.
485 With count: Exchange current window with Nth window (first
486 window is 1). The cursor is put in the other window.
487 When vertical and horizontal window splits are mixed, the
488 exchange is only done in the row or column of windows that the
489 current window is in.
490
491The following commands can be used to change the window layout. For example,
492when there are two vertically split windows, CTRL-W K will change that in
493horizontally split windows. CTRL-W H does it the other way around.
494
495 *CTRL-W_K*
496CTRL-W K Move the current window to be at the very top, using the full
497 width of the screen. This works like closing the current
498 window and then creating another one with ":topleft split",
499 except that the current window contents is used for the new
500 window.
501
502 *CTRL-W_J*
503CTRL-W J Move the current window to be at the very bottom, using the
504 full width of the screen. This works like closing the current
505 window and then creating another one with ":botright split",
506 except that the current window contents is used for the new
507 window.
508
509 *CTRL-W_H*
510CTRL-W H Move the current window to be at the far left, using the
511 full height of the screen. This works like closing the
512 current window and then creating another one with
513 ":vert topleft split", except that the current window contents
514 is used for the new window.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000515
516 *CTRL-W_L*
517CTRL-W L Move the current window to be at the far right, using the full
518 height of the screen. This works like closing the
519 current window and then creating another one with
520 ":vert botright split", except that the current window
521 contents is used for the new window.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000522
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000523 *CTRL-W_T*
524CTRL-W T Move the current window to a new tab page. This fails if
525 there is only one window in the current tab page.
526 When a count is specified the new tab page will be opened
527 before the tab page with this index. Otherwise it comes after
528 the current tab page.
529
Bram Moolenaar071d4272004-06-13 20:20:40 +0000530==============================================================================
5316. Window resizing *window-resize*
532
533 *CTRL-W_=*
534CTRL-W = Make all windows (almost) equally high and wide, but use
535 'winheight' and 'winwidth' for the current window.
Bram Moolenaar756ec0f2007-05-05 17:59:48 +0000536 Windows with 'winfixheight' set keep their height and windows
537 with 'winfixwidth' set keep their width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000538
539:res[ize] -N *:res* *:resize* *CTRL-W_-*
540CTRL-W - Decrease current window height by N (default 1).
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200541 If used after |:vertical|: decrease width by N.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000542
543:res[ize] +N *CTRL-W_+*
544CTRL-W + Increase current window height by N (default 1).
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200545 If used after |:vertical|: increase width by N.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000546
547:res[ize] [N]
548CTRL-W CTRL-_ *CTRL-W_CTRL-_* *CTRL-W__*
549CTRL-W _ Set current window height to N (default: highest possible).
550
551z{nr}<CR> Set current window height to {nr}.
552
553 *CTRL-W_<*
554CTRL-W < Decrease current window width by N (default 1).
555
556 *CTRL-W_>*
557CTRL-W > Increase current window width by N (default 1).
558
559:vertical res[ize] [N] *:vertical-resize* *CTRL-W_bar*
560CTRL-W | Set current window width to N (default: widest possible).
561
562You can also resize a window by dragging a status line up or down with the
563mouse. Or by dragging a vertical separator line left or right. This only
564works if the version of Vim that is being used supports the mouse and the
565'mouse' option has been set to enable it.
566
567The option 'winheight' ('wh') is used to set the minimal window height of the
568current window. This option is used each time another window becomes the
569current window. If the option is '0', it is disabled. Set 'winheight' to a
570very large value, e.g., '9999', to make the current window always fill all
571available space. Set it to a reasonable value, e.g., '10', to make editing in
572the current window comfortable.
573
574The equivalent 'winwidth' ('wiw') option is used to set the minimal width of
575the current window.
576
577When the option 'equalalways' ('ea') is set, all the windows are automatically
578made the same size after splitting or closing a window. If you don't set this
579option, splitting a window will reduce the size of the current window and
580leave the other windows the same. When closing a window, the extra lines are
581given to the window above it.
582
583The 'eadirection' option limits the direction in which the 'equalalways'
584option is applied. The default "both" resizes in both directions. When the
585value is "ver" only the heights of windows are equalized. Use this when you
586have manually resized a vertically split window and want to keep this width.
587Likewise, "hor" causes only the widths of windows to be equalized.
588
589The option 'cmdheight' ('ch') is used to set the height of the command-line.
590If you are annoyed by the |hit-enter| prompt for long messages, set this
591option to 2 or 3.
592
593If there is only one window, resizing that window will also change the command
594line height. If there are several windows, resizing the current window will
595also change the height of the window below it (and sometimes the window above
596it).
597
598The minimal height and width of a window is set with 'winminheight' and
599'winminwidth'. These are hard values, a window will never become smaller.
600
601==============================================================================
6027. Argument and buffer list commands *buffer-list*
603
604 args list buffer list meaning ~
6051. :[N]argument [N] 11. :[N]buffer [N] to arg/buf N
6062. :[N]next [file ..] 12. :[N]bnext [N] to Nth next arg/buf
6073. :[N]Next [N] 13. :[N]bNext [N] to Nth previous arg/buf
6084. :[N]previous [N] 14. :[N]bprevious [N] to Nth previous arg/buf
6095. :rewind / :first 15. :brewind / :bfirst to first arg/buf
6106. :last 16. :blast to last arg/buf
6117. :all 17. :ball edit all args/buffers
612 18. :unhide edit all loaded buffers
613 19. :[N]bmod [N] to Nth modified buf
614
615 split & args list split & buffer list meaning ~
61621. :[N]sargument [N] 31. :[N]sbuffer [N] split + to arg/buf N
61722. :[N]snext [file ..] 32. :[N]sbnext [N] split + to Nth next arg/buf
61823. :[N]sNext [N] 33. :[N]sbNext [N] split + to Nth previous arg/buf
61924. :[N]sprevious [N] 34. :[N]sbprevious [N] split + to Nth previous arg/buf
62025. :srewind / :sfirst 35. :sbrewind / :sbfirst split + to first arg/buf
62126. :slast 36. :sblast split + to last arg/buf
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +000062227. :sall 37. :sball edit all args/buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +0000623 38. :sunhide edit all loaded buffers
624 39. :[N]sbmod [N] split + to Nth modified buf
625
62640. :args list of arguments
62741. :buffers list of buffers
628
629The meaning of [N] depends on the command:
Bram Moolenaar24a98a02017-09-27 22:23:55 +0200630 [N] is the number of buffers to go forward/backward on 2/12/22/32,
631 3/13/23/33, and 4/14/24/34
Bram Moolenaar071d4272004-06-13 20:20:40 +0000632 [N] is an argument number, defaulting to current argument, for 1 and 21
633 [N] is a buffer number, defaulting to current buffer, for 11 and 31
634 [N] is a count for 19 and 39
635
636Note: ":next" is an exception, because it must accept a list of file names
637for compatibility with Vi.
638
639
640The argument list and multiple windows
641--------------------------------------
642
643The current position in the argument list can be different for each window.
644Remember that when doing ":e file", the position in the argument list stays
645the same, but you are not editing the file at that position. To indicate
646this, the file message (and the title, if you have one) shows
647"(file (N) of M)", where "(N)" is the current position in the file list, and
648"M" the number of files in the file list.
649
650All the entries in the argument list are added to the buffer list. Thus, you
651can also get to them with the buffer list commands, like ":bnext".
652
653:[N]al[l][!] [N] *:al* *:all* *:sal* *:sall*
654:[N]sal[l][!] [N]
655 Rearrange the screen to open one window for each argument.
656 All other windows are closed. When a count is given, this is
657 the maximum number of windows to open.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +0000658 With the |:tab| modifier open a tab page for each argument.
659 When there are more arguments than 'tabpagemax' further ones
660 become split windows in the last tab page.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000661 When the 'hidden' option is set, all buffers in closed windows
662 become hidden.
663 When 'hidden' is not set, and the 'autowrite' option is set,
664 modified buffers are written. Otherwise, windows that have
665 buffers that are modified are not removed, unless the [!] is
666 given, then they become hidden. But modified buffers are
667 never abandoned, so changes cannot get lost.
668 [N] is the maximum number of windows to open. 'winheight'
669 also limits the number of windows opened ('winwidth' if
670 |:vertical| was prepended).
671 Buf/Win Enter/Leave autocommands are not executed for the new
672 windows here, that's only done when they are really entered.
Bram Moolenaar54775062019-07-31 21:07:14 +0200673 If autocommands change the window layout while this command is
674 busy an error will be given. *E249*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000675
676:[N]sa[rgument][!] [++opt] [+cmd] [N] *:sa* *:sargument*
677 Short for ":split | argument [N]": split window and go to Nth
678 argument. But when there is no such argument, the window is
679 not split. Also see |++opt| and |+cmd|.
680
681:[N]sn[ext][!] [++opt] [+cmd] [file ..] *:sn* *:snext*
682 Short for ":split | [N]next": split window and go to Nth next
683 argument. But when there is no next file, the window is not
684 split. Also see |++opt| and |+cmd|.
685
686:[N]spr[evious][!] [++opt] [+cmd] [N] *:spr* *:sprevious*
687:[N]sN[ext][!] [++opt] [+cmd] [N] *:sN* *:sNext*
688 Short for ":split | [N]Next": split window and go to Nth
689 previous argument. But when there is no previous file, the
690 window is not split. Also see |++opt| and |+cmd|.
691
692 *:sre* *:srewind*
693:sre[wind][!] [++opt] [+cmd]
694 Short for ":split | rewind": split window and go to first
695 argument. But when there is no argument list, the window is
696 not split. Also see |++opt| and |+cmd|.
697
698 *:sfir* *:sfirst*
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000699:sfir[st] [++opt] [+cmd]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000700 Same as ":srewind".
701
702 *:sla* *:slast*
703:sla[st][!] [++opt] [+cmd]
704 Short for ":split | last": split window and go to last
705 argument. But when there is no argument list, the window is
706 not split. Also see |++opt| and |+cmd|.
707
708 *:dr* *:drop*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000709:dr[op] [++opt] [+cmd] {file} ..
Bram Moolenaar071d4272004-06-13 20:20:40 +0000710 Edit the first {file} in a window.
711 - If the file is already open in a window change to that
712 window.
713 - If the file is not open in a window edit the file in the
714 current window. If the current buffer can't be |abandon|ed,
715 the window is split first.
Bram Moolenaar51628222016-12-01 23:03:28 +0100716 - Windows that are not in the argument list or are not full
717 width will be closed if possible.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000718 The |argument-list| is set, like with the |:next| command.
719 The purpose of this command is that it can be used from a
720 program that wants Vim to edit another file, e.g., a debugger.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000721 When using the |:tab| modifier each argument is opened in a
722 tab page. The last window is used if it's empty.
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000723 Also see |++opt| and |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000724
725==============================================================================
7268. Do a command in all buffers or windows *list-repeat*
727
728 *:windo*
Bram Moolenaara162bc52015-01-07 16:54:21 +0100729:[range]windo {cmd} Execute {cmd} in each window or if [range] is given
730 only in windows for which the window number lies in
731 the [range]. It works like doing this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000732 CTRL-W t
733 :{cmd}
734 CTRL-W w
735 :{cmd}
736 etc.
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000737< This only operates in the current tab page.
Bram Moolenaar7e8fd632006-02-18 22:14:51 +0000738 When an error is detected on one window, further
Bram Moolenaar071d4272004-06-13 20:20:40 +0000739 windows will not be visited.
740 The last window (or where an error occurred) becomes
741 the current window.
742 {cmd} can contain '|' to concatenate several commands.
743 {cmd} must not open or close windows or reorder them.
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200744
Bram Moolenaaraa23b372015-09-08 18:46:31 +0200745 Also see |:tabdo|, |:argdo|, |:bufdo|, |:cdo|, |:ldo|,
746 |:cfdo| and |:lfdo|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000747
748 *:bufdo*
Bram Moolenaara162bc52015-01-07 16:54:21 +0100749:[range]bufdo[!] {cmd} Execute {cmd} in each buffer in the buffer list or if
750 [range] is given only for buffers for which their
Bram Moolenaar681baaf2016-02-04 20:57:07 +0100751 buffer number is in the [range]. It works like doing
Bram Moolenaara162bc52015-01-07 16:54:21 +0100752 this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000753 :bfirst
754 :{cmd}
755 :bnext
756 :{cmd}
757 etc.
758< When the current file can't be |abandon|ed and the [!]
759 is not present, the command fails.
760 When an error is detected on one buffer, further
761 buffers will not be visited.
762 Unlisted buffers are skipped.
763 The last buffer (or where an error occurred) becomes
764 the current buffer.
765 {cmd} can contain '|' to concatenate several commands.
766 {cmd} must not delete buffers or add buffers to the
767 buffer list.
768 Note: While this command is executing, the Syntax
769 autocommand event is disabled by adding it to
770 'eventignore'. This considerably speeds up editing
771 each buffer.
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200772
Bram Moolenaaraa23b372015-09-08 18:46:31 +0200773 Also see |:tabdo|, |:argdo|, |:windo|, |:cdo|, |:ldo|,
774 |:cfdo| and |:lfdo|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000775
776Examples: >
777
778 :windo set nolist nofoldcolumn | normal zn
779
780This resets the 'list' option and disables folding in all windows. >
781
782 :bufdo set fileencoding= | update
783
784This resets the 'fileencoding' in each buffer and writes it if this changed
785the buffer. The result is that all buffers will use the 'encoding' encoding
786(if conversion works properly).
787
788==============================================================================
7899. Tag or file name under the cursor *window-tag*
790
791 *:sta* *:stag*
792:sta[g][!] [tagname]
793 Does ":tag[!] [tagname]" and splits the window for the found
794 tag. See also |:tag|.
795
796CTRL-W ] *CTRL-W_]* *CTRL-W_CTRL-]*
797CTRL-W CTRL-] Split current window in two. Use identifier under cursor as a
Bram Moolenaar3a991dd2014-10-02 01:41:41 +0200798 tag and jump to it in the new upper window.
799 In Visual mode uses the Visually selected text as a tag.
800 Make new window N high.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000801
802 *CTRL-W_g]*
803CTRL-W g ] Split current window in two. Use identifier under cursor as a
804 tag and perform ":tselect" on it in the new upper window.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +0200805 In Visual mode uses the Visually selected text as a tag.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000806 Make new window N high.
807
808 *CTRL-W_g_CTRL-]*
809CTRL-W g CTRL-] Split current window in two. Use identifier under cursor as a
Bram Moolenaar3a991dd2014-10-02 01:41:41 +0200810 tag and perform ":tjump" on it in the new upper window.
811 In Visual mode uses the Visually selected text as a tag.
812 Make new window N high.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000813
814CTRL-W f *CTRL-W_f* *CTRL-W_CTRL-F*
815CTRL-W CTRL-F Split current window in two. Edit file name under cursor.
Bram Moolenaar8dff8182006-04-06 20:18:50 +0000816 Like ":split gf", but window isn't split if the file does not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000817 exist.
818 Uses the 'path' variable as a list of directory names where to
819 look for the file. Also the path for current file is
820 used to search for the file name.
821 If the name is a hypertext link that looks like
822 "type://machine/path", only "/path" is used.
823 If a count is given, the count'th matching file is edited.
824 {not available when the |+file_in_path| feature was disabled
825 at compile time}
826
Bram Moolenaard1f56e62006-02-22 21:25:37 +0000827CTRL-W F *CTRL-W_F*
828 Split current window in two. Edit file name under cursor and
829 jump to the line number following the file name. See |gF| for
830 details on how the line number is obtained.
Bram Moolenaar57657d82006-04-21 22:12:41 +0000831 {not available when the |+file_in_path| feature was disabled
832 at compile time}
Bram Moolenaard1f56e62006-02-22 21:25:37 +0000833
Bram Moolenaar8dff8182006-04-06 20:18:50 +0000834CTRL-W gf *CTRL-W_gf*
835 Open a new tab page and edit the file name under the cursor.
836 Like "tab split" and "gf", but the new tab page isn't created
837 if the file does not exist.
838 {not available when the |+file_in_path| feature was disabled
839 at compile time}
840
Bram Moolenaar57657d82006-04-21 22:12:41 +0000841CTRL-W gF *CTRL-W_gF*
842 Open a new tab page and edit the file name under the cursor
843 and jump to the line number following the file name. Like
844 "tab split" and "gF", but the new tab page isn't created if
845 the file does not exist.
846 {not available when the |+file_in_path| feature was disabled
847 at compile time}
848
Bram Moolenaar26967612019-03-17 17:13:16 +0100849CTRL-W gt *CTRL-W_gt*
850 Go to next tab page, same as `gt`.
851
852CTRL-W gT *CTRL-W_gT*
853 Go to previous tab page, same as `gT`.
854
Bram Moolenaar071d4272004-06-13 20:20:40 +0000855Also see |CTRL-W_CTRL-I|: open window for an included file that includes
856the keyword under the cursor.
857
858==============================================================================
85910. The preview window *preview-window*
860
861The preview window is a special window to show (preview) another file. It is
862normally a small window used to show an include file or definition of a
863function.
864{not available when compiled without the |+quickfix| feature}
865
Bram Moolenaarc270d802006-03-11 21:29:41 +0000866There can be only one preview window (per tab page). It is created with one
867of the commands below. The 'previewheight' option can be set to specify the
868height of the preview window when it's opened. The 'previewwindow' option is
869set in the preview window to be able to recognize it. The 'winfixheight'
870option is set to have it keep the same height when opening/closing other
871windows.
Bram Moolenaar79648732019-07-18 21:43:07 +0200872 *preview-popup*
873Alternatively, a popup window can be used by setting the 'previewpopup'
874option. When set, it overrules the 'previewwindow' and 'previewheight'
875settings. The option is a comma separated list of values:
876 height maximum height of the popup
Bram Moolenaar85850f32019-07-19 22:05:51 +0200877 width maximum width of the popup
Bram Moolenaar06fe74a2019-08-31 16:20:32 +0200878 highlight highlight group of the popup (default is Pmenu)
Bram Moolenaar79648732019-07-18 21:43:07 +0200879Example: >
880 :set previewpopup=height:10,width:60
Bram Moolenaar2debf1c2019-08-04 20:44:19 +0200881
882A few peculiarities:
883- If the file is in a buffer already, it will be re-used. This will allow for
884 editing the file while it's visible in the popup window.
885- No ATTENTION dialog will be used, since you can't edit the file in the popup
886 window. However, if you later open the same buffer in a normal window, you
887 may not notice it's edited elsewhere. And when then using ":edit" to
888 trigger the ATTENTION and responding "A" for Abort, the preview window will
889 become empty.
890
Bram Moolenaar071d4272004-06-13 20:20:40 +0000891 *:pta* *:ptag*
892:pta[g][!] [tagname]
893 Does ":tag[!] [tagname]" and shows the found tag in a
894 "Preview" window without changing the current buffer or cursor
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000895 position. If a "Preview" window already exists, it is re-used
Bram Moolenaar071d4272004-06-13 20:20:40 +0000896 (like a help window is). If a new one is opened,
897 'previewheight' is used for the height of the window. See
898 also |:tag|.
899 See below for an example. |CursorHold-example|
900 Small difference from |:tag|: When [tagname] is equal to the
901 already displayed tag, the position in the matching tag list
902 is not reset. This makes the CursorHold example work after a
903 |:ptnext|.
904
905CTRL-W z *CTRL-W_z*
906CTRL-W CTRL-Z *CTRL-W_CTRL-Z* *:pc* *:pclose*
907:pc[lose][!] Close any "Preview" window currently open. When the 'hidden'
908 option is set, or when the buffer was changed and the [!] is
909 used, the buffer becomes hidden (unless there is another
910 window editing it). The command fails if any "Preview" buffer
911 cannot be closed. See also |:close|.
912
913 *:pp* *:ppop*
914:[count]pp[op][!]
915 Does ":[count]pop[!]" in the preview window. See |:pop| and
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200916 |:ptag|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000917
918CTRL-W } *CTRL-W_}*
919 Use identifier under cursor as a tag and perform a :ptag on
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000920 it. Make the new Preview window (if required) N high. If N is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000921 not given, 'previewheight' is used.
922
923CTRL-W g } *CTRL-W_g}*
924 Use identifier under cursor as a tag and perform a :ptjump on
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000925 it. Make the new Preview window (if required) N high. If N is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000926 not given, 'previewheight' is used.
927
928 *:ped* *:pedit*
929:ped[it][!] [++opt] [+cmd] {file}
930 Edit {file} in the preview window. The preview window is
931 opened like with |:ptag|. The current window and cursor
932 position isn't changed. Useful example: >
933 :pedit +/fputc /usr/include/stdio.h
934<
935 *:ps* *:psearch*
936:[range]ps[earch][!] [count] [/]pattern[/]
937 Works like |:ijump| but shows the found match in the preview
938 window. The preview window is opened like with |:ptag|. The
939 current window and cursor position isn't changed. Useful
940 example: >
941 :psearch popen
942< Like with the |:ptag| command, you can use this to
943 automatically show information about the word under the
944 cursor. This is less clever than using |:ptag|, but you don't
945 need a tags file and it will also find matches in system
946 include files. Example: >
947 :au! CursorHold *.[ch] nested exe "silent! psearch " . expand("<cword>")
948< Warning: This can be slow.
949
950Example *CursorHold-example* >
951
952 :au! CursorHold *.[ch] nested exe "silent! ptag " . expand("<cword>")
953
954This will cause a ":ptag" to be executed for the keyword under the cursor,
955when the cursor hasn't moved for the time set with 'updatetime'. The "nested"
956makes other autocommands be executed, so that syntax highlighting works in the
957preview window. The "silent!" avoids an error message when the tag could not
958be found. Also see |CursorHold|. To disable this again: >
959
960 :au! CursorHold
961
962A nice addition is to highlight the found tag, avoid the ":ptag" when there
963is no word under the cursor, and a few other things: >
964
965 :au! CursorHold *.[ch] nested call PreviewWord()
966 :func PreviewWord()
967 : if &previewwindow " don't do this in the preview window
968 : return
969 : endif
970 : let w = expand("<cword>") " get the word under cursor
971 : if w =~ '\a' " if the word contains a letter
972 :
973 : " Delete any existing highlight before showing another tag
974 : silent! wincmd P " jump to preview window
975 : if &previewwindow " if we really get there...
976 : match none " delete existing highlight
977 : wincmd p " back to old window
978 : endif
979 :
980 : " Try displaying a matching tag for the word under the cursor
981 : try
982 : exe "ptag " . w
983 : catch
984 : return
985 : endtry
986 :
987 : silent! wincmd P " jump to preview window
988 : if &previewwindow " if we really get there...
989 : if has("folding")
990 : silent! .foldopen " don't want a closed fold
991 : endif
992 : call search("$", "b") " to end of previous line
993 : let w = substitute(w, '\\', '\\\\', "")
994 : call search('\<\V' . w . '\>') " position cursor on match
995 : " Add a match highlight to the word at this position
996 : hi previewWord term=bold ctermbg=green guibg=green
997 : exe 'match previewWord "\%' . line(".") . 'l\%' . col(".") . 'c\k*"'
998 : wincmd p " back to old window
999 : endif
1000 : endif
1001 :endfun
1002
1003==============================================================================
100411. Using hidden buffers *buffer-hidden*
1005
1006A hidden buffer is not displayed in a window, but is still loaded into memory.
1007This makes it possible to jump from file to file, without the need to read or
1008write the file every time you get another buffer in a window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001009
1010 *:buffer-!*
1011If the option 'hidden' ('hid') is set, abandoned buffers are kept for all
1012commands that start editing another file: ":edit", ":next", ":tag", etc. The
1013commands that move through the buffer list sometimes make the current buffer
1014hidden although the 'hidden' option is not set. This happens when a buffer is
1015modified, but is forced (with '!') to be removed from a window, and
1016'autowrite' is off or the buffer can't be written.
1017
1018You can make a hidden buffer not hidden by starting to edit it with any
1019command. Or by deleting it with the ":bdelete" command.
1020
1021The 'hidden' is global, it is used for all buffers. The 'bufhidden' option
1022can be used to make an exception for a specific buffer. It can take these
1023values:
1024 <empty> Use the value of 'hidden'.
1025 hide Hide this buffer, also when 'hidden' is not set.
1026 unload Don't hide but unload this buffer, also when 'hidden'
1027 is set.
1028 delete Delete the buffer.
1029
1030 *hidden-quit*
1031When you try to quit Vim while there is a hidden, modified buffer, you will
1032get an error message and Vim will make that buffer the current buffer. You
1033can then decide to write this buffer (":wq") or quit without writing (":q!").
1034Be careful: there may be more hidden, modified buffers!
1035
1036A buffer can also be unlisted. This means it exists, but it is not in the
1037list of buffers. |unlisted-buffer|
1038
1039
Bram Moolenaard51cb702015-07-21 15:03:06 +02001040:files[!] [flags] *:files*
1041:buffers[!] [flags] *:buffers* *:ls*
1042:ls[!] [flags]
1043 Show all buffers. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001044
Bram Moolenaar97d62492012-11-15 21:28:22 +01001045 1 #h "/test/text" line 1 ~
1046 2u "asdf" line 0 ~
1047 3 %a + "version.c" line 1 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +00001048
1049 When the [!] is included the list will show unlisted buffers
1050 (the term "unlisted" is a bit confusing then...).
1051
1052 Each buffer has a unique number. That number will not change,
Bram Moolenaar0122c402015-02-03 19:13:34 +01001053 thus you can always go to a specific buffer with ":buffer N"
1054 or "N CTRL-^", where N is the buffer number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001055
Bram Moolenaarc6896e22019-05-30 22:32:34 +02001056 For the file name these special values are used:
1057 [Prompt] |prompt-buffer|
1058 [Popup] buffer of a |popup-window|
1059 [Scratch] 'buftype' is "nofile"
1060 [No Name] no file name specified
1061 For a |terminal-window| buffer the status is used.
1062
Bram Moolenaar071d4272004-06-13 20:20:40 +00001063 Indicators (chars in the same column are mutually exclusive):
1064 u an unlisted buffer (only displayed when [!] is used)
1065 |unlisted-buffer|
1066 % the buffer in the current window
1067 # the alternate buffer for ":e #" and CTRL-^
1068 a an active buffer: it is loaded and visible
1069 h a hidden buffer: It is loaded, but currently not
1070 displayed in a window |hidden-buffer|
1071 - a buffer with 'modifiable' off
1072 = a readonly buffer
Bram Moolenaarc572da52017-08-27 16:52:01 +02001073 R a terminal buffer with a running job
1074 F a terminal buffer with a finished job
Bram Moolenaar37c64c72017-09-19 22:06:03 +02001075 ? a terminal buffer without a job: `:terminal NONE`
Bram Moolenaar071d4272004-06-13 20:20:40 +00001076 + a modified buffer
1077 x a buffer with read errors
1078
Bram Moolenaard51cb702015-07-21 15:03:06 +02001079 [flags] can be a combination of the following characters,
1080 which restrict the buffers to be listed:
1081 + modified buffers
1082 - buffers with 'modifiable' off
1083 = readonly buffers
1084 a active buffers
Bram Moolenaare392eb42015-11-19 20:38:09 +01001085 u unlisted buffers (overrides the "!")
Bram Moolenaard51cb702015-07-21 15:03:06 +02001086 h hidden buffers
1087 x buffers with a read error
1088 % current buffer
1089 # alternate buffer
Bram Moolenaar0751f512018-03-29 16:37:16 +02001090 R terminal buffers with a running job
1091 F terminal buffers with a finished job
1092 ? terminal buffers without a job: `:terminal NONE`
Bram Moolenaar52410572019-10-27 05:12:45 +01001093 t show time last used and sort buffers
Bram Moolenaard51cb702015-07-21 15:03:06 +02001094 Combining flags means they are "and"ed together, e.g.:
1095 h+ hidden buffers which are modified
1096 a+ active buffers which are modified
1097
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02001098 When using |:filter| the pattern is matched against the
1099 displayed buffer name, e.g.: >
1100 filter /\.vim/ ls
1101<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001102 *:bad* *:badd*
1103:bad[d] [+lnum] {fname}
1104 Add file name {fname} to the buffer list, without loading it.
1105 If "lnum" is specified, the cursor will be positioned at that
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001106 line when the buffer is first entered. Note that other
Bram Moolenaar071d4272004-06-13 20:20:40 +00001107 commands after the + will be ignored.
1108
1109:[N]bd[elete][!] *:bd* *:bdel* *:bdelete* *E516*
1110:bd[elete][!] [N]
1111 Unload buffer [N] (default: current buffer) and delete it from
1112 the buffer list. If the buffer was changed, this fails,
1113 unless when [!] is specified, in which case changes are lost.
1114 The file remains unaffected. Any windows for this buffer are
1115 closed. If buffer [N] is the current buffer, another buffer
1116 will be displayed instead. This is the most recent entry in
1117 the jump list that points into a loaded buffer.
1118 Actually, the buffer isn't completely deleted, it is removed
1119 from the buffer list |unlisted-buffer| and option values,
1120 variables and mappings/abbreviations for the buffer are
Bram Moolenaar4d84d932014-11-30 14:50:16 +01001121 cleared. Examples: >
1122 :.,$-bdelete " delete buffers from the current one to
1123 " last but one
1124 :%bdelete " delete all buffers
1125<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001126
1127:bdelete[!] {bufname} *E93* *E94*
Bram Moolenaar15142e22018-04-30 22:19:58 +02001128 Like ":bdelete[!] [N]", but buffer given by name, see
1129 |{bufname}|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001130
1131:bdelete[!] N1 N2 ...
1132 Do ":bdelete[!]" for buffer N1, N2, etc. The arguments can be
1133 buffer numbers or buffer names (but not buffer names that are
1134 a number). Insert a backslash before a space in a buffer
1135 name.
1136
1137:N,Mbdelete[!] Do ":bdelete[!]" for all buffers in the range N to M
1138 |inclusive|.
1139
1140:[N]bw[ipeout][!] *:bw* *:bwipe* *:bwipeout* *E517*
1141:bw[ipeout][!] {bufname}
1142:N,Mbw[ipeout][!]
1143:bw[ipeout][!] N1 N2 ...
Bram Moolenaardf1bdc92006-02-23 21:32:16 +00001144 Like |:bdelete|, but really delete the buffer. Everything
1145 related to the buffer is lost. All marks in this buffer
1146 become invalid, option settings are lost, etc. Don't use this
Bram Moolenaar4d84d932014-11-30 14:50:16 +01001147 unless you know what you are doing. Examples: >
1148 :.+,$bwipeout " wipe out all buffers after the current
1149 " one
1150 :%bwipeout " wipe out all buffers
1151<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001152
1153:[N]bun[load][!] *:bun* *:bunload* *E515*
1154:bun[load][!] [N]
1155 Unload buffer [N] (default: current buffer). The memory
1156 allocated for this buffer will be freed. The buffer remains
1157 in the buffer list.
1158 If the buffer was changed, this fails, unless when [!] is
1159 specified, in which case the changes are lost.
1160 Any windows for this buffer are closed. If buffer [N] is the
1161 current buffer, another buffer will be displayed instead.
1162 This is the most recent entry in the jump list that points
1163 into a loaded buffer.
1164
1165:bunload[!] {bufname}
Bram Moolenaar15142e22018-04-30 22:19:58 +02001166 Like ":bunload[!] [N]", but buffer given by name.
1167 Also see |{bufname}|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001168
1169:N,Mbunload[!] Do ":bunload[!]" for all buffers in the range N to M
1170 |inclusive|.
1171
1172:bunload[!] N1 N2 ...
1173 Do ":bunload[!]" for buffer N1, N2, etc. The arguments can be
1174 buffer numbers or buffer names (but not buffer names that are
1175 a number). Insert a backslash before a space in a buffer
1176 name.
1177
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001178:[N]b[uffer][!] [+cmd] [N] *:b* *:bu* *:buf* *:buffer* *E86*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001179 Edit buffer [N] from the buffer list. If [N] is not given,
1180 the current buffer remains being edited. See |:buffer-!| for
1181 [!]. This will also edit a buffer that is not in the buffer
1182 list, without setting the 'buflisted' flag.
Bram Moolenaar12969c02015-09-08 23:36:10 +02001183 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001184
Bram Moolenaar15142e22018-04-30 22:19:58 +02001185:[N]b[uffer][!] [+cmd] {bufname} *{bufname}*
1186 Edit buffer for {bufname} from the buffer list. A partial
1187 name also works, so long as it is unique in the list of
1188 buffers.
1189 Note that a buffer whose name is a number cannot be referenced
1190 by that name; use the buffer number instead.
1191 Insert a backslash before a space in a buffer name.
1192 See |:buffer-!| for [!].
1193 This will also edit a buffer that is not in the buffer list,
1194 without setting the 'buflisted' flag.
Bram Moolenaar12969c02015-09-08 23:36:10 +02001195 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001196
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001197:[N]sb[uffer] [+cmd] [N] *:sb* *:sbuffer*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001198 Split window and edit buffer [N] from the buffer list. If [N]
1199 is not given, the current buffer is edited. Respects the
1200 "useopen" setting of 'switchbuf' when splitting. This will
1201 also edit a buffer that is not in the buffer list, without
1202 setting the 'buflisted' flag.
Bram Moolenaar12969c02015-09-08 23:36:10 +02001203 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001204
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001205:[N]sb[uffer] [+cmd] {bufname}
Bram Moolenaar15142e22018-04-30 22:19:58 +02001206 Split window and edit buffer for |{bufname}| from the buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001207 list. This will also edit a buffer that is not in the buffer
1208 list, without setting the 'buflisted' flag.
Bram Moolenaar280f1262006-01-30 00:14:18 +00001209 Note: If what you want to do is split the buffer, make a copy
1210 under another name, you can do it this way: >
1211 :w foobar | sp #
Bram Moolenaar12969c02015-09-08 23:36:10 +02001212< Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001213
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001214:[N]bn[ext][!] [+cmd] [N] *:bn* *:bnext* *E87*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001215 Go to [N]th next buffer in buffer list. [N] defaults to one.
1216 Wraps around the end of the buffer list.
1217 See |:buffer-!| for [!].
Bram Moolenaar12969c02015-09-08 23:36:10 +02001218 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001219 If you are in a help buffer, this takes you to the next help
1220 buffer (if there is one). Similarly, if you are in a normal
1221 (non-help) buffer, this takes you to the next normal buffer.
1222 This is so that if you have invoked help, it doesn't get in
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001223 the way when you're browsing code/text buffers. The next three
Bram Moolenaar071d4272004-06-13 20:20:40 +00001224 commands also work like this.
1225
1226 *:sbn* *:sbnext*
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001227:[N]sbn[ext] [+cmd] [N]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001228 Split window and go to [N]th next buffer in buffer list.
1229 Wraps around the end of the buffer list. Uses 'switchbuf'
Bram Moolenaar12969c02015-09-08 23:36:10 +02001230 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001231
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001232:[N]bN[ext][!] [+cmd] [N] *:bN* *:bNext* *:bp* *:bprevious* *E88*
1233:[N]bp[revious][!] [+cmd] [N]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001234 Go to [N]th previous buffer in buffer list. [N] defaults to
1235 one. Wraps around the start of the buffer list.
1236 See |:buffer-!| for [!] and 'switchbuf'.
Bram Moolenaar12969c02015-09-08 23:36:10 +02001237 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001238
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001239:[N]sbN[ext] [+cmd] [N] *:sbN* *:sbNext* *:sbp* *:sbprevious*
1240:[N]sbp[revious] [+cmd] [N]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001241 Split window and go to [N]th previous buffer in buffer list.
1242 Wraps around the start of the buffer list.
1243 Uses 'switchbuf'.
Bram Moolenaar12969c02015-09-08 23:36:10 +02001244 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001245
Bram Moolenaar61da1bf2019-06-06 12:14:49 +02001246:br[ewind][!] [+cmd] *:br* *:bre* *:brewind*
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001247 Go to first buffer in buffer list. If the buffer list is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001248 empty, go to the first unlisted buffer.
1249 See |:buffer-!| for [!].
1250
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001251:bf[irst] [+cmd] *:bf* *:bfirst*
1252 Same as |:brewind|.
1253 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001254
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001255:sbr[ewind] [+cmd] *:sbr* *:sbrewind*
1256 Split window and go to first buffer in buffer list. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001257 buffer list is empty, go to the first unlisted buffer.
1258 Respects the 'switchbuf' option.
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001259 Also see |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001260
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001261:sbf[irst] [+cmd] *:sbf* *:sbfirst*
1262 Same as ":sbrewind".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001263
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001264:bl[ast][!] [+cmd] *:bl* *:blast*
1265 Go to last buffer in buffer list. If the buffer list is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001266 empty, go to the last unlisted buffer.
1267 See |:buffer-!| for [!].
1268
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001269:sbl[ast] [+cmd] *:sbl* *:sblast*
1270 Split window and go to last buffer in buffer list. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001271 buffer list is empty, go to the last unlisted buffer.
1272 Respects 'switchbuf' option.
1273
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001274:[N]bm[odified][!] [+cmd] [N] *:bm* *:bmodified* *E84*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001275 Go to [N]th next modified buffer. Note: this command also
1276 finds unlisted buffers. If there is no modified buffer the
1277 command fails.
1278
Bram Moolenaar9c8d9e12014-09-19 20:07:26 +02001279:[N]sbm[odified] [+cmd] [N] *:sbm* *:sbmodified*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001280 Split window and go to [N]th next modified buffer.
1281 Respects 'switchbuf' option.
1282 Note: this command also finds buffers not in the buffer list.
1283
1284:[N]unh[ide] [N] *:unh* *:unhide* *:sun* *:sunhide*
1285:[N]sun[hide] [N]
1286 Rearrange the screen to open one window for each loaded buffer
1287 in the buffer list. When a count is given, this is the
1288 maximum number of windows to open.
1289
1290:[N]ba[ll] [N] *:ba* *:ball* *:sba* *:sball*
1291:[N]sba[ll] [N] Rearrange the screen to open one window for each buffer in
1292 the buffer list. When a count is given, this is the maximum
1293 number of windows to open. 'winheight' also limits the number
1294 of windows opened ('winwidth' if |:vertical| was prepended).
1295 Buf/Win Enter/Leave autocommands are not executed for the new
1296 windows here, that's only done when they are really entered.
Bram Moolenaar756ec0f2007-05-05 17:59:48 +00001297 When the |:tab| modifier is used new windows are opened in a
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00001298 new tab, up to 'tabpagemax'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001299
1300Note: All the commands above that start editing another buffer, keep the
1301'readonly' flag as it was. This differs from the ":edit" command, which sets
1302the 'readonly' flag each time the file is read.
1303
1304==============================================================================
130512. Special kinds of buffers *special-buffers*
1306
1307Instead of containing the text of a file, buffers can also be used for other
1308purposes. A few options can be set to change the behavior of a buffer:
1309 'bufhidden' what happens when the buffer is no longer displayed
1310 in a window.
1311 'buftype' what kind of a buffer this is
1312 'swapfile' whether the buffer will have a swap file
1313 'buflisted' buffer shows up in the buffer list
1314
1315A few useful kinds of a buffer:
1316
Bram Moolenaar280f1262006-01-30 00:14:18 +00001317quickfix Used to contain the error list or the location list. See
1318 |:cwindow| and |:lwindow|. This command sets the 'buftype'
1319 option to "quickfix". You are not supposed to change this!
1320 'swapfile' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001321
1322help Contains a help file. Will only be created with the |:help|
1323 command. The flag that indicates a help buffer is internal
1324 and can't be changed. The 'buflisted' option will be reset
1325 for a help buffer.
1326
Bram Moolenaarb6e0ec62017-07-23 22:12:20 +02001327terminal A terminal window buffer, see |terminal|. The contents cannot
1328 be read or changed until the job ends.
1329
Bram Moolenaar677ee682005-01-27 14:41:15 +00001330directory Displays directory contents. Can be used by a file explorer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001331 plugin. The buffer is created with these settings: >
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001332 :setlocal buftype=nowrite
1333 :setlocal bufhidden=delete
1334 :setlocal noswapfile
Bram Moolenaar071d4272004-06-13 20:20:40 +00001335< The buffer name is the name of the directory and is adjusted
1336 when using the |:cd| command.
1337
1338scratch Contains text that can be discarded at any time. It is kept
1339 when closing the window, it must be deleted explicitly.
1340 Settings: >
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001341 :setlocal buftype=nofile
1342 :setlocal bufhidden=hide
1343 :setlocal noswapfile
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001344< The buffer name can be used to identify the buffer, if you
1345 give it a meaningful name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001346
1347 *unlisted-buffer*
1348unlisted The buffer is not in the buffer list. It is not used for
1349 normal editing, but to show a help file, remember a file name
1350 or marks. The ":bdelete" command will also set this option,
1351 thus it doesn't completely delete the buffer. Settings: >
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001352 :setlocal nobuflisted
Bram Moolenaar071d4272004-06-13 20:20:40 +00001353<
1354
Bram Moolenaard473c8c2018-08-11 18:00:22 +02001355 vim:tw=78:ts=8:noet:ft=help:norl: