blob: 17a8ca38395cd70147b10cb6798e6cbfac1eba19 [file] [log] [blame]
Bram Moolenaar662db672011-03-22 14:05:35 +01001*editing.txt* For Vim version 7.3. Last change: 2011 Feb 26
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 Moolenaard4755bb2004-09-02 19:12:26 +000041
42 *:keepalt* *:keepa*
43:keepalt {cmd} Execute {cmd} while keeping the current alternate file
44 name. Note that commands invoked indirectly (e.g.,
45 with a function) may still set the alternate file
46 name. {not in Vi}
47
Bram Moolenaar1cd871b2004-12-19 22:46:22 +000048All file names are remembered in the buffer list. When you enter a file name,
Bram Moolenaar402d2fe2005-04-15 21:00:38 +000049for editing (e.g., with ":e filename") or writing (e.g., with ":w filename"),
Bram Moolenaar1cd871b2004-12-19 22:46:22 +000050the file name is added to the list. You can use the buffer list to remember
51which files you edited and to quickly switch from one file to another (e.g.,
52to copy text) with the |CTRL-^| command. First type the number of the file
53and then hit CTRL-^. {Vi: only one alternate file name is remembered}
54
Bram Moolenaar071d4272004-06-13 20:20:40 +000055
56CTRL-G or *CTRL-G* *:f* *:fi* *:file*
Bram Moolenaard9d30582005-05-18 22:10:28 +000057:f[ile] Prints the current file name (as typed, unless ":cd"
58 was used), the cursor position (unless the 'ruler'
59 option is set), and the file status (readonly,
60 modified, read errors, new file). See the 'shortmess'
61 option about how to make this message shorter.
62 {Vi does not include column number}
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
69 buffer number is also given. {not in Vi}
70
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.
76 If there are characters in the line that take more
77 than one position on the screen (<Tab> or special
78 character), both the "real" column and the screen
79 column are shown, separated with a dash.
80 See also 'ruler' option. {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +000081
82 *v_g_CTRL-G*
Bram Moolenaar7c626922005-02-07 22:01:03 +000083{Visual}g CTRL-G Similar to "g CTRL-G", but Word, Character, Line, and
84 Byte counts for the visually selected region are
85 displayed.
86 In Blockwise mode, Column count is also shown. (For
Bram Moolenaar071d4272004-06-13 20:20:40 +000087 {Visual} see |Visual-mode|.)
88 {not in VI}
89
90 *:file_f*
Bram Moolenaar325b7a22004-07-05 15:58:32 +000091:f[ile][!] {name} Sets the current file name to {name}. The optional !
92 avoids truncating the message, as with |:file|.
Bram Moolenaar7171abe2004-10-11 10:06:20 +000093 If the buffer did have a name, that name becomes the
94 |alternate-file| name. An unlisted buffer is created
95 to hold the old name.
Bram Moolenaar10de2da2005-01-27 14:33:00 +000096 *:0file*
Bram Moolenaar325b7a22004-07-05 15:58:32 +000097:0f[ile][!] Remove the name of the current buffer. The optional !
98 avoids truncating the message, as with |:file|. {not
99 in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000100
101:buffers
102:files
103:ls List all the currently known file names. See
104 'windows.txt' |:files| |:buffers| |:ls|. {not in
105 Vi}
106
107Vim will remember the full path name of a file name that you enter. In most
108cases when the file name is displayed only the name you typed is shown, but
109the full path name is being used if you used the ":cd" command |:cd|.
110
111 *home-replace*
112If the environment variable $HOME is set, and the file name starts with that
113string, it is often displayed with HOME replaced with "~". This was done to
114keep file names short. When reading or writing files the full name is still
115used, the "~" is only used when displaying file names. When replacing the
116file name would result in just "~", "~/" is used instead (to avoid confusion
Bram Moolenaar81695252004-12-29 20:58:21 +0000117between options set to $HOME with 'backupext' set to "~").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000118
119When writing the buffer, the default is to use the current file name. Thus
120when you give the "ZZ" or ":wq" command, the original file will be
121overwritten. If you do not want this, the buffer can be written into another
122file by giving a file name argument to the ":write" command. For example: >
123
124 vim testfile
125 [change the buffer with editor commands]
126 :w newfile
127 :q
128
129This will create a file "newfile", that is a modified copy of "testfile".
130The file "testfile" will remain unchanged. Anyway, if the 'backup' option is
131set, Vim renames or copies the original file before it will be overwritten.
132You can use this file if you discover that you need the original file. See
133also the 'patchmode' option. The name of the backup file is normally the same
134as the original file with 'backupext' appended. The default "~" is a bit
135strange to avoid accidentally overwriting existing files. If you prefer ".bak"
136change the 'backupext' option. Extra dots are replaced with '_' on MS-DOS
137machines, when Vim has detected that an MS-DOS-like filesystem is being used
138(e.g., messydos or crossdos) or when the 'shortname' option is on. The
139backup file can be placed in another directory by setting 'backupdir'.
140
141 *auto-shortname*
142Technical: On the Amiga you can use 30 characters for a file name. But on an
143 MS-DOS-compatible filesystem only 8 plus 3 characters are
144 available. Vim tries to detect the type of filesystem when it is
145 creating the .swp file. If an MS-DOS-like filesystem is suspected,
146 a flag is set that has the same effect as setting the 'shortname'
147 option. This flag will be reset as soon as you start editing a
148 new file. The flag will be used when making the file name for the
149 ".swp" and ".~" files for the current file. But when you are
150 editing a file in a normal filesystem and write to an MS-DOS-like
151 filesystem the flag will not have been set. In that case the
152 creation of the ".~" file may fail and you will get an error
153 message. Use the 'shortname' option in this case.
154
155When you started editing without giving a file name, "No File" is displayed in
156messages. If the ":write" command is used with a file name argument, the file
157name for the current file is set to that file name. This only happens when
Bram Moolenaar2d3f4892006-01-20 23:02:51 +0000158the 'F' flag is included in 'cpoptions' (by default it is included) |cpo-F|.
159This is useful when entering text in an empty buffer and then writing it to a
160file. If 'cpoptions' contains the 'f' flag (by default it is NOT included)
161|cpo-f| the file name is set for the ":read file" command. This is useful
162when starting Vim without an argument and then doing ":read file" to start
163editing a file.
164When the file name was set and 'filetype' is empty the filetype detection
165autocommands will be triggered.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000166 *not-edited*
167Because the file name was set without really starting to edit that file, you
168are protected from overwriting that file. This is done by setting the
169"notedited" flag. You can see if this flag is set with the CTRL-G or ":file"
170command. It will include "[Not edited]" when the "notedited" flag is set.
171When writing the buffer to the current file name (with ":w!"), the "notedited"
172flag is reset.
173
174 *abandon*
175Vim remembers whether you have changed the buffer. You are protected from
176losing the changes you made. If you try to quit without writing, or want to
177start editing another file, Vim will refuse this. In order to overrule this
178protection, add a '!' to the command. The changes will then be lost. For
179example: ":q" will not work if the buffer was changed, but ":q!" will. To see
180whether the buffer was changed use the "CTRL-G" command. The message includes
181the string "[Modified]" if the buffer has been changed.
182
183If you want to automatically save the changes without asking, switch on the
184'autowriteall' option. 'autowrite' is the associated Vi-compatible option
185that does not work for all commands.
186
187If you want to keep the changed buffer without saving it, switch on the
188'hidden' option. See |hidden-buffer|.
189
190==============================================================================
1912. Editing a file *edit-a-file*
192
193 *:e* *:edit*
194:e[dit] [++opt] [+cmd] Edit the current file. This is useful to re-edit the
195 current file, when it has been changed outside of Vim.
196 This fails when changes have been made to the current
197 buffer and 'autowriteall' isn't set or the file can't
198 be written.
199 Also see |++opt| and |+cmd|.
200 {Vi: no ++opt}
201
202 *:edit!*
203:e[dit]! [++opt] [+cmd]
204 Edit the current file always. Discard any changes to
205 the current buffer. This is useful if you want to
206 start all over again.
207 Also see |++opt| and |+cmd|.
208 {Vi: no ++opt}
209
210 *:edit_f*
211:e[dit] [++opt] [+cmd] {file}
212 Edit {file}.
213 This fails when changes have been made to the current
214 buffer, unless 'hidden' is set or 'autowriteall' is
215 set and the file can be written.
216 Also see |++opt| and |+cmd|.
217 {Vi: no ++opt}
218
219 *:edit!_f*
220:e[dit]! [++opt] [+cmd] {file}
221 Edit {file} always. Discard any changes to the
222 current buffer.
223 Also see |++opt| and |+cmd|.
224 {Vi: no ++opt}
225
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|.
232 {Vi: no ++opt}
233
234 *:ene* *:enew*
235:ene[w] Edit a new, unnamed buffer. This fails when changes
236 have been made to the current buffer, unless 'hidden'
237 is set or 'autowriteall' is set and the file can be
238 written.
239 If 'fileformats' is not empty, the first format given
240 will be used for the new buffer. If 'fileformats' is
241 empty, the 'fileformat' of the current buffer is used.
242 {not in Vi}
243
244 *:ene!* *:enew!*
245:ene[w]! Edit a new, unnamed buffer. Discard any changes to
246 the current buffer.
247 Set 'fileformat' like |:enew|.
248 {not in Vi}
249
250 *:fin* *:find*
251:fin[d][!] [++opt] [+cmd] {file}
252 Find {file} in 'path' and then |:edit| it.
253 {not in Vi} {not available when the |+file_in_path|
254 feature was disabled at compile time}
255
256:{count}fin[d][!] [++opt] [+cmd] {file}
257 Just like ":find", but use the {count} match in
258 'path'. Thus ":2find file" will find the second
259 "file" found in 'path'. When there are fewer matches
260 for the file in 'path' than asked for, you get an
261 error message.
262
263 *:ex*
264:ex [++opt] [+cmd] [file]
265 Same as |:edit|.
266
267 *:vi* *:visual*
268:vi[sual][!] [++opt] [+cmd] [file]
Bram Moolenaar81695252004-12-29 20:58:21 +0000269 When used in Ex mode: Leave |Ex-mode|, go back to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000270 Normal mode. Otherwise same as |:edit|.
271
272 *:vie* *:view*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100273:vie[w][!] [++opt] [+cmd] file
Bram Moolenaar81695252004-12-29 20:58:21 +0000274 When used in Ex mode: Leave |Ex mode|, go back to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000275 Normal mode. Otherwise same as |:edit|, but set
276 'readonly' option for this buffer. {not in Vi}
277
278 *CTRL-^* *CTRL-6*
Bram Moolenaar662db672011-03-22 14:05:35 +0100279CTRL-^ Edit the alternate file. Mostly the alternate file is
280 the previously edited file. This is a quick way to
281 toggle between two files. It is equivalent to ":e #",
282 except that it also works when there is no file name.
283
Bram Moolenaar071d4272004-06-13 20:20:40 +0000284 If the 'autowrite' or 'autowriteall' option is on and
285 the buffer was changed, write it.
286 Mostly the ^ character is positioned on the 6 key,
287 pressing CTRL and 6 then gets you what we call CTRL-^.
288 But on some non-US keyboards CTRL-^ is produced in
289 another way.
290
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000291{count}CTRL-^ Edit [count]th file in the buffer list (equivalent to
292 ":e #[count]"). This is a quick way to switch between
293 files.
294 See |CTRL-^| above for further details.
295 {not in Vi}
296
Bram Moolenaar071d4272004-06-13 20:20:40 +0000297[count]]f *]f* *[f*
298[count][f Same as "gf". Deprecated.
299
300 *gf* *E446* *E447*
301[count]gf Edit the file whose name is under or after the cursor.
302 Mnemonic: "goto file".
303 Uses the 'isfname' option to find out which characters
304 are supposed to be in a file name. Trailing
305 punctuation characters ".,:;!" are ignored.
Bram Moolenaarc236c162008-07-13 17:41:49 +0000306 Uses the 'path' option as a list of directory names to
307 look for the file. See the 'path' option for details
308 about relative directories and wildcards.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000309 Uses the 'suffixesadd' option to check for file names
310 with a suffix added.
311 If the file can't be found, 'includeexpr' is used to
312 modify the name and another attempt is done.
313 If a [count] is given, the count'th file that is found
314 in the 'path' is edited.
315 This command fails if Vim refuses to |abandon| the
316 current file.
Bram Moolenaar8dff8182006-04-06 20:18:50 +0000317 If you want to edit the file in a new window use
318 |CTRL-W_CTRL-F|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000319 If you do want to edit a new file, use: >
320 :e <cfile>
321< To make gf always work like that: >
322 :map gf :e <cfile><CR>
323< If the name is a hypertext link, that looks like
324 "type://machine/path", you need the |netrw| plugin.
325 For Unix the '~' character is expanded, like in
326 "~user/file". Environment variables are expanded too
327 |expand-env|.
328 {not in Vi}
329 {not available when the |+file_in_path| feature was
330 disabled at compile time}
331
332 *v_gf*
333{Visual}[count]gf Same as "gf", but the highlighted text is used as the
334 name of the file to edit. 'isfname' is ignored.
335 Leading blanks are skipped, otherwise all blanks and
336 special characters are included in the file name.
337 (For {Visual} see |Visual-mode|.)
338 {not in VI}
339
Bram Moolenaard1f56e62006-02-22 21:25:37 +0000340 *gF*
341[count]gF Same as "gf", except if a number follows the file
342 name, then the cursor is positioned on that line in
343 the file. The file name and the number must be
344 separated by a non-filename (see 'isfname') and
345 non-numeric character. White space between the
346 filename, the separator and the number are ignored.
Bram Moolenaard8fc5c02006-04-29 21:55:22 +0000347 Examples:
348 eval.c:10 ~
349 eval.c @ 20 ~
350 eval.c (30) ~
351 eval.c 40 ~
352
Bram Moolenaard1f56e62006-02-22 21:25:37 +0000353 *v_gF*
354{Visual}[count]gF Same as "v_gf".
355
Bram Moolenaar071d4272004-06-13 20:20:40 +0000356These commands are used to start editing a single file. This means that the
357file is read into the buffer and the current file name is set. The file that
358is opened depends on the current directory, see |:cd|.
359
360See |read-messages| for an explanation of the message that is given after the
361file has been read.
362
363You can use the ":e!" command if you messed up the buffer and want to start
364all over again. The ":e" command is only useful if you have changed the
365current file name.
366
367 *:filename* *{file}*
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000368Besides the things mentioned here, more special items for where a filename is
369expected are mentioned at |cmdline-special|.
370
Bram Moolenaarc236c162008-07-13 17:41:49 +0000371Note for systems other than Unix: When using a command that accepts a single
372file name (like ":edit file") spaces in the file name are allowed, but
373trailing spaces are ignored. This is useful on systems that regularly embed
374spaces in file names (like MS-Windows and the Amiga). Example: The command
375":e Long File Name " will edit the file "Long File Name". When using a
376command that accepts more than one file name (like ":next file1 file2")
377embedded spaces must be escaped with a backslash.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000378
Bram Moolenaar9964e462007-05-05 17:54:07 +0000379 *wildcard* *wildcards*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000380Wildcards in {file} are expanded. Which wildcards are supported depends on
381the system. These are the common ones:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000382 ? matches one character
Bram Moolenaar02743632005-07-25 20:42:36 +0000383 * matches anything, including nothing
384 ** matches anything, including nothing, recurses into directories
Bram Moolenaar071d4272004-06-13 20:20:40 +0000385 [abc] match 'a', 'b' or 'c'
Bram Moolenaar02743632005-07-25 20:42:36 +0000386
Bram Moolenaar071d4272004-06-13 20:20:40 +0000387To avoid the special meaning of the wildcards prepend a backslash. However,
388on MS-Windows the backslash is a path separator and "path\[abc]" is still seen
389as a wildcard when "[" is in the 'isfname' option. A simple way to avoid this
390is to use "path\[[]abc]". Then the file "path[abc]" literally.
391
Bram Moolenaar02743632005-07-25 20:42:36 +0000392 *starstar-wildcard*
393Expanding "**" is possible on Unix, Win32, Mac OS/X and a few other systems.
394This allows searching a directory tree. This goes up to 100 directories deep.
Bram Moolenaarc236c162008-07-13 17:41:49 +0000395Note there are some commands where this works slightly different, see
396|file-searching|.
Bram Moolenaar02743632005-07-25 20:42:36 +0000397Example: >
398 :n **/*.txt
399Finds files:
400 ttt.txt
401 subdir/ttt.txt
402 a/b/c/d/ttt.txt
403When non-wildcard characters are used these are only matched in the first
404directory. Example: >
405 :n /usr/inc**/*.h
406Finds files:
407 /usr/include/types.h
408 /usr/include/sys/types.h
409 /usr/inc_old/types.h
Bram Moolenaar071d4272004-06-13 20:20:40 +0000410 *backtick-expansion* *`-expansion*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000411On Unix and a few other systems you can also use backticks in the file name,
412for example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000413 :e `find . -name ver\\*.c -print`
414The backslashes before the star are required to prevent "ver*.c" to be
415expanded by the shell before executing the find program.
416This also works for most other systems, with the restriction that the
417backticks must be around the whole item. It is not possible to have text
418directly before the first or just after the last backtick.
419
Bram Moolenaared203462004-06-16 11:19:22 +0000420 *`=*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000421You can have the backticks expanded as a Vim expression, instead of an
422external command, by using the syntax `={expr}` e.g.: >
423 :e `=tempname()`
424The expression can contain just about anything, thus this can also be used to
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000425avoid the special meaning of '"', '|', '%' and '#'. Names are to be separated
426with line breaks. When the result is a |List| then each item is used as a
427name. Line breaks also separate names.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000428
429 *++opt* *[++opt]*
Bram Moolenaarb0bf8582005-12-13 20:02:15 +0000430The [++opt] argument can be used to force the value of 'fileformat',
431'fileencoding' or 'binary' to a value for one command, and to specify the
432behavior for bad characters. The form is: >
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000433 ++{optname}
434Or: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000435 ++{optname}={value}
436
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000437Where {optname} is one of: *++ff* *++enc* *++bin* *++nobin* *++edit*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000438 ff or fileformat overrides 'fileformat'
439 enc or encoding overrides 'fileencoding'
440 bin or binary sets 'binary'
441 nobin or nobinary resets 'binary'
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000442 bad specifies behavior for bad characters
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000443 edit for |:read| only: keep option values as if editing
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000444 a file
Bram Moolenaar071d4272004-06-13 20:20:40 +0000445
446{value} cannot contain white space. It can be any valid value for these
447options. Examples: >
448 :e ++ff=unix
449This edits the same file again with 'fileformat' set to "unix". >
450
451 :w ++enc=latin1 newfile
452This writes the current buffer to "newfile" in latin1 format.
453
Bram Moolenaarb0bf8582005-12-13 20:02:15 +0000454There may be several ++opt arguments, separated by white space. They must all
455appear before any |+cmd| argument.
456
457 *++bad*
458The argument of "++bad=" specifies what happens with characters that can't be
459converted and illegal bytes. It can be one of three things:
460 ++bad=X A single-byte character that replaces each bad character.
461 ++bad=keep Keep bad characters without conversion. Note that this may
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000462 result in illegal bytes in your text!
Bram Moolenaarb0bf8582005-12-13 20:02:15 +0000463 ++bad=drop Remove the bad characters.
464
465The default is like "++bad=?": Replace each bad character with a question
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100466mark. In some places an inverted question mark is used (0xBF).
467
468Note that not all commands use the ++bad argument, even though they do not
469give an error when you add it. E.g. |:write|.
Bram Moolenaarb0bf8582005-12-13 20:02:15 +0000470
Bram Moolenaar071d4272004-06-13 20:20:40 +0000471Note that when reading, the 'fileformat' and 'fileencoding' options will be
472set to the used format. When writing this doesn't happen, thus a next write
473will use the old value of the option. Same for the 'binary' option.
474
Bram Moolenaar071d4272004-06-13 20:20:40 +0000475
476 *+cmd* *[+cmd]*
477The [+cmd] argument can be used to position the cursor in the newly opened
478file, or execute any other command:
479 + Start at the last line.
480 +{num} Start at line {num}.
481 +/{pat} Start at first line containing {pat}.
482 +{command} Execute {command} after opening the new file.
483 {command} is any Ex command.
484To include a white space in the {pat} or {command}, precede it with a
485backslash. Double the number of backslashes. >
486 :edit +/The\ book file
487 :edit +/dir\ dirname\\ file
488 :edit +set\ dir=c:\\\\temp file
489Note that in the last example the number of backslashes is halved twice: Once
490for the "+cmd" argument and once for the ":set" command.
491
492 *file-formats*
493The 'fileformat' option sets the <EOL> style for a file:
494'fileformat' characters name ~
495 "dos" <CR><NL> or <NL> DOS format *DOS-format*
496 "unix" <NL> Unix format *Unix-format*
497 "mac" <CR> Mac format *Mac-format*
498Previously 'textmode' was used. It is obsolete now.
499
500When reading a file, the mentioned characters are interpreted as the <EOL>.
501In DOS format (default for MS-DOS, OS/2 and Win32), <CR><NL> and <NL> are both
502interpreted as the <EOL>. Note that when writing the file in DOS format,
503<CR> characters will be added for each single <NL>. Also see |file-read|.
504
505When writing a file, the mentioned characters are used for <EOL>. For DOS
506format <CR><NL> is used. Also see |DOS-format-write|.
507
508You can read a file in DOS format and write it in Unix format. This will
509replace all <CR><NL> pairs by <NL> (assuming 'fileformats' includes "dos"): >
510 :e file
511 :set fileformat=unix
512 :w
513If you read a file in Unix format and write with DOS format, all <NL>
514characters will be replaced with <CR><NL> (assuming 'fileformats' includes
515"unix"): >
516 :e file
517 :set fileformat=dos
518 :w
519
520If you start editing a new file and the 'fileformats' option is not empty
521(which is the default), Vim will try to detect whether the lines in the file
522are separated by the specified formats. When set to "unix,dos", Vim will
523check for lines with a single <NL> (as used on Unix and Amiga) or by a <CR>
524<NL> pair (MS-DOS). Only when ALL lines end in <CR><NL>, 'fileformat' is set
525to "dos", otherwise it is set to "unix". When 'fileformats' includes "mac",
526and no <NL> characters are found in the file, 'fileformat' is set to "mac".
527
528If the 'fileformat' option is set to "dos" on non-MS-DOS systems the message
529"[dos format]" is shown to remind you that something unusual is happening. On
530MS-DOS systems you get the message "[unix format]" if 'fileformat' is set to
531"unix". On all systems but the Macintosh you get the message "[mac format]"
532if 'fileformat' is set to "mac".
533
534If the 'fileformats' option is empty and DOS format is used, but while reading
535a file some lines did not end in <CR><NL>, "[CR missing]" will be included in
536the file message.
537If the 'fileformats' option is empty and Mac format is used, but while reading
538a file a <NL> was found, "[NL missing]" will be included in the file message.
539
540If the new file does not exist, the 'fileformat' of the current buffer is used
541when 'fileformats' is empty. Otherwise the first format from 'fileformats' is
542used for the new file.
543
544Before editing binary, executable or Vim script files you should set the
545'binary' option. A simple way to do this is by starting Vim with the "-b"
546option. This will avoid the use of 'fileformat'. Without this you risk that
547single <NL> characters are unexpectedly replaced with <CR><NL>.
548
549You can encrypt files that are written by setting the 'key' option. This
550provides some security against others reading your files. |encryption|
551
552
Bram Moolenaar071d4272004-06-13 20:20:40 +0000553==============================================================================
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005543. The argument list *argument-list* *arglist*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000555
556If you give more than one file name when starting Vim, this list is remembered
557as the argument list. You can jump to each file in this list.
558
559Do not confuse this with the buffer list, which you can see with the
560|:buffers| command. The argument list was already present in Vi, the buffer
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000561list is new in Vim. Every file name in the argument list will also be present
562in the buffer list (unless it was deleted with |:bdel| or |:bwipe|). But it's
563common that names in the buffer list are not in the argument list.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000564
565This subject is introduced in section |07.2| of the user manual.
566
567There is one global argument list, which is used for all windows by default.
568It is possible to create a new argument list local to a window, see
569|:arglocal|.
570
571You can use the argument list with the following commands, and with the
572expression functions |argc()| and |argv()|. These all work on the argument
573list of the current window.
574
575 *:ar* *:args*
576:ar[gs] Print the argument list, with the current file in
577 square brackets.
578
579:ar[gs] [++opt] [+cmd] {arglist} *:args_f*
580 Define {arglist} as the new argument list and edit
581 the first one. This fails when changes have been made
582 and Vim does not want to |abandon| the current buffer.
583 Also see |++opt| and |+cmd|.
584 {Vi: no ++opt}
585
586:ar[gs]! [++opt] [+cmd] {arglist} *:args_f!*
587 Define {arglist} as the new argument list and edit
588 the first one. Discard any changes to the current
589 buffer.
590 Also see |++opt| and |+cmd|.
591 {Vi: no ++opt}
592
593:[count]arge[dit][!] [++opt] [+cmd] {name} *:arge* *:argedit*
594 Add {name} to the argument list and edit it.
595 When {name} already exists in the argument list, this
596 entry is edited.
597 This is like using |:argadd| and then |:edit|.
598 Note that only one file name is allowed, and spaces
599 inside the file name are allowed, like with |:edit|.
600 [count] is used like with |:argadd|.
601 [!] is required if the current file cannot be
602 |abandon|ed.
603 Also see |++opt| and |+cmd|.
604 {not in Vi}
605
606:[count]arga[dd] {name} .. *:arga* *:argadd* *E479*
607 Add the {name}s to the argument list.
608 If [count] is omitted, the {name}s are added just
609 after the current entry in the argument list.
610 Otherwise they are added after the [count]'th file.
611 If the argument list is "a b c", and "b" is the
612 current argument, then these commands result in:
613 command new argument list ~
614 :argadd x a b x c
615 :0argadd x x a b c
616 :1argadd x a x b c
617 :99argadd x a b c x
618 There is no check for duplicates, it is possible to
619 add a file to the argument list twice.
620 The currently edited file is not changed.
621 {not in Vi} {not available when compiled without the
622 |+listcmds| feature}
623 Note: you can also use this method: >
624 :args ## x
625< This will add the "x" item and sort the new list.
626
627:argd[elete] {pattern} .. *:argd* *:argdelete* *E480*
628 Delete files from the argument list that match the
629 {pattern}s. {pattern} is used like a file pattern,
630 see |file-pattern|. "%" can be used to delete the
631 current entry.
632 This command keeps the currently edited file, also
633 when it's deleted from the argument list.
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +0000634 Example: >
635 :argdel *.obj
636< {not in Vi} {not available when compiled without the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000637 |+listcmds| feature}
638
639:{range}argd[elete] Delete the {range} files from the argument list.
640 When the last number in the range is too high, up to
641 the last argument is deleted. Example: >
642 :10,1000argdel
643< Deletes arguments 10 and further, keeping 1-9.
644 {not in Vi} {not available when compiled without the
645 |+listcmds| feature}
646
647 *:argu* *:argument*
648:[count]argu[ment] [count] [++opt] [+cmd]
649 Edit file [count] in the argument list. When [count]
650 is omitted the current entry is used. This fails
651 when changes have been made and Vim does not want to
652 |abandon| the current buffer.
653 Also see |++opt| and |+cmd|.
654 {not in Vi} {not available when compiled without the
655 |+listcmds| feature}
656
657:[count]argu[ment]! [count] [++opt] [+cmd]
658 Edit file [count] in the argument list, discard any
659 changes to the current buffer. When [count] is
660 omitted the current entry is used.
661 Also see |++opt| and |+cmd|.
662 {not in Vi} {not available when compiled without the
663 |+listcmds| feature}
664
665:[count]n[ext] [++opt] [+cmd] *:n* *:ne* *:next* *E165* *E163*
666 Edit [count] next file. This fails when changes have
667 been made and Vim does not want to |abandon| the
668 current buffer. Also see |++opt| and |+cmd|. {Vi: no
669 count or ++opt}.
670
671:[count]n[ext]! [++opt] [+cmd]
672 Edit [count] next file, discard any changes to the
673 buffer. Also see |++opt| and |+cmd|. {Vi: no count
674 or ++opt}.
675
676:n[ext] [++opt] [+cmd] {arglist} *:next_f*
677 Same as |:args_f|.
678
679:n[ext]! [++opt] [+cmd] {arglist}
680 Same as |:args_f!|.
681
682:[count]N[ext] [count] [++opt] [+cmd] *:Next* *:N* *E164*
683 Edit [count] previous file in argument list. This
684 fails when changes have been made and Vim does not
685 want to |abandon| the current buffer.
686 Also see |++opt| and |+cmd|. {Vi: no count or ++opt}.
687
688:[count]N[ext]! [count] [++opt] [+cmd]
689 Edit [count] previous file in argument list. Discard
690 any changes to the buffer. Also see |++opt| and
691 |+cmd|. {Vi: no count or ++opt}.
692
693:[count]prev[ious] [count] [++opt] [+cmd] *:prev* *:previous*
694 Same as :Next. Also see |++opt| and |+cmd|. {Vi:
695 only in some versions}
696
697 *:rew* *:rewind*
698:rew[ind] [++opt] [+cmd]
699 Start editing the first file in the argument list.
700 This fails when changes have been made and Vim does
701 not want to |abandon| the current buffer.
702 Also see |++opt| and |+cmd|. {Vi: no ++opt}
703
704:rew[ind]! [++opt] [+cmd]
705 Start editing the first file in the argument list.
706 Discard any changes to the buffer. Also see |++opt|
707 and |+cmd|. {Vi: no ++opt}
708
709 *:fir* *:first*
710:fir[st][!] [++opt] [+cmd]
711 Other name for ":rewind". {not in Vi}
712
713 *:la* *:last*
714:la[st] [++opt] [+cmd]
715 Start editing the last file in the argument list.
716 This fails when changes have been made and Vim does
717 not want to |abandon| the current buffer.
718 Also see |++opt| and |+cmd|. {not in Vi}
719
720:la[st]! [++opt] [+cmd]
721 Start editing the last file in the argument list.
722 Discard any changes to the buffer. Also see |++opt|
723 and |+cmd|. {not in Vi}
724
725 *:wn* *:wnext*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000726:[count]wn[ext] [++opt]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000727 Write current file and start editing the [count]
728 next file. Also see |++opt| and |+cmd|. {not in Vi}
729
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000730:[count]wn[ext] [++opt] {file}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000731 Write current file to {file} and start editing the
732 [count] next file, unless {file} already exists and
733 the 'writeany' option is off. Also see |++opt| and
734 |+cmd|. {not in Vi}
735
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000736:[count]wn[ext]! [++opt] {file}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000737 Write current file to {file} and start editing the
738 [count] next file. Also see |++opt| and |+cmd|. {not
739 in Vi}
740
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000741:[count]wN[ext][!] [++opt] [file] *:wN* *:wNext*
742:[count]wp[revious][!] [++opt] [file] *:wp* *:wprevious*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000743 Same as :wnext, but go to previous file instead of
744 next. {not in Vi}
745
746The [count] in the commands above defaults to one. For some commands it is
747possible to use two counts. The last one (rightmost one) is used.
748
749If no [+cmd] argument is present, the cursor is positioned at the last known
750cursor position for the file. If 'startofline' is set, the cursor will be
751positioned at the first non-blank in the line, otherwise the last know column
752is used. If there is no last known cursor position the cursor will be in the
753first line (the last line in Ex mode).
754
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000755 *{arglist}*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000756The wildcards in the argument list are expanded and the file names are sorted.
757Thus you can use the command "vim *.c" to edit all the C files. From within
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000758Vim the command ":n *.c" does the same.
759
760White space is used to separate file names. Put a backslash before a space or
Bram Moolenaar9e368db2007-05-12 13:25:01 +0000761tab to include it in a file name. E.g., to edit the single file "foo bar": >
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000762 :next foo\ bar
763
764On Unix and a few other systems you can also use backticks, for example: >
765 :next `find . -name \\*.c -print`
Bram Moolenaar071d4272004-06-13 20:20:40 +0000766The backslashes before the star are required to prevent "*.c" to be expanded
767by the shell before executing the find program.
768
769 *arglist-position*
770When there is an argument list you can see which file you are editing in the
771title of the window (if there is one and 'title' is on) and with the file
772message you get with the "CTRL-G" command. You will see something like
773 (file 4 of 11)
774If 'shortmess' contains 'f' it will be
775 (4 of 11)
776If you are not really editing the file at the current position in the argument
777list it will be
778 (file (4) of 11)
779This means that you are position 4 in the argument list, but not editing the
780fourth file in the argument list. This happens when you do ":e file".
781
782
783LOCAL ARGUMENT LIST
784
785{not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +0200786{not available when compiled without the |+windows| or |+listcmds| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000787
788 *:arglocal*
789:argl[ocal] Make a local copy of the global argument list.
790 Doesn't start editing another file.
791
792:argl[ocal][!] [++opt] [+cmd] {arglist}
793 Define a new argument list, which is local to the
794 current window. Works like |:args_f| otherwise.
795
796 *:argglobal*
797:argg[lobal] Use the global argument list for the current window.
798 Doesn't start editing another file.
799
800:argg[lobal][!] [++opt] [+cmd] {arglist}
801 Use the global argument list for the current window.
802 Define a new global argument list like |:args_f|.
803 All windows using the global argument list will see
804 this new list.
805
806There can be several argument lists. They can be shared between windows.
807When they are shared, changing the argument list in one window will also
808change it in the other window.
809
810When a window is split the new window inherits the argument list from the
811current window. The two windows then share this list, until one of them uses
812|:arglocal| or |:argglobal| to use another argument list.
813
814
815USING THE ARGUMENT LIST
816
817 *:argdo*
818:argdo[!] {cmd} Execute {cmd} for each file in the argument list.
819 It works like doing this: >
820 :rewind
821 :{cmd}
822 :next
823 :{cmd}
824 etc.
825< When the current file can't be |abandon|ed and the [!]
826 is not present, the command fails.
827 When an error is detected on one file, further files
828 in the argument list will not be visited.
829 The last file in the argument list (or where an error
830 occurred) becomes the current file.
831 {cmd} can contain '|' to concatenate several commands.
832 {cmd} must not change the argument list.
833 Note: While this command is executing, the Syntax
834 autocommand event is disabled by adding it to
835 'eventignore'. This considerably speeds up editing
836 each file.
837 {not in Vi} {not available when compiled without the
838 |+listcmds| feature}
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000839 Also see |:windo|, |:tabdo| and |:bufdo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000840
841Example: >
842 :args *.c
843 :argdo set ff=unix | update
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100844This sets the 'fileformat' option to "unix" and writes the file if it is now
Bram Moolenaar071d4272004-06-13 20:20:40 +0000845changed. This is done for all *.c files.
846
847Example: >
848 :args *.[ch]
849 :argdo %s/\<my_foo\>/My_Foo/ge | update
850This changes the word "my_foo" to "My_Foo" in all *.c and *.h files. The "e"
851flag is used for the ":substitute" command to avoid an error for files where
852"my_foo" isn't used. ":update" writes the file only if changes were made.
853
854==============================================================================
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00008554. Writing *writing* *save-file*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000856
857Note: When the 'write' option is off, you are not able to write any file.
858
859 *:w* *:write*
860 *E502* *E503* *E504* *E505*
Bram Moolenaar9964e462007-05-05 17:54:07 +0000861 *E512* *E514* *E667* *E796*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000862:w[rite] [++opt] Write the whole buffer to the current file. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000863 the normal way to save changes to a file. It fails
864 when the 'readonly' option is set or when there is
865 another reason why the file can't be written.
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000866 For ++opt see |++opt|, but only ++bin, ++nobin, ++ff
867 and ++enc are effective.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000868
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000869:w[rite]! [++opt] Like ":write", but forcefully write when 'readonly' is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000870 set or there is another reason why writing was
871 refused.
872 Note: This may change the permission and ownership of
873 the file and break (symbolic) links. Add the 'W' flag
874 to 'cpoptions' to avoid this.
875
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000876:[range]w[rite][!] [++opt]
877 Write the specified lines to the current file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000878 is unusual, because the file will not contain all
879 lines in the buffer.
880
881 *:w_f* *:write_f*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000882:[range]w[rite] [++opt] {file}
883 Write the specified lines to {file}, unless it
Bram Moolenaar071d4272004-06-13 20:20:40 +0000884 already exists and the 'writeany' option is off.
885
886 *:w!*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000887:[range]w[rite]! [++opt] {file}
888 Write the specified lines to {file}. Overwrite an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000889 existing file.
890
891 *:w_a* *:write_a* *E494*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000892:[range]w[rite][!] [++opt] >>
893 Append the specified lines to the current file.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000894
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000895:[range]w[rite][!] [++opt] >> {file}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000896 Append the specified lines to {file}. '!' forces the
897 write even if file does not exist.
898
899 *:w_c* *:write_c*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000900:[range]w[rite] [++opt] !{cmd}
901 Execute {cmd} with [range] lines as standard input
Bram Moolenaar071d4272004-06-13 20:20:40 +0000902 (note the space in front of the '!'). {cmd} is
903 executed like with ":!{cmd}", any '!' is replaced with
904 the previous command |:!|.
905
Bram Moolenaar5c4e21c2004-10-12 19:54:52 +0000906The default [range] for the ":w" command is the whole buffer (1,$). If you
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000907write the whole buffer, it is no longer considered changed. When you
908write it to a different file with ":w somefile" it depends on the "+" flag in
909'cpoptions'. When included, the write command will reset the 'modified' flag,
910even though the buffer itself may still be different from its file.
Bram Moolenaar5c4e21c2004-10-12 19:54:52 +0000911
Bram Moolenaar071d4272004-06-13 20:20:40 +0000912If a file name is given with ":w" it becomes the alternate file. This can be
913used, for example, when the write fails and you want to try again later with
914":w #". This can be switched off by removing the 'A' flag from the
915'cpoptions' option.
916
917 *:sav* *:saveas*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000918:sav[eas][!] [++opt] {file}
919 Save the current buffer under the name {file} and set
Bram Moolenaar071d4272004-06-13 20:20:40 +0000920 the filename of the current buffer to {file}. The
921 previous name is used for the alternate file name.
922 The [!] is needed to overwrite an existing file.
Bram Moolenaar2d3f4892006-01-20 23:02:51 +0000923 When 'filetype' is empty filetype detection is done
924 with the new name, before the file is written.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000925 When the write was successful 'readonly' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000926 {not in Vi}
927
928 *:up* *:update*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000929:[range]up[date][!] [++opt] [>>] [file]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000930 Like ":write", but only write when the buffer has been
931 modified. {not in Vi}
932
933
934WRITING WITH MULTIPLE BUFFERS *buffer-write*
935
936 *:wa* *:wall*
937:wa[ll] Write all changed buffers. Buffers without a file
938 name or which are readonly are not written. {not in
939 Vi}
940
941:wa[ll]! Write all changed buffers, even the ones that are
942 readonly. Buffers without a file name are not
943 written. {not in Vi}
944
945
946Vim will warn you if you try to overwrite a file that has been changed
947elsewhere. See |timestamp|.
948
949 *backup* *E207* *E506* *E507* *E508* *E509* *E510*
950If you write to an existing file (but do not append) while the 'backup',
951'writebackup' or 'patchmode' option is on, a backup of the original file is
952made. The file is either copied or renamed (see 'backupcopy'). After the
953file has been successfully written and when the 'writebackup' option is on and
954the 'backup' option is off, the backup file is deleted. When the 'patchmode'
955option is on the backup file may be renamed.
956
957 *backup-table*
958'backup' 'writebackup' action ~
959 off off no backup made
960 off on backup current file, deleted afterwards (default)
961 on off delete old backup, backup current file
962 on on delete old backup, backup current file
963
964When the 'backupskip' pattern matches with the name of the file which is
965written, no backup file is made. The values of 'backup' and 'writebackup' are
966ignored then.
967
968When the 'backup' option is on, an old backup file (with the same name as the
969new backup file) will be deleted. If 'backup' is not set, but 'writebackup'
970is set, an existing backup file will not be deleted. The backup file that is
971made while the file is being written will have a different name.
972
973On some filesystems it's possible that in a crash you lose both the backup and
974the newly written file (it might be there but contain bogus data). In that
975case try recovery, because the swap file is synced to disk and might still be
976there. |:recover|
977
978The directories given with the 'backupdir' option is used to put the backup
979file in. (default: same directory as the written file).
980
981Whether the backup is a new file, which is a copy of the original file, or the
982original file renamed depends on the 'backupcopy' option. See there for an
983explanation of when the copy is made and when the file is renamed.
984
985If the creation of a backup file fails, the write is not done. If you want
986to write anyway add a '!' to the command.
987
Bram Moolenaard58e9292011-02-09 17:07:58 +0100988 *write-permissions*
989When writing a new file the permissions are read-write. For unix the mask is
9900666 with additionally umask applied. When writing a file that was read Vim
991will preserve the permissions, but clear the s-bit.
992
Bram Moolenaar071d4272004-06-13 20:20:40 +0000993 *write-readonly*
994When the 'cpoptions' option contains 'W', Vim will refuse to overwrite a
995readonly file. When 'W' is not present, ":w!" will overwrite a readonly file,
996if the system allows it (the directory must be writable).
997
998 *write-fail*
999If the writing of the new file fails, you have to be careful not to lose
1000your changes AND the original file. If there is no backup file and writing
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001001the new file failed, you have already lost the original file! DON'T EXIT VIM
1002UNTIL YOU WRITE OUT THE FILE! If a backup was made, it is put back in place
Bram Moolenaar071d4272004-06-13 20:20:40 +00001003of the original file (if possible). If you exit Vim, and lose the changes
1004you made, the original file will mostly still be there. If putting back the
1005original file fails, there will be an error message telling you that you
1006lost the original file.
1007
1008 *DOS-format-write*
1009If the 'fileformat' is "dos", <CR> <NL> is used for <EOL>. This is default
1010for MS-DOS, Win32 and OS/2. On other systems the message "[dos format]" is
1011shown to remind you that an unusual <EOL> was used.
1012 *Unix-format-write*
1013If the 'fileformat' is "unix", <NL> is used for <EOL>. On MS-DOS, Win32 and
1014OS/2 the message "[unix format]" is shown.
1015 *Mac-format-write*
1016If the 'fileformat' is "mac", <CR> is used for <EOL>. On non-Mac systems the
1017message "[mac format]" is shown.
1018
1019See also |file-formats| and the 'fileformat' and 'fileformats' options.
1020
1021 *ACL*
1022ACL stands for Access Control List. It is an advanced way to control access
1023rights for a file. It is used on new MS-Windows and Unix systems, but only
1024when the filesystem supports it.
1025 Vim attempts to preserve the ACL info when writing a file. The backup file
1026will get the ACL info of the original file.
1027 The ACL info is also used to check if a file is read-only (when opening the
1028file).
1029
1030 *read-only-share*
1031When MS-Windows shares a drive on the network it can be marked as read-only.
1032This means that even if the file read-only attribute is absent, and the ACL
1033settings on NT network shared drives allow writing to the file, you can still
1034not write to the file. Vim on Win32 platforms will detect read-only network
1035drives and will mark the file as read-only. You will not be able to override
1036it with |:write|.
1037
1038 *write-device*
1039When the file name is actually a device name, Vim will not make a backup (that
1040would be impossible). You need to use "!", since the device already exists.
1041Example for Unix: >
1042 :w! /dev/lpt0
1043and for MS-DOS or MS-Windows: >
1044 :w! lpt0
1045For Unix a device is detected when the name doesn't refer to a normal file or
1046a directory. A fifo or named pipe also looks like a device to Vim.
1047For MS-DOS and MS-Windows the device is detected by its name:
1048 AUX
1049 CON
1050 CLOCK$
1051 NUL
1052 PRN
1053 COMn n=1,2,3... etc
1054 LPTn n=1,2,3... etc
1055The names can be in upper- or lowercase.
1056
1057==============================================================================
Bram Moolenaar1cd871b2004-12-19 22:46:22 +000010585. Writing and quitting *write-quit*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001059
1060 *:q* *:quit*
1061:q[uit] Quit the current window. Quit Vim if this is the last
1062 window. This fails when changes have been made and
1063 Vim refuses to |abandon| the current buffer, and when
1064 the last file in the argument list has not been
1065 edited.
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00001066 If there are other tab pages and quitting the last
1067 window in the current tab page the current tab page is
1068 closed |tab-page|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001069
1070:conf[irm] q[uit] Quit, but give prompt when changes have been made, or
1071 the last file in the argument list has not been
1072 edited. See |:confirm| and 'confirm'. {not in Vi}
1073
1074:q[uit]! Quit without writing, also when visible buffers have
1075 changes. Does not exit when there are changed hidden
1076 buffers. Use ":qall!" to exit always.
1077
1078:cq[uit] Quit always, without writing, and return an error
1079 code. See |:cq|. Used for Manx's QuickFix mode (see
1080 |quickfix|). {not in Vi}
1081
1082 *:wq*
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001083:wq [++opt] Write the current file and quit. Writing fails when
Bram Moolenaar071d4272004-06-13 20:20:40 +00001084 the file is read-only or the buffer does not have a
1085 name. Quitting fails when the last file in the
1086 argument list has not been edited.
1087
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001088:wq! [++opt] Write the current file and quit. Writing fails when
Bram Moolenaar071d4272004-06-13 20:20:40 +00001089 the current buffer does not have a name.
1090
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001091:wq [++opt] {file} Write to {file} and quit. Quitting fails when the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001092 last file in the argument list has not been edited.
1093
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001094:wq! [++opt] {file} Write to {file} and quit.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001095
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001096:[range]wq[!] [++opt] [file]
1097 Same as above, but only write the lines in [range].
Bram Moolenaar071d4272004-06-13 20:20:40 +00001098
1099 *:x* *:xit*
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001100:[range]x[it][!] [++opt] [file]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001101 Like ":wq", but write only when changes have been
1102 made.
1103 When 'hidden' is set and there are more windows, the
1104 current buffer becomes hidden, after writing the file.
1105
1106 *:exi* *:exit*
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001107:[range]exi[t][!] [++opt] [file]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001108 Same as :xit.
1109
1110 *ZZ*
1111ZZ Write current file, if modified, and quit (same as
1112 ":x"). (Note: If there are several windows for the
1113 current file, the file is written if it was modified
1114 and the window is closed).
1115
1116 *ZQ*
1117ZQ Quit without checking for changes (same as ":q!").
1118 {not in Vi}
1119
1120MULTIPLE WINDOWS AND BUFFERS *window-exit*
1121
1122 *:qa* *:qall*
1123:qa[ll] Exit Vim, unless there are some buffers which have been
1124 changed. (Use ":bmod" to go to the next modified buffer).
1125 When 'autowriteall' is set all changed buffers will be
1126 written, like |:wqall|. {not in Vi}
1127
1128:conf[irm] qa[ll]
1129 Exit Vim. Bring up a prompt when some buffers have been
1130 changed. See |:confirm|. {not in Vi}
1131
1132:qa[ll]! Exit Vim. Any changes to buffers are lost. {not in Vi}
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00001133 Also see |:cquit|, it does the same but exits with a non-zero
1134 value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001135
1136 *:quita* *:quitall*
1137:quita[ll][!] Same as ":qall". {not in Vi}
1138
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001139:wqa[ll] [++opt] *:wqa* *:wqall* *:xa* *:xall*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001140:xa[ll] Write all changed buffers and exit Vim. If there are buffers
1141 without a file name, which are readonly or which cannot be
1142 written for another reason, Vim will not quit. {not in Vi}
1143
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001144:conf[irm] wqa[ll] [++opt]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001145:conf[irm] xa[ll]
1146 Write all changed buffers and exit Vim. Bring up a prompt
1147 when some buffers are readonly or cannot be written for
1148 another reason. See |:confirm|. {not in Vi}
1149
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001150:wqa[ll]! [++opt]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001151:xa[ll]! Write all changed buffers, even the ones that are readonly,
1152 and exit Vim. If there are buffers without a file name or
1153 which cannot be written for another reason, Vim will not quit.
1154 {not in Vi}
1155
1156==============================================================================
Bram Moolenaar1cd871b2004-12-19 22:46:22 +000011576. Dialogs *edit-dialogs*
1158
1159 *:confirm* *:conf*
1160:conf[irm] {command} Execute {command}, and use a dialog when an
1161 operation has to be confirmed. Can be used on the
1162 ":q", ":qa" and ":w" commands (the latter to over-ride
1163 a read-only setting).
1164
1165Examples: >
1166 :confirm w foo
1167< Will ask for confirmation when "foo" already exists. >
1168 :confirm q
1169< Will ask for confirmation when there are changes. >
1170 :confirm qa
1171< If any modified, unsaved buffers exist, you will be prompted to save
1172 or abandon each one. There are also choices to "save all" or "abandon
1173 all".
1174
1175If you want to always use ":confirm", set the 'confirm' option.
1176
1177 *:browse* *:bro* *E338* *E614* *E615* *E616* *E578*
1178:bro[wse] {command} Open a file selection dialog for an argument to
1179 {command}. At present this works for |:e|, |:w|,
Bram Moolenaar9028b102010-07-11 16:58:51 +02001180 |:wall|, |:wq|, |:wqall|, |:x|, |:xall|, |:exit|,
1181 |:view|, |:sview|, |:r|, |:saveas|, |:sp|, |:mkexrc|,
1182 |:mkvimrc|, |:mksession|, |:mkview|, |:split|,
1183 |:vsplit|, |:tabe|, |:tabnew|, |:cfile|, |:cgetfile|,
1184 |:caddfile|, |:lfile|, |:lgetfile|, |:laddfile|,
1185 |:diffsplit|, |:diffpatch|, |:open|, |:pedit|,
1186 |:redir|, |:source|, |:update|, |:visual|, |:vsplit|,
1187 and |:qall| if 'confirm' is set.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001188 {only in Win32, Athena, Motif, GTK and Mac GUI}
1189 When ":browse" is not possible you get an error
1190 message. If the |+browse| feature is missing or the
1191 {command} doesn't support browsing, the {command} is
1192 executed without a dialog.
1193 ":browse set" works like |:options|.
Bram Moolenaar9028b102010-07-11 16:58:51 +02001194 See also |:oldfiles| for ":browse oldfiles".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001195
1196The syntax is best shown via some examples: >
1197 :browse e $vim/foo
1198< Open the browser in the $vim/foo directory, and edit the
1199 file chosen. >
1200 :browse e
1201< Open the browser in the directory specified with 'browsedir',
1202 and edit the file chosen. >
1203 :browse w
1204< Open the browser in the directory of the current buffer,
1205 with the current buffer filename as default, and save the
1206 buffer under the filename chosen. >
1207 :browse w C:/bar
1208< Open the browser in the C:/bar directory, with the current
1209 buffer filename as default, and save the buffer under the
1210 filename chosen.
1211Also see the |'browsedir'| option.
1212For versions of Vim where browsing is not supported, the command is executed
1213unmodified.
1214
1215 *browsefilter*
1216For MS Windows, you can modify the filters that are used in the browse dialog.
1217By setting the g:browsefilter or b:browsefilter variables, you can change the
1218filters globally or locally to the buffer. The variable is set to a string in
1219the format "{filter label}\t{pattern};{pattern}\n" where {filter label} is the
1220text that appears in the "Files of Type" comboBox, and {pattern} is the
1221pattern which filters the filenames. Several patterns can be given, separated
1222by ';'.
1223
1224For Motif the same format is used, but only the very first pattern is actually
1225used (Motif only offers one pattern, but you can edit it).
1226
1227For example, to have only Vim files in the dialog, you could use the following
1228command: >
1229
1230 let g:browsefilter="Vim Scripts\t*.vim\nVim Startup Files\t*vimrc\n"
1231
1232You can override the filter setting on a per-buffer basis by setting the
1233b:browsefilter variable. You would most likely set b:browsefilter in a
1234filetype plugin, so that the browse dialog would contain entries related to
1235the type of file you are currently editing. Disadvantage: This makes it
1236difficult to start editing a file of a different type. To overcome this, you
1237may want to add "All Files\t*.*\n" as the final filter, so that the user can
1238still access any desired file.
1239
1240==============================================================================
12417. The current directory *current-directory*
1242
1243You may use the |:cd| and |:lcd| commands to change to another directory, so
1244you will not have to type that directory name in front of the file names. It
1245also makes a difference for executing external commands, e.g. ":!ls".
1246
Bram Moolenaardf177f62005-02-22 08:39:57 +00001247Changing directory fails when the current buffer is modified, the '.' flag is
1248present in 'cpoptions' and "!" is not used in the command.
1249
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00001250 *:cd* *E747* *E472*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001251:cd[!] On non-Unix systems: Print the current directory
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001252 name. On Unix systems: Change the current directory
1253 to the home directory. Use |:pwd| to print the
1254 current directory on all systems.
1255
Bram Moolenaardf177f62005-02-22 08:39:57 +00001256:cd[!] {path} Change the current directory to {path}.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001257 If {path} is relative, it is searched for in the
1258 directories listed in |'cdpath'|.
1259 Does not change the meaning of an already opened file,
1260 because its full path name is remembered. Files from
1261 the |arglist| may change though!
1262 On MS-DOS this also changes the active drive.
1263 To change to the directory of the current file: >
1264 :cd %:h
1265<
1266 *:cd-* *E186*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001267:cd[!] - Change to the previous current directory (before the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001268 previous ":cd {path}" command). {not in Vi}
1269
1270 *:chd* *:chdir*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001271:chd[ir][!] [path] Same as |:cd|.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001272
1273 *:lc* *:lcd*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001274:lc[d][!] {path} Like |:cd|, but only set the current directory for the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001275 current window. The current directory for other
1276 windows is not changed. {not in Vi}
1277
1278 *:lch* *:lchdir*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001279:lch[dir][!] Same as |:lcd|. {not in Vi}
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001280
1281 *:pw* *:pwd* *E187*
1282:pw[d] Print the current directory name. {Vi: no pwd}
1283 Also see |getcwd()|.
1284
1285So long as no |:lcd| command has been used, all windows share the same current
1286directory. Using a command to jump to another window doesn't change anything
1287for the current directory.
1288When a |:lcd| command has been used for a window, the specified directory
1289becomes the current directory for that window. Windows where the |:lcd|
1290command has not been used stick to the global current directory. When jumping
1291to another window the current directory will become the last specified local
1292current directory. If none was specified, the global current directory is
1293used.
1294When a |:cd| command is used, the current window will lose his local current
1295directory and will use the global current directory from now on.
1296
1297After using |:cd| the full path name will be used for reading and writing
1298files. On some networked file systems this may cause problems. The result of
1299using the full path name is that the file names currently in use will remain
1300referring to the same file. Example: If you have a file a:test and a
1301directory a:vim the commands ":e test" ":cd vim" ":w" will overwrite the file
1302a:test and not write a:vim/test. But if you do ":w test" the file a:vim/test
1303will be written, because you gave a new file name and did not refer to a
1304filename before the ":cd".
1305
1306==============================================================================
Bram Moolenaar071d4272004-06-13 20:20:40 +000013078. Editing binary files *edit-binary*
1308
1309Although Vim was made to edit text files, it is possible to edit binary
1310files. The |-b| Vim argument (b for binary) makes Vim do file I/O in binary
1311mode, and sets some options for editing binary files ('binary' on, 'textwidth'
1312to 0, 'modeline' off, 'expandtab' off). Setting the 'binary' option has the
1313same effect. Don't forget to do this before reading the file.
1314
1315There are a few things to remember when editing binary files:
1316- When editing executable files the number of characters must not change.
1317 Use only the "R" or "r" command to change text. Do not delete characters
1318 with "x" or by backspacing.
1319- Set the 'textwidth' option to 0. Otherwise lines will unexpectedly be
1320 split in two.
1321- When there are not many <EOL>s, the lines will become very long. If you
1322 want to edit a line that does not fit on the screen reset the 'wrap' option.
1323 Horizontal scrolling is used then. If a line becomes too long (more than
1324 about 32767 characters on the Amiga, much more on 32-bit systems, see
1325 |limits|) you cannot edit that line. The line will be split when reading
1326 the file. It is also possible that you get an "out of memory" error when
1327 reading the file.
1328- Make sure the 'binary' option is set BEFORE loading the
1329 file. Otherwise both <CR> <NL> and <NL> are considered to end a line
1330 and when the file is written the <NL> will be replaced with <CR> <NL>.
1331- <Nul> characters are shown on the screen as ^@. You can enter them with
1332 "CTRL-V CTRL-@" or "CTRL-V 000" {Vi cannot handle <Nul> characters in the
1333 file}
1334- To insert a <NL> character in the file split up a line. When writing the
1335 buffer to a file a <NL> will be written for the <EOL>.
1336- Vim normally appends an <EOL> at the end of the file if there is none.
1337 Setting the 'binary' option prevents this. If you want to add the final
1338 <EOL>, set the 'endofline' option. You can also read the value of this
1339 option to see if there was an <EOL> for the last line (you cannot see this
1340 in the text).
1341
1342==============================================================================
13439. Encryption *encryption*
1344
1345Vim is able to write files encrypted, and read them back. The encrypted text
1346cannot be read without the right key.
Bram Moolenaar996343d2010-07-04 22:20:21 +02001347{only available when compiled with the |+cryptv| feature} *E833*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001348
Bram Moolenaar81af9252010-12-10 20:35:50 +01001349The text in the swap file and the undo file is also encrypted. *E843*
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001350
1351Note: The text in memory is not encrypted. A system administrator may be able
1352to see your text while you are editing it. When filtering text with
1353":!filter" or using ":w !command" the text is not encrypted, this may reveal
1354it to others. The 'viminfo' file is not encrypted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001355
1356WARNING: If you make a typo when entering the key and then write the file and
1357exit, the text will be lost!
1358
1359The normal way to work with encryption, is to use the ":X" command, which will
1360ask you to enter a key. A following write command will use that key to
1361encrypt the file. If you later edit the same file, Vim will ask you to enter
1362a key. If you type the same key as that was used for writing, the text will
1363be readable again. If you use a wrong key, it will be a mess.
1364
1365 *:X*
1366:X Prompt for an encryption key. The typing is done without showing the
1367 actual text, so that someone looking at the display won't see it.
1368 The typed key is stored in the 'key' option, which is used to encrypt
1369 the file when it is written. The file will remain unchanged until you
1370 write it. See also |-x|.
1371
1372The value of the 'key' options is used when text is written. When the option
1373is not empty, the written file will be encrypted, using the value as the
1374encryption key. A magic number is prepended, so that Vim can recognize that
1375the file is encrypted.
1376
1377To disable the encryption, reset the 'key' option to an empty value: >
1378 :set key=
1379
Bram Moolenaar49771f42010-07-20 17:32:38 +02001380You can use the 'cryptmethod' option to select the type of encryption, use one
1381of these two: >
1382 :setlocal cm=zip " weak method, backwards compatible
1383 :setlocal cm=blowfish " strong method
1384Do this before writing the file. When reading an encrypted file it will be
1385set automatically to the method used when that file was written. You can
1386change 'cryptmethod' before writing that file to change the method.
1387To set the default method, used for new files, use one of these in your
1388|vimrc| file: >
1389 set cm=zip
1390 set cm=blowfish
Bram Moolenaar662db672011-03-22 14:05:35 +01001391The message given for reading and writing a file will show "[crypted]" when
1392using zip, "[blowfish]" when using blowfish.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02001393
Bram Moolenaara3ff49f2010-05-30 22:48:02 +02001394When writing an undo file, the same key and method will be used for the text
1395in the undo file. |persistent-undo|.
1396
Bram Moolenaarfa7584c2010-05-19 21:57:45 +02001397 *E817* *E818* *E819* *E820*
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02001398When encryption does not work properly, you would be able to write your text
1399to a file and never be able to read it back. Therefore a test is performed to
1400check if the encryption works as expected. If you get one of these errors
1401don't write the file encrypted! You need to rebuild the Vim binary to fix
1402this.
1403
Bram Moolenaar46f9d492010-06-12 20:18:19 +02001404*E831* This is an internal error, "cannot happen". If you can reproduce it,
Bram Moolenaar56be9502010-06-06 14:20:26 +02001405please report to the developers.
1406
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02001407When reading a file that has been encrypted and the 'key' option is not empty,
1408it will be used for decryption. If the value is empty, you will be prompted
1409to enter the key. If you don't enter a key, or you enter the wrong key, the
1410file is edited without being decrypted. There is no warning about using the
1411wrong key (this makes brute force methods to find the key more difficult).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001412
1413If want to start reading a file that uses a different key, set the 'key'
1414option to an empty string, so that Vim will prompt for a new one. Don't use
1415the ":set" command to enter the value, other people can read the command over
1416your shoulder.
1417
1418Since the value of the 'key' option is supposed to be a secret, its value can
1419never be viewed. You should not set this option in a vimrc file.
1420
Bram Moolenaar60aad972010-07-21 20:36:22 +02001421An encrypted file can be recognized by the "file" command, if you add these
1422lines to "/etc/magic", "/usr/share/misc/magic" or wherever your system has the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001423"magic" file: >
1424 0 string VimCrypt~ Vim encrypted file
Bram Moolenaarc095b282010-07-20 22:33:34 +02001425 >9 string 01 - "zip" cryptmethod
1426 >9 string 02 - "blowfish" cryptmethod
1427
Bram Moolenaar071d4272004-06-13 20:20:40 +00001428
1429Notes:
1430- Encryption is not possible when doing conversion with 'charconvert'.
1431- Text you copy or delete goes to the numbered registers. The registers can
1432 be saved in the .viminfo file, where they could be read. Change your
1433 'viminfo' option to be safe.
1434- Someone can type commands in Vim when you walk away for a moment, he should
1435 not be able to get the key.
1436- If you make a typing mistake when entering the key, you might not be able to
1437 get your text back!
1438- If you type the key with a ":set key=value" command, it can be kept in the
1439 history, showing the 'key' value in a viminfo file.
1440- There is never 100% safety. The encryption in Vim has not been tested for
1441 robustness.
Bram Moolenaar24ea3ba2010-09-19 19:01:21 +02001442- The algorithm used for 'cryptmethod' "zip" is breakable. A 4 character key
1443 in about one hour, a 6 character key in one day (on a Pentium 133 PC). This
1444 requires that you know some text that must appear in the file. An expert
1445 can break it for any key. When the text has been decrypted, this also means
1446 that the key can be revealed, and other files encrypted with the same key
1447 can be decrypted.
1448- Pkzip uses the same encryption as 'cryptmethod' "zip", and US Govt has no
1449 objection to its export. Pkzip's public file APPNOTE.TXT describes this
1450 algorithm in detail.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001451- Vim originates from the Netherlands. That is where the sources come from.
1452 Thus the encryption code is not exported from the USA.
1453
1454==============================================================================
145510. Timestamps *timestamp* *timestamps*
1456
1457Vim remembers the modification timestamp of a file when you begin editing it.
1458This is used to avoid that you have two different versions of the same file
1459(without you knowing this).
1460
1461After a shell command is run (|:!cmd| |suspend| |:read!| |K|) timestamps are
1462compared for all buffers in a window. Vim will run any associated
1463|FileChangedShell| autocommands or display a warning for any files that have
1464changed. In the GUI this happens when Vim regains input focus.
1465
1466 *E321* *E462*
1467If you want to automatically reload a file when it has been changed outside of
1468Vim, set the 'autoread' option. This doesn't work at the moment you write the
1469file though, only when the file wasn't changed inside of Vim.
1470
1471Note that if a FileChangedShell autocommand is defined you will not get a
1472warning message or prompt. The autocommand is expected to handle this.
1473
Bram Moolenaar10de2da2005-01-27 14:33:00 +00001474There is no warning for a directory (e.g., with |netrw-browse|). But you do
1475get warned if you started editing a new file and it was created as a directory
1476later.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001477
1478When Vim notices the timestamp of a file has changed, and the file is being
1479edited in a buffer but has not changed, Vim checks if the contents of the file
1480is equal. This is done by reading the file again (into a hidden buffer, which
1481is immediately deleted again) and comparing the text. If the text is equal,
1482you will get no warning.
1483
1484If you don't get warned often enough you can use the following command.
1485
1486 *:checkt* *:checktime*
1487:checkt[ime] Check if any buffers were changed outside of Vim.
1488 This checks and warns you if you would end up with two
1489 versions of a file.
1490 If this is called from an autocommand, a ":global"
1491 command or is not typed the actual check is postponed
1492 until a moment the side effects (reloading the file)
1493 would be harmless.
1494 Each loaded buffer is checked for its associated file
1495 being changed. If the file was changed Vim will take
1496 action. If there are no changes in the buffer and
1497 'autoread' is set, the buffer is reloaded. Otherwise,
1498 you are offered the choice of reloading the file. If
1499 the file was deleted you get an error message.
1500 If the file previously didn't exist you get a warning
1501 if it exists now.
1502 Once a file has been checked the timestamp is reset,
1503 you will not be warned again.
1504
1505:[N]checkt[ime] {filename}
1506:[N]checkt[ime] [N]
1507 Check the timestamp of a specific buffer. The buffer
1508 may be specified by name, number or with a pattern.
1509
1510
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001511 *E813* *E814*
1512Vim will reload the buffer if you chose to. If a window is visible that
1513contains this buffer, the reloading will happen in the context of this window.
1514Otherwise a special window is used, so that most autocommands will work. You
1515can't close this window. A few other restrictions apply. Best is to make
1516sure nothing happens outside of the current buffer. E.g., setting
1517window-local options may end up in the wrong window. Splitting the window,
1518doing something there and closing it should be OK (if there are no side
1519effects from other autocommands). Closing unrelated windows and buffers will
1520get you into trouble.
1521
Bram Moolenaar071d4272004-06-13 20:20:40 +00001522Before writing a file the timestamp is checked. If it has changed, Vim will
1523ask if you really want to overwrite the file:
1524
1525 WARNING: The file has been changed since reading it!!!
1526 Do you really want to write to it (y/n)?
1527
1528If you hit 'y' Vim will continue writing the file. If you hit 'n' the write is
1529aborted. If you used ":wq" or "ZZ" Vim will not exit, you will get another
1530chance to write the file.
1531
1532The message would normally mean that somebody has written to the file after
1533the edit session started. This could be another person, in which case you
1534probably want to check if your changes to the file and the changes from the
1535other person should be merged. Write the file under another name and check for
1536differences (the "diff" program can be used for this).
1537
1538It is also possible that you modified the file yourself, from another edit
1539session or with another command (e.g., a filter command). Then you will know
1540which version of the file you want to keep.
1541
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001542There is one situation where you get the message while there is nothing wrong:
1543On a Win32 system on the day daylight saving time starts. There is something
1544in the Win32 libraries that confuses Vim about the hour time difference. The
1545problem goes away the next day.
1546
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001547==============================================================================
154811. File Searching *file-searching*
1549
1550{not available when compiled without the |+path_extra| feature}
1551
1552The file searching is currently used for the 'path', 'cdpath' and 'tags'
Bram Moolenaarc236c162008-07-13 17:41:49 +00001553options, for |finddir()| and |findfile()|. Other commands use |wildcards|
1554which is slightly different.
Bram Moolenaar9964e462007-05-05 17:54:07 +00001555
1556There are three different types of searching:
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001557
Bram Moolenaar02743632005-07-25 20:42:36 +000015581) Downward search: *starstar*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001559 Downward search uses the wildcards '*', '**' and possibly others
Bram Moolenaarc236c162008-07-13 17:41:49 +00001560 supported by your operating system. '*' and '**' are handled inside Vim,
1561 so they work on all operating systems. Note that "**" only acts as a
1562 special wildcard when it is at the start of a name.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001563
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00001564 The usage of '*' is quite simple: It matches 0 or more characters. In a
1565 search pattern this would be ".*". Note that the "." is not used for file
1566 searching.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001567
1568 '**' is more sophisticated:
1569 - It ONLY matches directories.
Bram Moolenaarc236c162008-07-13 17:41:49 +00001570 - It matches up to 30 directories deep by default, so you can use it to
1571 search an entire directory tree
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001572 - The maximum number of levels matched can be given by appending a number
1573 to '**'.
1574 Thus '/usr/**2' can match: >
1575 /usr
1576 /usr/include
1577 /usr/include/sys
1578 /usr/include/g++
1579 /usr/lib
1580 /usr/lib/X11
1581 ....
1582< It does NOT match '/usr/include/g++/std' as this would be three
1583 levels.
Bram Moolenaarc236c162008-07-13 17:41:49 +00001584 The allowed number range is 0 ('**0' is removed) to 100
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001585 If the given number is smaller than 0 it defaults to 30, if it's
Bram Moolenaarc236c162008-07-13 17:41:49 +00001586 bigger than 100 then 100 is used. The system also has a limit on the
1587 path length, usually 256 or 1024 bytes.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001588 - '**' can only be at the end of the path or be followed by a path
1589 separator or by a number and a path separator.
1590
1591 You can combine '*' and '**' in any order: >
1592 /usr/**/sys/*
Bram Moolenaarc236c162008-07-13 17:41:49 +00001593 /usr/*tory/sys/**
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001594 /usr/**2/sys/*
1595
15962) Upward search:
1597 Here you can give a directory and then search the directory tree upward for
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001598 a file. You could give stop-directories to limit the upward search. The
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001599 stop-directories are appended to the path (for the 'path' option) or to
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001600 the filename (for the 'tags' option) with a ';'. If you want several
1601 stop-directories separate them with ';'. If you want no stop-directory
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001602 ("search upward till the root directory) just use ';'. >
1603 /usr/include/sys;/usr
1604< will search in: >
1605 /usr/include/sys
1606 /usr/include
1607 /usr
1608<
1609 If you use a relative path the upward search is started in Vim's current
1610 directory or in the directory of the current file (if the relative path
1611 starts with './' and 'd' is not included in 'cpoptions').
1612
1613 If Vim's current path is /u/user_x/work/release and you do >
1614 :set path=include;/u/user_x
1615< and then search for a file with |gf| the file is searched in: >
1616 /u/user_x/work/release/include
1617 /u/user_x/work/include
1618 /u/user_x/include
1619
Bram Moolenaar402d2fe2005-04-15 21:00:38 +000016203) Combined up/downward search:
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001621 If Vim's current path is /u/user_x/work/release and you do >
1622 set path=**;/u/user_x
1623< and then search for a file with |gf| the file is searched in: >
1624 /u/user_x/work/release/**
1625 /u/user_x/work/**
1626 /u/user_x/**
1627<
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001628 BE CAREFUL! This might consume a lot of time, as the search of
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001629 '/u/user_x/**' includes '/u/user_x/work/**' and
1630 '/u/user_x/work/release/**'. So '/u/user_x/work/release/**' is searched
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001631 three times and '/u/user_x/work/**' is searched twice.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001632
1633 In the above example you might want to set path to: >
1634 :set path=**,/u/user_x/**
Bram Moolenaar162bd912010-07-28 22:29:10 +02001635< This searches:
1636 /u/user_x/work/release/** ~
1637 /u/user_x/** ~
1638 This searches the same directories, but in a different order.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001639
Bram Moolenaar162bd912010-07-28 22:29:10 +02001640 Note that completion for ":find", ":sfind", and ":tabfind" commands do not
1641 currently work with 'path' items that contain a url or use the double star
1642 (/usr/**2) or upward search (;) notations. >
Bram Moolenaar071d4272004-06-13 20:20:40 +00001643
1644 vim:tw=78:ts=8:ft=help:norl: