blob: c8cb5981e9cf5602bcd284678e0906b777b3d0bf [file] [log] [blame]
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01001*editing.txt* For Vim version 7.4. Last change: 2016 Feb 01
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.
Bram Moolenaared767a22016-01-03 22:49:16 +010081 Also see the 'ruler' option and the |wordcount()|
82 function.
83 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +000084
85 *v_g_CTRL-G*
Bram Moolenaar7c626922005-02-07 22:01:03 +000086{Visual}g CTRL-G Similar to "g CTRL-G", but Word, Character, Line, and
87 Byte counts for the visually selected region are
88 displayed.
89 In Blockwise mode, Column count is also shown. (For
Bram Moolenaar071d4272004-06-13 20:20:40 +000090 {Visual} see |Visual-mode|.)
91 {not in VI}
92
93 *:file_f*
Bram Moolenaar325b7a22004-07-05 15:58:32 +000094:f[ile][!] {name} Sets the current file name to {name}. The optional !
95 avoids truncating the message, as with |:file|.
Bram Moolenaar7171abe2004-10-11 10:06:20 +000096 If the buffer did have a name, that name becomes the
97 |alternate-file| name. An unlisted buffer is created
98 to hold the old name.
Bram Moolenaar10de2da2005-01-27 14:33:00 +000099 *:0file*
Bram Moolenaar325b7a22004-07-05 15:58:32 +0000100:0f[ile][!] Remove the name of the current buffer. The optional !
101 avoids truncating the message, as with |:file|. {not
102 in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000103
104:buffers
105:files
106:ls List all the currently known file names. See
107 'windows.txt' |:files| |:buffers| |:ls|. {not in
108 Vi}
109
110Vim will remember the full path name of a file name that you enter. In most
111cases when the file name is displayed only the name you typed is shown, but
112the full path name is being used if you used the ":cd" command |:cd|.
113
114 *home-replace*
115If the environment variable $HOME is set, and the file name starts with that
116string, it is often displayed with HOME replaced with "~". This was done to
117keep file names short. When reading or writing files the full name is still
118used, the "~" is only used when displaying file names. When replacing the
119file name would result in just "~", "~/" is used instead (to avoid confusion
Bram Moolenaar81695252004-12-29 20:58:21 +0000120between options set to $HOME with 'backupext' set to "~").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000121
122When writing the buffer, the default is to use the current file name. Thus
123when you give the "ZZ" or ":wq" command, the original file will be
124overwritten. If you do not want this, the buffer can be written into another
125file by giving a file name argument to the ":write" command. For example: >
126
127 vim testfile
128 [change the buffer with editor commands]
129 :w newfile
130 :q
131
132This will create a file "newfile", that is a modified copy of "testfile".
133The file "testfile" will remain unchanged. Anyway, if the 'backup' option is
134set, Vim renames or copies the original file before it will be overwritten.
135You can use this file if you discover that you need the original file. See
136also the 'patchmode' option. The name of the backup file is normally the same
137as the original file with 'backupext' appended. The default "~" is a bit
138strange to avoid accidentally overwriting existing files. If you prefer ".bak"
139change the 'backupext' option. Extra dots are replaced with '_' on MS-DOS
140machines, when Vim has detected that an MS-DOS-like filesystem is being used
141(e.g., messydos or crossdos) or when the 'shortname' option is on. The
142backup file can be placed in another directory by setting 'backupdir'.
143
144 *auto-shortname*
145Technical: On the Amiga you can use 30 characters for a file name. But on an
146 MS-DOS-compatible filesystem only 8 plus 3 characters are
147 available. Vim tries to detect the type of filesystem when it is
148 creating the .swp file. If an MS-DOS-like filesystem is suspected,
149 a flag is set that has the same effect as setting the 'shortname'
150 option. This flag will be reset as soon as you start editing a
151 new file. The flag will be used when making the file name for the
152 ".swp" and ".~" files for the current file. But when you are
153 editing a file in a normal filesystem and write to an MS-DOS-like
154 filesystem the flag will not have been set. In that case the
155 creation of the ".~" file may fail and you will get an error
156 message. Use the 'shortname' option in this case.
157
158When you started editing without giving a file name, "No File" is displayed in
159messages. If the ":write" command is used with a file name argument, the file
160name for the current file is set to that file name. This only happens when
Bram Moolenaar2d3f4892006-01-20 23:02:51 +0000161the 'F' flag is included in 'cpoptions' (by default it is included) |cpo-F|.
162This is useful when entering text in an empty buffer and then writing it to a
163file. If 'cpoptions' contains the 'f' flag (by default it is NOT included)
164|cpo-f| the file name is set for the ":read file" command. This is useful
165when starting Vim without an argument and then doing ":read file" to start
166editing a file.
167When the file name was set and 'filetype' is empty the filetype detection
168autocommands will be triggered.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000169 *not-edited*
170Because the file name was set without really starting to edit that file, you
171are protected from overwriting that file. This is done by setting the
172"notedited" flag. You can see if this flag is set with the CTRL-G or ":file"
173command. It will include "[Not edited]" when the "notedited" flag is set.
174When writing the buffer to the current file name (with ":w!"), the "notedited"
175flag is reset.
176
177 *abandon*
178Vim remembers whether you have changed the buffer. You are protected from
179losing the changes you made. If you try to quit without writing, or want to
180start editing another file, Vim will refuse this. In order to overrule this
181protection, add a '!' to the command. The changes will then be lost. For
182example: ":q" will not work if the buffer was changed, but ":q!" will. To see
183whether the buffer was changed use the "CTRL-G" command. The message includes
184the string "[Modified]" if the buffer has been changed.
185
186If you want to automatically save the changes without asking, switch on the
187'autowriteall' option. 'autowrite' is the associated Vi-compatible option
188that does not work for all commands.
189
190If you want to keep the changed buffer without saving it, switch on the
Bram Moolenaar9d98fe92013-08-03 18:35:36 +0200191'hidden' option. See |hidden-buffer|. Some commands work like this even when
192'hidden' is not set, check the help for the command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000193
194==============================================================================
1952. Editing a file *edit-a-file*
196
Bram Moolenaar9d98fe92013-08-03 18:35:36 +0200197 *:e* *:edit* *reload*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000198:e[dit] [++opt] [+cmd] Edit the current file. This is useful to re-edit the
199 current file, when it has been changed outside of Vim.
200 This fails when changes have been made to the current
201 buffer and 'autowriteall' isn't set or the file can't
202 be written.
203 Also see |++opt| and |+cmd|.
204 {Vi: no ++opt}
205
Bram Moolenaar9d98fe92013-08-03 18:35:36 +0200206 *:edit!* *discard*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000207:e[dit]! [++opt] [+cmd]
208 Edit the current file always. Discard any changes to
209 the current buffer. This is useful if you want to
210 start all over again.
211 Also see |++opt| and |+cmd|.
212 {Vi: no ++opt}
213
214 *:edit_f*
215:e[dit] [++opt] [+cmd] {file}
216 Edit {file}.
217 This fails when changes have been made to the current
218 buffer, unless 'hidden' is set or 'autowriteall' is
219 set and the file can be written.
220 Also see |++opt| and |+cmd|.
221 {Vi: no ++opt}
222
223 *:edit!_f*
224:e[dit]! [++opt] [+cmd] {file}
225 Edit {file} always. Discard any changes to the
226 current buffer.
227 Also see |++opt| and |+cmd|.
228 {Vi: no ++opt}
229
230:e[dit] [++opt] [+cmd] #[count]
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000231 Edit the [count]th buffer (as shown by |:files|).
232 This command does the same as [count] CTRL-^. But ":e
233 #" doesn't work if the alternate buffer doesn't have a
234 file name, while CTRL-^ still works then.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000235 Also see |++opt| and |+cmd|.
236 {Vi: no ++opt}
237
238 *:ene* *:enew*
239:ene[w] Edit a new, unnamed buffer. This fails when changes
240 have been made to the current buffer, unless 'hidden'
241 is set or 'autowriteall' is set and the file can be
242 written.
243 If 'fileformats' is not empty, the first format given
244 will be used for the new buffer. If 'fileformats' is
245 empty, the 'fileformat' of the current buffer is used.
246 {not in Vi}
247
248 *:ene!* *:enew!*
249:ene[w]! Edit a new, unnamed buffer. Discard any changes to
250 the current buffer.
251 Set 'fileformat' like |:enew|.
252 {not in Vi}
253
254 *:fin* *:find*
255:fin[d][!] [++opt] [+cmd] {file}
256 Find {file} in 'path' and then |:edit| it.
257 {not in Vi} {not available when the |+file_in_path|
258 feature was disabled at compile time}
259
260:{count}fin[d][!] [++opt] [+cmd] {file}
261 Just like ":find", but use the {count} match in
262 'path'. Thus ":2find file" will find the second
263 "file" found in 'path'. When there are fewer matches
264 for the file in 'path' than asked for, you get an
265 error message.
266
267 *:ex*
268:ex [++opt] [+cmd] [file]
269 Same as |:edit|.
270
271 *:vi* *:visual*
272:vi[sual][!] [++opt] [+cmd] [file]
Bram Moolenaar81695252004-12-29 20:58:21 +0000273 When used in Ex mode: Leave |Ex-mode|, go back to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000274 Normal mode. Otherwise same as |:edit|.
275
276 *:vie* *:view*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100277:vie[w][!] [++opt] [+cmd] file
Bram Moolenaar81695252004-12-29 20:58:21 +0000278 When used in Ex mode: Leave |Ex mode|, go back to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000279 Normal mode. Otherwise same as |:edit|, but set
280 'readonly' option for this buffer. {not in Vi}
281
282 *CTRL-^* *CTRL-6*
Bram Moolenaar662db672011-03-22 14:05:35 +0100283CTRL-^ Edit the alternate file. Mostly the alternate file is
284 the previously edited file. This is a quick way to
285 toggle between two files. It is equivalent to ":e #",
286 except that it also works when there is no file name.
287
Bram Moolenaar071d4272004-06-13 20:20:40 +0000288 If the 'autowrite' or 'autowriteall' option is on and
289 the buffer was changed, write it.
290 Mostly the ^ character is positioned on the 6 key,
291 pressing CTRL and 6 then gets you what we call CTRL-^.
292 But on some non-US keyboards CTRL-^ is produced in
293 another way.
294
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000295{count}CTRL-^ Edit [count]th file in the buffer list (equivalent to
296 ":e #[count]"). This is a quick way to switch between
297 files.
298 See |CTRL-^| above for further details.
299 {not in Vi}
300
Bram Moolenaar071d4272004-06-13 20:20:40 +0000301[count]]f *]f* *[f*
302[count][f Same as "gf". Deprecated.
303
304 *gf* *E446* *E447*
305[count]gf Edit the file whose name is under or after the cursor.
306 Mnemonic: "goto file".
307 Uses the 'isfname' option to find out which characters
308 are supposed to be in a file name. Trailing
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100309 punctuation characters ".,:;!" are ignored. Escaped
310 spaces "\ " are reduced to a single space.
Bram Moolenaarc236c162008-07-13 17:41:49 +0000311 Uses the 'path' option as a list of directory names to
312 look for the file. See the 'path' option for details
313 about relative directories and wildcards.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000314 Uses the 'suffixesadd' option to check for file names
315 with a suffix added.
316 If the file can't be found, 'includeexpr' is used to
317 modify the name and another attempt is done.
318 If a [count] is given, the count'th file that is found
319 in the 'path' is edited.
320 This command fails if Vim refuses to |abandon| the
321 current file.
Bram Moolenaar8dff8182006-04-06 20:18:50 +0000322 If you want to edit the file in a new window use
323 |CTRL-W_CTRL-F|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000324 If you do want to edit a new file, use: >
325 :e <cfile>
326< To make gf always work like that: >
327 :map gf :e <cfile><CR>
328< If the name is a hypertext link, that looks like
329 "type://machine/path", you need the |netrw| plugin.
330 For Unix the '~' character is expanded, like in
331 "~user/file". Environment variables are expanded too
332 |expand-env|.
333 {not in Vi}
334 {not available when the |+file_in_path| feature was
335 disabled at compile time}
336
337 *v_gf*
338{Visual}[count]gf Same as "gf", but the highlighted text is used as the
339 name of the file to edit. 'isfname' is ignored.
340 Leading blanks are skipped, otherwise all blanks and
341 special characters are included in the file name.
342 (For {Visual} see |Visual-mode|.)
343 {not in VI}
344
Bram Moolenaard1f56e62006-02-22 21:25:37 +0000345 *gF*
346[count]gF Same as "gf", except if a number follows the file
347 name, then the cursor is positioned on that line in
348 the file. The file name and the number must be
349 separated by a non-filename (see 'isfname') and
350 non-numeric character. White space between the
351 filename, the separator and the number are ignored.
Bram Moolenaard8fc5c02006-04-29 21:55:22 +0000352 Examples:
353 eval.c:10 ~
354 eval.c @ 20 ~
355 eval.c (30) ~
356 eval.c 40 ~
357
Bram Moolenaard1f56e62006-02-22 21:25:37 +0000358 *v_gF*
359{Visual}[count]gF Same as "v_gf".
360
Bram Moolenaar071d4272004-06-13 20:20:40 +0000361These commands are used to start editing a single file. This means that the
362file is read into the buffer and the current file name is set. The file that
363is opened depends on the current directory, see |:cd|.
364
365See |read-messages| for an explanation of the message that is given after the
366file has been read.
367
368You can use the ":e!" command if you messed up the buffer and want to start
369all over again. The ":e" command is only useful if you have changed the
370current file name.
371
372 *:filename* *{file}*
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000373Besides the things mentioned here, more special items for where a filename is
374expected are mentioned at |cmdline-special|.
375
Bram Moolenaarc236c162008-07-13 17:41:49 +0000376Note for systems other than Unix: When using a command that accepts a single
377file name (like ":edit file") spaces in the file name are allowed, but
378trailing spaces are ignored. This is useful on systems that regularly embed
379spaces in file names (like MS-Windows and the Amiga). Example: The command
380":e Long File Name " will edit the file "Long File Name". When using a
381command that accepts more than one file name (like ":next file1 file2")
382embedded spaces must be escaped with a backslash.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000383
Bram Moolenaar9964e462007-05-05 17:54:07 +0000384 *wildcard* *wildcards*
Bram Moolenaar30b65812012-07-12 22:01:11 +0200385Wildcards in {file} are expanded, but as with file completion, 'wildignore'
386and 'suffixes' apply. Which wildcards are supported depends on the system.
387These are the common ones:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000388 ? matches one character
Bram Moolenaar02743632005-07-25 20:42:36 +0000389 * matches anything, including nothing
390 ** matches anything, including nothing, recurses into directories
Bram Moolenaar071d4272004-06-13 20:20:40 +0000391 [abc] match 'a', 'b' or 'c'
Bram Moolenaar02743632005-07-25 20:42:36 +0000392
Bram Moolenaar071d4272004-06-13 20:20:40 +0000393To avoid the special meaning of the wildcards prepend a backslash. However,
394on MS-Windows the backslash is a path separator and "path\[abc]" is still seen
395as a wildcard when "[" is in the 'isfname' option. A simple way to avoid this
396is to use "path\[[]abc]". Then the file "path[abc]" literally.
397
Bram Moolenaar02743632005-07-25 20:42:36 +0000398 *starstar-wildcard*
399Expanding "**" is possible on Unix, Win32, Mac OS/X and a few other systems.
400This allows searching a directory tree. This goes up to 100 directories deep.
Bram Moolenaar9b451252012-08-15 17:43:31 +0200401Note there are some commands where this works slightly differently, see
Bram Moolenaarc236c162008-07-13 17:41:49 +0000402|file-searching|.
Bram Moolenaar02743632005-07-25 20:42:36 +0000403Example: >
404 :n **/*.txt
405Finds files:
406 ttt.txt
407 subdir/ttt.txt
408 a/b/c/d/ttt.txt
409When non-wildcard characters are used these are only matched in the first
410directory. Example: >
411 :n /usr/inc**/*.h
412Finds files:
413 /usr/include/types.h
414 /usr/include/sys/types.h
415 /usr/inc_old/types.h
Bram Moolenaar071d4272004-06-13 20:20:40 +0000416 *backtick-expansion* *`-expansion*
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200417On Unix and a few other systems you can also use backticks for the file name
418argument, for example: >
419 :next `find . -name ver\\*.c -print`
Bram Moolenaar88774fd2015-08-25 19:52:04 +0200420 :view `ls -t *.patch \| head -n1`
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200421The backslashes before the star are required to prevent the shell from
422expanding "ver*.c" prior to execution of the find program. The backslash
423before the shell pipe symbol "|" prevents Vim from parsing it as command
424termination.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000425This also works for most other systems, with the restriction that the
426backticks must be around the whole item. It is not possible to have text
427directly before the first or just after the last backtick.
428
Bram Moolenaared203462004-06-16 11:19:22 +0000429 *`=*
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200430You can have the backticks expanded as a Vim expression, instead of as an
431external command, by putting an equal sign right after the first backtick,
432e.g.: >
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000433 :e `=tempname()`
434The expression can contain just about anything, thus this can also be used to
Bram Moolenaar30b65812012-07-12 22:01:11 +0200435avoid the special meaning of '"', '|', '%' and '#'. However, 'wildignore'
Bram Moolenaar00154502013-02-13 16:15:55 +0100436does apply like to other wildcards.
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200437
Bram Moolenaar88774fd2015-08-25 19:52:04 +0200438Environment variables in the expression are expanded when evaluating the
439expression, thus this works: >
440 :e `=$HOME . '/.vimrc'`
441This does not work, $HOME is inside a string and used literally: >
442 :e `='$HOME' . '/.vimrc'`
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200443
Bram Moolenaar30b65812012-07-12 22:01:11 +0200444If the expression returns a string then names are to be separated with line
445breaks. When the result is a |List| then each item is used as a name. Line
446breaks also separate names.
Bram Moolenaarf9132812015-07-21 19:19:13 +0200447Note that such expressions are only supported in places where a filename is
448expected as an argument to an Ex-command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000449
450 *++opt* *[++opt]*
Bram Moolenaarb0bf8582005-12-13 20:02:15 +0000451The [++opt] argument can be used to force the value of 'fileformat',
452'fileencoding' or 'binary' to a value for one command, and to specify the
453behavior for bad characters. The form is: >
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000454 ++{optname}
455Or: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000456 ++{optname}={value}
457
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000458Where {optname} is one of: *++ff* *++enc* *++bin* *++nobin* *++edit*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000459 ff or fileformat overrides 'fileformat'
460 enc or encoding overrides 'fileencoding'
461 bin or binary sets 'binary'
462 nobin or nobinary resets 'binary'
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000463 bad specifies behavior for bad characters
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000464 edit for |:read| only: keep option values as if editing
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000465 a file
Bram Moolenaar071d4272004-06-13 20:20:40 +0000466
467{value} cannot contain white space. It can be any valid value for these
468options. Examples: >
469 :e ++ff=unix
470This edits the same file again with 'fileformat' set to "unix". >
471
472 :w ++enc=latin1 newfile
473This writes the current buffer to "newfile" in latin1 format.
474
Bram Moolenaarb0bf8582005-12-13 20:02:15 +0000475There may be several ++opt arguments, separated by white space. They must all
476appear before any |+cmd| argument.
477
478 *++bad*
479The argument of "++bad=" specifies what happens with characters that can't be
480converted and illegal bytes. It can be one of three things:
481 ++bad=X A single-byte character that replaces each bad character.
482 ++bad=keep Keep bad characters without conversion. Note that this may
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000483 result in illegal bytes in your text!
Bram Moolenaarb0bf8582005-12-13 20:02:15 +0000484 ++bad=drop Remove the bad characters.
485
486The default is like "++bad=?": Replace each bad character with a question
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100487mark. In some places an inverted question mark is used (0xBF).
488
489Note that not all commands use the ++bad argument, even though they do not
490give an error when you add it. E.g. |:write|.
Bram Moolenaarb0bf8582005-12-13 20:02:15 +0000491
Bram Moolenaar071d4272004-06-13 20:20:40 +0000492Note that when reading, the 'fileformat' and 'fileencoding' options will be
493set to the used format. When writing this doesn't happen, thus a next write
494will use the old value of the option. Same for the 'binary' option.
495
Bram Moolenaar071d4272004-06-13 20:20:40 +0000496
497 *+cmd* *[+cmd]*
498The [+cmd] argument can be used to position the cursor in the newly opened
499file, or execute any other command:
500 + Start at the last line.
501 +{num} Start at line {num}.
502 +/{pat} Start at first line containing {pat}.
503 +{command} Execute {command} after opening the new file.
504 {command} is any Ex command.
505To include a white space in the {pat} or {command}, precede it with a
506backslash. Double the number of backslashes. >
507 :edit +/The\ book file
508 :edit +/dir\ dirname\\ file
509 :edit +set\ dir=c:\\\\temp file
510Note that in the last example the number of backslashes is halved twice: Once
511for the "+cmd" argument and once for the ":set" command.
512
513 *file-formats*
514The 'fileformat' option sets the <EOL> style for a file:
515'fileformat' characters name ~
516 "dos" <CR><NL> or <NL> DOS format *DOS-format*
517 "unix" <NL> Unix format *Unix-format*
518 "mac" <CR> Mac format *Mac-format*
519Previously 'textmode' was used. It is obsolete now.
520
521When reading a file, the mentioned characters are interpreted as the <EOL>.
522In DOS format (default for MS-DOS, OS/2 and Win32), <CR><NL> and <NL> are both
523interpreted as the <EOL>. Note that when writing the file in DOS format,
524<CR> characters will be added for each single <NL>. Also see |file-read|.
525
526When writing a file, the mentioned characters are used for <EOL>. For DOS
527format <CR><NL> is used. Also see |DOS-format-write|.
528
529You can read a file in DOS format and write it in Unix format. This will
530replace all <CR><NL> pairs by <NL> (assuming 'fileformats' includes "dos"): >
531 :e file
532 :set fileformat=unix
533 :w
534If you read a file in Unix format and write with DOS format, all <NL>
535characters will be replaced with <CR><NL> (assuming 'fileformats' includes
536"unix"): >
537 :e file
538 :set fileformat=dos
539 :w
540
541If you start editing a new file and the 'fileformats' option is not empty
542(which is the default), Vim will try to detect whether the lines in the file
543are separated by the specified formats. When set to "unix,dos", Vim will
544check for lines with a single <NL> (as used on Unix and Amiga) or by a <CR>
545<NL> pair (MS-DOS). Only when ALL lines end in <CR><NL>, 'fileformat' is set
546to "dos", otherwise it is set to "unix". When 'fileformats' includes "mac",
547and no <NL> characters are found in the file, 'fileformat' is set to "mac".
548
549If the 'fileformat' option is set to "dos" on non-MS-DOS systems the message
550"[dos format]" is shown to remind you that something unusual is happening. On
551MS-DOS systems you get the message "[unix format]" if 'fileformat' is set to
552"unix". On all systems but the Macintosh you get the message "[mac format]"
553if 'fileformat' is set to "mac".
554
555If the 'fileformats' option is empty and DOS format is used, but while reading
556a file some lines did not end in <CR><NL>, "[CR missing]" will be included in
557the file message.
558If the 'fileformats' option is empty and Mac format is used, but while reading
559a file a <NL> was found, "[NL missing]" will be included in the file message.
560
561If the new file does not exist, the 'fileformat' of the current buffer is used
562when 'fileformats' is empty. Otherwise the first format from 'fileformats' is
563used for the new file.
564
565Before editing binary, executable or Vim script files you should set the
566'binary' option. A simple way to do this is by starting Vim with the "-b"
567option. This will avoid the use of 'fileformat'. Without this you risk that
568single <NL> characters are unexpectedly replaced with <CR><NL>.
569
570You can encrypt files that are written by setting the 'key' option. This
571provides some security against others reading your files. |encryption|
572
573
Bram Moolenaar071d4272004-06-13 20:20:40 +0000574==============================================================================
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005753. The argument list *argument-list* *arglist*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000576
577If you give more than one file name when starting Vim, this list is remembered
578as the argument list. You can jump to each file in this list.
579
580Do not confuse this with the buffer list, which you can see with the
581|:buffers| command. The argument list was already present in Vi, the buffer
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000582list is new in Vim. Every file name in the argument list will also be present
583in the buffer list (unless it was deleted with |:bdel| or |:bwipe|). But it's
584common that names in the buffer list are not in the argument list.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000585
586This subject is introduced in section |07.2| of the user manual.
587
588There is one global argument list, which is used for all windows by default.
589It is possible to create a new argument list local to a window, see
590|:arglocal|.
591
592You can use the argument list with the following commands, and with the
593expression functions |argc()| and |argv()|. These all work on the argument
594list of the current window.
595
596 *:ar* *:args*
597:ar[gs] Print the argument list, with the current file in
598 square brackets.
599
600:ar[gs] [++opt] [+cmd] {arglist} *:args_f*
601 Define {arglist} as the new argument list and edit
602 the first one. This fails when changes have been made
603 and Vim does not want to |abandon| the current buffer.
604 Also see |++opt| and |+cmd|.
605 {Vi: no ++opt}
606
607:ar[gs]! [++opt] [+cmd] {arglist} *:args_f!*
608 Define {arglist} as the new argument list and edit
609 the first one. Discard any changes to the current
610 buffer.
611 Also see |++opt| and |+cmd|.
612 {Vi: no ++opt}
613
614:[count]arge[dit][!] [++opt] [+cmd] {name} *:arge* *:argedit*
615 Add {name} to the argument list and edit it.
616 When {name} already exists in the argument list, this
617 entry is edited.
618 This is like using |:argadd| and then |:edit|.
619 Note that only one file name is allowed, and spaces
620 inside the file name are allowed, like with |:edit|.
621 [count] is used like with |:argadd|.
622 [!] is required if the current file cannot be
623 |abandon|ed.
624 Also see |++opt| and |+cmd|.
625 {not in Vi}
626
627:[count]arga[dd] {name} .. *:arga* *:argadd* *E479*
Bram Moolenaar91e15e12014-09-19 22:38:48 +0200628:[count]arga[dd]
629 Add the {name}s to the argument list. When {name} is
Bram Moolenaared32d942014-12-06 23:33:00 +0100630 omitted add the current buffer name to the argument
Bram Moolenaar91e15e12014-09-19 22:38:48 +0200631 list.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000632 If [count] is omitted, the {name}s are added just
633 after the current entry in the argument list.
634 Otherwise they are added after the [count]'th file.
635 If the argument list is "a b c", and "b" is the
636 current argument, then these commands result in:
637 command new argument list ~
638 :argadd x a b x c
639 :0argadd x x a b c
640 :1argadd x a x b c
Bram Moolenaared32d942014-12-06 23:33:00 +0100641 :$argadd x a b c x
Bram Moolenaar85084ef2016-01-17 22:26:33 +0100642 And after the last one:
Bram Moolenaared32d942014-12-06 23:33:00 +0100643 :+2argadd y a b c x y
Bram Moolenaar071d4272004-06-13 20:20:40 +0000644 There is no check for duplicates, it is possible to
645 add a file to the argument list twice.
646 The currently edited file is not changed.
647 {not in Vi} {not available when compiled without the
648 |+listcmds| feature}
649 Note: you can also use this method: >
650 :args ## x
651< This will add the "x" item and sort the new list.
652
653:argd[elete] {pattern} .. *:argd* *:argdelete* *E480*
654 Delete files from the argument list that match the
655 {pattern}s. {pattern} is used like a file pattern,
656 see |file-pattern|. "%" can be used to delete the
657 current entry.
658 This command keeps the currently edited file, also
659 when it's deleted from the argument list.
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +0000660 Example: >
661 :argdel *.obj
662< {not in Vi} {not available when compiled without the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000663 |+listcmds| feature}
664
Bram Moolenaared32d942014-12-06 23:33:00 +0100665:[range]argd[elete] Delete the {range} files from the argument list.
666 Example: >
667 :10,$argdel
668< Deletes arguments 10 and further, keeping 1-9. >
669 :$argd
670< Deletes just the last one. >
671 :argd
672 :.argd
673< Deletes the current argument. >
674 :%argd
675< Removes all the files from the arglist.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000676 When the last number in the range is too high, up to
Bram Moolenaared32d942014-12-06 23:33:00 +0100677 the last argument is deleted.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000678 {not in Vi} {not available when compiled without the
679 |+listcmds| feature}
680
681 *:argu* *:argument*
682:[count]argu[ment] [count] [++opt] [+cmd]
683 Edit file [count] in the argument list. When [count]
684 is omitted the current entry is used. This fails
685 when changes have been made and Vim does not want to
686 |abandon| the current buffer.
687 Also see |++opt| and |+cmd|.
688 {not in Vi} {not available when compiled without the
689 |+listcmds| feature}
690
691:[count]argu[ment]! [count] [++opt] [+cmd]
692 Edit file [count] in the argument list, discard any
693 changes to the current buffer. When [count] is
694 omitted the current entry is used.
695 Also see |++opt| and |+cmd|.
696 {not in Vi} {not available when compiled without the
697 |+listcmds| feature}
698
699:[count]n[ext] [++opt] [+cmd] *:n* *:ne* *:next* *E165* *E163*
700 Edit [count] next file. This fails when changes have
701 been made and Vim does not want to |abandon| the
702 current buffer. Also see |++opt| and |+cmd|. {Vi: no
703 count or ++opt}.
704
705:[count]n[ext]! [++opt] [+cmd]
706 Edit [count] next file, discard any changes to the
707 buffer. Also see |++opt| and |+cmd|. {Vi: no count
708 or ++opt}.
709
710:n[ext] [++opt] [+cmd] {arglist} *:next_f*
711 Same as |:args_f|.
712
713:n[ext]! [++opt] [+cmd] {arglist}
714 Same as |:args_f!|.
715
716:[count]N[ext] [count] [++opt] [+cmd] *:Next* *:N* *E164*
717 Edit [count] previous file in argument list. This
718 fails when changes have been made and Vim does not
719 want to |abandon| the current buffer.
720 Also see |++opt| and |+cmd|. {Vi: no count or ++opt}.
721
722:[count]N[ext]! [count] [++opt] [+cmd]
723 Edit [count] previous file in argument list. Discard
724 any changes to the buffer. Also see |++opt| and
725 |+cmd|. {Vi: no count or ++opt}.
726
727:[count]prev[ious] [count] [++opt] [+cmd] *:prev* *:previous*
728 Same as :Next. Also see |++opt| and |+cmd|. {Vi:
729 only in some versions}
730
731 *:rew* *:rewind*
732:rew[ind] [++opt] [+cmd]
733 Start editing the first file in the argument list.
734 This fails when changes have been made and Vim does
735 not want to |abandon| the current buffer.
736 Also see |++opt| and |+cmd|. {Vi: no ++opt}
737
738:rew[ind]! [++opt] [+cmd]
739 Start editing the first file in the argument list.
740 Discard any changes to the buffer. Also see |++opt|
741 and |+cmd|. {Vi: no ++opt}
742
743 *:fir* *:first*
744:fir[st][!] [++opt] [+cmd]
745 Other name for ":rewind". {not in Vi}
746
747 *:la* *:last*
748:la[st] [++opt] [+cmd]
749 Start editing the last file in the argument list.
750 This fails when changes have been made and Vim does
751 not want to |abandon| the current buffer.
752 Also see |++opt| and |+cmd|. {not in Vi}
753
754:la[st]! [++opt] [+cmd]
755 Start editing the last file in the argument list.
756 Discard any changes to the buffer. Also see |++opt|
757 and |+cmd|. {not in Vi}
758
759 *:wn* *:wnext*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000760:[count]wn[ext] [++opt]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000761 Write current file and start editing the [count]
762 next file. Also see |++opt| and |+cmd|. {not in Vi}
763
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000764:[count]wn[ext] [++opt] {file}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000765 Write current file to {file} and start editing the
766 [count] next file, unless {file} already exists and
767 the 'writeany' option is off. Also see |++opt| and
768 |+cmd|. {not in Vi}
769
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000770:[count]wn[ext]! [++opt] {file}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000771 Write current file to {file} and start editing the
772 [count] next file. Also see |++opt| and |+cmd|. {not
773 in Vi}
774
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000775:[count]wN[ext][!] [++opt] [file] *:wN* *:wNext*
776:[count]wp[revious][!] [++opt] [file] *:wp* *:wprevious*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000777 Same as :wnext, but go to previous file instead of
778 next. {not in Vi}
779
780The [count] in the commands above defaults to one. For some commands it is
781possible to use two counts. The last one (rightmost one) is used.
782
783If no [+cmd] argument is present, the cursor is positioned at the last known
784cursor position for the file. If 'startofline' is set, the cursor will be
785positioned at the first non-blank in the line, otherwise the last know column
786is used. If there is no last known cursor position the cursor will be in the
787first line (the last line in Ex mode).
788
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000789 *{arglist}*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000790The wildcards in the argument list are expanded and the file names are sorted.
791Thus you can use the command "vim *.c" to edit all the C files. From within
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000792Vim the command ":n *.c" does the same.
793
794White space is used to separate file names. Put a backslash before a space or
Bram Moolenaar9e368db2007-05-12 13:25:01 +0000795tab to include it in a file name. E.g., to edit the single file "foo bar": >
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000796 :next foo\ bar
797
798On Unix and a few other systems you can also use backticks, for example: >
799 :next `find . -name \\*.c -print`
Bram Moolenaar071d4272004-06-13 20:20:40 +0000800The backslashes before the star are required to prevent "*.c" to be expanded
801by the shell before executing the find program.
802
803 *arglist-position*
804When there is an argument list you can see which file you are editing in the
805title of the window (if there is one and 'title' is on) and with the file
806message you get with the "CTRL-G" command. You will see something like
807 (file 4 of 11)
808If 'shortmess' contains 'f' it will be
809 (4 of 11)
810If you are not really editing the file at the current position in the argument
811list it will be
812 (file (4) of 11)
813This means that you are position 4 in the argument list, but not editing the
814fourth file in the argument list. This happens when you do ":e file".
815
816
817LOCAL ARGUMENT LIST
818
819{not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +0200820{not available when compiled without the |+windows| or |+listcmds| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000821
822 *:arglocal*
823:argl[ocal] Make a local copy of the global argument list.
824 Doesn't start editing another file.
825
826:argl[ocal][!] [++opt] [+cmd] {arglist}
827 Define a new argument list, which is local to the
828 current window. Works like |:args_f| otherwise.
829
830 *:argglobal*
831:argg[lobal] Use the global argument list for the current window.
832 Doesn't start editing another file.
833
834:argg[lobal][!] [++opt] [+cmd] {arglist}
835 Use the global argument list for the current window.
836 Define a new global argument list like |:args_f|.
837 All windows using the global argument list will see
838 this new list.
839
840There can be several argument lists. They can be shared between windows.
841When they are shared, changing the argument list in one window will also
842change it in the other window.
843
844When a window is split the new window inherits the argument list from the
845current window. The two windows then share this list, until one of them uses
846|:arglocal| or |:argglobal| to use another argument list.
847
848
849USING THE ARGUMENT LIST
850
851 *:argdo*
Bram Moolenaara162bc52015-01-07 16:54:21 +0100852:[range]argdo[!] {cmd} Execute {cmd} for each file in the argument list or
853 if [range] is specified only for arguments in that
854 range. It works like doing this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000855 :rewind
856 :{cmd}
857 :next
858 :{cmd}
859 etc.
860< When the current file can't be |abandon|ed and the [!]
861 is not present, the command fails.
862 When an error is detected on one file, further files
863 in the argument list will not be visited.
864 The last file in the argument list (or where an error
865 occurred) becomes the current file.
866 {cmd} can contain '|' to concatenate several commands.
867 {cmd} must not change the argument list.
868 Note: While this command is executing, the Syntax
869 autocommand event is disabled by adding it to
870 'eventignore'. This considerably speeds up editing
871 each file.
872 {not in Vi} {not available when compiled without the
873 |+listcmds| feature}
Bram Moolenaaraa23b372015-09-08 18:46:31 +0200874 Also see |:windo|, |:tabdo|, |:bufdo|, |:cdo|, |:ldo|,
875 |:cfdo| and |:lfdo|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000876
877Example: >
878 :args *.c
879 :argdo set ff=unix | update
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100880This sets the 'fileformat' option to "unix" and writes the file if it is now
Bram Moolenaar071d4272004-06-13 20:20:40 +0000881changed. This is done for all *.c files.
882
883Example: >
884 :args *.[ch]
885 :argdo %s/\<my_foo\>/My_Foo/ge | update
886This changes the word "my_foo" to "My_Foo" in all *.c and *.h files. The "e"
887flag is used for the ":substitute" command to avoid an error for files where
888"my_foo" isn't used. ":update" writes the file only if changes were made.
889
890==============================================================================
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00008914. Writing *writing* *save-file*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000892
893Note: When the 'write' option is off, you are not able to write any file.
894
895 *:w* *:write*
896 *E502* *E503* *E504* *E505*
Bram Moolenaar9964e462007-05-05 17:54:07 +0000897 *E512* *E514* *E667* *E796*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000898:w[rite] [++opt] Write the whole buffer to the current file. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000899 the normal way to save changes to a file. It fails
900 when the 'readonly' option is set or when there is
901 another reason why the file can't be written.
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000902 For ++opt see |++opt|, but only ++bin, ++nobin, ++ff
903 and ++enc are effective.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000904
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000905:w[rite]! [++opt] Like ":write", but forcefully write when 'readonly' is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000906 set or there is another reason why writing was
907 refused.
908 Note: This may change the permission and ownership of
909 the file and break (symbolic) links. Add the 'W' flag
910 to 'cpoptions' to avoid this.
911
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000912:[range]w[rite][!] [++opt]
913 Write the specified lines to the current file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000914 is unusual, because the file will not contain all
915 lines in the buffer.
916
917 *:w_f* *:write_f*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000918:[range]w[rite] [++opt] {file}
919 Write the specified lines to {file}, unless it
Bram Moolenaar071d4272004-06-13 20:20:40 +0000920 already exists and the 'writeany' option is off.
921
922 *:w!*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000923:[range]w[rite]! [++opt] {file}
924 Write the specified lines to {file}. Overwrite an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000925 existing file.
926
927 *:w_a* *:write_a* *E494*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000928:[range]w[rite][!] [++opt] >>
929 Append the specified lines to the current file.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000930
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000931:[range]w[rite][!] [++opt] >> {file}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000932 Append the specified lines to {file}. '!' forces the
933 write even if file does not exist.
934
935 *:w_c* *:write_c*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000936:[range]w[rite] [++opt] !{cmd}
937 Execute {cmd} with [range] lines as standard input
Bram Moolenaar071d4272004-06-13 20:20:40 +0000938 (note the space in front of the '!'). {cmd} is
939 executed like with ":!{cmd}", any '!' is replaced with
940 the previous command |:!|.
941
Bram Moolenaar5c4e21c2004-10-12 19:54:52 +0000942The default [range] for the ":w" command is the whole buffer (1,$). If you
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000943write the whole buffer, it is no longer considered changed. When you
944write it to a different file with ":w somefile" it depends on the "+" flag in
945'cpoptions'. When included, the write command will reset the 'modified' flag,
946even though the buffer itself may still be different from its file.
Bram Moolenaar5c4e21c2004-10-12 19:54:52 +0000947
Bram Moolenaar071d4272004-06-13 20:20:40 +0000948If a file name is given with ":w" it becomes the alternate file. This can be
949used, for example, when the write fails and you want to try again later with
950":w #". This can be switched off by removing the 'A' flag from the
951'cpoptions' option.
952
953 *:sav* *:saveas*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000954:sav[eas][!] [++opt] {file}
955 Save the current buffer under the name {file} and set
Bram Moolenaar071d4272004-06-13 20:20:40 +0000956 the filename of the current buffer to {file}. The
957 previous name is used for the alternate file name.
958 The [!] is needed to overwrite an existing file.
Bram Moolenaar2d3f4892006-01-20 23:02:51 +0000959 When 'filetype' is empty filetype detection is done
960 with the new name, before the file is written.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000961 When the write was successful 'readonly' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000962 {not in Vi}
963
964 *:up* *:update*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000965:[range]up[date][!] [++opt] [>>] [file]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000966 Like ":write", but only write when the buffer has been
967 modified. {not in Vi}
968
969
970WRITING WITH MULTIPLE BUFFERS *buffer-write*
971
972 *:wa* *:wall*
973:wa[ll] Write all changed buffers. Buffers without a file
974 name or which are readonly are not written. {not in
975 Vi}
976
977:wa[ll]! Write all changed buffers, even the ones that are
978 readonly. Buffers without a file name are not
979 written. {not in Vi}
980
981
982Vim will warn you if you try to overwrite a file that has been changed
983elsewhere. See |timestamp|.
984
985 *backup* *E207* *E506* *E507* *E508* *E509* *E510*
986If you write to an existing file (but do not append) while the 'backup',
987'writebackup' or 'patchmode' option is on, a backup of the original file is
988made. The file is either copied or renamed (see 'backupcopy'). After the
989file has been successfully written and when the 'writebackup' option is on and
990the 'backup' option is off, the backup file is deleted. When the 'patchmode'
991option is on the backup file may be renamed.
992
993 *backup-table*
994'backup' 'writebackup' action ~
995 off off no backup made
996 off on backup current file, deleted afterwards (default)
997 on off delete old backup, backup current file
998 on on delete old backup, backup current file
999
1000When the 'backupskip' pattern matches with the name of the file which is
1001written, no backup file is made. The values of 'backup' and 'writebackup' are
1002ignored then.
1003
1004When the 'backup' option is on, an old backup file (with the same name as the
1005new backup file) will be deleted. If 'backup' is not set, but 'writebackup'
1006is set, an existing backup file will not be deleted. The backup file that is
1007made while the file is being written will have a different name.
1008
1009On some filesystems it's possible that in a crash you lose both the backup and
1010the newly written file (it might be there but contain bogus data). In that
1011case try recovery, because the swap file is synced to disk and might still be
1012there. |:recover|
1013
1014The directories given with the 'backupdir' option is used to put the backup
1015file in. (default: same directory as the written file).
1016
1017Whether the backup is a new file, which is a copy of the original file, or the
1018original file renamed depends on the 'backupcopy' option. See there for an
1019explanation of when the copy is made and when the file is renamed.
1020
1021If the creation of a backup file fails, the write is not done. If you want
1022to write anyway add a '!' to the command.
1023
Bram Moolenaard58e9292011-02-09 17:07:58 +01001024 *write-permissions*
1025When writing a new file the permissions are read-write. For unix the mask is
10260666 with additionally umask applied. When writing a file that was read Vim
1027will preserve the permissions, but clear the s-bit.
1028
Bram Moolenaar071d4272004-06-13 20:20:40 +00001029 *write-readonly*
1030When the 'cpoptions' option contains 'W', Vim will refuse to overwrite a
1031readonly file. When 'W' is not present, ":w!" will overwrite a readonly file,
1032if the system allows it (the directory must be writable).
1033
1034 *write-fail*
1035If the writing of the new file fails, you have to be careful not to lose
1036your changes AND the original file. If there is no backup file and writing
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001037the new file failed, you have already lost the original file! DON'T EXIT VIM
1038UNTIL YOU WRITE OUT THE FILE! If a backup was made, it is put back in place
Bram Moolenaar071d4272004-06-13 20:20:40 +00001039of the original file (if possible). If you exit Vim, and lose the changes
1040you made, the original file will mostly still be there. If putting back the
1041original file fails, there will be an error message telling you that you
1042lost the original file.
1043
1044 *DOS-format-write*
1045If the 'fileformat' is "dos", <CR> <NL> is used for <EOL>. This is default
1046for MS-DOS, Win32 and OS/2. On other systems the message "[dos format]" is
1047shown to remind you that an unusual <EOL> was used.
1048 *Unix-format-write*
1049If the 'fileformat' is "unix", <NL> is used for <EOL>. On MS-DOS, Win32 and
1050OS/2 the message "[unix format]" is shown.
1051 *Mac-format-write*
1052If the 'fileformat' is "mac", <CR> is used for <EOL>. On non-Mac systems the
1053message "[mac format]" is shown.
1054
1055See also |file-formats| and the 'fileformat' and 'fileformats' options.
1056
1057 *ACL*
1058ACL stands for Access Control List. It is an advanced way to control access
1059rights for a file. It is used on new MS-Windows and Unix systems, but only
1060when the filesystem supports it.
1061 Vim attempts to preserve the ACL info when writing a file. The backup file
1062will get the ACL info of the original file.
1063 The ACL info is also used to check if a file is read-only (when opening the
1064file).
1065
1066 *read-only-share*
1067When MS-Windows shares a drive on the network it can be marked as read-only.
1068This means that even if the file read-only attribute is absent, and the ACL
1069settings on NT network shared drives allow writing to the file, you can still
1070not write to the file. Vim on Win32 platforms will detect read-only network
1071drives and will mark the file as read-only. You will not be able to override
1072it with |:write|.
1073
1074 *write-device*
1075When the file name is actually a device name, Vim will not make a backup (that
1076would be impossible). You need to use "!", since the device already exists.
1077Example for Unix: >
1078 :w! /dev/lpt0
1079and for MS-DOS or MS-Windows: >
1080 :w! lpt0
1081For Unix a device is detected when the name doesn't refer to a normal file or
1082a directory. A fifo or named pipe also looks like a device to Vim.
1083For MS-DOS and MS-Windows the device is detected by its name:
1084 AUX
1085 CON
1086 CLOCK$
1087 NUL
1088 PRN
1089 COMn n=1,2,3... etc
1090 LPTn n=1,2,3... etc
1091The names can be in upper- or lowercase.
1092
1093==============================================================================
Bram Moolenaar1cd871b2004-12-19 22:46:22 +000010945. Writing and quitting *write-quit*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001095
1096 *:q* *:quit*
1097:q[uit] Quit the current window. Quit Vim if this is the last
1098 window. This fails when changes have been made and
1099 Vim refuses to |abandon| the current buffer, and when
1100 the last file in the argument list has not been
1101 edited.
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00001102 If there are other tab pages and quitting the last
1103 window in the current tab page the current tab page is
1104 closed |tab-page|.
Bram Moolenaar30b65812012-07-12 22:01:11 +02001105 Triggers the |QuitPre| autocommand event.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001106
1107:conf[irm] q[uit] Quit, but give prompt when changes have been made, or
1108 the last file in the argument list has not been
1109 edited. See |:confirm| and 'confirm'. {not in Vi}
1110
Bram Moolenaarfa735342016-01-03 22:14:44 +01001111:q[uit]! Quit without writing, also when the current buffer has
Bram Moolenaar027387f2016-01-02 22:25:52 +01001112 changes. If this is the last window and there is a
1113 modified hidden buffer, the current buffer is
1114 abandoned and the first changed hidden buffer becomes
Bram Moolenaar2f3b5102014-11-19 18:54:17 +01001115 the current buffer.
1116 Use ":qall!" to exit always.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001117
1118:cq[uit] Quit always, without writing, and return an error
1119 code. See |:cq|. Used for Manx's QuickFix mode (see
1120 |quickfix|). {not in Vi}
1121
1122 *:wq*
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001123:wq [++opt] Write the current file and quit. Writing fails when
Bram Moolenaar071d4272004-06-13 20:20:40 +00001124 the file is read-only or the buffer does not have a
1125 name. Quitting fails when the last file in the
1126 argument list has not been edited.
1127
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001128:wq! [++opt] Write the current file and quit. Writing fails when
Bram Moolenaar071d4272004-06-13 20:20:40 +00001129 the current buffer does not have a name.
1130
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001131:wq [++opt] {file} Write to {file} and quit. Quitting fails when the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001132 last file in the argument list has not been edited.
1133
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001134:wq! [++opt] {file} Write to {file} and quit.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001135
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001136:[range]wq[!] [++opt] [file]
1137 Same as above, but only write the lines in [range].
Bram Moolenaar071d4272004-06-13 20:20:40 +00001138
1139 *:x* *:xit*
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001140:[range]x[it][!] [++opt] [file]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001141 Like ":wq", but write only when changes have been
1142 made.
1143 When 'hidden' is set and there are more windows, the
1144 current buffer becomes hidden, after writing the file.
1145
1146 *:exi* *:exit*
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001147:[range]exi[t][!] [++opt] [file]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001148 Same as :xit.
1149
1150 *ZZ*
1151ZZ Write current file, if modified, and quit (same as
1152 ":x"). (Note: If there are several windows for the
1153 current file, the file is written if it was modified
1154 and the window is closed).
1155
1156 *ZQ*
1157ZQ Quit without checking for changes (same as ":q!").
1158 {not in Vi}
1159
1160MULTIPLE WINDOWS AND BUFFERS *window-exit*
1161
1162 *:qa* *:qall*
1163:qa[ll] Exit Vim, unless there are some buffers which have been
1164 changed. (Use ":bmod" to go to the next modified buffer).
1165 When 'autowriteall' is set all changed buffers will be
1166 written, like |:wqall|. {not in Vi}
1167
1168:conf[irm] qa[ll]
1169 Exit Vim. Bring up a prompt when some buffers have been
1170 changed. See |:confirm|. {not in Vi}
1171
1172:qa[ll]! Exit Vim. Any changes to buffers are lost. {not in Vi}
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00001173 Also see |:cquit|, it does the same but exits with a non-zero
1174 value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001175
1176 *:quita* *:quitall*
1177:quita[ll][!] Same as ":qall". {not in Vi}
1178
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001179:wqa[ll] [++opt] *:wqa* *:wqall* *:xa* *:xall*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001180:xa[ll] Write all changed buffers and exit Vim. If there are buffers
1181 without a file name, which are readonly or which cannot be
1182 written for another reason, Vim will not quit. {not in Vi}
1183
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001184:conf[irm] wqa[ll] [++opt]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001185:conf[irm] xa[ll]
1186 Write all changed buffers and exit Vim. Bring up a prompt
1187 when some buffers are readonly or cannot be written for
1188 another reason. See |:confirm|. {not in Vi}
1189
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001190:wqa[ll]! [++opt]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001191:xa[ll]! Write all changed buffers, even the ones that are readonly,
1192 and exit Vim. If there are buffers without a file name or
1193 which cannot be written for another reason, Vim will not quit.
1194 {not in Vi}
1195
1196==============================================================================
Bram Moolenaar1cd871b2004-12-19 22:46:22 +000011976. Dialogs *edit-dialogs*
1198
1199 *:confirm* *:conf*
1200:conf[irm] {command} Execute {command}, and use a dialog when an
1201 operation has to be confirmed. Can be used on the
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02001202 |:q|, |:qa| and |:w| commands (the latter to override
1203 a read-only setting), and any other command that can
1204 fail in such a way, such as |:only|, |:buffer|,
1205 |:bdelete|, etc.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001206
1207Examples: >
1208 :confirm w foo
1209< Will ask for confirmation when "foo" already exists. >
1210 :confirm q
1211< Will ask for confirmation when there are changes. >
1212 :confirm qa
1213< If any modified, unsaved buffers exist, you will be prompted to save
1214 or abandon each one. There are also choices to "save all" or "abandon
1215 all".
1216
1217If you want to always use ":confirm", set the 'confirm' option.
1218
1219 *:browse* *:bro* *E338* *E614* *E615* *E616* *E578*
1220:bro[wse] {command} Open a file selection dialog for an argument to
1221 {command}. At present this works for |:e|, |:w|,
Bram Moolenaar9028b102010-07-11 16:58:51 +02001222 |:wall|, |:wq|, |:wqall|, |:x|, |:xall|, |:exit|,
1223 |:view|, |:sview|, |:r|, |:saveas|, |:sp|, |:mkexrc|,
1224 |:mkvimrc|, |:mksession|, |:mkview|, |:split|,
1225 |:vsplit|, |:tabe|, |:tabnew|, |:cfile|, |:cgetfile|,
1226 |:caddfile|, |:lfile|, |:lgetfile|, |:laddfile|,
1227 |:diffsplit|, |:diffpatch|, |:open|, |:pedit|,
1228 |:redir|, |:source|, |:update|, |:visual|, |:vsplit|,
1229 and |:qall| if 'confirm' is set.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001230 {only in Win32, Athena, Motif, GTK and Mac GUI}
1231 When ":browse" is not possible you get an error
1232 message. If the |+browse| feature is missing or the
1233 {command} doesn't support browsing, the {command} is
1234 executed without a dialog.
1235 ":browse set" works like |:options|.
Bram Moolenaar9028b102010-07-11 16:58:51 +02001236 See also |:oldfiles| for ":browse oldfiles".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001237
1238The syntax is best shown via some examples: >
1239 :browse e $vim/foo
1240< Open the browser in the $vim/foo directory, and edit the
1241 file chosen. >
1242 :browse e
1243< Open the browser in the directory specified with 'browsedir',
1244 and edit the file chosen. >
1245 :browse w
1246< Open the browser in the directory of the current buffer,
1247 with the current buffer filename as default, and save the
1248 buffer under the filename chosen. >
1249 :browse w C:/bar
1250< Open the browser in the C:/bar directory, with the current
1251 buffer filename as default, and save the buffer under the
1252 filename chosen.
1253Also see the |'browsedir'| option.
1254For versions of Vim where browsing is not supported, the command is executed
1255unmodified.
1256
1257 *browsefilter*
Bram Moolenaar30b65812012-07-12 22:01:11 +02001258For MS Windows and GTK, you can modify the filters that are used in the browse
1259dialog. By setting the g:browsefilter or b:browsefilter variables, you can
1260change the filters globally or locally to the buffer. The variable is set to
1261a string in the format "{filter label}\t{pattern};{pattern}\n" where {filter
1262label} is the text that appears in the "Files of Type" comboBox, and {pattern}
1263is the pattern which filters the filenames. Several patterns can be given,
1264separated by ';'.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001265
1266For Motif the same format is used, but only the very first pattern is actually
1267used (Motif only offers one pattern, but you can edit it).
1268
1269For example, to have only Vim files in the dialog, you could use the following
1270command: >
1271
Bram Moolenaar30b65812012-07-12 22:01:11 +02001272 let g:browsefilter = "Vim Scripts\t*.vim\nVim Startup Files\t*vimrc\n"
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001273
1274You can override the filter setting on a per-buffer basis by setting the
1275b:browsefilter variable. You would most likely set b:browsefilter in a
1276filetype plugin, so that the browse dialog would contain entries related to
1277the type of file you are currently editing. Disadvantage: This makes it
1278difficult to start editing a file of a different type. To overcome this, you
1279may want to add "All Files\t*.*\n" as the final filter, so that the user can
1280still access any desired file.
1281
Bram Moolenaar30b65812012-07-12 22:01:11 +02001282To avoid setting browsefilter when Vim does not actually support it, you can
1283use has("browsefilter"): >
1284
1285 if has("browsefilter")
1286 let g:browsefilter = "whatever"
1287 endif
1288
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001289==============================================================================
12907. The current directory *current-directory*
1291
1292You may use the |:cd| and |:lcd| commands to change to another directory, so
1293you will not have to type that directory name in front of the file names. It
1294also makes a difference for executing external commands, e.g. ":!ls".
1295
Bram Moolenaardf177f62005-02-22 08:39:57 +00001296Changing directory fails when the current buffer is modified, the '.' flag is
1297present in 'cpoptions' and "!" is not used in the command.
1298
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00001299 *:cd* *E747* *E472*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001300:cd[!] On non-Unix systems: Print the current directory
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001301 name. On Unix systems: Change the current directory
1302 to the home directory. Use |:pwd| to print the
1303 current directory on all systems.
1304
Bram Moolenaardf177f62005-02-22 08:39:57 +00001305:cd[!] {path} Change the current directory to {path}.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001306 If {path} is relative, it is searched for in the
1307 directories listed in |'cdpath'|.
1308 Does not change the meaning of an already opened file,
1309 because its full path name is remembered. Files from
1310 the |arglist| may change though!
1311 On MS-DOS this also changes the active drive.
1312 To change to the directory of the current file: >
1313 :cd %:h
1314<
1315 *:cd-* *E186*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001316:cd[!] - Change to the previous current directory (before the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001317 previous ":cd {path}" command). {not in Vi}
1318
1319 *:chd* *:chdir*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001320:chd[ir][!] [path] Same as |:cd|.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001321
1322 *:lc* *:lcd*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001323:lc[d][!] {path} Like |:cd|, but only set the current directory for the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001324 current window. The current directory for other
1325 windows is not changed. {not in Vi}
1326
1327 *:lch* *:lchdir*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001328:lch[dir][!] Same as |:lcd|. {not in Vi}
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001329
1330 *:pw* *:pwd* *E187*
1331:pw[d] Print the current directory name. {Vi: no pwd}
1332 Also see |getcwd()|.
1333
1334So long as no |:lcd| command has been used, all windows share the same current
1335directory. Using a command to jump to another window doesn't change anything
1336for the current directory.
1337When a |:lcd| command has been used for a window, the specified directory
1338becomes the current directory for that window. Windows where the |:lcd|
1339command has not been used stick to the global current directory. When jumping
1340to another window the current directory will become the last specified local
1341current directory. If none was specified, the global current directory is
1342used.
1343When a |:cd| command is used, the current window will lose his local current
1344directory and will use the global current directory from now on.
1345
1346After using |:cd| the full path name will be used for reading and writing
1347files. On some networked file systems this may cause problems. The result of
1348using the full path name is that the file names currently in use will remain
1349referring to the same file. Example: If you have a file a:test and a
1350directory a:vim the commands ":e test" ":cd vim" ":w" will overwrite the file
1351a:test and not write a:vim/test. But if you do ":w test" the file a:vim/test
1352will be written, because you gave a new file name and did not refer to a
1353filename before the ":cd".
1354
1355==============================================================================
Bram Moolenaar071d4272004-06-13 20:20:40 +000013568. Editing binary files *edit-binary*
1357
1358Although Vim was made to edit text files, it is possible to edit binary
1359files. The |-b| Vim argument (b for binary) makes Vim do file I/O in binary
1360mode, and sets some options for editing binary files ('binary' on, 'textwidth'
1361to 0, 'modeline' off, 'expandtab' off). Setting the 'binary' option has the
1362same effect. Don't forget to do this before reading the file.
1363
1364There are a few things to remember when editing binary files:
1365- When editing executable files the number of characters must not change.
1366 Use only the "R" or "r" command to change text. Do not delete characters
1367 with "x" or by backspacing.
1368- Set the 'textwidth' option to 0. Otherwise lines will unexpectedly be
1369 split in two.
1370- When there are not many <EOL>s, the lines will become very long. If you
1371 want to edit a line that does not fit on the screen reset the 'wrap' option.
1372 Horizontal scrolling is used then. If a line becomes too long (more than
1373 about 32767 characters on the Amiga, much more on 32-bit systems, see
1374 |limits|) you cannot edit that line. The line will be split when reading
1375 the file. It is also possible that you get an "out of memory" error when
1376 reading the file.
1377- Make sure the 'binary' option is set BEFORE loading the
1378 file. Otherwise both <CR> <NL> and <NL> are considered to end a line
1379 and when the file is written the <NL> will be replaced with <CR> <NL>.
1380- <Nul> characters are shown on the screen as ^@. You can enter them with
1381 "CTRL-V CTRL-@" or "CTRL-V 000" {Vi cannot handle <Nul> characters in the
1382 file}
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +02001383- To insert a <NL> character in the file split a line. When writing the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001384 buffer to a file a <NL> will be written for the <EOL>.
1385- Vim normally appends an <EOL> at the end of the file if there is none.
1386 Setting the 'binary' option prevents this. If you want to add the final
1387 <EOL>, set the 'endofline' option. You can also read the value of this
1388 option to see if there was an <EOL> for the last line (you cannot see this
1389 in the text).
1390
1391==============================================================================
13929. Encryption *encryption*
1393
1394Vim is able to write files encrypted, and read them back. The encrypted text
1395cannot be read without the right key.
Bram Moolenaar996343d2010-07-04 22:20:21 +02001396{only available when compiled with the |+cryptv| feature} *E833*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001397
Bram Moolenaar81af9252010-12-10 20:35:50 +01001398The text in the swap file and the undo file is also encrypted. *E843*
Bram Moolenaar07d87792014-07-19 14:04:47 +02001399However, this is done block-by-block and may reduce the time needed to crack a
1400password. You can disable the swap file, but then a crash will cause you to
1401lose your work. The undo file can be disabled without much disadvantage. >
1402 :set noundofile
1403 :noswapfile edit secrets
Bram Moolenaara8ffcbb2010-06-21 06:15:46 +02001404
1405Note: The text in memory is not encrypted. A system administrator may be able
1406to see your text while you are editing it. When filtering text with
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001407":!filter" or using ":w !command" the text is also not encrypted, this may
1408reveal it to others. The 'viminfo' file is not encrypted.
1409
1410You could do this to edit very secret text: >
1411 :set noundofile viminfo=
1412 :noswapfile edit secrets.txt
Bram Moolenaar88774fd2015-08-25 19:52:04 +02001413Keep in mind that without a swap file you risk losing your work in the event
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +02001414of a crash or a power failure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001415
1416WARNING: If you make a typo when entering the key and then write the file and
1417exit, the text will be lost!
1418
1419The normal way to work with encryption, is to use the ":X" command, which will
1420ask you to enter a key. A following write command will use that key to
1421encrypt the file. If you later edit the same file, Vim will ask you to enter
1422a key. If you type the same key as that was used for writing, the text will
1423be readable again. If you use a wrong key, it will be a mess.
1424
1425 *:X*
1426:X Prompt for an encryption key. The typing is done without showing the
1427 actual text, so that someone looking at the display won't see it.
1428 The typed key is stored in the 'key' option, which is used to encrypt
1429 the file when it is written. The file will remain unchanged until you
1430 write it. See also |-x|.
1431
1432The value of the 'key' options is used when text is written. When the option
1433is not empty, the written file will be encrypted, using the value as the
1434encryption key. A magic number is prepended, so that Vim can recognize that
1435the file is encrypted.
1436
1437To disable the encryption, reset the 'key' option to an empty value: >
1438 :set key=
1439
Bram Moolenaar49771f42010-07-20 17:32:38 +02001440You can use the 'cryptmethod' option to select the type of encryption, use one
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001441of these: >
1442 :setlocal cm=zip " weak method, backwards compatible
1443 :setlocal cm=blowfish " method with flaws
1444 :setlocal cm=blowfish2 " medium strong method
1445
Bram Moolenaar49771f42010-07-20 17:32:38 +02001446Do this before writing the file. When reading an encrypted file it will be
1447set automatically to the method used when that file was written. You can
1448change 'cryptmethod' before writing that file to change the method.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001449
Bram Moolenaarc2299672014-11-13 14:25:38 +01001450To set the default method, used for new files, use this in your |vimrc|
1451file: >
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001452 set cm=blowfish2
Bram Moolenaarc2299672014-11-13 14:25:38 +01001453Using "blowfish2" is highly recommended. Only use another method if you
1454must use an older Vim version that does not support it.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001455
Bram Moolenaar662db672011-03-22 14:05:35 +01001456The message given for reading and writing a file will show "[crypted]" when
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001457using zip, "[blowfish]" when using blowfish, etc.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02001458
Bram Moolenaara3ff49f2010-05-30 22:48:02 +02001459When writing an undo file, the same key and method will be used for the text
1460in the undo file. |persistent-undo|.
1461
Bram Moolenaar85084ef2016-01-17 22:26:33 +01001462To test for blowfish support you can use these conditions: >
1463 has('crypt-blowfish')
1464 has('crypt-blowfish2')
1465This works since Vim 7.4.1099 while blowfish support was added earlier.
1466Thus the condition failing doesn't mean blowfish is not supported. You can
1467test for blowfish with: >
1468 v:version >= 703
1469And for blowfish2 with: >
1470 v:version > 704 || (v:version == 704 && has('patch401'))
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01001471If you are sure Vim includes patch 7.4.237 a simpler check is: >
1472 has('patch-7.4.401')
Bram Moolenaar85084ef2016-01-17 22:26:33 +01001473<
Bram Moolenaarfa7584c2010-05-19 21:57:45 +02001474 *E817* *E818* *E819* *E820*
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02001475When encryption does not work properly, you would be able to write your text
1476to a file and never be able to read it back. Therefore a test is performed to
1477check if the encryption works as expected. If you get one of these errors
1478don't write the file encrypted! You need to rebuild the Vim binary to fix
1479this.
1480
Bram Moolenaar46f9d492010-06-12 20:18:19 +02001481*E831* This is an internal error, "cannot happen". If you can reproduce it,
Bram Moolenaar56be9502010-06-06 14:20:26 +02001482please report to the developers.
1483
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02001484When reading a file that has been encrypted and the 'key' option is not empty,
1485it will be used for decryption. If the value is empty, you will be prompted
1486to enter the key. If you don't enter a key, or you enter the wrong key, the
1487file is edited without being decrypted. There is no warning about using the
1488wrong key (this makes brute force methods to find the key more difficult).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001489
1490If want to start reading a file that uses a different key, set the 'key'
1491option to an empty string, so that Vim will prompt for a new one. Don't use
1492the ":set" command to enter the value, other people can read the command over
1493your shoulder.
1494
1495Since the value of the 'key' option is supposed to be a secret, its value can
1496never be viewed. You should not set this option in a vimrc file.
1497
Bram Moolenaar60aad972010-07-21 20:36:22 +02001498An encrypted file can be recognized by the "file" command, if you add these
1499lines to "/etc/magic", "/usr/share/misc/magic" or wherever your system has the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001500"magic" file: >
1501 0 string VimCrypt~ Vim encrypted file
Bram Moolenaarc095b282010-07-20 22:33:34 +02001502 >9 string 01 - "zip" cryptmethod
1503 >9 string 02 - "blowfish" cryptmethod
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001504 >9 string 03 - "blowfish2" cryptmethod
Bram Moolenaar071d4272004-06-13 20:20:40 +00001505
1506Notes:
1507- Encryption is not possible when doing conversion with 'charconvert'.
1508- Text you copy or delete goes to the numbered registers. The registers can
1509 be saved in the .viminfo file, where they could be read. Change your
1510 'viminfo' option to be safe.
1511- Someone can type commands in Vim when you walk away for a moment, he should
1512 not be able to get the key.
1513- If you make a typing mistake when entering the key, you might not be able to
1514 get your text back!
1515- If you type the key with a ":set key=value" command, it can be kept in the
1516 history, showing the 'key' value in a viminfo file.
1517- There is never 100% safety. The encryption in Vim has not been tested for
1518 robustness.
Bram Moolenaar24ea3ba2010-09-19 19:01:21 +02001519- The algorithm used for 'cryptmethod' "zip" is breakable. A 4 character key
1520 in about one hour, a 6 character key in one day (on a Pentium 133 PC). This
1521 requires that you know some text that must appear in the file. An expert
1522 can break it for any key. When the text has been decrypted, this also means
1523 that the key can be revealed, and other files encrypted with the same key
1524 can be decrypted.
1525- Pkzip uses the same encryption as 'cryptmethod' "zip", and US Govt has no
1526 objection to its export. Pkzip's public file APPNOTE.TXT describes this
1527 algorithm in detail.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02001528- The implementation of 'cryptmethod' "blowfish" has a flaw. It is possible
1529 to crack the first 64 bytes of a file and in some circumstances more of the
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02001530 file. Use of it is not recommended, but it's still the strongest method
1531 supported by Vim 7.3 and 7.4. The "zip" method is even weaker.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001532- Vim originates from the Netherlands. That is where the sources come from.
1533 Thus the encryption code is not exported from the USA.
1534
1535==============================================================================
153610. Timestamps *timestamp* *timestamps*
1537
Bram Moolenaare968e362014-05-13 20:23:24 +02001538Vim remembers the modification timestamp, mode and size of a file when you
1539begin editing it. This is used to avoid that you have two different versions
1540of the same file (without you knowing this).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001541
Bram Moolenaare968e362014-05-13 20:23:24 +02001542After a shell command is run (|:!cmd| |suspend| |:read!| |K|) timestamps,
1543file modes and file sizes are compared for all buffers in a window. Vim will
1544run any associated |FileChangedShell| autocommands or display a warning for
1545any files that have changed. In the GUI this happens when Vim regains input
1546focus.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001547
1548 *E321* *E462*
1549If you want to automatically reload a file when it has been changed outside of
1550Vim, set the 'autoread' option. This doesn't work at the moment you write the
1551file though, only when the file wasn't changed inside of Vim.
1552
1553Note that if a FileChangedShell autocommand is defined you will not get a
1554warning message or prompt. The autocommand is expected to handle this.
1555
Bram Moolenaar10de2da2005-01-27 14:33:00 +00001556There is no warning for a directory (e.g., with |netrw-browse|). But you do
1557get warned if you started editing a new file and it was created as a directory
1558later.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001559
1560When Vim notices the timestamp of a file has changed, and the file is being
1561edited in a buffer but has not changed, Vim checks if the contents of the file
1562is equal. This is done by reading the file again (into a hidden buffer, which
1563is immediately deleted again) and comparing the text. If the text is equal,
1564you will get no warning.
1565
1566If you don't get warned often enough you can use the following command.
1567
1568 *:checkt* *:checktime*
1569:checkt[ime] Check if any buffers were changed outside of Vim.
1570 This checks and warns you if you would end up with two
1571 versions of a file.
1572 If this is called from an autocommand, a ":global"
1573 command or is not typed the actual check is postponed
1574 until a moment the side effects (reloading the file)
1575 would be harmless.
1576 Each loaded buffer is checked for its associated file
1577 being changed. If the file was changed Vim will take
1578 action. If there are no changes in the buffer and
1579 'autoread' is set, the buffer is reloaded. Otherwise,
1580 you are offered the choice of reloading the file. If
1581 the file was deleted you get an error message.
1582 If the file previously didn't exist you get a warning
1583 if it exists now.
1584 Once a file has been checked the timestamp is reset,
1585 you will not be warned again.
1586
1587:[N]checkt[ime] {filename}
1588:[N]checkt[ime] [N]
1589 Check the timestamp of a specific buffer. The buffer
1590 may be specified by name, number or with a pattern.
1591
1592
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001593 *E813* *E814*
1594Vim will reload the buffer if you chose to. If a window is visible that
1595contains this buffer, the reloading will happen in the context of this window.
1596Otherwise a special window is used, so that most autocommands will work. You
1597can't close this window. A few other restrictions apply. Best is to make
1598sure nothing happens outside of the current buffer. E.g., setting
1599window-local options may end up in the wrong window. Splitting the window,
1600doing something there and closing it should be OK (if there are no side
1601effects from other autocommands). Closing unrelated windows and buffers will
1602get you into trouble.
1603
Bram Moolenaar071d4272004-06-13 20:20:40 +00001604Before writing a file the timestamp is checked. If it has changed, Vim will
1605ask if you really want to overwrite the file:
1606
1607 WARNING: The file has been changed since reading it!!!
1608 Do you really want to write to it (y/n)?
1609
1610If you hit 'y' Vim will continue writing the file. If you hit 'n' the write is
1611aborted. If you used ":wq" or "ZZ" Vim will not exit, you will get another
1612chance to write the file.
1613
1614The message would normally mean that somebody has written to the file after
1615the edit session started. This could be another person, in which case you
1616probably want to check if your changes to the file and the changes from the
1617other person should be merged. Write the file under another name and check for
1618differences (the "diff" program can be used for this).
1619
1620It is also possible that you modified the file yourself, from another edit
1621session or with another command (e.g., a filter command). Then you will know
1622which version of the file you want to keep.
1623
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001624There is one situation where you get the message while there is nothing wrong:
1625On a Win32 system on the day daylight saving time starts. There is something
1626in the Win32 libraries that confuses Vim about the hour time difference. The
1627problem goes away the next day.
1628
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001629==============================================================================
163011. File Searching *file-searching*
1631
1632{not available when compiled without the |+path_extra| feature}
1633
1634The file searching is currently used for the 'path', 'cdpath' and 'tags'
Bram Moolenaarc236c162008-07-13 17:41:49 +00001635options, for |finddir()| and |findfile()|. Other commands use |wildcards|
1636which is slightly different.
Bram Moolenaar9964e462007-05-05 17:54:07 +00001637
1638There are three different types of searching:
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001639
Bram Moolenaar02743632005-07-25 20:42:36 +000016401) Downward search: *starstar*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001641 Downward search uses the wildcards '*', '**' and possibly others
Bram Moolenaarc236c162008-07-13 17:41:49 +00001642 supported by your operating system. '*' and '**' are handled inside Vim,
1643 so they work on all operating systems. Note that "**" only acts as a
1644 special wildcard when it is at the start of a name.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001645
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00001646 The usage of '*' is quite simple: It matches 0 or more characters. In a
1647 search pattern this would be ".*". Note that the "." is not used for file
1648 searching.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001649
1650 '**' is more sophisticated:
1651 - It ONLY matches directories.
Bram Moolenaarc236c162008-07-13 17:41:49 +00001652 - It matches up to 30 directories deep by default, so you can use it to
1653 search an entire directory tree
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001654 - The maximum number of levels matched can be given by appending a number
1655 to '**'.
1656 Thus '/usr/**2' can match: >
1657 /usr
1658 /usr/include
1659 /usr/include/sys
1660 /usr/include/g++
1661 /usr/lib
1662 /usr/lib/X11
1663 ....
1664< It does NOT match '/usr/include/g++/std' as this would be three
1665 levels.
Bram Moolenaarc236c162008-07-13 17:41:49 +00001666 The allowed number range is 0 ('**0' is removed) to 100
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001667 If the given number is smaller than 0 it defaults to 30, if it's
Bram Moolenaarc236c162008-07-13 17:41:49 +00001668 bigger than 100 then 100 is used. The system also has a limit on the
1669 path length, usually 256 or 1024 bytes.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001670 - '**' can only be at the end of the path or be followed by a path
1671 separator or by a number and a path separator.
1672
1673 You can combine '*' and '**' in any order: >
1674 /usr/**/sys/*
Bram Moolenaarc236c162008-07-13 17:41:49 +00001675 /usr/*tory/sys/**
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001676 /usr/**2/sys/*
1677
16782) Upward search:
1679 Here you can give a directory and then search the directory tree upward for
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001680 a file. You could give stop-directories to limit the upward search. The
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001681 stop-directories are appended to the path (for the 'path' option) or to
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001682 the filename (for the 'tags' option) with a ';'. If you want several
1683 stop-directories separate them with ';'. If you want no stop-directory
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001684 ("search upward till the root directory) just use ';'. >
1685 /usr/include/sys;/usr
1686< will search in: >
1687 /usr/include/sys
1688 /usr/include
1689 /usr
1690<
1691 If you use a relative path the upward search is started in Vim's current
1692 directory or in the directory of the current file (if the relative path
1693 starts with './' and 'd' is not included in 'cpoptions').
1694
1695 If Vim's current path is /u/user_x/work/release and you do >
1696 :set path=include;/u/user_x
1697< and then search for a file with |gf| the file is searched in: >
1698 /u/user_x/work/release/include
1699 /u/user_x/work/include
1700 /u/user_x/include
1701
Bram Moolenaar402d2fe2005-04-15 21:00:38 +000017023) Combined up/downward search:
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001703 If Vim's current path is /u/user_x/work/release and you do >
1704 set path=**;/u/user_x
1705< and then search for a file with |gf| the file is searched in: >
1706 /u/user_x/work/release/**
1707 /u/user_x/work/**
1708 /u/user_x/**
1709<
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001710 BE CAREFUL! This might consume a lot of time, as the search of
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001711 '/u/user_x/**' includes '/u/user_x/work/**' and
1712 '/u/user_x/work/release/**'. So '/u/user_x/work/release/**' is searched
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001713 three times and '/u/user_x/work/**' is searched twice.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001714
1715 In the above example you might want to set path to: >
1716 :set path=**,/u/user_x/**
Bram Moolenaar162bd912010-07-28 22:29:10 +02001717< This searches:
1718 /u/user_x/work/release/** ~
1719 /u/user_x/** ~
1720 This searches the same directories, but in a different order.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001721
Bram Moolenaar162bd912010-07-28 22:29:10 +02001722 Note that completion for ":find", ":sfind", and ":tabfind" commands do not
1723 currently work with 'path' items that contain a url or use the double star
Bram Moolenaar5b435d62012-04-05 17:33:26 +02001724 with depth limiter (/usr/**2) or upward search (;) notations.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001725
1726 vim:tw=78:ts=8:ft=help:norl: