blob: c3e1d0d61bdf9f7dd63ac8763454a4f3d4e82884 [file] [log] [blame]
Bram Moolenaar76db9e02022-11-09 21:21:04 +00001*editing.txt* For Vim version 9.0. Last change: 2022 Nov 02
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Editing files *edit-files*
8
91. Introduction |edit-intro|
102. Editing a file |edit-a-file|
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000113. The argument list |argument-list|
124. Writing |writing|
135. Writing and quitting |write-quit|
146. Dialogs |edit-dialogs|
157. The current directory |current-directory|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000168. Editing binary files |edit-binary|
179. Encryption |encryption|
1810. Timestamps |timestamps|
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001911. File Searching |file-searching|
Bram Moolenaar071d4272004-06-13 20:20:40 +000020
21==============================================================================
221. Introduction *edit-intro*
23
24Editing a file with Vim means:
25
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000261. reading the file into a buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +0000272. changing the buffer with editor commands
283. writing the buffer into a file
29
30 *current-file*
31As long as you don't write the buffer, the original file remains unchanged.
32If you start editing a file (read a file into the buffer), the file name is
Bram Moolenaard4755bb2004-09-02 19:12:26 +000033remembered as the "current file name". This is also known as the name of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +000034current buffer. It can be used with "%" on the command line |:_%|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000035
36 *alternate-file*
37If there already was a current file name, then that one becomes the alternate
Bram Moolenaar1cd871b2004-12-19 22:46:22 +000038file name. It can be used with "#" on the command line |:_#| and you can use
39the |CTRL-^| command to toggle between the current and the alternate file.
40However, the alternate file name is not changed when |:keepalt| is used.
Bram Moolenaar36782082013-11-28 13:53:34 +010041An alternate file name is remembered for each window.
Bram Moolenaard4755bb2004-09-02 19:12:26 +000042
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
Bram Moolenaar25c9c682019-05-05 18:13:34 +020047 name.
Bram Moolenaard4755bb2004-09-02 19:12:26 +000048
Bram Moolenaar1cd871b2004-12-19 22:46:22 +000049All file names are remembered in the buffer list. When you enter a file name,
Bram Moolenaar402d2fe2005-04-15 21:00:38 +000050for editing (e.g., with ":e filename") or writing (e.g., with ":w filename"),
Bram Moolenaar1cd871b2004-12-19 22:46:22 +000051the file name is added to the list. You can use the buffer list to remember
52which files you edited and to quickly switch from one file to another (e.g.,
53to copy text) with the |CTRL-^| command. First type the number of the file
Bram Moolenaara6c27c42019-05-09 19:16:22 +020054and then hit CTRL-^.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +000055
Bram Moolenaar071d4272004-06-13 20:20:40 +000056
57CTRL-G or *CTRL-G* *:f* *:fi* *:file*
Bram Moolenaard9d30582005-05-18 22:10:28 +000058: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.
Bram Moolenaar071d4272004-06-13 20:20:40 +000063
Bram Moolenaar325b7a22004-07-05 15:58:32 +000064:f[ile]! like |:file|, but don't truncate the name even when
65 'shortmess' indicates this.
66
Bram Moolenaar071d4272004-06-13 20:20:40 +000067{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
Bram Moolenaar25c9c682019-05-05 18:13:34 +020069 buffer number is also given.
Bram Moolenaar071d4272004-06-13 20:20:40 +000070
71 *g_CTRL-G* *word-count* *byte-count*
Bram Moolenaar7c626922005-02-07 22:01:03 +000072g 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.
Bram Moolenaarcb80aa22020-10-26 21:12:46 +010076
Bram Moolenaar7c626922005-02-07 22:01:03 +000077 If there are characters in the line that take more
78 than one position on the screen (<Tab> or special
Bram Moolenaarcb80aa22020-10-26 21:12:46 +010079 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
Bram Moolenaared767a22016-01-03 22:49:16 +010084 Also see the 'ruler' option and the |wordcount()|
85 function.
Bram Moolenaar071d4272004-06-13 20:20:40 +000086
87 *v_g_CTRL-G*
Bram Moolenaar7c626922005-02-07 22:01:03 +000088{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
Bram Moolenaar071d4272004-06-13 20:20:40 +000092 {Visual} see |Visual-mode|.)
Bram Moolenaar071d4272004-06-13 20:20:40 +000093
94 *:file_f*
Bram Moolenaar325b7a22004-07-05 15:58:32 +000095:f[ile][!] {name} Sets the current file name to {name}. The optional !
96 avoids truncating the message, as with |:file|.
Bram Moolenaar7171abe2004-10-11 10:06:20 +000097 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.
Bram Moolenaar10de2da2005-01-27 14:33:00 +0000100 *:0file*
Bram Moolenaar325b7a22004-07-05 15:58:32 +0000101:0f[ile][!] Remove the name of the current buffer. The optional !
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200102 avoids truncating the message, as with |:file|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000103
104:buffers
105:files
106:ls List all the currently known file names. See
Bram Moolenaar30e9b3c2019-09-07 16:24:12 +0200107 |windows.txt| |:files| |:buffers| |:ls|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000108
109Vim will remember the full path name of a file name that you enter. In most
110cases when the file name is displayed only the name you typed is shown, but
111the full path name is being used if you used the ":cd" command |:cd|.
112
113 *home-replace*
114If the environment variable $HOME is set, and the file name starts with that
115string, it is often displayed with HOME replaced with "~". This was done to
116keep file names short. When reading or writing files the full name is still
117used, the "~" is only used when displaying file names. When replacing the
118file name would result in just "~", "~/" is used instead (to avoid confusion
Bram Moolenaar81695252004-12-29 20:58:21 +0000119between options set to $HOME with 'backupext' set to "~").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000120
121When writing the buffer, the default is to use the current file name. Thus
122when you give the "ZZ" or ":wq" command, the original file will be
123overwritten. If you do not want this, the buffer can be written into another
124file 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
131This will create a file "newfile", that is a modified copy of "testfile".
132The file "testfile" will remain unchanged. Anyway, if the 'backup' option is
133set, Vim renames or copies the original file before it will be overwritten.
134You can use this file if you discover that you need the original file. See
135also the 'patchmode' option. The name of the backup file is normally the same
136as the original file with 'backupext' appended. The default "~" is a bit
137strange to avoid accidentally overwriting existing files. If you prefer ".bak"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100138change the 'backupext' option. Extra dots are replaced with '_' on MS-Windows
Bram Moolenaar071d4272004-06-13 20:20:40 +0000139machines, 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
141backup file can be placed in another directory by setting 'backupdir'.
142
143 *auto-shortname*
144Technical: 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
157When you started editing without giving a file name, "No File" is displayed in
158messages. If the ":write" command is used with a file name argument, the file
159name for the current file is set to that file name. This only happens when
Bram Moolenaar2d3f4892006-01-20 23:02:51 +0000160the 'F' flag is included in 'cpoptions' (by default it is included) |cpo-F|.
161This is useful when entering text in an empty buffer and then writing it to a
162file. 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
164when starting Vim without an argument and then doing ":read file" to start
165editing a file.
166When the file name was set and 'filetype' is empty the filetype detection
167autocommands will be triggered.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000168 *not-edited*
169Because the file name was set without really starting to edit that file, you
170are 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"
172command. It will include "[Not edited]" when the "notedited" flag is set.
173When writing the buffer to the current file name (with ":w!"), the "notedited"
174flag is reset.
175
176 *abandon*
177Vim remembers whether you have changed the buffer. You are protected from
178losing the changes you made. If you try to quit without writing, or want to
179start editing another file, Vim will refuse this. In order to overrule this
180protection, add a '!' to the command. The changes will then be lost. For
181example: ":q" will not work if the buffer was changed, but ":q!" will. To see
182whether the buffer was changed use the "CTRL-G" command. The message includes
Bram Moolenaar2ec618c2016-10-01 14:47:05 +0200183the string "[Modified]" if the buffer has been changed, or "+" if the 'm' flag
184is in 'shortmess'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000185
186If you want to automatically save the changes without asking, switch on the
187'autowriteall' option. 'autowrite' is the associated Vi-compatible option
188that does not work for all commands.
189
190If you want to keep the changed buffer without saving it, switch on the
Bram Moolenaar9d98fe92013-08-03 18:35:36 +0200191'hidden' option. See |hidden-buffer|. Some commands work like this even when
192'hidden' is not set, check the help for the command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000193
194==============================================================================
1952. Editing a file *edit-a-file*
196
Bram Moolenaar9d98fe92013-08-03 18:35:36 +0200197 *:e* *:edit* *reload*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000198: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|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000204
Bram Moolenaar9d98fe92013-08-03 18:35:36 +0200205 *:edit!* *discard*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000206: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|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000211
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|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000219
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|.
Bram Moolenaar944697a2022-02-20 19:48:20 +0000225 *:edit_#* *:e#*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000226:e[dit] [++opt] [+cmd] #[count]
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000227 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.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000231 Also see |++opt| and |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000232
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.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000241
242 *:ene!* *:enew!*
243:ene[w]! Edit a new, unnamed buffer. Discard any changes to
244 the current buffer.
245 Set 'fileformat' like |:enew|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000246
247 *:fin* *:find*
248:fin[d][!] [++opt] [+cmd] {file}
249 Find {file} in 'path' and then |:edit| it.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000250
251:{count}fin[d][!] [++opt] [+cmd] {file}
252 Just like ":find", but use the {count} match in
253 'path'. Thus ":2find file" will find the second
254 "file" found in 'path'. When there are fewer matches
255 for the file in 'path' than asked for, you get an
256 error message.
257
258 *:ex*
259:ex [++opt] [+cmd] [file]
260 Same as |:edit|.
261
262 *:vi* *:visual*
263:vi[sual][!] [++opt] [+cmd] [file]
Bram Moolenaar81695252004-12-29 20:58:21 +0000264 When used in Ex mode: Leave |Ex-mode|, go back to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000265 Normal mode. Otherwise same as |:edit|.
266
267 *:vie* *:view*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100268:vie[w][!] [++opt] [+cmd] file
Bram Moolenaar036986f2017-03-16 17:41:02 +0100269 When used in Ex mode: Leave |Ex-mode|, go back to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000270 Normal mode. Otherwise same as |:edit|, but set
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200271 'readonly' option for this buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000272
273 *CTRL-^* *CTRL-6*
Bram Moolenaar662db672011-03-22 14:05:35 +0100274CTRL-^ Edit the alternate file. Mostly the alternate file is
275 the previously edited file. This is a quick way to
276 toggle between two files. It is equivalent to ":e #",
277 except that it also works when there is no file name.
278
Bram Moolenaar071d4272004-06-13 20:20:40 +0000279 If the 'autowrite' or 'autowriteall' option is on and
280 the buffer was changed, write it.
281 Mostly the ^ character is positioned on the 6 key,
282 pressing CTRL and 6 then gets you what we call CTRL-^.
283 But on some non-US keyboards CTRL-^ is produced in
284 another way.
285
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000286{count}CTRL-^ Edit [count]th file in the buffer list (equivalent to
287 ":e #[count]"). This is a quick way to switch between
288 files.
289 See |CTRL-^| above for further details.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000290
Bram Moolenaar071d4272004-06-13 20:20:40 +0000291[count]]f *]f* *[f*
292[count][f Same as "gf". Deprecated.
293
294 *gf* *E446* *E447*
295[count]gf Edit the file whose name is under or after the cursor.
296 Mnemonic: "goto file".
297 Uses the 'isfname' option to find out which characters
298 are supposed to be in a file name. Trailing
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100299 punctuation characters ".,:;!" are ignored. Escaped
300 spaces "\ " are reduced to a single space.
Bram Moolenaarc236c162008-07-13 17:41:49 +0000301 Uses the 'path' option as a list of directory names to
302 look for the file. See the 'path' option for details
303 about relative directories and wildcards.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000304 Uses the 'suffixesadd' option to check for file names
305 with a suffix added.
306 If the file can't be found, 'includeexpr' is used to
307 modify the name and another attempt is done.
308 If a [count] is given, the count'th file that is found
309 in the 'path' is edited.
310 This command fails if Vim refuses to |abandon| the
311 current file.
Bram Moolenaar8dff8182006-04-06 20:18:50 +0000312 If you want to edit the file in a new window use
313 |CTRL-W_CTRL-F|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000314 If you do want to edit a new file, use: >
315 :e <cfile>
316< To make gf always work like that: >
317 :map gf :e <cfile><CR>
318< If the name is a hypertext link, that looks like
319 "type://machine/path", you need the |netrw| plugin.
320 For Unix the '~' character is expanded, like in
321 "~user/file". Environment variables are expanded too
322 |expand-env|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000323
324 *v_gf*
325{Visual}[count]gf Same as "gf", but the highlighted text is used as the
326 name of the file to edit. 'isfname' is ignored.
327 Leading blanks are skipped, otherwise all blanks and
328 special characters are included in the file name.
329 (For {Visual} see |Visual-mode|.)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000330
Bram Moolenaard1f56e62006-02-22 21:25:37 +0000331 *gF*
332[count]gF Same as "gf", except if a number follows the file
333 name, then the cursor is positioned on that line in
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100334 the file.
335 The file name and the number must be separated by a
336 non-filename (see 'isfname') and non-numeric
337 character. " line " is also recognized, like it is
338 used in the output of `:verbose command UserCmd`
339 White space between the filename, the separator and
340 the number are ignored.
Bram Moolenaard8fc5c02006-04-29 21:55:22 +0000341 Examples:
342 eval.c:10 ~
343 eval.c @ 20 ~
344 eval.c (30) ~
345 eval.c 40 ~
346
Bram Moolenaard1f56e62006-02-22 21:25:37 +0000347 *v_gF*
348{Visual}[count]gF Same as "v_gf".
349
Bram Moolenaar071d4272004-06-13 20:20:40 +0000350These commands are used to start editing a single file. This means that the
351file is read into the buffer and the current file name is set. The file that
352is opened depends on the current directory, see |:cd|.
353
354See |read-messages| for an explanation of the message that is given after the
355file has been read.
356
357You can use the ":e!" command if you messed up the buffer and want to start
358all over again. The ":e" command is only useful if you have changed the
359current file name.
360
361 *:filename* *{file}*
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000362Besides the things mentioned here, more special items for where a filename is
363expected are mentioned at |cmdline-special|.
364
Bram Moolenaarc236c162008-07-13 17:41:49 +0000365Note for systems other than Unix: When using a command that accepts a single
366file name (like ":edit file") spaces in the file name are allowed, but
367trailing spaces are ignored. This is useful on systems that regularly embed
368spaces in file names (like MS-Windows and the Amiga). Example: The command
369":e Long File Name " will edit the file "Long File Name". When using a
370command that accepts more than one file name (like ":next file1 file2")
371embedded spaces must be escaped with a backslash.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000372
Bram Moolenaar9964e462007-05-05 17:54:07 +0000373 *wildcard* *wildcards*
Bram Moolenaar30b65812012-07-12 22:01:11 +0200374Wildcards in {file} are expanded, but as with file completion, 'wildignore'
375and 'suffixes' apply. Which wildcards are supported depends on the system.
376These are the common ones:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000377 ? matches one character
Bram Moolenaar02743632005-07-25 20:42:36 +0000378 * matches anything, including nothing
379 ** matches anything, including nothing, recurses into directories
Bram Moolenaar071d4272004-06-13 20:20:40 +0000380 [abc] match 'a', 'b' or 'c'
Bram Moolenaar02743632005-07-25 20:42:36 +0000381
Bram Moolenaar071d4272004-06-13 20:20:40 +0000382To avoid the special meaning of the wildcards prepend a backslash. However,
383on MS-Windows the backslash is a path separator and "path\[abc]" is still seen
384as a wildcard when "[" is in the 'isfname' option. A simple way to avoid this
Bram Moolenaar7db8f6f2016-03-29 23:12:46 +0200385is to use "path\[[]abc]", this matches the file "path\[abc]".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000386
Bram Moolenaar02743632005-07-25 20:42:36 +0000387 *starstar-wildcard*
Bram Moolenaar944697a2022-02-20 19:48:20 +0000388Expanding "**" is possible on Unix, Win32, macOS and a few other systems.
Bram Moolenaar02743632005-07-25 20:42:36 +0000389This allows searching a directory tree. This goes up to 100 directories deep.
Bram Moolenaar9b451252012-08-15 17:43:31 +0200390Note there are some commands where this works slightly differently, see
Bram Moolenaarc236c162008-07-13 17:41:49 +0000391|file-searching|.
Bram Moolenaar02743632005-07-25 20:42:36 +0000392Example: >
393 :n **/*.txt
394Finds files:
Bram Moolenaar38a55632016-02-15 22:07:32 +0100395 aaa.txt ~
396 subdir/bbb.txt ~
397 a/b/c/d/ccc.txt ~
398When non-wildcard characters are used right before or after "**" these are
399only matched in the top directory. They are not used for directories further
400down in the tree. For example: >
401 :n /usr/inc**/types.h
Bram Moolenaar02743632005-07-25 20:42:36 +0000402Finds files:
Bram Moolenaar38a55632016-02-15 22:07:32 +0100403 /usr/include/types.h ~
404 /usr/include/sys/types.h ~
405 /usr/inc/old/types.h ~
406Note that the path with "/sys" is included because it does not need to match
407"/inc". Thus it's like matching "/usr/inc*/*/*...", not
408"/usr/inc*/inc*/inc*".
409
Bram Moolenaar071d4272004-06-13 20:20:40 +0000410 *backtick-expansion* *`-expansion*
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200411On Unix and a few other systems you can also use backticks for the file name
412argument, for example: >
413 :next `find . -name ver\\*.c -print`
Bram Moolenaar88774fd2015-08-25 19:52:04 +0200414 :view `ls -t *.patch \| head -n1`
Bram Moolenaarab943432018-03-29 18:27:07 +0200415Vim will run the command in backticks using the 'shell' and use the standard
416output as argument for the given Vim command (error messages from the shell
417command will be discarded).
418To see what shell command Vim is running, set the 'verbose' option to 4. When
419the shell command returns a non-zero exit code, an error message will be
420displayed and the Vim command will be aborted. To avoid this make the shell
421always return zero like so: >
422 :next `find . -name ver\\*.c -print \|\| true`
423
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200424The backslashes before the star are required to prevent the shell from
425expanding "ver*.c" prior to execution of the find program. The backslash
426before the shell pipe symbol "|" prevents Vim from parsing it as command
427termination.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000428This also works for most other systems, with the restriction that the
429backticks must be around the whole item. It is not possible to have text
430directly before the first or just after the last backtick.
431
Bram Moolenaar6f4754b2022-01-23 12:07:04 +0000432 *`=* *E1083*
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200433You can have the backticks expanded as a Vim expression, instead of as an
434external command, by putting an equal sign right after the first backtick,
435e.g.: >
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000436 :e `=tempname()`
437The expression can contain just about anything, thus this can also be used to
Bram Moolenaar30b65812012-07-12 22:01:11 +0200438avoid the special meaning of '"', '|', '%' and '#'. However, 'wildignore'
Bram Moolenaar00154502013-02-13 16:15:55 +0100439does apply like to other wildcards.
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200440
Bram Moolenaar88774fd2015-08-25 19:52:04 +0200441Environment variables in the expression are expanded when evaluating the
442expression, thus this works: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +0000443 :e `=$HOME .. '/.vimrc'`
Bram Moolenaar75ab5902022-04-18 15:36:40 +0100444This uses $HOME inside a string and it will be used literally, most likely not
445what you intended: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +0000446 :e `='$HOME' .. '/.vimrc'`
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200447
Bram Moolenaar30b65812012-07-12 22:01:11 +0200448If the expression returns a string then names are to be separated with line
449breaks. When the result is a |List| then each item is used as a name. Line
450breaks also separate names.
Bram Moolenaarf9132812015-07-21 19:19:13 +0200451Note that such expressions are only supported in places where a filename is
452expected as an argument to an Ex-command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000453
454 *++opt* *[++opt]*
Bram Moolenaarb0bf8582005-12-13 20:02:15 +0000455The [++opt] argument can be used to force the value of 'fileformat',
456'fileencoding' or 'binary' to a value for one command, and to specify the
457behavior for bad characters. The form is: >
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000458 ++{optname}
459Or: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000460 ++{optname}={value}
461
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000462Where {optname} is one of: *++ff* *++enc* *++bin* *++nobin* *++edit*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000463 ff or fileformat overrides 'fileformat'
464 enc or encoding overrides 'fileencoding'
465 bin or binary sets 'binary'
466 nobin or nobinary resets 'binary'
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000467 bad specifies behavior for bad characters
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000468 edit for |:read| only: keep option values as if editing
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000469 a file
Bram Moolenaar071d4272004-06-13 20:20:40 +0000470
471{value} cannot contain white space. It can be any valid value for these
472options. Examples: >
473 :e ++ff=unix
474This edits the same file again with 'fileformat' set to "unix". >
475
476 :w ++enc=latin1 newfile
477This writes the current buffer to "newfile" in latin1 format.
478
Bram Moolenaar47e13952020-05-12 22:49:12 +0200479The message given when writing a file will show "[converted]" when
480'fileencoding' or the value specified with ++enc differs from 'encoding'.
481
Bram Moolenaarb0bf8582005-12-13 20:02:15 +0000482There may be several ++opt arguments, separated by white space. They must all
483appear before any |+cmd| argument.
484
485 *++bad*
486The argument of "++bad=" specifies what happens with characters that can't be
487converted and illegal bytes. It can be one of three things:
488 ++bad=X A single-byte character that replaces each bad character.
489 ++bad=keep Keep bad characters without conversion. Note that this may
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000490 result in illegal bytes in your text!
Bram Moolenaarb0bf8582005-12-13 20:02:15 +0000491 ++bad=drop Remove the bad characters.
492
493The default is like "++bad=?": Replace each bad character with a question
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100494mark. In some places an inverted question mark is used (0xBF).
495
496Note that not all commands use the ++bad argument, even though they do not
497give an error when you add it. E.g. |:write|.
Bram Moolenaarb0bf8582005-12-13 20:02:15 +0000498
Bram Moolenaar071d4272004-06-13 20:20:40 +0000499Note that when reading, the 'fileformat' and 'fileencoding' options will be
500set to the used format. When writing this doesn't happen, thus a next write
501will use the old value of the option. Same for the 'binary' option.
502
Bram Moolenaar071d4272004-06-13 20:20:40 +0000503
504 *+cmd* *[+cmd]*
505The [+cmd] argument can be used to position the cursor in the newly opened
506file, or execute any other command:
507 + Start at the last line.
508 +{num} Start at line {num}.
509 +/{pat} Start at first line containing {pat}.
510 +{command} Execute {command} after opening the new file.
511 {command} is any Ex command.
512To include a white space in the {pat} or {command}, precede it with a
513backslash. Double the number of backslashes. >
514 :edit +/The\ book file
515 :edit +/dir\ dirname\\ file
516 :edit +set\ dir=c:\\\\temp file
517Note that in the last example the number of backslashes is halved twice: Once
518for the "+cmd" argument and once for the ":set" command.
519
520 *file-formats*
521The 'fileformat' option sets the <EOL> style for a file:
522'fileformat' characters name ~
523 "dos" <CR><NL> or <NL> DOS format *DOS-format*
524 "unix" <NL> Unix format *Unix-format*
525 "mac" <CR> Mac format *Mac-format*
526Previously 'textmode' was used. It is obsolete now.
527
528When reading a file, the mentioned characters are interpreted as the <EOL>.
Bram Moolenaar6f345a12019-12-17 21:27:18 +0100529In DOS format (default for Win32), <CR><NL> and <NL> are both interpreted as
530the <EOL>. Note that when writing the file in DOS format, <CR> characters
531will be added for each single <NL>. Also see |file-read|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000532
533When writing a file, the mentioned characters are used for <EOL>. For DOS
534format <CR><NL> is used. Also see |DOS-format-write|.
535
536You can read a file in DOS format and write it in Unix format. This will
537replace all <CR><NL> pairs by <NL> (assuming 'fileformats' includes "dos"): >
538 :e file
539 :set fileformat=unix
540 :w
541If you read a file in Unix format and write with DOS format, all <NL>
542characters will be replaced with <CR><NL> (assuming 'fileformats' includes
543"unix"): >
544 :e file
545 :set fileformat=dos
546 :w
547
548If you start editing a new file and the 'fileformats' option is not empty
549(which is the default), Vim will try to detect whether the lines in the file
550are separated by the specified formats. When set to "unix,dos", Vim will
551check for lines with a single <NL> (as used on Unix and Amiga) or by a <CR>
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100552<NL> pair (MS-Windows). Only when ALL lines end in <CR><NL>, 'fileformat' is
553set to "dos", otherwise it is set to "unix". When 'fileformats' includes
554"mac", and no <NL> characters are found in the file, 'fileformat' is set to
555"mac".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000556
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100557If the 'fileformat' option is set to "dos" on non-MS-Windows systems the
558message "[dos format]" is shown to remind you that something unusual is
559happening. On MS-Windows systems you get the message "[unix format]" if
560'fileformat' is set to "unix". On all systems but the Macintosh you get the
561message "[mac format]" if 'fileformat' is set to "mac".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000562
563If the 'fileformats' option is empty and DOS format is used, but while reading
564a file some lines did not end in <CR><NL>, "[CR missing]" will be included in
565the file message.
566If the 'fileformats' option is empty and Mac format is used, but while reading
567a file a <NL> was found, "[NL missing]" will be included in the file message.
568
569If the new file does not exist, the 'fileformat' of the current buffer is used
570when 'fileformats' is empty. Otherwise the first format from 'fileformats' is
571used for the new file.
572
573Before editing binary, executable or Vim script files you should set the
574'binary' option. A simple way to do this is by starting Vim with the "-b"
575option. This will avoid the use of 'fileformat'. Without this you risk that
576single <NL> characters are unexpectedly replaced with <CR><NL>.
577
578You can encrypt files that are written by setting the 'key' option. This
579provides some security against others reading your files. |encryption|
580
K.Takata3af98212022-11-01 20:36:19 +0000581END OF LINE AND END OF FILE *eol-and-eof*
582
583Vim has several options to control the file format:
584 'fileformat' the <EOL> style: Unix, DOS, Mac
585 'endofline' whether the last line ends with a <EOL>
Bram Moolenaar76db9e02022-11-09 21:21:04 +0000586 'endoffile' whether the file ends with a CTRL-Z
K.Takata3af98212022-11-01 20:36:19 +0000587 'fixendofline' whether to fix eol and eof
588
589The first three values are normally detected automatically when reading the
590file and are used when writing the text to a file. While editing the buffer
591it looks like every line has a line ending and the CTRL-Z isn't there (an
592exception is when 'binary' is set, it works differently then).
593
594The 'fixendofline' option can be used to choose what to write. You can also
595change the option values to write the file differently than how it was read.
596
597Here are some examples how to use them.
598
599If you want files in Unix format (every line NL terminated): >
600 setl ff=unix fixeol
601You should probably do this on any Unix-like system. Also modern MS-Windows
602systems tend to work well with this. It is recommended to always use this
603format for Vim scripts.
604
605If you want to use an old MS-DOS file in a modern environment, fixing line
606endings and dropping CTRL-Z, but keeping the <CR><NL> style <EOL>: >
607 setl ff=dos fixeol
608This is useful for many MS-Windows programs, they regularly expect the
609<CR><NL> line endings.
610
611If you want to drop the final <EOL> and add a final CTRL-Z (e.g. for an old
612system like CP/M): >
613 setl ff=dos nofixeol noeol eof
614
615If you want to preserve the fileformat exactly as-is, including any final
616<EOL> and final CTRL-Z: >
617 setl nofixeol
Bram Moolenaar071d4272004-06-13 20:20:40 +0000618
Bram Moolenaar071d4272004-06-13 20:20:40 +0000619==============================================================================
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00006203. The argument list *argument-list* *arglist*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000621
622If you give more than one file name when starting Vim, this list is remembered
623as the argument list. You can jump to each file in this list.
624
625Do not confuse this with the buffer list, which you can see with the
626|:buffers| command. The argument list was already present in Vi, the buffer
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000627list is new in Vim. Every file name in the argument list will also be present
628in the buffer list (unless it was deleted with |:bdel| or |:bwipe|). But it's
629common that names in the buffer list are not in the argument list.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000630
631This subject is introduced in section |07.2| of the user manual.
632
633There is one global argument list, which is used for all windows by default.
634It is possible to create a new argument list local to a window, see
635|:arglocal|.
636
637You can use the argument list with the following commands, and with the
638expression functions |argc()| and |argv()|. These all work on the argument
639list of the current window.
640
Bram Moolenaar12ee7ff2019-06-10 22:47:40 +0200641 *:ar* *:arg* *:args*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000642:ar[gs] Print the argument list, with the current file in
643 square brackets.
644
645:ar[gs] [++opt] [+cmd] {arglist} *:args_f*
646 Define {arglist} as the new argument list and edit
647 the first one. This fails when changes have been made
648 and Vim does not want to |abandon| the current buffer.
649 Also see |++opt| and |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000650
651:ar[gs]! [++opt] [+cmd] {arglist} *:args_f!*
652 Define {arglist} as the new argument list and edit
653 the first one. Discard any changes to the current
654 buffer.
655 Also see |++opt| and |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000656
Bram Moolenaar90305c62017-07-16 15:31:17 +0200657:[count]arge[dit][!] [++opt] [+cmd] {name} .. *:arge* *:argedit*
658 Add {name}s to the argument list and edit it.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000659 When {name} already exists in the argument list, this
660 entry is edited.
661 This is like using |:argadd| and then |:edit|.
Bram Moolenaar90305c62017-07-16 15:31:17 +0200662 Spaces in filenames have to be escaped with "\".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000663 [count] is used like with |:argadd|.
Bram Moolenaar90305c62017-07-16 15:31:17 +0200664 If the current file cannot be |abandon|ed {name}s will
665 still be added to the argument list, but won't be
666 edited. No check for duplicates is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000667 Also see |++opt| and |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000668
669:[count]arga[dd] {name} .. *:arga* *:argadd* *E479*
Bram Moolenaara2baa732022-02-04 16:09:54 +0000670:[count]arga[dd] *E1156*
Bram Moolenaar91e15e12014-09-19 22:38:48 +0200671 Add the {name}s to the argument list. When {name} is
Bram Moolenaared32d942014-12-06 23:33:00 +0100672 omitted add the current buffer name to the argument
Bram Moolenaar91e15e12014-09-19 22:38:48 +0200673 list.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000674 If [count] is omitted, the {name}s are added just
675 after the current entry in the argument list.
676 Otherwise they are added after the [count]'th file.
677 If the argument list is "a b c", and "b" is the
678 current argument, then these commands result in:
679 command new argument list ~
680 :argadd x a b x c
681 :0argadd x x a b c
682 :1argadd x a x b c
Bram Moolenaared32d942014-12-06 23:33:00 +0100683 :$argadd x a b c x
Bram Moolenaar85084ef2016-01-17 22:26:33 +0100684 And after the last one:
Bram Moolenaared32d942014-12-06 23:33:00 +0100685 :+2argadd y a b c x y
Bram Moolenaar071d4272004-06-13 20:20:40 +0000686 There is no check for duplicates, it is possible to
Nir Lichtman73a02422021-12-24 20:28:03 +0000687 add a file to the argument list twice. You can use
688 |:argdedupe| to fix it afterwards: >
689 :argadd *.txt | argdedupe
690< The currently edited file is not changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000691 Note: you can also use this method: >
692 :args ## x
693< This will add the "x" item and sort the new list.
694
Nir Lichtman73a02422021-12-24 20:28:03 +0000695:argded[upe] *:argded* *:argdedupe*
696 Remove duplicate filenames from the argument list.
697 If your current file is a duplicate, your current file
698 will change to the original file index.
699
Bram Moolenaar207f0092020-08-30 17:20:20 +0200700:argd[elete] {pattern} .. *:argd* *:argdelete* *E480* *E610*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000701 Delete files from the argument list that match the
702 {pattern}s. {pattern} is used like a file pattern,
703 see |file-pattern|. "%" can be used to delete the
704 current entry.
705 This command keeps the currently edited file, also
706 when it's deleted from the argument list.
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +0000707 Example: >
708 :argdel *.obj
Bram Moolenaar071d4272004-06-13 20:20:40 +0000709
Bram Moolenaar207f0092020-08-30 17:20:20 +0200710:[range]argd[elete] Delete the [range] files from the argument list.
Bram Moolenaared32d942014-12-06 23:33:00 +0100711 Example: >
712 :10,$argdel
713< Deletes arguments 10 and further, keeping 1-9. >
714 :$argd
715< Deletes just the last one. >
716 :argd
717 :.argd
718< Deletes the current argument. >
719 :%argd
720< Removes all the files from the arglist.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000721 When the last number in the range is too high, up to
Bram Moolenaared32d942014-12-06 23:33:00 +0100722 the last argument is deleted.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000723
724 *:argu* *:argument*
725:[count]argu[ment] [count] [++opt] [+cmd]
726 Edit file [count] in the argument list. When [count]
727 is omitted the current entry is used. This fails
728 when changes have been made and Vim does not want to
729 |abandon| the current buffer.
730 Also see |++opt| and |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000731
732:[count]argu[ment]! [count] [++opt] [+cmd]
733 Edit file [count] in the argument list, discard any
734 changes to the current buffer. When [count] is
735 omitted the current entry is used.
736 Also see |++opt| and |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000737
738:[count]n[ext] [++opt] [+cmd] *:n* *:ne* *:next* *E165* *E163*
739 Edit [count] next file. This fails when changes have
740 been made and Vim does not want to |abandon| the
Bram Moolenaara6c27c42019-05-09 19:16:22 +0200741 current buffer. Also see |++opt| and |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000742
743:[count]n[ext]! [++opt] [+cmd]
744 Edit [count] next file, discard any changes to the
Bram Moolenaara6c27c42019-05-09 19:16:22 +0200745 buffer. Also see |++opt| and |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000746
747:n[ext] [++opt] [+cmd] {arglist} *:next_f*
748 Same as |:args_f|.
749
750:n[ext]! [++opt] [+cmd] {arglist}
751 Same as |:args_f!|.
752
753:[count]N[ext] [count] [++opt] [+cmd] *:Next* *:N* *E164*
754 Edit [count] previous file in argument list. This
755 fails when changes have been made and Vim does not
756 want to |abandon| the current buffer.
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200757 Also see |++opt| and |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000758
759:[count]N[ext]! [count] [++opt] [+cmd]
760 Edit [count] previous file in argument list. Discard
761 any changes to the buffer. Also see |++opt| and
Bram Moolenaara6c27c42019-05-09 19:16:22 +0200762 |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000763
764:[count]prev[ious] [count] [++opt] [+cmd] *:prev* *:previous*
Bram Moolenaara6c27c42019-05-09 19:16:22 +0200765 Same as :Next. Also see |++opt| and |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000766
767 *:rew* *:rewind*
768:rew[ind] [++opt] [+cmd]
769 Start editing the first file in the argument list.
770 This fails when changes have been made and Vim does
771 not want to |abandon| the current buffer.
Bram Moolenaara6c27c42019-05-09 19:16:22 +0200772 Also see |++opt| and |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000773
774:rew[ind]! [++opt] [+cmd]
775 Start editing the first file in the argument list.
776 Discard any changes to the buffer. Also see |++opt|
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200777 and |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000778
779 *:fir* *:first*
780:fir[st][!] [++opt] [+cmd]
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200781 Other name for ":rewind".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000782
783 *:la* *:last*
784:la[st] [++opt] [+cmd]
785 Start editing the last file in the argument list.
786 This fails when changes have been made and Vim does
787 not want to |abandon| the current buffer.
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200788 Also see |++opt| and |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000789
790:la[st]! [++opt] [+cmd]
791 Start editing the last file in the argument list.
792 Discard any changes to the buffer. Also see |++opt|
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200793 and |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000794
795 *:wn* *:wnext*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000796:[count]wn[ext] [++opt]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000797 Write current file and start editing the [count]
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200798 next file. Also see |++opt| and |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000799
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000800:[count]wn[ext] [++opt] {file}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000801 Write current file to {file} and start editing the
802 [count] next file, unless {file} already exists and
803 the 'writeany' option is off. Also see |++opt| and
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200804 |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000805
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000806:[count]wn[ext]! [++opt] {file}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000807 Write current file to {file} and start editing the
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200808 [count] next file. Also see |++opt| and |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000809
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000810:[count]wN[ext][!] [++opt] [file] *:wN* *:wNext*
811:[count]wp[revious][!] [++opt] [file] *:wp* *:wprevious*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000812 Same as :wnext, but go to previous file instead of
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200813 next.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000814
815The [count] in the commands above defaults to one. For some commands it is
816possible to use two counts. The last one (rightmost one) is used.
817
818If no [+cmd] argument is present, the cursor is positioned at the last known
819cursor position for the file. If 'startofline' is set, the cursor will be
820positioned at the first non-blank in the line, otherwise the last know column
821is used. If there is no last known cursor position the cursor will be in the
822first line (the last line in Ex mode).
823
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000824 *{arglist}*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000825The wildcards in the argument list are expanded and the file names are sorted.
826Thus you can use the command "vim *.c" to edit all the C files. From within
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000827Vim the command ":n *.c" does the same.
828
829White space is used to separate file names. Put a backslash before a space or
Bram Moolenaar9e368db2007-05-12 13:25:01 +0000830tab to include it in a file name. E.g., to edit the single file "foo bar": >
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000831 :next foo\ bar
832
833On Unix and a few other systems you can also use backticks, for example: >
834 :next `find . -name \\*.c -print`
Bram Moolenaar071d4272004-06-13 20:20:40 +0000835The backslashes before the star are required to prevent "*.c" to be expanded
836by the shell before executing the find program.
837
838 *arglist-position*
839When there is an argument list you can see which file you are editing in the
840title of the window (if there is one and 'title' is on) and with the file
841message you get with the "CTRL-G" command. You will see something like
842 (file 4 of 11)
843If 'shortmess' contains 'f' it will be
844 (4 of 11)
845If you are not really editing the file at the current position in the argument
846list it will be
847 (file (4) of 11)
848This means that you are position 4 in the argument list, but not editing the
849fourth file in the argument list. This happens when you do ":e file".
850
851
852LOCAL ARGUMENT LIST
853
Bram Moolenaar071d4272004-06-13 20:20:40 +0000854 *:arglocal*
855:argl[ocal] Make a local copy of the global argument list.
856 Doesn't start editing another file.
857
858:argl[ocal][!] [++opt] [+cmd] {arglist}
859 Define a new argument list, which is local to the
860 current window. Works like |:args_f| otherwise.
861
862 *:argglobal*
863:argg[lobal] Use the global argument list for the current window.
864 Doesn't start editing another file.
865
866:argg[lobal][!] [++opt] [+cmd] {arglist}
867 Use the global argument list for the current window.
868 Define a new global argument list like |:args_f|.
869 All windows using the global argument list will see
870 this new list.
871
872There can be several argument lists. They can be shared between windows.
873When they are shared, changing the argument list in one window will also
874change it in the other window.
875
876When a window is split the new window inherits the argument list from the
877current window. The two windows then share this list, until one of them uses
878|:arglocal| or |:argglobal| to use another argument list.
879
880
881USING THE ARGUMENT LIST
882
883 *:argdo*
Bram Moolenaara162bc52015-01-07 16:54:21 +0100884:[range]argdo[!] {cmd} Execute {cmd} for each file in the argument list or
885 if [range] is specified only for arguments in that
886 range. It works like doing this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000887 :rewind
888 :{cmd}
889 :next
890 :{cmd}
891 etc.
892< When the current file can't be |abandon|ed and the [!]
893 is not present, the command fails.
894 When an error is detected on one file, further files
895 in the argument list will not be visited.
896 The last file in the argument list (or where an error
897 occurred) becomes the current file.
898 {cmd} can contain '|' to concatenate several commands.
899 {cmd} must not change the argument list.
900 Note: While this command is executing, the Syntax
901 autocommand event is disabled by adding it to
902 'eventignore'. This considerably speeds up editing
903 each file.
Bram Moolenaaraa23b372015-09-08 18:46:31 +0200904 Also see |:windo|, |:tabdo|, |:bufdo|, |:cdo|, |:ldo|,
905 |:cfdo| and |:lfdo|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000906
907Example: >
908 :args *.c
909 :argdo set ff=unix | update
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100910This sets the 'fileformat' option to "unix" and writes the file if it is now
Bram Moolenaar071d4272004-06-13 20:20:40 +0000911changed. This is done for all *.c files.
912
913Example: >
914 :args *.[ch]
915 :argdo %s/\<my_foo\>/My_Foo/ge | update
916This changes the word "my_foo" to "My_Foo" in all *.c and *.h files. The "e"
917flag is used for the ":substitute" command to avoid an error for files where
918"my_foo" isn't used. ":update" writes the file only if changes were made.
919
920==============================================================================
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00009214. Writing *writing* *save-file*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000922
923Note: When the 'write' option is off, you are not able to write any file.
924
925 *:w* *:write*
Bram Moolenaar6dc819b2018-07-03 16:42:19 +0200926 *E502* *E503* *E504* *E505*
Bram Moolenaar6f4754b2022-01-23 12:07:04 +0000927 *E512* *E514* *E667* *E949*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000928:w[rite] [++opt] Write the whole buffer to the current file. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000929 the normal way to save changes to a file. It fails
930 when the 'readonly' option is set or when there is
931 another reason why the file can't be written.
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000932 For ++opt see |++opt|, but only ++bin, ++nobin, ++ff
933 and ++enc are effective.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000934
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000935:w[rite]! [++opt] Like ":write", but forcefully write when 'readonly' is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000936 set or there is another reason why writing was
937 refused.
938 Note: This may change the permission and ownership of
939 the file and break (symbolic) links. Add the 'W' flag
940 to 'cpoptions' to avoid this.
941
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000942:[range]w[rite][!] [++opt]
943 Write the specified lines to the current file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000944 is unusual, because the file will not contain all
945 lines in the buffer.
946
947 *:w_f* *:write_f*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000948:[range]w[rite] [++opt] {file}
949 Write the specified lines to {file}, unless it
Bram Moolenaar071d4272004-06-13 20:20:40 +0000950 already exists and the 'writeany' option is off.
951
952 *:w!*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000953:[range]w[rite]! [++opt] {file}
954 Write the specified lines to {file}. Overwrite an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000955 existing file.
956
957 *:w_a* *:write_a* *E494*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000958:[range]w[rite][!] [++opt] >>
959 Append the specified lines to the current file.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000960
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000961:[range]w[rite][!] [++opt] >> {file}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000962 Append the specified lines to {file}. '!' forces the
963 write even if file does not exist.
964
965 *:w_c* *:write_c*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000966:[range]w[rite] [++opt] !{cmd}
967 Execute {cmd} with [range] lines as standard input
Bram Moolenaar071d4272004-06-13 20:20:40 +0000968 (note the space in front of the '!'). {cmd} is
969 executed like with ":!{cmd}", any '!' is replaced with
970 the previous command |:!|.
971
Bram Moolenaar5c4e21c2004-10-12 19:54:52 +0000972The default [range] for the ":w" command is the whole buffer (1,$). If you
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000973write the whole buffer, it is no longer considered changed. When you
974write it to a different file with ":w somefile" it depends on the "+" flag in
975'cpoptions'. When included, the write command will reset the 'modified' flag,
976even though the buffer itself may still be different from its file.
Bram Moolenaar5c4e21c2004-10-12 19:54:52 +0000977
Bram Moolenaar071d4272004-06-13 20:20:40 +0000978If a file name is given with ":w" it becomes the alternate file. This can be
979used, for example, when the write fails and you want to try again later with
980":w #". This can be switched off by removing the 'A' flag from the
981'cpoptions' option.
982
Bram Moolenaara2a80162017-11-21 23:09:50 +0100983Note that the 'fsync' option matters here. If it's set it may make writes
984slower (but safer).
985
Bram Moolenaar071d4272004-06-13 20:20:40 +0000986 *:sav* *:saveas*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000987:sav[eas][!] [++opt] {file}
988 Save the current buffer under the name {file} and set
Bram Moolenaar071d4272004-06-13 20:20:40 +0000989 the filename of the current buffer to {file}. The
990 previous name is used for the alternate file name.
991 The [!] is needed to overwrite an existing file.
Bram Moolenaar2d3f4892006-01-20 23:02:51 +0000992 When 'filetype' is empty filetype detection is done
993 with the new name, before the file is written.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000994 When the write was successful 'readonly' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000995
996 *:up* *:update*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000997:[range]up[date][!] [++opt] [>>] [file]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000998 Like ":write", but only write when the buffer has been
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200999 modified.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001000
1001
1002WRITING WITH MULTIPLE BUFFERS *buffer-write*
1003
1004 *:wa* *:wall*
1005:wa[ll] Write all changed buffers. Buffers without a file
Bram Moolenaar51628222016-12-01 23:03:28 +01001006 name cause an error message. Buffers which are
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001007 readonly are not written.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001008
1009:wa[ll]! Write all changed buffers, even the ones that are
1010 readonly. Buffers without a file name are not
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001011 written and cause an error message.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001012
1013
1014Vim will warn you if you try to overwrite a file that has been changed
1015elsewhere. See |timestamp|.
1016
1017 *backup* *E207* *E506* *E507* *E508* *E509* *E510*
1018If you write to an existing file (but do not append) while the 'backup',
1019'writebackup' or 'patchmode' option is on, a backup of the original file is
1020made. The file is either copied or renamed (see 'backupcopy'). After the
1021file has been successfully written and when the 'writebackup' option is on and
1022the 'backup' option is off, the backup file is deleted. When the 'patchmode'
1023option is on the backup file may be renamed.
1024
1025 *backup-table*
1026'backup' 'writebackup' action ~
1027 off off no backup made
1028 off on backup current file, deleted afterwards (default)
1029 on off delete old backup, backup current file
1030 on on delete old backup, backup current file
1031
1032When the 'backupskip' pattern matches with the name of the file which is
1033written, no backup file is made. The values of 'backup' and 'writebackup' are
1034ignored then.
1035
1036When the 'backup' option is on, an old backup file (with the same name as the
1037new backup file) will be deleted. If 'backup' is not set, but 'writebackup'
1038is set, an existing backup file will not be deleted. The backup file that is
1039made while the file is being written will have a different name.
1040
1041On some filesystems it's possible that in a crash you lose both the backup and
1042the newly written file (it might be there but contain bogus data). In that
1043case try recovery, because the swap file is synced to disk and might still be
1044there. |:recover|
1045
Bram Moolenaare0fa3742016-02-20 15:47:01 +01001046The directories given with the 'backupdir' option are used to put the backup
Bram Moolenaar071d4272004-06-13 20:20:40 +00001047file in. (default: same directory as the written file).
1048
1049Whether the backup is a new file, which is a copy of the original file, or the
1050original file renamed depends on the 'backupcopy' option. See there for an
1051explanation of when the copy is made and when the file is renamed.
1052
1053If the creation of a backup file fails, the write is not done. If you want
1054to write anyway add a '!' to the command.
1055
Bram Moolenaard58e9292011-02-09 17:07:58 +01001056 *write-permissions*
1057When writing a new file the permissions are read-write. For unix the mask is
Bram Moolenaar82be4842021-01-11 19:40:15 +010010580o666 with additionally umask applied. When writing a file that was read Vim
Bram Moolenaard58e9292011-02-09 17:07:58 +01001059will preserve the permissions, but clear the s-bit.
1060
Bram Moolenaar071d4272004-06-13 20:20:40 +00001061 *write-readonly*
1062When the 'cpoptions' option contains 'W', Vim will refuse to overwrite a
1063readonly file. When 'W' is not present, ":w!" will overwrite a readonly file,
1064if the system allows it (the directory must be writable).
1065
1066 *write-fail*
1067If the writing of the new file fails, you have to be careful not to lose
1068your changes AND the original file. If there is no backup file and writing
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001069the new file failed, you have already lost the original file! DON'T EXIT VIM
1070UNTIL YOU WRITE OUT THE FILE! If a backup was made, it is put back in place
Bram Moolenaar071d4272004-06-13 20:20:40 +00001071of the original file (if possible). If you exit Vim, and lose the changes
1072you made, the original file will mostly still be there. If putting back the
1073original file fails, there will be an error message telling you that you
1074lost the original file.
1075
1076 *DOS-format-write*
Bram Moolenaar4072ba52020-12-23 13:56:35 +01001077If the 'fileformat' is "dos", <CR><NL> is used for <EOL>. This is default
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001078for Win32. On other systems the message "[dos format]" is shown to remind you
1079that an unusual <EOL> was used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001080 *Unix-format-write*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001081If the 'fileformat' is "unix", <NL> is used for <EOL>. On Win32 the message
1082"[unix format]" is shown.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001083 *Mac-format-write*
1084If the 'fileformat' is "mac", <CR> is used for <EOL>. On non-Mac systems the
1085message "[mac format]" is shown.
1086
1087See also |file-formats| and the 'fileformat' and 'fileformats' options.
1088
1089 *ACL*
1090ACL stands for Access Control List. It is an advanced way to control access
1091rights for a file. It is used on new MS-Windows and Unix systems, but only
1092when the filesystem supports it.
1093 Vim attempts to preserve the ACL info when writing a file. The backup file
1094will get the ACL info of the original file.
1095 The ACL info is also used to check if a file is read-only (when opening the
1096file).
1097
1098 *read-only-share*
1099When MS-Windows shares a drive on the network it can be marked as read-only.
1100This means that even if the file read-only attribute is absent, and the ACL
1101settings on NT network shared drives allow writing to the file, you can still
1102not write to the file. Vim on Win32 platforms will detect read-only network
1103drives and will mark the file as read-only. You will not be able to override
1104it with |:write|.
1105
1106 *write-device*
1107When the file name is actually a device name, Vim will not make a backup (that
1108would be impossible). You need to use "!", since the device already exists.
1109Example for Unix: >
1110 :w! /dev/lpt0
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001111and for MS-Windows: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00001112 :w! lpt0
1113For Unix a device is detected when the name doesn't refer to a normal file or
1114a directory. A fifo or named pipe also looks like a device to Vim.
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001115For MS-Windows the device is detected by its name:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001116 AUX
1117 CON
1118 CLOCK$
1119 NUL
1120 PRN
1121 COMn n=1,2,3... etc
1122 LPTn n=1,2,3... etc
1123The names can be in upper- or lowercase.
1124
1125==============================================================================
Bram Moolenaar1cd871b2004-12-19 22:46:22 +000011265. Writing and quitting *write-quit*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001127
1128 *:q* *:quit*
1129:q[uit] Quit the current window. Quit Vim if this is the last
Bram Moolenaar47e13952020-05-12 22:49:12 +02001130 |edit-window|. This fails when changes have been made
1131 and Vim refuses to |abandon| the current buffer, and
1132 when the last file in the argument list has not been
Bram Moolenaar071d4272004-06-13 20:20:40 +00001133 edited.
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00001134 If there are other tab pages and quitting the last
1135 window in the current tab page the current tab page is
1136 closed |tab-page|.
Bram Moolenaar30b65812012-07-12 22:01:11 +02001137 Triggers the |QuitPre| autocommand event.
Bram Moolenaarc572da52017-08-27 16:52:01 +02001138 See |CTRL-W_q| for quitting another window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001139
1140:conf[irm] q[uit] Quit, but give prompt when changes have been made, or
1141 the last file in the argument list has not been
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001142 edited. See |:confirm| and 'confirm'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001143
Bram Moolenaarfa735342016-01-03 22:14:44 +01001144:q[uit]! Quit without writing, also when the current buffer has
Bram Moolenaar09521312016-08-12 22:54:35 +02001145 changes. The buffer is unloaded, also when it has
1146 'hidden' set.
1147 If this is the last window and there is a modified
1148 hidden buffer, the current buffer is abandoned and the
1149 first changed hidden buffer becomes the current
1150 buffer.
Bram Moolenaar2f3b5102014-11-19 18:54:17 +01001151 Use ":qall!" to exit always.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001152
1153:cq[uit] Quit always, without writing, and return an error
1154 code. See |:cq|. Used for Manx's QuickFix mode (see
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001155 |quickfix|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001156
1157 *:wq*
Bram Moolenaar47e13952020-05-12 22:49:12 +02001158:wq [++opt] Write the current file and close the window. If this
1159 was the last |edit-window| Vim quits.
1160 Writing fails when the file is read-only or the buffer
1161 does not have a name. Quitting fails when the last
1162 file in the argument list has not been edited.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001163
Bram Moolenaar47e13952020-05-12 22:49:12 +02001164:wq! [++opt] Write the current file and close the window. If this
1165 was the last |edit-window| Vim quits. Writing fails
1166 when the current buffer does not have a name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001167
Bram Moolenaar47e13952020-05-12 22:49:12 +02001168:wq [++opt] {file} Write to {file} and close the window. If this was the
1169 last |edit-window| Vim quits. Quitting fails when the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001170 last file in the argument list has not been edited.
1171
Bram Moolenaar47e13952020-05-12 22:49:12 +02001172:wq! [++opt] {file} Write to {file} and close the current window. Quit
1173 Vim if this was the last |edit-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001174
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001175:[range]wq[!] [++opt] [file]
1176 Same as above, but only write the lines in [range].
Bram Moolenaar071d4272004-06-13 20:20:40 +00001177
1178 *:x* *:xit*
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001179:[range]x[it][!] [++opt] [file]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001180 Like ":wq", but write only when changes have been
1181 made.
1182 When 'hidden' is set and there are more windows, the
1183 current buffer becomes hidden, after writing the file.
Bram Moolenaara4d131d2021-12-27 21:33:07 +00001184 This command is not supported in |Vim9| script,
1185 because it is too easily confused with a variable
1186 name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001187
1188 *:exi* *:exit*
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001189:[range]exi[t][!] [++opt] [file]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001190 Same as :xit.
1191
1192 *ZZ*
Bram Moolenaar47e13952020-05-12 22:49:12 +02001193ZZ Write current file, if modified, and close the current
1194 window (same as ":x").
1195 If there are several windows for the current file,
1196 only the current window is closed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001197
1198 *ZQ*
1199ZQ Quit without checking for changes (same as ":q!").
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001200
Bram Moolenaar071d4272004-06-13 20:20:40 +00001201
1202MULTIPLE WINDOWS AND BUFFERS *window-exit*
1203
1204 *:qa* *:qall*
1205:qa[ll] Exit Vim, unless there are some buffers which have been
1206 changed. (Use ":bmod" to go to the next modified buffer).
1207 When 'autowriteall' is set all changed buffers will be
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001208 written, like |:wqall|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001209
1210:conf[irm] qa[ll]
1211 Exit Vim. Bring up a prompt when some buffers have been
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001212 changed. See |:confirm|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001213
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001214:qa[ll]! Exit Vim. Any changes to buffers are lost.
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00001215 Also see |:cquit|, it does the same but exits with a non-zero
1216 value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001217
1218 *:quita* *:quitall*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001219:quita[ll][!] Same as ":qall".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001220
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001221:wqa[ll] [++opt] *:wqa* *:wqall* *:xa* *:xall*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001222:xa[ll] Write all changed buffers and exit Vim. If there are buffers
1223 without a file name, which are readonly or which cannot be
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001224 written for another reason, Vim will not quit.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001225
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001226:conf[irm] wqa[ll] [++opt]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001227:conf[irm] xa[ll]
1228 Write all changed buffers and exit Vim. Bring up a prompt
1229 when some buffers are readonly or cannot be written for
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001230 another reason. See |:confirm|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001231
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001232:wqa[ll]! [++opt]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001233:xa[ll]! Write all changed buffers, even the ones that are readonly,
1234 and exit Vim. If there are buffers without a file name or
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001235 which cannot be written for another reason, or there is a
1236 terminal with a running job, Vim will not quit.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001237
1238==============================================================================
Bram Moolenaar1cd871b2004-12-19 22:46:22 +000012396. Dialogs *edit-dialogs*
1240
1241 *:confirm* *:conf*
1242:conf[irm] {command} Execute {command}, and use a dialog when an
1243 operation has to be confirmed. Can be used on the
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02001244 |:q|, |:qa| and |:w| commands (the latter to override
1245 a read-only setting), and any other command that can
1246 fail in such a way, such as |:only|, |:buffer|,
1247 |:bdelete|, etc.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001248
1249Examples: >
1250 :confirm w foo
1251< Will ask for confirmation when "foo" already exists. >
1252 :confirm q
1253< Will ask for confirmation when there are changes. >
1254 :confirm qa
1255< If any modified, unsaved buffers exist, you will be prompted to save
1256 or abandon each one. There are also choices to "save all" or "abandon
1257 all".
1258
1259If you want to always use ":confirm", set the 'confirm' option.
1260
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01001261 *:browse* *:bro* *E338*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001262:bro[wse] {command} Open a file selection dialog for an argument to
1263 {command}. At present this works for |:e|, |:w|,
Bram Moolenaar9028b102010-07-11 16:58:51 +02001264 |:wall|, |:wq|, |:wqall|, |:x|, |:xall|, |:exit|,
1265 |:view|, |:sview|, |:r|, |:saveas|, |:sp|, |:mkexrc|,
1266 |:mkvimrc|, |:mksession|, |:mkview|, |:split|,
1267 |:vsplit|, |:tabe|, |:tabnew|, |:cfile|, |:cgetfile|,
1268 |:caddfile|, |:lfile|, |:lgetfile|, |:laddfile|,
1269 |:diffsplit|, |:diffpatch|, |:open|, |:pedit|,
1270 |:redir|, |:source|, |:update|, |:visual|, |:vsplit|,
1271 and |:qall| if 'confirm' is set.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001272 {only in Win32, Motif, GTK and Mac GUI, in
Bram Moolenaar6e649222021-10-04 21:32:54 +01001273 console `browse edit` works if the FileExplorer
1274 autocommand group exists}
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001275 When ":browse" is not possible you get an error
1276 message. If the |+browse| feature is missing or the
1277 {command} doesn't support browsing, the {command} is
1278 executed without a dialog.
1279 ":browse set" works like |:options|.
Bram Moolenaar9028b102010-07-11 16:58:51 +02001280 See also |:oldfiles| for ":browse oldfiles".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001281
1282The syntax is best shown via some examples: >
1283 :browse e $vim/foo
1284< Open the browser in the $vim/foo directory, and edit the
1285 file chosen. >
1286 :browse e
1287< Open the browser in the directory specified with 'browsedir',
1288 and edit the file chosen. >
1289 :browse w
1290< Open the browser in the directory of the current buffer,
1291 with the current buffer filename as default, and save the
1292 buffer under the filename chosen. >
1293 :browse w C:/bar
1294< Open the browser in the C:/bar directory, with the current
1295 buffer filename as default, and save the buffer under the
1296 filename chosen.
Bram Moolenaar30e9b3c2019-09-07 16:24:12 +02001297Also see the 'browsedir' option.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001298For versions of Vim where browsing is not supported, the command is executed
1299unmodified.
1300
1301 *browsefilter*
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02001302For MS-Windows and GTK, you can modify the filters that are used in the browse
Bram Moolenaar30b65812012-07-12 22:01:11 +02001303dialog. By setting the g:browsefilter or b:browsefilter variables, you can
1304change the filters globally or locally to the buffer. The variable is set to
1305a string in the format "{filter label}\t{pattern};{pattern}\n" where {filter
1306label} is the text that appears in the "Files of Type" comboBox, and {pattern}
1307is the pattern which filters the filenames. Several patterns can be given,
1308separated by ';'.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001309
1310For Motif the same format is used, but only the very first pattern is actually
1311used (Motif only offers one pattern, but you can edit it).
1312
1313For example, to have only Vim files in the dialog, you could use the following
1314command: >
1315
Bram Moolenaar30b65812012-07-12 22:01:11 +02001316 let g:browsefilter = "Vim Scripts\t*.vim\nVim Startup Files\t*vimrc\n"
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001317
1318You can override the filter setting on a per-buffer basis by setting the
1319b:browsefilter variable. You would most likely set b:browsefilter in a
1320filetype plugin, so that the browse dialog would contain entries related to
1321the type of file you are currently editing. Disadvantage: This makes it
1322difficult to start editing a file of a different type. To overcome this, you
1323may want to add "All Files\t*.*\n" as the final filter, so that the user can
1324still access any desired file.
1325
Bram Moolenaar30b65812012-07-12 22:01:11 +02001326To avoid setting browsefilter when Vim does not actually support it, you can
1327use has("browsefilter"): >
1328
1329 if has("browsefilter")
1330 let g:browsefilter = "whatever"
1331 endif
1332
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001333==============================================================================
13347. The current directory *current-directory*
1335
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001336You can use the |:cd|, |:tcd| and |:lcd| commands to change to another
1337directory, so you will not have to type that directory name in front of the
1338file names. It also makes a difference for executing external commands, e.g.
1339":!ls".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001340
Bram Moolenaardf177f62005-02-22 08:39:57 +00001341Changing directory fails when the current buffer is modified, the '.' flag is
1342present in 'cpoptions' and "!" is not used in the command.
1343
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00001344 *:cd* *E747* *E472*
Bakudankun29f3a452021-12-11 12:28:08 +00001345:cd[!] On non-Unix systems when 'cdhome' is off: Print the
1346 current directory name.
1347 Otherwise: Change the current directory to the home
1348 directory. Clear any window-local directory.
1349 Use |:pwd| to print the current directory on all
1350 systems.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001351
Bram Moolenaardf177f62005-02-22 08:39:57 +00001352:cd[!] {path} Change the current directory to {path}.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001353 If {path} is relative, it is searched for in the
1354 directories listed in |'cdpath'|.
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001355 Clear any window-local directory.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001356 Does not change the meaning of an already opened file,
1357 because its full path name is remembered. Files from
1358 the |arglist| may change though!
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001359 On MS-Windows this also changes the active drive.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001360 To change to the directory of the current file: >
1361 :cd %:h
1362<
1363 *:cd-* *E186*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001364:cd[!] - Change to the previous current directory (before the
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001365 previous ":cd {path}" command).
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001366
1367 *:chd* *:chdir*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001368:chd[ir][!] [path] Same as |:cd|.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001369
Bram Moolenaard2ea7cf2021-05-30 20:54:13 +02001370 *:tc* *:tcd*
1371:tc[d][!] {path} Like |:cd|, but only set the directory for the current
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001372 tab. The current window will also use this directory.
1373 The current directory is not changed for windows in
1374 other tabs and for windows in the current tab that
1375 have their own window-local directory.
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001376
Bram Moolenaar002bc792020-06-05 22:33:42 +02001377 *:tcd-*
Bram Moolenaard2ea7cf2021-05-30 20:54:13 +02001378:tc[d][!] - Change to the previous current directory, before the
Bram Moolenaar002bc792020-06-05 22:33:42 +02001379 last ":tcd {path}" command.
1380
Bram Moolenaar22863042021-10-16 15:23:36 +01001381 *:tch* *:tchdir*
1382:tch[dir][!] Same as |:tcd|.
1383
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001384 *:lc* *:lcd*
Bram Moolenaar74675a62017-07-15 13:53:23 +02001385:lc[d][!] {path} Like |:cd|, but only set the current directory when
1386 the cursor is in the current window. The current
1387 directory for other windows is not changed, switching
1388 to another window will stop using {path}.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001389
Bram Moolenaar002bc792020-06-05 22:33:42 +02001390 *:lcd-*
1391:lcd[!] - Change to the previous current directory, before the
1392 last ":lcd {path}" command.
1393
Bram Moolenaar22863042021-10-16 15:23:36 +01001394 *:lch* *:lchdir*
1395:lch[dir][!] Same as |:lcd|.
1396
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001397 *:pw* *:pwd* *E187*
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001398:pw[d] Print the current directory name.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001399 Also see |getcwd()|.
Bram Moolenaar95058722020-06-01 16:26:19 +02001400 *:pwd-verbose*
1401 When 'verbose' is non-zero, |:pwd| will also display
1402 what scope the current directory was set. Example: >
1403
1404 " Set by :cd
1405 :verbose pwd
1406 [global] /path/to/current
1407
1408 " Set by :lcd
1409 :verbose pwd
1410 [window] /path/to/current
1411
1412 " Set by :tcd
1413 :verbose pwd
1414 [tabpage] /path/to/current
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001415
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001416So long as no |:lcd| or |:tcd| command has been used, all windows share the
1417same current directory. Using a command to jump to another window doesn't
1418change anything for the current directory.
1419
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001420When a |:lcd| command has been used for a window, the specified directory
1421becomes the current directory for that window. Windows where the |:lcd|
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001422command has not been used stick to the global or tab-local current directory.
Bram Moolenaar22863042021-10-16 15:23:36 +01001423When jumping to another window the current directory is changed to the last
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001424specified local current directory. If none was specified, the global or
Bram Moolenaarfd31be22022-01-16 14:46:06 +00001425tab-local current directory is used. When creating a new window it inherits
1426the local directory of the current window.
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001427
1428When a |:tcd| command has been used for a tab page, the specified directory
1429becomes the current directory for the current tab page and the current window.
1430The current directory of other tab pages is not affected. When jumping to
Bram Moolenaar22863042021-10-16 15:23:36 +01001431another tab page, the current directory is changed to the last specified local
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001432directory for that tab page. If the current tab has no local current directory
1433the global current directory is used.
1434
1435When a |:cd| command is used, the current window and tab page will lose the
1436local current directory and will use the global current directory from now on.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001437
1438After using |:cd| the full path name will be used for reading and writing
1439files. On some networked file systems this may cause problems. The result of
1440using the full path name is that the file names currently in use will remain
1441referring to the same file. Example: If you have a file a:test and a
1442directory a:vim the commands ":e test" ":cd vim" ":w" will overwrite the file
1443a:test and not write a:vim/test. But if you do ":w test" the file a:vim/test
1444will be written, because you gave a new file name and did not refer to a
1445filename before the ":cd".
1446
1447==============================================================================
Bram Moolenaar071d4272004-06-13 20:20:40 +000014488. Editing binary files *edit-binary*
1449
1450Although Vim was made to edit text files, it is possible to edit binary
1451files. The |-b| Vim argument (b for binary) makes Vim do file I/O in binary
1452mode, and sets some options for editing binary files ('binary' on, 'textwidth'
1453to 0, 'modeline' off, 'expandtab' off). Setting the 'binary' option has the
1454same effect. Don't forget to do this before reading the file.
1455
1456There are a few things to remember when editing binary files:
Bram Moolenaar7ff78462020-07-10 22:00:53 +02001457- When editing executable files the number of bytes must not change.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001458 Use only the "R" or "r" command to change text. Do not delete characters
1459 with "x" or by backspacing.
1460- Set the 'textwidth' option to 0. Otherwise lines will unexpectedly be
1461 split in two.
1462- When there are not many <EOL>s, the lines will become very long. If you
1463 want to edit a line that does not fit on the screen reset the 'wrap' option.
1464 Horizontal scrolling is used then. If a line becomes too long (more than
Bram Moolenaar7ff78462020-07-10 22:00:53 +02001465 about 32767 bytes on the Amiga, much more on 32-bit and 64-bit systems, see
Bram Moolenaar071d4272004-06-13 20:20:40 +00001466 |limits|) you cannot edit that line. The line will be split when reading
1467 the file. It is also possible that you get an "out of memory" error when
1468 reading the file.
1469- Make sure the 'binary' option is set BEFORE loading the
Bram Moolenaar4072ba52020-12-23 13:56:35 +01001470 file. Otherwise both <CR><NL> and <NL> are considered to end a line
1471 and when the file is written the <NL> will be replaced with <CR><NL>.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001472- <Nul> characters are shown on the screen as ^@. You can enter them with
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001473 "CTRL-V CTRL-@" or "CTRL-V 000"
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +02001474- To insert a <NL> character in the file split a line. When writing the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001475 buffer to a file a <NL> will be written for the <EOL>.
1476- Vim normally appends an <EOL> at the end of the file if there is none.
1477 Setting the 'binary' option prevents this. If you want to add the final
1478 <EOL>, set the 'endofline' option. You can also read the value of this
1479 option to see if there was an <EOL> for the last line (you cannot see this
1480 in the text).
1481
1482==============================================================================
14839. Encryption *encryption*
1484
1485Vim is able to write files encrypted, and read them back. The encrypted text
1486cannot be read without the right key.
Bram Moolenaar996343d2010-07-04 22:20:21 +02001487{only available when compiled with the |+cryptv| feature} *E833*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001488
Bram Moolenaar81af9252010-12-10 20:35:50 +01001489The text in the swap file and the undo file is also encrypted. *E843*
Bram Moolenaar07d87792014-07-19 14:04:47 +02001490However, this is done block-by-block and may reduce the time needed to crack a
1491password. You can disable the swap file, but then a crash will cause you to
Bram Moolenaar9d87a372018-12-18 21:41:50 +01001492lose your work. The undo file can be disabled without too much disadvantage. >
Bram Moolenaar07d87792014-07-19 14:04:47 +02001493 :set noundofile
1494 :noswapfile edit secrets
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001495
1496Note: The text in memory is not encrypted. A system administrator may be able
1497to see your text while you are editing it. When filtering text with
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001498":!filter" or using ":w !command" the text is also not encrypted, this may
1499reveal it to others. The 'viminfo' file is not encrypted.
1500
1501You could do this to edit very secret text: >
1502 :set noundofile viminfo=
1503 :noswapfile edit secrets.txt
Bram Moolenaar88774fd2015-08-25 19:52:04 +02001504Keep in mind that without a swap file you risk losing your work in the event
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +02001505of a crash or a power failure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001506
1507WARNING: If you make a typo when entering the key and then write the file and
1508exit, the text will be lost!
1509
1510The normal way to work with encryption, is to use the ":X" command, which will
1511ask you to enter a key. A following write command will use that key to
1512encrypt the file. If you later edit the same file, Vim will ask you to enter
1513a key. If you type the same key as that was used for writing, the text will
1514be readable again. If you use a wrong key, it will be a mess.
1515
1516 *:X*
1517:X Prompt for an encryption key. The typing is done without showing the
1518 actual text, so that someone looking at the display won't see it.
1519 The typed key is stored in the 'key' option, which is used to encrypt
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02001520 the file when it is written.
1521 The file will remain unchanged until you write it. Note that commands
1522 such as `:xit` and `ZZ` will NOT write the file unless there are other
1523 changes.
1524 See also |-x|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001525
1526The value of the 'key' options is used when text is written. When the option
1527is not empty, the written file will be encrypted, using the value as the
1528encryption key. A magic number is prepended, so that Vim can recognize that
1529the file is encrypted.
1530
1531To disable the encryption, reset the 'key' option to an empty value: >
1532 :set key=
1533
Bram Moolenaar49771f42010-07-20 17:32:38 +02001534You can use the 'cryptmethod' option to select the type of encryption, use one
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001535of these: >
1536 :setlocal cm=zip " weak method, backwards compatible
1537 :setlocal cm=blowfish " method with flaws
1538 :setlocal cm=blowfish2 " medium strong method
1539
Bram Moolenaar49771f42010-07-20 17:32:38 +02001540Do this before writing the file. When reading an encrypted file it will be
1541set automatically to the method used when that file was written. You can
1542change 'cryptmethod' before writing that file to change the method.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001543
Bram Moolenaar664f3cf2019-12-07 16:03:51 +01001544To set the default method, used for new files, use this in your |vimrc|
Bram Moolenaarc2299672014-11-13 14:25:38 +01001545file: >
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001546 set cm=blowfish2
Bram Moolenaarc2299672014-11-13 14:25:38 +01001547Using "blowfish2" is highly recommended. Only use another method if you
1548must use an older Vim version that does not support it.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001549
Bram Moolenaar662db672011-03-22 14:05:35 +01001550The message given for reading and writing a file will show "[crypted]" when
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001551using zip, "[blowfish]" when using blowfish, etc.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02001552
Bram Moolenaara3ff49f2010-05-30 22:48:02 +02001553When writing an undo file, the same key and method will be used for the text
1554in the undo file. |persistent-undo|.
1555
Bram Moolenaar85084ef2016-01-17 22:26:33 +01001556To test for blowfish support you can use these conditions: >
1557 has('crypt-blowfish')
1558 has('crypt-blowfish2')
1559This works since Vim 7.4.1099 while blowfish support was added earlier.
1560Thus the condition failing doesn't mean blowfish is not supported. You can
1561test for blowfish with: >
1562 v:version >= 703
1563And for blowfish2 with: >
1564 v:version > 704 || (v:version == 704 && has('patch401'))
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01001565If you are sure Vim includes patch 7.4.237 a simpler check is: >
1566 has('patch-7.4.401')
Bram Moolenaar85084ef2016-01-17 22:26:33 +01001567<
Bram Moolenaarfa7584c2010-05-19 21:57:45 +02001568 *E817* *E818* *E819* *E820*
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02001569When encryption does not work properly, you would be able to write your text
1570to a file and never be able to read it back. Therefore a test is performed to
1571check if the encryption works as expected. If you get one of these errors
1572don't write the file encrypted! You need to rebuild the Vim binary to fix
1573this.
1574
Bram Moolenaar46f9d492010-06-12 20:18:19 +02001575*E831* This is an internal error, "cannot happen". If you can reproduce it,
Bram Moolenaar56be9502010-06-06 14:20:26 +02001576please report to the developers.
1577
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02001578When reading a file that has been encrypted and the 'key' option is not empty,
1579it will be used for decryption. If the value is empty, you will be prompted
1580to enter the key. If you don't enter a key, or you enter the wrong key, the
1581file is edited without being decrypted. There is no warning about using the
1582wrong key (this makes brute force methods to find the key more difficult).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001583
1584If want to start reading a file that uses a different key, set the 'key'
1585option to an empty string, so that Vim will prompt for a new one. Don't use
1586the ":set" command to enter the value, other people can read the command over
1587your shoulder.
1588
1589Since the value of the 'key' option is supposed to be a secret, its value can
1590never be viewed. You should not set this option in a vimrc file.
1591
Bram Moolenaar60aad972010-07-21 20:36:22 +02001592An encrypted file can be recognized by the "file" command, if you add these
1593lines to "/etc/magic", "/usr/share/misc/magic" or wherever your system has the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001594"magic" file: >
1595 0 string VimCrypt~ Vim encrypted file
Bram Moolenaarc095b282010-07-20 22:33:34 +02001596 >9 string 01 - "zip" cryptmethod
1597 >9 string 02 - "blowfish" cryptmethod
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001598 >9 string 03 - "blowfish2" cryptmethod
Bram Moolenaar071d4272004-06-13 20:20:40 +00001599
1600Notes:
1601- Encryption is not possible when doing conversion with 'charconvert'.
1602- Text you copy or delete goes to the numbered registers. The registers can
1603 be saved in the .viminfo file, where they could be read. Change your
1604 'viminfo' option to be safe.
1605- Someone can type commands in Vim when you walk away for a moment, he should
1606 not be able to get the key.
1607- If you make a typing mistake when entering the key, you might not be able to
1608 get your text back!
1609- If you type the key with a ":set key=value" command, it can be kept in the
1610 history, showing the 'key' value in a viminfo file.
1611- There is never 100% safety. The encryption in Vim has not been tested for
1612 robustness.
Bram Moolenaar24ea3ba2010-09-19 19:01:21 +02001613- The algorithm used for 'cryptmethod' "zip" is breakable. A 4 character key
1614 in about one hour, a 6 character key in one day (on a Pentium 133 PC). This
1615 requires that you know some text that must appear in the file. An expert
1616 can break it for any key. When the text has been decrypted, this also means
1617 that the key can be revealed, and other files encrypted with the same key
1618 can be decrypted.
1619- Pkzip uses the same encryption as 'cryptmethod' "zip", and US Govt has no
1620 objection to its export. Pkzip's public file APPNOTE.TXT describes this
1621 algorithm in detail.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02001622- The implementation of 'cryptmethod' "blowfish" has a flaw. It is possible
1623 to crack the first 64 bytes of a file and in some circumstances more of the
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001624 file. Use of it is not recommended, but it's still the strongest method
1625 supported by Vim 7.3 and 7.4. The "zip" method is even weaker.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001626- Vim originates from the Netherlands. That is where the sources come from.
1627 Thus the encryption code is not exported from the USA.
1628
1629==============================================================================
163010. Timestamps *timestamp* *timestamps*
1631
Bram Moolenaare968e362014-05-13 20:23:24 +02001632Vim remembers the modification timestamp, mode and size of a file when you
1633begin editing it. This is used to avoid that you have two different versions
1634of the same file (without you knowing this).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001635
Bram Moolenaare968e362014-05-13 20:23:24 +02001636After a shell command is run (|:!cmd| |suspend| |:read!| |K|) timestamps,
1637file modes and file sizes are compared for all buffers in a window. Vim will
1638run any associated |FileChangedShell| autocommands or display a warning for
1639any files that have changed. In the GUI this happens when Vim regains input
1640focus.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001641
1642 *E321* *E462*
1643If you want to automatically reload a file when it has been changed outside of
1644Vim, set the 'autoread' option. This doesn't work at the moment you write the
1645file though, only when the file wasn't changed inside of Vim.
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02001646 *ignore-timestamp*
Bram Moolenaar94237492017-04-23 18:40:21 +02001647If you do not want to be asked or automatically reload the file, you can use
1648this: >
1649 set buftype=nofile
1650
1651Or, when starting gvim from a shell: >
1652 gvim file.log -c "set buftype=nofile"
1653
Bram Moolenaar071d4272004-06-13 20:20:40 +00001654Note that if a FileChangedShell autocommand is defined you will not get a
1655warning message or prompt. The autocommand is expected to handle this.
1656
Bram Moolenaar10de2da2005-01-27 14:33:00 +00001657There is no warning for a directory (e.g., with |netrw-browse|). But you do
1658get warned if you started editing a new file and it was created as a directory
1659later.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001660
1661When Vim notices the timestamp of a file has changed, and the file is being
1662edited in a buffer but has not changed, Vim checks if the contents of the file
1663is equal. This is done by reading the file again (into a hidden buffer, which
1664is immediately deleted again) and comparing the text. If the text is equal,
1665you will get no warning.
1666
1667If you don't get warned often enough you can use the following command.
1668
1669 *:checkt* *:checktime*
1670:checkt[ime] Check if any buffers were changed outside of Vim.
1671 This checks and warns you if you would end up with two
1672 versions of a file.
1673 If this is called from an autocommand, a ":global"
1674 command or is not typed the actual check is postponed
1675 until a moment the side effects (reloading the file)
1676 would be harmless.
1677 Each loaded buffer is checked for its associated file
1678 being changed. If the file was changed Vim will take
1679 action. If there are no changes in the buffer and
1680 'autoread' is set, the buffer is reloaded. Otherwise,
1681 you are offered the choice of reloading the file. If
1682 the file was deleted you get an error message.
1683 If the file previously didn't exist you get a warning
1684 if it exists now.
1685 Once a file has been checked the timestamp is reset,
1686 you will not be warned again.
Rob Pilling8196e942022-02-11 15:12:10 +00001687 Syntax highlighting, marks, diff status,
1688 'fileencoding', 'fileformat' and 'binary' options
1689 are not changed. See |v:fcs_choice| to reload these
1690 too (for example, if a code formatting tools has
1691 changed the file).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001692
1693:[N]checkt[ime] {filename}
1694:[N]checkt[ime] [N]
1695 Check the timestamp of a specific buffer. The buffer
1696 may be specified by name, number or with a pattern.
1697
1698
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001699 *E813* *E814*
1700Vim will reload the buffer if you chose to. If a window is visible that
1701contains this buffer, the reloading will happen in the context of this window.
1702Otherwise a special window is used, so that most autocommands will work. You
1703can't close this window. A few other restrictions apply. Best is to make
1704sure nothing happens outside of the current buffer. E.g., setting
1705window-local options may end up in the wrong window. Splitting the window,
1706doing something there and closing it should be OK (if there are no side
1707effects from other autocommands). Closing unrelated windows and buffers will
1708get you into trouble.
1709
Bram Moolenaar071d4272004-06-13 20:20:40 +00001710Before writing a file the timestamp is checked. If it has changed, Vim will
1711ask if you really want to overwrite the file:
1712
1713 WARNING: The file has been changed since reading it!!!
1714 Do you really want to write to it (y/n)?
1715
1716If you hit 'y' Vim will continue writing the file. If you hit 'n' the write is
1717aborted. If you used ":wq" or "ZZ" Vim will not exit, you will get another
1718chance to write the file.
1719
1720The message would normally mean that somebody has written to the file after
1721the edit session started. This could be another person, in which case you
1722probably want to check if your changes to the file and the changes from the
1723other person should be merged. Write the file under another name and check for
1724differences (the "diff" program can be used for this).
1725
1726It is also possible that you modified the file yourself, from another edit
1727session or with another command (e.g., a filter command). Then you will know
1728which version of the file you want to keep.
1729
Bram Moolenaar22863042021-10-16 15:23:36 +01001730The accuracy of the time check depends on the filesystem. On Unix it is
Bram Moolenaar75ab5902022-04-18 15:36:40 +01001731usually sub-second. With old file systems and on MS-Windows it is normally one
Bram Moolenaar944697a2022-02-20 19:48:20 +00001732second. Use `has('nanotime')` to check if sub-second time stamp checks are
Bram Moolenaar22863042021-10-16 15:23:36 +01001733available.
1734
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001735There is one situation where you get the message while there is nothing wrong:
1736On a Win32 system on the day daylight saving time starts. There is something
1737in the Win32 libraries that confuses Vim about the hour time difference. The
1738problem goes away the next day.
1739
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001740==============================================================================
174111. File Searching *file-searching*
1742
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001743The file searching is currently used for the 'path', 'cdpath' and 'tags'
Bram Moolenaarc236c162008-07-13 17:41:49 +00001744options, for |finddir()| and |findfile()|. Other commands use |wildcards|
1745which is slightly different.
Bram Moolenaar9964e462007-05-05 17:54:07 +00001746
1747There are three different types of searching:
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001748
Bram Moolenaar02743632005-07-25 20:42:36 +000017491) Downward search: *starstar*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001750 Downward search uses the wildcards '*', '**' and possibly others
Bram Moolenaarc236c162008-07-13 17:41:49 +00001751 supported by your operating system. '*' and '**' are handled inside Vim,
1752 so they work on all operating systems. Note that "**" only acts as a
1753 special wildcard when it is at the start of a name.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001754
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00001755 The usage of '*' is quite simple: It matches 0 or more characters. In a
1756 search pattern this would be ".*". Note that the "." is not used for file
1757 searching.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001758
1759 '**' is more sophisticated:
1760 - It ONLY matches directories.
Bram Moolenaarc236c162008-07-13 17:41:49 +00001761 - It matches up to 30 directories deep by default, so you can use it to
1762 search an entire directory tree
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001763 - The maximum number of levels matched can be given by appending a number
1764 to '**'.
1765 Thus '/usr/**2' can match: >
1766 /usr
1767 /usr/include
1768 /usr/include/sys
1769 /usr/include/g++
1770 /usr/lib
1771 /usr/lib/X11
1772 ....
1773< It does NOT match '/usr/include/g++/std' as this would be three
1774 levels.
Bram Moolenaarc236c162008-07-13 17:41:49 +00001775 The allowed number range is 0 ('**0' is removed) to 100
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001776 If the given number is smaller than 0 it defaults to 30, if it's
Bram Moolenaarc236c162008-07-13 17:41:49 +00001777 bigger than 100 then 100 is used. The system also has a limit on the
1778 path length, usually 256 or 1024 bytes.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001779 - '**' can only be at the end of the path or be followed by a path
1780 separator or by a number and a path separator.
1781
1782 You can combine '*' and '**' in any order: >
1783 /usr/**/sys/*
Bram Moolenaarc236c162008-07-13 17:41:49 +00001784 /usr/*tory/sys/**
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001785 /usr/**2/sys/*
1786
17872) Upward search:
1788 Here you can give a directory and then search the directory tree upward for
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001789 a file. You could give stop-directories to limit the upward search. The
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001790 stop-directories are appended to the path (for the 'path' option) or to
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001791 the filename (for the 'tags' option) with a ';'. If you want several
1792 stop-directories separate them with ';'. If you want no stop-directory
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001793 ("search upward till the root directory) just use ';'. >
1794 /usr/include/sys;/usr
1795< will search in: >
1796 /usr/include/sys
1797 /usr/include
1798 /usr
1799<
1800 If you use a relative path the upward search is started in Vim's current
1801 directory or in the directory of the current file (if the relative path
1802 starts with './' and 'd' is not included in 'cpoptions').
1803
1804 If Vim's current path is /u/user_x/work/release and you do >
1805 :set path=include;/u/user_x
1806< and then search for a file with |gf| the file is searched in: >
1807 /u/user_x/work/release/include
1808 /u/user_x/work/include
1809 /u/user_x/include
1810
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00001811< Note: If your 'path' setting includes a non-existing directory, Vim will
Bram Moolenaara2baa732022-02-04 16:09:54 +00001812 skip the non-existing directory, and also does not search in the parent of
1813 the non-existing directory if upwards searching is used.
Christian Brabandt7a4ca322021-07-25 15:08:05 +02001814
Bram Moolenaar402d2fe2005-04-15 21:00:38 +000018153) Combined up/downward search:
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001816 If Vim's current path is /u/user_x/work/release and you do >
1817 set path=**;/u/user_x
1818< and then search for a file with |gf| the file is searched in: >
1819 /u/user_x/work/release/**
1820 /u/user_x/work/**
1821 /u/user_x/**
1822<
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001823 BE CAREFUL! This might consume a lot of time, as the search of
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001824 '/u/user_x/**' includes '/u/user_x/work/**' and
1825 '/u/user_x/work/release/**'. So '/u/user_x/work/release/**' is searched
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001826 three times and '/u/user_x/work/**' is searched twice.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001827
1828 In the above example you might want to set path to: >
1829 :set path=**,/u/user_x/**
Bram Moolenaar162bd912010-07-28 22:29:10 +02001830< This searches:
1831 /u/user_x/work/release/** ~
1832 /u/user_x/** ~
1833 This searches the same directories, but in a different order.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001834
Bram Moolenaar162bd912010-07-28 22:29:10 +02001835 Note that completion for ":find", ":sfind", and ":tabfind" commands do not
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02001836 currently work with 'path' items that contain a URL or use the double star
Bram Moolenaar5b435d62012-04-05 17:33:26 +02001837 with depth limiter (/usr/**2) or upward search (;) notations.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001838
Bram Moolenaar91f84f62018-07-29 15:07:52 +02001839 vim:tw=78:ts=8:noet:ft=help:norl: