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