blob: ebb78b099ac75ebcc4982d25d44c0904b81352f8 [file] [log] [blame]
Bram Moolenaara4d131d2021-12-27 21:33:07 +00001*editing.txt* For Vim version 8.2. Last change: 2021 Dec 27
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 Moolenaar071d4272004-06-13 20:20:40 +0000225
226: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 Moolenaar25c9c682019-05-05 18:13:34 +0200250 {not available when the |+file_in_path| feature was
251 disabled at compile time}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000252
253:{count}fin[d][!] [++opt] [+cmd] {file}
254 Just like ":find", but use the {count} match in
255 'path'. Thus ":2find file" will find the second
256 "file" found in 'path'. When there are fewer matches
257 for the file in 'path' than asked for, you get an
258 error message.
259
260 *:ex*
261:ex [++opt] [+cmd] [file]
262 Same as |:edit|.
263
264 *:vi* *:visual*
265:vi[sual][!] [++opt] [+cmd] [file]
Bram Moolenaar81695252004-12-29 20:58:21 +0000266 When used in Ex mode: Leave |Ex-mode|, go back to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000267 Normal mode. Otherwise same as |:edit|.
268
269 *:vie* *:view*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100270:vie[w][!] [++opt] [+cmd] file
Bram Moolenaar036986f2017-03-16 17:41:02 +0100271 When used in Ex mode: Leave |Ex-mode|, go back to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000272 Normal mode. Otherwise same as |:edit|, but set
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200273 'readonly' option for this buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000274
275 *CTRL-^* *CTRL-6*
Bram Moolenaar662db672011-03-22 14:05:35 +0100276CTRL-^ Edit the alternate file. Mostly the alternate file is
277 the previously edited file. This is a quick way to
278 toggle between two files. It is equivalent to ":e #",
279 except that it also works when there is no file name.
280
Bram Moolenaar071d4272004-06-13 20:20:40 +0000281 If the 'autowrite' or 'autowriteall' option is on and
282 the buffer was changed, write it.
283 Mostly the ^ character is positioned on the 6 key,
284 pressing CTRL and 6 then gets you what we call CTRL-^.
285 But on some non-US keyboards CTRL-^ is produced in
286 another way.
287
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000288{count}CTRL-^ Edit [count]th file in the buffer list (equivalent to
289 ":e #[count]"). This is a quick way to switch between
290 files.
291 See |CTRL-^| above for further details.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000292
Bram Moolenaar071d4272004-06-13 20:20:40 +0000293[count]]f *]f* *[f*
294[count][f Same as "gf". Deprecated.
295
296 *gf* *E446* *E447*
297[count]gf Edit the file whose name is under or after the cursor.
298 Mnemonic: "goto file".
299 Uses the 'isfname' option to find out which characters
300 are supposed to be in a file name. Trailing
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100301 punctuation characters ".,:;!" are ignored. Escaped
302 spaces "\ " are reduced to a single space.
Bram Moolenaarc236c162008-07-13 17:41:49 +0000303 Uses the 'path' option as a list of directory names to
304 look for the file. See the 'path' option for details
305 about relative directories and wildcards.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000306 Uses the 'suffixesadd' option to check for file names
307 with a suffix added.
308 If the file can't be found, 'includeexpr' is used to
309 modify the name and another attempt is done.
310 If a [count] is given, the count'th file that is found
311 in the 'path' is edited.
312 This command fails if Vim refuses to |abandon| the
313 current file.
Bram Moolenaar8dff8182006-04-06 20:18:50 +0000314 If you want to edit the file in a new window use
315 |CTRL-W_CTRL-F|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000316 If you do want to edit a new file, use: >
317 :e <cfile>
318< To make gf always work like that: >
319 :map gf :e <cfile><CR>
320< If the name is a hypertext link, that looks like
321 "type://machine/path", you need the |netrw| plugin.
322 For Unix the '~' character is expanded, like in
323 "~user/file". Environment variables are expanded too
324 |expand-env|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000325 {not available when the |+file_in_path| feature was
326 disabled at compile time}
327
328 *v_gf*
329{Visual}[count]gf Same as "gf", but the highlighted text is used as the
330 name of the file to edit. 'isfname' is ignored.
331 Leading blanks are skipped, otherwise all blanks and
332 special characters are included in the file name.
333 (For {Visual} see |Visual-mode|.)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000334
Bram Moolenaard1f56e62006-02-22 21:25:37 +0000335 *gF*
336[count]gF Same as "gf", except if a number follows the file
337 name, then the cursor is positioned on that line in
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100338 the file.
339 The file name and the number must be separated by a
340 non-filename (see 'isfname') and non-numeric
341 character. " line " is also recognized, like it is
342 used in the output of `:verbose command UserCmd`
343 White space between the filename, the separator and
344 the number are ignored.
Bram Moolenaard8fc5c02006-04-29 21:55:22 +0000345 Examples:
346 eval.c:10 ~
347 eval.c @ 20 ~
348 eval.c (30) ~
349 eval.c 40 ~
350
Bram Moolenaard1f56e62006-02-22 21:25:37 +0000351 *v_gF*
352{Visual}[count]gF Same as "v_gf".
353
Bram Moolenaar071d4272004-06-13 20:20:40 +0000354These commands are used to start editing a single file. This means that the
355file is read into the buffer and the current file name is set. The file that
356is opened depends on the current directory, see |:cd|.
357
358See |read-messages| for an explanation of the message that is given after the
359file has been read.
360
361You can use the ":e!" command if you messed up the buffer and want to start
362all over again. The ":e" command is only useful if you have changed the
363current file name.
364
365 *:filename* *{file}*
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000366Besides the things mentioned here, more special items for where a filename is
367expected are mentioned at |cmdline-special|.
368
Bram Moolenaarc236c162008-07-13 17:41:49 +0000369Note for systems other than Unix: When using a command that accepts a single
370file name (like ":edit file") spaces in the file name are allowed, but
371trailing spaces are ignored. This is useful on systems that regularly embed
372spaces in file names (like MS-Windows and the Amiga). Example: The command
373":e Long File Name " will edit the file "Long File Name". When using a
374command that accepts more than one file name (like ":next file1 file2")
375embedded spaces must be escaped with a backslash.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000376
Bram Moolenaar9964e462007-05-05 17:54:07 +0000377 *wildcard* *wildcards*
Bram Moolenaar30b65812012-07-12 22:01:11 +0200378Wildcards in {file} are expanded, but as with file completion, 'wildignore'
379and 'suffixes' apply. Which wildcards are supported depends on the system.
380These are the common ones:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000381 ? matches one character
Bram Moolenaar02743632005-07-25 20:42:36 +0000382 * matches anything, including nothing
383 ** matches anything, including nothing, recurses into directories
Bram Moolenaar071d4272004-06-13 20:20:40 +0000384 [abc] match 'a', 'b' or 'c'
Bram Moolenaar02743632005-07-25 20:42:36 +0000385
Bram Moolenaar071d4272004-06-13 20:20:40 +0000386To avoid the special meaning of the wildcards prepend a backslash. However,
387on MS-Windows the backslash is a path separator and "path\[abc]" is still seen
388as a wildcard when "[" is in the 'isfname' option. A simple way to avoid this
Bram Moolenaar7db8f6f2016-03-29 23:12:46 +0200389is to use "path\[[]abc]", this matches the file "path\[abc]".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000390
Bram Moolenaar02743632005-07-25 20:42:36 +0000391 *starstar-wildcard*
392Expanding "**" is possible on Unix, Win32, Mac OS/X and a few other systems.
393This allows searching a directory tree. This goes up to 100 directories deep.
Bram Moolenaar9b451252012-08-15 17:43:31 +0200394Note there are some commands where this works slightly differently, see
Bram Moolenaarc236c162008-07-13 17:41:49 +0000395|file-searching|.
Bram Moolenaar02743632005-07-25 20:42:36 +0000396Example: >
397 :n **/*.txt
398Finds files:
Bram Moolenaar38a55632016-02-15 22:07:32 +0100399 aaa.txt ~
400 subdir/bbb.txt ~
401 a/b/c/d/ccc.txt ~
402When non-wildcard characters are used right before or after "**" these are
403only matched in the top directory. They are not used for directories further
404down in the tree. For example: >
405 :n /usr/inc**/types.h
Bram Moolenaar02743632005-07-25 20:42:36 +0000406Finds files:
Bram Moolenaar38a55632016-02-15 22:07:32 +0100407 /usr/include/types.h ~
408 /usr/include/sys/types.h ~
409 /usr/inc/old/types.h ~
410Note that the path with "/sys" is included because it does not need to match
411"/inc". Thus it's like matching "/usr/inc*/*/*...", not
412"/usr/inc*/inc*/inc*".
413
Bram Moolenaar071d4272004-06-13 20:20:40 +0000414 *backtick-expansion* *`-expansion*
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200415On Unix and a few other systems you can also use backticks for the file name
416argument, for example: >
417 :next `find . -name ver\\*.c -print`
Bram Moolenaar88774fd2015-08-25 19:52:04 +0200418 :view `ls -t *.patch \| head -n1`
Bram Moolenaarab943432018-03-29 18:27:07 +0200419Vim will run the command in backticks using the 'shell' and use the standard
420output as argument for the given Vim command (error messages from the shell
421command will be discarded).
422To see what shell command Vim is running, set the 'verbose' option to 4. When
423the shell command returns a non-zero exit code, an error message will be
424displayed and the Vim command will be aborted. To avoid this make the shell
425always return zero like so: >
426 :next `find . -name ver\\*.c -print \|\| true`
427
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200428The backslashes before the star are required to prevent the shell from
429expanding "ver*.c" prior to execution of the find program. The backslash
430before the shell pipe symbol "|" prevents Vim from parsing it as command
431termination.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000432This also works for most other systems, with the restriction that the
433backticks must be around the whole item. It is not possible to have text
434directly before the first or just after the last backtick.
435
Bram Moolenaared203462004-06-16 11:19:22 +0000436 *`=*
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200437You can have the backticks expanded as a Vim expression, instead of as an
438external command, by putting an equal sign right after the first backtick,
439e.g.: >
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000440 :e `=tempname()`
441The expression can contain just about anything, thus this can also be used to
Bram Moolenaar30b65812012-07-12 22:01:11 +0200442avoid the special meaning of '"', '|', '%' and '#'. However, 'wildignore'
Bram Moolenaar00154502013-02-13 16:15:55 +0100443does apply like to other wildcards.
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200444
Bram Moolenaar88774fd2015-08-25 19:52:04 +0200445Environment variables in the expression are expanded when evaluating the
446expression, thus this works: >
447 :e `=$HOME . '/.vimrc'`
448This does not work, $HOME is inside a string and used literally: >
449 :e `='$HOME' . '/.vimrc'`
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200450
Bram Moolenaar30b65812012-07-12 22:01:11 +0200451If the expression returns a string then names are to be separated with line
452breaks. When the result is a |List| then each item is used as a name. Line
453breaks also separate names.
Bram Moolenaarf9132812015-07-21 19:19:13 +0200454Note that such expressions are only supported in places where a filename is
455expected as an argument to an Ex-command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000456
457 *++opt* *[++opt]*
Bram Moolenaarb0bf8582005-12-13 20:02:15 +0000458The [++opt] argument can be used to force the value of 'fileformat',
459'fileencoding' or 'binary' to a value for one command, and to specify the
460behavior for bad characters. The form is: >
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000461 ++{optname}
462Or: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000463 ++{optname}={value}
464
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000465Where {optname} is one of: *++ff* *++enc* *++bin* *++nobin* *++edit*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000466 ff or fileformat overrides 'fileformat'
467 enc or encoding overrides 'fileencoding'
468 bin or binary sets 'binary'
469 nobin or nobinary resets 'binary'
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000470 bad specifies behavior for bad characters
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000471 edit for |:read| only: keep option values as if editing
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000472 a file
Bram Moolenaar071d4272004-06-13 20:20:40 +0000473
474{value} cannot contain white space. It can be any valid value for these
475options. Examples: >
476 :e ++ff=unix
477This edits the same file again with 'fileformat' set to "unix". >
478
479 :w ++enc=latin1 newfile
480This writes the current buffer to "newfile" in latin1 format.
481
Bram Moolenaar47e13952020-05-12 22:49:12 +0200482The message given when writing a file will show "[converted]" when
483'fileencoding' or the value specified with ++enc differs from 'encoding'.
484
Bram Moolenaarb0bf8582005-12-13 20:02:15 +0000485There may be several ++opt arguments, separated by white space. They must all
486appear before any |+cmd| argument.
487
488 *++bad*
489The argument of "++bad=" specifies what happens with characters that can't be
490converted and illegal bytes. It can be one of three things:
491 ++bad=X A single-byte character that replaces each bad character.
492 ++bad=keep Keep bad characters without conversion. Note that this may
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000493 result in illegal bytes in your text!
Bram Moolenaarb0bf8582005-12-13 20:02:15 +0000494 ++bad=drop Remove the bad characters.
495
496The default is like "++bad=?": Replace each bad character with a question
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100497mark. In some places an inverted question mark is used (0xBF).
498
499Note that not all commands use the ++bad argument, even though they do not
500give an error when you add it. E.g. |:write|.
Bram Moolenaarb0bf8582005-12-13 20:02:15 +0000501
Bram Moolenaar071d4272004-06-13 20:20:40 +0000502Note that when reading, the 'fileformat' and 'fileencoding' options will be
503set to the used format. When writing this doesn't happen, thus a next write
504will use the old value of the option. Same for the 'binary' option.
505
Bram Moolenaar071d4272004-06-13 20:20:40 +0000506
507 *+cmd* *[+cmd]*
508The [+cmd] argument can be used to position the cursor in the newly opened
509file, or execute any other command:
510 + Start at the last line.
511 +{num} Start at line {num}.
512 +/{pat} Start at first line containing {pat}.
513 +{command} Execute {command} after opening the new file.
514 {command} is any Ex command.
515To include a white space in the {pat} or {command}, precede it with a
516backslash. Double the number of backslashes. >
517 :edit +/The\ book file
518 :edit +/dir\ dirname\\ file
519 :edit +set\ dir=c:\\\\temp file
520Note that in the last example the number of backslashes is halved twice: Once
521for the "+cmd" argument and once for the ":set" command.
522
523 *file-formats*
524The 'fileformat' option sets the <EOL> style for a file:
525'fileformat' characters name ~
526 "dos" <CR><NL> or <NL> DOS format *DOS-format*
527 "unix" <NL> Unix format *Unix-format*
528 "mac" <CR> Mac format *Mac-format*
529Previously 'textmode' was used. It is obsolete now.
530
531When reading a file, the mentioned characters are interpreted as the <EOL>.
Bram Moolenaar6f345a12019-12-17 21:27:18 +0100532In DOS format (default for Win32), <CR><NL> and <NL> are both interpreted as
533the <EOL>. Note that when writing the file in DOS format, <CR> characters
534will be added for each single <NL>. Also see |file-read|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000535
536When writing a file, the mentioned characters are used for <EOL>. For DOS
537format <CR><NL> is used. Also see |DOS-format-write|.
538
539You can read a file in DOS format and write it in Unix format. This will
540replace all <CR><NL> pairs by <NL> (assuming 'fileformats' includes "dos"): >
541 :e file
542 :set fileformat=unix
543 :w
544If you read a file in Unix format and write with DOS format, all <NL>
545characters will be replaced with <CR><NL> (assuming 'fileformats' includes
546"unix"): >
547 :e file
548 :set fileformat=dos
549 :w
550
551If you start editing a new file and the 'fileformats' option is not empty
552(which is the default), Vim will try to detect whether the lines in the file
553are separated by the specified formats. When set to "unix,dos", Vim will
554check for lines with a single <NL> (as used on Unix and Amiga) or by a <CR>
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100555<NL> pair (MS-Windows). Only when ALL lines end in <CR><NL>, 'fileformat' is
556set to "dos", otherwise it is set to "unix". When 'fileformats' includes
557"mac", and no <NL> characters are found in the file, 'fileformat' is set to
558"mac".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000559
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100560If the 'fileformat' option is set to "dos" on non-MS-Windows systems the
561message "[dos format]" is shown to remind you that something unusual is
562happening. On MS-Windows systems you get the message "[unix format]" if
563'fileformat' is set to "unix". On all systems but the Macintosh you get the
564message "[mac format]" if 'fileformat' is set to "mac".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000565
566If the 'fileformats' option is empty and DOS format is used, but while reading
567a file some lines did not end in <CR><NL>, "[CR missing]" will be included in
568the file message.
569If the 'fileformats' option is empty and Mac format is used, but while reading
570a file a <NL> was found, "[NL missing]" will be included in the file message.
571
572If the new file does not exist, the 'fileformat' of the current buffer is used
573when 'fileformats' is empty. Otherwise the first format from 'fileformats' is
574used for the new file.
575
576Before editing binary, executable or Vim script files you should set the
577'binary' option. A simple way to do this is by starting Vim with the "-b"
578option. This will avoid the use of 'fileformat'. Without this you risk that
579single <NL> characters are unexpectedly replaced with <CR><NL>.
580
581You can encrypt files that are written by setting the 'key' option. This
582provides some security against others reading your files. |encryption|
583
584
Bram Moolenaar071d4272004-06-13 20:20:40 +0000585==============================================================================
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005863. The argument list *argument-list* *arglist*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000587
588If you give more than one file name when starting Vim, this list is remembered
589as the argument list. You can jump to each file in this list.
590
591Do not confuse this with the buffer list, which you can see with the
592|:buffers| command. The argument list was already present in Vi, the buffer
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000593list is new in Vim. Every file name in the argument list will also be present
594in the buffer list (unless it was deleted with |:bdel| or |:bwipe|). But it's
595common that names in the buffer list are not in the argument list.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000596
597This subject is introduced in section |07.2| of the user manual.
598
599There is one global argument list, which is used for all windows by default.
600It is possible to create a new argument list local to a window, see
601|:arglocal|.
602
603You can use the argument list with the following commands, and with the
604expression functions |argc()| and |argv()|. These all work on the argument
605list of the current window.
606
Bram Moolenaar12ee7ff2019-06-10 22:47:40 +0200607 *:ar* *:arg* *:args*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000608:ar[gs] Print the argument list, with the current file in
609 square brackets.
610
611:ar[gs] [++opt] [+cmd] {arglist} *:args_f*
612 Define {arglist} as the new argument list and edit
613 the first one. This fails when changes have been made
614 and Vim does not want to |abandon| the current buffer.
615 Also see |++opt| and |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000616
617:ar[gs]! [++opt] [+cmd] {arglist} *:args_f!*
618 Define {arglist} as the new argument list and edit
619 the first one. Discard any changes to the current
620 buffer.
621 Also see |++opt| and |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000622
Bram Moolenaar90305c62017-07-16 15:31:17 +0200623:[count]arge[dit][!] [++opt] [+cmd] {name} .. *:arge* *:argedit*
624 Add {name}s to the argument list and edit it.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000625 When {name} already exists in the argument list, this
626 entry is edited.
627 This is like using |:argadd| and then |:edit|.
Bram Moolenaar90305c62017-07-16 15:31:17 +0200628 Spaces in filenames have to be escaped with "\".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000629 [count] is used like with |:argadd|.
Bram Moolenaar90305c62017-07-16 15:31:17 +0200630 If the current file cannot be |abandon|ed {name}s will
631 still be added to the argument list, but won't be
632 edited. No check for duplicates is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000633 Also see |++opt| and |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000634
635:[count]arga[dd] {name} .. *:arga* *:argadd* *E479*
Bram Moolenaar91e15e12014-09-19 22:38:48 +0200636:[count]arga[dd]
637 Add the {name}s to the argument list. When {name} is
Bram Moolenaared32d942014-12-06 23:33:00 +0100638 omitted add the current buffer name to the argument
Bram Moolenaar91e15e12014-09-19 22:38:48 +0200639 list.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000640 If [count] is omitted, the {name}s are added just
641 after the current entry in the argument list.
642 Otherwise they are added after the [count]'th file.
643 If the argument list is "a b c", and "b" is the
644 current argument, then these commands result in:
645 command new argument list ~
646 :argadd x a b x c
647 :0argadd x x a b c
648 :1argadd x a x b c
Bram Moolenaared32d942014-12-06 23:33:00 +0100649 :$argadd x a b c x
Bram Moolenaar85084ef2016-01-17 22:26:33 +0100650 And after the last one:
Bram Moolenaared32d942014-12-06 23:33:00 +0100651 :+2argadd y a b c x y
Bram Moolenaar071d4272004-06-13 20:20:40 +0000652 There is no check for duplicates, it is possible to
Nir Lichtman73a02422021-12-24 20:28:03 +0000653 add a file to the argument list twice. You can use
654 |:argdedupe| to fix it afterwards: >
655 :argadd *.txt | argdedupe
656< The currently edited file is not changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000657 Note: you can also use this method: >
658 :args ## x
659< This will add the "x" item and sort the new list.
660
Nir Lichtman73a02422021-12-24 20:28:03 +0000661:argded[upe] *:argded* *:argdedupe*
662 Remove duplicate filenames from the argument list.
663 If your current file is a duplicate, your current file
664 will change to the original file index.
665
Bram Moolenaar207f0092020-08-30 17:20:20 +0200666:argd[elete] {pattern} .. *:argd* *:argdelete* *E480* *E610*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000667 Delete files from the argument list that match the
668 {pattern}s. {pattern} is used like a file pattern,
669 see |file-pattern|. "%" can be used to delete the
670 current entry.
671 This command keeps the currently edited file, also
672 when it's deleted from the argument list.
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +0000673 Example: >
674 :argdel *.obj
Bram Moolenaar071d4272004-06-13 20:20:40 +0000675
Bram Moolenaar207f0092020-08-30 17:20:20 +0200676:[range]argd[elete] Delete the [range] files from the argument list.
Bram Moolenaared32d942014-12-06 23:33:00 +0100677 Example: >
678 :10,$argdel
679< Deletes arguments 10 and further, keeping 1-9. >
680 :$argd
681< Deletes just the last one. >
682 :argd
683 :.argd
684< Deletes the current argument. >
685 :%argd
686< Removes all the files from the arglist.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000687 When the last number in the range is too high, up to
Bram Moolenaared32d942014-12-06 23:33:00 +0100688 the last argument is deleted.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000689
690 *:argu* *:argument*
691:[count]argu[ment] [count] [++opt] [+cmd]
692 Edit file [count] in the argument list. When [count]
693 is omitted the current entry is used. This fails
694 when changes have been made and Vim does not want to
695 |abandon| the current buffer.
696 Also see |++opt| and |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000697
698:[count]argu[ment]! [count] [++opt] [+cmd]
699 Edit file [count] in the argument list, discard any
700 changes to the current buffer. When [count] is
701 omitted the current entry is used.
702 Also see |++opt| and |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000703
704:[count]n[ext] [++opt] [+cmd] *:n* *:ne* *:next* *E165* *E163*
705 Edit [count] next file. This fails when changes have
706 been made and Vim does not want to |abandon| the
Bram Moolenaara6c27c42019-05-09 19:16:22 +0200707 current buffer. Also see |++opt| and |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000708
709:[count]n[ext]! [++opt] [+cmd]
710 Edit [count] next file, discard any changes to the
Bram Moolenaara6c27c42019-05-09 19:16:22 +0200711 buffer. Also see |++opt| and |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000712
713:n[ext] [++opt] [+cmd] {arglist} *:next_f*
714 Same as |:args_f|.
715
716:n[ext]! [++opt] [+cmd] {arglist}
717 Same as |:args_f!|.
718
719:[count]N[ext] [count] [++opt] [+cmd] *:Next* *:N* *E164*
720 Edit [count] previous file in argument list. This
721 fails when changes have been made and Vim does not
722 want to |abandon| the current buffer.
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200723 Also see |++opt| and |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000724
725:[count]N[ext]! [count] [++opt] [+cmd]
726 Edit [count] previous file in argument list. Discard
727 any changes to the buffer. Also see |++opt| and
Bram Moolenaara6c27c42019-05-09 19:16:22 +0200728 |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000729
730:[count]prev[ious] [count] [++opt] [+cmd] *:prev* *:previous*
Bram Moolenaara6c27c42019-05-09 19:16:22 +0200731 Same as :Next. Also see |++opt| and |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000732
733 *:rew* *:rewind*
734:rew[ind] [++opt] [+cmd]
735 Start editing the first file in the argument list.
736 This fails when changes have been made and Vim does
737 not want to |abandon| the current buffer.
Bram Moolenaara6c27c42019-05-09 19:16:22 +0200738 Also see |++opt| and |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000739
740:rew[ind]! [++opt] [+cmd]
741 Start editing the first file in the argument list.
742 Discard any changes to the buffer. Also see |++opt|
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200743 and |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000744
745 *:fir* *:first*
746:fir[st][!] [++opt] [+cmd]
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200747 Other name for ":rewind".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000748
749 *:la* *:last*
750:la[st] [++opt] [+cmd]
751 Start editing the last file in the argument list.
752 This fails when changes have been made and Vim does
753 not want to |abandon| the current buffer.
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200754 Also see |++opt| and |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000755
756:la[st]! [++opt] [+cmd]
757 Start editing the last file in the argument list.
758 Discard any changes to the buffer. Also see |++opt|
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200759 and |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000760
761 *:wn* *:wnext*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000762:[count]wn[ext] [++opt]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000763 Write current file and start editing the [count]
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200764 next file. Also see |++opt| and |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000765
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000766:[count]wn[ext] [++opt] {file}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000767 Write current file to {file} and start editing the
768 [count] next file, unless {file} already exists and
769 the 'writeany' option is off. Also see |++opt| and
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200770 |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000771
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000772:[count]wn[ext]! [++opt] {file}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000773 Write current file to {file} and start editing the
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200774 [count] next file. Also see |++opt| and |+cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000775
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000776:[count]wN[ext][!] [++opt] [file] *:wN* *:wNext*
777:[count]wp[revious][!] [++opt] [file] *:wp* *:wprevious*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000778 Same as :wnext, but go to previous file instead of
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200779 next.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000780
781The [count] in the commands above defaults to one. For some commands it is
782possible to use two counts. The last one (rightmost one) is used.
783
784If no [+cmd] argument is present, the cursor is positioned at the last known
785cursor position for the file. If 'startofline' is set, the cursor will be
786positioned at the first non-blank in the line, otherwise the last know column
787is used. If there is no last known cursor position the cursor will be in the
788first line (the last line in Ex mode).
789
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000790 *{arglist}*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000791The wildcards in the argument list are expanded and the file names are sorted.
792Thus you can use the command "vim *.c" to edit all the C files. From within
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000793Vim the command ":n *.c" does the same.
794
795White space is used to separate file names. Put a backslash before a space or
Bram Moolenaar9e368db2007-05-12 13:25:01 +0000796tab to include it in a file name. E.g., to edit the single file "foo bar": >
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000797 :next foo\ bar
798
799On Unix and a few other systems you can also use backticks, for example: >
800 :next `find . -name \\*.c -print`
Bram Moolenaar071d4272004-06-13 20:20:40 +0000801The backslashes before the star are required to prevent "*.c" to be expanded
802by the shell before executing the find program.
803
804 *arglist-position*
805When there is an argument list you can see which file you are editing in the
806title of the window (if there is one and 'title' is on) and with the file
807message you get with the "CTRL-G" command. You will see something like
808 (file 4 of 11)
809If 'shortmess' contains 'f' it will be
810 (4 of 11)
811If you are not really editing the file at the current position in the argument
812list it will be
813 (file (4) of 11)
814This means that you are position 4 in the argument list, but not editing the
815fourth file in the argument list. This happens when you do ":e file".
816
817
818LOCAL ARGUMENT LIST
819
Bram Moolenaar071d4272004-06-13 20:20:40 +0000820 *:arglocal*
821:argl[ocal] Make a local copy of the global argument list.
822 Doesn't start editing another file.
823
824:argl[ocal][!] [++opt] [+cmd] {arglist}
825 Define a new argument list, which is local to the
826 current window. Works like |:args_f| otherwise.
827
828 *:argglobal*
829:argg[lobal] Use the global argument list for the current window.
830 Doesn't start editing another file.
831
832:argg[lobal][!] [++opt] [+cmd] {arglist}
833 Use the global argument list for the current window.
834 Define a new global argument list like |:args_f|.
835 All windows using the global argument list will see
836 this new list.
837
838There can be several argument lists. They can be shared between windows.
839When they are shared, changing the argument list in one window will also
840change it in the other window.
841
842When a window is split the new window inherits the argument list from the
843current window. The two windows then share this list, until one of them uses
844|:arglocal| or |:argglobal| to use another argument list.
845
846
847USING THE ARGUMENT LIST
848
849 *:argdo*
Bram Moolenaara162bc52015-01-07 16:54:21 +0100850:[range]argdo[!] {cmd} Execute {cmd} for each file in the argument list or
851 if [range] is specified only for arguments in that
852 range. It works like doing this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000853 :rewind
854 :{cmd}
855 :next
856 :{cmd}
857 etc.
858< When the current file can't be |abandon|ed and the [!]
859 is not present, the command fails.
860 When an error is detected on one file, further files
861 in the argument list will not be visited.
862 The last file in the argument list (or where an error
863 occurred) becomes the current file.
864 {cmd} can contain '|' to concatenate several commands.
865 {cmd} must not change the argument list.
866 Note: While this command is executing, the Syntax
867 autocommand event is disabled by adding it to
868 'eventignore'. This considerably speeds up editing
869 each file.
Bram Moolenaaraa23b372015-09-08 18:46:31 +0200870 Also see |:windo|, |:tabdo|, |:bufdo|, |:cdo|, |:ldo|,
871 |:cfdo| and |:lfdo|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000872
873Example: >
874 :args *.c
875 :argdo set ff=unix | update
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100876This sets the 'fileformat' option to "unix" and writes the file if it is now
Bram Moolenaar071d4272004-06-13 20:20:40 +0000877changed. This is done for all *.c files.
878
879Example: >
880 :args *.[ch]
881 :argdo %s/\<my_foo\>/My_Foo/ge | update
882This changes the word "my_foo" to "My_Foo" in all *.c and *.h files. The "e"
883flag is used for the ":substitute" command to avoid an error for files where
884"my_foo" isn't used. ":update" writes the file only if changes were made.
885
886==============================================================================
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00008874. Writing *writing* *save-file*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000888
889Note: When the 'write' option is off, you are not able to write any file.
890
891 *:w* *:write*
Bram Moolenaar6dc819b2018-07-03 16:42:19 +0200892 *E502* *E503* *E504* *E505*
893 *E512* *E514* *E667* *E796* *E949*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000894:w[rite] [++opt] Write the whole buffer to the current file. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000895 the normal way to save changes to a file. It fails
896 when the 'readonly' option is set or when there is
897 another reason why the file can't be written.
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000898 For ++opt see |++opt|, but only ++bin, ++nobin, ++ff
899 and ++enc are effective.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000900
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000901:w[rite]! [++opt] Like ":write", but forcefully write when 'readonly' is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000902 set or there is another reason why writing was
903 refused.
904 Note: This may change the permission and ownership of
905 the file and break (symbolic) links. Add the 'W' flag
906 to 'cpoptions' to avoid this.
907
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000908:[range]w[rite][!] [++opt]
909 Write the specified lines to the current file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000910 is unusual, because the file will not contain all
911 lines in the buffer.
912
913 *:w_f* *:write_f*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000914:[range]w[rite] [++opt] {file}
915 Write the specified lines to {file}, unless it
Bram Moolenaar071d4272004-06-13 20:20:40 +0000916 already exists and the 'writeany' option is off.
917
918 *:w!*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000919:[range]w[rite]! [++opt] {file}
920 Write the specified lines to {file}. Overwrite an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000921 existing file.
922
923 *:w_a* *:write_a* *E494*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000924:[range]w[rite][!] [++opt] >>
925 Append the specified lines to the current file.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000926
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000927:[range]w[rite][!] [++opt] >> {file}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000928 Append the specified lines to {file}. '!' forces the
929 write even if file does not exist.
930
931 *:w_c* *:write_c*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000932:[range]w[rite] [++opt] !{cmd}
933 Execute {cmd} with [range] lines as standard input
Bram Moolenaar071d4272004-06-13 20:20:40 +0000934 (note the space in front of the '!'). {cmd} is
935 executed like with ":!{cmd}", any '!' is replaced with
936 the previous command |:!|.
937
Bram Moolenaar5c4e21c2004-10-12 19:54:52 +0000938The default [range] for the ":w" command is the whole buffer (1,$). If you
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000939write the whole buffer, it is no longer considered changed. When you
940write it to a different file with ":w somefile" it depends on the "+" flag in
941'cpoptions'. When included, the write command will reset the 'modified' flag,
942even though the buffer itself may still be different from its file.
Bram Moolenaar5c4e21c2004-10-12 19:54:52 +0000943
Bram Moolenaar071d4272004-06-13 20:20:40 +0000944If a file name is given with ":w" it becomes the alternate file. This can be
945used, for example, when the write fails and you want to try again later with
946":w #". This can be switched off by removing the 'A' flag from the
947'cpoptions' option.
948
Bram Moolenaara2a80162017-11-21 23:09:50 +0100949Note that the 'fsync' option matters here. If it's set it may make writes
950slower (but safer).
951
Bram Moolenaar071d4272004-06-13 20:20:40 +0000952 *:sav* *:saveas*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000953:sav[eas][!] [++opt] {file}
954 Save the current buffer under the name {file} and set
Bram Moolenaar071d4272004-06-13 20:20:40 +0000955 the filename of the current buffer to {file}. The
956 previous name is used for the alternate file name.
957 The [!] is needed to overwrite an existing file.
Bram Moolenaar2d3f4892006-01-20 23:02:51 +0000958 When 'filetype' is empty filetype detection is done
959 with the new name, before the file is written.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000960 When the write was successful 'readonly' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000961
962 *:up* *:update*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000963:[range]up[date][!] [++opt] [>>] [file]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000964 Like ":write", but only write when the buffer has been
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200965 modified.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000966
967
968WRITING WITH MULTIPLE BUFFERS *buffer-write*
969
970 *:wa* *:wall*
971:wa[ll] Write all changed buffers. Buffers without a file
Bram Moolenaar51628222016-12-01 23:03:28 +0100972 name cause an error message. Buffers which are
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200973 readonly are not written.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000974
975:wa[ll]! Write all changed buffers, even the ones that are
976 readonly. Buffers without a file name are not
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200977 written and cause an error message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000978
979
980Vim will warn you if you try to overwrite a file that has been changed
981elsewhere. See |timestamp|.
982
983 *backup* *E207* *E506* *E507* *E508* *E509* *E510*
984If you write to an existing file (but do not append) while the 'backup',
985'writebackup' or 'patchmode' option is on, a backup of the original file is
986made. The file is either copied or renamed (see 'backupcopy'). After the
987file has been successfully written and when the 'writebackup' option is on and
988the 'backup' option is off, the backup file is deleted. When the 'patchmode'
989option is on the backup file may be renamed.
990
991 *backup-table*
992'backup' 'writebackup' action ~
993 off off no backup made
994 off on backup current file, deleted afterwards (default)
995 on off delete old backup, backup current file
996 on on delete old backup, backup current file
997
998When the 'backupskip' pattern matches with the name of the file which is
999written, no backup file is made. The values of 'backup' and 'writebackup' are
1000ignored then.
1001
1002When the 'backup' option is on, an old backup file (with the same name as the
1003new backup file) will be deleted. If 'backup' is not set, but 'writebackup'
1004is set, an existing backup file will not be deleted. The backup file that is
1005made while the file is being written will have a different name.
1006
1007On some filesystems it's possible that in a crash you lose both the backup and
1008the newly written file (it might be there but contain bogus data). In that
1009case try recovery, because the swap file is synced to disk and might still be
1010there. |:recover|
1011
Bram Moolenaare0fa3742016-02-20 15:47:01 +01001012The directories given with the 'backupdir' option are used to put the backup
Bram Moolenaar071d4272004-06-13 20:20:40 +00001013file in. (default: same directory as the written file).
1014
1015Whether the backup is a new file, which is a copy of the original file, or the
1016original file renamed depends on the 'backupcopy' option. See there for an
1017explanation of when the copy is made and when the file is renamed.
1018
1019If the creation of a backup file fails, the write is not done. If you want
1020to write anyway add a '!' to the command.
1021
Bram Moolenaard58e9292011-02-09 17:07:58 +01001022 *write-permissions*
1023When writing a new file the permissions are read-write. For unix the mask is
Bram Moolenaar82be4842021-01-11 19:40:15 +010010240o666 with additionally umask applied. When writing a file that was read Vim
Bram Moolenaard58e9292011-02-09 17:07:58 +01001025will preserve the permissions, but clear the s-bit.
1026
Bram Moolenaar071d4272004-06-13 20:20:40 +00001027 *write-readonly*
1028When the 'cpoptions' option contains 'W', Vim will refuse to overwrite a
1029readonly file. When 'W' is not present, ":w!" will overwrite a readonly file,
1030if the system allows it (the directory must be writable).
1031
1032 *write-fail*
1033If the writing of the new file fails, you have to be careful not to lose
1034your changes AND the original file. If there is no backup file and writing
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001035the new file failed, you have already lost the original file! DON'T EXIT VIM
1036UNTIL YOU WRITE OUT THE FILE! If a backup was made, it is put back in place
Bram Moolenaar071d4272004-06-13 20:20:40 +00001037of the original file (if possible). If you exit Vim, and lose the changes
1038you made, the original file will mostly still be there. If putting back the
1039original file fails, there will be an error message telling you that you
1040lost the original file.
1041
1042 *DOS-format-write*
Bram Moolenaar4072ba52020-12-23 13:56:35 +01001043If the 'fileformat' is "dos", <CR><NL> is used for <EOL>. This is default
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001044for Win32. On other systems the message "[dos format]" is shown to remind you
1045that an unusual <EOL> was used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001046 *Unix-format-write*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001047If the 'fileformat' is "unix", <NL> is used for <EOL>. On Win32 the message
1048"[unix format]" is shown.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001049 *Mac-format-write*
1050If the 'fileformat' is "mac", <CR> is used for <EOL>. On non-Mac systems the
1051message "[mac format]" is shown.
1052
1053See also |file-formats| and the 'fileformat' and 'fileformats' options.
1054
1055 *ACL*
1056ACL stands for Access Control List. It is an advanced way to control access
1057rights for a file. It is used on new MS-Windows and Unix systems, but only
1058when the filesystem supports it.
1059 Vim attempts to preserve the ACL info when writing a file. The backup file
1060will get the ACL info of the original file.
1061 The ACL info is also used to check if a file is read-only (when opening the
1062file).
1063
1064 *read-only-share*
1065When MS-Windows shares a drive on the network it can be marked as read-only.
1066This means that even if the file read-only attribute is absent, and the ACL
1067settings on NT network shared drives allow writing to the file, you can still
1068not write to the file. Vim on Win32 platforms will detect read-only network
1069drives and will mark the file as read-only. You will not be able to override
1070it with |:write|.
1071
1072 *write-device*
1073When the file name is actually a device name, Vim will not make a backup (that
1074would be impossible). You need to use "!", since the device already exists.
1075Example for Unix: >
1076 :w! /dev/lpt0
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001077and for MS-Windows: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00001078 :w! lpt0
1079For Unix a device is detected when the name doesn't refer to a normal file or
1080a directory. A fifo or named pipe also looks like a device to Vim.
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001081For MS-Windows the device is detected by its name:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001082 AUX
1083 CON
1084 CLOCK$
1085 NUL
1086 PRN
1087 COMn n=1,2,3... etc
1088 LPTn n=1,2,3... etc
1089The names can be in upper- or lowercase.
1090
1091==============================================================================
Bram Moolenaar1cd871b2004-12-19 22:46:22 +000010925. Writing and quitting *write-quit*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001093
1094 *:q* *:quit*
1095:q[uit] Quit the current window. Quit Vim if this is the last
Bram Moolenaar47e13952020-05-12 22:49:12 +02001096 |edit-window|. This fails when changes have been made
1097 and Vim refuses to |abandon| the current buffer, and
1098 when the last file in the argument list has not been
Bram Moolenaar071d4272004-06-13 20:20:40 +00001099 edited.
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00001100 If there are other tab pages and quitting the last
1101 window in the current tab page the current tab page is
1102 closed |tab-page|.
Bram Moolenaar30b65812012-07-12 22:01:11 +02001103 Triggers the |QuitPre| autocommand event.
Bram Moolenaarc572da52017-08-27 16:52:01 +02001104 See |CTRL-W_q| for quitting another window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001105
1106:conf[irm] q[uit] Quit, but give prompt when changes have been made, or
1107 the last file in the argument list has not been
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001108 edited. See |:confirm| and 'confirm'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001109
Bram Moolenaarfa735342016-01-03 22:14:44 +01001110:q[uit]! Quit without writing, also when the current buffer has
Bram Moolenaar09521312016-08-12 22:54:35 +02001111 changes. The buffer is unloaded, also when it has
1112 'hidden' set.
1113 If this is the last window and there is a modified
1114 hidden buffer, the current buffer is abandoned and the
1115 first changed hidden buffer becomes the current
1116 buffer.
Bram Moolenaar2f3b5102014-11-19 18:54:17 +01001117 Use ":qall!" to exit always.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001118
1119:cq[uit] Quit always, without writing, and return an error
1120 code. See |:cq|. Used for Manx's QuickFix mode (see
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001121 |quickfix|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001122
1123 *:wq*
Bram Moolenaar47e13952020-05-12 22:49:12 +02001124:wq [++opt] Write the current file and close the window. If this
1125 was the last |edit-window| Vim quits.
1126 Writing fails when the file is read-only or the buffer
1127 does not have a name. Quitting fails when the last
1128 file in the argument list has not been edited.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001129
Bram Moolenaar47e13952020-05-12 22:49:12 +02001130:wq! [++opt] Write the current file and close the window. If this
1131 was the last |edit-window| Vim quits. Writing fails
1132 when the current buffer does not have a name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001133
Bram Moolenaar47e13952020-05-12 22:49:12 +02001134:wq [++opt] {file} Write to {file} and close the window. If this was the
1135 last |edit-window| Vim quits. Quitting fails when the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001136 last file in the argument list has not been edited.
1137
Bram Moolenaar47e13952020-05-12 22:49:12 +02001138:wq! [++opt] {file} Write to {file} and close the current window. Quit
1139 Vim if this was the last |edit-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001140
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001141:[range]wq[!] [++opt] [file]
1142 Same as above, but only write the lines in [range].
Bram Moolenaar071d4272004-06-13 20:20:40 +00001143
1144 *:x* *:xit*
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001145:[range]x[it][!] [++opt] [file]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001146 Like ":wq", but write only when changes have been
1147 made.
1148 When 'hidden' is set and there are more windows, the
1149 current buffer becomes hidden, after writing the file.
Bram Moolenaara4d131d2021-12-27 21:33:07 +00001150 This command is not supported in |Vim9| script,
1151 because it is too easily confused with a variable
1152 name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001153
1154 *:exi* *:exit*
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001155:[range]exi[t][!] [++opt] [file]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001156 Same as :xit.
1157
1158 *ZZ*
Bram Moolenaar47e13952020-05-12 22:49:12 +02001159ZZ Write current file, if modified, and close the current
1160 window (same as ":x").
1161 If there are several windows for the current file,
1162 only the current window is closed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001163
1164 *ZQ*
1165ZQ Quit without checking for changes (same as ":q!").
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001166
Bram Moolenaar071d4272004-06-13 20:20:40 +00001167
1168MULTIPLE WINDOWS AND BUFFERS *window-exit*
1169
1170 *:qa* *:qall*
1171:qa[ll] Exit Vim, unless there are some buffers which have been
1172 changed. (Use ":bmod" to go to the next modified buffer).
1173 When 'autowriteall' is set all changed buffers will be
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001174 written, like |:wqall|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001175
1176:conf[irm] qa[ll]
1177 Exit Vim. Bring up a prompt when some buffers have been
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001178 changed. See |:confirm|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001179
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001180:qa[ll]! Exit Vim. Any changes to buffers are lost.
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00001181 Also see |:cquit|, it does the same but exits with a non-zero
1182 value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001183
1184 *:quita* *:quitall*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001185:quita[ll][!] Same as ":qall".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001186
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001187:wqa[ll] [++opt] *:wqa* *:wqall* *:xa* *:xall*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001188:xa[ll] Write all changed buffers and exit Vim. If there are buffers
1189 without a file name, which are readonly or which cannot be
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001190 written for another reason, Vim will not quit.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001191
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001192:conf[irm] wqa[ll] [++opt]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001193:conf[irm] xa[ll]
1194 Write all changed buffers and exit Vim. Bring up a prompt
1195 when some buffers are readonly or cannot be written for
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001196 another reason. See |:confirm|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001197
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001198:wqa[ll]! [++opt]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001199:xa[ll]! Write all changed buffers, even the ones that are readonly,
1200 and exit Vim. If there are buffers without a file name or
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001201 which cannot be written for another reason, or there is a
1202 terminal with a running job, Vim will not quit.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001203
1204==============================================================================
Bram Moolenaar1cd871b2004-12-19 22:46:22 +000012056. Dialogs *edit-dialogs*
1206
1207 *:confirm* *:conf*
1208:conf[irm] {command} Execute {command}, and use a dialog when an
1209 operation has to be confirmed. Can be used on the
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02001210 |:q|, |:qa| and |:w| commands (the latter to override
1211 a read-only setting), and any other command that can
1212 fail in such a way, such as |:only|, |:buffer|,
1213 |:bdelete|, etc.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001214
1215Examples: >
1216 :confirm w foo
1217< Will ask for confirmation when "foo" already exists. >
1218 :confirm q
1219< Will ask for confirmation when there are changes. >
1220 :confirm qa
1221< If any modified, unsaved buffers exist, you will be prompted to save
1222 or abandon each one. There are also choices to "save all" or "abandon
1223 all".
1224
1225If you want to always use ":confirm", set the 'confirm' option.
1226
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02001227 *:browse* *:bro* *E338* *E614* *E615* *E616*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001228:bro[wse] {command} Open a file selection dialog for an argument to
1229 {command}. At present this works for |:e|, |:w|,
Bram Moolenaar9028b102010-07-11 16:58:51 +02001230 |:wall|, |:wq|, |:wqall|, |:x|, |:xall|, |:exit|,
1231 |:view|, |:sview|, |:r|, |:saveas|, |:sp|, |:mkexrc|,
1232 |:mkvimrc|, |:mksession|, |:mkview|, |:split|,
1233 |:vsplit|, |:tabe|, |:tabnew|, |:cfile|, |:cgetfile|,
1234 |:caddfile|, |:lfile|, |:lgetfile|, |:laddfile|,
1235 |:diffsplit|, |:diffpatch|, |:open|, |:pedit|,
1236 |:redir|, |:source|, |:update|, |:visual|, |:vsplit|,
1237 and |:qall| if 'confirm' is set.
Bram Moolenaar6e649222021-10-04 21:32:54 +01001238 {only in Win32, Athena, Motif, GTK and Mac GUI, in
1239 console `browse edit` works if the FileExplorer
1240 autocommand group exists}
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001241 When ":browse" is not possible you get an error
1242 message. If the |+browse| feature is missing or the
1243 {command} doesn't support browsing, the {command} is
1244 executed without a dialog.
1245 ":browse set" works like |:options|.
Bram Moolenaar9028b102010-07-11 16:58:51 +02001246 See also |:oldfiles| for ":browse oldfiles".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001247
1248The syntax is best shown via some examples: >
1249 :browse e $vim/foo
1250< Open the browser in the $vim/foo directory, and edit the
1251 file chosen. >
1252 :browse e
1253< Open the browser in the directory specified with 'browsedir',
1254 and edit the file chosen. >
1255 :browse w
1256< Open the browser in the directory of the current buffer,
1257 with the current buffer filename as default, and save the
1258 buffer under the filename chosen. >
1259 :browse w C:/bar
1260< Open the browser in the C:/bar directory, with the current
1261 buffer filename as default, and save the buffer under the
1262 filename chosen.
Bram Moolenaar30e9b3c2019-09-07 16:24:12 +02001263Also see the 'browsedir' option.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001264For versions of Vim where browsing is not supported, the command is executed
1265unmodified.
1266
1267 *browsefilter*
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02001268For MS-Windows and GTK, you can modify the filters that are used in the browse
Bram Moolenaar30b65812012-07-12 22:01:11 +02001269dialog. By setting the g:browsefilter or b:browsefilter variables, you can
1270change the filters globally or locally to the buffer. The variable is set to
1271a string in the format "{filter label}\t{pattern};{pattern}\n" where {filter
1272label} is the text that appears in the "Files of Type" comboBox, and {pattern}
1273is the pattern which filters the filenames. Several patterns can be given,
1274separated by ';'.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001275
1276For Motif the same format is used, but only the very first pattern is actually
1277used (Motif only offers one pattern, but you can edit it).
1278
1279For example, to have only Vim files in the dialog, you could use the following
1280command: >
1281
Bram Moolenaar30b65812012-07-12 22:01:11 +02001282 let g:browsefilter = "Vim Scripts\t*.vim\nVim Startup Files\t*vimrc\n"
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001283
1284You can override the filter setting on a per-buffer basis by setting the
1285b:browsefilter variable. You would most likely set b:browsefilter in a
1286filetype plugin, so that the browse dialog would contain entries related to
1287the type of file you are currently editing. Disadvantage: This makes it
1288difficult to start editing a file of a different type. To overcome this, you
1289may want to add "All Files\t*.*\n" as the final filter, so that the user can
1290still access any desired file.
1291
Bram Moolenaar30b65812012-07-12 22:01:11 +02001292To avoid setting browsefilter when Vim does not actually support it, you can
1293use has("browsefilter"): >
1294
1295 if has("browsefilter")
1296 let g:browsefilter = "whatever"
1297 endif
1298
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001299==============================================================================
13007. The current directory *current-directory*
1301
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001302You can use the |:cd|, |:tcd| and |:lcd| commands to change to another
1303directory, so you will not have to type that directory name in front of the
1304file names. It also makes a difference for executing external commands, e.g.
1305":!ls".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001306
Bram Moolenaardf177f62005-02-22 08:39:57 +00001307Changing directory fails when the current buffer is modified, the '.' flag is
1308present in 'cpoptions' and "!" is not used in the command.
1309
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00001310 *:cd* *E747* *E472*
Bakudankun29f3a452021-12-11 12:28:08 +00001311:cd[!] On non-Unix systems when 'cdhome' is off: Print the
1312 current directory name.
1313 Otherwise: Change the current directory to the home
1314 directory. Clear any window-local directory.
1315 Use |:pwd| to print the current directory on all
1316 systems.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001317
Bram Moolenaardf177f62005-02-22 08:39:57 +00001318:cd[!] {path} Change the current directory to {path}.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001319 If {path} is relative, it is searched for in the
1320 directories listed in |'cdpath'|.
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001321 Clear any window-local directory.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001322 Does not change the meaning of an already opened file,
1323 because its full path name is remembered. Files from
1324 the |arglist| may change though!
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001325 On MS-Windows this also changes the active drive.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001326 To change to the directory of the current file: >
1327 :cd %:h
1328<
1329 *:cd-* *E186*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001330:cd[!] - Change to the previous current directory (before the
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001331 previous ":cd {path}" command).
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001332
1333 *:chd* *:chdir*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001334:chd[ir][!] [path] Same as |:cd|.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001335
Bram Moolenaard2ea7cf2021-05-30 20:54:13 +02001336 *:tc* *:tcd*
1337:tc[d][!] {path} Like |:cd|, but only set the directory for the current
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001338 tab. The current window will also use this directory.
1339 The current directory is not changed for windows in
1340 other tabs and for windows in the current tab that
1341 have their own window-local directory.
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001342
Bram Moolenaar002bc792020-06-05 22:33:42 +02001343 *:tcd-*
Bram Moolenaard2ea7cf2021-05-30 20:54:13 +02001344:tc[d][!] - Change to the previous current directory, before the
Bram Moolenaar002bc792020-06-05 22:33:42 +02001345 last ":tcd {path}" command.
1346
Bram Moolenaar22863042021-10-16 15:23:36 +01001347 *:tch* *:tchdir*
1348:tch[dir][!] Same as |:tcd|.
1349
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001350 *:lc* *:lcd*
Bram Moolenaar74675a62017-07-15 13:53:23 +02001351:lc[d][!] {path} Like |:cd|, but only set the current directory when
1352 the cursor is in the current window. The current
1353 directory for other windows is not changed, switching
1354 to another window will stop using {path}.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001355
Bram Moolenaar002bc792020-06-05 22:33:42 +02001356 *:lcd-*
1357:lcd[!] - Change to the previous current directory, before the
1358 last ":lcd {path}" command.
1359
Bram Moolenaar22863042021-10-16 15:23:36 +01001360 *:lch* *:lchdir*
1361:lch[dir][!] Same as |:lcd|.
1362
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001363 *:pw* *:pwd* *E187*
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001364:pw[d] Print the current directory name.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001365 Also see |getcwd()|.
Bram Moolenaar95058722020-06-01 16:26:19 +02001366 *:pwd-verbose*
1367 When 'verbose' is non-zero, |:pwd| will also display
1368 what scope the current directory was set. Example: >
1369
1370 " Set by :cd
1371 :verbose pwd
1372 [global] /path/to/current
1373
1374 " Set by :lcd
1375 :verbose pwd
1376 [window] /path/to/current
1377
1378 " Set by :tcd
1379 :verbose pwd
1380 [tabpage] /path/to/current
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001381
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001382So long as no |:lcd| or |:tcd| command has been used, all windows share the
1383same current directory. Using a command to jump to another window doesn't
1384change anything for the current directory.
1385
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001386When a |:lcd| command has been used for a window, the specified directory
1387becomes the current directory for that window. Windows where the |:lcd|
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001388command has not been used stick to the global or tab-local current directory.
Bram Moolenaar22863042021-10-16 15:23:36 +01001389When jumping to another window the current directory is changed to the last
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001390specified local current directory. If none was specified, the global or
1391tab-local current directory is used.
1392
1393When a |:tcd| command has been used for a tab page, the specified directory
1394becomes the current directory for the current tab page and the current window.
1395The current directory of other tab pages is not affected. When jumping to
Bram Moolenaar22863042021-10-16 15:23:36 +01001396another tab page, the current directory is changed to the last specified local
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001397directory for that tab page. If the current tab has no local current directory
1398the global current directory is used.
1399
1400When a |:cd| command is used, the current window and tab page will lose the
1401local current directory and will use the global current directory from now on.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001402
1403After using |:cd| the full path name will be used for reading and writing
1404files. On some networked file systems this may cause problems. The result of
1405using the full path name is that the file names currently in use will remain
1406referring to the same file. Example: If you have a file a:test and a
1407directory a:vim the commands ":e test" ":cd vim" ":w" will overwrite the file
1408a:test and not write a:vim/test. But if you do ":w test" the file a:vim/test
1409will be written, because you gave a new file name and did not refer to a
1410filename before the ":cd".
1411
1412==============================================================================
Bram Moolenaar071d4272004-06-13 20:20:40 +000014138. Editing binary files *edit-binary*
1414
1415Although Vim was made to edit text files, it is possible to edit binary
1416files. The |-b| Vim argument (b for binary) makes Vim do file I/O in binary
1417mode, and sets some options for editing binary files ('binary' on, 'textwidth'
1418to 0, 'modeline' off, 'expandtab' off). Setting the 'binary' option has the
1419same effect. Don't forget to do this before reading the file.
1420
1421There are a few things to remember when editing binary files:
Bram Moolenaar7ff78462020-07-10 22:00:53 +02001422- When editing executable files the number of bytes must not change.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001423 Use only the "R" or "r" command to change text. Do not delete characters
1424 with "x" or by backspacing.
1425- Set the 'textwidth' option to 0. Otherwise lines will unexpectedly be
1426 split in two.
1427- When there are not many <EOL>s, the lines will become very long. If you
1428 want to edit a line that does not fit on the screen reset the 'wrap' option.
1429 Horizontal scrolling is used then. If a line becomes too long (more than
Bram Moolenaar7ff78462020-07-10 22:00:53 +02001430 about 32767 bytes on the Amiga, much more on 32-bit and 64-bit systems, see
Bram Moolenaar071d4272004-06-13 20:20:40 +00001431 |limits|) you cannot edit that line. The line will be split when reading
1432 the file. It is also possible that you get an "out of memory" error when
1433 reading the file.
1434- Make sure the 'binary' option is set BEFORE loading the
Bram Moolenaar4072ba52020-12-23 13:56:35 +01001435 file. Otherwise both <CR><NL> and <NL> are considered to end a line
1436 and when the file is written the <NL> will be replaced with <CR><NL>.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001437- <Nul> characters are shown on the screen as ^@. You can enter them with
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001438 "CTRL-V CTRL-@" or "CTRL-V 000"
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +02001439- To insert a <NL> character in the file split a line. When writing the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001440 buffer to a file a <NL> will be written for the <EOL>.
1441- Vim normally appends an <EOL> at the end of the file if there is none.
1442 Setting the 'binary' option prevents this. If you want to add the final
1443 <EOL>, set the 'endofline' option. You can also read the value of this
1444 option to see if there was an <EOL> for the last line (you cannot see this
1445 in the text).
1446
1447==============================================================================
14489. Encryption *encryption*
1449
1450Vim is able to write files encrypted, and read them back. The encrypted text
1451cannot be read without the right key.
Bram Moolenaar996343d2010-07-04 22:20:21 +02001452{only available when compiled with the |+cryptv| feature} *E833*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001453
Bram Moolenaar81af9252010-12-10 20:35:50 +01001454The text in the swap file and the undo file is also encrypted. *E843*
Bram Moolenaar07d87792014-07-19 14:04:47 +02001455However, this is done block-by-block and may reduce the time needed to crack a
1456password. You can disable the swap file, but then a crash will cause you to
Bram Moolenaar9d87a372018-12-18 21:41:50 +01001457lose your work. The undo file can be disabled without too much disadvantage. >
Bram Moolenaar07d87792014-07-19 14:04:47 +02001458 :set noundofile
1459 :noswapfile edit secrets
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001460
1461Note: The text in memory is not encrypted. A system administrator may be able
1462to see your text while you are editing it. When filtering text with
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001463":!filter" or using ":w !command" the text is also not encrypted, this may
1464reveal it to others. The 'viminfo' file is not encrypted.
1465
1466You could do this to edit very secret text: >
1467 :set noundofile viminfo=
1468 :noswapfile edit secrets.txt
Bram Moolenaar88774fd2015-08-25 19:52:04 +02001469Keep in mind that without a swap file you risk losing your work in the event
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +02001470of a crash or a power failure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001471
1472WARNING: If you make a typo when entering the key and then write the file and
1473exit, the text will be lost!
1474
1475The normal way to work with encryption, is to use the ":X" command, which will
1476ask you to enter a key. A following write command will use that key to
1477encrypt the file. If you later edit the same file, Vim will ask you to enter
1478a key. If you type the same key as that was used for writing, the text will
1479be readable again. If you use a wrong key, it will be a mess.
1480
1481 *:X*
1482:X Prompt for an encryption key. The typing is done without showing the
1483 actual text, so that someone looking at the display won't see it.
1484 The typed key is stored in the 'key' option, which is used to encrypt
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02001485 the file when it is written.
1486 The file will remain unchanged until you write it. Note that commands
1487 such as `:xit` and `ZZ` will NOT write the file unless there are other
1488 changes.
1489 See also |-x|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001490
1491The value of the 'key' options is used when text is written. When the option
1492is not empty, the written file will be encrypted, using the value as the
1493encryption key. A magic number is prepended, so that Vim can recognize that
1494the file is encrypted.
1495
1496To disable the encryption, reset the 'key' option to an empty value: >
1497 :set key=
1498
Bram Moolenaar49771f42010-07-20 17:32:38 +02001499You can use the 'cryptmethod' option to select the type of encryption, use one
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001500of these: >
1501 :setlocal cm=zip " weak method, backwards compatible
1502 :setlocal cm=blowfish " method with flaws
1503 :setlocal cm=blowfish2 " medium strong method
1504
Bram Moolenaar49771f42010-07-20 17:32:38 +02001505Do this before writing the file. When reading an encrypted file it will be
1506set automatically to the method used when that file was written. You can
1507change 'cryptmethod' before writing that file to change the method.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001508
Bram Moolenaar664f3cf2019-12-07 16:03:51 +01001509To set the default method, used for new files, use this in your |vimrc|
Bram Moolenaarc2299672014-11-13 14:25:38 +01001510file: >
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001511 set cm=blowfish2
Bram Moolenaarc2299672014-11-13 14:25:38 +01001512Using "blowfish2" is highly recommended. Only use another method if you
1513must use an older Vim version that does not support it.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001514
Bram Moolenaar662db672011-03-22 14:05:35 +01001515The message given for reading and writing a file will show "[crypted]" when
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001516using zip, "[blowfish]" when using blowfish, etc.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02001517
Bram Moolenaara3ff49f2010-05-30 22:48:02 +02001518When writing an undo file, the same key and method will be used for the text
1519in the undo file. |persistent-undo|.
1520
Bram Moolenaar85084ef2016-01-17 22:26:33 +01001521To test for blowfish support you can use these conditions: >
1522 has('crypt-blowfish')
1523 has('crypt-blowfish2')
1524This works since Vim 7.4.1099 while blowfish support was added earlier.
1525Thus the condition failing doesn't mean blowfish is not supported. You can
1526test for blowfish with: >
1527 v:version >= 703
1528And for blowfish2 with: >
1529 v:version > 704 || (v:version == 704 && has('patch401'))
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01001530If you are sure Vim includes patch 7.4.237 a simpler check is: >
1531 has('patch-7.4.401')
Bram Moolenaar85084ef2016-01-17 22:26:33 +01001532<
Bram Moolenaarfa7584c2010-05-19 21:57:45 +02001533 *E817* *E818* *E819* *E820*
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02001534When encryption does not work properly, you would be able to write your text
1535to a file and never be able to read it back. Therefore a test is performed to
1536check if the encryption works as expected. If you get one of these errors
1537don't write the file encrypted! You need to rebuild the Vim binary to fix
1538this.
1539
Bram Moolenaar46f9d492010-06-12 20:18:19 +02001540*E831* This is an internal error, "cannot happen". If you can reproduce it,
Bram Moolenaar56be9502010-06-06 14:20:26 +02001541please report to the developers.
1542
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02001543When reading a file that has been encrypted and the 'key' option is not empty,
1544it will be used for decryption. If the value is empty, you will be prompted
1545to enter the key. If you don't enter a key, or you enter the wrong key, the
1546file is edited without being decrypted. There is no warning about using the
1547wrong key (this makes brute force methods to find the key more difficult).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001548
1549If want to start reading a file that uses a different key, set the 'key'
1550option to an empty string, so that Vim will prompt for a new one. Don't use
1551the ":set" command to enter the value, other people can read the command over
1552your shoulder.
1553
1554Since the value of the 'key' option is supposed to be a secret, its value can
1555never be viewed. You should not set this option in a vimrc file.
1556
Bram Moolenaar60aad972010-07-21 20:36:22 +02001557An encrypted file can be recognized by the "file" command, if you add these
1558lines to "/etc/magic", "/usr/share/misc/magic" or wherever your system has the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001559"magic" file: >
1560 0 string VimCrypt~ Vim encrypted file
Bram Moolenaarc095b282010-07-20 22:33:34 +02001561 >9 string 01 - "zip" cryptmethod
1562 >9 string 02 - "blowfish" cryptmethod
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001563 >9 string 03 - "blowfish2" cryptmethod
Bram Moolenaar071d4272004-06-13 20:20:40 +00001564
1565Notes:
1566- Encryption is not possible when doing conversion with 'charconvert'.
1567- Text you copy or delete goes to the numbered registers. The registers can
1568 be saved in the .viminfo file, where they could be read. Change your
1569 'viminfo' option to be safe.
1570- Someone can type commands in Vim when you walk away for a moment, he should
1571 not be able to get the key.
1572- If you make a typing mistake when entering the key, you might not be able to
1573 get your text back!
1574- If you type the key with a ":set key=value" command, it can be kept in the
1575 history, showing the 'key' value in a viminfo file.
1576- There is never 100% safety. The encryption in Vim has not been tested for
1577 robustness.
Bram Moolenaar24ea3ba2010-09-19 19:01:21 +02001578- The algorithm used for 'cryptmethod' "zip" is breakable. A 4 character key
1579 in about one hour, a 6 character key in one day (on a Pentium 133 PC). This
1580 requires that you know some text that must appear in the file. An expert
1581 can break it for any key. When the text has been decrypted, this also means
1582 that the key can be revealed, and other files encrypted with the same key
1583 can be decrypted.
1584- Pkzip uses the same encryption as 'cryptmethod' "zip", and US Govt has no
1585 objection to its export. Pkzip's public file APPNOTE.TXT describes this
1586 algorithm in detail.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02001587- The implementation of 'cryptmethod' "blowfish" has a flaw. It is possible
1588 to crack the first 64 bytes of a file and in some circumstances more of the
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001589 file. Use of it is not recommended, but it's still the strongest method
1590 supported by Vim 7.3 and 7.4. The "zip" method is even weaker.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001591- Vim originates from the Netherlands. That is where the sources come from.
1592 Thus the encryption code is not exported from the USA.
1593
1594==============================================================================
159510. Timestamps *timestamp* *timestamps*
1596
Bram Moolenaare968e362014-05-13 20:23:24 +02001597Vim remembers the modification timestamp, mode and size of a file when you
1598begin editing it. This is used to avoid that you have two different versions
1599of the same file (without you knowing this).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001600
Bram Moolenaare968e362014-05-13 20:23:24 +02001601After a shell command is run (|:!cmd| |suspend| |:read!| |K|) timestamps,
1602file modes and file sizes are compared for all buffers in a window. Vim will
1603run any associated |FileChangedShell| autocommands or display a warning for
1604any files that have changed. In the GUI this happens when Vim regains input
1605focus.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001606
1607 *E321* *E462*
1608If you want to automatically reload a file when it has been changed outside of
1609Vim, set the 'autoread' option. This doesn't work at the moment you write the
1610file though, only when the file wasn't changed inside of Vim.
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02001611 *ignore-timestamp*
Bram Moolenaar94237492017-04-23 18:40:21 +02001612If you do not want to be asked or automatically reload the file, you can use
1613this: >
1614 set buftype=nofile
1615
1616Or, when starting gvim from a shell: >
1617 gvim file.log -c "set buftype=nofile"
1618
Bram Moolenaar071d4272004-06-13 20:20:40 +00001619Note that if a FileChangedShell autocommand is defined you will not get a
1620warning message or prompt. The autocommand is expected to handle this.
1621
Bram Moolenaar10de2da2005-01-27 14:33:00 +00001622There is no warning for a directory (e.g., with |netrw-browse|). But you do
1623get warned if you started editing a new file and it was created as a directory
1624later.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001625
1626When Vim notices the timestamp of a file has changed, and the file is being
1627edited in a buffer but has not changed, Vim checks if the contents of the file
1628is equal. This is done by reading the file again (into a hidden buffer, which
1629is immediately deleted again) and comparing the text. If the text is equal,
1630you will get no warning.
1631
1632If you don't get warned often enough you can use the following command.
1633
1634 *:checkt* *:checktime*
1635:checkt[ime] Check if any buffers were changed outside of Vim.
1636 This checks and warns you if you would end up with two
1637 versions of a file.
1638 If this is called from an autocommand, a ":global"
1639 command or is not typed the actual check is postponed
1640 until a moment the side effects (reloading the file)
1641 would be harmless.
1642 Each loaded buffer is checked for its associated file
1643 being changed. If the file was changed Vim will take
1644 action. If there are no changes in the buffer and
1645 'autoread' is set, the buffer is reloaded. Otherwise,
1646 you are offered the choice of reloading the file. If
1647 the file was deleted you get an error message.
1648 If the file previously didn't exist you get a warning
1649 if it exists now.
1650 Once a file has been checked the timestamp is reset,
1651 you will not be warned again.
1652
1653:[N]checkt[ime] {filename}
1654:[N]checkt[ime] [N]
1655 Check the timestamp of a specific buffer. The buffer
1656 may be specified by name, number or with a pattern.
1657
1658
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001659 *E813* *E814*
1660Vim will reload the buffer if you chose to. If a window is visible that
1661contains this buffer, the reloading will happen in the context of this window.
1662Otherwise a special window is used, so that most autocommands will work. You
1663can't close this window. A few other restrictions apply. Best is to make
1664sure nothing happens outside of the current buffer. E.g., setting
1665window-local options may end up in the wrong window. Splitting the window,
1666doing something there and closing it should be OK (if there are no side
1667effects from other autocommands). Closing unrelated windows and buffers will
1668get you into trouble.
1669
Bram Moolenaar071d4272004-06-13 20:20:40 +00001670Before writing a file the timestamp is checked. If it has changed, Vim will
1671ask if you really want to overwrite the file:
1672
1673 WARNING: The file has been changed since reading it!!!
1674 Do you really want to write to it (y/n)?
1675
1676If you hit 'y' Vim will continue writing the file. If you hit 'n' the write is
1677aborted. If you used ":wq" or "ZZ" Vim will not exit, you will get another
1678chance to write the file.
1679
1680The message would normally mean that somebody has written to the file after
1681the edit session started. This could be another person, in which case you
1682probably want to check if your changes to the file and the changes from the
1683other person should be merged. Write the file under another name and check for
1684differences (the "diff" program can be used for this).
1685
1686It is also possible that you modified the file yourself, from another edit
1687session or with another command (e.g., a filter command). Then you will know
1688which version of the file you want to keep.
1689
Bram Moolenaar22863042021-10-16 15:23:36 +01001690The accuracy of the time check depends on the filesystem. On Unix it is
1691usually sub-second. With old file sytems and on MS-Windows it is normally one
1692second. Use has('nanotime') check if sub-second time stamp checks are
1693available.
1694
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001695There is one situation where you get the message while there is nothing wrong:
1696On a Win32 system on the day daylight saving time starts. There is something
1697in the Win32 libraries that confuses Vim about the hour time difference. The
1698problem goes away the next day.
1699
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001700==============================================================================
170111. File Searching *file-searching*
1702
1703{not available when compiled without the |+path_extra| feature}
1704
1705The file searching is currently used for the 'path', 'cdpath' and 'tags'
Bram Moolenaarc236c162008-07-13 17:41:49 +00001706options, for |finddir()| and |findfile()|. Other commands use |wildcards|
1707which is slightly different.
Bram Moolenaar9964e462007-05-05 17:54:07 +00001708
1709There are three different types of searching:
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001710
Bram Moolenaar02743632005-07-25 20:42:36 +000017111) Downward search: *starstar*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001712 Downward search uses the wildcards '*', '**' and possibly others
Bram Moolenaarc236c162008-07-13 17:41:49 +00001713 supported by your operating system. '*' and '**' are handled inside Vim,
1714 so they work on all operating systems. Note that "**" only acts as a
1715 special wildcard when it is at the start of a name.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001716
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00001717 The usage of '*' is quite simple: It matches 0 or more characters. In a
1718 search pattern this would be ".*". Note that the "." is not used for file
1719 searching.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001720
1721 '**' is more sophisticated:
1722 - It ONLY matches directories.
Bram Moolenaarc236c162008-07-13 17:41:49 +00001723 - It matches up to 30 directories deep by default, so you can use it to
1724 search an entire directory tree
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001725 - The maximum number of levels matched can be given by appending a number
1726 to '**'.
1727 Thus '/usr/**2' can match: >
1728 /usr
1729 /usr/include
1730 /usr/include/sys
1731 /usr/include/g++
1732 /usr/lib
1733 /usr/lib/X11
1734 ....
1735< It does NOT match '/usr/include/g++/std' as this would be three
1736 levels.
Bram Moolenaarc236c162008-07-13 17:41:49 +00001737 The allowed number range is 0 ('**0' is removed) to 100
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001738 If the given number is smaller than 0 it defaults to 30, if it's
Bram Moolenaarc236c162008-07-13 17:41:49 +00001739 bigger than 100 then 100 is used. The system also has a limit on the
1740 path length, usually 256 or 1024 bytes.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001741 - '**' can only be at the end of the path or be followed by a path
1742 separator or by a number and a path separator.
1743
1744 You can combine '*' and '**' in any order: >
1745 /usr/**/sys/*
Bram Moolenaarc236c162008-07-13 17:41:49 +00001746 /usr/*tory/sys/**
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001747 /usr/**2/sys/*
1748
17492) Upward search:
1750 Here you can give a directory and then search the directory tree upward for
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001751 a file. You could give stop-directories to limit the upward search. The
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001752 stop-directories are appended to the path (for the 'path' option) or to
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001753 the filename (for the 'tags' option) with a ';'. If you want several
1754 stop-directories separate them with ';'. If you want no stop-directory
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001755 ("search upward till the root directory) just use ';'. >
1756 /usr/include/sys;/usr
1757< will search in: >
1758 /usr/include/sys
1759 /usr/include
1760 /usr
1761<
1762 If you use a relative path the upward search is started in Vim's current
1763 directory or in the directory of the current file (if the relative path
1764 starts with './' and 'd' is not included in 'cpoptions').
1765
1766 If Vim's current path is /u/user_x/work/release and you do >
1767 :set path=include;/u/user_x
1768< and then search for a file with |gf| the file is searched in: >
1769 /u/user_x/work/release/include
1770 /u/user_x/work/include
1771 /u/user_x/include
1772
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00001773< Note: If your 'path' setting includes a non-existing directory, Vim will
Christian Brabandt7a4ca322021-07-25 15:08:05 +02001774 skip the non-existing directory, but continues searching in the parent of
1775 the non-existing directory if upwards searching is used. E.g. when
1776 searching "../include" and that doesn't exist, and upward searching is
1777 used, also searches in "..".
1778
Bram Moolenaar402d2fe2005-04-15 21:00:38 +000017793) Combined up/downward search:
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001780 If Vim's current path is /u/user_x/work/release and you do >
1781 set path=**;/u/user_x
1782< and then search for a file with |gf| the file is searched in: >
1783 /u/user_x/work/release/**
1784 /u/user_x/work/**
1785 /u/user_x/**
1786<
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001787 BE CAREFUL! This might consume a lot of time, as the search of
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001788 '/u/user_x/**' includes '/u/user_x/work/**' and
1789 '/u/user_x/work/release/**'. So '/u/user_x/work/release/**' is searched
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001790 three times and '/u/user_x/work/**' is searched twice.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001791
1792 In the above example you might want to set path to: >
1793 :set path=**,/u/user_x/**
Bram Moolenaar162bd912010-07-28 22:29:10 +02001794< This searches:
1795 /u/user_x/work/release/** ~
1796 /u/user_x/** ~
1797 This searches the same directories, but in a different order.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001798
Bram Moolenaar162bd912010-07-28 22:29:10 +02001799 Note that completion for ":find", ":sfind", and ":tabfind" commands do not
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02001800 currently work with 'path' items that contain a URL or use the double star
Bram Moolenaar5b435d62012-04-05 17:33:26 +02001801 with depth limiter (/usr/**2) or upward search (;) notations.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001802
Bram Moolenaar91f84f62018-07-29 15:07:52 +02001803 vim:tw=78:ts=8:noet:ft=help:norl: