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