Mercurial > vim
annotate runtime/doc/windows.txt @ 30422:52b7188f13b1
Added tag v9.0.0546 for changeset 425b686c5244788b67d1205e696f6d04bedb0f24
author | Bram Moolenaar <Bram@vim.org> |
---|---|
date | Thu, 22 Sep 2022 17:15:04 +0200 |
parents | ebed259f919f |
children | 5acd6f02ea35 |
rev | line source |
---|---|
29314 | 1 *windows.txt* For Vim version 9.0. Last change: 2022 May 11 |
7 | 2 |
3 | |
4 VIM REFERENCE MANUAL by Bram Moolenaar | |
5 | |
6 | |
7 Editing with multiple windows and buffers. *windows* *buffers* | |
8 | |
9 The commands which have been added to use multiple windows and buffers are | |
10 explained here. Additionally, there are explanations for commands that work | |
11 differently when used in combination with more than one window. | |
12 | |
13 The basics are explained in chapter 7 and 8 of the user manual |usr_07.txt| | |
14 |usr_08.txt|. | |
15 | |
16 1. Introduction |windows-intro| | |
17 2. Starting Vim |windows-starting| | |
18 3. Opening and closing a window |opening-window| | |
19 4. Moving cursor to other windows |window-move-cursor| | |
20 5. Moving windows around |window-moving| | |
21 6. Window resizing |window-resize| | |
22 7. Argument and buffer list commands |buffer-list| | |
23 8. Do a command in all buffers or windows |list-repeat| | |
24 9. Tag or file name under the cursor |window-tag| | |
25 10. The preview window |preview-window| | |
26 11. Using hidden buffers |buffer-hidden| | |
27 12. Special kinds of buffers |special-buffers| | |
28 | |
29 {not able to use multiple windows when the |+windows| feature was disabled at | |
30 compile time} | |
31 | |
32 ============================================================================== | |
819 | 33 1. Introduction *windows-intro* *window* |
7 | 34 |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
35 Summary: |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
36 A buffer is the in-memory text of a file. |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
37 A window is a viewport on a buffer. |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
38 A tab page is a collection of windows. |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
39 |
7 | 40 A window is a viewport onto a buffer. You can use multiple windows on one |
41 buffer, or several windows on different buffers. | |
42 | |
43 A buffer is a file loaded into memory for editing. The original file remains | |
44 unchanged until you write the buffer to the file. | |
45 | |
46 A buffer can be in one of three states: | |
47 | |
48 *active-buffer* | |
49 active: 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* | |
53 hidden: 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* | |
57 inactive: 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 | |
62 In a table: | |
63 | |
64 state displayed loaded ":buffers" ~ | |
65 in window shows ~ | |
66 active yes yes 'a' | |
67 hidden no yes 'h' | |
68 inactive no no ' ' | |
69 | |
70 Note: All CTRL-W commands can also be executed with |:wincmd|, for those | |
71 places where a Normal mode command can't be used or is inconvenient. | |
72 | |
674 | 73 The main Vim window can hold several split windows. There are also tab pages |
74 |tab-page|, each of which can hold multiple windows. | |
9975
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9908
diff
changeset
|
75 *window-ID* *winid* *windowid* |
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
7924
diff
changeset
|
76 Each window has a unique identifier called the window ID. This identifier |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
7924
diff
changeset
|
77 will not change within a Vim session. The |win_getid()| and |win_id2tabwin()| |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
7924
diff
changeset
|
78 functions can be used to convert between the window/tab number and the |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
7924
diff
changeset
|
79 identifier. There is also the window number, which may change whenever |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
7924
diff
changeset
|
80 windows are opened or closed, see |winnr()|. |
14999 | 81 The window number is only valid in one specific tab. The window ID is valid |
82 across tabs. For most functions that take a window ID or a window number, the | |
83 window number only applies to the current tab, while the window ID can refer | |
84 to a window in any tab. | |
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
7924
diff
changeset
|
85 |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
7924
diff
changeset
|
86 Each buffer has a unique number and the number will not change within a Vim |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
7924
diff
changeset
|
87 session. The |bufnr()| and |bufname()| functions can be used to convert |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
7924
diff
changeset
|
88 between a buffer name and the buffer number. |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
7924
diff
changeset
|
89 |
7 | 90 ============================================================================== |
91 2. Starting Vim *windows-starting* | |
92 | |
93 By default, Vim starts with one window, just like Vi. | |
94 | |
95 The "-o" and "-O" arguments to Vim can be used to open a window for each file | |
96 in the argument list. The "-o" argument will split the windows horizontally; | |
97 the "-O" argument will split the windows vertically. If both "-o" and "-O" | |
98 are given, the last one encountered will be used to determine the split | |
99 orientation. 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 | |
103 there are more file names than windows, only N windows are opened and some | |
104 files do not get a window. If there are more windows than file names, the | |
105 last few windows will be editing empty buffers. Similarly, "-ON" opens N | |
106 windows split vertically, with the same restrictions. | |
107 | |
108 If there are many file names, the windows will become very small. You might | |
109 want to set the 'winheight' and/or 'winwidth' options to create a workable | |
110 situation. | |
111 | |
112 Buf/Win Enter/Leave |autocommand|s are not executed when opening the new | |
113 windows and reading the files, that's only done when they are really entered. | |
114 | |
115 *status-line* | |
116 A status line will be used to separate windows. The 'laststatus' option tells | |
117 when 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 | |
122 You can change the contents of the status line with the 'statusline' option. | |
40 | 123 This option can be local to the window, so that you can have a different |
124 status line in each window. | |
7 | 125 |
126 Normally, inversion is used to display the status line. This can be changed | |
127 with the 's' character in the 'highlight' option. For example, "sb" sets it to | |
128 bold 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 | |
130 the mouse is supported and enabled with the 'mouse' option, a status line can | |
131 be dragged to resize windows. | |
132 | |
133 Note: If you expect your status line to be in reverse video and it isn't, | |
134 check if the 'highlight' option contains "si". In version 3.0, this meant to | |
135 invert 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 | |
137 status line is inverted anyway; you will only see this problem on terminals | |
138 that have termcap codes for italics. | |
139 | |
20856 | 140 *filler-lines* |
23932
4549133c1e77
patch 8.2.2508: cannot change the character displayed in non existing lines
Bram Moolenaar <Bram@vim.org>
parents:
23931
diff
changeset
|
141 The lines after the last buffer line in a window are called filler lines. By |
4549133c1e77
patch 8.2.2508: cannot change the character displayed in non existing lines
Bram Moolenaar <Bram@vim.org>
parents:
23931
diff
changeset
|
142 default, these lines start with a tilde (~) character. The 'eob' item in the |
4549133c1e77
patch 8.2.2508: cannot change the character displayed in non existing lines
Bram Moolenaar <Bram@vim.org>
parents:
23931
diff
changeset
|
143 'fillchars' option can be used to change this character. By default, these |
4549133c1e77
patch 8.2.2508: cannot change the character displayed in non existing lines
Bram Moolenaar <Bram@vim.org>
parents:
23931
diff
changeset
|
144 characters are highlighted as NonText (|hl-NonText|). The EndOfBuffer |
4549133c1e77
patch 8.2.2508: cannot change the character displayed in non existing lines
Bram Moolenaar <Bram@vim.org>
parents:
23931
diff
changeset
|
145 highlight group (|hl-EndOfBuffer|) can be used to change the highlighting of |
4549133c1e77
patch 8.2.2508: cannot change the character displayed in non existing lines
Bram Moolenaar <Bram@vim.org>
parents:
23931
diff
changeset
|
146 the filler characters. |
20856 | 147 |
7 | 148 ============================================================================== |
27036 | 149 3. Opening and closing a window *opening-window* |
7 | 150 |
151 CTRL-W s *CTRL-W_s* | |
152 CTRL-W S *CTRL-W_S* | |
153 CTRL-W CTRL-S *CTRL-W_CTRL-S* | |
5741 | 154 :[N]sp[lit] [++opt] [+cmd] [file] *:sp* *:split* |
7 | 155 Split current window in two. The result is two viewports on |
5741 | 156 the same file. |
18831 | 157 |
5741 | 158 Make the new window N high (default is to use half the height |
159 of the current window). Reduces the current window height to | |
160 create room (and others, if the 'equalalways' option is set, | |
161 'eadirection' isn't "hor", and one of them is higher than the | |
162 current or the new window). | |
163 | |
164 If [file] is given it will be edited in the new window. If it | |
165 is not loaded in any buffer, it will be read. Else the new | |
166 window will use the already loaded buffer. | |
167 | |
7 | 168 Note: CTRL-S does not work on all terminals and might block |
169 further input, use CTRL-Q to get going again. | |
170 Also see |++opt| and |+cmd|. | |
27537 | 171 *E242* *E1159* |
17571 | 172 Be careful when splitting a window in an autocommand, it may |
173 mess up the window layout if this happens while making other | |
174 window layout changes. | |
7 | 175 |
176 CTRL-W CTRL-V *CTRL-W_CTRL-V* | |
177 CTRL-W v *CTRL-W_v* | |
178 :[N]vs[plit] [++opt] [+cmd] [file] *:vs* *:vsplit* | |
1354 | 179 Like |:split|, but split vertically. The windows will be |
180 spread out horizontally if | |
181 1. a width was not specified, | |
182 2. 'equalalways' is set, | |
183 3. 'eadirection' isn't "ver", and | |
1622 | 184 4. one of the other windows is wider than the current or new |
1354 | 185 window. |
29840 | 186 If N was given make the new window N columns wide, if |
187 possible. | |
7 | 188 Note: In other places CTRL-Q does the same as CTRL-V, but here |
189 it doesn't! | |
190 | |
191 CTRL-W n *CTRL-W_n* | |
192 CTRL-W CTRL_N *CTRL-W_CTRL-N* | |
193 :[N]new [++opt] [+cmd] *:new* | |
194 Create a new window and start editing an empty file in it. | |
195 Make new window N high (default is to use half the existing | |
196 height). Reduces the current window height to create room (and | |
197 others, if the 'equalalways' option is set and 'eadirection' | |
198 isn't "hor"). | |
199 Also see |++opt| and |+cmd|. | |
200 If 'fileformats' is not empty, the first format given will be | |
201 used for the new buffer. If 'fileformats' is empty, the | |
202 'fileformat' of the current buffer is used. This can be | |
203 overridden with the |++opt| argument. | |
204 Autocommands are executed in this order: | |
205 1. WinLeave for the current window | |
206 2. WinEnter for the new window | |
207 3. BufLeave for the current buffer | |
208 4. BufEnter for the new buffer | |
3465 | 209 This behaves like a ":split" first, and then an ":enew" |
210 command. | |
7 | 211 |
212 :[N]new [++opt] [+cmd] {file} | |
213 :[N]sp[lit] [++opt] [+cmd] {file} *:split_f* | |
3465 | 214 Create a new window and start editing file {file} in it. This |
23931 | 215 behaves almost like a ":split" first, and then an ":edit" |
216 command, but the alternate file name in the original window is | |
217 set to {file}. | |
7 | 218 If [+cmd] is given, execute the command when the file has been |
219 loaded |+cmd|. | |
220 Also see |++opt|. | |
221 Make new window N high (default is to use half the existing | |
222 height). Reduces the current window height to create room | |
223 (and others, if the 'equalalways' option is set). | |
224 | |
23305 | 225 :[N]vne[w] [++opt] [+cmd] [file] *:vne* *:vnew* |
226 Like |:new|, but split vertically. If 'equalalways' is set | |
227 and 'eadirection' isn't "ver" the windows will be spread out | |
228 horizontally, unless a width was specified. | |
229 | |
19721 | 230 :[N]sv[iew] [++opt] [+cmd] [file] *:sv* *:sview* *splitview* |
7 | 231 Same as ":split", but set 'readonly' option for this buffer. |
232 | |
16944 | 233 :[N]sf[ind] [++opt] [+cmd] {file} *:sf* *:sfi* *:sfind* *splitfind* |
1668 | 234 Same as ":split", but search for {file} in 'path' like in |
235 |:find|. Doesn't split if {file} is not found. | |
7 | 236 |
237 CTRL-W CTRL-^ *CTRL-W_CTRL-^* *CTRL-W_^* | |
15006
1fd8e32532f7
patch 8.1.0514: CTRL-W ^ does not work when alternate buffer has no name
Bram Moolenaar <Bram@vim.org>
parents:
14999
diff
changeset
|
238 CTRL-W ^ Split the current window in two and edit the alternate file. |
1fd8e32532f7
patch 8.1.0514: CTRL-W ^ does not work when alternate buffer has no name
Bram Moolenaar <Bram@vim.org>
parents:
14999
diff
changeset
|
239 When a count N is given, split the current window and edit |
1fd8e32532f7
patch 8.1.0514: CTRL-W ^ does not work when alternate buffer has no name
Bram Moolenaar <Bram@vim.org>
parents:
14999
diff
changeset
|
240 buffer N. Similar to ":sp #" and ":sp #N", but it allows the |
1fd8e32532f7
patch 8.1.0514: CTRL-W ^ does not work when alternate buffer has no name
Bram Moolenaar <Bram@vim.org>
parents:
14999
diff
changeset
|
241 other buffer to be unnamed. This command matches the behavior |
1fd8e32532f7
patch 8.1.0514: CTRL-W ^ does not work when alternate buffer has no name
Bram Moolenaar <Bram@vim.org>
parents:
14999
diff
changeset
|
242 of |CTRL-^|, except that it splits a window first. |
7 | 243 |
11763
21f3930dfe6e
Documentation updates.
Christian Brabandt <cb@256bit.org>
parents:
10449
diff
changeset
|
244 *CTRL-W_:* |
14123 | 245 CTRL-W : Does the same as typing |:| - enter a command line. Useful in a |
11763
21f3930dfe6e
Documentation updates.
Christian Brabandt <cb@256bit.org>
parents:
10449
diff
changeset
|
246 terminal window, where all Vim commands must be preceded with |
14123 | 247 CTRL-W or 'termwinkey'. |
11763
21f3930dfe6e
Documentation updates.
Christian Brabandt <cb@256bit.org>
parents:
10449
diff
changeset
|
248 |
7 | 249 Note that the 'splitbelow' and 'splitright' options influence where a new |
250 window will appear. | |
27036 | 251 *E36* |
252 Creating a window will fail if there is not enough room. Every window needs | |
253 at least one screen line and column, sometimes more. Options 'winminheight' | |
254 and 'winminwidth' are relevant. | |
7 | 255 |
256 *:vert* *:vertical* | |
257 :vert[ical] {cmd} | |
258 Execute {cmd}. If it contains a command that splits a window, | |
30009
b97a870a7c63
patch 9.0.0342: ":wincmd =" equalizes in two directions
Bram Moolenaar <Bram@vim.org>
parents:
29853
diff
changeset
|
259 it will be split vertically. For `vertical wincmd =` windows |
30085 | 260 will be equalized only vertically. |
1123 | 261 Doesn't work for |:execute| and |:normal|. |
7 | 262 |
30009
b97a870a7c63
patch 9.0.0342: ":wincmd =" equalizes in two directions
Bram Moolenaar <Bram@vim.org>
parents:
29853
diff
changeset
|
263 *:hor* *:horizontal* |
b97a870a7c63
patch 9.0.0342: ":wincmd =" equalizes in two directions
Bram Moolenaar <Bram@vim.org>
parents:
29853
diff
changeset
|
264 :hor[izontal] {cmd} |
b97a870a7c63
patch 9.0.0342: ":wincmd =" equalizes in two directions
Bram Moolenaar <Bram@vim.org>
parents:
29853
diff
changeset
|
265 Execute {cmd}. Currently only makes a difference for |
30085 | 266 `horizontal wincmd =`, which will equalize windows only |
30009
b97a870a7c63
patch 9.0.0342: ":wincmd =" equalizes in two directions
Bram Moolenaar <Bram@vim.org>
parents:
29853
diff
changeset
|
267 horizontally. |
b97a870a7c63
patch 9.0.0342: ":wincmd =" equalizes in two directions
Bram Moolenaar <Bram@vim.org>
parents:
29853
diff
changeset
|
268 |
7 | 269 :lefta[bove] {cmd} *:lefta* *:leftabove* |
270 :abo[veleft] {cmd} *:abo* *:aboveleft* | |
271 Execute {cmd}. If it contains a command that splits a window, | |
272 it will be opened left (vertical split) or above (horizontal | |
273 split) the current window. Overrules 'splitbelow' and | |
274 'splitright'. | |
1123 | 275 Doesn't work for |:execute| and |:normal|. |
7 | 276 |
277 :rightb[elow] {cmd} *:rightb* *:rightbelow* | |
278 :bel[owright] {cmd} *:bel* *:belowright* | |
279 Execute {cmd}. If it contains a command that splits a window, | |
280 it will be opened right (vertical split) or below (horizontal | |
281 split) the current window. Overrules 'splitbelow' and | |
282 'splitright'. | |
1123 | 283 Doesn't work for |:execute| and |:normal|. |
7 | 284 |
285 *:topleft* *E442* | |
286 :to[pleft] {cmd} | |
287 Execute {cmd}. If it contains a command that splits a window, | |
288 it will appear at the top and occupy the full width of the Vim | |
289 window. When the split is vertical the window appears at the | |
290 far left and occupies the full height of the Vim window. | |
1123 | 291 Doesn't work for |:execute| and |:normal|. |
7 | 292 |
9737
35ce559b8553
commit https://github.com/vim/vim/commit/bc8801c9317eb721a2ee91322669f2dd5d136380
Christian Brabandt <cb@256bit.org>
parents:
9286
diff
changeset
|
293 *:bo* *:botright* |
7 | 294 :bo[tright] {cmd} |
295 Execute {cmd}. If it contains a command that splits a window, | |
296 it will appear at the bottom and occupy the full width of the | |
297 Vim window. When the split is vertical the window appears at | |
298 the far right and occupies the full height of the Vim window. | |
1123 | 299 Doesn't work for |:execute| and |:normal|. |
7 | 300 |
301 These command modifiers can be combined to make a vertically split window | |
302 occupy the full height. Example: > | |
3082 | 303 :vertical topleft split tags |
7 | 304 Opens a vertically split, full-height window on the "tags" file at the far |
305 left of the Vim window. | |
306 | |
307 | |
308 Closing a window | |
309 ---------------- | |
310 | |
6398 | 311 :q[uit] |
25773 | 312 :{count}q[uit] *:count_quit* |
7 | 313 CTRL-W q *CTRL-W_q* |
314 CTRL-W CTRL-Q *CTRL-W_CTRL-Q* | |
6398 | 315 Without {count}: Quit the current window. If {count} is |
316 given quit the {count} window. | |
20379 | 317 *edit-window* |
318 When quitting the last edit window (not counting help or | |
319 preview windows), exit Vim. | |
18831 | 320 |
6398 | 321 When 'hidden' is set, and there is only one window for the |
322 current buffer, it becomes hidden. When 'hidden' is not set, | |
323 and there is only one window for the current buffer, and the | |
324 buffer was changed, the command fails. | |
18831 | 325 |
6421 | 326 (Note: CTRL-Q does not work on all terminals). |
18831 | 327 |
6421 | 328 If [count] is greater than the last window number the last |
329 window will be closed: > | |
6398 | 330 :1quit " quit the first window |
331 :$quit " quit the last window | |
332 :9quit " quit the last window | |
10301
07d2b5a3b7cc
commit https://github.com/vim/vim/commit/46fceaaa8d1447a9588736d86eb4908214187b08
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
333 " if there are fewer than 9 windows opened |
07d2b5a3b7cc
commit https://github.com/vim/vim/commit/46fceaaa8d1447a9588736d86eb4908214187b08
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
334 :-quit " quit the previous window |
6398 | 335 :+quit " quit the next window |
6421 | 336 :+2quit " quit the second next window |
6398 | 337 < |
20379 | 338 When closing a help window, and this is not the only window, |
339 Vim will try to restore the previous window layout, see | |
340 |:helpclose|. | |
18456 | 341 |
6398 | 342 :q[uit]! |
343 :{count}q[uit]! | |
344 Without {count}: Quit the current window. If {count} is | |
345 given quit the {count} window. | |
7 | 346 |
6398 | 347 If this was the last window for a buffer, any changes to that |
348 buffer are lost. When quitting the last window (not counting | |
349 help windows), exit Vim. The contents of the buffer are lost, | |
350 even when 'hidden' is set. | |
351 | |
352 :clo[se][!] | |
353 :{count}clo[se][!] | |
7 | 354 CTRL-W c *CTRL-W_c* *:clo* *:close* |
6398 | 355 Without {count}: Close the current window. If {count} is |
356 given close the {count} window. | |
357 | |
358 When the 'hidden' option is set, or when the buffer was | |
359 changed and the [!] is used, the buffer becomes hidden (unless | |
360 there is another window editing it). | |
18831 | 361 |
20379 | 362 When there is only one |edit-window| in the current tab page |
363 and there is another tab page, this closes the current tab | |
364 page. |tab-page|. | |
6398 | 365 |
7 | 366 This command fails when: *E444* |
367 - There is only one window on the screen. | |
368 - When 'hidden' is not set, [!] is not used, the buffer has | |
369 changes, and there is no other window on this buffer. | |
370 Changes to the buffer are not written and won't get lost, so | |
371 this is a "safe" command. | |
372 | |
373 CTRL-W CTRL-C *CTRL-W_CTRL-C* | |
374 You might have expected that CTRL-W CTRL-C closes the current | |
375 window, but that does not work, because the CTRL-C cancels the | |
376 command. | |
377 | |
378 *:hide* | |
6398 | 379 :hid[e] |
380 :{count}hid[e] | |
12254 | 381 Without {count}: Quit the current window, unless it is the |
382 last window on the screen. | |
383 If {count} is given quit the {count} window. | |
18831 | 384 |
6398 | 385 The buffer becomes hidden (unless there is another window |
6421 | 386 editing it or 'bufhidden' is "unload", "delete" or "wipe"). |
387 If the window is the last one in the current tab page the tab | |
18831 | 388 page is closed. |tab-page| |
389 | |
6398 | 390 The value of 'hidden' is irrelevant for this command. Changes |
391 to the buffer are not written and won't get lost, so this is a | |
392 "safe" command. | |
7 | 393 |
394 :hid[e] {cmd} Execute {cmd} with 'hidden' is set. The previous value of | |
395 'hidden' is restored after {cmd} has been executed. | |
396 Example: > | |
397 :hide edit Makefile | |
398 < This will edit "Makefile", and hide the current buffer if it | |
399 has any changes. | |
400 | |
6398 | 401 :on[ly][!] |
402 :{count}on[ly][!] | |
7 | 403 CTRL-W o *CTRL-W_o* *E445* |
404 CTRL-W CTRL-O *CTRL-W_CTRL-O* *:on* *:only* | |
6398 | 405 Make the current window the only one on the screen. All other |
25773 | 406 windows are closed. For {count} see the `:quit` command |
407 above |:count_quit|. | |
18831 | 408 |
7 | 409 When the 'hidden' option is set, all buffers in closed windows |
410 become hidden. | |
18831 | 411 |
7 | 412 When 'hidden' is not set, and the 'autowrite' option is set, |
413 modified buffers are written. Otherwise, windows that have | |
414 buffers that are modified are not removed, unless the [!] is | |
415 given, then they become hidden. But modified buffers are | |
416 never abandoned, so changes cannot get lost. | |
417 | |
418 ============================================================================== | |
419 4. Moving cursor to other windows *window-move-cursor* | |
420 | |
421 CTRL-W <Down> *CTRL-W_<Down>* | |
422 CTRL-W CTRL-J *CTRL-W_CTRL-J* *CTRL-W_j* | |
423 CTRL-W j Move cursor to Nth window below current one. Uses the cursor | |
424 position to select between alternatives. | |
425 | |
426 CTRL-W <Up> *CTRL-W_<Up>* | |
427 CTRL-W CTRL-K *CTRL-W_CTRL-K* *CTRL-W_k* | |
428 CTRL-W k Move cursor to Nth window above current one. Uses the cursor | |
429 position to select between alternatives. | |
430 | |
431 CTRL-W <Left> *CTRL-W_<Left>* | |
432 CTRL-W CTRL-H *CTRL-W_CTRL-H* | |
433 CTRL-W <BS> *CTRL-W_<BS>* *CTRL-W_h* | |
434 CTRL-W h Move cursor to Nth window left of current one. Uses the | |
435 cursor position to select between alternatives. | |
436 | |
437 CTRL-W <Right> *CTRL-W_<Right>* | |
438 CTRL-W CTRL-L *CTRL-W_CTRL-L* *CTRL-W_l* | |
439 CTRL-W l Move cursor to Nth window right of current one. Uses the | |
440 cursor position to select between alternatives. | |
441 | |
442 CTRL-W w *CTRL-W_w* *CTRL-W_CTRL-W* | |
443 CTRL-W CTRL-W Without count: move cursor to window below/right of the | |
444 current one. If there is no window below or right, go to | |
445 top-left window. | |
446 With count: go to Nth window (windows are numbered from | |
447 top-left to bottom-right). To obtain the window number see | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
448 |bufwinnr()| and |winnr()|. When N is larger than the number |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
449 of windows go to the last window. |
7 | 450 |
451 *CTRL-W_W* | |
452 CTRL-W W Without count: move cursor to window above/left of current | |
453 one. If there is no window above or left, go to bottom-right | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
454 window. With count: go to Nth window, like with CTRL-W w. |
7 | 455 |
456 CTRL-W t *CTRL-W_t* *CTRL-W_CTRL-T* | |
457 CTRL-W CTRL-T Move cursor to top-left window. | |
458 | |
459 CTRL-W b *CTRL-W_b* *CTRL-W_CTRL-B* | |
460 CTRL-W CTRL-B Move cursor to bottom-right window. | |
461 | |
462 CTRL-W p *CTRL-W_p* *CTRL-W_CTRL-P* | |
463 CTRL-W CTRL-P Go to previous (last accessed) window. | |
464 | |
465 *CTRL-W_P* *E441* | |
466 CTRL-W P Go to preview window. When there is no preview window this is | |
467 an error. | |
468 {not available when compiled without the |+quickfix| feature} | |
469 | |
470 If Visual mode is active and the new window is not for the same buffer, the | |
471 Visual mode is ended. If the window is on the same buffer, the cursor | |
472 position is set to keep the same Visual area selected. | |
473 | |
474 *:winc* *:wincmd* | |
475 These commands can also be executed with ":wincmd": | |
476 | |
477 :[count]winc[md] {arg} | |
478 Like executing CTRL-W [count] {arg}. Example: > | |
479 :wincmd j | |
480 < Moves to the window below the current one. | |
481 This command is useful when a Normal mode cannot be used (for | |
482 the |CursorHold| autocommand event). Or when a Normal mode | |
483 command is inconvenient. | |
484 The count can also be a window number. Example: > | |
27903 | 485 :exe nr .. "wincmd w" |
7 | 486 < This goes to window "nr". |
487 | |
488 ============================================================================== | |
489 5. Moving windows around *window-moving* | |
490 | |
491 CTRL-W r *CTRL-W_r* *CTRL-W_CTRL-R* *E443* | |
492 CTRL-W CTRL-R Rotate windows downwards/rightwards. The first window becomes | |
493 the second one, the second one becomes the third one, etc. | |
494 The last window becomes the first window. The cursor remains | |
495 in the same window. | |
496 This only works within the row or column of windows that the | |
497 current window is in. | |
498 | |
499 *CTRL-W_R* | |
500 CTRL-W R Rotate windows upwards/leftwards. The second window becomes | |
501 the first one, the third one becomes the second one, etc. The | |
502 first window becomes the last window. The cursor remains in | |
503 the same window. | |
504 This only works within the row or column of windows that the | |
505 current window is in. | |
506 | |
507 CTRL-W x *CTRL-W_x* *CTRL-W_CTRL-X* | |
508 CTRL-W CTRL-X Without count: Exchange current window with next one. If there | |
509 is no next window, exchange with previous window. | |
510 With count: Exchange current window with Nth window (first | |
511 window is 1). The cursor is put in the other window. | |
512 When vertical and horizontal window splits are mixed, the | |
513 exchange is only done in the row or column of windows that the | |
514 current window is in. | |
515 | |
516 The following commands can be used to change the window layout. For example, | |
517 when there are two vertically split windows, CTRL-W K will change that in | |
518 horizontally split windows. CTRL-W H does it the other way around. | |
519 | |
520 *CTRL-W_K* | |
521 CTRL-W K Move the current window to be at the very top, using the full | |
522 width of the screen. This works like closing the current | |
523 window and then creating another one with ":topleft split", | |
524 except that the current window contents is used for the new | |
525 window. | |
526 | |
527 *CTRL-W_J* | |
528 CTRL-W J Move the current window to be at the very bottom, using the | |
529 full width of the screen. This works like closing the current | |
530 window and then creating another one with ":botright split", | |
531 except that the current window contents is used for the new | |
532 window. | |
533 | |
534 *CTRL-W_H* | |
535 CTRL-W H Move the current window to be at the far left, using the | |
536 full height of the screen. This works like closing the | |
537 current window and then creating another one with | |
24468 | 538 `:vert topleft split`, except that the current window contents |
7 | 539 is used for the new window. |
540 | |
541 *CTRL-W_L* | |
542 CTRL-W L Move the current window to be at the far right, using the full | |
543 height of the screen. This works like closing the | |
544 current window and then creating another one with | |
24468 | 545 `:vert botright split`, except that the current window |
7 | 546 contents is used for the new window. |
547 | |
826 | 548 *CTRL-W_T* |
549 CTRL-W T Move the current window to a new tab page. This fails if | |
550 there is only one window in the current tab page. | |
551 When a count is specified the new tab page will be opened | |
552 before the tab page with this index. Otherwise it comes after | |
553 the current tab page. | |
554 | |
7 | 555 ============================================================================== |
556 6. Window resizing *window-resize* | |
557 | |
558 *CTRL-W_=* | |
559 CTRL-W = Make all windows (almost) equally high and wide, but use | |
560 'winheight' and 'winwidth' for the current window. | |
1123 | 561 Windows with 'winfixheight' set keep their height and windows |
562 with 'winfixwidth' set keep their width. | |
30009
b97a870a7c63
patch 9.0.0342: ":wincmd =" equalizes in two directions
Bram Moolenaar <Bram@vim.org>
parents:
29853
diff
changeset
|
563 To equalize only vertically (make window equally high) use |
b97a870a7c63
patch 9.0.0342: ":wincmd =" equalizes in two directions
Bram Moolenaar <Bram@vim.org>
parents:
29853
diff
changeset
|
564 `vertical wincmd =` |
b97a870a7c63
patch 9.0.0342: ":wincmd =" equalizes in two directions
Bram Moolenaar <Bram@vim.org>
parents:
29853
diff
changeset
|
565 To equalize only horizontally (make window equally wide) use |
b97a870a7c63
patch 9.0.0342: ":wincmd =" equalizes in two directions
Bram Moolenaar <Bram@vim.org>
parents:
29853
diff
changeset
|
566 `horizontal wincmd =` |
7 | 567 |
568 :res[ize] -N *:res* *:resize* *CTRL-W_-* | |
569 CTRL-W - Decrease current window height by N (default 1). | |
2152 | 570 If used after |:vertical|: decrease width by N. |
7 | 571 |
572 :res[ize] +N *CTRL-W_+* | |
573 CTRL-W + Increase current window height by N (default 1). | |
2152 | 574 If used after |:vertical|: increase width by N. |
7 | 575 |
576 :res[ize] [N] | |
577 CTRL-W CTRL-_ *CTRL-W_CTRL-_* *CTRL-W__* | |
578 CTRL-W _ Set current window height to N (default: highest possible). | |
579 | |
18489 | 580 :{winnr}res[ize] [+-]N |
581 Like `:resize` above, but apply the size to window {winnr} | |
582 instead of the current window. | |
583 | |
7 | 584 z{nr}<CR> Set current window height to {nr}. |
585 | |
586 *CTRL-W_<* | |
587 CTRL-W < Decrease current window width by N (default 1). | |
588 | |
589 *CTRL-W_>* | |
590 CTRL-W > Increase current window width by N (default 1). | |
591 | |
24468 | 592 :vert[ical] res[ize] [N] *:vertical-resize* *CTRL-W_bar* |
7 | 593 CTRL-W | Set current window width to N (default: widest possible). |
594 | |
595 You can also resize a window by dragging a status line up or down with the | |
596 mouse. Or by dragging a vertical separator line left or right. This only | |
597 works if the version of Vim that is being used supports the mouse and the | |
598 'mouse' option has been set to enable it. | |
599 | |
600 The option 'winheight' ('wh') is used to set the minimal window height of the | |
601 current window. This option is used each time another window becomes the | |
602 current window. If the option is '0', it is disabled. Set 'winheight' to a | |
603 very large value, e.g., '9999', to make the current window always fill all | |
604 available space. Set it to a reasonable value, e.g., '10', to make editing in | |
605 the current window comfortable. | |
606 | |
607 The equivalent 'winwidth' ('wiw') option is used to set the minimal width of | |
608 the current window. | |
609 | |
610 When the option 'equalalways' ('ea') is set, all the windows are automatically | |
611 made the same size after splitting or closing a window. If you don't set this | |
612 option, splitting a window will reduce the size of the current window and | |
613 leave the other windows the same. When closing a window, the extra lines are | |
614 given to the window above it. | |
615 | |
616 The 'eadirection' option limits the direction in which the 'equalalways' | |
617 option is applied. The default "both" resizes in both directions. When the | |
618 value is "ver" only the heights of windows are equalized. Use this when you | |
619 have manually resized a vertically split window and want to keep this width. | |
620 Likewise, "hor" causes only the widths of windows to be equalized. | |
621 | |
622 The option 'cmdheight' ('ch') is used to set the height of the command-line. | |
623 If you are annoyed by the |hit-enter| prompt for long messages, set this | |
624 option to 2 or 3. | |
625 | |
626 If there is only one window, resizing that window will also change the command | |
627 line height. If there are several windows, resizing the current window will | |
628 also change the height of the window below it (and sometimes the window above | |
629 it). | |
630 | |
631 The minimal height and width of a window is set with 'winminheight' and | |
632 'winminwidth'. These are hard values, a window will never become smaller. | |
633 | |
634 ============================================================================== | |
635 7. Argument and buffer list commands *buffer-list* | |
636 | |
637 args list buffer list meaning ~ | |
638 1. :[N]argument [N] 11. :[N]buffer [N] to arg/buf N | |
639 2. :[N]next [file ..] 12. :[N]bnext [N] to Nth next arg/buf | |
640 3. :[N]Next [N] 13. :[N]bNext [N] to Nth previous arg/buf | |
641 4. :[N]previous [N] 14. :[N]bprevious [N] to Nth previous arg/buf | |
642 5. :rewind / :first 15. :brewind / :bfirst to first arg/buf | |
643 6. :last 16. :blast to last arg/buf | |
644 7. :all 17. :ball edit all args/buffers | |
645 18. :unhide edit all loaded buffers | |
646 19. :[N]bmod [N] to Nth modified buf | |
647 | |
648 split & args list split & buffer list meaning ~ | |
649 21. :[N]sargument [N] 31. :[N]sbuffer [N] split + to arg/buf N | |
650 22. :[N]snext [file ..] 32. :[N]sbnext [N] split + to Nth next arg/buf | |
651 23. :[N]sNext [N] 33. :[N]sbNext [N] split + to Nth previous arg/buf | |
652 24. :[N]sprevious [N] 34. :[N]sbprevious [N] split + to Nth previous arg/buf | |
653 25. :srewind / :sfirst 35. :sbrewind / :sbfirst split + to first arg/buf | |
654 26. :slast 36. :sblast split + to last arg/buf | |
237 | 655 27. :sall 37. :sball edit all args/buffers |
7 | 656 38. :sunhide edit all loaded buffers |
657 39. :[N]sbmod [N] split + to Nth modified buf | |
658 | |
659 40. :args list of arguments | |
660 41. :buffers list of buffers | |
661 | |
662 The meaning of [N] depends on the command: | |
12559 | 663 [N] is the number of buffers to go forward/backward on 2/12/22/32, |
664 3/13/23/33, and 4/14/24/34 | |
7 | 665 [N] is an argument number, defaulting to current argument, for 1 and 21 |
666 [N] is a buffer number, defaulting to current buffer, for 11 and 31 | |
667 [N] is a count for 19 and 39 | |
668 | |
669 Note: ":next" is an exception, because it must accept a list of file names | |
670 for compatibility with Vi. | |
671 | |
672 | |
673 The argument list and multiple windows | |
674 -------------------------------------- | |
675 | |
676 The current position in the argument list can be different for each window. | |
677 Remember that when doing ":e file", the position in the argument list stays | |
678 the same, but you are not editing the file at that position. To indicate | |
679 this, the file message (and the title, if you have one) shows | |
680 "(file (N) of M)", where "(N)" is the current position in the file list, and | |
681 "M" the number of files in the file list. | |
682 | |
683 All the entries in the argument list are added to the buffer list. Thus, you | |
684 can also get to them with the buffer list commands, like ":bnext". | |
685 | |
686 :[N]al[l][!] [N] *:al* *:all* *:sal* *:sall* | |
687 :[N]sal[l][!] [N] | |
688 Rearrange the screen to open one window for each argument. | |
689 All other windows are closed. When a count is given, this is | |
690 the maximum number of windows to open. | |
699 | 691 With the |:tab| modifier open a tab page for each argument. |
692 When there are more arguments than 'tabpagemax' further ones | |
693 become split windows in the last tab page. | |
7 | 694 When the 'hidden' option is set, all buffers in closed windows |
695 become hidden. | |
696 When 'hidden' is not set, and the 'autowrite' option is set, | |
697 modified buffers are written. Otherwise, windows that have | |
698 buffers that are modified are not removed, unless the [!] is | |
699 given, then they become hidden. But modified buffers are | |
700 never abandoned, so changes cannot get lost. | |
701 [N] is the maximum number of windows to open. 'winheight' | |
702 also limits the number of windows opened ('winwidth' if | |
703 |:vertical| was prepended). | |
704 Buf/Win Enter/Leave autocommands are not executed for the new | |
705 windows here, that's only done when they are really entered. | |
17571 | 706 If autocommands change the window layout while this command is |
707 busy an error will be given. *E249* | |
7 | 708 |
709 :[N]sa[rgument][!] [++opt] [+cmd] [N] *:sa* *:sargument* | |
710 Short for ":split | argument [N]": split window and go to Nth | |
711 argument. But when there is no such argument, the window is | |
712 not split. Also see |++opt| and |+cmd|. | |
713 | |
714 :[N]sn[ext][!] [++opt] [+cmd] [file ..] *:sn* *:snext* | |
715 Short for ":split | [N]next": split window and go to Nth next | |
716 argument. But when there is no next file, the window is not | |
717 split. Also see |++opt| and |+cmd|. | |
718 | |
719 :[N]spr[evious][!] [++opt] [+cmd] [N] *:spr* *:sprevious* | |
720 :[N]sN[ext][!] [++opt] [+cmd] [N] *:sN* *:sNext* | |
721 Short for ":split | [N]Next": split window and go to Nth | |
722 previous argument. But when there is no previous file, the | |
723 window is not split. Also see |++opt| and |+cmd|. | |
724 | |
725 *:sre* *:srewind* | |
726 :sre[wind][!] [++opt] [+cmd] | |
727 Short for ":split | rewind": split window and go to first | |
728 argument. But when there is no argument list, the window is | |
729 not split. Also see |++opt| and |+cmd|. | |
730 | |
731 *:sfir* *:sfirst* | |
168 | 732 :sfir[st] [++opt] [+cmd] |
7 | 733 Same as ":srewind". |
734 | |
735 *:sla* *:slast* | |
736 :sla[st][!] [++opt] [+cmd] | |
737 Short for ":split | last": split window and go to last | |
738 argument. But when there is no argument list, the window is | |
739 not split. Also see |++opt| and |+cmd|. | |
740 | |
741 *:dr* *:drop* | |
1702 | 742 :dr[op] [++opt] [+cmd] {file} .. |
7 | 743 Edit the first {file} in a window. |
744 - If the file is already open in a window change to that | |
745 window. | |
746 - If the file is not open in a window edit the file in the | |
747 current window. If the current buffer can't be |abandon|ed, | |
748 the window is split first. | |
10449
222b1432814e
commit https://github.com/vim/vim/commit/5162822914372fc916a93f85848c0c82209e7cec
Christian Brabandt <cb@256bit.org>
parents:
10301
diff
changeset
|
749 - Windows that are not in the argument list or are not full |
222b1432814e
commit https://github.com/vim/vim/commit/5162822914372fc916a93f85848c0c82209e7cec
Christian Brabandt <cb@256bit.org>
parents:
10301
diff
changeset
|
750 width will be closed if possible. |
7 | 751 The |argument-list| is set, like with the |:next| command. |
752 The purpose of this command is that it can be used from a | |
753 program that wants Vim to edit another file, e.g., a debugger. | |
819 | 754 When using the |:tab| modifier each argument is opened in a |
755 tab page. The last window is used if it's empty. | |
1702 | 756 Also see |++opt| and |+cmd|. |
7 | 757 |
758 ============================================================================== | |
759 8. Do a command in all buffers or windows *list-repeat* | |
760 | |
761 *:windo* | |
6474 | 762 :[range]windo {cmd} Execute {cmd} in each window or if [range] is given |
763 only in windows for which the window number lies in | |
764 the [range]. It works like doing this: > | |
7 | 765 CTRL-W t |
766 :{cmd} | |
767 CTRL-W w | |
768 :{cmd} | |
769 etc. | |
685 | 770 < This only operates in the current tab page. |
674 | 771 When an error is detected on one window, further |
7 | 772 windows will not be visited. |
773 The last window (or where an error occurred) becomes | |
774 the current window. | |
775 {cmd} can contain '|' to concatenate several commands. | |
776 {cmd} must not open or close windows or reorder them. | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16023
diff
changeset
|
777 |
7092
64e30831fa42
commit https://github.com/vim/vim/commit/aa23b379421aa214e6543b06c974594a25799b09
Christian Brabandt <cb@256bit.org>
parents:
6951
diff
changeset
|
778 Also see |:tabdo|, |:argdo|, |:bufdo|, |:cdo|, |:ldo|, |
64e30831fa42
commit https://github.com/vim/vim/commit/aa23b379421aa214e6543b06c974594a25799b09
Christian Brabandt <cb@256bit.org>
parents:
6951
diff
changeset
|
779 |:cfdo| and |:lfdo| |
7 | 780 |
781 *:bufdo* | |
6474 | 782 :[range]bufdo[!] {cmd} Execute {cmd} in each buffer in the buffer list or if |
783 [range] is given only for buffers for which their | |
7924
00d64eb49ce1
commit https://github.com/vim/vim/commit/681baaf4a4c81418693dcafb81421a8614832e91
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
784 buffer number is in the [range]. It works like doing |
6474 | 785 this: > |
7 | 786 :bfirst |
787 :{cmd} | |
788 :bnext | |
789 :{cmd} | |
790 etc. | |
791 < When the current file can't be |abandon|ed and the [!] | |
792 is not present, the command fails. | |
793 When an error is detected on one buffer, further | |
794 buffers will not be visited. | |
795 Unlisted buffers are skipped. | |
796 The last buffer (or where an error occurred) becomes | |
797 the current buffer. | |
798 {cmd} can contain '|' to concatenate several commands. | |
799 {cmd} must not delete buffers or add buffers to the | |
800 buffer list. | |
801 Note: While this command is executing, the Syntax | |
802 autocommand event is disabled by adding it to | |
803 'eventignore'. This considerably speeds up editing | |
804 each buffer. | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16023
diff
changeset
|
805 |
7092
64e30831fa42
commit https://github.com/vim/vim/commit/aa23b379421aa214e6543b06c974594a25799b09
Christian Brabandt <cb@256bit.org>
parents:
6951
diff
changeset
|
806 Also see |:tabdo|, |:argdo|, |:windo|, |:cdo|, |:ldo|, |
64e30831fa42
commit https://github.com/vim/vim/commit/aa23b379421aa214e6543b06c974594a25799b09
Christian Brabandt <cb@256bit.org>
parents:
6951
diff
changeset
|
807 |:cfdo| and |:lfdo| |
7 | 808 |
809 Examples: > | |
810 | |
24278 | 811 :windo set nolist foldcolumn=0 | normal! zn |
7 | 812 |
813 This resets the 'list' option and disables folding in all windows. > | |
814 | |
815 :bufdo set fileencoding= | update | |
816 | |
817 This resets the 'fileencoding' in each buffer and writes it if this changed | |
818 the buffer. The result is that all buffers will use the 'encoding' encoding | |
24278 | 819 (if conversion succeeds). |
7 | 820 |
821 ============================================================================== | |
822 9. Tag or file name under the cursor *window-tag* | |
823 | |
824 *:sta* *:stag* | |
825 :sta[g][!] [tagname] | |
826 Does ":tag[!] [tagname]" and splits the window for the found | |
827 tag. See also |:tag|. | |
828 | |
829 CTRL-W ] *CTRL-W_]* *CTRL-W_CTRL-]* | |
830 CTRL-W CTRL-] Split current window in two. Use identifier under cursor as a | |
6259 | 831 tag and jump to it in the new upper window. |
832 In Visual mode uses the Visually selected text as a tag. | |
833 Make new window N high. | |
7 | 834 |
835 *CTRL-W_g]* | |
836 CTRL-W g ] Split current window in two. Use identifier under cursor as a | |
837 tag and perform ":tselect" on it in the new upper window. | |
6259 | 838 In Visual mode uses the Visually selected text as a tag. |
7 | 839 Make new window N high. |
840 | |
841 *CTRL-W_g_CTRL-]* | |
842 CTRL-W g CTRL-] Split current window in two. Use identifier under cursor as a | |
6259 | 843 tag and perform ":tjump" on it in the new upper window. |
844 In Visual mode uses the Visually selected text as a tag. | |
845 Make new window N high. | |
7 | 846 |
847 CTRL-W f *CTRL-W_f* *CTRL-W_CTRL-F* | |
848 CTRL-W CTRL-F Split current window in two. Edit file name under cursor. | |
820 | 849 Like ":split gf", but window isn't split if the file does not |
7 | 850 exist. |
851 Uses the 'path' variable as a list of directory names where to | |
852 look for the file. Also the path for current file is | |
853 used to search for the file name. | |
854 If the name is a hypertext link that looks like | |
855 "type://machine/path", only "/path" is used. | |
856 If a count is given, the count'th matching file is edited. | |
857 | |
681 | 858 CTRL-W F *CTRL-W_F* |
859 Split current window in two. Edit file name under cursor and | |
860 jump to the line number following the file name. See |gF| for | |
861 details on how the line number is obtained. | |
862 | |
820 | 863 CTRL-W gf *CTRL-W_gf* |
864 Open a new tab page and edit the file name under the cursor. | |
865 Like "tab split" and "gf", but the new tab page isn't created | |
866 if the file does not exist. | |
867 | |
839 | 868 CTRL-W gF *CTRL-W_gF* |
869 Open a new tab page and edit the file name under the cursor | |
870 and jump to the line number following the file name. Like | |
871 "tab split" and "gF", but the new tab page isn't created if | |
872 the file does not exist. | |
873 | |
16023 | 874 CTRL-W gt *CTRL-W_gt* |
875 Go to next tab page, same as `gt`. | |
876 | |
877 CTRL-W gT *CTRL-W_gT* | |
878 Go to previous tab page, same as `gT`. | |
879 | |
7 | 880 Also see |CTRL-W_CTRL-I|: open window for an included file that includes |
881 the keyword under the cursor. | |
882 | |
883 ============================================================================== | |
884 10. The preview window *preview-window* | |
885 | |
886 The preview window is a special window to show (preview) another file. It is | |
887 normally a small window used to show an include file or definition of a | |
888 function. | |
889 {not available when compiled without the |+quickfix| feature} | |
890 | |
731 | 891 There can be only one preview window (per tab page). It is created with one |
892 of the commands below. The 'previewheight' option can be set to specify the | |
893 height of the preview window when it's opened. The 'previewwindow' option is | |
894 set in the preview window to be able to recognize it. The 'winfixheight' | |
895 option is set to have it keep the same height when opening/closing other | |
896 windows. | |
17431
ce35cdbe9f74
patch 8.1.1714: cannot preview a file in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
897 *preview-popup* |
ce35cdbe9f74
patch 8.1.1714: cannot preview a file in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
898 Alternatively, a popup window can be used by setting the 'previewpopup' |
ce35cdbe9f74
patch 8.1.1714: cannot preview a file in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
899 option. When set, it overrules the 'previewwindow' and 'previewheight' |
28379 | 900 settings. The option is a comma-separated list of values: |
17431
ce35cdbe9f74
patch 8.1.1714: cannot preview a file in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
901 height maximum height of the popup |
17433 | 902 width maximum width of the popup |
17909 | 903 highlight highlight group of the popup (default is Pmenu) |
17431
ce35cdbe9f74
patch 8.1.1714: cannot preview a file in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
904 Example: > |
ce35cdbe9f74
patch 8.1.1714: cannot preview a file in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
905 :set previewpopup=height:10,width:60 |
17632
5278e5a2a4e3
patch 8.1.1813: ATTENTION prompt for a preview popup window
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
906 |
5278e5a2a4e3
patch 8.1.1813: ATTENTION prompt for a preview popup window
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
907 A few peculiarities: |
5278e5a2a4e3
patch 8.1.1813: ATTENTION prompt for a preview popup window
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
908 - If the file is in a buffer already, it will be re-used. This will allow for |
5278e5a2a4e3
patch 8.1.1813: ATTENTION prompt for a preview popup window
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
909 editing the file while it's visible in the popup window. |
5278e5a2a4e3
patch 8.1.1813: ATTENTION prompt for a preview popup window
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
910 - No ATTENTION dialog will be used, since you can't edit the file in the popup |
5278e5a2a4e3
patch 8.1.1813: ATTENTION prompt for a preview popup window
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
911 window. However, if you later open the same buffer in a normal window, you |
5278e5a2a4e3
patch 8.1.1813: ATTENTION prompt for a preview popup window
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
912 may not notice it's edited elsewhere. And when then using ":edit" to |
5278e5a2a4e3
patch 8.1.1813: ATTENTION prompt for a preview popup window
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
913 trigger the ATTENTION and responding "A" for Abort, the preview window will |
5278e5a2a4e3
patch 8.1.1813: ATTENTION prompt for a preview popup window
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
914 become empty. |
5278e5a2a4e3
patch 8.1.1813: ATTENTION prompt for a preview popup window
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
915 |
7 | 916 *:pta* *:ptag* |
917 :pta[g][!] [tagname] | |
918 Does ":tag[!] [tagname]" and shows the found tag in a | |
919 "Preview" window without changing the current buffer or cursor | |
237 | 920 position. If a "Preview" window already exists, it is re-used |
7 | 921 (like a help window is). If a new one is opened, |
922 'previewheight' is used for the height of the window. See | |
923 also |:tag|. | |
924 See below for an example. |CursorHold-example| | |
925 Small difference from |:tag|: When [tagname] is equal to the | |
926 already displayed tag, the position in the matching tag list | |
927 is not reset. This makes the CursorHold example work after a | |
928 |:ptnext|. | |
929 | |
930 CTRL-W z *CTRL-W_z* | |
931 CTRL-W CTRL-Z *CTRL-W_CTRL-Z* *:pc* *:pclose* | |
932 :pc[lose][!] Close any "Preview" window currently open. When the 'hidden' | |
933 option is set, or when the buffer was changed and the [!] is | |
934 used, the buffer becomes hidden (unless there is another | |
935 window editing it). The command fails if any "Preview" buffer | |
936 cannot be closed. See also |:close|. | |
937 | |
938 *:pp* *:ppop* | |
939 :[count]pp[op][!] | |
940 Does ":[count]pop[!]" in the preview window. See |:pop| and | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16023
diff
changeset
|
941 |:ptag|. |
7 | 942 |
943 CTRL-W } *CTRL-W_}* | |
944 Use identifier under cursor as a tag and perform a :ptag on | |
237 | 945 it. Make the new Preview window (if required) N high. If N is |
7 | 946 not given, 'previewheight' is used. |
947 | |
948 CTRL-W g } *CTRL-W_g}* | |
949 Use identifier under cursor as a tag and perform a :ptjump on | |
237 | 950 it. Make the new Preview window (if required) N high. If N is |
7 | 951 not given, 'previewheight' is used. |
952 | |
953 *:ped* *:pedit* | |
954 :ped[it][!] [++opt] [+cmd] {file} | |
955 Edit {file} in the preview window. The preview window is | |
956 opened like with |:ptag|. The current window and cursor | |
957 position isn't changed. Useful example: > | |
958 :pedit +/fputc /usr/include/stdio.h | |
959 < | |
960 *:ps* *:psearch* | |
961 :[range]ps[earch][!] [count] [/]pattern[/] | |
962 Works like |:ijump| but shows the found match in the preview | |
963 window. The preview window is opened like with |:ptag|. The | |
964 current window and cursor position isn't changed. Useful | |
965 example: > | |
966 :psearch popen | |
967 < Like with the |:ptag| command, you can use this to | |
968 automatically show information about the word under the | |
969 cursor. This is less clever than using |:ptag|, but you don't | |
970 need a tags file and it will also find matches in system | |
971 include files. Example: > | |
27903 | 972 :au! CursorHold *.[ch] ++nested exe "silent! psearch " .. expand("<cword>") |
7 | 973 < Warning: This can be slow. |
974 | |
975 Example *CursorHold-example* > | |
976 | |
27903 | 977 :au! CursorHold *.[ch] ++nested exe "silent! ptag " .. expand("<cword>") |
7 | 978 |
979 This will cause a ":ptag" to be executed for the keyword under the cursor, | |
980 when the cursor hasn't moved for the time set with 'updatetime'. The "nested" | |
981 makes other autocommands be executed, so that syntax highlighting works in the | |
982 preview window. The "silent!" avoids an error message when the tag could not | |
983 be found. Also see |CursorHold|. To disable this again: > | |
984 | |
985 :au! CursorHold | |
986 | |
987 A nice addition is to highlight the found tag, avoid the ":ptag" when there | |
988 is no word under the cursor, and a few other things: > | |
989 | |
22171 | 990 :au! CursorHold *.[ch] ++nested call PreviewWord() |
7 | 991 :func PreviewWord() |
992 : if &previewwindow " don't do this in the preview window | |
993 : return | |
994 : endif | |
995 : let w = expand("<cword>") " get the word under cursor | |
996 : if w =~ '\a' " if the word contains a letter | |
997 : | |
998 : " Delete any existing highlight before showing another tag | |
999 : silent! wincmd P " jump to preview window | |
27903 | 1000 : if &previewwindow " if we really get there... |
7 | 1001 : match none " delete existing highlight |
1002 : wincmd p " back to old window | |
1003 : endif | |
1004 : | |
1005 : " Try displaying a matching tag for the word under the cursor | |
1006 : try | |
27903 | 1007 : exe "ptag " .. w |
7 | 1008 : catch |
1009 : return | |
1010 : endtry | |
1011 : | |
1012 : silent! wincmd P " jump to preview window | |
1013 : if &previewwindow " if we really get there... | |
1014 : if has("folding") | |
1015 : silent! .foldopen " don't want a closed fold | |
1016 : endif | |
1017 : call search("$", "b") " to end of previous line | |
1018 : let w = substitute(w, '\\', '\\\\', "") | |
27903 | 1019 : call search('\<\V' .. w .. '\>') " position cursor on match |
7 | 1020 : " Add a match highlight to the word at this position |
1021 : hi previewWord term=bold ctermbg=green guibg=green | |
27903 | 1022 : exe 'match previewWord "\%' .. line(".") .. 'l\%' .. col(".") .. 'c\k*"' |
7 | 1023 : wincmd p " back to old window |
1024 : endif | |
1025 : endif | |
1026 :endfun | |
1027 | |
1028 ============================================================================== | |
1029 11. Using hidden buffers *buffer-hidden* | |
1030 | |
1031 A hidden buffer is not displayed in a window, but is still loaded into memory. | |
1032 This makes it possible to jump from file to file, without the need to read or | |
1033 write the file every time you get another buffer in a window. | |
1034 | |
1035 *:buffer-!* | |
1036 If the option 'hidden' ('hid') is set, abandoned buffers are kept for all | |
1037 commands that start editing another file: ":edit", ":next", ":tag", etc. The | |
1038 commands that move through the buffer list sometimes make the current buffer | |
1039 hidden although the 'hidden' option is not set. This happens when a buffer is | |
1040 modified, but is forced (with '!') to be removed from a window, and | |
1041 'autowrite' is off or the buffer can't be written. | |
1042 | |
1043 You can make a hidden buffer not hidden by starting to edit it with any | |
28843
cd68a630f0d0
Update runtime files and translations
Bram Moolenaar <Bram@vim.org>
parents:
28379
diff
changeset
|
1044 command, or by deleting it with the ":bdelete" command. |
7 | 1045 |
1046 The 'hidden' is global, it is used for all buffers. The 'bufhidden' option | |
1047 can be used to make an exception for a specific buffer. It can take these | |
1048 values: | |
1049 <empty> Use the value of 'hidden'. | |
1050 hide Hide this buffer, also when 'hidden' is not set. | |
1051 unload Don't hide but unload this buffer, also when 'hidden' | |
1052 is set. | |
1053 delete Delete the buffer. | |
1054 | |
1055 *hidden-quit* | |
1056 When you try to quit Vim while there is a hidden, modified buffer, you will | |
1057 get an error message and Vim will make that buffer the current buffer. You | |
1058 can then decide to write this buffer (":wq") or quit without writing (":q!"). | |
1059 Be careful: there may be more hidden, modified buffers! | |
1060 | |
1061 A buffer can also be unlisted. This means it exists, but it is not in the | |
1062 list of buffers. |unlisted-buffer| | |
1063 | |
1064 | |
6945 | 1065 :files[!] [flags] *:files* |
1066 :buffers[!] [flags] *:buffers* *:ls* | |
1067 :ls[!] [flags] | |
1068 Show all buffers. Example: | |
7 | 1069 |
3920 | 1070 1 #h "/test/text" line 1 ~ |
1071 2u "asdf" line 0 ~ | |
1072 3 %a + "version.c" line 1 ~ | |
7 | 1073 |
1074 When the [!] is included the list will show unlisted buffers | |
1075 (the term "unlisted" is a bit confusing then...). | |
1076 | |
1077 Each buffer has a unique number. That number will not change, | |
6583 | 1078 thus you can always go to a specific buffer with ":buffer N" |
1079 or "N CTRL-^", where N is the buffer number. | |
7 | 1080 |
16859
0154363d3b98
patch 8.1.1431: popup window listed as "Scratch"
Bram Moolenaar <Bram@vim.org>
parents:
16808
diff
changeset
|
1081 For the file name these special values are used: |
0154363d3b98
patch 8.1.1431: popup window listed as "Scratch"
Bram Moolenaar <Bram@vim.org>
parents:
16808
diff
changeset
|
1082 [Prompt] |prompt-buffer| |
0154363d3b98
patch 8.1.1431: popup window listed as "Scratch"
Bram Moolenaar <Bram@vim.org>
parents:
16808
diff
changeset
|
1083 [Popup] buffer of a |popup-window| |
0154363d3b98
patch 8.1.1431: popup window listed as "Scratch"
Bram Moolenaar <Bram@vim.org>
parents:
16808
diff
changeset
|
1084 [Scratch] 'buftype' is "nofile" |
0154363d3b98
patch 8.1.1431: popup window listed as "Scratch"
Bram Moolenaar <Bram@vim.org>
parents:
16808
diff
changeset
|
1085 [No Name] no file name specified |
0154363d3b98
patch 8.1.1431: popup window listed as "Scratch"
Bram Moolenaar <Bram@vim.org>
parents:
16808
diff
changeset
|
1086 For a |terminal-window| buffer the status is used. |
0154363d3b98
patch 8.1.1431: popup window listed as "Scratch"
Bram Moolenaar <Bram@vim.org>
parents:
16808
diff
changeset
|
1087 |
7 | 1088 Indicators (chars in the same column are mutually exclusive): |
1089 u an unlisted buffer (only displayed when [!] is used) | |
1090 |unlisted-buffer| | |
1091 % the buffer in the current window | |
1092 # the alternate buffer for ":e #" and CTRL-^ | |
1093 a an active buffer: it is loaded and visible | |
1094 h a hidden buffer: It is loaded, but currently not | |
1095 displayed in a window |hidden-buffer| | |
1096 - a buffer with 'modifiable' off | |
1097 = a readonly buffer | |
12254 | 1098 R a terminal buffer with a running job |
1099 F a terminal buffer with a finished job | |
12499 | 1100 ? a terminal buffer without a job: `:terminal NONE` |
7 | 1101 + a modified buffer |
1102 x a buffer with read errors | |
1103 | |
6945 | 1104 [flags] can be a combination of the following characters, |
1105 which restrict the buffers to be listed: | |
1106 + modified buffers | |
1107 - buffers with 'modifiable' off | |
1108 = readonly buffers | |
1109 a active buffers | |
7245
8896150aba23
commit https://github.com/vim/vim/commit/e392eb41f8dfc01bd13634e534ac6b4d505326f4
Christian Brabandt <cb@256bit.org>
parents:
7100
diff
changeset
|
1110 u unlisted buffers (overrides the "!") |
6945 | 1111 h hidden buffers |
1112 x buffers with a read error | |
1113 % current buffer | |
1114 # alternate buffer | |
13555
78ead137b2ad
patch 8.0.1651: cannot filter :ls output for terminal buffers
Christian Brabandt <cb@256bit.org>
parents:
13268
diff
changeset
|
1115 R terminal buffers with a running job |
78ead137b2ad
patch 8.0.1651: cannot filter :ls output for terminal buffers
Christian Brabandt <cb@256bit.org>
parents:
13268
diff
changeset
|
1116 F terminal buffers with a finished job |
78ead137b2ad
patch 8.0.1651: cannot filter :ls output for terminal buffers
Christian Brabandt <cb@256bit.org>
parents:
13268
diff
changeset
|
1117 ? terminal buffers without a job: `:terminal NONE` |
18463
18d7337b6837
patch 8.1.2225: the "last used" info of a buffer is under used
Bram Moolenaar <Bram@vim.org>
parents:
18456
diff
changeset
|
1118 t show time last used and sort buffers |
6945 | 1119 Combining flags means they are "and"ed together, e.g.: |
1120 h+ hidden buffers which are modified | |
1121 a+ active buffers which are modified | |
1122 | |
9975
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9908
diff
changeset
|
1123 When using |:filter| the pattern is matched against the |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9908
diff
changeset
|
1124 displayed buffer name, e.g.: > |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9908
diff
changeset
|
1125 filter /\.vim/ ls |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9908
diff
changeset
|
1126 < |
7 | 1127 *:bad* *:badd* |
1128 :bad[d] [+lnum] {fname} | |
21825 | 1129 Add file name {fname} to the buffer list, without loading it, |
1130 if it wasn't listed yet. If the buffer was previously | |
1131 deleted, not wiped, it will be made listed again. | |
7 | 1132 If "lnum" is specified, the cursor will be positioned at that |
237 | 1133 line when the buffer is first entered. Note that other |
7 | 1134 commands after the + will be ignored. |
1135 | |
22840
7c1e2e3f2d8d
patch 8.2.1967: the session file does not restore the alternate file
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
1136 *:balt* |
7c1e2e3f2d8d
patch 8.2.1967: the session file does not restore the alternate file
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
1137 :balt [+lnum] {fname} |
7c1e2e3f2d8d
patch 8.2.1967: the session file does not restore the alternate file
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
1138 Like `:badd` and also set the alternate file for the current |
7c1e2e3f2d8d
patch 8.2.1967: the session file does not restore the alternate file
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
1139 window to {fname}. |
7c1e2e3f2d8d
patch 8.2.1967: the session file does not restore the alternate file
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
1140 |
7 | 1141 :[N]bd[elete][!] *:bd* *:bdel* *:bdelete* *E516* |
1142 :bd[elete][!] [N] | |
1143 Unload buffer [N] (default: current buffer) and delete it from | |
1144 the buffer list. If the buffer was changed, this fails, | |
1145 unless when [!] is specified, in which case changes are lost. | |
1146 The file remains unaffected. Any windows for this buffer are | |
1147 closed. If buffer [N] is the current buffer, another buffer | |
1148 will be displayed instead. This is the most recent entry in | |
1149 the jump list that points into a loaded buffer. | |
1150 Actually, the buffer isn't completely deleted, it is removed | |
1151 from the buffer list |unlisted-buffer| and option values, | |
1152 variables and mappings/abbreviations for the buffer are | |
6417 | 1153 cleared. Examples: > |
1154 :.,$-bdelete " delete buffers from the current one to | |
1155 " last but one | |
1156 :%bdelete " delete all buffers | |
1157 < | |
7 | 1158 |
1159 :bdelete[!] {bufname} *E93* *E94* | |
13818
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13555
diff
changeset
|
1160 Like ":bdelete[!] [N]", but buffer given by name, see |
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13555
diff
changeset
|
1161 |{bufname}|. |
7 | 1162 |
1163 :bdelete[!] N1 N2 ... | |
1164 Do ":bdelete[!]" for buffer N1, N2, etc. The arguments can be | |
1165 buffer numbers or buffer names (but not buffer names that are | |
1166 a number). Insert a backslash before a space in a buffer | |
1167 name. | |
1168 | |
1169 :N,Mbdelete[!] Do ":bdelete[!]" for all buffers in the range N to M | |
1170 |inclusive|. | |
1171 | |
1172 :[N]bw[ipeout][!] *:bw* *:bwipe* *:bwipeout* *E517* | |
1173 :bw[ipeout][!] {bufname} | |
1174 :N,Mbw[ipeout][!] | |
1175 :bw[ipeout][!] N1 N2 ... | |
683 | 1176 Like |:bdelete|, but really delete the buffer. Everything |
1177 related to the buffer is lost. All marks in this buffer | |
1178 become invalid, option settings are lost, etc. Don't use this | |
6417 | 1179 unless you know what you are doing. Examples: > |
1180 :.+,$bwipeout " wipe out all buffers after the current | |
1181 " one | |
1182 :%bwipeout " wipe out all buffers | |
1183 < | |
7 | 1184 |
1185 :[N]bun[load][!] *:bun* *:bunload* *E515* | |
1186 :bun[load][!] [N] | |
1187 Unload buffer [N] (default: current buffer). The memory | |
1188 allocated for this buffer will be freed. The buffer remains | |
1189 in the buffer list. | |
1190 If the buffer was changed, this fails, unless when [!] is | |
1191 specified, in which case the changes are lost. | |
1192 Any windows for this buffer are closed. If buffer [N] is the | |
1193 current buffer, another buffer will be displayed instead. | |
1194 This is the most recent entry in the jump list that points | |
1195 into a loaded buffer. | |
1196 | |
1197 :bunload[!] {bufname} | |
13818
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13555
diff
changeset
|
1198 Like ":bunload[!] [N]", but buffer given by name. |
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13555
diff
changeset
|
1199 Also see |{bufname}|. |
7 | 1200 |
1201 :N,Mbunload[!] Do ":bunload[!]" for all buffers in the range N to M | |
1202 |inclusive|. | |
1203 | |
1204 :bunload[!] N1 N2 ... | |
1205 Do ":bunload[!]" for buffer N1, N2, etc. The arguments can be | |
1206 buffer numbers or buffer names (but not buffer names that are | |
1207 a number). Insert a backslash before a space in a buffer | |
1208 name. | |
1209 | |
6230 | 1210 :[N]b[uffer][!] [+cmd] [N] *:b* *:bu* *:buf* *:buffer* *E86* |
7 | 1211 Edit buffer [N] from the buffer list. If [N] is not given, |
1212 the current buffer remains being edited. See |:buffer-!| for | |
1213 [!]. This will also edit a buffer that is not in the buffer | |
1214 list, without setting the 'buflisted' flag. | |
26438 | 1215 The notation with single quotes does not work here, |
1216 `:buf 12'345'` uses 12'345 as a buffer name. | |
7100
f717d96a39b3
commit https://github.com/vim/vim/commit/12969c04fe7bd27dc0cbf37709eb40a86d4a27f9
Christian Brabandt <cb@256bit.org>
parents:
7092
diff
changeset
|
1217 Also see |+cmd|. |
7 | 1218 |
13818
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13555
diff
changeset
|
1219 :[N]b[uffer][!] [+cmd] {bufname} *{bufname}* |
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13555
diff
changeset
|
1220 Edit buffer for {bufname} from the buffer list. A partial |
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13555
diff
changeset
|
1221 name also works, so long as it is unique in the list of |
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13555
diff
changeset
|
1222 buffers. |
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13555
diff
changeset
|
1223 Note that a buffer whose name is a number cannot be referenced |
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13555
diff
changeset
|
1224 by that name; use the buffer number instead. |
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13555
diff
changeset
|
1225 Insert a backslash before a space in a buffer name. |
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13555
diff
changeset
|
1226 See |:buffer-!| for [!]. |
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13555
diff
changeset
|
1227 This will also edit a buffer that is not in the buffer list, |
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13555
diff
changeset
|
1228 without setting the 'buflisted' flag. |
7100
f717d96a39b3
commit https://github.com/vim/vim/commit/12969c04fe7bd27dc0cbf37709eb40a86d4a27f9
Christian Brabandt <cb@256bit.org>
parents:
7092
diff
changeset
|
1229 Also see |+cmd|. |
7 | 1230 |
6230 | 1231 :[N]sb[uffer] [+cmd] [N] *:sb* *:sbuffer* |
7 | 1232 Split window and edit buffer [N] from the buffer list. If [N] |
1233 is not given, the current buffer is edited. Respects the | |
1234 "useopen" setting of 'switchbuf' when splitting. This will | |
1235 also edit a buffer that is not in the buffer list, without | |
1236 setting the 'buflisted' flag. | |
7100
f717d96a39b3
commit https://github.com/vim/vim/commit/12969c04fe7bd27dc0cbf37709eb40a86d4a27f9
Christian Brabandt <cb@256bit.org>
parents:
7092
diff
changeset
|
1237 Also see |+cmd|. |
7 | 1238 |
6230 | 1239 :[N]sb[uffer] [+cmd] {bufname} |
13818
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13555
diff
changeset
|
1240 Split window and edit buffer for |{bufname}| from the buffer |
7 | 1241 list. This will also edit a buffer that is not in the buffer |
1242 list, without setting the 'buflisted' flag. | |
648 | 1243 Note: If what you want to do is split the buffer, make a copy |
1244 under another name, you can do it this way: > | |
1245 :w foobar | sp # | |
7100
f717d96a39b3
commit https://github.com/vim/vim/commit/12969c04fe7bd27dc0cbf37709eb40a86d4a27f9
Christian Brabandt <cb@256bit.org>
parents:
7092
diff
changeset
|
1246 < Also see |+cmd|. |
7 | 1247 |
6230 | 1248 :[N]bn[ext][!] [+cmd] [N] *:bn* *:bnext* *E87* |
7 | 1249 Go to [N]th next buffer in buffer list. [N] defaults to one. |
1250 Wraps around the end of the buffer list. | |
1251 See |:buffer-!| for [!]. | |
7100
f717d96a39b3
commit https://github.com/vim/vim/commit/12969c04fe7bd27dc0cbf37709eb40a86d4a27f9
Christian Brabandt <cb@256bit.org>
parents:
7092
diff
changeset
|
1252 Also see |+cmd|. |
7 | 1253 If you are in a help buffer, this takes you to the next help |
1254 buffer (if there is one). Similarly, if you are in a normal | |
1255 (non-help) buffer, this takes you to the next normal buffer. | |
1256 This is so that if you have invoked help, it doesn't get in | |
237 | 1257 the way when you're browsing code/text buffers. The next three |
7 | 1258 commands also work like this. |
1259 | |
1260 *:sbn* *:sbnext* | |
6230 | 1261 :[N]sbn[ext] [+cmd] [N] |
7 | 1262 Split window and go to [N]th next buffer in buffer list. |
1263 Wraps around the end of the buffer list. Uses 'switchbuf' | |
7100
f717d96a39b3
commit https://github.com/vim/vim/commit/12969c04fe7bd27dc0cbf37709eb40a86d4a27f9
Christian Brabandt <cb@256bit.org>
parents:
7092
diff
changeset
|
1264 Also see |+cmd|. |
7 | 1265 |
6230 | 1266 :[N]bN[ext][!] [+cmd] [N] *:bN* *:bNext* *:bp* *:bprevious* *E88* |
1267 :[N]bp[revious][!] [+cmd] [N] | |
7 | 1268 Go to [N]th previous buffer in buffer list. [N] defaults to |
1269 one. Wraps around the start of the buffer list. | |
1270 See |:buffer-!| for [!] and 'switchbuf'. | |
7100
f717d96a39b3
commit https://github.com/vim/vim/commit/12969c04fe7bd27dc0cbf37709eb40a86d4a27f9
Christian Brabandt <cb@256bit.org>
parents:
7092
diff
changeset
|
1271 Also see |+cmd|. |
7 | 1272 |
6230 | 1273 :[N]sbN[ext] [+cmd] [N] *:sbN* *:sbNext* *:sbp* *:sbprevious* |
1274 :[N]sbp[revious] [+cmd] [N] | |
7 | 1275 Split window and go to [N]th previous buffer in buffer list. |
1276 Wraps around the start of the buffer list. | |
1277 Uses 'switchbuf'. | |
7100
f717d96a39b3
commit https://github.com/vim/vim/commit/12969c04fe7bd27dc0cbf37709eb40a86d4a27f9
Christian Brabandt <cb@256bit.org>
parents:
7092
diff
changeset
|
1278 Also see |+cmd|. |
7 | 1279 |
16944 | 1280 :br[ewind][!] [+cmd] *:br* *:bre* *:brewind* |
6230 | 1281 Go to first buffer in buffer list. If the buffer list is |
7 | 1282 empty, go to the first unlisted buffer. |
1283 See |:buffer-!| for [!]. | |
1284 | |
6230 | 1285 :bf[irst] [+cmd] *:bf* *:bfirst* |
1286 Same as |:brewind|. | |
1287 Also see |+cmd|. | |
7 | 1288 |
6230 | 1289 :sbr[ewind] [+cmd] *:sbr* *:sbrewind* |
1290 Split window and go to first buffer in buffer list. If the | |
7 | 1291 buffer list is empty, go to the first unlisted buffer. |
1292 Respects the 'switchbuf' option. | |
6230 | 1293 Also see |+cmd|. |
7 | 1294 |
6230 | 1295 :sbf[irst] [+cmd] *:sbf* *:sbfirst* |
1296 Same as ":sbrewind". | |
7 | 1297 |
6230 | 1298 :bl[ast][!] [+cmd] *:bl* *:blast* |
1299 Go to last buffer in buffer list. If the buffer list is | |
7 | 1300 empty, go to the last unlisted buffer. |
1301 See |:buffer-!| for [!]. | |
1302 | |
6230 | 1303 :sbl[ast] [+cmd] *:sbl* *:sblast* |
1304 Split window and go to last buffer in buffer list. If the | |
7 | 1305 buffer list is empty, go to the last unlisted buffer. |
1306 Respects 'switchbuf' option. | |
1307 | |
6230 | 1308 :[N]bm[odified][!] [+cmd] [N] *:bm* *:bmodified* *E84* |
7 | 1309 Go to [N]th next modified buffer. Note: this command also |
1310 finds unlisted buffers. If there is no modified buffer the | |
1311 command fails. | |
1312 | |
6230 | 1313 :[N]sbm[odified] [+cmd] [N] *:sbm* *:sbmodified* |
7 | 1314 Split window and go to [N]th next modified buffer. |
1315 Respects 'switchbuf' option. | |
1316 Note: this command also finds buffers not in the buffer list. | |
1317 | |
1318 :[N]unh[ide] [N] *:unh* *:unhide* *:sun* *:sunhide* | |
1319 :[N]sun[hide] [N] | |
1320 Rearrange the screen to open one window for each loaded buffer | |
1321 in the buffer list. When a count is given, this is the | |
1322 maximum number of windows to open. | |
1323 | |
1324 :[N]ba[ll] [N] *:ba* *:ball* *:sba* *:sball* | |
1325 :[N]sba[ll] [N] Rearrange the screen to open one window for each buffer in | |
1326 the buffer list. When a count is given, this is the maximum | |
1327 number of windows to open. 'winheight' also limits the number | |
1328 of windows opened ('winwidth' if |:vertical| was prepended). | |
1329 Buf/Win Enter/Leave autocommands are not executed for the new | |
1330 windows here, that's only done when they are really entered. | |
1123 | 1331 When the |:tab| modifier is used new windows are opened in a |
699 | 1332 new tab, up to 'tabpagemax'. |
7 | 1333 |
1334 Note: All the commands above that start editing another buffer, keep the | |
1335 'readonly' flag as it was. This differs from the ":edit" command, which sets | |
1336 the 'readonly' flag each time the file is read. | |
1337 | |
1338 ============================================================================== | |
1339 12. Special kinds of buffers *special-buffers* | |
1340 | |
1341 Instead of containing the text of a file, buffers can also be used for other | |
1342 purposes. A few options can be set to change the behavior of a buffer: | |
1343 'bufhidden' what happens when the buffer is no longer displayed | |
1344 in a window. | |
1345 'buftype' what kind of a buffer this is | |
1346 'swapfile' whether the buffer will have a swap file | |
1347 'buflisted' buffer shows up in the buffer list | |
1348 | |
1349 A few useful kinds of a buffer: | |
1350 | |
648 | 1351 quickfix Used to contain the error list or the location list. See |
1352 |:cwindow| and |:lwindow|. This command sets the 'buftype' | |
1353 option to "quickfix". You are not supposed to change this! | |
1354 'swapfile' is off. | |
7 | 1355 |
1356 help Contains a help file. Will only be created with the |:help| | |
1357 command. The flag that indicates a help buffer is internal | |
1358 and can't be changed. The 'buflisted' option will be reset | |
1359 for a help buffer. | |
1360 | |
11763
21f3930dfe6e
Documentation updates.
Christian Brabandt <cb@256bit.org>
parents:
10449
diff
changeset
|
1361 terminal A terminal window buffer, see |terminal|. The contents cannot |
21f3930dfe6e
Documentation updates.
Christian Brabandt <cb@256bit.org>
parents:
10449
diff
changeset
|
1362 be read or changed until the job ends. |
21f3930dfe6e
Documentation updates.
Christian Brabandt <cb@256bit.org>
parents:
10449
diff
changeset
|
1363 |
140 | 1364 directory Displays directory contents. Can be used by a file explorer |
7 | 1365 plugin. The buffer is created with these settings: > |
632 | 1366 :setlocal buftype=nowrite |
1367 :setlocal bufhidden=delete | |
1368 :setlocal noswapfile | |
7 | 1369 < The buffer name is the name of the directory and is adjusted |
1370 when using the |:cd| command. | |
1371 | |
26089
c544eacaf066
patch 8.2.3578: manipulating highlighting is complicated
Bram Moolenaar <Bram@vim.org>
parents:
25773
diff
changeset
|
1372 *scratch-buffer* |
7 | 1373 scratch Contains text that can be discarded at any time. It is kept |
1374 when closing the window, it must be deleted explicitly. | |
1375 Settings: > | |
632 | 1376 :setlocal buftype=nofile |
1377 :setlocal bufhidden=hide | |
1378 :setlocal noswapfile | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1379 < The buffer name can be used to identify the buffer, if you |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1380 give it a meaningful name. |
7 | 1381 |
1382 *unlisted-buffer* | |
1383 unlisted The buffer is not in the buffer list. It is not used for | |
1384 normal editing, but to show a help file, remember a file name | |
1385 or marks. The ":bdelete" command will also set this option, | |
1386 thus it doesn't completely delete the buffer. Settings: > | |
632 | 1387 :setlocal nobuflisted |
7 | 1388 < |
1389 | |
14519 | 1390 vim:tw=78:ts=8:noet:ft=help:norl: |