blob: 307e20d07813c5875fc0f713f00dd958263b74fe [file] [log] [blame]
Bram Moolenaarfa735342016-01-03 22:14:44 +01001*editing.txt* For Vim version 7.4. Last change: 2016 Jan 03
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
47 name. {not in Vi}
48
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
54and then hit CTRL-^. {Vi: only one alternate file name is remembered}
55
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.
63 {Vi does not include column number}
Bram Moolenaar071d4272004-06-13 20:20:40 +000064
Bram Moolenaar325b7a22004-07-05 15:58:32 +000065:f[ile]! like |:file|, but don't truncate the name even when
66 'shortmess' indicates this.
67
Bram Moolenaar071d4272004-06-13 20:20:40 +000068{count}CTRL-G Like CTRL-G, but prints the current file name with
69 full path. If the count is higher than 1 the current
70 buffer number is also given. {not in Vi}
71
72 *g_CTRL-G* *word-count* *byte-count*
Bram Moolenaar7c626922005-02-07 22:01:03 +000073g CTRL-G Prints the current position of the cursor in five
74 ways: Column, Line, Word, Character and Byte. If the
75 number of Characters and Bytes is the same then the
76 Character position is omitted.
77 If there are characters in the line that take more
78 than one position on the screen (<Tab> or special
79 character), both the "real" column and the screen
80 column are shown, separated with a dash.
81 See also 'ruler' option. {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +000082
83 *v_g_CTRL-G*
Bram Moolenaar7c626922005-02-07 22:01:03 +000084{Visual}g CTRL-G Similar to "g CTRL-G", but Word, Character, Line, and
85 Byte counts for the visually selected region are
86 displayed.
87 In Blockwise mode, Column count is also shown. (For
Bram Moolenaar071d4272004-06-13 20:20:40 +000088 {Visual} see |Visual-mode|.)
89 {not in VI}
90
91 *:file_f*
Bram Moolenaar325b7a22004-07-05 15:58:32 +000092:f[ile][!] {name} Sets the current file name to {name}. The optional !
93 avoids truncating the message, as with |:file|.
Bram Moolenaar7171abe2004-10-11 10:06:20 +000094 If the buffer did have a name, that name becomes the
95 |alternate-file| name. An unlisted buffer is created
96 to hold the old name.
Bram Moolenaar10de2da2005-01-27 14:33:00 +000097 *:0file*
Bram Moolenaar325b7a22004-07-05 15:58:32 +000098:0f[ile][!] Remove the name of the current buffer. The optional !
99 avoids truncating the message, as with |:file|. {not
100 in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000101
102:buffers
103:files
104:ls List all the currently known file names. See
105 'windows.txt' |:files| |:buffers| |:ls|. {not in
106 Vi}
107
108Vim will remember the full path name of a file name that you enter. In most
109cases when the file name is displayed only the name you typed is shown, but
110the full path name is being used if you used the ":cd" command |:cd|.
111
112 *home-replace*
113If the environment variable $HOME is set, and the file name starts with that
114string, it is often displayed with HOME replaced with "~". This was done to
115keep file names short. When reading or writing files the full name is still
116used, the "~" is only used when displaying file names. When replacing the
117file name would result in just "~", "~/" is used instead (to avoid confusion
Bram Moolenaar81695252004-12-29 20:58:21 +0000118between options set to $HOME with 'backupext' set to "~").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000119
120When writing the buffer, the default is to use the current file name. Thus
121when you give the "ZZ" or ":wq" command, the original file will be
122overwritten. If you do not want this, the buffer can be written into another
123file by giving a file name argument to the ":write" command. For example: >
124
125 vim testfile
126 [change the buffer with editor commands]
127 :w newfile
128 :q
129
130This will create a file "newfile", that is a modified copy of "testfile".
131The file "testfile" will remain unchanged. Anyway, if the 'backup' option is
132set, Vim renames or copies the original file before it will be overwritten.
133You can use this file if you discover that you need the original file. See
134also the 'patchmode' option. The name of the backup file is normally the same
135as the original file with 'backupext' appended. The default "~" is a bit
136strange to avoid accidentally overwriting existing files. If you prefer ".bak"
137change the 'backupext' option. Extra dots are replaced with '_' on MS-DOS
138machines, when Vim has detected that an MS-DOS-like filesystem is being used
139(e.g., messydos or crossdos) or when the 'shortname' option is on. The
140backup file can be placed in another directory by setting 'backupdir'.
141
142 *auto-shortname*
143Technical: On the Amiga you can use 30 characters for a file name. But on an
144 MS-DOS-compatible filesystem only 8 plus 3 characters are
145 available. Vim tries to detect the type of filesystem when it is
146 creating the .swp file. If an MS-DOS-like filesystem is suspected,
147 a flag is set that has the same effect as setting the 'shortname'
148 option. This flag will be reset as soon as you start editing a
149 new file. The flag will be used when making the file name for the
150 ".swp" and ".~" files for the current file. But when you are
151 editing a file in a normal filesystem and write to an MS-DOS-like
152 filesystem the flag will not have been set. In that case the
153 creation of the ".~" file may fail and you will get an error
154 message. Use the 'shortname' option in this case.
155
156When you started editing without giving a file name, "No File" is displayed in
157messages. If the ":write" command is used with a file name argument, the file
158name for the current file is set to that file name. This only happens when
Bram Moolenaar2d3f4892006-01-20 23:02:51 +0000159the 'F' flag is included in 'cpoptions' (by default it is included) |cpo-F|.
160This is useful when entering text in an empty buffer and then writing it to a
161file. If 'cpoptions' contains the 'f' flag (by default it is NOT included)
162|cpo-f| the file name is set for the ":read file" command. This is useful
163when starting Vim without an argument and then doing ":read file" to start
164editing a file.
165When the file name was set and 'filetype' is empty the filetype detection
166autocommands will be triggered.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000167 *not-edited*
168Because the file name was set without really starting to edit that file, you
169are protected from overwriting that file. This is done by setting the
170"notedited" flag. You can see if this flag is set with the CTRL-G or ":file"
171command. It will include "[Not edited]" when the "notedited" flag is set.
172When writing the buffer to the current file name (with ":w!"), the "notedited"
173flag is reset.
174
175 *abandon*
176Vim remembers whether you have changed the buffer. You are protected from
177losing the changes you made. If you try to quit without writing, or want to
178start editing another file, Vim will refuse this. In order to overrule this
179protection, add a '!' to the command. The changes will then be lost. For
180example: ":q" will not work if the buffer was changed, but ":q!" will. To see
181whether the buffer was changed use the "CTRL-G" command. The message includes
182the string "[Modified]" if the buffer has been changed.
183
184If you want to automatically save the changes without asking, switch on the
185'autowriteall' option. 'autowrite' is the associated Vi-compatible option
186that does not work for all commands.
187
188If you want to keep the changed buffer without saving it, switch on the
Bram Moolenaar9d98fe92013-08-03 18:35:36 +0200189'hidden' option. See |hidden-buffer|. Some commands work like this even when
190'hidden' is not set, check the help for the command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000191
192==============================================================================
1932. Editing a file *edit-a-file*
194
Bram Moolenaar9d98fe92013-08-03 18:35:36 +0200195 *:e* *:edit* *reload*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000196:e[dit] [++opt] [+cmd] Edit the current file. This is useful to re-edit the
197 current file, when it has been changed outside of Vim.
198 This fails when changes have been made to the current
199 buffer and 'autowriteall' isn't set or the file can't
200 be written.
201 Also see |++opt| and |+cmd|.
202 {Vi: no ++opt}
203
Bram Moolenaar9d98fe92013-08-03 18:35:36 +0200204 *:edit!* *discard*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000205:e[dit]! [++opt] [+cmd]
206 Edit the current file always. Discard any changes to
207 the current buffer. This is useful if you want to
208 start all over again.
209 Also see |++opt| and |+cmd|.
210 {Vi: no ++opt}
211
212 *:edit_f*
213:e[dit] [++opt] [+cmd] {file}
214 Edit {file}.
215 This fails when changes have been made to the current
216 buffer, unless 'hidden' is set or 'autowriteall' is
217 set and the file can be written.
218 Also see |++opt| and |+cmd|.
219 {Vi: no ++opt}
220
221 *:edit!_f*
222:e[dit]! [++opt] [+cmd] {file}
223 Edit {file} always. Discard any changes to the
224 current buffer.
225 Also see |++opt| and |+cmd|.
226 {Vi: no ++opt}
227
228:e[dit] [++opt] [+cmd] #[count]
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000229 Edit the [count]th buffer (as shown by |:files|).
230 This command does the same as [count] CTRL-^. But ":e
231 #" doesn't work if the alternate buffer doesn't have a
232 file name, while CTRL-^ still works then.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000233 Also see |++opt| and |+cmd|.
234 {Vi: no ++opt}
235
236 *:ene* *:enew*
237:ene[w] Edit a new, unnamed buffer. This fails when changes
238 have been made to the current buffer, unless 'hidden'
239 is set or 'autowriteall' is set and the file can be
240 written.
241 If 'fileformats' is not empty, the first format given
242 will be used for the new buffer. If 'fileformats' is
243 empty, the 'fileformat' of the current buffer is used.
244 {not in Vi}
245
246 *:ene!* *:enew!*
247:ene[w]! Edit a new, unnamed buffer. Discard any changes to
248 the current buffer.
249 Set 'fileformat' like |:enew|.
250 {not in Vi}
251
252 *:fin* *:find*
253:fin[d][!] [++opt] [+cmd] {file}
254 Find {file} in 'path' and then |:edit| it.
255 {not in Vi} {not available when the |+file_in_path|
256 feature was disabled at compile time}
257
258:{count}fin[d][!] [++opt] [+cmd] {file}
259 Just like ":find", but use the {count} match in
260 'path'. Thus ":2find file" will find the second
261 "file" found in 'path'. When there are fewer matches
262 for the file in 'path' than asked for, you get an
263 error message.
264
265 *:ex*
266:ex [++opt] [+cmd] [file]
267 Same as |:edit|.
268
269 *:vi* *:visual*
270:vi[sual][!] [++opt] [+cmd] [file]
Bram Moolenaar81695252004-12-29 20:58:21 +0000271 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|.
273
274 *:vie* *:view*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100275:vie[w][!] [++opt] [+cmd] file
Bram Moolenaar81695252004-12-29 20:58:21 +0000276 When used in Ex mode: Leave |Ex mode|, go back to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000277 Normal mode. Otherwise same as |:edit|, but set
278 'readonly' option for this buffer. {not in Vi}
279
280 *CTRL-^* *CTRL-6*
Bram Moolenaar662db672011-03-22 14:05:35 +0100281CTRL-^ Edit the alternate file. Mostly the alternate file is
282 the previously edited file. This is a quick way to
283 toggle between two files. It is equivalent to ":e #",
284 except that it also works when there is no file name.
285
Bram Moolenaar071d4272004-06-13 20:20:40 +0000286 If the 'autowrite' or 'autowriteall' option is on and
287 the buffer was changed, write it.
288 Mostly the ^ character is positioned on the 6 key,
289 pressing CTRL and 6 then gets you what we call CTRL-^.
290 But on some non-US keyboards CTRL-^ is produced in
291 another way.
292
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000293{count}CTRL-^ Edit [count]th file in the buffer list (equivalent to
294 ":e #[count]"). This is a quick way to switch between
295 files.
296 See |CTRL-^| above for further details.
297 {not in Vi}
298
Bram Moolenaar071d4272004-06-13 20:20:40 +0000299[count]]f *]f* *[f*
300[count][f Same as "gf". Deprecated.
301
302 *gf* *E446* *E447*
303[count]gf Edit the file whose name is under or after the cursor.
304 Mnemonic: "goto file".
305 Uses the 'isfname' option to find out which characters
306 are supposed to be in a file name. Trailing
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100307 punctuation characters ".,:;!" are ignored. Escaped
308 spaces "\ " are reduced to a single space.
Bram Moolenaarc236c162008-07-13 17:41:49 +0000309 Uses the 'path' option as a list of directory names to
310 look for the file. See the 'path' option for details
311 about relative directories and wildcards.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000312 Uses the 'suffixesadd' option to check for file names
313 with a suffix added.
314 If the file can't be found, 'includeexpr' is used to
315 modify the name and another attempt is done.
316 If a [count] is given, the count'th file that is found
317 in the 'path' is edited.
318 This command fails if Vim refuses to |abandon| the
319 current file.
Bram Moolenaar8dff8182006-04-06 20:18:50 +0000320 If you want to edit the file in a new window use
321 |CTRL-W_CTRL-F|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000322 If you do want to edit a new file, use: >
323 :e <cfile>
324< To make gf always work like that: >
325 :map gf :e <cfile><CR>
326< If the name is a hypertext link, that looks like
327 "type://machine/path", you need the |netrw| plugin.
328 For Unix the '~' character is expanded, like in
329 "~user/file". Environment variables are expanded too
330 |expand-env|.
331 {not in Vi}
332 {not available when the |+file_in_path| feature was
333 disabled at compile time}
334
335 *v_gf*
336{Visual}[count]gf Same as "gf", but the highlighted text is used as the
337 name of the file to edit. 'isfname' is ignored.
338 Leading blanks are skipped, otherwise all blanks and
339 special characters are included in the file name.
340 (For {Visual} see |Visual-mode|.)
341 {not in VI}
342
Bram Moolenaard1f56e62006-02-22 21:25:37 +0000343 *gF*
344[count]gF Same as "gf", except if a number follows the file
345 name, then the cursor is positioned on that line in
346 the file. The file name and the number must be
347 separated by a non-filename (see 'isfname') and
348 non-numeric character. White space between the
349 filename, the separator and the number are ignored.
Bram Moolenaard8fc5c02006-04-29 21:55:22 +0000350 Examples:
351 eval.c:10 ~
352 eval.c @ 20 ~
353 eval.c (30) ~
354 eval.c 40 ~
355
Bram Moolenaard1f56e62006-02-22 21:25:37 +0000356 *v_gF*
357{Visual}[count]gF Same as "v_gf".
358
Bram Moolenaar071d4272004-06-13 20:20:40 +0000359These commands are used to start editing a single file. This means that the
360file is read into the buffer and the current file name is set. The file that
361is opened depends on the current directory, see |:cd|.
362
363See |read-messages| for an explanation of the message that is given after the
364file has been read.
365
366You can use the ":e!" command if you messed up the buffer and want to start
367all over again. The ":e" command is only useful if you have changed the
368current file name.
369
370 *:filename* *{file}*
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000371Besides the things mentioned here, more special items for where a filename is
372expected are mentioned at |cmdline-special|.
373
Bram Moolenaarc236c162008-07-13 17:41:49 +0000374Note for systems other than Unix: When using a command that accepts a single
375file name (like ":edit file") spaces in the file name are allowed, but
376trailing spaces are ignored. This is useful on systems that regularly embed
377spaces in file names (like MS-Windows and the Amiga). Example: The command
378":e Long File Name " will edit the file "Long File Name". When using a
379command that accepts more than one file name (like ":next file1 file2")
380embedded spaces must be escaped with a backslash.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000381
Bram Moolenaar9964e462007-05-05 17:54:07 +0000382 *wildcard* *wildcards*
Bram Moolenaar30b65812012-07-12 22:01:11 +0200383Wildcards in {file} are expanded, but as with file completion, 'wildignore'
384and 'suffixes' apply. Which wildcards are supported depends on the system.
385These are the common ones:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000386 ? matches one character
Bram Moolenaar02743632005-07-25 20:42:36 +0000387 * matches anything, including nothing
388 ** matches anything, including nothing, recurses into directories
Bram Moolenaar071d4272004-06-13 20:20:40 +0000389 [abc] match 'a', 'b' or 'c'
Bram Moolenaar02743632005-07-25 20:42:36 +0000390
Bram Moolenaar071d4272004-06-13 20:20:40 +0000391To avoid the special meaning of the wildcards prepend a backslash. However,
392on MS-Windows the backslash is a path separator and "path\[abc]" is still seen
393as a wildcard when "[" is in the 'isfname' option. A simple way to avoid this
394is to use "path\[[]abc]". Then the file "path[abc]" literally.
395
Bram Moolenaar02743632005-07-25 20:42:36 +0000396 *starstar-wildcard*
397Expanding "**" is possible on Unix, Win32, Mac OS/X and a few other systems.
398This allows searching a directory tree. This goes up to 100 directories deep.
Bram Moolenaar9b451252012-08-15 17:43:31 +0200399Note there are some commands where this works slightly differently, see
Bram Moolenaarc236c162008-07-13 17:41:49 +0000400|file-searching|.
Bram Moolenaar02743632005-07-25 20:42:36 +0000401Example: >
402 :n **/*.txt
403Finds files:
404 ttt.txt
405 subdir/ttt.txt
406 a/b/c/d/ttt.txt
407When non-wildcard characters are used these are only matched in the first
408directory. Example: >
409 :n /usr/inc**/*.h
410Finds files:
411 /usr/include/types.h
412 /usr/include/sys/types.h
413 /usr/inc_old/types.h
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 Moolenaarfc39ecf2015-08-11 20:34:49 +0200419The backslashes before the star are required to prevent the shell from
420expanding "ver*.c" prior to execution of the find program. The backslash
421before the shell pipe symbol "|" prevents Vim from parsing it as command
422termination.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000423This also works for most other systems, with the restriction that the
424backticks must be around the whole item. It is not possible to have text
425directly before the first or just after the last backtick.
426
Bram Moolenaared203462004-06-16 11:19:22 +0000427 *`=*
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200428You can have the backticks expanded as a Vim expression, instead of as an
429external command, by putting an equal sign right after the first backtick,
430e.g.: >
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000431 :e `=tempname()`
432The expression can contain just about anything, thus this can also be used to
Bram Moolenaar30b65812012-07-12 22:01:11 +0200433avoid the special meaning of '"', '|', '%' and '#'. However, 'wildignore'
Bram Moolenaar00154502013-02-13 16:15:55 +0100434does apply like to other wildcards.
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200435
Bram Moolenaar88774fd2015-08-25 19:52:04 +0200436Environment variables in the expression are expanded when evaluating the
437expression, thus this works: >
438 :e `=$HOME . '/.vimrc'`
439This does not work, $HOME is inside a string and used literally: >
440 :e `='$HOME' . '/.vimrc'`
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200441
Bram Moolenaar30b65812012-07-12 22:01:11 +0200442If the expression returns a string then names are to be separated with line
443breaks. When the result is a |List| then each item is used as a name. Line
444breaks also separate names.
Bram Moolenaarf9132812015-07-21 19:19:13 +0200445Note that such expressions are only supported in places where a filename is
446expected as an argument to an Ex-command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000447
448 *++opt* *[++opt]*
Bram Moolenaarb0bf8582005-12-13 20:02:15 +0000449The [++opt] argument can be used to force the value of 'fileformat',
450'fileencoding' or 'binary' to a value for one command, and to specify the
451behavior for bad characters. The form is: >
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000452 ++{optname}
453Or: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000454 ++{optname}={value}
455
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000456Where {optname} is one of: *++ff* *++enc* *++bin* *++nobin* *++edit*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000457 ff or fileformat overrides 'fileformat'
458 enc or encoding overrides 'fileencoding'
459 bin or binary sets 'binary'
460 nobin or nobinary resets 'binary'
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000461 bad specifies behavior for bad characters
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000462 edit for |:read| only: keep option values as if editing
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000463 a file
Bram Moolenaar071d4272004-06-13 20:20:40 +0000464
465{value} cannot contain white space. It can be any valid value for these
466options. Examples: >
467 :e ++ff=unix
468This edits the same file again with 'fileformat' set to "unix". >
469
470 :w ++enc=latin1 newfile
471This writes the current buffer to "newfile" in latin1 format.
472
Bram Moolenaarb0bf8582005-12-13 20:02:15 +0000473There may be several ++opt arguments, separated by white space. They must all
474appear before any |+cmd| argument.
475
476 *++bad*
477The argument of "++bad=" specifies what happens with characters that can't be
478converted and illegal bytes. It can be one of three things:
479 ++bad=X A single-byte character that replaces each bad character.
480 ++bad=keep Keep bad characters without conversion. Note that this may
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000481 result in illegal bytes in your text!
Bram Moolenaarb0bf8582005-12-13 20:02:15 +0000482 ++bad=drop Remove the bad characters.
483
484The default is like "++bad=?": Replace each bad character with a question
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100485mark. In some places an inverted question mark is used (0xBF).
486
487Note that not all commands use the ++bad argument, even though they do not
488give an error when you add it. E.g. |:write|.
Bram Moolenaarb0bf8582005-12-13 20:02:15 +0000489
Bram Moolenaar071d4272004-06-13 20:20:40 +0000490Note that when reading, the 'fileformat' and 'fileencoding' options will be
491set to the used format. When writing this doesn't happen, thus a next write
492will use the old value of the option. Same for the 'binary' option.
493
Bram Moolenaar071d4272004-06-13 20:20:40 +0000494
495 *+cmd* *[+cmd]*
496The [+cmd] argument can be used to position the cursor in the newly opened
497file, or execute any other command:
498 + Start at the last line.
499 +{num} Start at line {num}.
500 +/{pat} Start at first line containing {pat}.
501 +{command} Execute {command} after opening the new file.
502 {command} is any Ex command.
503To include a white space in the {pat} or {command}, precede it with a
504backslash. Double the number of backslashes. >
505 :edit +/The\ book file
506 :edit +/dir\ dirname\\ file
507 :edit +set\ dir=c:\\\\temp file
508Note that in the last example the number of backslashes is halved twice: Once
509for the "+cmd" argument and once for the ":set" command.
510
511 *file-formats*
512The 'fileformat' option sets the <EOL> style for a file:
513'fileformat' characters name ~
514 "dos" <CR><NL> or <NL> DOS format *DOS-format*
515 "unix" <NL> Unix format *Unix-format*
516 "mac" <CR> Mac format *Mac-format*
517Previously 'textmode' was used. It is obsolete now.
518
519When reading a file, the mentioned characters are interpreted as the <EOL>.
520In DOS format (default for MS-DOS, OS/2 and Win32), <CR><NL> and <NL> are both
521interpreted as the <EOL>. Note that when writing the file in DOS format,
522<CR> characters will be added for each single <NL>. Also see |file-read|.
523
524When writing a file, the mentioned characters are used for <EOL>. For DOS
525format <CR><NL> is used. Also see |DOS-format-write|.
526
527You can read a file in DOS format and write it in Unix format. This will
528replace all <CR><NL> pairs by <NL> (assuming 'fileformats' includes "dos"): >
529 :e file
530 :set fileformat=unix
531 :w
532If you read a file in Unix format and write with DOS format, all <NL>
533characters will be replaced with <CR><NL> (assuming 'fileformats' includes
534"unix"): >
535 :e file
536 :set fileformat=dos
537 :w
538
539If you start editing a new file and the 'fileformats' option is not empty
540(which is the default), Vim will try to detect whether the lines in the file
541are separated by the specified formats. When set to "unix,dos", Vim will
542check for lines with a single <NL> (as used on Unix and Amiga) or by a <CR>
543<NL> pair (MS-DOS). Only when ALL lines end in <CR><NL>, 'fileformat' is set
544to "dos", otherwise it is set to "unix". When 'fileformats' includes "mac",
545and no <NL> characters are found in the file, 'fileformat' is set to "mac".
546
547If the 'fileformat' option is set to "dos" on non-MS-DOS systems the message
548"[dos format]" is shown to remind you that something unusual is happening. On
549MS-DOS systems you get the message "[unix format]" if 'fileformat' is set to
550"unix". On all systems but the Macintosh you get the message "[mac format]"
551if 'fileformat' is set to "mac".
552
553If the 'fileformats' option is empty and DOS format is used, but while reading
554a file some lines did not end in <CR><NL>, "[CR missing]" will be included in
555the file message.
556If the 'fileformats' option is empty and Mac format is used, but while reading
557a file a <NL> was found, "[NL missing]" will be included in the file message.
558
559If the new file does not exist, the 'fileformat' of the current buffer is used
560when 'fileformats' is empty. Otherwise the first format from 'fileformats' is
561used for the new file.
562
563Before editing binary, executable or Vim script files you should set the
564'binary' option. A simple way to do this is by starting Vim with the "-b"
565option. This will avoid the use of 'fileformat'. Without this you risk that
566single <NL> characters are unexpectedly replaced with <CR><NL>.
567
568You can encrypt files that are written by setting the 'key' option. This
569provides some security against others reading your files. |encryption|
570
571
Bram Moolenaar071d4272004-06-13 20:20:40 +0000572==============================================================================
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005733. The argument list *argument-list* *arglist*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000574
575If you give more than one file name when starting Vim, this list is remembered
576as the argument list. You can jump to each file in this list.
577
578Do not confuse this with the buffer list, which you can see with the
579|:buffers| command. The argument list was already present in Vi, the buffer
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000580list is new in Vim. Every file name in the argument list will also be present
581in the buffer list (unless it was deleted with |:bdel| or |:bwipe|). But it's
582common that names in the buffer list are not in the argument list.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000583
584This subject is introduced in section |07.2| of the user manual.
585
586There is one global argument list, which is used for all windows by default.
587It is possible to create a new argument list local to a window, see
588|:arglocal|.
589
590You can use the argument list with the following commands, and with the
591expression functions |argc()| and |argv()|. These all work on the argument
592list of the current window.
593
594 *:ar* *:args*
595:ar[gs] Print the argument list, with the current file in
596 square brackets.
597
598:ar[gs] [++opt] [+cmd] {arglist} *:args_f*
599 Define {arglist} as the new argument list and edit
600 the first one. This fails when changes have been made
601 and Vim does not want to |abandon| the current buffer.
602 Also see |++opt| and |+cmd|.
603 {Vi: no ++opt}
604
605:ar[gs]! [++opt] [+cmd] {arglist} *:args_f!*
606 Define {arglist} as the new argument list and edit
607 the first one. Discard any changes to the current
608 buffer.
609 Also see |++opt| and |+cmd|.
610 {Vi: no ++opt}
611
612:[count]arge[dit][!] [++opt] [+cmd] {name} *:arge* *:argedit*
613 Add {name} to the argument list and edit it.
614 When {name} already exists in the argument list, this
615 entry is edited.
616 This is like using |:argadd| and then |:edit|.
617 Note that only one file name is allowed, and spaces
618 inside the file name are allowed, like with |:edit|.
619 [count] is used like with |:argadd|.
620 [!] is required if the current file cannot be
621 |abandon|ed.
622 Also see |++opt| and |+cmd|.
623 {not in Vi}
624
625:[count]arga[dd] {name} .. *:arga* *:argadd* *E479*
Bram Moolenaar91e15e12014-09-19 22:38:48 +0200626:[count]arga[dd]
627 Add the {name}s to the argument list. When {name} is
Bram Moolenaared32d942014-12-06 23:33:00 +0100628 omitted add the current buffer name to the argument
Bram Moolenaar91e15e12014-09-19 22:38:48 +0200629 list.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000630 If [count] is omitted, the {name}s are added just
631 after the current entry in the argument list.
632 Otherwise they are added after the [count]'th file.
633 If the argument list is "a b c", and "b" is the
634 current argument, then these commands result in:
635 command new argument list ~
636 :argadd x a b x c
637 :0argadd x x a b c
638 :1argadd x a x b c
Bram Moolenaared32d942014-12-06 23:33:00 +0100639 :$argadd x a b c x
640 :+2argadd y a b c x y
Bram Moolenaar071d4272004-06-13 20:20:40 +0000641 There is no check for duplicates, it is possible to
642 add a file to the argument list twice.
643 The currently edited file is not changed.
644 {not in Vi} {not available when compiled without the
645 |+listcmds| feature}
646 Note: you can also use this method: >
647 :args ## x
648< This will add the "x" item and sort the new list.
649
650:argd[elete] {pattern} .. *:argd* *:argdelete* *E480*
651 Delete files from the argument list that match the
652 {pattern}s. {pattern} is used like a file pattern,
653 see |file-pattern|. "%" can be used to delete the
654 current entry.
655 This command keeps the currently edited file, also
656 when it's deleted from the argument list.
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +0000657 Example: >
658 :argdel *.obj
659< {not in Vi} {not available when compiled without the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000660 |+listcmds| feature}
661
Bram Moolenaared32d942014-12-06 23:33:00 +0100662:[range]argd[elete] Delete the {range} files from the argument list.
663 Example: >
664 :10,$argdel
665< Deletes arguments 10 and further, keeping 1-9. >
666 :$argd
667< Deletes just the last one. >
668 :argd
669 :.argd
670< Deletes the current argument. >
671 :%argd
672< Removes all the files from the arglist.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000673 When the last number in the range is too high, up to
Bram Moolenaared32d942014-12-06 23:33:00 +0100674 the last argument is deleted.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000675 {not in Vi} {not available when compiled without the
676 |+listcmds| feature}
677
678 *:argu* *:argument*
679:[count]argu[ment] [count] [++opt] [+cmd]
680 Edit file [count] in the argument list. When [count]
681 is omitted the current entry is used. This fails
682 when changes have been made and Vim does not want to
683 |abandon| the current buffer.
684 Also see |++opt| and |+cmd|.
685 {not in Vi} {not available when compiled without the
686 |+listcmds| feature}
687
688:[count]argu[ment]! [count] [++opt] [+cmd]
689 Edit file [count] in the argument list, discard any
690 changes to the current buffer. When [count] is
691 omitted the current entry is used.
692 Also see |++opt| and |+cmd|.
693 {not in Vi} {not available when compiled without the
694 |+listcmds| feature}
695
696:[count]n[ext] [++opt] [+cmd] *:n* *:ne* *:next* *E165* *E163*
697 Edit [count] next file. This fails when changes have
698 been made and Vim does not want to |abandon| the
699 current buffer. Also see |++opt| and |+cmd|. {Vi: no
700 count or ++opt}.
701
702:[count]n[ext]! [++opt] [+cmd]
703 Edit [count] next file, discard any changes to the
704 buffer. Also see |++opt| and |+cmd|. {Vi: no count
705 or ++opt}.
706
707:n[ext] [++opt] [+cmd] {arglist} *:next_f*
708 Same as |:args_f|.
709
710:n[ext]! [++opt] [+cmd] {arglist}
711 Same as |:args_f!|.
712
713:[count]N[ext] [count] [++opt] [+cmd] *:Next* *:N* *E164*
714 Edit [count] previous file in argument list. This
715 fails when changes have been made and Vim does not
716 want to |abandon| the current buffer.
717 Also see |++opt| and |+cmd|. {Vi: no count or ++opt}.
718
719:[count]N[ext]! [count] [++opt] [+cmd]
720 Edit [count] previous file in argument list. Discard
721 any changes to the buffer. Also see |++opt| and
722 |+cmd|. {Vi: no count or ++opt}.
723
724:[count]prev[ious] [count] [++opt] [+cmd] *:prev* *:previous*
725 Same as :Next. Also see |++opt| and |+cmd|. {Vi:
726 only in some versions}
727
728 *:rew* *:rewind*
729:rew[ind] [++opt] [+cmd]
730 Start editing the first file in the argument list.
731 This fails when changes have been made and Vim does
732 not want to |abandon| the current buffer.
733 Also see |++opt| and |+cmd|. {Vi: no ++opt}
734
735:rew[ind]! [++opt] [+cmd]
736 Start editing the first file in the argument list.
737 Discard any changes to the buffer. Also see |++opt|
738 and |+cmd|. {Vi: no ++opt}
739
740 *:fir* *:first*
741:fir[st][!] [++opt] [+cmd]
742 Other name for ":rewind". {not in Vi}
743
744 *:la* *:last*
745:la[st] [++opt] [+cmd]
746 Start editing the last file in the argument list.
747 This fails when changes have been made and Vim does
748 not want to |abandon| the current buffer.
749 Also see |++opt| and |+cmd|. {not in Vi}
750
751:la[st]! [++opt] [+cmd]
752 Start editing the last file in the argument list.
753 Discard any changes to the buffer. Also see |++opt|
754 and |+cmd|. {not in Vi}
755
756 *:wn* *:wnext*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000757:[count]wn[ext] [++opt]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000758 Write current file and start editing the [count]
759 next file. Also see |++opt| and |+cmd|. {not in Vi}
760
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000761:[count]wn[ext] [++opt] {file}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000762 Write current file to {file} and start editing the
763 [count] next file, unless {file} already exists and
764 the 'writeany' option is off. Also see |++opt| and
765 |+cmd|. {not in Vi}
766
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000767:[count]wn[ext]! [++opt] {file}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000768 Write current file to {file} and start editing the
769 [count] next file. Also see |++opt| and |+cmd|. {not
770 in Vi}
771
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000772:[count]wN[ext][!] [++opt] [file] *:wN* *:wNext*
773:[count]wp[revious][!] [++opt] [file] *:wp* *:wprevious*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000774 Same as :wnext, but go to previous file instead of
775 next. {not in Vi}
776
777The [count] in the commands above defaults to one. For some commands it is
778possible to use two counts. The last one (rightmost one) is used.
779
780If no [+cmd] argument is present, the cursor is positioned at the last known
781cursor position for the file. If 'startofline' is set, the cursor will be
782positioned at the first non-blank in the line, otherwise the last know column
783is used. If there is no last known cursor position the cursor will be in the
784first line (the last line in Ex mode).
785
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000786 *{arglist}*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000787The wildcards in the argument list are expanded and the file names are sorted.
788Thus you can use the command "vim *.c" to edit all the C files. From within
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000789Vim the command ":n *.c" does the same.
790
791White space is used to separate file names. Put a backslash before a space or
Bram Moolenaar9e368db2007-05-12 13:25:01 +0000792tab to include it in a file name. E.g., to edit the single file "foo bar": >
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000793 :next foo\ bar
794
795On Unix and a few other systems you can also use backticks, for example: >
796 :next `find . -name \\*.c -print`
Bram Moolenaar071d4272004-06-13 20:20:40 +0000797The backslashes before the star are required to prevent "*.c" to be expanded
798by the shell before executing the find program.
799
800 *arglist-position*
801When there is an argument list you can see which file you are editing in the
802title of the window (if there is one and 'title' is on) and with the file
803message you get with the "CTRL-G" command. You will see something like
804 (file 4 of 11)
805If 'shortmess' contains 'f' it will be
806 (4 of 11)
807If you are not really editing the file at the current position in the argument
808list it will be
809 (file (4) of 11)
810This means that you are position 4 in the argument list, but not editing the
811fourth file in the argument list. This happens when you do ":e file".
812
813
814LOCAL ARGUMENT LIST
815
816{not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +0200817{not available when compiled without the |+windows| or |+listcmds| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000818
819 *:arglocal*
820:argl[ocal] Make a local copy of the global argument list.
821 Doesn't start editing another file.
822
823:argl[ocal][!] [++opt] [+cmd] {arglist}
824 Define a new argument list, which is local to the
825 current window. Works like |:args_f| otherwise.
826
827 *:argglobal*
828:argg[lobal] Use the global argument list for the current window.
829 Doesn't start editing another file.
830
831:argg[lobal][!] [++opt] [+cmd] {arglist}
832 Use the global argument list for the current window.
833 Define a new global argument list like |:args_f|.
834 All windows using the global argument list will see
835 this new list.
836
837There can be several argument lists. They can be shared between windows.
838When they are shared, changing the argument list in one window will also
839change it in the other window.
840
841When a window is split the new window inherits the argument list from the
842current window. The two windows then share this list, until one of them uses
843|:arglocal| or |:argglobal| to use another argument list.
844
845
846USING THE ARGUMENT LIST
847
848 *:argdo*
Bram Moolenaara162bc52015-01-07 16:54:21 +0100849:[range]argdo[!] {cmd} Execute {cmd} for each file in the argument list or
850 if [range] is specified only for arguments in that
851 range. It works like doing this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000852 :rewind
853 :{cmd}
854 :next
855 :{cmd}
856 etc.
857< When the current file can't be |abandon|ed and the [!]
858 is not present, the command fails.
859 When an error is detected on one file, further files
860 in the argument list will not be visited.
861 The last file in the argument list (or where an error
862 occurred) becomes the current file.
863 {cmd} can contain '|' to concatenate several commands.
864 {cmd} must not change the argument list.
865 Note: While this command is executing, the Syntax
866 autocommand event is disabled by adding it to
867 'eventignore'. This considerably speeds up editing
868 each file.
869 {not in Vi} {not available when compiled without the
870 |+listcmds| feature}
Bram Moolenaaraa23b372015-09-08 18:46:31 +0200871 Also see |:windo|, |:tabdo|, |:bufdo|, |:cdo|, |:ldo|,
872 |:cfdo| and |:lfdo|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000873
874Example: >
875 :args *.c
876 :argdo set ff=unix | update
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100877This sets the 'fileformat' option to "unix" and writes the file if it is now
Bram Moolenaar071d4272004-06-13 20:20:40 +0000878changed. This is done for all *.c files.
879
880Example: >
881 :args *.[ch]
882 :argdo %s/\<my_foo\>/My_Foo/ge | update
883This changes the word "my_foo" to "My_Foo" in all *.c and *.h files. The "e"
884flag is used for the ":substitute" command to avoid an error for files where
885"my_foo" isn't used. ":update" writes the file only if changes were made.
886
887==============================================================================
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00008884. Writing *writing* *save-file*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000889
890Note: When the 'write' option is off, you are not able to write any file.
891
892 *:w* *:write*
893 *E502* *E503* *E504* *E505*
Bram Moolenaar9964e462007-05-05 17:54:07 +0000894 *E512* *E514* *E667* *E796*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000895:w[rite] [++opt] Write the whole buffer to the current file. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000896 the normal way to save changes to a file. It fails
897 when the 'readonly' option is set or when there is
898 another reason why the file can't be written.
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000899 For ++opt see |++opt|, but only ++bin, ++nobin, ++ff
900 and ++enc are effective.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000901
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000902:w[rite]! [++opt] Like ":write", but forcefully write when 'readonly' is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000903 set or there is another reason why writing was
904 refused.
905 Note: This may change the permission and ownership of
906 the file and break (symbolic) links. Add the 'W' flag
907 to 'cpoptions' to avoid this.
908
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000909:[range]w[rite][!] [++opt]
910 Write the specified lines to the current file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000911 is unusual, because the file will not contain all
912 lines in the buffer.
913
914 *:w_f* *:write_f*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000915:[range]w[rite] [++opt] {file}
916 Write the specified lines to {file}, unless it
Bram Moolenaar071d4272004-06-13 20:20:40 +0000917 already exists and the 'writeany' option is off.
918
919 *:w!*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000920:[range]w[rite]! [++opt] {file}
921 Write the specified lines to {file}. Overwrite an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000922 existing file.
923
924 *:w_a* *:write_a* *E494*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000925:[range]w[rite][!] [++opt] >>
926 Append the specified lines to the current file.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000927
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000928:[range]w[rite][!] [++opt] >> {file}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000929 Append the specified lines to {file}. '!' forces the
930 write even if file does not exist.
931
932 *:w_c* *:write_c*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000933:[range]w[rite] [++opt] !{cmd}
934 Execute {cmd} with [range] lines as standard input
Bram Moolenaar071d4272004-06-13 20:20:40 +0000935 (note the space in front of the '!'). {cmd} is
936 executed like with ":!{cmd}", any '!' is replaced with
937 the previous command |:!|.
938
Bram Moolenaar5c4e21c2004-10-12 19:54:52 +0000939The default [range] for the ":w" command is the whole buffer (1,$). If you
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000940write the whole buffer, it is no longer considered changed. When you
941write it to a different file with ":w somefile" it depends on the "+" flag in
942'cpoptions'. When included, the write command will reset the 'modified' flag,
943even though the buffer itself may still be different from its file.
Bram Moolenaar5c4e21c2004-10-12 19:54:52 +0000944
Bram Moolenaar071d4272004-06-13 20:20:40 +0000945If a file name is given with ":w" it becomes the alternate file. This can be
946used, for example, when the write fails and you want to try again later with
947":w #". This can be switched off by removing the 'A' flag from the
948'cpoptions' option.
949
950 *:sav* *:saveas*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000951:sav[eas][!] [++opt] {file}
952 Save the current buffer under the name {file} and set
Bram Moolenaar071d4272004-06-13 20:20:40 +0000953 the filename of the current buffer to {file}. The
954 previous name is used for the alternate file name.
955 The [!] is needed to overwrite an existing file.
Bram Moolenaar2d3f4892006-01-20 23:02:51 +0000956 When 'filetype' is empty filetype detection is done
957 with the new name, before the file is written.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000958 When the write was successful 'readonly' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000959 {not in Vi}
960
961 *:up* *:update*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000962:[range]up[date][!] [++opt] [>>] [file]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000963 Like ":write", but only write when the buffer has been
964 modified. {not in Vi}
965
966
967WRITING WITH MULTIPLE BUFFERS *buffer-write*
968
969 *:wa* *:wall*
970:wa[ll] Write all changed buffers. Buffers without a file
971 name or which are readonly are not written. {not in
972 Vi}
973
974:wa[ll]! Write all changed buffers, even the ones that are
975 readonly. Buffers without a file name are not
976 written. {not in Vi}
977
978
979Vim will warn you if you try to overwrite a file that has been changed
980elsewhere. See |timestamp|.
981
982 *backup* *E207* *E506* *E507* *E508* *E509* *E510*
983If you write to an existing file (but do not append) while the 'backup',
984'writebackup' or 'patchmode' option is on, a backup of the original file is
985made. The file is either copied or renamed (see 'backupcopy'). After the
986file has been successfully written and when the 'writebackup' option is on and
987the 'backup' option is off, the backup file is deleted. When the 'patchmode'
988option is on the backup file may be renamed.
989
990 *backup-table*
991'backup' 'writebackup' action ~
992 off off no backup made
993 off on backup current file, deleted afterwards (default)
994 on off delete old backup, backup current file
995 on on delete old backup, backup current file
996
997When the 'backupskip' pattern matches with the name of the file which is
998written, no backup file is made. The values of 'backup' and 'writebackup' are
999ignored then.
1000
1001When the 'backup' option is on, an old backup file (with the same name as the
1002new backup file) will be deleted. If 'backup' is not set, but 'writebackup'
1003is set, an existing backup file will not be deleted. The backup file that is
1004made while the file is being written will have a different name.
1005
1006On some filesystems it's possible that in a crash you lose both the backup and
1007the newly written file (it might be there but contain bogus data). In that
1008case try recovery, because the swap file is synced to disk and might still be
1009there. |:recover|
1010
1011The directories given with the 'backupdir' option is used to put the backup
1012file in. (default: same directory as the written file).
1013
1014Whether the backup is a new file, which is a copy of the original file, or the
1015original file renamed depends on the 'backupcopy' option. See there for an
1016explanation of when the copy is made and when the file is renamed.
1017
1018If the creation of a backup file fails, the write is not done. If you want
1019to write anyway add a '!' to the command.
1020
Bram Moolenaard58e9292011-02-09 17:07:58 +01001021 *write-permissions*
1022When writing a new file the permissions are read-write. For unix the mask is
10230666 with additionally umask applied. When writing a file that was read Vim
1024will preserve the permissions, but clear the s-bit.
1025
Bram Moolenaar071d4272004-06-13 20:20:40 +00001026 *write-readonly*
1027When the 'cpoptions' option contains 'W', Vim will refuse to overwrite a
1028readonly file. When 'W' is not present, ":w!" will overwrite a readonly file,
1029if the system allows it (the directory must be writable).
1030
1031 *write-fail*
1032If the writing of the new file fails, you have to be careful not to lose
1033your changes AND the original file. If there is no backup file and writing
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001034the new file failed, you have already lost the original file! DON'T EXIT VIM
1035UNTIL YOU WRITE OUT THE FILE! If a backup was made, it is put back in place
Bram Moolenaar071d4272004-06-13 20:20:40 +00001036of the original file (if possible). If you exit Vim, and lose the changes
1037you made, the original file will mostly still be there. If putting back the
1038original file fails, there will be an error message telling you that you
1039lost the original file.
1040
1041 *DOS-format-write*
1042If the 'fileformat' is "dos", <CR> <NL> is used for <EOL>. This is default
1043for MS-DOS, Win32 and OS/2. On other systems the message "[dos format]" is
1044shown to remind you that an unusual <EOL> was used.
1045 *Unix-format-write*
1046If the 'fileformat' is "unix", <NL> is used for <EOL>. On MS-DOS, Win32 and
1047OS/2 the message "[unix format]" is shown.
1048 *Mac-format-write*
1049If the 'fileformat' is "mac", <CR> is used for <EOL>. On non-Mac systems the
1050message "[mac format]" is shown.
1051
1052See also |file-formats| and the 'fileformat' and 'fileformats' options.
1053
1054 *ACL*
1055ACL stands for Access Control List. It is an advanced way to control access
1056rights for a file. It is used on new MS-Windows and Unix systems, but only
1057when the filesystem supports it.
1058 Vim attempts to preserve the ACL info when writing a file. The backup file
1059will get the ACL info of the original file.
1060 The ACL info is also used to check if a file is read-only (when opening the
1061file).
1062
1063 *read-only-share*
1064When MS-Windows shares a drive on the network it can be marked as read-only.
1065This means that even if the file read-only attribute is absent, and the ACL
1066settings on NT network shared drives allow writing to the file, you can still
1067not write to the file. Vim on Win32 platforms will detect read-only network
1068drives and will mark the file as read-only. You will not be able to override
1069it with |:write|.
1070
1071 *write-device*
1072When the file name is actually a device name, Vim will not make a backup (that
1073would be impossible). You need to use "!", since the device already exists.
1074Example for Unix: >
1075 :w! /dev/lpt0
1076and for MS-DOS or MS-Windows: >
1077 :w! lpt0
1078For Unix a device is detected when the name doesn't refer to a normal file or
1079a directory. A fifo or named pipe also looks like a device to Vim.
1080For MS-DOS and MS-Windows the device is detected by its name:
1081 AUX
1082 CON
1083 CLOCK$
1084 NUL
1085 PRN
1086 COMn n=1,2,3... etc
1087 LPTn n=1,2,3... etc
1088The names can be in upper- or lowercase.
1089
1090==============================================================================
Bram Moolenaar1cd871b2004-12-19 22:46:22 +000010915. Writing and quitting *write-quit*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001092
1093 *:q* *:quit*
1094:q[uit] Quit the current window. Quit Vim if this is the last
1095 window. This fails when changes have been made and
1096 Vim refuses to |abandon| the current buffer, and when
1097 the last file in the argument list has not been
1098 edited.
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00001099 If there are other tab pages and quitting the last
1100 window in the current tab page the current tab page is
1101 closed |tab-page|.
Bram Moolenaar30b65812012-07-12 22:01:11 +02001102 Triggers the |QuitPre| autocommand event.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001103
1104:conf[irm] q[uit] Quit, but give prompt when changes have been made, or
1105 the last file in the argument list has not been
1106 edited. See |:confirm| and 'confirm'. {not in Vi}
1107
Bram Moolenaarfa735342016-01-03 22:14:44 +01001108:q[uit]! Quit without writing, also when the current buffer has
Bram Moolenaar027387f2016-01-02 22:25:52 +01001109 changes. If this is the last window and there is a
1110 modified hidden buffer, the current buffer is
1111 abandoned and the first changed hidden buffer becomes
Bram Moolenaar2f3b5102014-11-19 18:54:17 +01001112 the current buffer.
1113 Use ":qall!" to exit always.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001114
1115:cq[uit] Quit always, without writing, and return an error
1116 code. See |:cq|. Used for Manx's QuickFix mode (see
1117 |quickfix|). {not in Vi}
1118
1119 *:wq*
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001120:wq [++opt] Write the current file and quit. Writing fails when
Bram Moolenaar071d4272004-06-13 20:20:40 +00001121 the file is read-only or the buffer does not have a
1122 name. Quitting fails when the last file in the
1123 argument list has not been edited.
1124
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001125:wq! [++opt] Write the current file and quit. Writing fails when
Bram Moolenaar071d4272004-06-13 20:20:40 +00001126 the current buffer does not have a name.
1127
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001128:wq [++opt] {file} Write to {file} and quit. Quitting fails when the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001129 last file in the argument list has not been edited.
1130
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001131:wq! [++opt] {file} Write to {file} and quit.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001132
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001133:[range]wq[!] [++opt] [file]
1134 Same as above, but only write the lines in [range].
Bram Moolenaar071d4272004-06-13 20:20:40 +00001135
1136 *:x* *:xit*
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001137:[range]x[it][!] [++opt] [file]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001138 Like ":wq", but write only when changes have been
1139 made.
1140 When 'hidden' is set and there are more windows, the
1141 current buffer becomes hidden, after writing the file.
1142
1143 *:exi* *:exit*
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001144:[range]exi[t][!] [++opt] [file]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001145 Same as :xit.
1146
1147 *ZZ*
1148ZZ Write current file, if modified, and quit (same as
1149 ":x"). (Note: If there are several windows for the
1150 current file, the file is written if it was modified
1151 and the window is closed).
1152
1153 *ZQ*
1154ZQ Quit without checking for changes (same as ":q!").
1155 {not in Vi}
1156
1157MULTIPLE WINDOWS AND BUFFERS *window-exit*
1158
1159 *:qa* *:qall*
1160:qa[ll] Exit Vim, unless there are some buffers which have been
1161 changed. (Use ":bmod" to go to the next modified buffer).
1162 When 'autowriteall' is set all changed buffers will be
1163 written, like |:wqall|. {not in Vi}
1164
1165:conf[irm] qa[ll]
1166 Exit Vim. Bring up a prompt when some buffers have been
1167 changed. See |:confirm|. {not in Vi}
1168
1169:qa[ll]! Exit Vim. Any changes to buffers are lost. {not in Vi}
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00001170 Also see |:cquit|, it does the same but exits with a non-zero
1171 value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001172
1173 *:quita* *:quitall*
1174:quita[ll][!] Same as ":qall". {not in Vi}
1175
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001176:wqa[ll] [++opt] *:wqa* *:wqall* *:xa* *:xall*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001177:xa[ll] Write all changed buffers and exit Vim. If there are buffers
1178 without a file name, which are readonly or which cannot be
1179 written for another reason, Vim will not quit. {not in Vi}
1180
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001181:conf[irm] wqa[ll] [++opt]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001182:conf[irm] xa[ll]
1183 Write all changed buffers and exit Vim. Bring up a prompt
1184 when some buffers are readonly or cannot be written for
1185 another reason. See |:confirm|. {not in Vi}
1186
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001187:wqa[ll]! [++opt]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001188:xa[ll]! Write all changed buffers, even the ones that are readonly,
1189 and exit Vim. If there are buffers without a file name or
1190 which cannot be written for another reason, Vim will not quit.
1191 {not in Vi}
1192
1193==============================================================================
Bram Moolenaar1cd871b2004-12-19 22:46:22 +000011946. Dialogs *edit-dialogs*
1195
1196 *:confirm* *:conf*
1197:conf[irm] {command} Execute {command}, and use a dialog when an
1198 operation has to be confirmed. Can be used on the
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02001199 |:q|, |:qa| and |:w| commands (the latter to override
1200 a read-only setting), and any other command that can
1201 fail in such a way, such as |:only|, |:buffer|,
1202 |:bdelete|, etc.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001203
1204Examples: >
1205 :confirm w foo
1206< Will ask for confirmation when "foo" already exists. >
1207 :confirm q
1208< Will ask for confirmation when there are changes. >
1209 :confirm qa
1210< If any modified, unsaved buffers exist, you will be prompted to save
1211 or abandon each one. There are also choices to "save all" or "abandon
1212 all".
1213
1214If you want to always use ":confirm", set the 'confirm' option.
1215
1216 *:browse* *:bro* *E338* *E614* *E615* *E616* *E578*
1217:bro[wse] {command} Open a file selection dialog for an argument to
1218 {command}. At present this works for |:e|, |:w|,
Bram Moolenaar9028b102010-07-11 16:58:51 +02001219 |:wall|, |:wq|, |:wqall|, |:x|, |:xall|, |:exit|,
1220 |:view|, |:sview|, |:r|, |:saveas|, |:sp|, |:mkexrc|,
1221 |:mkvimrc|, |:mksession|, |:mkview|, |:split|,
1222 |:vsplit|, |:tabe|, |:tabnew|, |:cfile|, |:cgetfile|,
1223 |:caddfile|, |:lfile|, |:lgetfile|, |:laddfile|,
1224 |:diffsplit|, |:diffpatch|, |:open|, |:pedit|,
1225 |:redir|, |:source|, |:update|, |:visual|, |:vsplit|,
1226 and |:qall| if 'confirm' is set.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001227 {only in Win32, Athena, Motif, GTK and Mac GUI}
1228 When ":browse" is not possible you get an error
1229 message. If the |+browse| feature is missing or the
1230 {command} doesn't support browsing, the {command} is
1231 executed without a dialog.
1232 ":browse set" works like |:options|.
Bram Moolenaar9028b102010-07-11 16:58:51 +02001233 See also |:oldfiles| for ":browse oldfiles".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001234
1235The syntax is best shown via some examples: >
1236 :browse e $vim/foo
1237< Open the browser in the $vim/foo directory, and edit the
1238 file chosen. >
1239 :browse e
1240< Open the browser in the directory specified with 'browsedir',
1241 and edit the file chosen. >
1242 :browse w
1243< Open the browser in the directory of the current buffer,
1244 with the current buffer filename as default, and save the
1245 buffer under the filename chosen. >
1246 :browse w C:/bar
1247< Open the browser in the C:/bar directory, with the current
1248 buffer filename as default, and save the buffer under the
1249 filename chosen.
1250Also see the |'browsedir'| option.
1251For versions of Vim where browsing is not supported, the command is executed
1252unmodified.
1253
1254 *browsefilter*
Bram Moolenaar30b65812012-07-12 22:01:11 +02001255For MS Windows and GTK, you can modify the filters that are used in the browse
1256dialog. By setting the g:browsefilter or b:browsefilter variables, you can
1257change the filters globally or locally to the buffer. The variable is set to
1258a string in the format "{filter label}\t{pattern};{pattern}\n" where {filter
1259label} is the text that appears in the "Files of Type" comboBox, and {pattern}
1260is the pattern which filters the filenames. Several patterns can be given,
1261separated by ';'.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001262
1263For Motif the same format is used, but only the very first pattern is actually
1264used (Motif only offers one pattern, but you can edit it).
1265
1266For example, to have only Vim files in the dialog, you could use the following
1267command: >
1268
Bram Moolenaar30b65812012-07-12 22:01:11 +02001269 let g:browsefilter = "Vim Scripts\t*.vim\nVim Startup Files\t*vimrc\n"
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001270
1271You can override the filter setting on a per-buffer basis by setting the
1272b:browsefilter variable. You would most likely set b:browsefilter in a
1273filetype plugin, so that the browse dialog would contain entries related to
1274the type of file you are currently editing. Disadvantage: This makes it
1275difficult to start editing a file of a different type. To overcome this, you
1276may want to add "All Files\t*.*\n" as the final filter, so that the user can
1277still access any desired file.
1278
Bram Moolenaar30b65812012-07-12 22:01:11 +02001279To avoid setting browsefilter when Vim does not actually support it, you can
1280use has("browsefilter"): >
1281
1282 if has("browsefilter")
1283 let g:browsefilter = "whatever"
1284 endif
1285
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001286==============================================================================
12877. The current directory *current-directory*
1288
1289You may use the |:cd| and |:lcd| commands to change to another directory, so
1290you will not have to type that directory name in front of the file names. It
1291also makes a difference for executing external commands, e.g. ":!ls".
1292
Bram Moolenaardf177f62005-02-22 08:39:57 +00001293Changing directory fails when the current buffer is modified, the '.' flag is
1294present in 'cpoptions' and "!" is not used in the command.
1295
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00001296 *:cd* *E747* *E472*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001297:cd[!] On non-Unix systems: Print the current directory
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001298 name. On Unix systems: Change the current directory
1299 to the home directory. Use |:pwd| to print the
1300 current directory on all systems.
1301
Bram Moolenaardf177f62005-02-22 08:39:57 +00001302:cd[!] {path} Change the current directory to {path}.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001303 If {path} is relative, it is searched for in the
1304 directories listed in |'cdpath'|.
1305 Does not change the meaning of an already opened file,
1306 because its full path name is remembered. Files from
1307 the |arglist| may change though!
1308 On MS-DOS this also changes the active drive.
1309 To change to the directory of the current file: >
1310 :cd %:h
1311<
1312 *:cd-* *E186*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001313:cd[!] - Change to the previous current directory (before the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001314 previous ":cd {path}" command). {not in Vi}
1315
1316 *:chd* *:chdir*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001317:chd[ir][!] [path] Same as |:cd|.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001318
1319 *:lc* *:lcd*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001320:lc[d][!] {path} Like |:cd|, but only set the current directory for the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001321 current window. The current directory for other
1322 windows is not changed. {not in Vi}
1323
1324 *:lch* *:lchdir*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001325:lch[dir][!] Same as |:lcd|. {not in Vi}
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001326
1327 *:pw* *:pwd* *E187*
1328:pw[d] Print the current directory name. {Vi: no pwd}
1329 Also see |getcwd()|.
1330
1331So long as no |:lcd| command has been used, all windows share the same current
1332directory. Using a command to jump to another window doesn't change anything
1333for the current directory.
1334When a |:lcd| command has been used for a window, the specified directory
1335becomes the current directory for that window. Windows where the |:lcd|
1336command has not been used stick to the global current directory. When jumping
1337to another window the current directory will become the last specified local
1338current directory. If none was specified, the global current directory is
1339used.
1340When a |:cd| command is used, the current window will lose his local current
1341directory and will use the global current directory from now on.
1342
1343After using |:cd| the full path name will be used for reading and writing
1344files. On some networked file systems this may cause problems. The result of
1345using the full path name is that the file names currently in use will remain
1346referring to the same file. Example: If you have a file a:test and a
1347directory a:vim the commands ":e test" ":cd vim" ":w" will overwrite the file
1348a:test and not write a:vim/test. But if you do ":w test" the file a:vim/test
1349will be written, because you gave a new file name and did not refer to a
1350filename before the ":cd".
1351
1352==============================================================================
Bram Moolenaar071d4272004-06-13 20:20:40 +000013538. Editing binary files *edit-binary*
1354
1355Although Vim was made to edit text files, it is possible to edit binary
1356files. The |-b| Vim argument (b for binary) makes Vim do file I/O in binary
1357mode, and sets some options for editing binary files ('binary' on, 'textwidth'
1358to 0, 'modeline' off, 'expandtab' off). Setting the 'binary' option has the
1359same effect. Don't forget to do this before reading the file.
1360
1361There are a few things to remember when editing binary files:
1362- When editing executable files the number of characters must not change.
1363 Use only the "R" or "r" command to change text. Do not delete characters
1364 with "x" or by backspacing.
1365- Set the 'textwidth' option to 0. Otherwise lines will unexpectedly be
1366 split in two.
1367- When there are not many <EOL>s, the lines will become very long. If you
1368 want to edit a line that does not fit on the screen reset the 'wrap' option.
1369 Horizontal scrolling is used then. If a line becomes too long (more than
1370 about 32767 characters on the Amiga, much more on 32-bit systems, see
1371 |limits|) you cannot edit that line. The line will be split when reading
1372 the file. It is also possible that you get an "out of memory" error when
1373 reading the file.
1374- Make sure the 'binary' option is set BEFORE loading the
1375 file. Otherwise both <CR> <NL> and <NL> are considered to end a line
1376 and when the file is written the <NL> will be replaced with <CR> <NL>.
1377- <Nul> characters are shown on the screen as ^@. You can enter them with
1378 "CTRL-V CTRL-@" or "CTRL-V 000" {Vi cannot handle <Nul> characters in the
1379 file}
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +02001380- To insert a <NL> character in the file split a line. When writing the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001381 buffer to a file a <NL> will be written for the <EOL>.
1382- Vim normally appends an <EOL> at the end of the file if there is none.
1383 Setting the 'binary' option prevents this. If you want to add the final
1384 <EOL>, set the 'endofline' option. You can also read the value of this
1385 option to see if there was an <EOL> for the last line (you cannot see this
1386 in the text).
1387
1388==============================================================================
13899. Encryption *encryption*
1390
1391Vim is able to write files encrypted, and read them back. The encrypted text
1392cannot be read without the right key.
Bram Moolenaar996343d2010-07-04 22:20:21 +02001393{only available when compiled with the |+cryptv| feature} *E833*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001394
Bram Moolenaar81af9252010-12-10 20:35:50 +01001395The text in the swap file and the undo file is also encrypted. *E843*
Bram Moolenaar07d87792014-07-19 14:04:47 +02001396However, this is done block-by-block and may reduce the time needed to crack a
1397password. You can disable the swap file, but then a crash will cause you to
1398lose your work. The undo file can be disabled without much disadvantage. >
1399 :set noundofile
1400 :noswapfile edit secrets
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001401
1402Note: The text in memory is not encrypted. A system administrator may be able
1403to see your text while you are editing it. When filtering text with
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001404":!filter" or using ":w !command" the text is also not encrypted, this may
1405reveal it to others. The 'viminfo' file is not encrypted.
1406
1407You could do this to edit very secret text: >
1408 :set noundofile viminfo=
1409 :noswapfile edit secrets.txt
Bram Moolenaar88774fd2015-08-25 19:52:04 +02001410Keep in mind that without a swap file you risk losing your work in the event
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +02001411of a crash or a power failure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001412
1413WARNING: If you make a typo when entering the key and then write the file and
1414exit, the text will be lost!
1415
1416The normal way to work with encryption, is to use the ":X" command, which will
1417ask you to enter a key. A following write command will use that key to
1418encrypt the file. If you later edit the same file, Vim will ask you to enter
1419a key. If you type the same key as that was used for writing, the text will
1420be readable again. If you use a wrong key, it will be a mess.
1421
1422 *:X*
1423:X Prompt for an encryption key. The typing is done without showing the
1424 actual text, so that someone looking at the display won't see it.
1425 The typed key is stored in the 'key' option, which is used to encrypt
1426 the file when it is written. The file will remain unchanged until you
1427 write it. See also |-x|.
1428
1429The value of the 'key' options is used when text is written. When the option
1430is not empty, the written file will be encrypted, using the value as the
1431encryption key. A magic number is prepended, so that Vim can recognize that
1432the file is encrypted.
1433
1434To disable the encryption, reset the 'key' option to an empty value: >
1435 :set key=
1436
Bram Moolenaar49771f42010-07-20 17:32:38 +02001437You can use the 'cryptmethod' option to select the type of encryption, use one
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001438of these: >
1439 :setlocal cm=zip " weak method, backwards compatible
1440 :setlocal cm=blowfish " method with flaws
1441 :setlocal cm=blowfish2 " medium strong method
1442
Bram Moolenaar49771f42010-07-20 17:32:38 +02001443Do this before writing the file. When reading an encrypted file it will be
1444set automatically to the method used when that file was written. You can
1445change 'cryptmethod' before writing that file to change the method.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001446
Bram Moolenaarc2299672014-11-13 14:25:38 +01001447To set the default method, used for new files, use this in your |vimrc|
1448file: >
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001449 set cm=blowfish2
Bram Moolenaarc2299672014-11-13 14:25:38 +01001450Using "blowfish2" is highly recommended. Only use another method if you
1451must use an older Vim version that does not support it.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001452
Bram Moolenaar662db672011-03-22 14:05:35 +01001453The message given for reading and writing a file will show "[crypted]" when
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001454using zip, "[blowfish]" when using blowfish, etc.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02001455
Bram Moolenaara3ff49f2010-05-30 22:48:02 +02001456When writing an undo file, the same key and method will be used for the text
1457in the undo file. |persistent-undo|.
1458
Bram Moolenaarfa7584c2010-05-19 21:57:45 +02001459 *E817* *E818* *E819* *E820*
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02001460When encryption does not work properly, you would be able to write your text
1461to a file and never be able to read it back. Therefore a test is performed to
1462check if the encryption works as expected. If you get one of these errors
1463don't write the file encrypted! You need to rebuild the Vim binary to fix
1464this.
1465
Bram Moolenaar46f9d492010-06-12 20:18:19 +02001466*E831* This is an internal error, "cannot happen". If you can reproduce it,
Bram Moolenaar56be9502010-06-06 14:20:26 +02001467please report to the developers.
1468
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02001469When reading a file that has been encrypted and the 'key' option is not empty,
1470it will be used for decryption. If the value is empty, you will be prompted
1471to enter the key. If you don't enter a key, or you enter the wrong key, the
1472file is edited without being decrypted. There is no warning about using the
1473wrong key (this makes brute force methods to find the key more difficult).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001474
1475If want to start reading a file that uses a different key, set the 'key'
1476option to an empty string, so that Vim will prompt for a new one. Don't use
1477the ":set" command to enter the value, other people can read the command over
1478your shoulder.
1479
1480Since the value of the 'key' option is supposed to be a secret, its value can
1481never be viewed. You should not set this option in a vimrc file.
1482
Bram Moolenaar60aad972010-07-21 20:36:22 +02001483An encrypted file can be recognized by the "file" command, if you add these
1484lines to "/etc/magic", "/usr/share/misc/magic" or wherever your system has the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001485"magic" file: >
1486 0 string VimCrypt~ Vim encrypted file
Bram Moolenaarc095b282010-07-20 22:33:34 +02001487 >9 string 01 - "zip" cryptmethod
1488 >9 string 02 - "blowfish" cryptmethod
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001489 >9 string 03 - "blowfish2" cryptmethod
Bram Moolenaar071d4272004-06-13 20:20:40 +00001490
1491Notes:
1492- Encryption is not possible when doing conversion with 'charconvert'.
1493- Text you copy or delete goes to the numbered registers. The registers can
1494 be saved in the .viminfo file, where they could be read. Change your
1495 'viminfo' option to be safe.
1496- Someone can type commands in Vim when you walk away for a moment, he should
1497 not be able to get the key.
1498- If you make a typing mistake when entering the key, you might not be able to
1499 get your text back!
1500- If you type the key with a ":set key=value" command, it can be kept in the
1501 history, showing the 'key' value in a viminfo file.
1502- There is never 100% safety. The encryption in Vim has not been tested for
1503 robustness.
Bram Moolenaar24ea3ba2010-09-19 19:01:21 +02001504- The algorithm used for 'cryptmethod' "zip" is breakable. A 4 character key
1505 in about one hour, a 6 character key in one day (on a Pentium 133 PC). This
1506 requires that you know some text that must appear in the file. An expert
1507 can break it for any key. When the text has been decrypted, this also means
1508 that the key can be revealed, and other files encrypted with the same key
1509 can be decrypted.
1510- Pkzip uses the same encryption as 'cryptmethod' "zip", and US Govt has no
1511 objection to its export. Pkzip's public file APPNOTE.TXT describes this
1512 algorithm in detail.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02001513- The implementation of 'cryptmethod' "blowfish" has a flaw. It is possible
1514 to crack the first 64 bytes of a file and in some circumstances more of the
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001515 file. Use of it is not recommended, but it's still the strongest method
1516 supported by Vim 7.3 and 7.4. The "zip" method is even weaker.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001517- Vim originates from the Netherlands. That is where the sources come from.
1518 Thus the encryption code is not exported from the USA.
1519
1520==============================================================================
152110. Timestamps *timestamp* *timestamps*
1522
Bram Moolenaare968e362014-05-13 20:23:24 +02001523Vim remembers the modification timestamp, mode and size of a file when you
1524begin editing it. This is used to avoid that you have two different versions
1525of the same file (without you knowing this).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001526
Bram Moolenaare968e362014-05-13 20:23:24 +02001527After a shell command is run (|:!cmd| |suspend| |:read!| |K|) timestamps,
1528file modes and file sizes are compared for all buffers in a window. Vim will
1529run any associated |FileChangedShell| autocommands or display a warning for
1530any files that have changed. In the GUI this happens when Vim regains input
1531focus.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001532
1533 *E321* *E462*
1534If you want to automatically reload a file when it has been changed outside of
1535Vim, set the 'autoread' option. This doesn't work at the moment you write the
1536file though, only when the file wasn't changed inside of Vim.
1537
1538Note that if a FileChangedShell autocommand is defined you will not get a
1539warning message or prompt. The autocommand is expected to handle this.
1540
Bram Moolenaar10de2da2005-01-27 14:33:00 +00001541There is no warning for a directory (e.g., with |netrw-browse|). But you do
1542get warned if you started editing a new file and it was created as a directory
1543later.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001544
1545When Vim notices the timestamp of a file has changed, and the file is being
1546edited in a buffer but has not changed, Vim checks if the contents of the file
1547is equal. This is done by reading the file again (into a hidden buffer, which
1548is immediately deleted again) and comparing the text. If the text is equal,
1549you will get no warning.
1550
1551If you don't get warned often enough you can use the following command.
1552
1553 *:checkt* *:checktime*
1554:checkt[ime] Check if any buffers were changed outside of Vim.
1555 This checks and warns you if you would end up with two
1556 versions of a file.
1557 If this is called from an autocommand, a ":global"
1558 command or is not typed the actual check is postponed
1559 until a moment the side effects (reloading the file)
1560 would be harmless.
1561 Each loaded buffer is checked for its associated file
1562 being changed. If the file was changed Vim will take
1563 action. If there are no changes in the buffer and
1564 'autoread' is set, the buffer is reloaded. Otherwise,
1565 you are offered the choice of reloading the file. If
1566 the file was deleted you get an error message.
1567 If the file previously didn't exist you get a warning
1568 if it exists now.
1569 Once a file has been checked the timestamp is reset,
1570 you will not be warned again.
1571
1572:[N]checkt[ime] {filename}
1573:[N]checkt[ime] [N]
1574 Check the timestamp of a specific buffer. The buffer
1575 may be specified by name, number or with a pattern.
1576
1577
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001578 *E813* *E814*
1579Vim will reload the buffer if you chose to. If a window is visible that
1580contains this buffer, the reloading will happen in the context of this window.
1581Otherwise a special window is used, so that most autocommands will work. You
1582can't close this window. A few other restrictions apply. Best is to make
1583sure nothing happens outside of the current buffer. E.g., setting
1584window-local options may end up in the wrong window. Splitting the window,
1585doing something there and closing it should be OK (if there are no side
1586effects from other autocommands). Closing unrelated windows and buffers will
1587get you into trouble.
1588
Bram Moolenaar071d4272004-06-13 20:20:40 +00001589Before writing a file the timestamp is checked. If it has changed, Vim will
1590ask if you really want to overwrite the file:
1591
1592 WARNING: The file has been changed since reading it!!!
1593 Do you really want to write to it (y/n)?
1594
1595If you hit 'y' Vim will continue writing the file. If you hit 'n' the write is
1596aborted. If you used ":wq" or "ZZ" Vim will not exit, you will get another
1597chance to write the file.
1598
1599The message would normally mean that somebody has written to the file after
1600the edit session started. This could be another person, in which case you
1601probably want to check if your changes to the file and the changes from the
1602other person should be merged. Write the file under another name and check for
1603differences (the "diff" program can be used for this).
1604
1605It is also possible that you modified the file yourself, from another edit
1606session or with another command (e.g., a filter command). Then you will know
1607which version of the file you want to keep.
1608
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001609There is one situation where you get the message while there is nothing wrong:
1610On a Win32 system on the day daylight saving time starts. There is something
1611in the Win32 libraries that confuses Vim about the hour time difference. The
1612problem goes away the next day.
1613
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001614==============================================================================
161511. File Searching *file-searching*
1616
1617{not available when compiled without the |+path_extra| feature}
1618
1619The file searching is currently used for the 'path', 'cdpath' and 'tags'
Bram Moolenaarc236c162008-07-13 17:41:49 +00001620options, for |finddir()| and |findfile()|. Other commands use |wildcards|
1621which is slightly different.
Bram Moolenaar9964e462007-05-05 17:54:07 +00001622
1623There are three different types of searching:
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001624
Bram Moolenaar02743632005-07-25 20:42:36 +000016251) Downward search: *starstar*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001626 Downward search uses the wildcards '*', '**' and possibly others
Bram Moolenaarc236c162008-07-13 17:41:49 +00001627 supported by your operating system. '*' and '**' are handled inside Vim,
1628 so they work on all operating systems. Note that "**" only acts as a
1629 special wildcard when it is at the start of a name.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001630
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00001631 The usage of '*' is quite simple: It matches 0 or more characters. In a
1632 search pattern this would be ".*". Note that the "." is not used for file
1633 searching.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001634
1635 '**' is more sophisticated:
1636 - It ONLY matches directories.
Bram Moolenaarc236c162008-07-13 17:41:49 +00001637 - It matches up to 30 directories deep by default, so you can use it to
1638 search an entire directory tree
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001639 - The maximum number of levels matched can be given by appending a number
1640 to '**'.
1641 Thus '/usr/**2' can match: >
1642 /usr
1643 /usr/include
1644 /usr/include/sys
1645 /usr/include/g++
1646 /usr/lib
1647 /usr/lib/X11
1648 ....
1649< It does NOT match '/usr/include/g++/std' as this would be three
1650 levels.
Bram Moolenaarc236c162008-07-13 17:41:49 +00001651 The allowed number range is 0 ('**0' is removed) to 100
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001652 If the given number is smaller than 0 it defaults to 30, if it's
Bram Moolenaarc236c162008-07-13 17:41:49 +00001653 bigger than 100 then 100 is used. The system also has a limit on the
1654 path length, usually 256 or 1024 bytes.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001655 - '**' can only be at the end of the path or be followed by a path
1656 separator or by a number and a path separator.
1657
1658 You can combine '*' and '**' in any order: >
1659 /usr/**/sys/*
Bram Moolenaarc236c162008-07-13 17:41:49 +00001660 /usr/*tory/sys/**
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001661 /usr/**2/sys/*
1662
16632) Upward search:
1664 Here you can give a directory and then search the directory tree upward for
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001665 a file. You could give stop-directories to limit the upward search. The
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001666 stop-directories are appended to the path (for the 'path' option) or to
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001667 the filename (for the 'tags' option) with a ';'. If you want several
1668 stop-directories separate them with ';'. If you want no stop-directory
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001669 ("search upward till the root directory) just use ';'. >
1670 /usr/include/sys;/usr
1671< will search in: >
1672 /usr/include/sys
1673 /usr/include
1674 /usr
1675<
1676 If you use a relative path the upward search is started in Vim's current
1677 directory or in the directory of the current file (if the relative path
1678 starts with './' and 'd' is not included in 'cpoptions').
1679
1680 If Vim's current path is /u/user_x/work/release and you do >
1681 :set path=include;/u/user_x
1682< and then search for a file with |gf| the file is searched in: >
1683 /u/user_x/work/release/include
1684 /u/user_x/work/include
1685 /u/user_x/include
1686
Bram Moolenaar402d2fe2005-04-15 21:00:38 +000016873) Combined up/downward search:
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001688 If Vim's current path is /u/user_x/work/release and you do >
1689 set path=**;/u/user_x
1690< and then search for a file with |gf| the file is searched in: >
1691 /u/user_x/work/release/**
1692 /u/user_x/work/**
1693 /u/user_x/**
1694<
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001695 BE CAREFUL! This might consume a lot of time, as the search of
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001696 '/u/user_x/**' includes '/u/user_x/work/**' and
1697 '/u/user_x/work/release/**'. So '/u/user_x/work/release/**' is searched
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001698 three times and '/u/user_x/work/**' is searched twice.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001699
1700 In the above example you might want to set path to: >
1701 :set path=**,/u/user_x/**
Bram Moolenaar162bd912010-07-28 22:29:10 +02001702< This searches:
1703 /u/user_x/work/release/** ~
1704 /u/user_x/** ~
1705 This searches the same directories, but in a different order.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001706
Bram Moolenaar162bd912010-07-28 22:29:10 +02001707 Note that completion for ":find", ":sfind", and ":tabfind" commands do not
1708 currently work with 'path' items that contain a url or use the double star
Bram Moolenaar5b435d62012-04-05 17:33:26 +02001709 with depth limiter (/usr/**2) or upward search (;) notations.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001710
1711 vim:tw=78:ts=8:ft=help:norl: