blob: 49a96f6a663a2400c31d88f2aaa5bc71b38017a3 [file] [log] [blame]
Bram Moolenaar88774fd2015-08-25 19:52:04 +02001*editing.txt* For Vim version 7.4. Last change: 2015 Aug 25
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 Moolenaar32466aa2006-02-24 23:53:04 +0000871 Also see |:windo|, |:tabdo| and |:bufdo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000872
873Example: >
874 :args *.c
875 :argdo set ff=unix | update
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100876This sets the 'fileformat' option to "unix" and writes the file if it is now
Bram Moolenaar071d4272004-06-13 20:20:40 +0000877changed. This is done for all *.c files.
878
879Example: >
880 :args *.[ch]
881 :argdo %s/\<my_foo\>/My_Foo/ge | update
882This changes the word "my_foo" to "My_Foo" in all *.c and *.h files. The "e"
883flag is used for the ":substitute" command to avoid an error for files where
884"my_foo" isn't used. ":update" writes the file only if changes were made.
885
886==============================================================================
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00008874. Writing *writing* *save-file*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000888
889Note: When the 'write' option is off, you are not able to write any file.
890
891 *:w* *:write*
892 *E502* *E503* *E504* *E505*
Bram Moolenaar9964e462007-05-05 17:54:07 +0000893 *E512* *E514* *E667* *E796*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000894:w[rite] [++opt] Write the whole buffer to the current file. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000895 the normal way to save changes to a file. It fails
896 when the 'readonly' option is set or when there is
897 another reason why the file can't be written.
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000898 For ++opt see |++opt|, but only ++bin, ++nobin, ++ff
899 and ++enc are effective.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000900
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000901:w[rite]! [++opt] Like ":write", but forcefully write when 'readonly' is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000902 set or there is another reason why writing was
903 refused.
904 Note: This may change the permission and ownership of
905 the file and break (symbolic) links. Add the 'W' flag
906 to 'cpoptions' to avoid this.
907
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000908:[range]w[rite][!] [++opt]
909 Write the specified lines to the current file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000910 is unusual, because the file will not contain all
911 lines in the buffer.
912
913 *:w_f* *:write_f*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000914:[range]w[rite] [++opt] {file}
915 Write the specified lines to {file}, unless it
Bram Moolenaar071d4272004-06-13 20:20:40 +0000916 already exists and the 'writeany' option is off.
917
918 *:w!*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000919:[range]w[rite]! [++opt] {file}
920 Write the specified lines to {file}. Overwrite an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000921 existing file.
922
923 *:w_a* *:write_a* *E494*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000924:[range]w[rite][!] [++opt] >>
925 Append the specified lines to the current file.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000926
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000927:[range]w[rite][!] [++opt] >> {file}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000928 Append the specified lines to {file}. '!' forces the
929 write even if file does not exist.
930
931 *:w_c* *:write_c*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000932:[range]w[rite] [++opt] !{cmd}
933 Execute {cmd} with [range] lines as standard input
Bram Moolenaar071d4272004-06-13 20:20:40 +0000934 (note the space in front of the '!'). {cmd} is
935 executed like with ":!{cmd}", any '!' is replaced with
936 the previous command |:!|.
937
Bram Moolenaar5c4e21c2004-10-12 19:54:52 +0000938The default [range] for the ":w" command is the whole buffer (1,$). If you
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000939write the whole buffer, it is no longer considered changed. When you
940write it to a different file with ":w somefile" it depends on the "+" flag in
941'cpoptions'. When included, the write command will reset the 'modified' flag,
942even though the buffer itself may still be different from its file.
Bram Moolenaar5c4e21c2004-10-12 19:54:52 +0000943
Bram Moolenaar071d4272004-06-13 20:20:40 +0000944If a file name is given with ":w" it becomes the alternate file. This can be
945used, for example, when the write fails and you want to try again later with
946":w #". This can be switched off by removing the 'A' flag from the
947'cpoptions' option.
948
949 *:sav* *:saveas*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000950:sav[eas][!] [++opt] {file}
951 Save the current buffer under the name {file} and set
Bram Moolenaar071d4272004-06-13 20:20:40 +0000952 the filename of the current buffer to {file}. The
953 previous name is used for the alternate file name.
954 The [!] is needed to overwrite an existing file.
Bram Moolenaar2d3f4892006-01-20 23:02:51 +0000955 When 'filetype' is empty filetype detection is done
956 with the new name, before the file is written.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000957 When the write was successful 'readonly' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000958 {not in Vi}
959
960 *:up* *:update*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000961:[range]up[date][!] [++opt] [>>] [file]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000962 Like ":write", but only write when the buffer has been
963 modified. {not in Vi}
964
965
966WRITING WITH MULTIPLE BUFFERS *buffer-write*
967
968 *:wa* *:wall*
969:wa[ll] Write all changed buffers. Buffers without a file
970 name or which are readonly are not written. {not in
971 Vi}
972
973:wa[ll]! Write all changed buffers, even the ones that are
974 readonly. Buffers without a file name are not
975 written. {not in Vi}
976
977
978Vim will warn you if you try to overwrite a file that has been changed
979elsewhere. See |timestamp|.
980
981 *backup* *E207* *E506* *E507* *E508* *E509* *E510*
982If you write to an existing file (but do not append) while the 'backup',
983'writebackup' or 'patchmode' option is on, a backup of the original file is
984made. The file is either copied or renamed (see 'backupcopy'). After the
985file has been successfully written and when the 'writebackup' option is on and
986the 'backup' option is off, the backup file is deleted. When the 'patchmode'
987option is on the backup file may be renamed.
988
989 *backup-table*
990'backup' 'writebackup' action ~
991 off off no backup made
992 off on backup current file, deleted afterwards (default)
993 on off delete old backup, backup current file
994 on on delete old backup, backup current file
995
996When the 'backupskip' pattern matches with the name of the file which is
997written, no backup file is made. The values of 'backup' and 'writebackup' are
998ignored then.
999
1000When the 'backup' option is on, an old backup file (with the same name as the
1001new backup file) will be deleted. If 'backup' is not set, but 'writebackup'
1002is set, an existing backup file will not be deleted. The backup file that is
1003made while the file is being written will have a different name.
1004
1005On some filesystems it's possible that in a crash you lose both the backup and
1006the newly written file (it might be there but contain bogus data). In that
1007case try recovery, because the swap file is synced to disk and might still be
1008there. |:recover|
1009
1010The directories given with the 'backupdir' option is used to put the backup
1011file in. (default: same directory as the written file).
1012
1013Whether the backup is a new file, which is a copy of the original file, or the
1014original file renamed depends on the 'backupcopy' option. See there for an
1015explanation of when the copy is made and when the file is renamed.
1016
1017If the creation of a backup file fails, the write is not done. If you want
1018to write anyway add a '!' to the command.
1019
Bram Moolenaard58e9292011-02-09 17:07:58 +01001020 *write-permissions*
1021When writing a new file the permissions are read-write. For unix the mask is
10220666 with additionally umask applied. When writing a file that was read Vim
1023will preserve the permissions, but clear the s-bit.
1024
Bram Moolenaar071d4272004-06-13 20:20:40 +00001025 *write-readonly*
1026When the 'cpoptions' option contains 'W', Vim will refuse to overwrite a
1027readonly file. When 'W' is not present, ":w!" will overwrite a readonly file,
1028if the system allows it (the directory must be writable).
1029
1030 *write-fail*
1031If the writing of the new file fails, you have to be careful not to lose
1032your changes AND the original file. If there is no backup file and writing
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001033the new file failed, you have already lost the original file! DON'T EXIT VIM
1034UNTIL YOU WRITE OUT THE FILE! If a backup was made, it is put back in place
Bram Moolenaar071d4272004-06-13 20:20:40 +00001035of the original file (if possible). If you exit Vim, and lose the changes
1036you made, the original file will mostly still be there. If putting back the
1037original file fails, there will be an error message telling you that you
1038lost the original file.
1039
1040 *DOS-format-write*
1041If the 'fileformat' is "dos", <CR> <NL> is used for <EOL>. This is default
1042for MS-DOS, Win32 and OS/2. On other systems the message "[dos format]" is
1043shown to remind you that an unusual <EOL> was used.
1044 *Unix-format-write*
1045If the 'fileformat' is "unix", <NL> is used for <EOL>. On MS-DOS, Win32 and
1046OS/2 the message "[unix format]" is shown.
1047 *Mac-format-write*
1048If the 'fileformat' is "mac", <CR> is used for <EOL>. On non-Mac systems the
1049message "[mac format]" is shown.
1050
1051See also |file-formats| and the 'fileformat' and 'fileformats' options.
1052
1053 *ACL*
1054ACL stands for Access Control List. It is an advanced way to control access
1055rights for a file. It is used on new MS-Windows and Unix systems, but only
1056when the filesystem supports it.
1057 Vim attempts to preserve the ACL info when writing a file. The backup file
1058will get the ACL info of the original file.
1059 The ACL info is also used to check if a file is read-only (when opening the
1060file).
1061
1062 *read-only-share*
1063When MS-Windows shares a drive on the network it can be marked as read-only.
1064This means that even if the file read-only attribute is absent, and the ACL
1065settings on NT network shared drives allow writing to the file, you can still
1066not write to the file. Vim on Win32 platforms will detect read-only network
1067drives and will mark the file as read-only. You will not be able to override
1068it with |:write|.
1069
1070 *write-device*
1071When the file name is actually a device name, Vim will not make a backup (that
1072would be impossible). You need to use "!", since the device already exists.
1073Example for Unix: >
1074 :w! /dev/lpt0
1075and for MS-DOS or MS-Windows: >
1076 :w! lpt0
1077For Unix a device is detected when the name doesn't refer to a normal file or
1078a directory. A fifo or named pipe also looks like a device to Vim.
1079For MS-DOS and MS-Windows the device is detected by its name:
1080 AUX
1081 CON
1082 CLOCK$
1083 NUL
1084 PRN
1085 COMn n=1,2,3... etc
1086 LPTn n=1,2,3... etc
1087The names can be in upper- or lowercase.
1088
1089==============================================================================
Bram Moolenaar1cd871b2004-12-19 22:46:22 +000010905. Writing and quitting *write-quit*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001091
1092 *:q* *:quit*
1093:q[uit] Quit the current window. Quit Vim if this is the last
1094 window. This fails when changes have been made and
1095 Vim refuses to |abandon| the current buffer, and when
1096 the last file in the argument list has not been
1097 edited.
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00001098 If there are other tab pages and quitting the last
1099 window in the current tab page the current tab page is
1100 closed |tab-page|.
Bram Moolenaar30b65812012-07-12 22:01:11 +02001101 Triggers the |QuitPre| autocommand event.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001102
1103:conf[irm] q[uit] Quit, but give prompt when changes have been made, or
1104 the last file in the argument list has not been
1105 edited. See |:confirm| and 'confirm'. {not in Vi}
1106
Bram Moolenaar2f3b5102014-11-19 18:54:17 +01001107:q[uit]! Quit without writing, also when currently visible
1108 buffers have changes. Does not exit when this is the
Bram Moolenaared32d942014-12-06 23:33:00 +01001109 last window and there is a changed hidden buffer.
Bram Moolenaar2f3b5102014-11-19 18:54:17 +01001110 In this case, the first changed hidden buffer becomes
1111 the current buffer.
1112 Use ":qall!" to exit always.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001113
1114:cq[uit] Quit always, without writing, and return an error
1115 code. See |:cq|. Used for Manx's QuickFix mode (see
1116 |quickfix|). {not in Vi}
1117
1118 *:wq*
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001119:wq [++opt] Write the current file and quit. Writing fails when
Bram Moolenaar071d4272004-06-13 20:20:40 +00001120 the file is read-only or the buffer does not have a
1121 name. Quitting fails when the last file in the
1122 argument list has not been edited.
1123
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001124:wq! [++opt] Write the current file and quit. Writing fails when
Bram Moolenaar071d4272004-06-13 20:20:40 +00001125 the current buffer does not have a name.
1126
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001127:wq [++opt] {file} Write to {file} and quit. Quitting fails when the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001128 last file in the argument list has not been edited.
1129
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001130:wq! [++opt] {file} Write to {file} and quit.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001131
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001132:[range]wq[!] [++opt] [file]
1133 Same as above, but only write the lines in [range].
Bram Moolenaar071d4272004-06-13 20:20:40 +00001134
1135 *:x* *:xit*
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001136:[range]x[it][!] [++opt] [file]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001137 Like ":wq", but write only when changes have been
1138 made.
1139 When 'hidden' is set and there are more windows, the
1140 current buffer becomes hidden, after writing the file.
1141
1142 *:exi* *:exit*
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001143:[range]exi[t][!] [++opt] [file]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001144 Same as :xit.
1145
1146 *ZZ*
1147ZZ Write current file, if modified, and quit (same as
1148 ":x"). (Note: If there are several windows for the
1149 current file, the file is written if it was modified
1150 and the window is closed).
1151
1152 *ZQ*
1153ZQ Quit without checking for changes (same as ":q!").
1154 {not in Vi}
1155
1156MULTIPLE WINDOWS AND BUFFERS *window-exit*
1157
1158 *:qa* *:qall*
1159:qa[ll] Exit Vim, unless there are some buffers which have been
1160 changed. (Use ":bmod" to go to the next modified buffer).
1161 When 'autowriteall' is set all changed buffers will be
1162 written, like |:wqall|. {not in Vi}
1163
1164:conf[irm] qa[ll]
1165 Exit Vim. Bring up a prompt when some buffers have been
1166 changed. See |:confirm|. {not in Vi}
1167
1168:qa[ll]! Exit Vim. Any changes to buffers are lost. {not in Vi}
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00001169 Also see |:cquit|, it does the same but exits with a non-zero
1170 value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001171
1172 *:quita* *:quitall*
1173:quita[ll][!] Same as ":qall". {not in Vi}
1174
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001175:wqa[ll] [++opt] *:wqa* *:wqall* *:xa* *:xall*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001176:xa[ll] Write all changed buffers and exit Vim. If there are buffers
1177 without a file name, which are readonly or which cannot be
1178 written for another reason, Vim will not quit. {not in Vi}
1179
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001180:conf[irm] wqa[ll] [++opt]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001181:conf[irm] xa[ll]
1182 Write all changed buffers and exit Vim. Bring up a prompt
1183 when some buffers are readonly or cannot be written for
1184 another reason. See |:confirm|. {not in Vi}
1185
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001186:wqa[ll]! [++opt]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001187:xa[ll]! Write all changed buffers, even the ones that are readonly,
1188 and exit Vim. If there are buffers without a file name or
1189 which cannot be written for another reason, Vim will not quit.
1190 {not in Vi}
1191
1192==============================================================================
Bram Moolenaar1cd871b2004-12-19 22:46:22 +000011936. Dialogs *edit-dialogs*
1194
1195 *:confirm* *:conf*
1196:conf[irm] {command} Execute {command}, and use a dialog when an
1197 operation has to be confirmed. Can be used on the
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02001198 |:q|, |:qa| and |:w| commands (the latter to override
1199 a read-only setting), and any other command that can
1200 fail in such a way, such as |:only|, |:buffer|,
1201 |:bdelete|, etc.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001202
1203Examples: >
1204 :confirm w foo
1205< Will ask for confirmation when "foo" already exists. >
1206 :confirm q
1207< Will ask for confirmation when there are changes. >
1208 :confirm qa
1209< If any modified, unsaved buffers exist, you will be prompted to save
1210 or abandon each one. There are also choices to "save all" or "abandon
1211 all".
1212
1213If you want to always use ":confirm", set the 'confirm' option.
1214
1215 *:browse* *:bro* *E338* *E614* *E615* *E616* *E578*
1216:bro[wse] {command} Open a file selection dialog for an argument to
1217 {command}. At present this works for |:e|, |:w|,
Bram Moolenaar9028b102010-07-11 16:58:51 +02001218 |:wall|, |:wq|, |:wqall|, |:x|, |:xall|, |:exit|,
1219 |:view|, |:sview|, |:r|, |:saveas|, |:sp|, |:mkexrc|,
1220 |:mkvimrc|, |:mksession|, |:mkview|, |:split|,
1221 |:vsplit|, |:tabe|, |:tabnew|, |:cfile|, |:cgetfile|,
1222 |:caddfile|, |:lfile|, |:lgetfile|, |:laddfile|,
1223 |:diffsplit|, |:diffpatch|, |:open|, |:pedit|,
1224 |:redir|, |:source|, |:update|, |:visual|, |:vsplit|,
1225 and |:qall| if 'confirm' is set.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001226 {only in Win32, Athena, Motif, GTK and Mac GUI}
1227 When ":browse" is not possible you get an error
1228 message. If the |+browse| feature is missing or the
1229 {command} doesn't support browsing, the {command} is
1230 executed without a dialog.
1231 ":browse set" works like |:options|.
Bram Moolenaar9028b102010-07-11 16:58:51 +02001232 See also |:oldfiles| for ":browse oldfiles".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001233
1234The syntax is best shown via some examples: >
1235 :browse e $vim/foo
1236< Open the browser in the $vim/foo directory, and edit the
1237 file chosen. >
1238 :browse e
1239< Open the browser in the directory specified with 'browsedir',
1240 and edit the file chosen. >
1241 :browse w
1242< Open the browser in the directory of the current buffer,
1243 with the current buffer filename as default, and save the
1244 buffer under the filename chosen. >
1245 :browse w C:/bar
1246< Open the browser in the C:/bar directory, with the current
1247 buffer filename as default, and save the buffer under the
1248 filename chosen.
1249Also see the |'browsedir'| option.
1250For versions of Vim where browsing is not supported, the command is executed
1251unmodified.
1252
1253 *browsefilter*
Bram Moolenaar30b65812012-07-12 22:01:11 +02001254For MS Windows and GTK, you can modify the filters that are used in the browse
1255dialog. By setting the g:browsefilter or b:browsefilter variables, you can
1256change the filters globally or locally to the buffer. The variable is set to
1257a string in the format "{filter label}\t{pattern};{pattern}\n" where {filter
1258label} is the text that appears in the "Files of Type" comboBox, and {pattern}
1259is the pattern which filters the filenames. Several patterns can be given,
1260separated by ';'.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001261
1262For Motif the same format is used, but only the very first pattern is actually
1263used (Motif only offers one pattern, but you can edit it).
1264
1265For example, to have only Vim files in the dialog, you could use the following
1266command: >
1267
Bram Moolenaar30b65812012-07-12 22:01:11 +02001268 let g:browsefilter = "Vim Scripts\t*.vim\nVim Startup Files\t*vimrc\n"
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001269
1270You can override the filter setting on a per-buffer basis by setting the
1271b:browsefilter variable. You would most likely set b:browsefilter in a
1272filetype plugin, so that the browse dialog would contain entries related to
1273the type of file you are currently editing. Disadvantage: This makes it
1274difficult to start editing a file of a different type. To overcome this, you
1275may want to add "All Files\t*.*\n" as the final filter, so that the user can
1276still access any desired file.
1277
Bram Moolenaar30b65812012-07-12 22:01:11 +02001278To avoid setting browsefilter when Vim does not actually support it, you can
1279use has("browsefilter"): >
1280
1281 if has("browsefilter")
1282 let g:browsefilter = "whatever"
1283 endif
1284
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001285==============================================================================
12867. The current directory *current-directory*
1287
1288You may use the |:cd| and |:lcd| commands to change to another directory, so
1289you will not have to type that directory name in front of the file names. It
1290also makes a difference for executing external commands, e.g. ":!ls".
1291
Bram Moolenaardf177f62005-02-22 08:39:57 +00001292Changing directory fails when the current buffer is modified, the '.' flag is
1293present in 'cpoptions' and "!" is not used in the command.
1294
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00001295 *:cd* *E747* *E472*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001296:cd[!] On non-Unix systems: Print the current directory
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001297 name. On Unix systems: Change the current directory
1298 to the home directory. Use |:pwd| to print the
1299 current directory on all systems.
1300
Bram Moolenaardf177f62005-02-22 08:39:57 +00001301:cd[!] {path} Change the current directory to {path}.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001302 If {path} is relative, it is searched for in the
1303 directories listed in |'cdpath'|.
1304 Does not change the meaning of an already opened file,
1305 because its full path name is remembered. Files from
1306 the |arglist| may change though!
1307 On MS-DOS this also changes the active drive.
1308 To change to the directory of the current file: >
1309 :cd %:h
1310<
1311 *:cd-* *E186*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001312:cd[!] - Change to the previous current directory (before the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001313 previous ":cd {path}" command). {not in Vi}
1314
1315 *:chd* *:chdir*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001316:chd[ir][!] [path] Same as |:cd|.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001317
1318 *:lc* *:lcd*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001319:lc[d][!] {path} Like |:cd|, but only set the current directory for the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001320 current window. The current directory for other
1321 windows is not changed. {not in Vi}
1322
1323 *:lch* *:lchdir*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001324:lch[dir][!] Same as |:lcd|. {not in Vi}
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001325
1326 *:pw* *:pwd* *E187*
1327:pw[d] Print the current directory name. {Vi: no pwd}
1328 Also see |getcwd()|.
1329
1330So long as no |:lcd| command has been used, all windows share the same current
1331directory. Using a command to jump to another window doesn't change anything
1332for the current directory.
1333When a |:lcd| command has been used for a window, the specified directory
1334becomes the current directory for that window. Windows where the |:lcd|
1335command has not been used stick to the global current directory. When jumping
1336to another window the current directory will become the last specified local
1337current directory. If none was specified, the global current directory is
1338used.
1339When a |:cd| command is used, the current window will lose his local current
1340directory and will use the global current directory from now on.
1341
1342After using |:cd| the full path name will be used for reading and writing
1343files. On some networked file systems this may cause problems. The result of
1344using the full path name is that the file names currently in use will remain
1345referring to the same file. Example: If you have a file a:test and a
1346directory a:vim the commands ":e test" ":cd vim" ":w" will overwrite the file
1347a:test and not write a:vim/test. But if you do ":w test" the file a:vim/test
1348will be written, because you gave a new file name and did not refer to a
1349filename before the ":cd".
1350
1351==============================================================================
Bram Moolenaar071d4272004-06-13 20:20:40 +000013528. Editing binary files *edit-binary*
1353
1354Although Vim was made to edit text files, it is possible to edit binary
1355files. The |-b| Vim argument (b for binary) makes Vim do file I/O in binary
1356mode, and sets some options for editing binary files ('binary' on, 'textwidth'
1357to 0, 'modeline' off, 'expandtab' off). Setting the 'binary' option has the
1358same effect. Don't forget to do this before reading the file.
1359
1360There are a few things to remember when editing binary files:
1361- When editing executable files the number of characters must not change.
1362 Use only the "R" or "r" command to change text. Do not delete characters
1363 with "x" or by backspacing.
1364- Set the 'textwidth' option to 0. Otherwise lines will unexpectedly be
1365 split in two.
1366- When there are not many <EOL>s, the lines will become very long. If you
1367 want to edit a line that does not fit on the screen reset the 'wrap' option.
1368 Horizontal scrolling is used then. If a line becomes too long (more than
1369 about 32767 characters on the Amiga, much more on 32-bit systems, see
1370 |limits|) you cannot edit that line. The line will be split when reading
1371 the file. It is also possible that you get an "out of memory" error when
1372 reading the file.
1373- Make sure the 'binary' option is set BEFORE loading the
1374 file. Otherwise both <CR> <NL> and <NL> are considered to end a line
1375 and when the file is written the <NL> will be replaced with <CR> <NL>.
1376- <Nul> characters are shown on the screen as ^@. You can enter them with
1377 "CTRL-V CTRL-@" or "CTRL-V 000" {Vi cannot handle <Nul> characters in the
1378 file}
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +02001379- To insert a <NL> character in the file split a line. When writing the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001380 buffer to a file a <NL> will be written for the <EOL>.
1381- Vim normally appends an <EOL> at the end of the file if there is none.
1382 Setting the 'binary' option prevents this. If you want to add the final
1383 <EOL>, set the 'endofline' option. You can also read the value of this
1384 option to see if there was an <EOL> for the last line (you cannot see this
1385 in the text).
1386
1387==============================================================================
13889. Encryption *encryption*
1389
1390Vim is able to write files encrypted, and read them back. The encrypted text
1391cannot be read without the right key.
Bram Moolenaar996343d2010-07-04 22:20:21 +02001392{only available when compiled with the |+cryptv| feature} *E833*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001393
Bram Moolenaar81af9252010-12-10 20:35:50 +01001394The text in the swap file and the undo file is also encrypted. *E843*
Bram Moolenaar07d87792014-07-19 14:04:47 +02001395However, this is done block-by-block and may reduce the time needed to crack a
1396password. You can disable the swap file, but then a crash will cause you to
1397lose your work. The undo file can be disabled without much disadvantage. >
1398 :set noundofile
1399 :noswapfile edit secrets
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001400
1401Note: The text in memory is not encrypted. A system administrator may be able
1402to see your text while you are editing it. When filtering text with
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001403":!filter" or using ":w !command" the text is also not encrypted, this may
1404reveal it to others. The 'viminfo' file is not encrypted.
1405
1406You could do this to edit very secret text: >
1407 :set noundofile viminfo=
1408 :noswapfile edit secrets.txt
Bram Moolenaar88774fd2015-08-25 19:52:04 +02001409Keep in mind that without a swap file you risk losing your work in the event
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +02001410of a crash or a power failure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001411
1412WARNING: If you make a typo when entering the key and then write the file and
1413exit, the text will be lost!
1414
1415The normal way to work with encryption, is to use the ":X" command, which will
1416ask you to enter a key. A following write command will use that key to
1417encrypt the file. If you later edit the same file, Vim will ask you to enter
1418a key. If you type the same key as that was used for writing, the text will
1419be readable again. If you use a wrong key, it will be a mess.
1420
1421 *:X*
1422:X Prompt for an encryption key. The typing is done without showing the
1423 actual text, so that someone looking at the display won't see it.
1424 The typed key is stored in the 'key' option, which is used to encrypt
1425 the file when it is written. The file will remain unchanged until you
1426 write it. See also |-x|.
1427
1428The value of the 'key' options is used when text is written. When the option
1429is not empty, the written file will be encrypted, using the value as the
1430encryption key. A magic number is prepended, so that Vim can recognize that
1431the file is encrypted.
1432
1433To disable the encryption, reset the 'key' option to an empty value: >
1434 :set key=
1435
Bram Moolenaar49771f42010-07-20 17:32:38 +02001436You can use the 'cryptmethod' option to select the type of encryption, use one
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001437of these: >
1438 :setlocal cm=zip " weak method, backwards compatible
1439 :setlocal cm=blowfish " method with flaws
1440 :setlocal cm=blowfish2 " medium strong method
1441
Bram Moolenaar49771f42010-07-20 17:32:38 +02001442Do this before writing the file. When reading an encrypted file it will be
1443set automatically to the method used when that file was written. You can
1444change 'cryptmethod' before writing that file to change the method.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001445
Bram Moolenaarc2299672014-11-13 14:25:38 +01001446To set the default method, used for new files, use this in your |vimrc|
1447file: >
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001448 set cm=blowfish2
Bram Moolenaarc2299672014-11-13 14:25:38 +01001449Using "blowfish2" is highly recommended. Only use another method if you
1450must use an older Vim version that does not support it.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001451
Bram Moolenaar662db672011-03-22 14:05:35 +01001452The message given for reading and writing a file will show "[crypted]" when
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001453using zip, "[blowfish]" when using blowfish, etc.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02001454
Bram Moolenaara3ff49f2010-05-30 22:48:02 +02001455When writing an undo file, the same key and method will be used for the text
1456in the undo file. |persistent-undo|.
1457
Bram Moolenaarfa7584c2010-05-19 21:57:45 +02001458 *E817* *E818* *E819* *E820*
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02001459When encryption does not work properly, you would be able to write your text
1460to a file and never be able to read it back. Therefore a test is performed to
1461check if the encryption works as expected. If you get one of these errors
1462don't write the file encrypted! You need to rebuild the Vim binary to fix
1463this.
1464
Bram Moolenaar46f9d492010-06-12 20:18:19 +02001465*E831* This is an internal error, "cannot happen". If you can reproduce it,
Bram Moolenaar56be9502010-06-06 14:20:26 +02001466please report to the developers.
1467
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02001468When reading a file that has been encrypted and the 'key' option is not empty,
1469it will be used for decryption. If the value is empty, you will be prompted
1470to enter the key. If you don't enter a key, or you enter the wrong key, the
1471file is edited without being decrypted. There is no warning about using the
1472wrong key (this makes brute force methods to find the key more difficult).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001473
1474If want to start reading a file that uses a different key, set the 'key'
1475option to an empty string, so that Vim will prompt for a new one. Don't use
1476the ":set" command to enter the value, other people can read the command over
1477your shoulder.
1478
1479Since the value of the 'key' option is supposed to be a secret, its value can
1480never be viewed. You should not set this option in a vimrc file.
1481
Bram Moolenaar60aad972010-07-21 20:36:22 +02001482An encrypted file can be recognized by the "file" command, if you add these
1483lines to "/etc/magic", "/usr/share/misc/magic" or wherever your system has the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001484"magic" file: >
1485 0 string VimCrypt~ Vim encrypted file
Bram Moolenaarc095b282010-07-20 22:33:34 +02001486 >9 string 01 - "zip" cryptmethod
1487 >9 string 02 - "blowfish" cryptmethod
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001488 >9 string 03 - "blowfish2" cryptmethod
Bram Moolenaar071d4272004-06-13 20:20:40 +00001489
1490Notes:
1491- Encryption is not possible when doing conversion with 'charconvert'.
1492- Text you copy or delete goes to the numbered registers. The registers can
1493 be saved in the .viminfo file, where they could be read. Change your
1494 'viminfo' option to be safe.
1495- Someone can type commands in Vim when you walk away for a moment, he should
1496 not be able to get the key.
1497- If you make a typing mistake when entering the key, you might not be able to
1498 get your text back!
1499- If you type the key with a ":set key=value" command, it can be kept in the
1500 history, showing the 'key' value in a viminfo file.
1501- There is never 100% safety. The encryption in Vim has not been tested for
1502 robustness.
Bram Moolenaar24ea3ba2010-09-19 19:01:21 +02001503- The algorithm used for 'cryptmethod' "zip" is breakable. A 4 character key
1504 in about one hour, a 6 character key in one day (on a Pentium 133 PC). This
1505 requires that you know some text that must appear in the file. An expert
1506 can break it for any key. When the text has been decrypted, this also means
1507 that the key can be revealed, and other files encrypted with the same key
1508 can be decrypted.
1509- Pkzip uses the same encryption as 'cryptmethod' "zip", and US Govt has no
1510 objection to its export. Pkzip's public file APPNOTE.TXT describes this
1511 algorithm in detail.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02001512- The implementation of 'cryptmethod' "blowfish" has a flaw. It is possible
1513 to crack the first 64 bytes of a file and in some circumstances more of the
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001514 file. Use of it is not recommended, but it's still the strongest method
1515 supported by Vim 7.3 and 7.4. The "zip" method is even weaker.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001516- Vim originates from the Netherlands. That is where the sources come from.
1517 Thus the encryption code is not exported from the USA.
1518
1519==============================================================================
152010. Timestamps *timestamp* *timestamps*
1521
Bram Moolenaare968e362014-05-13 20:23:24 +02001522Vim remembers the modification timestamp, mode and size of a file when you
1523begin editing it. This is used to avoid that you have two different versions
1524of the same file (without you knowing this).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001525
Bram Moolenaare968e362014-05-13 20:23:24 +02001526After a shell command is run (|:!cmd| |suspend| |:read!| |K|) timestamps,
1527file modes and file sizes are compared for all buffers in a window. Vim will
1528run any associated |FileChangedShell| autocommands or display a warning for
1529any files that have changed. In the GUI this happens when Vim regains input
1530focus.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001531
1532 *E321* *E462*
1533If you want to automatically reload a file when it has been changed outside of
1534Vim, set the 'autoread' option. This doesn't work at the moment you write the
1535file though, only when the file wasn't changed inside of Vim.
1536
1537Note that if a FileChangedShell autocommand is defined you will not get a
1538warning message or prompt. The autocommand is expected to handle this.
1539
Bram Moolenaar10de2da2005-01-27 14:33:00 +00001540There is no warning for a directory (e.g., with |netrw-browse|). But you do
1541get warned if you started editing a new file and it was created as a directory
1542later.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001543
1544When Vim notices the timestamp of a file has changed, and the file is being
1545edited in a buffer but has not changed, Vim checks if the contents of the file
1546is equal. This is done by reading the file again (into a hidden buffer, which
1547is immediately deleted again) and comparing the text. If the text is equal,
1548you will get no warning.
1549
1550If you don't get warned often enough you can use the following command.
1551
1552 *:checkt* *:checktime*
1553:checkt[ime] Check if any buffers were changed outside of Vim.
1554 This checks and warns you if you would end up with two
1555 versions of a file.
1556 If this is called from an autocommand, a ":global"
1557 command or is not typed the actual check is postponed
1558 until a moment the side effects (reloading the file)
1559 would be harmless.
1560 Each loaded buffer is checked for its associated file
1561 being changed. If the file was changed Vim will take
1562 action. If there are no changes in the buffer and
1563 'autoread' is set, the buffer is reloaded. Otherwise,
1564 you are offered the choice of reloading the file. If
1565 the file was deleted you get an error message.
1566 If the file previously didn't exist you get a warning
1567 if it exists now.
1568 Once a file has been checked the timestamp is reset,
1569 you will not be warned again.
1570
1571:[N]checkt[ime] {filename}
1572:[N]checkt[ime] [N]
1573 Check the timestamp of a specific buffer. The buffer
1574 may be specified by name, number or with a pattern.
1575
1576
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001577 *E813* *E814*
1578Vim will reload the buffer if you chose to. If a window is visible that
1579contains this buffer, the reloading will happen in the context of this window.
1580Otherwise a special window is used, so that most autocommands will work. You
1581can't close this window. A few other restrictions apply. Best is to make
1582sure nothing happens outside of the current buffer. E.g., setting
1583window-local options may end up in the wrong window. Splitting the window,
1584doing something there and closing it should be OK (if there are no side
1585effects from other autocommands). Closing unrelated windows and buffers will
1586get you into trouble.
1587
Bram Moolenaar071d4272004-06-13 20:20:40 +00001588Before writing a file the timestamp is checked. If it has changed, Vim will
1589ask if you really want to overwrite the file:
1590
1591 WARNING: The file has been changed since reading it!!!
1592 Do you really want to write to it (y/n)?
1593
1594If you hit 'y' Vim will continue writing the file. If you hit 'n' the write is
1595aborted. If you used ":wq" or "ZZ" Vim will not exit, you will get another
1596chance to write the file.
1597
1598The message would normally mean that somebody has written to the file after
1599the edit session started. This could be another person, in which case you
1600probably want to check if your changes to the file and the changes from the
1601other person should be merged. Write the file under another name and check for
1602differences (the "diff" program can be used for this).
1603
1604It is also possible that you modified the file yourself, from another edit
1605session or with another command (e.g., a filter command). Then you will know
1606which version of the file you want to keep.
1607
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001608There is one situation where you get the message while there is nothing wrong:
1609On a Win32 system on the day daylight saving time starts. There is something
1610in the Win32 libraries that confuses Vim about the hour time difference. The
1611problem goes away the next day.
1612
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001613==============================================================================
161411. File Searching *file-searching*
1615
1616{not available when compiled without the |+path_extra| feature}
1617
1618The file searching is currently used for the 'path', 'cdpath' and 'tags'
Bram Moolenaarc236c162008-07-13 17:41:49 +00001619options, for |finddir()| and |findfile()|. Other commands use |wildcards|
1620which is slightly different.
Bram Moolenaar9964e462007-05-05 17:54:07 +00001621
1622There are three different types of searching:
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001623
Bram Moolenaar02743632005-07-25 20:42:36 +000016241) Downward search: *starstar*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001625 Downward search uses the wildcards '*', '**' and possibly others
Bram Moolenaarc236c162008-07-13 17:41:49 +00001626 supported by your operating system. '*' and '**' are handled inside Vim,
1627 so they work on all operating systems. Note that "**" only acts as a
1628 special wildcard when it is at the start of a name.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001629
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00001630 The usage of '*' is quite simple: It matches 0 or more characters. In a
1631 search pattern this would be ".*". Note that the "." is not used for file
1632 searching.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001633
1634 '**' is more sophisticated:
1635 - It ONLY matches directories.
Bram Moolenaarc236c162008-07-13 17:41:49 +00001636 - It matches up to 30 directories deep by default, so you can use it to
1637 search an entire directory tree
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001638 - The maximum number of levels matched can be given by appending a number
1639 to '**'.
1640 Thus '/usr/**2' can match: >
1641 /usr
1642 /usr/include
1643 /usr/include/sys
1644 /usr/include/g++
1645 /usr/lib
1646 /usr/lib/X11
1647 ....
1648< It does NOT match '/usr/include/g++/std' as this would be three
1649 levels.
Bram Moolenaarc236c162008-07-13 17:41:49 +00001650 The allowed number range is 0 ('**0' is removed) to 100
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001651 If the given number is smaller than 0 it defaults to 30, if it's
Bram Moolenaarc236c162008-07-13 17:41:49 +00001652 bigger than 100 then 100 is used. The system also has a limit on the
1653 path length, usually 256 or 1024 bytes.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001654 - '**' can only be at the end of the path or be followed by a path
1655 separator or by a number and a path separator.
1656
1657 You can combine '*' and '**' in any order: >
1658 /usr/**/sys/*
Bram Moolenaarc236c162008-07-13 17:41:49 +00001659 /usr/*tory/sys/**
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001660 /usr/**2/sys/*
1661
16622) Upward search:
1663 Here you can give a directory and then search the directory tree upward for
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001664 a file. You could give stop-directories to limit the upward search. The
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001665 stop-directories are appended to the path (for the 'path' option) or to
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001666 the filename (for the 'tags' option) with a ';'. If you want several
1667 stop-directories separate them with ';'. If you want no stop-directory
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001668 ("search upward till the root directory) just use ';'. >
1669 /usr/include/sys;/usr
1670< will search in: >
1671 /usr/include/sys
1672 /usr/include
1673 /usr
1674<
1675 If you use a relative path the upward search is started in Vim's current
1676 directory or in the directory of the current file (if the relative path
1677 starts with './' and 'd' is not included in 'cpoptions').
1678
1679 If Vim's current path is /u/user_x/work/release and you do >
1680 :set path=include;/u/user_x
1681< and then search for a file with |gf| the file is searched in: >
1682 /u/user_x/work/release/include
1683 /u/user_x/work/include
1684 /u/user_x/include
1685
Bram Moolenaar402d2fe2005-04-15 21:00:38 +000016863) Combined up/downward search:
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001687 If Vim's current path is /u/user_x/work/release and you do >
1688 set path=**;/u/user_x
1689< and then search for a file with |gf| the file is searched in: >
1690 /u/user_x/work/release/**
1691 /u/user_x/work/**
1692 /u/user_x/**
1693<
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001694 BE CAREFUL! This might consume a lot of time, as the search of
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001695 '/u/user_x/**' includes '/u/user_x/work/**' and
1696 '/u/user_x/work/release/**'. So '/u/user_x/work/release/**' is searched
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001697 three times and '/u/user_x/work/**' is searched twice.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001698
1699 In the above example you might want to set path to: >
1700 :set path=**,/u/user_x/**
Bram Moolenaar162bd912010-07-28 22:29:10 +02001701< This searches:
1702 /u/user_x/work/release/** ~
1703 /u/user_x/** ~
1704 This searches the same directories, but in a different order.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001705
Bram Moolenaar162bd912010-07-28 22:29:10 +02001706 Note that completion for ":find", ":sfind", and ":tabfind" commands do not
1707 currently work with 'path' items that contain a url or use the double star
Bram Moolenaar5b435d62012-04-05 17:33:26 +02001708 with depth limiter (/usr/**2) or upward search (;) notations.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001709
1710 vim:tw=78:ts=8:ft=help:norl: