Mercurial > vim
annotate runtime/doc/editing.txt @ 29579:f7a64755dbe9 v9.0.0130
patch 9.0.0130: cursor position wrong when inserting around virtual text
Commit: https://github.com/vim/vim/commit/1f4ee19eefecd8f70b7cbe8ee9db8ace6352e23e
Author: Bram Moolenaar <Bram@vim.org>
Date: Mon Aug 1 15:52:55 2022 +0100
patch 9.0.0130: cursor position wrong when inserting around virtual text
Problem: Cursor position wrong when inserting around virtual text.
Solution: Update the cursor position properly.
author | Bram Moolenaar <Bram@vim.org> |
---|---|
date | Mon, 01 Aug 2022 17:00:04 +0200 |
parents | f8116058ca76 |
children | 31c598083364 |
rev | line source |
---|---|
29314 | 1 *editing.txt* For Vim version 9.0. Last change: 2022 Apr 16 |
7 | 2 |
3 | |
4 VIM REFERENCE MANUAL by Bram Moolenaar | |
5 | |
6 | |
7 Editing files *edit-files* | |
8 | |
9 1. Introduction |edit-intro| | |
10 2. Editing a file |edit-a-file| | |
39 | 11 3. The argument list |argument-list| |
12 4. Writing |writing| | |
13 5. Writing and quitting |write-quit| | |
14 6. Dialogs |edit-dialogs| | |
15 7. The current directory |current-directory| | |
7 | 16 8. Editing binary files |edit-binary| |
17 9. Encryption |encryption| | |
18 10. Timestamps |timestamps| | |
39 | 19 11. File Searching |file-searching| |
7 | 20 |
21 ============================================================================== | |
22 1. Introduction *edit-intro* | |
23 | |
24 Editing a file with Vim means: | |
25 | |
39 | 26 1. reading the file into a buffer |
7 | 27 2. changing the buffer with editor commands |
28 3. writing the buffer into a file | |
29 | |
30 *current-file* | |
31 As long as you don't write the buffer, the original file remains unchanged. | |
32 If you start editing a file (read a file into the buffer), the file name is | |
22 | 33 remembered as the "current file name". This is also known as the name of the |
39 | 34 current buffer. It can be used with "%" on the command line |:_%|. |
7 | 35 |
36 *alternate-file* | |
37 If there already was a current file name, then that one becomes the alternate | |
39 | 38 file name. It can be used with "#" on the command line |:_#| and you can use |
39 the |CTRL-^| command to toggle between the current and the alternate file. | |
40 However, the alternate file name is not changed when |:keepalt| is used. | |
5510 | 41 An alternate file name is remembered for each window. |
22 | 42 |
43 *:keepalt* *:keepa* | |
44 :keepalt {cmd} Execute {cmd} while keeping the current alternate file | |
45 name. Note that commands invoked indirectly (e.g., | |
46 with a function) may still set the alternate file | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16427
diff
changeset
|
47 name. |
22 | 48 |
39 | 49 All file names are remembered in the buffer list. When you enter a file name, |
236 | 50 for editing (e.g., with ":e filename") or writing (e.g., with ":w filename"), |
39 | 51 the file name is added to the list. You can use the buffer list to remember |
52 which files you edited and to quickly switch from one file to another (e.g., | |
53 to copy text) with the |CTRL-^| command. First type the number of the file | |
16610 | 54 and then hit CTRL-^. |
39 | 55 |
7 | 56 |
57 CTRL-G or *CTRL-G* *:f* *:fi* *:file* | |
268 | 58 :f[ile] Prints the current file name (as typed, unless ":cd" |
59 was used), the cursor position (unless the 'ruler' | |
60 option is set), and the file status (readonly, | |
61 modified, read errors, new file). See the 'shortmess' | |
62 option about how to make this message shorter. | |
7 | 63 |
14 | 64 :f[ile]! like |:file|, but don't truncate the name even when |
65 'shortmess' indicates this. | |
66 | |
7 | 67 {count}CTRL-G Like CTRL-G, but prints the current file name with |
68 full path. If the count is higher than 1 the current | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16427
diff
changeset
|
69 buffer number is also given. |
7 | 70 |
71 *g_CTRL-G* *word-count* *byte-count* | |
161 | 72 g CTRL-G Prints the current position of the cursor in five |
73 ways: Column, Line, Word, Character and Byte. If the | |
74 number of Characters and Bytes is the same then the | |
75 Character position is omitted. | |
22723 | 76 |
161 | 77 If there are characters in the line that take more |
78 than one position on the screen (<Tab> or special | |
22723 | 79 character), or characters using more than one byte per |
80 column (characters above 0x7F when 'encoding' is | |
81 utf-8), both the byte column and the screen column are | |
82 shown, separated by a dash. | |
83 | |
7480
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
84 Also see the 'ruler' option and the |wordcount()| |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
85 function. |
7 | 86 |
87 *v_g_CTRL-G* | |
161 | 88 {Visual}g CTRL-G Similar to "g CTRL-G", but Word, Character, Line, and |
89 Byte counts for the visually selected region are | |
90 displayed. | |
91 In Blockwise mode, Column count is also shown. (For | |
7 | 92 {Visual} see |Visual-mode|.) |
93 | |
94 *:file_f* | |
14 | 95 :f[ile][!] {name} Sets the current file name to {name}. The optional ! |
96 avoids truncating the message, as with |:file|. | |
28 | 97 If the buffer did have a name, that name becomes the |
98 |alternate-file| name. An unlisted buffer is created | |
99 to hold the old name. | |
139 | 100 *:0file* |
14 | 101 :0f[ile][!] Remove the name of the current buffer. The optional ! |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16427
diff
changeset
|
102 avoids truncating the message, as with |:file|. |
7 | 103 |
104 :buffers | |
105 :files | |
106 :ls List all the currently known file names. See | |
18016 | 107 |windows.txt| |:files| |:buffers| |:ls|. |
7 | 108 |
109 Vim will remember the full path name of a file name that you enter. In most | |
110 cases when the file name is displayed only the name you typed is shown, but | |
111 the full path name is being used if you used the ":cd" command |:cd|. | |
112 | |
113 *home-replace* | |
114 If the environment variable $HOME is set, and the file name starts with that | |
115 string, it is often displayed with HOME replaced with "~". This was done to | |
116 keep file names short. When reading or writing files the full name is still | |
117 used, the "~" is only used when displaying file names. When replacing the | |
118 file name would result in just "~", "~/" is used instead (to avoid confusion | |
42 | 119 between options set to $HOME with 'backupext' set to "~"). |
7 | 120 |
121 When writing the buffer, the default is to use the current file name. Thus | |
122 when you give the "ZZ" or ":wq" command, the original file will be | |
123 overwritten. If you do not want this, the buffer can be written into another | |
124 file by giving a file name argument to the ":write" command. For example: > | |
125 | |
126 vim testfile | |
127 [change the buffer with editor commands] | |
128 :w newfile | |
129 :q | |
130 | |
131 This will create a file "newfile", that is a modified copy of "testfile". | |
132 The file "testfile" will remain unchanged. Anyway, if the 'backup' option is | |
133 set, Vim renames or copies the original file before it will be overwritten. | |
134 You can use this file if you discover that you need the original file. See | |
135 also the 'patchmode' option. The name of the backup file is normally the same | |
136 as the original file with 'backupext' appended. The default "~" is a bit | |
137 strange to avoid accidentally overwriting existing files. If you prefer ".bak" | |
18972 | 138 change the 'backupext' option. Extra dots are replaced with '_' on MS-Windows |
7 | 139 machines, when Vim has detected that an MS-DOS-like filesystem is being used |
140 (e.g., messydos or crossdos) or when the 'shortname' option is on. The | |
141 backup file can be placed in another directory by setting 'backupdir'. | |
142 | |
143 *auto-shortname* | |
144 Technical: On the Amiga you can use 30 characters for a file name. But on an | |
145 MS-DOS-compatible filesystem only 8 plus 3 characters are | |
146 available. Vim tries to detect the type of filesystem when it is | |
147 creating the .swp file. If an MS-DOS-like filesystem is suspected, | |
148 a flag is set that has the same effect as setting the 'shortname' | |
149 option. This flag will be reset as soon as you start editing a | |
150 new file. The flag will be used when making the file name for the | |
151 ".swp" and ".~" files for the current file. But when you are | |
152 editing a file in a normal filesystem and write to an MS-DOS-like | |
153 filesystem the flag will not have been set. In that case the | |
154 creation of the ".~" file may fail and you will get an error | |
155 message. Use the 'shortname' option in this case. | |
156 | |
157 When you started editing without giving a file name, "No File" is displayed in | |
158 messages. If the ":write" command is used with a file name argument, the file | |
159 name for the current file is set to that file name. This only happens when | |
633 | 160 the 'F' flag is included in 'cpoptions' (by default it is included) |cpo-F|. |
161 This is useful when entering text in an empty buffer and then writing it to a | |
162 file. If 'cpoptions' contains the 'f' flag (by default it is NOT included) | |
163 |cpo-f| the file name is set for the ":read file" command. This is useful | |
164 when starting Vim without an argument and then doing ":read file" to start | |
165 editing a file. | |
166 When the file name was set and 'filetype' is empty the filetype detection | |
167 autocommands will be triggered. | |
7 | 168 *not-edited* |
169 Because the file name was set without really starting to edit that file, you | |
170 are protected from overwriting that file. This is done by setting the | |
171 "notedited" flag. You can see if this flag is set with the CTRL-G or ":file" | |
172 command. It will include "[Not edited]" when the "notedited" flag is set. | |
173 When writing the buffer to the current file name (with ":w!"), the "notedited" | |
174 flag is reset. | |
175 | |
176 *abandon* | |
177 Vim remembers whether you have changed the buffer. You are protected from | |
178 losing the changes you made. If you try to quit without writing, or want to | |
179 start editing another file, Vim will refuse this. In order to overrule this | |
180 protection, add a '!' to the command. The changes will then be lost. For | |
181 example: ":q" will not work if the buffer was changed, but ":q!" will. To see | |
182 whether the buffer was changed use the "CTRL-G" command. The message includes | |
10244
876fbdd84e52
commit https://github.com/vim/vim/commit/2ec618c9feac4573b154510236ad8121c77d0eca
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
183 the string "[Modified]" if the buffer has been changed, or "+" if the 'm' flag |
876fbdd84e52
commit https://github.com/vim/vim/commit/2ec618c9feac4573b154510236ad8121c77d0eca
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
184 is in 'shortmess'. |
7 | 185 |
186 If you want to automatically save the changes without asking, switch on the | |
187 'autowriteall' option. 'autowrite' is the associated Vi-compatible option | |
188 that does not work for all commands. | |
189 | |
190 If you want to keep the changed buffer without saving it, switch on the | |
5277 | 191 'hidden' option. See |hidden-buffer|. Some commands work like this even when |
192 'hidden' is not set, check the help for the command. | |
7 | 193 |
194 ============================================================================== | |
195 2. Editing a file *edit-a-file* | |
196 | |
5277 | 197 *:e* *:edit* *reload* |
7 | 198 :e[dit] [++opt] [+cmd] Edit the current file. This is useful to re-edit the |
199 current file, when it has been changed outside of Vim. | |
200 This fails when changes have been made to the current | |
201 buffer and 'autowriteall' isn't set or the file can't | |
202 be written. | |
203 Also see |++opt| and |+cmd|. | |
204 | |
5277 | 205 *:edit!* *discard* |
7 | 206 :e[dit]! [++opt] [+cmd] |
207 Edit the current file always. Discard any changes to | |
208 the current buffer. This is useful if you want to | |
209 start all over again. | |
210 Also see |++opt| and |+cmd|. | |
211 | |
212 *:edit_f* | |
213 :e[dit] [++opt] [+cmd] {file} | |
214 Edit {file}. | |
215 This fails when changes have been made to the current | |
216 buffer, unless 'hidden' is set or 'autowriteall' is | |
217 set and the file can be written. | |
218 Also see |++opt| and |+cmd|. | |
219 | |
220 *:edit!_f* | |
221 :e[dit]! [++opt] [+cmd] {file} | |
222 Edit {file} always. Discard any changes to the | |
223 current buffer. | |
224 Also see |++opt| and |+cmd|. | |
27804 | 225 *:edit_#* *:e#* |
7 | 226 :e[dit] [++opt] [+cmd] #[count] |
39 | 227 Edit the [count]th buffer (as shown by |:files|). |
228 This command does the same as [count] CTRL-^. But ":e | |
229 #" doesn't work if the alternate buffer doesn't have a | |
230 file name, while CTRL-^ still works then. | |
7 | 231 Also see |++opt| and |+cmd|. |
232 | |
233 *:ene* *:enew* | |
234 :ene[w] Edit a new, unnamed buffer. This fails when changes | |
235 have been made to the current buffer, unless 'hidden' | |
236 is set or 'autowriteall' is set and the file can be | |
237 written. | |
238 If 'fileformats' is not empty, the first format given | |
239 will be used for the new buffer. If 'fileformats' is | |
240 empty, the 'fileformat' of the current buffer is used. | |
241 | |
242 *:ene!* *:enew!* | |
243 :ene[w]! Edit a new, unnamed buffer. Discard any changes to | |
244 the current buffer. | |
245 Set 'fileformat' like |:enew|. | |
246 | |
247 *:fin* *:find* | |
248 :fin[d][!] [++opt] [+cmd] {file} | |
249 Find {file} in 'path' and then |:edit| it. | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16427
diff
changeset
|
250 {not available when the |+file_in_path| feature was |
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16427
diff
changeset
|
251 disabled at compile time} |
7 | 252 |
253 :{count}fin[d][!] [++opt] [+cmd] {file} | |
254 Just like ":find", but use the {count} match in | |
255 'path'. Thus ":2find file" will find the second | |
256 "file" found in 'path'. When there are fewer matches | |
257 for the file in 'path' than asked for, you get an | |
258 error message. | |
259 | |
260 *:ex* | |
261 :ex [++opt] [+cmd] [file] | |
262 Same as |:edit|. | |
263 | |
264 *:vi* *:visual* | |
265 :vi[sual][!] [++opt] [+cmd] [file] | |
42 | 266 When used in Ex mode: Leave |Ex-mode|, go back to |
7 | 267 Normal mode. Otherwise same as |:edit|. |
268 | |
269 *:vie* *:view* | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
270 :vie[w][!] [++opt] [+cmd] file |
11160 | 271 When used in Ex mode: Leave |Ex-mode|, go back to |
7 | 272 Normal mode. Otherwise same as |:edit|, but set |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16427
diff
changeset
|
273 'readonly' option for this buffer. |
7 | 274 |
275 *CTRL-^* *CTRL-6* | |
2725 | 276 CTRL-^ Edit the alternate file. Mostly the alternate file is |
277 the previously edited file. This is a quick way to | |
278 toggle between two files. It is equivalent to ":e #", | |
279 except that it also works when there is no file name. | |
280 | |
7 | 281 If the 'autowrite' or 'autowriteall' option is on and |
282 the buffer was changed, write it. | |
283 Mostly the ^ character is positioned on the 6 key, | |
284 pressing CTRL and 6 then gets you what we call CTRL-^. | |
285 But on some non-US keyboards CTRL-^ is produced in | |
286 another way. | |
287 | |
39 | 288 {count}CTRL-^ Edit [count]th file in the buffer list (equivalent to |
289 ":e #[count]"). This is a quick way to switch between | |
290 files. | |
291 See |CTRL-^| above for further details. | |
292 | |
7 | 293 [count]]f *]f* *[f* |
294 [count][f Same as "gf". Deprecated. | |
295 | |
296 *gf* *E446* *E447* | |
297 [count]gf Edit the file whose name is under or after the cursor. | |
298 Mnemonic: "goto file". | |
299 Uses the 'isfname' option to find out which characters | |
300 are supposed to be in a file name. Trailing | |
6647 | 301 punctuation characters ".,:;!" are ignored. Escaped |
302 spaces "\ " are reduced to a single space. | |
1668 | 303 Uses the 'path' option as a list of directory names to |
304 look for the file. See the 'path' option for details | |
305 about relative directories and wildcards. | |
7 | 306 Uses the 'suffixesadd' option to check for file names |
307 with a suffix added. | |
308 If the file can't be found, 'includeexpr' is used to | |
309 modify the name and another attempt is done. | |
310 If a [count] is given, the count'th file that is found | |
311 in the 'path' is edited. | |
312 This command fails if Vim refuses to |abandon| the | |
313 current file. | |
820 | 314 If you want to edit the file in a new window use |
315 |CTRL-W_CTRL-F|. | |
7 | 316 If you do want to edit a new file, use: > |
317 :e <cfile> | |
318 < To make gf always work like that: > | |
319 :map gf :e <cfile><CR> | |
320 < If the name is a hypertext link, that looks like | |
321 "type://machine/path", you need the |netrw| plugin. | |
322 For Unix the '~' character is expanded, like in | |
323 "~user/file". Environment variables are expanded too | |
324 |expand-env|. | |
325 {not available when the |+file_in_path| feature was | |
326 disabled at compile time} | |
327 | |
328 *v_gf* | |
329 {Visual}[count]gf Same as "gf", but the highlighted text is used as the | |
330 name of the file to edit. 'isfname' is ignored. | |
331 Leading blanks are skipped, otherwise all blanks and | |
332 special characters are included in the file name. | |
333 (For {Visual} see |Visual-mode|.) | |
334 | |
681 | 335 *gF* |
336 [count]gF Same as "gf", except if a number follows the file | |
337 name, then the cursor is positioned on that line in | |
18972 | 338 the file. |
339 The file name and the number must be separated by a | |
340 non-filename (see 'isfname') and non-numeric | |
341 character. " line " is also recognized, like it is | |
342 used in the output of `:verbose command UserCmd` | |
343 White space between the filename, the separator and | |
344 the number are ignored. | |
852 | 345 Examples: |
346 eval.c:10 ~ | |
347 eval.c @ 20 ~ | |
348 eval.c (30) ~ | |
349 eval.c 40 ~ | |
350 | |
681 | 351 *v_gF* |
352 {Visual}[count]gF Same as "v_gf". | |
353 | |
7 | 354 These commands are used to start editing a single file. This means that the |
355 file is read into the buffer and the current file name is set. The file that | |
356 is opened depends on the current directory, see |:cd|. | |
357 | |
358 See |read-messages| for an explanation of the message that is given after the | |
359 file has been read. | |
360 | |
361 You can use the ":e!" command if you messed up the buffer and want to start | |
362 all over again. The ":e" command is only useful if you have changed the | |
363 current file name. | |
364 | |
365 *:filename* *{file}* | |
1620 | 366 Besides the things mentioned here, more special items for where a filename is |
367 expected are mentioned at |cmdline-special|. | |
368 | |
1668 | 369 Note for systems other than Unix: When using a command that accepts a single |
370 file name (like ":edit file") spaces in the file name are allowed, but | |
371 trailing spaces are ignored. This is useful on systems that regularly embed | |
372 spaces in file names (like MS-Windows and the Amiga). Example: The command | |
373 ":e Long File Name " will edit the file "Long File Name". When using a | |
374 command that accepts more than one file name (like ":next file1 file2") | |
375 embedded spaces must be escaped with a backslash. | |
7 | 376 |
1121 | 377 *wildcard* *wildcards* |
3682 | 378 Wildcards in {file} are expanded, but as with file completion, 'wildignore' |
379 and 'suffixes' apply. Which wildcards are supported depends on the system. | |
380 These are the common ones: | |
444 | 381 ? matches one character |
7 | 382 * matches anything, including nothing |
444 | 383 ** matches anything, including nothing, recurses into directories |
7 | 384 [abc] match 'a', 'b' or 'c' |
444 | 385 |
7 | 386 To avoid the special meaning of the wildcards prepend a backslash. However, |
387 on MS-Windows the backslash is a path separator and "path\[abc]" is still seen | |
388 as a wildcard when "[" is in the 'isfname' option. A simple way to avoid this | |
8795
aba2d0a01290
commit https://github.com/vim/vim/commit/7db8f6f4f85e5d0526d23107b2a5e2334dc23354
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
389 is to use "path\[[]abc]", this matches the file "path\[abc]". |
7 | 390 |
444 | 391 *starstar-wildcard* |
27804 | 392 Expanding "**" is possible on Unix, Win32, macOS and a few other systems. |
444 | 393 This allows searching a directory tree. This goes up to 100 directories deep. |
3750 | 394 Note there are some commands where this works slightly differently, see |
1668 | 395 |file-searching|. |
444 | 396 Example: > |
397 :n **/*.txt | |
398 Finds files: | |
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
399 aaa.txt ~ |
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
400 subdir/bbb.txt ~ |
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
401 a/b/c/d/ccc.txt ~ |
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
402 When non-wildcard characters are used right before or after "**" these are |
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
403 only matched in the top directory. They are not used for directories further |
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
404 down in the tree. For example: > |
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
405 :n /usr/inc**/types.h |
444 | 406 Finds files: |
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
407 /usr/include/types.h ~ |
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
408 /usr/include/sys/types.h ~ |
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
409 /usr/inc/old/types.h ~ |
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
410 Note that the path with "/sys" is included because it does not need to match |
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
411 "/inc". Thus it's like matching "/usr/inc*/*/*...", not |
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
412 "/usr/inc*/inc*/inc*". |
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
413 |
7 | 414 *backtick-expansion* *`-expansion* |
7013 | 415 On Unix and a few other systems you can also use backticks for the file name |
416 argument, for example: > | |
417 :next `find . -name ver\\*.c -print` | |
7051
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
7013
diff
changeset
|
418 :view `ls -t *.patch \| head -n1` |
13563 | 419 Vim will run the command in backticks using the 'shell' and use the standard |
420 output as argument for the given Vim command (error messages from the shell | |
421 command will be discarded). | |
422 To see what shell command Vim is running, set the 'verbose' option to 4. When | |
423 the shell command returns a non-zero exit code, an error message will be | |
424 displayed and the Vim command will be aborted. To avoid this make the shell | |
425 always return zero like so: > | |
426 :next `find . -name ver\\*.c -print \|\| true` | |
427 | |
7013 | 428 The backslashes before the star are required to prevent the shell from |
429 expanding "ver*.c" prior to execution of the find program. The backslash | |
430 before the shell pipe symbol "|" prevents Vim from parsing it as command | |
431 termination. | |
7 | 432 This also works for most other systems, with the restriction that the |
433 backticks must be around the whole item. It is not possible to have text | |
434 directly before the first or just after the last backtick. | |
435 | |
27321 | 436 *`=* *E1083* |
7013 | 437 You can have the backticks expanded as a Vim expression, instead of as an |
438 external command, by putting an equal sign right after the first backtick, | |
439 e.g.: > | |
39 | 440 :e `=tempname()` |
441 The expression can contain just about anything, thus this can also be used to | |
3682 | 442 avoid the special meaning of '"', '|', '%' and '#'. However, 'wildignore' |
4119 | 443 does apply like to other wildcards. |
7013 | 444 |
7051
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
7013
diff
changeset
|
445 Environment variables in the expression are expanded when evaluating the |
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
7013
diff
changeset
|
446 expression, thus this works: > |
27903 | 447 :e `=$HOME .. '/.vimrc'` |
28517 | 448 This uses $HOME inside a string and it will be used literally, most likely not |
449 what you intended: > | |
27903 | 450 :e `='$HOME' .. '/.vimrc'` |
7013 | 451 |
3682 | 452 If the expression returns a string then names are to be separated with line |
453 breaks. When the result is a |List| then each item is used as a name. Line | |
454 breaks also separate names. | |
6951
b2673982c625
Updated and new runtime files.
Bram Moolenaar <bram@vim.org>
parents:
6647
diff
changeset
|
455 Note that such expressions are only supported in places where a filename is |
b2673982c625
Updated and new runtime files.
Bram Moolenaar <bram@vim.org>
parents:
6647
diff
changeset
|
456 expected as an argument to an Ex-command. |
7 | 457 |
458 *++opt* *[++opt]* | |
595 | 459 The [++opt] argument can be used to force the value of 'fileformat', |
460 'fileencoding' or 'binary' to a value for one command, and to specify the | |
461 behavior for bad characters. The form is: > | |
819 | 462 ++{optname} |
463 Or: > | |
7 | 464 ++{optname}={value} |
465 | |
819 | 466 Where {optname} is one of: *++ff* *++enc* *++bin* *++nobin* *++edit* |
7 | 467 ff or fileformat overrides 'fileformat' |
468 enc or encoding overrides 'fileencoding' | |
469 bin or binary sets 'binary' | |
470 nobin or nobinary resets 'binary' | |
856 | 471 bad specifies behavior for bad characters |
819 | 472 edit for |:read| only: keep option values as if editing |
856 | 473 a file |
7 | 474 |
475 {value} cannot contain white space. It can be any valid value for these | |
476 options. Examples: > | |
477 :e ++ff=unix | |
478 This edits the same file again with 'fileformat' set to "unix". > | |
479 | |
480 :w ++enc=latin1 newfile | |
481 This writes the current buffer to "newfile" in latin1 format. | |
482 | |
20379 | 483 The message given when writing a file will show "[converted]" when |
484 'fileencoding' or the value specified with ++enc differs from 'encoding'. | |
485 | |
595 | 486 There may be several ++opt arguments, separated by white space. They must all |
487 appear before any |+cmd| argument. | |
488 | |
489 *++bad* | |
490 The argument of "++bad=" specifies what happens with characters that can't be | |
491 converted and illegal bytes. It can be one of three things: | |
492 ++bad=X A single-byte character that replaces each bad character. | |
493 ++bad=keep Keep bad characters without conversion. Note that this may | |
856 | 494 result in illegal bytes in your text! |
595 | 495 ++bad=drop Remove the bad characters. |
496 | |
497 The default is like "++bad=?": Replace each bad character with a question | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
498 mark. In some places an inverted question mark is used (0xBF). |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
499 |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
500 Note that not all commands use the ++bad argument, even though they do not |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
501 give an error when you add it. E.g. |:write|. |
595 | 502 |
7 | 503 Note that when reading, the 'fileformat' and 'fileencoding' options will be |
504 set to the used format. When writing this doesn't happen, thus a next write | |
505 will use the old value of the option. Same for the 'binary' option. | |
506 | |
507 | |
508 *+cmd* *[+cmd]* | |
509 The [+cmd] argument can be used to position the cursor in the newly opened | |
510 file, or execute any other command: | |
511 + Start at the last line. | |
512 +{num} Start at line {num}. | |
513 +/{pat} Start at first line containing {pat}. | |
514 +{command} Execute {command} after opening the new file. | |
515 {command} is any Ex command. | |
516 To include a white space in the {pat} or {command}, precede it with a | |
517 backslash. Double the number of backslashes. > | |
518 :edit +/The\ book file | |
519 :edit +/dir\ dirname\\ file | |
520 :edit +set\ dir=c:\\\\temp file | |
521 Note that in the last example the number of backslashes is halved twice: Once | |
522 for the "+cmd" argument and once for the ":set" command. | |
523 | |
524 *file-formats* | |
525 The 'fileformat' option sets the <EOL> style for a file: | |
526 'fileformat' characters name ~ | |
527 "dos" <CR><NL> or <NL> DOS format *DOS-format* | |
528 "unix" <NL> Unix format *Unix-format* | |
529 "mac" <CR> Mac format *Mac-format* | |
530 Previously 'textmode' was used. It is obsolete now. | |
531 | |
532 When reading a file, the mentioned characters are interpreted as the <EOL>. | |
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
533 In DOS format (default for Win32), <CR><NL> and <NL> are both interpreted as |
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
534 the <EOL>. Note that when writing the file in DOS format, <CR> characters |
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
535 will be added for each single <NL>. Also see |file-read|. |
7 | 536 |
537 When writing a file, the mentioned characters are used for <EOL>. For DOS | |
538 format <CR><NL> is used. Also see |DOS-format-write|. | |
539 | |
540 You can read a file in DOS format and write it in Unix format. This will | |
541 replace all <CR><NL> pairs by <NL> (assuming 'fileformats' includes "dos"): > | |
542 :e file | |
543 :set fileformat=unix | |
544 :w | |
545 If you read a file in Unix format and write with DOS format, all <NL> | |
546 characters will be replaced with <CR><NL> (assuming 'fileformats' includes | |
547 "unix"): > | |
548 :e file | |
549 :set fileformat=dos | |
550 :w | |
551 | |
552 If you start editing a new file and the 'fileformats' option is not empty | |
553 (which is the default), Vim will try to detect whether the lines in the file | |
554 are separated by the specified formats. When set to "unix,dos", Vim will | |
555 check for lines with a single <NL> (as used on Unix and Amiga) or by a <CR> | |
18972 | 556 <NL> pair (MS-Windows). Only when ALL lines end in <CR><NL>, 'fileformat' is |
557 set to "dos", otherwise it is set to "unix". When 'fileformats' includes | |
558 "mac", and no <NL> characters are found in the file, 'fileformat' is set to | |
559 "mac". | |
7 | 560 |
18972 | 561 If the 'fileformat' option is set to "dos" on non-MS-Windows systems the |
562 message "[dos format]" is shown to remind you that something unusual is | |
563 happening. On MS-Windows systems you get the message "[unix format]" if | |
564 'fileformat' is set to "unix". On all systems but the Macintosh you get the | |
565 message "[mac format]" if 'fileformat' is set to "mac". | |
7 | 566 |
567 If the 'fileformats' option is empty and DOS format is used, but while reading | |
568 a file some lines did not end in <CR><NL>, "[CR missing]" will be included in | |
569 the file message. | |
570 If the 'fileformats' option is empty and Mac format is used, but while reading | |
571 a file a <NL> was found, "[NL missing]" will be included in the file message. | |
572 | |
573 If the new file does not exist, the 'fileformat' of the current buffer is used | |
574 when 'fileformats' is empty. Otherwise the first format from 'fileformats' is | |
575 used for the new file. | |
576 | |
577 Before editing binary, executable or Vim script files you should set the | |
578 'binary' option. A simple way to do this is by starting Vim with the "-b" | |
579 option. This will avoid the use of 'fileformat'. Without this you risk that | |
580 single <NL> characters are unexpectedly replaced with <CR><NL>. | |
581 | |
582 You can encrypt files that are written by setting the 'key' option. This | |
583 provides some security against others reading your files. |encryption| | |
584 | |
585 | |
586 ============================================================================== | |
39 | 587 3. The argument list *argument-list* *arglist* |
7 | 588 |
589 If you give more than one file name when starting Vim, this list is remembered | |
590 as the argument list. You can jump to each file in this list. | |
591 | |
592 Do not confuse this with the buffer list, which you can see with the | |
593 |:buffers| command. The argument list was already present in Vi, the buffer | |
39 | 594 list is new in Vim. Every file name in the argument list will also be present |
595 in the buffer list (unless it was deleted with |:bdel| or |:bwipe|). But it's | |
596 common that names in the buffer list are not in the argument list. | |
7 | 597 |
598 This subject is introduced in section |07.2| of the user manual. | |
599 | |
600 There is one global argument list, which is used for all windows by default. | |
601 It is possible to create a new argument list local to a window, see | |
602 |:arglocal|. | |
603 | |
604 You can use the argument list with the following commands, and with the | |
605 expression functions |argc()| and |argv()|. These all work on the argument | |
606 list of the current window. | |
607 | |
17036 | 608 *:ar* *:arg* *:args* |
7 | 609 :ar[gs] Print the argument list, with the current file in |
610 square brackets. | |
611 | |
612 :ar[gs] [++opt] [+cmd] {arglist} *:args_f* | |
613 Define {arglist} as the new argument list and edit | |
614 the first one. This fails when changes have been made | |
615 and Vim does not want to |abandon| the current buffer. | |
616 Also see |++opt| and |+cmd|. | |
617 | |
618 :ar[gs]! [++opt] [+cmd] {arglist} *:args_f!* | |
619 Define {arglist} as the new argument list and edit | |
620 the first one. Discard any changes to the current | |
621 buffer. | |
622 Also see |++opt| and |+cmd|. | |
623 | |
11676
f87c43fca41d
patch 8.0.0721: :argedit can only have one argument
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
624 :[count]arge[dit][!] [++opt] [+cmd] {name} .. *:arge* *:argedit* |
f87c43fca41d
patch 8.0.0721: :argedit can only have one argument
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
625 Add {name}s to the argument list and edit it. |
7 | 626 When {name} already exists in the argument list, this |
627 entry is edited. | |
628 This is like using |:argadd| and then |:edit|. | |
11676
f87c43fca41d
patch 8.0.0721: :argedit can only have one argument
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
629 Spaces in filenames have to be escaped with "\". |
7 | 630 [count] is used like with |:argadd|. |
11676
f87c43fca41d
patch 8.0.0721: :argedit can only have one argument
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
631 If the current file cannot be |abandon|ed {name}s will |
f87c43fca41d
patch 8.0.0721: :argedit can only have one argument
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
632 still be added to the argument list, but won't be |
f87c43fca41d
patch 8.0.0721: :argedit can only have one argument
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
633 edited. No check for duplicates is done. |
7 | 634 Also see |++opt| and |+cmd|. |
635 | |
636 :[count]arga[dd] {name} .. *:arga* *:argadd* *E479* | |
27537 | 637 :[count]arga[dd] *E1156* |
6238 | 638 Add the {name}s to the argument list. When {name} is |
6421 | 639 omitted add the current buffer name to the argument |
6238 | 640 list. |
7 | 641 If [count] is omitted, the {name}s are added just |
642 after the current entry in the argument list. | |
643 Otherwise they are added after the [count]'th file. | |
644 If the argument list is "a b c", and "b" is the | |
645 current argument, then these commands result in: | |
646 command new argument list ~ | |
647 :argadd x a b x c | |
648 :0argadd x x a b c | |
649 :1argadd x a x b c | |
6421 | 650 :$argadd x a b c x |
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7480
diff
changeset
|
651 And after the last one: |
6421 | 652 :+2argadd y a b c x y |
7 | 653 There is no check for duplicates, it is possible to |
26719
2bdcce61a4e4
patch 8.2.3888: the argument list may contain duplicates
Bram Moolenaar <Bram@vim.org>
parents:
26591
diff
changeset
|
654 add a file to the argument list twice. You can use |
2bdcce61a4e4
patch 8.2.3888: the argument list may contain duplicates
Bram Moolenaar <Bram@vim.org>
parents:
26591
diff
changeset
|
655 |:argdedupe| to fix it afterwards: > |
2bdcce61a4e4
patch 8.2.3888: the argument list may contain duplicates
Bram Moolenaar <Bram@vim.org>
parents:
26591
diff
changeset
|
656 :argadd *.txt | argdedupe |
2bdcce61a4e4
patch 8.2.3888: the argument list may contain duplicates
Bram Moolenaar <Bram@vim.org>
parents:
26591
diff
changeset
|
657 < The currently edited file is not changed. |
7 | 658 Note: you can also use this method: > |
659 :args ## x | |
660 < This will add the "x" item and sort the new list. | |
661 | |
26719
2bdcce61a4e4
patch 8.2.3888: the argument list may contain duplicates
Bram Moolenaar <Bram@vim.org>
parents:
26591
diff
changeset
|
662 :argded[upe] *:argded* *:argdedupe* |
2bdcce61a4e4
patch 8.2.3888: the argument list may contain duplicates
Bram Moolenaar <Bram@vim.org>
parents:
26591
diff
changeset
|
663 Remove duplicate filenames from the argument list. |
2bdcce61a4e4
patch 8.2.3888: the argument list may contain duplicates
Bram Moolenaar <Bram@vim.org>
parents:
26591
diff
changeset
|
664 If your current file is a duplicate, your current file |
2bdcce61a4e4
patch 8.2.3888: the argument list may contain duplicates
Bram Moolenaar <Bram@vim.org>
parents:
26591
diff
changeset
|
665 will change to the original file index. |
2bdcce61a4e4
patch 8.2.3888: the argument list may contain duplicates
Bram Moolenaar <Bram@vim.org>
parents:
26591
diff
changeset
|
666 |
21991 | 667 :argd[elete] {pattern} .. *:argd* *:argdelete* *E480* *E610* |
7 | 668 Delete files from the argument list that match the |
669 {pattern}s. {pattern} is used like a file pattern, | |
670 see |file-pattern|. "%" can be used to delete the | |
671 current entry. | |
672 This command keeps the currently edited file, also | |
673 when it's deleted from the argument list. | |
280 | 674 Example: > |
675 :argdel *.obj | |
7 | 676 |
21991 | 677 :[range]argd[elete] Delete the [range] files from the argument list. |
6421 | 678 Example: > |
679 :10,$argdel | |
680 < Deletes arguments 10 and further, keeping 1-9. > | |
681 :$argd | |
682 < Deletes just the last one. > | |
683 :argd | |
684 :.argd | |
685 < Deletes the current argument. > | |
686 :%argd | |
687 < Removes all the files from the arglist. | |
7 | 688 When the last number in the range is too high, up to |
6421 | 689 the last argument is deleted. |
7 | 690 |
691 *:argu* *:argument* | |
692 :[count]argu[ment] [count] [++opt] [+cmd] | |
693 Edit file [count] in the argument list. When [count] | |
694 is omitted the current entry is used. This fails | |
695 when changes have been made and Vim does not want to | |
696 |abandon| the current buffer. | |
697 Also see |++opt| and |+cmd|. | |
698 | |
699 :[count]argu[ment]! [count] [++opt] [+cmd] | |
700 Edit file [count] in the argument list, discard any | |
701 changes to the current buffer. When [count] is | |
702 omitted the current entry is used. | |
703 Also see |++opt| and |+cmd|. | |
704 | |
705 :[count]n[ext] [++opt] [+cmd] *:n* *:ne* *:next* *E165* *E163* | |
706 Edit [count] next file. This fails when changes have | |
707 been made and Vim does not want to |abandon| the | |
16610 | 708 current buffer. Also see |++opt| and |+cmd|. |
7 | 709 |
710 :[count]n[ext]! [++opt] [+cmd] | |
711 Edit [count] next file, discard any changes to the | |
16610 | 712 buffer. Also see |++opt| and |+cmd|. |
7 | 713 |
714 :n[ext] [++opt] [+cmd] {arglist} *:next_f* | |
715 Same as |:args_f|. | |
716 | |
717 :n[ext]! [++opt] [+cmd] {arglist} | |
718 Same as |:args_f!|. | |
719 | |
720 :[count]N[ext] [count] [++opt] [+cmd] *:Next* *:N* *E164* | |
721 Edit [count] previous file in argument list. This | |
722 fails when changes have been made and Vim does not | |
723 want to |abandon| the current buffer. | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16427
diff
changeset
|
724 Also see |++opt| and |+cmd|. |
7 | 725 |
726 :[count]N[ext]! [count] [++opt] [+cmd] | |
727 Edit [count] previous file in argument list. Discard | |
728 any changes to the buffer. Also see |++opt| and | |
16610 | 729 |+cmd|. |
7 | 730 |
731 :[count]prev[ious] [count] [++opt] [+cmd] *:prev* *:previous* | |
16610 | 732 Same as :Next. Also see |++opt| and |+cmd|. |
7 | 733 |
734 *:rew* *:rewind* | |
735 :rew[ind] [++opt] [+cmd] | |
736 Start editing the first file in the argument list. | |
737 This fails when changes have been made and Vim does | |
738 not want to |abandon| the current buffer. | |
16610 | 739 Also see |++opt| and |+cmd|. |
7 | 740 |
741 :rew[ind]! [++opt] [+cmd] | |
742 Start editing the first file in the argument list. | |
743 Discard any changes to the buffer. Also see |++opt| | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16427
diff
changeset
|
744 and |+cmd|. |
7 | 745 |
746 *:fir* *:first* | |
747 :fir[st][!] [++opt] [+cmd] | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16427
diff
changeset
|
748 Other name for ":rewind". |
7 | 749 |
750 *:la* *:last* | |
751 :la[st] [++opt] [+cmd] | |
752 Start editing the last file in the argument list. | |
753 This fails when changes have been made and Vim does | |
754 not want to |abandon| the current buffer. | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16427
diff
changeset
|
755 Also see |++opt| and |+cmd|. |
7 | 756 |
757 :la[st]! [++opt] [+cmd] | |
758 Start editing the last file in the argument list. | |
759 Discard any changes to the buffer. Also see |++opt| | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16427
diff
changeset
|
760 and |+cmd|. |
7 | 761 |
762 *:wn* *:wnext* | |
1702 | 763 :[count]wn[ext] [++opt] |
7 | 764 Write current file and start editing the [count] |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16427
diff
changeset
|
765 next file. Also see |++opt| and |+cmd|. |
7 | 766 |
1702 | 767 :[count]wn[ext] [++opt] {file} |
7 | 768 Write current file to {file} and start editing the |
769 [count] next file, unless {file} already exists and | |
770 the 'writeany' option is off. Also see |++opt| and | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16427
diff
changeset
|
771 |+cmd|. |
7 | 772 |
1702 | 773 :[count]wn[ext]! [++opt] {file} |
7 | 774 Write current file to {file} and start editing the |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16427
diff
changeset
|
775 [count] next file. Also see |++opt| and |+cmd|. |
7 | 776 |
1702 | 777 :[count]wN[ext][!] [++opt] [file] *:wN* *:wNext* |
778 :[count]wp[revious][!] [++opt] [file] *:wp* *:wprevious* | |
7 | 779 Same as :wnext, but go to previous file instead of |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16427
diff
changeset
|
780 next. |
7 | 781 |
782 The [count] in the commands above defaults to one. For some commands it is | |
783 possible to use two counts. The last one (rightmost one) is used. | |
784 | |
785 If no [+cmd] argument is present, the cursor is positioned at the last known | |
786 cursor position for the file. If 'startofline' is set, the cursor will be | |
787 positioned at the first non-blank in the line, otherwise the last know column | |
788 is used. If there is no last known cursor position the cursor will be in the | |
789 first line (the last line in Ex mode). | |
790 | |
39 | 791 *{arglist}* |
7 | 792 The wildcards in the argument list are expanded and the file names are sorted. |
793 Thus you can use the command "vim *.c" to edit all the C files. From within | |
39 | 794 Vim the command ":n *.c" does the same. |
795 | |
796 White space is used to separate file names. Put a backslash before a space or | |
1240 | 797 tab to include it in a file name. E.g., to edit the single file "foo bar": > |
39 | 798 :next foo\ bar |
799 | |
800 On Unix and a few other systems you can also use backticks, for example: > | |
801 :next `find . -name \\*.c -print` | |
7 | 802 The backslashes before the star are required to prevent "*.c" to be expanded |
803 by the shell before executing the find program. | |
804 | |
805 *arglist-position* | |
806 When there is an argument list you can see which file you are editing in the | |
807 title of the window (if there is one and 'title' is on) and with the file | |
808 message you get with the "CTRL-G" command. You will see something like | |
809 (file 4 of 11) | |
810 If 'shortmess' contains 'f' it will be | |
811 (4 of 11) | |
812 If you are not really editing the file at the current position in the argument | |
813 list it will be | |
814 (file (4) of 11) | |
815 This means that you are position 4 in the argument list, but not editing the | |
816 fourth file in the argument list. This happens when you do ":e file". | |
817 | |
818 | |
819 LOCAL ARGUMENT LIST | |
820 | |
821 *:arglocal* | |
822 :argl[ocal] Make a local copy of the global argument list. | |
823 Doesn't start editing another file. | |
824 | |
825 :argl[ocal][!] [++opt] [+cmd] {arglist} | |
826 Define a new argument list, which is local to the | |
827 current window. Works like |:args_f| otherwise. | |
828 | |
829 *:argglobal* | |
830 :argg[lobal] Use the global argument list for the current window. | |
831 Doesn't start editing another file. | |
832 | |
833 :argg[lobal][!] [++opt] [+cmd] {arglist} | |
834 Use the global argument list for the current window. | |
835 Define a new global argument list like |:args_f|. | |
836 All windows using the global argument list will see | |
837 this new list. | |
838 | |
839 There can be several argument lists. They can be shared between windows. | |
840 When they are shared, changing the argument list in one window will also | |
841 change it in the other window. | |
842 | |
843 When a window is split the new window inherits the argument list from the | |
844 current window. The two windows then share this list, until one of them uses | |
845 |:arglocal| or |:argglobal| to use another argument list. | |
846 | |
847 | |
848 USING THE ARGUMENT LIST | |
849 | |
850 *:argdo* | |
6474 | 851 :[range]argdo[!] {cmd} Execute {cmd} for each file in the argument list or |
852 if [range] is specified only for arguments in that | |
853 range. It works like doing this: > | |
7 | 854 :rewind |
855 :{cmd} | |
856 :next | |
857 :{cmd} | |
858 etc. | |
859 < When the current file can't be |abandon|ed and the [!] | |
860 is not present, the command fails. | |
861 When an error is detected on one file, further files | |
862 in the argument list will not be visited. | |
863 The last file in the argument list (or where an error | |
864 occurred) becomes the current file. | |
865 {cmd} can contain '|' to concatenate several commands. | |
866 {cmd} must not change the argument list. | |
867 Note: While this command is executing, the Syntax | |
868 autocommand event is disabled by adding it to | |
869 'eventignore'. This considerably speeds up editing | |
870 each file. | |
7092
64e30831fa42
commit https://github.com/vim/vim/commit/aa23b379421aa214e6543b06c974594a25799b09
Christian Brabandt <cb@256bit.org>
parents:
7051
diff
changeset
|
871 Also see |:windo|, |:tabdo|, |:bufdo|, |:cdo|, |:ldo|, |
64e30831fa42
commit https://github.com/vim/vim/commit/aa23b379421aa214e6543b06c974594a25799b09
Christian Brabandt <cb@256bit.org>
parents:
7051
diff
changeset
|
872 |:cfdo| and |:lfdo| |
7 | 873 |
874 Example: > | |
875 :args *.c | |
876 :argdo set ff=unix | update | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
877 This sets the 'fileformat' option to "unix" and writes the file if it is now |
7 | 878 changed. This is done for all *.c files. |
879 | |
880 Example: > | |
881 :args *.[ch] | |
882 :argdo %s/\<my_foo\>/My_Foo/ge | update | |
883 This changes the word "my_foo" to "My_Foo" in all *.c and *.h files. The "e" | |
884 flag is used for the ":substitute" command to avoid an error for files where | |
885 "my_foo" isn't used. ":update" writes the file only if changes were made. | |
886 | |
887 ============================================================================== | |
39 | 888 4. Writing *writing* *save-file* |
7 | 889 |
890 Note: When the 'write' option is off, you are not able to write any file. | |
891 | |
892 *:w* *:write* | |
14249
4543777545a3
Updated runtime and language files.
Christian Brabandt <cb@256bit.org>
parents:
13963
diff
changeset
|
893 *E502* *E503* *E504* *E505* |
27321 | 894 *E512* *E514* *E667* *E949* |
1702 | 895 :w[rite] [++opt] Write the whole buffer to the current file. This is |
7 | 896 the normal way to save changes to a file. It fails |
897 when the 'readonly' option is set or when there is | |
898 another reason why the file can't be written. | |
1702 | 899 For ++opt see |++opt|, but only ++bin, ++nobin, ++ff |
900 and ++enc are effective. | |
7 | 901 |
1702 | 902 :w[rite]! [++opt] Like ":write", but forcefully write when 'readonly' is |
7 | 903 set or there is another reason why writing was |
904 refused. | |
905 Note: This may change the permission and ownership of | |
906 the file and break (symbolic) links. Add the 'W' flag | |
907 to 'cpoptions' to avoid this. | |
908 | |
1702 | 909 :[range]w[rite][!] [++opt] |
910 Write the specified lines to the current file. This | |
7 | 911 is unusual, because the file will not contain all |
912 lines in the buffer. | |
913 | |
914 *:w_f* *:write_f* | |
1702 | 915 :[range]w[rite] [++opt] {file} |
916 Write the specified lines to {file}, unless it | |
7 | 917 already exists and the 'writeany' option is off. |
918 | |
919 *:w!* | |
1702 | 920 :[range]w[rite]! [++opt] {file} |
921 Write the specified lines to {file}. Overwrite an | |
7 | 922 existing file. |
923 | |
924 *:w_a* *:write_a* *E494* | |
1702 | 925 :[range]w[rite][!] [++opt] >> |
926 Append the specified lines to the current file. | |
7 | 927 |
1702 | 928 :[range]w[rite][!] [++opt] >> {file} |
7 | 929 Append the specified lines to {file}. '!' forces the |
930 write even if file does not exist. | |
931 | |
932 *:w_c* *:write_c* | |
1702 | 933 :[range]w[rite] [++opt] !{cmd} |
934 Execute {cmd} with [range] lines as standard input | |
7 | 935 (note the space in front of the '!'). {cmd} is |
936 executed like with ":!{cmd}", any '!' is replaced with | |
937 the previous command |:!|. | |
938 | |
31 | 939 The default [range] for the ":w" command is the whole buffer (1,$). If you |
1620 | 940 write the whole buffer, it is no longer considered changed. When you |
941 write it to a different file with ":w somefile" it depends on the "+" flag in | |
942 'cpoptions'. When included, the write command will reset the 'modified' flag, | |
943 even though the buffer itself may still be different from its file. | |
31 | 944 |
7 | 945 If a file name is given with ":w" it becomes the alternate file. This can be |
946 used, for example, when the write fails and you want to try again later with | |
947 ":w #". This can be switched off by removing the 'A' flag from the | |
948 'cpoptions' option. | |
949 | |
12909 | 950 Note that the 'fsync' option matters here. If it's set it may make writes |
951 slower (but safer). | |
952 | |
7 | 953 *:sav* *:saveas* |
1702 | 954 :sav[eas][!] [++opt] {file} |
955 Save the current buffer under the name {file} and set | |
7 | 956 the filename of the current buffer to {file}. The |
957 previous name is used for the alternate file name. | |
958 The [!] is needed to overwrite an existing file. | |
633 | 959 When 'filetype' is empty filetype detection is done |
960 with the new name, before the file is written. | |
819 | 961 When the write was successful 'readonly' is reset. |
7 | 962 |
963 *:up* *:update* | |
1702 | 964 :[range]up[date][!] [++opt] [>>] [file] |
7 | 965 Like ":write", but only write when the buffer has been |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16427
diff
changeset
|
966 modified. |
7 | 967 |
968 | |
969 WRITING WITH MULTIPLE BUFFERS *buffer-write* | |
970 | |
971 *:wa* *:wall* | |
972 :wa[ll] Write all changed buffers. Buffers without a file | |
10449
222b1432814e
commit https://github.com/vim/vim/commit/5162822914372fc916a93f85848c0c82209e7cec
Christian Brabandt <cb@256bit.org>
parents:
10244
diff
changeset
|
973 name cause an error message. Buffers which are |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16427
diff
changeset
|
974 readonly are not written. |
7 | 975 |
976 :wa[ll]! Write all changed buffers, even the ones that are | |
977 readonly. Buffers without a file name are not | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16427
diff
changeset
|
978 written and cause an error message. |
7 | 979 |
980 | |
981 Vim will warn you if you try to overwrite a file that has been changed | |
982 elsewhere. See |timestamp|. | |
983 | |
984 *backup* *E207* *E506* *E507* *E508* *E509* *E510* | |
985 If you write to an existing file (but do not append) while the 'backup', | |
986 'writebackup' or 'patchmode' option is on, a backup of the original file is | |
987 made. The file is either copied or renamed (see 'backupcopy'). After the | |
988 file has been successfully written and when the 'writebackup' option is on and | |
989 the 'backup' option is off, the backup file is deleted. When the 'patchmode' | |
990 option is on the backup file may be renamed. | |
991 | |
992 *backup-table* | |
993 'backup' 'writebackup' action ~ | |
994 off off no backup made | |
995 off on backup current file, deleted afterwards (default) | |
996 on off delete old backup, backup current file | |
997 on on delete old backup, backup current file | |
998 | |
999 When the 'backupskip' pattern matches with the name of the file which is | |
1000 written, no backup file is made. The values of 'backup' and 'writebackup' are | |
1001 ignored then. | |
1002 | |
1003 When the 'backup' option is on, an old backup file (with the same name as the | |
1004 new backup file) will be deleted. If 'backup' is not set, but 'writebackup' | |
1005 is set, an existing backup file will not be deleted. The backup file that is | |
1006 made while the file is being written will have a different name. | |
1007 | |
1008 On some filesystems it's possible that in a crash you lose both the backup and | |
1009 the newly written file (it might be there but contain bogus data). In that | |
1010 case try recovery, because the swap file is synced to disk and might still be | |
1011 there. |:recover| | |
1012 | |
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
1013 The directories given with the 'backupdir' option are used to put the backup |
7 | 1014 file in. (default: same directory as the written file). |
1015 | |
1016 Whether the backup is a new file, which is a copy of the original file, or the | |
1017 original file renamed depends on the 'backupcopy' option. See there for an | |
1018 explanation of when the copy is made and when the file is renamed. | |
1019 | |
1020 If the creation of a backup file fails, the write is not done. If you want | |
1021 to write anyway add a '!' to the command. | |
1022 | |
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2662
diff
changeset
|
1023 *write-permissions* |
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2662
diff
changeset
|
1024 When writing a new file the permissions are read-write. For unix the mask is |
23573 | 1025 0o666 with additionally umask applied. When writing a file that was read Vim |
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2662
diff
changeset
|
1026 will preserve the permissions, but clear the s-bit. |
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2662
diff
changeset
|
1027 |
7 | 1028 *write-readonly* |
1029 When the 'cpoptions' option contains 'W', Vim will refuse to overwrite a | |
1030 readonly file. When 'W' is not present, ":w!" will overwrite a readonly file, | |
1031 if the system allows it (the directory must be writable). | |
1032 | |
1033 *write-fail* | |
1034 If the writing of the new file fails, you have to be careful not to lose | |
1035 your changes AND the original file. If there is no backup file and writing | |
236 | 1036 the new file failed, you have already lost the original file! DON'T EXIT VIM |
1037 UNTIL YOU WRITE OUT THE FILE! If a backup was made, it is put back in place | |
7 | 1038 of the original file (if possible). If you exit Vim, and lose the changes |
1039 you made, the original file will mostly still be there. If putting back the | |
1040 original file fails, there will be an error message telling you that you | |
1041 lost the original file. | |
1042 | |
1043 *DOS-format-write* | |
23305 | 1044 If the 'fileformat' is "dos", <CR><NL> is used for <EOL>. This is default |
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
1045 for Win32. On other systems the message "[dos format]" is shown to remind you |
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
1046 that an unusual <EOL> was used. |
7 | 1047 *Unix-format-write* |
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
1048 If the 'fileformat' is "unix", <NL> is used for <EOL>. On Win32 the message |
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
1049 "[unix format]" is shown. |
7 | 1050 *Mac-format-write* |
1051 If the 'fileformat' is "mac", <CR> is used for <EOL>. On non-Mac systems the | |
1052 message "[mac format]" is shown. | |
1053 | |
1054 See also |file-formats| and the 'fileformat' and 'fileformats' options. | |
1055 | |
1056 *ACL* | |
1057 ACL stands for Access Control List. It is an advanced way to control access | |
1058 rights for a file. It is used on new MS-Windows and Unix systems, but only | |
1059 when the filesystem supports it. | |
1060 Vim attempts to preserve the ACL info when writing a file. The backup file | |
1061 will get the ACL info of the original file. | |
1062 The ACL info is also used to check if a file is read-only (when opening the | |
1063 file). | |
1064 | |
1065 *read-only-share* | |
1066 When MS-Windows shares a drive on the network it can be marked as read-only. | |
1067 This means that even if the file read-only attribute is absent, and the ACL | |
1068 settings on NT network shared drives allow writing to the file, you can still | |
1069 not write to the file. Vim on Win32 platforms will detect read-only network | |
1070 drives and will mark the file as read-only. You will not be able to override | |
1071 it with |:write|. | |
1072 | |
1073 *write-device* | |
1074 When the file name is actually a device name, Vim will not make a backup (that | |
1075 would be impossible). You need to use "!", since the device already exists. | |
1076 Example for Unix: > | |
1077 :w! /dev/lpt0 | |
18972 | 1078 and for MS-Windows: > |
7 | 1079 :w! lpt0 |
1080 For Unix a device is detected when the name doesn't refer to a normal file or | |
1081 a directory. A fifo or named pipe also looks like a device to Vim. | |
18972 | 1082 For MS-Windows the device is detected by its name: |
7 | 1083 AUX |
1084 CON | |
1085 CLOCK$ | |
1086 NUL | |
1087 PRN | |
1088 COMn n=1,2,3... etc | |
1089 LPTn n=1,2,3... etc | |
1090 The names can be in upper- or lowercase. | |
1091 | |
1092 ============================================================================== | |
39 | 1093 5. Writing and quitting *write-quit* |
7 | 1094 |
1095 *:q* *:quit* | |
1096 :q[uit] Quit the current window. Quit Vim if this is the last | |
20379 | 1097 |edit-window|. This fails when changes have been made |
1098 and Vim refuses to |abandon| the current buffer, and | |
1099 when the last file in the argument list has not been | |
7 | 1100 edited. |
674 | 1101 If there are other tab pages and quitting the last |
1102 window in the current tab page the current tab page is | |
1103 closed |tab-page|. | |
3682 | 1104 Triggers the |QuitPre| autocommand event. |
12254 | 1105 See |CTRL-W_q| for quitting another window. |
7 | 1106 |
1107 :conf[irm] q[uit] Quit, but give prompt when changes have been made, or | |
1108 the last file in the argument list has not been | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16427
diff
changeset
|
1109 edited. See |:confirm| and 'confirm'. |
7 | 1110 |
7477
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7469
diff
changeset
|
1111 :q[uit]! Quit without writing, also when the current buffer has |
9860
9eaf8ef656e9
commit https://github.com/vim/vim/commit/0952131376a517fc12dc5ae908a97018b4ee23f0
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
1112 changes. The buffer is unloaded, also when it has |
9eaf8ef656e9
commit https://github.com/vim/vim/commit/0952131376a517fc12dc5ae908a97018b4ee23f0
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
1113 'hidden' set. |
9eaf8ef656e9
commit https://github.com/vim/vim/commit/0952131376a517fc12dc5ae908a97018b4ee23f0
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
1114 If this is the last window and there is a modified |
9eaf8ef656e9
commit https://github.com/vim/vim/commit/0952131376a517fc12dc5ae908a97018b4ee23f0
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
1115 hidden buffer, the current buffer is abandoned and the |
9eaf8ef656e9
commit https://github.com/vim/vim/commit/0952131376a517fc12dc5ae908a97018b4ee23f0
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
1116 first changed hidden buffer becomes the current |
9eaf8ef656e9
commit https://github.com/vim/vim/commit/0952131376a517fc12dc5ae908a97018b4ee23f0
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
1117 buffer. |
6385 | 1118 Use ":qall!" to exit always. |
7 | 1119 |
1120 :cq[uit] Quit always, without writing, and return an error | |
1121 code. See |:cq|. Used for Manx's QuickFix mode (see | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16427
diff
changeset
|
1122 |quickfix|). |
7 | 1123 |
1124 *:wq* | |
20379 | 1125 :wq [++opt] Write the current file and close the window. If this |
1126 was the last |edit-window| Vim quits. | |
1127 Writing fails when the file is read-only or the buffer | |
1128 does not have a name. Quitting fails when the last | |
1129 file in the argument list has not been edited. | |
7 | 1130 |
20379 | 1131 :wq! [++opt] Write the current file and close the window. If this |
1132 was the last |edit-window| Vim quits. Writing fails | |
1133 when the current buffer does not have a name. | |
7 | 1134 |
20379 | 1135 :wq [++opt] {file} Write to {file} and close the window. If this was the |
1136 last |edit-window| Vim quits. Quitting fails when the | |
7 | 1137 last file in the argument list has not been edited. |
1138 | |
20379 | 1139 :wq! [++opt] {file} Write to {file} and close the current window. Quit |
1140 Vim if this was the last |edit-window|. | |
7 | 1141 |
1702 | 1142 :[range]wq[!] [++opt] [file] |
1143 Same as above, but only write the lines in [range]. | |
7 | 1144 |
1145 *:x* *:xit* | |
1702 | 1146 :[range]x[it][!] [++opt] [file] |
7 | 1147 Like ":wq", but write only when changes have been |
1148 made. | |
1149 When 'hidden' is set and there are more windows, the | |
1150 current buffer becomes hidden, after writing the file. | |
26779 | 1151 This command is not supported in |Vim9| script, |
1152 because it is too easily confused with a variable | |
1153 name. | |
7 | 1154 |
1155 *:exi* *:exit* | |
1702 | 1156 :[range]exi[t][!] [++opt] [file] |
7 | 1157 Same as :xit. |
1158 | |
1159 *ZZ* | |
20379 | 1160 ZZ Write current file, if modified, and close the current |
1161 window (same as ":x"). | |
1162 If there are several windows for the current file, | |
1163 only the current window is closed. | |
7 | 1164 |
1165 *ZQ* | |
1166 ZQ Quit without checking for changes (same as ":q!"). | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16427
diff
changeset
|
1167 |
7 | 1168 |
1169 MULTIPLE WINDOWS AND BUFFERS *window-exit* | |
1170 | |
1171 *:qa* *:qall* | |
1172 :qa[ll] Exit Vim, unless there are some buffers which have been | |
1173 changed. (Use ":bmod" to go to the next modified buffer). | |
1174 When 'autowriteall' is set all changed buffers will be | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16427
diff
changeset
|
1175 written, like |:wqall|. |
7 | 1176 |
1177 :conf[irm] qa[ll] | |
1178 Exit Vim. Bring up a prompt when some buffers have been | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16427
diff
changeset
|
1179 changed. See |:confirm|. |
7 | 1180 |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16427
diff
changeset
|
1181 :qa[ll]! Exit Vim. Any changes to buffers are lost. |
1620 | 1182 Also see |:cquit|, it does the same but exits with a non-zero |
1183 value. | |
7 | 1184 |
1185 *:quita* *:quitall* | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16427
diff
changeset
|
1186 :quita[ll][!] Same as ":qall". |
7 | 1187 |
1702 | 1188 :wqa[ll] [++opt] *:wqa* *:wqall* *:xa* *:xall* |
7 | 1189 :xa[ll] Write all changed buffers and exit Vim. If there are buffers |
1190 without a file name, which are readonly or which cannot be | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16427
diff
changeset
|
1191 written for another reason, Vim will not quit. |
7 | 1192 |
1702 | 1193 :conf[irm] wqa[ll] [++opt] |
7 | 1194 :conf[irm] xa[ll] |
1195 Write all changed buffers and exit Vim. Bring up a prompt | |
1196 when some buffers are readonly or cannot be written for | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16427
diff
changeset
|
1197 another reason. See |:confirm|. |
7 | 1198 |
1702 | 1199 :wqa[ll]! [++opt] |
7 | 1200 :xa[ll]! Write all changed buffers, even the ones that are readonly, |
1201 and exit Vim. If there are buffers without a file name or | |
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
12909
diff
changeset
|
1202 which cannot be written for another reason, or there is a |
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
12909
diff
changeset
|
1203 terminal with a running job, Vim will not quit. |
7 | 1204 |
1205 ============================================================================== | |
39 | 1206 6. Dialogs *edit-dialogs* |
1207 | |
1208 *:confirm* *:conf* | |
1209 :conf[irm] {command} Execute {command}, and use a dialog when an | |
1210 operation has to be confirmed. Can be used on the | |
3445 | 1211 |:q|, |:qa| and |:w| commands (the latter to override |
1212 a read-only setting), and any other command that can | |
1213 fail in such a way, such as |:only|, |:buffer|, | |
1214 |:bdelete|, etc. | |
39 | 1215 |
1216 Examples: > | |
1217 :confirm w foo | |
1218 < Will ask for confirmation when "foo" already exists. > | |
1219 :confirm q | |
1220 < Will ask for confirmation when there are changes. > | |
1221 :confirm qa | |
1222 < If any modified, unsaved buffers exist, you will be prompted to save | |
1223 or abandon each one. There are also choices to "save all" or "abandon | |
1224 all". | |
1225 | |
1226 If you want to always use ":confirm", set the 'confirm' option. | |
1227 | |
29290 | 1228 *:browse* *:bro* *E338* |
39 | 1229 :bro[wse] {command} Open a file selection dialog for an argument to |
1230 {command}. At present this works for |:e|, |:w|, | |
2296
eb7be7b075a6
Support :browse for commands that use an error file argument. (Lech Lorens)
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
1231 |:wall|, |:wq|, |:wqall|, |:x|, |:xall|, |:exit|, |
eb7be7b075a6
Support :browse for commands that use an error file argument. (Lech Lorens)
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
1232 |:view|, |:sview|, |:r|, |:saveas|, |:sp|, |:mkexrc|, |
eb7be7b075a6
Support :browse for commands that use an error file argument. (Lech Lorens)
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
1233 |:mkvimrc|, |:mksession|, |:mkview|, |:split|, |
eb7be7b075a6
Support :browse for commands that use an error file argument. (Lech Lorens)
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
1234 |:vsplit|, |:tabe|, |:tabnew|, |:cfile|, |:cgetfile|, |
eb7be7b075a6
Support :browse for commands that use an error file argument. (Lech Lorens)
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
1235 |:caddfile|, |:lfile|, |:lgetfile|, |:laddfile|, |
eb7be7b075a6
Support :browse for commands that use an error file argument. (Lech Lorens)
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
1236 |:diffsplit|, |:diffpatch|, |:open|, |:pedit|, |
eb7be7b075a6
Support :browse for commands that use an error file argument. (Lech Lorens)
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
1237 |:redir|, |:source|, |:update|, |:visual|, |:vsplit|, |
eb7be7b075a6
Support :browse for commands that use an error file argument. (Lech Lorens)
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
1238 and |:qall| if 'confirm' is set. |
28379 | 1239 {only in Win32, Motif, GTK and Mac GUI, in |
25880 | 1240 console `browse edit` works if the FileExplorer |
1241 autocommand group exists} | |
39 | 1242 When ":browse" is not possible you get an error |
1243 message. If the |+browse| feature is missing or the | |
1244 {command} doesn't support browsing, the {command} is | |
1245 executed without a dialog. | |
1246 ":browse set" works like |:options|. | |
2296
eb7be7b075a6
Support :browse for commands that use an error file argument. (Lech Lorens)
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
1247 See also |:oldfiles| for ":browse oldfiles". |
39 | 1248 |
1249 The syntax is best shown via some examples: > | |
1250 :browse e $vim/foo | |
1251 < Open the browser in the $vim/foo directory, and edit the | |
1252 file chosen. > | |
1253 :browse e | |
1254 < Open the browser in the directory specified with 'browsedir', | |
1255 and edit the file chosen. > | |
1256 :browse w | |
1257 < Open the browser in the directory of the current buffer, | |
1258 with the current buffer filename as default, and save the | |
1259 buffer under the filename chosen. > | |
1260 :browse w C:/bar | |
1261 < Open the browser in the C:/bar directory, with the current | |
1262 buffer filename as default, and save the buffer under the | |
1263 filename chosen. | |
18016 | 1264 Also see the 'browsedir' option. |
39 | 1265 For versions of Vim where browsing is not supported, the command is executed |
1266 unmodified. | |
1267 | |
1268 *browsefilter* | |
24387 | 1269 For MS-Windows and GTK, you can modify the filters that are used in the browse |
3682 | 1270 dialog. By setting the g:browsefilter or b:browsefilter variables, you can |
1271 change the filters globally or locally to the buffer. The variable is set to | |
1272 a string in the format "{filter label}\t{pattern};{pattern}\n" where {filter | |
1273 label} is the text that appears in the "Files of Type" comboBox, and {pattern} | |
1274 is the pattern which filters the filenames. Several patterns can be given, | |
1275 separated by ';'. | |
39 | 1276 |
1277 For Motif the same format is used, but only the very first pattern is actually | |
1278 used (Motif only offers one pattern, but you can edit it). | |
1279 | |
1280 For example, to have only Vim files in the dialog, you could use the following | |
1281 command: > | |
1282 | |
3682 | 1283 let g:browsefilter = "Vim Scripts\t*.vim\nVim Startup Files\t*vimrc\n" |
39 | 1284 |
1285 You can override the filter setting on a per-buffer basis by setting the | |
1286 b:browsefilter variable. You would most likely set b:browsefilter in a | |
1287 filetype plugin, so that the browse dialog would contain entries related to | |
1288 the type of file you are currently editing. Disadvantage: This makes it | |
1289 difficult to start editing a file of a different type. To overcome this, you | |
1290 may want to add "All Files\t*.*\n" as the final filter, so that the user can | |
1291 still access any desired file. | |
1292 | |
3682 | 1293 To avoid setting browsefilter when Vim does not actually support it, you can |
1294 use has("browsefilter"): > | |
1295 | |
1296 if has("browsefilter") | |
1297 let g:browsefilter = "whatever" | |
1298 endif | |
1299 | |
39 | 1300 ============================================================================== |
1301 7. The current directory *current-directory* | |
1302 | |
16427
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1303 You can use the |:cd|, |:tcd| and |:lcd| commands to change to another |
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1304 directory, so you will not have to type that directory name in front of the |
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1305 file names. It also makes a difference for executing external commands, e.g. |
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1306 ":!ls". |
39 | 1307 |
167 | 1308 Changing directory fails when the current buffer is modified, the '.' flag is |
1309 present in 'cpoptions' and "!" is not used in the command. | |
1310 | |
835 | 1311 *:cd* *E747* *E472* |
26500
8088fa133b93
patch 8.2.3780: ":cd" works differently on MS-Windows
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
1312 :cd[!] On non-Unix systems when 'cdhome' is off: Print the |
8088fa133b93
patch 8.2.3780: ":cd" works differently on MS-Windows
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
1313 current directory name. |
8088fa133b93
patch 8.2.3780: ":cd" works differently on MS-Windows
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
1314 Otherwise: Change the current directory to the home |
8088fa133b93
patch 8.2.3780: ":cd" works differently on MS-Windows
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
1315 directory. Clear any window-local directory. |
8088fa133b93
patch 8.2.3780: ":cd" works differently on MS-Windows
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
1316 Use |:pwd| to print the current directory on all |
8088fa133b93
patch 8.2.3780: ":cd" works differently on MS-Windows
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
1317 systems. |
39 | 1318 |
167 | 1319 :cd[!] {path} Change the current directory to {path}. |
39 | 1320 If {path} is relative, it is searched for in the |
1321 directories listed in |'cdpath'|. | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16427
diff
changeset
|
1322 Clear any window-local directory. |
39 | 1323 Does not change the meaning of an already opened file, |
1324 because its full path name is remembered. Files from | |
1325 the |arglist| may change though! | |
18972 | 1326 On MS-Windows this also changes the active drive. |
39 | 1327 To change to the directory of the current file: > |
1328 :cd %:h | |
1329 < | |
1330 *:cd-* *E186* | |
167 | 1331 :cd[!] - Change to the previous current directory (before the |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16427
diff
changeset
|
1332 previous ":cd {path}" command). |
39 | 1333 |
1334 *:chd* *:chdir* | |
167 | 1335 :chd[ir][!] [path] Same as |:cd|. |
39 | 1336 |
24751 | 1337 *:tc* *:tcd* |
1338 :tc[d][!] {path} Like |:cd|, but only set the directory for the current | |
16427
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1339 tab. The current window will also use this directory. |
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1340 The current directory is not changed for windows in |
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1341 other tabs and for windows in the current tab that |
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1342 have their own window-local directory. |
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1343 |
20711
d91b8d1e5198
patch 8.2.0909: cannot go back to the previous local directory
Bram Moolenaar <Bram@vim.org>
parents:
20645
diff
changeset
|
1344 *:tcd-* |
24751 | 1345 :tc[d][!] - Change to the previous current directory, before the |
20711
d91b8d1e5198
patch 8.2.0909: cannot go back to the previous local directory
Bram Moolenaar <Bram@vim.org>
parents:
20645
diff
changeset
|
1346 last ":tcd {path}" command. |
d91b8d1e5198
patch 8.2.0909: cannot go back to the previous local directory
Bram Moolenaar <Bram@vim.org>
parents:
20645
diff
changeset
|
1347 |
25973 | 1348 *:tch* *:tchdir* |
1349 :tch[dir][!] Same as |:tcd|. | |
1350 | |
39 | 1351 *:lc* *:lcd* |
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11400
diff
changeset
|
1352 :lc[d][!] {path} Like |:cd|, but only set the current directory when |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11400
diff
changeset
|
1353 the cursor is in the current window. The current |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11400
diff
changeset
|
1354 directory for other windows is not changed, switching |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11400
diff
changeset
|
1355 to another window will stop using {path}. |
39 | 1356 |
20711
d91b8d1e5198
patch 8.2.0909: cannot go back to the previous local directory
Bram Moolenaar <Bram@vim.org>
parents:
20645
diff
changeset
|
1357 *:lcd-* |
d91b8d1e5198
patch 8.2.0909: cannot go back to the previous local directory
Bram Moolenaar <Bram@vim.org>
parents:
20645
diff
changeset
|
1358 :lcd[!] - Change to the previous current directory, before the |
d91b8d1e5198
patch 8.2.0909: cannot go back to the previous local directory
Bram Moolenaar <Bram@vim.org>
parents:
20645
diff
changeset
|
1359 last ":lcd {path}" command. |
d91b8d1e5198
patch 8.2.0909: cannot go back to the previous local directory
Bram Moolenaar <Bram@vim.org>
parents:
20645
diff
changeset
|
1360 |
25973 | 1361 *:lch* *:lchdir* |
1362 :lch[dir][!] Same as |:lcd|. | |
1363 | |
39 | 1364 *:pw* *:pwd* *E187* |
16610 | 1365 :pw[d] Print the current directory name. |
39 | 1366 Also see |getcwd()|. |
20645
b60bb094af52
patch 8.2.0876: :pwd does not give a hint about the scope of the directory
Bram Moolenaar <Bram@vim.org>
parents:
20379
diff
changeset
|
1367 *:pwd-verbose* |
b60bb094af52
patch 8.2.0876: :pwd does not give a hint about the scope of the directory
Bram Moolenaar <Bram@vim.org>
parents:
20379
diff
changeset
|
1368 When 'verbose' is non-zero, |:pwd| will also display |
b60bb094af52
patch 8.2.0876: :pwd does not give a hint about the scope of the directory
Bram Moolenaar <Bram@vim.org>
parents:
20379
diff
changeset
|
1369 what scope the current directory was set. Example: > |
b60bb094af52
patch 8.2.0876: :pwd does not give a hint about the scope of the directory
Bram Moolenaar <Bram@vim.org>
parents:
20379
diff
changeset
|
1370 |
b60bb094af52
patch 8.2.0876: :pwd does not give a hint about the scope of the directory
Bram Moolenaar <Bram@vim.org>
parents:
20379
diff
changeset
|
1371 " Set by :cd |
b60bb094af52
patch 8.2.0876: :pwd does not give a hint about the scope of the directory
Bram Moolenaar <Bram@vim.org>
parents:
20379
diff
changeset
|
1372 :verbose pwd |
b60bb094af52
patch 8.2.0876: :pwd does not give a hint about the scope of the directory
Bram Moolenaar <Bram@vim.org>
parents:
20379
diff
changeset
|
1373 [global] /path/to/current |
b60bb094af52
patch 8.2.0876: :pwd does not give a hint about the scope of the directory
Bram Moolenaar <Bram@vim.org>
parents:
20379
diff
changeset
|
1374 |
b60bb094af52
patch 8.2.0876: :pwd does not give a hint about the scope of the directory
Bram Moolenaar <Bram@vim.org>
parents:
20379
diff
changeset
|
1375 " Set by :lcd |
b60bb094af52
patch 8.2.0876: :pwd does not give a hint about the scope of the directory
Bram Moolenaar <Bram@vim.org>
parents:
20379
diff
changeset
|
1376 :verbose pwd |
b60bb094af52
patch 8.2.0876: :pwd does not give a hint about the scope of the directory
Bram Moolenaar <Bram@vim.org>
parents:
20379
diff
changeset
|
1377 [window] /path/to/current |
b60bb094af52
patch 8.2.0876: :pwd does not give a hint about the scope of the directory
Bram Moolenaar <Bram@vim.org>
parents:
20379
diff
changeset
|
1378 |
b60bb094af52
patch 8.2.0876: :pwd does not give a hint about the scope of the directory
Bram Moolenaar <Bram@vim.org>
parents:
20379
diff
changeset
|
1379 " Set by :tcd |
b60bb094af52
patch 8.2.0876: :pwd does not give a hint about the scope of the directory
Bram Moolenaar <Bram@vim.org>
parents:
20379
diff
changeset
|
1380 :verbose pwd |
b60bb094af52
patch 8.2.0876: :pwd does not give a hint about the scope of the directory
Bram Moolenaar <Bram@vim.org>
parents:
20379
diff
changeset
|
1381 [tabpage] /path/to/current |
39 | 1382 |
16427
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1383 So long as no |:lcd| or |:tcd| command has been used, all windows share the |
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1384 same current directory. Using a command to jump to another window doesn't |
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1385 change anything for the current directory. |
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1386 |
39 | 1387 When a |:lcd| command has been used for a window, the specified directory |
1388 becomes the current directory for that window. Windows where the |:lcd| | |
16427
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1389 command has not been used stick to the global or tab-local current directory. |
25973 | 1390 When jumping to another window the current directory is changed to the last |
16427
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1391 specified local current directory. If none was specified, the global or |
27162 | 1392 tab-local current directory is used. When creating a new window it inherits |
1393 the local directory of the current window. | |
16427
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1394 |
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1395 When a |:tcd| command has been used for a tab page, the specified directory |
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1396 becomes the current directory for the current tab page and the current window. |
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1397 The current directory of other tab pages is not affected. When jumping to |
25973 | 1398 another tab page, the current directory is changed to the last specified local |
16427
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1399 directory for that tab page. If the current tab has no local current directory |
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1400 the global current directory is used. |
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1401 |
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1402 When a |:cd| command is used, the current window and tab page will lose the |
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1403 local current directory and will use the global current directory from now on. |
39 | 1404 |
1405 After using |:cd| the full path name will be used for reading and writing | |
1406 files. On some networked file systems this may cause problems. The result of | |
1407 using the full path name is that the file names currently in use will remain | |
1408 referring to the same file. Example: If you have a file a:test and a | |
1409 directory a:vim the commands ":e test" ":cd vim" ":w" will overwrite the file | |
1410 a:test and not write a:vim/test. But if you do ":w test" the file a:vim/test | |
1411 will be written, because you gave a new file name and did not refer to a | |
1412 filename before the ":cd". | |
1413 | |
1414 ============================================================================== | |
7 | 1415 8. Editing binary files *edit-binary* |
1416 | |
1417 Although Vim was made to edit text files, it is possible to edit binary | |
1418 files. The |-b| Vim argument (b for binary) makes Vim do file I/O in binary | |
1419 mode, and sets some options for editing binary files ('binary' on, 'textwidth' | |
1420 to 0, 'modeline' off, 'expandtab' off). Setting the 'binary' option has the | |
1421 same effect. Don't forget to do this before reading the file. | |
1422 | |
1423 There are a few things to remember when editing binary files: | |
21250 | 1424 - When editing executable files the number of bytes must not change. |
7 | 1425 Use only the "R" or "r" command to change text. Do not delete characters |
1426 with "x" or by backspacing. | |
1427 - Set the 'textwidth' option to 0. Otherwise lines will unexpectedly be | |
1428 split in two. | |
1429 - When there are not many <EOL>s, the lines will become very long. If you | |
1430 want to edit a line that does not fit on the screen reset the 'wrap' option. | |
1431 Horizontal scrolling is used then. If a line becomes too long (more than | |
21250 | 1432 about 32767 bytes on the Amiga, much more on 32-bit and 64-bit systems, see |
7 | 1433 |limits|) you cannot edit that line. The line will be split when reading |
1434 the file. It is also possible that you get an "out of memory" error when | |
1435 reading the file. | |
1436 - Make sure the 'binary' option is set BEFORE loading the | |
23305 | 1437 file. Otherwise both <CR><NL> and <NL> are considered to end a line |
1438 and when the file is written the <NL> will be replaced with <CR><NL>. | |
7 | 1439 - <Nul> characters are shown on the screen as ^@. You can enter them with |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16427
diff
changeset
|
1440 "CTRL-V CTRL-@" or "CTRL-V 000" |
7013 | 1441 - To insert a <NL> character in the file split a line. When writing the |
7 | 1442 buffer to a file a <NL> will be written for the <EOL>. |
1443 - Vim normally appends an <EOL> at the end of the file if there is none. | |
1444 Setting the 'binary' option prevents this. If you want to add the final | |
1445 <EOL>, set the 'endofline' option. You can also read the value of this | |
1446 option to see if there was an <EOL> for the last line (you cannot see this | |
1447 in the text). | |
1448 | |
1449 ============================================================================== | |
1450 9. Encryption *encryption* | |
1451 | |
1452 Vim is able to write files encrypted, and read them back. The encrypted text | |
1453 cannot be read without the right key. | |
2283
7e1bd501306d
Mainly documentation updates.
Bram Moolenaar <bram@vim.org>
parents:
2267
diff
changeset
|
1454 {only available when compiled with the |+cryptv| feature} *E833* |
7 | 1455 |
2662 | 1456 The text in the swap file and the undo file is also encrypted. *E843* |
6070
32a77cc160d9
Update runtime files. Make matchparen plugin backwards compatible.
Bram Moolenaar <bram@vim.org>
parents:
5908
diff
changeset
|
1457 However, this is done block-by-block and may reduce the time needed to crack a |
32a77cc160d9
Update runtime files. Make matchparen plugin backwards compatible.
Bram Moolenaar <bram@vim.org>
parents:
5908
diff
changeset
|
1458 password. You can disable the swap file, but then a crash will cause you to |
15194 | 1459 lose your work. The undo file can be disabled without too much disadvantage. > |
6070
32a77cc160d9
Update runtime files. Make matchparen plugin backwards compatible.
Bram Moolenaar <bram@vim.org>
parents:
5908
diff
changeset
|
1460 :set noundofile |
32a77cc160d9
Update runtime files. Make matchparen plugin backwards compatible.
Bram Moolenaar <bram@vim.org>
parents:
5908
diff
changeset
|
1461 :noswapfile edit secrets |
2267 | 1462 |
1463 Note: The text in memory is not encrypted. A system administrator may be able | |
1464 to see your text while you are editing it. When filtering text with | |
6122 | 1465 ":!filter" or using ":w !command" the text is also not encrypted, this may |
1466 reveal it to others. The 'viminfo' file is not encrypted. | |
1467 | |
1468 You could do this to edit very secret text: > | |
1469 :set noundofile viminfo= | |
1470 :noswapfile edit secrets.txt | |
7051
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
7013
diff
changeset
|
1471 Keep in mind that without a swap file you risk losing your work in the event |
7013 | 1472 of a crash or a power failure. |
7 | 1473 |
1474 WARNING: If you make a typo when entering the key and then write the file and | |
1475 exit, the text will be lost! | |
1476 | |
1477 The normal way to work with encryption, is to use the ":X" command, which will | |
1478 ask you to enter a key. A following write command will use that key to | |
1479 encrypt the file. If you later edit the same file, Vim will ask you to enter | |
1480 a key. If you type the same key as that was used for writing, the text will | |
1481 be readable again. If you use a wrong key, it will be a mess. | |
1482 | |
1483 *:X* | |
1484 :X Prompt for an encryption key. The typing is done without showing the | |
1485 actual text, so that someone looking at the display won't see it. | |
1486 The typed key is stored in the 'key' option, which is used to encrypt | |
25402 | 1487 the file when it is written. |
1488 The file will remain unchanged until you write it. Note that commands | |
1489 such as `:xit` and `ZZ` will NOT write the file unless there are other | |
1490 changes. | |
1491 See also |-x|. | |
7 | 1492 |
1493 The value of the 'key' options is used when text is written. When the option | |
1494 is not empty, the written file will be encrypted, using the value as the | |
1495 encryption key. A magic number is prepended, so that Vim can recognize that | |
1496 the file is encrypted. | |
1497 | |
1498 To disable the encryption, reset the 'key' option to an empty value: > | |
1499 :set key= | |
1500 | |
2360
d8e4b27cef80
Change 'cryptmethod' from a number to a string option. Make it global-local.
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
1501 You can use the 'cryptmethod' option to select the type of encryption, use one |
6122 | 1502 of these: > |
1503 :setlocal cm=zip " weak method, backwards compatible | |
1504 :setlocal cm=blowfish " method with flaws | |
1505 :setlocal cm=blowfish2 " medium strong method | |
1506 | |
2360
d8e4b27cef80
Change 'cryptmethod' from a number to a string option. Make it global-local.
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
1507 Do this before writing the file. When reading an encrypted file it will be |
d8e4b27cef80
Change 'cryptmethod' from a number to a string option. Make it global-local.
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
1508 set automatically to the method used when that file was written. You can |
d8e4b27cef80
Change 'cryptmethod' from a number to a string option. Make it global-local.
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
1509 change 'cryptmethod' before writing that file to change the method. |
6122 | 1510 |
18831 | 1511 To set the default method, used for new files, use this in your |vimrc| |
6369 | 1512 file: > |
6122 | 1513 set cm=blowfish2 |
6369 | 1514 Using "blowfish2" is highly recommended. Only use another method if you |
1515 must use an older Vim version that does not support it. | |
6122 | 1516 |
2725 | 1517 The message given for reading and writing a file will show "[crypted]" when |
6122 | 1518 using zip, "[blowfish]" when using blowfish, etc. |
2180
f60a0c9cbe6c
Add the blowfish encryption patch from Mohsin Ahmed. Needs more work.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1519 |
2239
732cb7b31956
Crypt the text in the undo file if the file itself is crypted.
Bram Moolenaar <bram@vim.org>
parents:
2199
diff
changeset
|
1520 When writing an undo file, the same key and method will be used for the text |
732cb7b31956
Crypt the text in the undo file if the file itself is crypted.
Bram Moolenaar <bram@vim.org>
parents:
2199
diff
changeset
|
1521 in the undo file. |persistent-undo|. |
732cb7b31956
Crypt the text in the undo file if the file itself is crypted.
Bram Moolenaar <bram@vim.org>
parents:
2199
diff
changeset
|
1522 |
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7480
diff
changeset
|
1523 To test for blowfish support you can use these conditions: > |
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7480
diff
changeset
|
1524 has('crypt-blowfish') |
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7480
diff
changeset
|
1525 has('crypt-blowfish2') |
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7480
diff
changeset
|
1526 This works since Vim 7.4.1099 while blowfish support was added earlier. |
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7480
diff
changeset
|
1527 Thus the condition failing doesn't mean blowfish is not supported. You can |
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7480
diff
changeset
|
1528 test for blowfish with: > |
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7480
diff
changeset
|
1529 v:version >= 703 |
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7480
diff
changeset
|
1530 And for blowfish2 with: > |
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7480
diff
changeset
|
1531 v:version > 704 || (v:version == 704 && has('patch401')) |
7876
93f747af7b58
commit https://github.com/vim/vim/commit/5e9b2fa9bb0e6061cf18457c173cd141a5dc9c92
Christian Brabandt <cb@256bit.org>
parents:
7659
diff
changeset
|
1532 If you are sure Vim includes patch 7.4.237 a simpler check is: > |
93f747af7b58
commit https://github.com/vim/vim/commit/5e9b2fa9bb0e6061cf18457c173cd141a5dc9c92
Christian Brabandt <cb@256bit.org>
parents:
7659
diff
changeset
|
1533 has('patch-7.4.401') |
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7480
diff
changeset
|
1534 < |
2199
014a996ac896
Use UINT32_T in the code, define it to uint32_t or unsigned int.
Bram Moolenaar <bram@vim.org>
parents:
2184
diff
changeset
|
1535 *E817* *E818* *E819* *E820* |
2184
5028c4d6d825
Fixed encryption big/little endian test.
Bram Moolenaar <bram@vim.org>
parents:
2180
diff
changeset
|
1536 When encryption does not work properly, you would be able to write your text |
5028c4d6d825
Fixed encryption big/little endian test.
Bram Moolenaar <bram@vim.org>
parents:
2180
diff
changeset
|
1537 to a file and never be able to read it back. Therefore a test is performed to |
5028c4d6d825
Fixed encryption big/little endian test.
Bram Moolenaar <bram@vim.org>
parents:
2180
diff
changeset
|
1538 check if the encryption works as expected. If you get one of these errors |
5028c4d6d825
Fixed encryption big/little endian test.
Bram Moolenaar <bram@vim.org>
parents:
2180
diff
changeset
|
1539 don't write the file encrypted! You need to rebuild the Vim binary to fix |
5028c4d6d825
Fixed encryption big/little endian test.
Bram Moolenaar <bram@vim.org>
parents:
2180
diff
changeset
|
1540 this. |
5028c4d6d825
Fixed encryption big/little endian test.
Bram Moolenaar <bram@vim.org>
parents:
2180
diff
changeset
|
1541 |
2264 | 1542 *E831* This is an internal error, "cannot happen". If you can reproduce it, |
2251
646d34788036
Fix a few compiler warnings. Fix crash with encrypted undo file.
Bram Moolenaar <bram@vim.org>
parents:
2239
diff
changeset
|
1543 please report to the developers. |
646d34788036
Fix a few compiler warnings. Fix crash with encrypted undo file.
Bram Moolenaar <bram@vim.org>
parents:
2239
diff
changeset
|
1544 |
2184
5028c4d6d825
Fixed encryption big/little endian test.
Bram Moolenaar <bram@vim.org>
parents:
2180
diff
changeset
|
1545 When reading a file that has been encrypted and the 'key' option is not empty, |
5028c4d6d825
Fixed encryption big/little endian test.
Bram Moolenaar <bram@vim.org>
parents:
2180
diff
changeset
|
1546 it will be used for decryption. If the value is empty, you will be prompted |
5028c4d6d825
Fixed encryption big/little endian test.
Bram Moolenaar <bram@vim.org>
parents:
2180
diff
changeset
|
1547 to enter the key. If you don't enter a key, or you enter the wrong key, the |
5028c4d6d825
Fixed encryption big/little endian test.
Bram Moolenaar <bram@vim.org>
parents:
2180
diff
changeset
|
1548 file is edited without being decrypted. There is no warning about using the |
5028c4d6d825
Fixed encryption big/little endian test.
Bram Moolenaar <bram@vim.org>
parents:
2180
diff
changeset
|
1549 wrong key (this makes brute force methods to find the key more difficult). |
7 | 1550 |
1551 If want to start reading a file that uses a different key, set the 'key' | |
1552 option to an empty string, so that Vim will prompt for a new one. Don't use | |
1553 the ":set" command to enter the value, other people can read the command over | |
1554 your shoulder. | |
1555 | |
1556 Since the value of the 'key' option is supposed to be a secret, its value can | |
1557 never be viewed. You should not set this option in a vimrc file. | |
1558 | |
2368 | 1559 An encrypted file can be recognized by the "file" command, if you add these |
1560 lines to "/etc/magic", "/usr/share/misc/magic" or wherever your system has the | |
7 | 1561 "magic" file: > |
1562 0 string VimCrypt~ Vim encrypted file | |
2364
151b037b7e74
Fix hang when resizing in diff mode and there are concealed items.
Bram Moolenaar <bram@vim.org>
parents:
2360
diff
changeset
|
1563 >9 string 01 - "zip" cryptmethod |
151b037b7e74
Fix hang when resizing in diff mode and there are concealed items.
Bram Moolenaar <bram@vim.org>
parents:
2360
diff
changeset
|
1564 >9 string 02 - "blowfish" cryptmethod |
6122 | 1565 >9 string 03 - "blowfish2" cryptmethod |
7 | 1566 |
1567 Notes: | |
1568 - Encryption is not possible when doing conversion with 'charconvert'. | |
1569 - Text you copy or delete goes to the numbered registers. The registers can | |
1570 be saved in the .viminfo file, where they could be read. Change your | |
1571 'viminfo' option to be safe. | |
1572 - Someone can type commands in Vim when you walk away for a moment, he should | |
1573 not be able to get the key. | |
1574 - If you make a typing mistake when entering the key, you might not be able to | |
1575 get your text back! | |
1576 - If you type the key with a ":set key=value" command, it can be kept in the | |
1577 history, showing the 'key' value in a viminfo file. | |
1578 - There is never 100% safety. The encryption in Vim has not been tested for | |
1579 robustness. | |
2581 | 1580 - The algorithm used for 'cryptmethod' "zip" is breakable. A 4 character key |
1581 in about one hour, a 6 character key in one day (on a Pentium 133 PC). This | |
1582 requires that you know some text that must appear in the file. An expert | |
1583 can break it for any key. When the text has been decrypted, this also means | |
1584 that the key can be revealed, and other files encrypted with the same key | |
1585 can be decrypted. | |
1586 - Pkzip uses the same encryption as 'cryptmethod' "zip", and US Govt has no | |
1587 objection to its export. Pkzip's public file APPNOTE.TXT describes this | |
1588 algorithm in detail. | |
6259 | 1589 - The implementation of 'cryptmethod' "blowfish" has a flaw. It is possible |
1590 to crack the first 64 bytes of a file and in some circumstances more of the | |
6122 | 1591 file. Use of it is not recommended, but it's still the strongest method |
1592 supported by Vim 7.3 and 7.4. The "zip" method is even weaker. | |
7 | 1593 - Vim originates from the Netherlands. That is where the sources come from. |
1594 Thus the encryption code is not exported from the USA. | |
1595 | |
1596 ============================================================================== | |
1597 10. Timestamps *timestamp* *timestamps* | |
1598 | |
5908 | 1599 Vim remembers the modification timestamp, mode and size of a file when you |
1600 begin editing it. This is used to avoid that you have two different versions | |
1601 of the same file (without you knowing this). | |
7 | 1602 |
5908 | 1603 After a shell command is run (|:!cmd| |suspend| |:read!| |K|) timestamps, |
1604 file modes and file sizes are compared for all buffers in a window. Vim will | |
1605 run any associated |FileChangedShell| autocommands or display a warning for | |
1606 any files that have changed. In the GUI this happens when Vim regains input | |
1607 focus. | |
7 | 1608 |
1609 *E321* *E462* | |
1610 If you want to automatically reload a file when it has been changed outside of | |
1611 Vim, set the 'autoread' option. This doesn't work at the moment you write the | |
1612 file though, only when the file wasn't changed inside of Vim. | |
18186 | 1613 *ignore-timestamp* |
11400
0f8713fe20dc
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
11160
diff
changeset
|
1614 If you do not want to be asked or automatically reload the file, you can use |
0f8713fe20dc
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
11160
diff
changeset
|
1615 this: > |
0f8713fe20dc
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
11160
diff
changeset
|
1616 set buftype=nofile |
0f8713fe20dc
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
11160
diff
changeset
|
1617 |
0f8713fe20dc
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
11160
diff
changeset
|
1618 Or, when starting gvim from a shell: > |
0f8713fe20dc
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
11160
diff
changeset
|
1619 gvim file.log -c "set buftype=nofile" |
0f8713fe20dc
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
11160
diff
changeset
|
1620 |
7 | 1621 Note that if a FileChangedShell autocommand is defined you will not get a |
1622 warning message or prompt. The autocommand is expected to handle this. | |
1623 | |
139 | 1624 There is no warning for a directory (e.g., with |netrw-browse|). But you do |
1625 get warned if you started editing a new file and it was created as a directory | |
1626 later. | |
7 | 1627 |
1628 When Vim notices the timestamp of a file has changed, and the file is being | |
1629 edited in a buffer but has not changed, Vim checks if the contents of the file | |
1630 is equal. This is done by reading the file again (into a hidden buffer, which | |
1631 is immediately deleted again) and comparing the text. If the text is equal, | |
1632 you will get no warning. | |
1633 | |
1634 If you don't get warned often enough you can use the following command. | |
1635 | |
1636 *:checkt* *:checktime* | |
1637 :checkt[ime] Check if any buffers were changed outside of Vim. | |
1638 This checks and warns you if you would end up with two | |
1639 versions of a file. | |
1640 If this is called from an autocommand, a ":global" | |
1641 command or is not typed the actual check is postponed | |
1642 until a moment the side effects (reloading the file) | |
1643 would be harmless. | |
1644 Each loaded buffer is checked for its associated file | |
1645 being changed. If the file was changed Vim will take | |
1646 action. If there are no changes in the buffer and | |
1647 'autoread' is set, the buffer is reloaded. Otherwise, | |
1648 you are offered the choice of reloading the file. If | |
1649 the file was deleted you get an error message. | |
1650 If the file previously didn't exist you get a warning | |
1651 if it exists now. | |
1652 Once a file has been checked the timestamp is reset, | |
1653 you will not be warned again. | |
27635
6ca2d8f4cd32
patch 8.2.4343: when reloading not all properties are detected
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
1654 Syntax highlighting, marks, diff status, |
6ca2d8f4cd32
patch 8.2.4343: when reloading not all properties are detected
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
1655 'fileencoding', 'fileformat' and 'binary' options |
6ca2d8f4cd32
patch 8.2.4343: when reloading not all properties are detected
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
1656 are not changed. See |v:fcs_choice| to reload these |
6ca2d8f4cd32
patch 8.2.4343: when reloading not all properties are detected
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
1657 too (for example, if a code formatting tools has |
6ca2d8f4cd32
patch 8.2.4343: when reloading not all properties are detected
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
1658 changed the file). |
7 | 1659 |
1660 :[N]checkt[ime] {filename} | |
1661 :[N]checkt[ime] [N] | |
1662 Check the timestamp of a specific buffer. The buffer | |
1663 may be specified by name, number or with a pattern. | |
1664 | |
1665 | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1666 *E813* *E814* |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1667 Vim will reload the buffer if you chose to. If a window is visible that |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1668 contains this buffer, the reloading will happen in the context of this window. |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1669 Otherwise a special window is used, so that most autocommands will work. You |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1670 can't close this window. A few other restrictions apply. Best is to make |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1671 sure nothing happens outside of the current buffer. E.g., setting |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1672 window-local options may end up in the wrong window. Splitting the window, |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1673 doing something there and closing it should be OK (if there are no side |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1674 effects from other autocommands). Closing unrelated windows and buffers will |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1675 get you into trouble. |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1676 |
7 | 1677 Before writing a file the timestamp is checked. If it has changed, Vim will |
1678 ask if you really want to overwrite the file: | |
1679 | |
1680 WARNING: The file has been changed since reading it!!! | |
1681 Do you really want to write to it (y/n)? | |
1682 | |
1683 If you hit 'y' Vim will continue writing the file. If you hit 'n' the write is | |
1684 aborted. If you used ":wq" or "ZZ" Vim will not exit, you will get another | |
1685 chance to write the file. | |
1686 | |
1687 The message would normally mean that somebody has written to the file after | |
1688 the edit session started. This could be another person, in which case you | |
1689 probably want to check if your changes to the file and the changes from the | |
1690 other person should be merged. Write the file under another name and check for | |
1691 differences (the "diff" program can be used for this). | |
1692 | |
1693 It is also possible that you modified the file yourself, from another edit | |
1694 session or with another command (e.g., a filter command). Then you will know | |
1695 which version of the file you want to keep. | |
1696 | |
25973 | 1697 The accuracy of the time check depends on the filesystem. On Unix it is |
28517 | 1698 usually sub-second. With old file systems and on MS-Windows it is normally one |
27804 | 1699 second. Use `has('nanotime')` to check if sub-second time stamp checks are |
25973 | 1700 available. |
1701 | |
236 | 1702 There is one situation where you get the message while there is nothing wrong: |
1703 On a Win32 system on the day daylight saving time starts. There is something | |
1704 in the Win32 libraries that confuses Vim about the hour time difference. The | |
1705 problem goes away the next day. | |
1706 | |
39 | 1707 ============================================================================== |
1708 11. File Searching *file-searching* | |
1709 | |
1710 {not available when compiled without the |+path_extra| feature} | |
1711 | |
1712 The file searching is currently used for the 'path', 'cdpath' and 'tags' | |
1668 | 1713 options, for |finddir()| and |findfile()|. Other commands use |wildcards| |
1714 which is slightly different. | |
1121 | 1715 |
1716 There are three different types of searching: | |
39 | 1717 |
444 | 1718 1) Downward search: *starstar* |
39 | 1719 Downward search uses the wildcards '*', '**' and possibly others |
1668 | 1720 supported by your operating system. '*' and '**' are handled inside Vim, |
1721 so they work on all operating systems. Note that "**" only acts as a | |
1722 special wildcard when it is at the start of a name. | |
39 | 1723 |
1620 | 1724 The usage of '*' is quite simple: It matches 0 or more characters. In a |
1725 search pattern this would be ".*". Note that the "." is not used for file | |
1726 searching. | |
39 | 1727 |
1728 '**' is more sophisticated: | |
1729 - It ONLY matches directories. | |
1668 | 1730 - It matches up to 30 directories deep by default, so you can use it to |
1731 search an entire directory tree | |
39 | 1732 - The maximum number of levels matched can be given by appending a number |
1733 to '**'. | |
1734 Thus '/usr/**2' can match: > | |
1735 /usr | |
1736 /usr/include | |
1737 /usr/include/sys | |
1738 /usr/include/g++ | |
1739 /usr/lib | |
1740 /usr/lib/X11 | |
1741 .... | |
1742 < It does NOT match '/usr/include/g++/std' as this would be three | |
1743 levels. | |
1668 | 1744 The allowed number range is 0 ('**0' is removed) to 100 |
39 | 1745 If the given number is smaller than 0 it defaults to 30, if it's |
1668 | 1746 bigger than 100 then 100 is used. The system also has a limit on the |
1747 path length, usually 256 or 1024 bytes. | |
39 | 1748 - '**' can only be at the end of the path or be followed by a path |
1749 separator or by a number and a path separator. | |
1750 | |
1751 You can combine '*' and '**' in any order: > | |
1752 /usr/**/sys/* | |
1668 | 1753 /usr/*tory/sys/** |
39 | 1754 /usr/**2/sys/* |
1755 | |
1756 2) Upward search: | |
1757 Here you can give a directory and then search the directory tree upward for | |
236 | 1758 a file. You could give stop-directories to limit the upward search. The |
39 | 1759 stop-directories are appended to the path (for the 'path' option) or to |
236 | 1760 the filename (for the 'tags' option) with a ';'. If you want several |
1761 stop-directories separate them with ';'. If you want no stop-directory | |
39 | 1762 ("search upward till the root directory) just use ';'. > |
1763 /usr/include/sys;/usr | |
1764 < will search in: > | |
1765 /usr/include/sys | |
1766 /usr/include | |
1767 /usr | |
1768 < | |
1769 If you use a relative path the upward search is started in Vim's current | |
1770 directory or in the directory of the current file (if the relative path | |
1771 starts with './' and 'd' is not included in 'cpoptions'). | |
1772 | |
1773 If Vim's current path is /u/user_x/work/release and you do > | |
1774 :set path=include;/u/user_x | |
1775 < and then search for a file with |gf| the file is searched in: > | |
1776 /u/user_x/work/release/include | |
1777 /u/user_x/work/include | |
1778 /u/user_x/include | |
1779 | |
27036 | 1780 < Note: If your 'path' setting includes a non-existing directory, Vim will |
27537 | 1781 skip the non-existing directory, and also does not search in the parent of |
1782 the non-existing directory if upwards searching is used. | |
25364
af5c4fabcf40
patch 8.2.3219: :find searches non-existing directories
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
1783 |
236 | 1784 3) Combined up/downward search: |
39 | 1785 If Vim's current path is /u/user_x/work/release and you do > |
1786 set path=**;/u/user_x | |
1787 < and then search for a file with |gf| the file is searched in: > | |
1788 /u/user_x/work/release/** | |
1789 /u/user_x/work/** | |
1790 /u/user_x/** | |
1791 < | |
236 | 1792 BE CAREFUL! This might consume a lot of time, as the search of |
39 | 1793 '/u/user_x/**' includes '/u/user_x/work/**' and |
1794 '/u/user_x/work/release/**'. So '/u/user_x/work/release/**' is searched | |
236 | 1795 three times and '/u/user_x/work/**' is searched twice. |
39 | 1796 |
1797 In the above example you might want to set path to: > | |
1798 :set path=**,/u/user_x/** | |
2429
7ce8b24450dc
Improvements for ":find" completion. (Nazri Ramliy)
Bram Moolenaar <bram@vim.org>
parents:
2413
diff
changeset
|
1799 < This searches: |
7ce8b24450dc
Improvements for ":find" completion. (Nazri Ramliy)
Bram Moolenaar <bram@vim.org>
parents:
2413
diff
changeset
|
1800 /u/user_x/work/release/** ~ |
7ce8b24450dc
Improvements for ":find" completion. (Nazri Ramliy)
Bram Moolenaar <bram@vim.org>
parents:
2413
diff
changeset
|
1801 /u/user_x/** ~ |
7ce8b24450dc
Improvements for ":find" completion. (Nazri Ramliy)
Bram Moolenaar <bram@vim.org>
parents:
2413
diff
changeset
|
1802 This searches the same directories, but in a different order. |
39 | 1803 |
2429
7ce8b24450dc
Improvements for ":find" completion. (Nazri Ramliy)
Bram Moolenaar <bram@vim.org>
parents:
2413
diff
changeset
|
1804 Note that completion for ":find", ":sfind", and ":tabfind" commands do not |
11914 | 1805 currently work with 'path' items that contain a URL or use the double star |
3456 | 1806 with depth limiter (/usr/**2) or upward search (;) notations. |
7 | 1807 |
14421 | 1808 vim:tw=78:ts=8:noet:ft=help:norl: |