blob: 391220d0012c79e4a3e4f9cad46537d6087ae955 [file] [log] [blame]
Bram Moolenaar32466aa2006-02-24 23:53:04 +00001*editing.txt* For Vim version 7.0aa. Last change: 2006 Feb 24
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Editing files *edit-files*
8
91. Introduction |edit-intro|
102. Editing a file |edit-a-file|
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000113. The argument list |argument-list|
124. Writing |writing|
135. Writing and quitting |write-quit|
146. Dialogs |edit-dialogs|
157. The current directory |current-directory|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000168. Editing binary files |edit-binary|
179. Encryption |encryption|
1810. Timestamps |timestamps|
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001911. File Searching |file-searching|
Bram Moolenaar071d4272004-06-13 20:20:40 +000020
21==============================================================================
221. Introduction *edit-intro*
23
24Editing a file with Vim means:
25
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000261. reading the file into a buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +0000272. changing the buffer with editor commands
283. writing the buffer into a file
29
30 *current-file*
31As long as you don't write the buffer, the original file remains unchanged.
32If you start editing a file (read a file into the buffer), the file name is
Bram Moolenaard4755bb2004-09-02 19:12:26 +000033remembered as the "current file name". This is also known as the name of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +000034current buffer. It can be used with "%" on the command line |:_%|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000035
36 *alternate-file*
37If there already was a current file name, then that one becomes the alternate
Bram Moolenaar1cd871b2004-12-19 22:46:22 +000038file name. It can be used with "#" on the command line |:_#| and you can use
39the |CTRL-^| command to toggle between the current and the alternate file.
40However, the alternate file name is not changed when |:keepalt| is used.
Bram Moolenaard4755bb2004-09-02 19:12:26 +000041
42 *:keepalt* *:keepa*
43:keepalt {cmd} Execute {cmd} while keeping the current alternate file
44 name. Note that commands invoked indirectly (e.g.,
45 with a function) may still set the alternate file
46 name. {not in Vi}
47
Bram Moolenaar1cd871b2004-12-19 22:46:22 +000048All file names are remembered in the buffer list. When you enter a file name,
Bram Moolenaar402d2fe2005-04-15 21:00:38 +000049for editing (e.g., with ":e filename") or writing (e.g., with ":w filename"),
Bram Moolenaar1cd871b2004-12-19 22:46:22 +000050the file name is added to the list. You can use the buffer list to remember
51which files you edited and to quickly switch from one file to another (e.g.,
52to copy text) with the |CTRL-^| command. First type the number of the file
53and then hit CTRL-^. {Vi: only one alternate file name is remembered}
54
Bram Moolenaar071d4272004-06-13 20:20:40 +000055
56CTRL-G or *CTRL-G* *:f* *:fi* *:file*
Bram Moolenaard9d30582005-05-18 22:10:28 +000057:f[ile] Prints the current file name (as typed, unless ":cd"
58 was used), the cursor position (unless the 'ruler'
59 option is set), and the file status (readonly,
60 modified, read errors, new file). See the 'shortmess'
61 option about how to make this message shorter.
62 {Vi does not include column number}
Bram Moolenaar071d4272004-06-13 20:20:40 +000063
Bram Moolenaar325b7a22004-07-05 15:58:32 +000064:f[ile]! like |:file|, but don't truncate the name even when
65 'shortmess' indicates this.
66
Bram Moolenaar071d4272004-06-13 20:20:40 +000067{count}CTRL-G Like CTRL-G, but prints the current file name with
68 full path. If the count is higher than 1 the current
69 buffer number is also given. {not in Vi}
70
71 *g_CTRL-G* *word-count* *byte-count*
Bram Moolenaar7c626922005-02-07 22:01:03 +000072g CTRL-G Prints the current position of the cursor in five
73 ways: Column, Line, Word, Character and Byte. If the
74 number of Characters and Bytes is the same then the
75 Character position is omitted.
76 If there are characters in the line that take more
77 than one position on the screen (<Tab> or special
78 character), both the "real" column and the screen
79 column are shown, separated with a dash.
80 See also 'ruler' option. {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +000081
82 *v_g_CTRL-G*
Bram Moolenaar7c626922005-02-07 22:01:03 +000083{Visual}g CTRL-G Similar to "g CTRL-G", but Word, Character, Line, and
84 Byte counts for the visually selected region are
85 displayed.
86 In Blockwise mode, Column count is also shown. (For
Bram Moolenaar071d4272004-06-13 20:20:40 +000087 {Visual} see |Visual-mode|.)
88 {not in VI}
89
90 *:file_f*
Bram Moolenaar325b7a22004-07-05 15:58:32 +000091:f[ile][!] {name} Sets the current file name to {name}. The optional !
92 avoids truncating the message, as with |:file|.
Bram Moolenaar7171abe2004-10-11 10:06:20 +000093 If the buffer did have a name, that name becomes the
94 |alternate-file| name. An unlisted buffer is created
95 to hold the old name.
Bram Moolenaar10de2da2005-01-27 14:33:00 +000096 *:0file*
Bram Moolenaar325b7a22004-07-05 15:58:32 +000097:0f[ile][!] Remove the name of the current buffer. The optional !
98 avoids truncating the message, as with |:file|. {not
99 in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000100
101:buffers
102:files
103:ls List all the currently known file names. See
104 'windows.txt' |:files| |:buffers| |:ls|. {not in
105 Vi}
106
107Vim will remember the full path name of a file name that you enter. In most
108cases when the file name is displayed only the name you typed is shown, but
109the full path name is being used if you used the ":cd" command |:cd|.
110
111 *home-replace*
112If the environment variable $HOME is set, and the file name starts with that
113string, it is often displayed with HOME replaced with "~". This was done to
114keep file names short. When reading or writing files the full name is still
115used, the "~" is only used when displaying file names. When replacing the
116file name would result in just "~", "~/" is used instead (to avoid confusion
Bram Moolenaar81695252004-12-29 20:58:21 +0000117between options set to $HOME with 'backupext' set to "~").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000118
119When writing the buffer, the default is to use the current file name. Thus
120when you give the "ZZ" or ":wq" command, the original file will be
121overwritten. If you do not want this, the buffer can be written into another
122file by giving a file name argument to the ":write" command. For example: >
123
124 vim testfile
125 [change the buffer with editor commands]
126 :w newfile
127 :q
128
129This will create a file "newfile", that is a modified copy of "testfile".
130The file "testfile" will remain unchanged. Anyway, if the 'backup' option is
131set, Vim renames or copies the original file before it will be overwritten.
132You can use this file if you discover that you need the original file. See
133also the 'patchmode' option. The name of the backup file is normally the same
134as the original file with 'backupext' appended. The default "~" is a bit
135strange to avoid accidentally overwriting existing files. If you prefer ".bak"
136change the 'backupext' option. Extra dots are replaced with '_' on MS-DOS
137machines, when Vim has detected that an MS-DOS-like filesystem is being used
138(e.g., messydos or crossdos) or when the 'shortname' option is on. The
139backup file can be placed in another directory by setting 'backupdir'.
140
141 *auto-shortname*
142Technical: On the Amiga you can use 30 characters for a file name. But on an
143 MS-DOS-compatible filesystem only 8 plus 3 characters are
144 available. Vim tries to detect the type of filesystem when it is
145 creating the .swp file. If an MS-DOS-like filesystem is suspected,
146 a flag is set that has the same effect as setting the 'shortname'
147 option. This flag will be reset as soon as you start editing a
148 new file. The flag will be used when making the file name for the
149 ".swp" and ".~" files for the current file. But when you are
150 editing a file in a normal filesystem and write to an MS-DOS-like
151 filesystem the flag will not have been set. In that case the
152 creation of the ".~" file may fail and you will get an error
153 message. Use the 'shortname' option in this case.
154
155When you started editing without giving a file name, "No File" is displayed in
156messages. If the ":write" command is used with a file name argument, the file
157name for the current file is set to that file name. This only happens when
Bram Moolenaar2d3f4892006-01-20 23:02:51 +0000158the 'F' flag is included in 'cpoptions' (by default it is included) |cpo-F|.
159This is useful when entering text in an empty buffer and then writing it to a
160file. If 'cpoptions' contains the 'f' flag (by default it is NOT included)
161|cpo-f| the file name is set for the ":read file" command. This is useful
162when starting Vim without an argument and then doing ":read file" to start
163editing a file.
164When the file name was set and 'filetype' is empty the filetype detection
165autocommands will be triggered.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000166 *not-edited*
167Because the file name was set without really starting to edit that file, you
168are protected from overwriting that file. This is done by setting the
169"notedited" flag. You can see if this flag is set with the CTRL-G or ":file"
170command. It will include "[Not edited]" when the "notedited" flag is set.
171When writing the buffer to the current file name (with ":w!"), the "notedited"
172flag is reset.
173
174 *abandon*
175Vim remembers whether you have changed the buffer. You are protected from
176losing the changes you made. If you try to quit without writing, or want to
177start editing another file, Vim will refuse this. In order to overrule this
178protection, add a '!' to the command. The changes will then be lost. For
179example: ":q" will not work if the buffer was changed, but ":q!" will. To see
180whether the buffer was changed use the "CTRL-G" command. The message includes
181the string "[Modified]" if the buffer has been changed.
182
183If you want to automatically save the changes without asking, switch on the
184'autowriteall' option. 'autowrite' is the associated Vi-compatible option
185that does not work for all commands.
186
187If you want to keep the changed buffer without saving it, switch on the
188'hidden' option. See |hidden-buffer|.
189
190==============================================================================
1912. Editing a file *edit-a-file*
192
193 *:e* *:edit*
194:e[dit] [++opt] [+cmd] Edit the current file. This is useful to re-edit the
195 current file, when it has been changed outside of Vim.
196 This fails when changes have been made to the current
197 buffer and 'autowriteall' isn't set or the file can't
198 be written.
199 Also see |++opt| and |+cmd|.
200 {Vi: no ++opt}
201
202 *:edit!*
203:e[dit]! [++opt] [+cmd]
204 Edit the current file always. Discard any changes to
205 the current buffer. This is useful if you want to
206 start all over again.
207 Also see |++opt| and |+cmd|.
208 {Vi: no ++opt}
209
210 *:edit_f*
211:e[dit] [++opt] [+cmd] {file}
212 Edit {file}.
213 This fails when changes have been made to the current
214 buffer, unless 'hidden' is set or 'autowriteall' is
215 set and the file can be written.
216 Also see |++opt| and |+cmd|.
217 {Vi: no ++opt}
218
219 *:edit!_f*
220:e[dit]! [++opt] [+cmd] {file}
221 Edit {file} always. Discard any changes to the
222 current buffer.
223 Also see |++opt| and |+cmd|.
224 {Vi: no ++opt}
225
226:e[dit] [++opt] [+cmd] #[count]
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000227 Edit the [count]th buffer (as shown by |:files|).
228 This command does the same as [count] CTRL-^. But ":e
229 #" doesn't work if the alternate buffer doesn't have a
230 file name, while CTRL-^ still works then.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000231 Also see |++opt| and |+cmd|.
232 {Vi: no ++opt}
233
234 *:ene* *:enew*
235:ene[w] Edit a new, unnamed buffer. This fails when changes
236 have been made to the current buffer, unless 'hidden'
237 is set or 'autowriteall' is set and the file can be
238 written.
239 If 'fileformats' is not empty, the first format given
240 will be used for the new buffer. If 'fileformats' is
241 empty, the 'fileformat' of the current buffer is used.
242 {not in Vi}
243
244 *:ene!* *:enew!*
245:ene[w]! Edit a new, unnamed buffer. Discard any changes to
246 the current buffer.
247 Set 'fileformat' like |:enew|.
248 {not in Vi}
249
250 *:fin* *:find*
251:fin[d][!] [++opt] [+cmd] {file}
252 Find {file} in 'path' and then |:edit| it.
253 {not in Vi} {not available when the |+file_in_path|
254 feature was disabled at compile time}
255
256:{count}fin[d][!] [++opt] [+cmd] {file}
257 Just like ":find", but use the {count} match in
258 'path'. Thus ":2find file" will find the second
259 "file" found in 'path'. When there are fewer matches
260 for the file in 'path' than asked for, you get an
261 error message.
262
263 *:ex*
264:ex [++opt] [+cmd] [file]
265 Same as |:edit|.
266
267 *:vi* *:visual*
268:vi[sual][!] [++opt] [+cmd] [file]
Bram Moolenaar81695252004-12-29 20:58:21 +0000269 When used in Ex mode: Leave |Ex-mode|, go back to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000270 Normal mode. Otherwise same as |:edit|.
271
272 *:vie* *:view*
273:vie[w] [++opt] [+cmd] file
Bram Moolenaar81695252004-12-29 20:58:21 +0000274 When used in Ex mode: Leave |Ex mode|, go back to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000275 Normal mode. Otherwise same as |:edit|, but set
276 'readonly' option for this buffer. {not in Vi}
277
278 *CTRL-^* *CTRL-6*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000279CTRL-^ Edit the alternate file (equivalent to ":e #").
280 Mostly the alternate file is the previously edited
281 file. This is a quick way to toggle between two
282 files.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000283 If the 'autowrite' or 'autowriteall' option is on and
284 the buffer was changed, write it.
285 Mostly the ^ character is positioned on the 6 key,
286 pressing CTRL and 6 then gets you what we call CTRL-^.
287 But on some non-US keyboards CTRL-^ is produced in
288 another way.
289
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000290{count}CTRL-^ Edit [count]th file in the buffer list (equivalent to
291 ":e #[count]"). This is a quick way to switch between
292 files.
293 See |CTRL-^| above for further details.
294 {not in Vi}
295
Bram Moolenaar071d4272004-06-13 20:20:40 +0000296[count]]f *]f* *[f*
297[count][f Same as "gf". Deprecated.
298
299 *gf* *E446* *E447*
300[count]gf Edit the file whose name is under or after the cursor.
301 Mnemonic: "goto file".
302 Uses the 'isfname' option to find out which characters
303 are supposed to be in a file name. Trailing
304 punctuation characters ".,:;!" are ignored.
305 Uses the 'path' option as a list of directory names
306 to look for the file. Also looks for the file
307 relative to the current file.
308 Uses the 'suffixesadd' option to check for file names
309 with a suffix added.
310 If the file can't be found, 'includeexpr' is used to
311 modify the name and another attempt is done.
312 If a [count] is given, the count'th file that is found
313 in the 'path' is edited.
314 This command fails if Vim refuses to |abandon| the
315 current file.
316 If you do want to edit a new file, use: >
317 :e <cfile>
318< To make gf always work like that: >
319 :map gf :e <cfile><CR>
320< If the name is a hypertext link, that looks like
321 "type://machine/path", you need the |netrw| plugin.
322 For Unix the '~' character is expanded, like in
323 "~user/file". Environment variables are expanded too
324 |expand-env|.
325 {not in Vi}
326 {not available when the |+file_in_path| feature was
327 disabled at compile time}
328
329 *v_gf*
330{Visual}[count]gf Same as "gf", but the highlighted text is used as the
331 name of the file to edit. 'isfname' is ignored.
332 Leading blanks are skipped, otherwise all blanks and
333 special characters are included in the file name.
334 (For {Visual} see |Visual-mode|.)
335 {not in VI}
336
Bram Moolenaard1f56e62006-02-22 21:25:37 +0000337 *gF*
338[count]gF Same as "gf", except if a number follows the file
339 name, then the cursor is positioned on that line in
340 the file. The file name and the number must be
341 separated by a non-filename (see 'isfname') and
342 non-numeric character. White space between the
343 filename, the separator and the number are ignored.
344 Examples: >
345 eval.c:10
346 eval.c @ 20
347 eval.c (30)
348 eval.c 40
349<
350 *v_gF*
351{Visual}[count]gF Same as "v_gf".
352
Bram Moolenaar071d4272004-06-13 20:20:40 +0000353These commands are used to start editing a single file. This means that the
354file is read into the buffer and the current file name is set. The file that
355is opened depends on the current directory, see |:cd|.
356
357See |read-messages| for an explanation of the message that is given after the
358file has been read.
359
360You can use the ":e!" command if you messed up the buffer and want to start
361all over again. The ":e" command is only useful if you have changed the
362current file name.
363
364 *:filename* *{file}*
365Note for systems other than Unix and MS-DOS: When using a command that
366accepts a single file name (like ":edit file") spaces in the file name are
367allowed, but trailing spaces are ignored. This is useful on systems that
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000368allow file names with embedded spaces (like MS-Windows and the Amiga).
369Example: The command ":e Long File Name " will edit the file "Long File
370Name". When using a command that accepts more than one file name (like ":next
371file1 file2") embedded spaces must be escaped with a backslash.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000372
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000373 *wildcard*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000374Wildcards in {file} are expanded. Which wildcards are supported depends on
375the system. These are the common ones:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000376 ? matches one character
Bram Moolenaar02743632005-07-25 20:42:36 +0000377 * matches anything, including nothing
378 ** matches anything, including nothing, recurses into directories
Bram Moolenaar071d4272004-06-13 20:20:40 +0000379 [abc] match 'a', 'b' or 'c'
Bram Moolenaar02743632005-07-25 20:42:36 +0000380
Bram Moolenaar071d4272004-06-13 20:20:40 +0000381To avoid the special meaning of the wildcards prepend a backslash. However,
382on MS-Windows the backslash is a path separator and "path\[abc]" is still seen
383as a wildcard when "[" is in the 'isfname' option. A simple way to avoid this
384is to use "path\[[]abc]". Then the file "path[abc]" literally.
385
Bram Moolenaar02743632005-07-25 20:42:36 +0000386 *starstar-wildcard*
387Expanding "**" is possible on Unix, Win32, Mac OS/X and a few other systems.
388This allows searching a directory tree. This goes up to 100 directories deep.
389Example: >
390 :n **/*.txt
391Finds files:
392 ttt.txt
393 subdir/ttt.txt
394 a/b/c/d/ttt.txt
395When non-wildcard characters are used these are only matched in the first
396directory. Example: >
397 :n /usr/inc**/*.h
398Finds files:
399 /usr/include/types.h
400 /usr/include/sys/types.h
401 /usr/inc_old/types.h
Bram Moolenaar071d4272004-06-13 20:20:40 +0000402 *backtick-expansion* *`-expansion*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000403On Unix and a few other systems you can also use backticks in the file name,
404for example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000405 :e `find . -name ver\\*.c -print`
406The backslashes before the star are required to prevent "ver*.c" to be
407expanded by the shell before executing the find program.
408This also works for most other systems, with the restriction that the
409backticks must be around the whole item. It is not possible to have text
410directly before the first or just after the last backtick.
411
Bram Moolenaared203462004-06-16 11:19:22 +0000412 *`=*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000413You can have the backticks expanded as a Vim expression, instead of an
414external command, by using the syntax `={expr}` e.g.: >
415 :e `=tempname()`
416The expression can contain just about anything, thus this can also be used to
417avoid the special meaning of '"', '|', '%' and '#'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000418
419 *++opt* *[++opt]*
Bram Moolenaarb0bf8582005-12-13 20:02:15 +0000420The [++opt] argument can be used to force the value of 'fileformat',
421'fileencoding' or 'binary' to a value for one command, and to specify the
422behavior for bad characters. The form is: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000423 ++{optname}={value}
424
425Where {optname} is one of: *++ff* *++enc* *++bin* *++nobin*
426 ff or fileformat overrides 'fileformat'
427 enc or encoding overrides 'fileencoding'
428 bin or binary sets 'binary'
429 nobin or nobinary resets 'binary'
Bram Moolenaarb0bf8582005-12-13 20:02:15 +0000430 bad specifies behavior for bad characters
Bram Moolenaar071d4272004-06-13 20:20:40 +0000431
432{value} cannot contain white space. It can be any valid value for these
433options. Examples: >
434 :e ++ff=unix
435This edits the same file again with 'fileformat' set to "unix". >
436
437 :w ++enc=latin1 newfile
438This writes the current buffer to "newfile" in latin1 format.
439
Bram Moolenaarb0bf8582005-12-13 20:02:15 +0000440There may be several ++opt arguments, separated by white space. They must all
441appear before any |+cmd| argument.
442
443 *++bad*
444The argument of "++bad=" specifies what happens with characters that can't be
445converted and illegal bytes. It can be one of three things:
446 ++bad=X A single-byte character that replaces each bad character.
447 ++bad=keep Keep bad characters without conversion. Note that this may
448 result in illegal bytes in your text!
449 ++bad=drop Remove the bad characters.
450
451The default is like "++bad=?": Replace each bad character with a question
452mark.
453
Bram Moolenaar071d4272004-06-13 20:20:40 +0000454Note that when reading, the 'fileformat' and 'fileencoding' options will be
455set to the used format. When writing this doesn't happen, thus a next write
456will use the old value of the option. Same for the 'binary' option.
457
Bram Moolenaar071d4272004-06-13 20:20:40 +0000458
459 *+cmd* *[+cmd]*
460The [+cmd] argument can be used to position the cursor in the newly opened
461file, or execute any other command:
462 + Start at the last line.
463 +{num} Start at line {num}.
464 +/{pat} Start at first line containing {pat}.
465 +{command} Execute {command} after opening the new file.
466 {command} is any Ex command.
467To include a white space in the {pat} or {command}, precede it with a
468backslash. Double the number of backslashes. >
469 :edit +/The\ book file
470 :edit +/dir\ dirname\\ file
471 :edit +set\ dir=c:\\\\temp file
472Note that in the last example the number of backslashes is halved twice: Once
473for the "+cmd" argument and once for the ":set" command.
474
475 *file-formats*
476The 'fileformat' option sets the <EOL> style for a file:
477'fileformat' characters name ~
478 "dos" <CR><NL> or <NL> DOS format *DOS-format*
479 "unix" <NL> Unix format *Unix-format*
480 "mac" <CR> Mac format *Mac-format*
481Previously 'textmode' was used. It is obsolete now.
482
483When reading a file, the mentioned characters are interpreted as the <EOL>.
484In DOS format (default for MS-DOS, OS/2 and Win32), <CR><NL> and <NL> are both
485interpreted as the <EOL>. Note that when writing the file in DOS format,
486<CR> characters will be added for each single <NL>. Also see |file-read|.
487
488When writing a file, the mentioned characters are used for <EOL>. For DOS
489format <CR><NL> is used. Also see |DOS-format-write|.
490
491You can read a file in DOS format and write it in Unix format. This will
492replace all <CR><NL> pairs by <NL> (assuming 'fileformats' includes "dos"): >
493 :e file
494 :set fileformat=unix
495 :w
496If you read a file in Unix format and write with DOS format, all <NL>
497characters will be replaced with <CR><NL> (assuming 'fileformats' includes
498"unix"): >
499 :e file
500 :set fileformat=dos
501 :w
502
503If you start editing a new file and the 'fileformats' option is not empty
504(which is the default), Vim will try to detect whether the lines in the file
505are separated by the specified formats. When set to "unix,dos", Vim will
506check for lines with a single <NL> (as used on Unix and Amiga) or by a <CR>
507<NL> pair (MS-DOS). Only when ALL lines end in <CR><NL>, 'fileformat' is set
508to "dos", otherwise it is set to "unix". When 'fileformats' includes "mac",
509and no <NL> characters are found in the file, 'fileformat' is set to "mac".
510
511If the 'fileformat' option is set to "dos" on non-MS-DOS systems the message
512"[dos format]" is shown to remind you that something unusual is happening. On
513MS-DOS systems you get the message "[unix format]" if 'fileformat' is set to
514"unix". On all systems but the Macintosh you get the message "[mac format]"
515if 'fileformat' is set to "mac".
516
517If the 'fileformats' option is empty and DOS format is used, but while reading
518a file some lines did not end in <CR><NL>, "[CR missing]" will be included in
519the file message.
520If the 'fileformats' option is empty and Mac format is used, but while reading
521a file a <NL> was found, "[NL missing]" will be included in the file message.
522
523If the new file does not exist, the 'fileformat' of the current buffer is used
524when 'fileformats' is empty. Otherwise the first format from 'fileformats' is
525used for the new file.
526
527Before editing binary, executable or Vim script files you should set the
528'binary' option. A simple way to do this is by starting Vim with the "-b"
529option. This will avoid the use of 'fileformat'. Without this you risk that
530single <NL> characters are unexpectedly replaced with <CR><NL>.
531
532You can encrypt files that are written by setting the 'key' option. This
533provides some security against others reading your files. |encryption|
534
535
Bram Moolenaar071d4272004-06-13 20:20:40 +0000536==============================================================================
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005373. The argument list *argument-list* *arglist*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000538
539If you give more than one file name when starting Vim, this list is remembered
540as the argument list. You can jump to each file in this list.
541
542Do not confuse this with the buffer list, which you can see with the
543|:buffers| command. The argument list was already present in Vi, the buffer
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000544list is new in Vim. Every file name in the argument list will also be present
545in the buffer list (unless it was deleted with |:bdel| or |:bwipe|). But it's
546common that names in the buffer list are not in the argument list.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000547
548This subject is introduced in section |07.2| of the user manual.
549
550There is one global argument list, which is used for all windows by default.
551It is possible to create a new argument list local to a window, see
552|:arglocal|.
553
554You can use the argument list with the following commands, and with the
555expression functions |argc()| and |argv()|. These all work on the argument
556list of the current window.
557
558 *:ar* *:args*
559:ar[gs] Print the argument list, with the current file in
560 square brackets.
561
562:ar[gs] [++opt] [+cmd] {arglist} *:args_f*
563 Define {arglist} as the new argument list and edit
564 the first one. This fails when changes have been made
565 and Vim does not want to |abandon| the current buffer.
566 Also see |++opt| and |+cmd|.
567 {Vi: no ++opt}
568
569:ar[gs]! [++opt] [+cmd] {arglist} *:args_f!*
570 Define {arglist} as the new argument list and edit
571 the first one. Discard any changes to the current
572 buffer.
573 Also see |++opt| and |+cmd|.
574 {Vi: no ++opt}
575
576:[count]arge[dit][!] [++opt] [+cmd] {name} *:arge* *:argedit*
577 Add {name} to the argument list and edit it.
578 When {name} already exists in the argument list, this
579 entry is edited.
580 This is like using |:argadd| and then |:edit|.
581 Note that only one file name is allowed, and spaces
582 inside the file name are allowed, like with |:edit|.
583 [count] is used like with |:argadd|.
584 [!] is required if the current file cannot be
585 |abandon|ed.
586 Also see |++opt| and |+cmd|.
587 {not in Vi}
588
589:[count]arga[dd] {name} .. *:arga* *:argadd* *E479*
590 Add the {name}s to the argument list.
591 If [count] is omitted, the {name}s are added just
592 after the current entry in the argument list.
593 Otherwise they are added after the [count]'th file.
594 If the argument list is "a b c", and "b" is the
595 current argument, then these commands result in:
596 command new argument list ~
597 :argadd x a b x c
598 :0argadd x x a b c
599 :1argadd x a x b c
600 :99argadd x a b c x
601 There is no check for duplicates, it is possible to
602 add a file to the argument list twice.
603 The currently edited file is not changed.
604 {not in Vi} {not available when compiled without the
605 |+listcmds| feature}
606 Note: you can also use this method: >
607 :args ## x
608< This will add the "x" item and sort the new list.
609
610:argd[elete] {pattern} .. *:argd* *:argdelete* *E480*
611 Delete files from the argument list that match the
612 {pattern}s. {pattern} is used like a file pattern,
613 see |file-pattern|. "%" can be used to delete the
614 current entry.
615 This command keeps the currently edited file, also
616 when it's deleted from the argument list.
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +0000617 Example: >
618 :argdel *.obj
619< {not in Vi} {not available when compiled without the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000620 |+listcmds| feature}
621
622:{range}argd[elete] Delete the {range} files from the argument list.
623 When the last number in the range is too high, up to
624 the last argument is deleted. Example: >
625 :10,1000argdel
626< Deletes arguments 10 and further, keeping 1-9.
627 {not in Vi} {not available when compiled without the
628 |+listcmds| feature}
629
630 *:argu* *:argument*
631:[count]argu[ment] [count] [++opt] [+cmd]
632 Edit file [count] in the argument list. When [count]
633 is omitted the current entry is used. This fails
634 when changes have been made and Vim does not want to
635 |abandon| the current buffer.
636 Also see |++opt| and |+cmd|.
637 {not in Vi} {not available when compiled without the
638 |+listcmds| feature}
639
640:[count]argu[ment]! [count] [++opt] [+cmd]
641 Edit file [count] in the argument list, discard any
642 changes to the current buffer. When [count] is
643 omitted the current entry is used.
644 Also see |++opt| and |+cmd|.
645 {not in Vi} {not available when compiled without the
646 |+listcmds| feature}
647
648:[count]n[ext] [++opt] [+cmd] *:n* *:ne* *:next* *E165* *E163*
649 Edit [count] next file. This fails when changes have
650 been made and Vim does not want to |abandon| the
651 current buffer. Also see |++opt| and |+cmd|. {Vi: no
652 count or ++opt}.
653
654:[count]n[ext]! [++opt] [+cmd]
655 Edit [count] next file, discard any changes to the
656 buffer. Also see |++opt| and |+cmd|. {Vi: no count
657 or ++opt}.
658
659:n[ext] [++opt] [+cmd] {arglist} *:next_f*
660 Same as |:args_f|.
661
662:n[ext]! [++opt] [+cmd] {arglist}
663 Same as |:args_f!|.
664
665:[count]N[ext] [count] [++opt] [+cmd] *:Next* *:N* *E164*
666 Edit [count] previous file in argument list. This
667 fails when changes have been made and Vim does not
668 want to |abandon| the current buffer.
669 Also see |++opt| and |+cmd|. {Vi: no count or ++opt}.
670
671:[count]N[ext]! [count] [++opt] [+cmd]
672 Edit [count] previous file in argument list. Discard
673 any changes to the buffer. Also see |++opt| and
674 |+cmd|. {Vi: no count or ++opt}.
675
676:[count]prev[ious] [count] [++opt] [+cmd] *:prev* *:previous*
677 Same as :Next. Also see |++opt| and |+cmd|. {Vi:
678 only in some versions}
679
680 *:rew* *:rewind*
681:rew[ind] [++opt] [+cmd]
682 Start editing the first file in the argument list.
683 This fails when changes have been made and Vim does
684 not want to |abandon| the current buffer.
685 Also see |++opt| and |+cmd|. {Vi: no ++opt}
686
687:rew[ind]! [++opt] [+cmd]
688 Start editing the first file in the argument list.
689 Discard any changes to the buffer. Also see |++opt|
690 and |+cmd|. {Vi: no ++opt}
691
692 *:fir* *:first*
693:fir[st][!] [++opt] [+cmd]
694 Other name for ":rewind". {not in Vi}
695
696 *:la* *:last*
697:la[st] [++opt] [+cmd]
698 Start editing the last file in the argument list.
699 This fails when changes have been made and Vim does
700 not want to |abandon| the current buffer.
701 Also see |++opt| and |+cmd|. {not in Vi}
702
703:la[st]! [++opt] [+cmd]
704 Start editing the last file in the argument list.
705 Discard any changes to the buffer. Also see |++opt|
706 and |+cmd|. {not in Vi}
707
708 *:wn* *:wnext*
709:[count]wn[ext] [++opt] [+cmd]
710 Write current file and start editing the [count]
711 next file. Also see |++opt| and |+cmd|. {not in Vi}
712
713:[count]wn[ext] [++opt] [+cmd] {file}
714 Write current file to {file} and start editing the
715 [count] next file, unless {file} already exists and
716 the 'writeany' option is off. Also see |++opt| and
717 |+cmd|. {not in Vi}
718
719:[count]wn[ext]! [++opt] [+cmd] {file}
720 Write current file to {file} and start editing the
721 [count] next file. Also see |++opt| and |+cmd|. {not
722 in Vi}
723
724:[count]wN[ext][!] [++opt] [+cmd] [file] *:wN* *:wNext*
Bram Moolenaar81695252004-12-29 20:58:21 +0000725:[count]wp[revious][!] [++opt] [+cmd] [file] *:wp* *:wprevious*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000726 Same as :wnext, but go to previous file instead of
727 next. {not in Vi}
728
729The [count] in the commands above defaults to one. For some commands it is
730possible to use two counts. The last one (rightmost one) is used.
731
732If no [+cmd] argument is present, the cursor is positioned at the last known
733cursor position for the file. If 'startofline' is set, the cursor will be
734positioned at the first non-blank in the line, otherwise the last know column
735is used. If there is no last known cursor position the cursor will be in the
736first line (the last line in Ex mode).
737
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000738 *{arglist}*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000739The wildcards in the argument list are expanded and the file names are sorted.
740Thus you can use the command "vim *.c" to edit all the C files. From within
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000741Vim the command ":n *.c" does the same.
742
743White space is used to separate file names. Put a backslash before a space or
744Tab to include it in a file name. E.g., to edit the single file "foo bar": >
745 :next foo\ bar
746
747On Unix and a few other systems you can also use backticks, for example: >
748 :next `find . -name \\*.c -print`
Bram Moolenaar071d4272004-06-13 20:20:40 +0000749The backslashes before the star are required to prevent "*.c" to be expanded
750by the shell before executing the find program.
751
752 *arglist-position*
753When there is an argument list you can see which file you are editing in the
754title of the window (if there is one and 'title' is on) and with the file
755message you get with the "CTRL-G" command. You will see something like
756 (file 4 of 11)
757If 'shortmess' contains 'f' it will be
758 (4 of 11)
759If you are not really editing the file at the current position in the argument
760list it will be
761 (file (4) of 11)
762This means that you are position 4 in the argument list, but not editing the
763fourth file in the argument list. This happens when you do ":e file".
764
765
766LOCAL ARGUMENT LIST
767
768{not in Vi}
769{not available when compiled without the |+windows| or |+listcmds| feature}
770
771 *:arglocal*
772:argl[ocal] Make a local copy of the global argument list.
773 Doesn't start editing another file.
774
775:argl[ocal][!] [++opt] [+cmd] {arglist}
776 Define a new argument list, which is local to the
777 current window. Works like |:args_f| otherwise.
778
779 *:argglobal*
780:argg[lobal] Use the global argument list for the current window.
781 Doesn't start editing another file.
782
783:argg[lobal][!] [++opt] [+cmd] {arglist}
784 Use the global argument list for the current window.
785 Define a new global argument list like |:args_f|.
786 All windows using the global argument list will see
787 this new list.
788
789There can be several argument lists. They can be shared between windows.
790When they are shared, changing the argument list in one window will also
791change it in the other window.
792
793When a window is split the new window inherits the argument list from the
794current window. The two windows then share this list, until one of them uses
795|:arglocal| or |:argglobal| to use another argument list.
796
797
798USING THE ARGUMENT LIST
799
800 *:argdo*
801:argdo[!] {cmd} Execute {cmd} for each file in the argument list.
802 It works like doing this: >
803 :rewind
804 :{cmd}
805 :next
806 :{cmd}
807 etc.
808< When the current file can't be |abandon|ed and the [!]
809 is not present, the command fails.
810 When an error is detected on one file, further files
811 in the argument list will not be visited.
812 The last file in the argument list (or where an error
813 occurred) becomes the current file.
814 {cmd} can contain '|' to concatenate several commands.
815 {cmd} must not change the argument list.
816 Note: While this command is executing, the Syntax
817 autocommand event is disabled by adding it to
818 'eventignore'. This considerably speeds up editing
819 each file.
820 {not in Vi} {not available when compiled without the
821 |+listcmds| feature}
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000822 Also see |:windo|, |:tabdo| and |:bufdo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000823
824Example: >
825 :args *.c
826 :argdo set ff=unix | update
827This sets the 'fileformat' option to "unix" and writes the file if is now
828changed. This is done for all *.c files.
829
830Example: >
831 :args *.[ch]
832 :argdo %s/\<my_foo\>/My_Foo/ge | update
833This changes the word "my_foo" to "My_Foo" in all *.c and *.h files. The "e"
834flag is used for the ":substitute" command to avoid an error for files where
835"my_foo" isn't used. ":update" writes the file only if changes were made.
836
837==============================================================================
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00008384. Writing *writing* *save-file*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000839
840Note: When the 'write' option is off, you are not able to write any file.
841
842 *:w* *:write*
843 *E502* *E503* *E504* *E505*
844 *E512* *E514* *E667*
845:w[rite] Write the whole buffer to the current file. This is
846 the normal way to save changes to a file. It fails
847 when the 'readonly' option is set or when there is
848 another reason why the file can't be written.
849
850:w[rite]! Like ":write", but forcefully write when 'readonly' is
851 set or there is another reason why writing was
852 refused.
853 Note: This may change the permission and ownership of
854 the file and break (symbolic) links. Add the 'W' flag
855 to 'cpoptions' to avoid this.
856
857:[range]w[rite][!] Write the specified lines to the current file. This
858 is unusual, because the file will not contain all
859 lines in the buffer.
860
861 *:w_f* *:write_f*
862:[range]w[rite] {file} Write the specified lines to {file}, unless it
863 already exists and the 'writeany' option is off.
864
865 *:w!*
866:[range]w[rite]! {file} Write the specified lines to {file}. Overwrite an
867 existing file.
868
869 *:w_a* *:write_a* *E494*
870:[range]w[rite][!] >> Append the specified lines to the current file.
871
872:[range]w[rite][!] >> {file}
873 Append the specified lines to {file}. '!' forces the
874 write even if file does not exist.
875
876 *:w_c* *:write_c*
877:[range]w[rite] !{cmd} Execute {cmd} with [range] lines as standard input
878 (note the space in front of the '!'). {cmd} is
879 executed like with ":!{cmd}", any '!' is replaced with
880 the previous command |:!|.
881
Bram Moolenaar5c4e21c2004-10-12 19:54:52 +0000882The default [range] for the ":w" command is the whole buffer (1,$). If you
883write the whole buffer, it is no longer considered changed. Also when you
884write it to a different file with ":w somefile"!
885
Bram Moolenaar071d4272004-06-13 20:20:40 +0000886If a file name is given with ":w" it becomes the alternate file. This can be
887used, for example, when the write fails and you want to try again later with
888":w #". This can be switched off by removing the 'A' flag from the
889'cpoptions' option.
890
891 *:sav* *:saveas*
892:sav[eas][!] {file} Save the current buffer under the name {file} and set
893 the filename of the current buffer to {file}. The
894 previous name is used for the alternate file name.
895 The [!] is needed to overwrite an existing file.
Bram Moolenaar2d3f4892006-01-20 23:02:51 +0000896 When 'filetype' is empty filetype detection is done
897 with the new name, before the file is written.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000898 {not in Vi}
899
900 *:up* *:update*
901:[range]up[date][!] [>>] [file]
902 Like ":write", but only write when the buffer has been
903 modified. {not in Vi}
904
905
906WRITING WITH MULTIPLE BUFFERS *buffer-write*
907
908 *:wa* *:wall*
909:wa[ll] Write all changed buffers. Buffers without a file
910 name or which are readonly are not written. {not in
911 Vi}
912
913:wa[ll]! Write all changed buffers, even the ones that are
914 readonly. Buffers without a file name are not
915 written. {not in Vi}
916
917
918Vim will warn you if you try to overwrite a file that has been changed
919elsewhere. See |timestamp|.
920
921 *backup* *E207* *E506* *E507* *E508* *E509* *E510*
922If you write to an existing file (but do not append) while the 'backup',
923'writebackup' or 'patchmode' option is on, a backup of the original file is
924made. The file is either copied or renamed (see 'backupcopy'). After the
925file has been successfully written and when the 'writebackup' option is on and
926the 'backup' option is off, the backup file is deleted. When the 'patchmode'
927option is on the backup file may be renamed.
928
929 *backup-table*
930'backup' 'writebackup' action ~
931 off off no backup made
932 off on backup current file, deleted afterwards (default)
933 on off delete old backup, backup current file
934 on on delete old backup, backup current file
935
936When the 'backupskip' pattern matches with the name of the file which is
937written, no backup file is made. The values of 'backup' and 'writebackup' are
938ignored then.
939
940When the 'backup' option is on, an old backup file (with the same name as the
941new backup file) will be deleted. If 'backup' is not set, but 'writebackup'
942is set, an existing backup file will not be deleted. The backup file that is
943made while the file is being written will have a different name.
944
945On some filesystems it's possible that in a crash you lose both the backup and
946the newly written file (it might be there but contain bogus data). In that
947case try recovery, because the swap file is synced to disk and might still be
948there. |:recover|
949
950The directories given with the 'backupdir' option is used to put the backup
951file in. (default: same directory as the written file).
952
953Whether the backup is a new file, which is a copy of the original file, or the
954original file renamed depends on the 'backupcopy' option. See there for an
955explanation of when the copy is made and when the file is renamed.
956
957If the creation of a backup file fails, the write is not done. If you want
958to write anyway add a '!' to the command.
959
960 *write-readonly*
961When the 'cpoptions' option contains 'W', Vim will refuse to overwrite a
962readonly file. When 'W' is not present, ":w!" will overwrite a readonly file,
963if the system allows it (the directory must be writable).
964
965 *write-fail*
966If the writing of the new file fails, you have to be careful not to lose
967your changes AND the original file. If there is no backup file and writing
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000968the new file failed, you have already lost the original file! DON'T EXIT VIM
969UNTIL YOU WRITE OUT THE FILE! If a backup was made, it is put back in place
Bram Moolenaar071d4272004-06-13 20:20:40 +0000970of the original file (if possible). If you exit Vim, and lose the changes
971you made, the original file will mostly still be there. If putting back the
972original file fails, there will be an error message telling you that you
973lost the original file.
974
975 *DOS-format-write*
976If the 'fileformat' is "dos", <CR> <NL> is used for <EOL>. This is default
977for MS-DOS, Win32 and OS/2. On other systems the message "[dos format]" is
978shown to remind you that an unusual <EOL> was used.
979 *Unix-format-write*
980If the 'fileformat' is "unix", <NL> is used for <EOL>. On MS-DOS, Win32 and
981OS/2 the message "[unix format]" is shown.
982 *Mac-format-write*
983If the 'fileformat' is "mac", <CR> is used for <EOL>. On non-Mac systems the
984message "[mac format]" is shown.
985
986See also |file-formats| and the 'fileformat' and 'fileformats' options.
987
988 *ACL*
989ACL stands for Access Control List. It is an advanced way to control access
990rights for a file. It is used on new MS-Windows and Unix systems, but only
991when the filesystem supports it.
992 Vim attempts to preserve the ACL info when writing a file. The backup file
993will get the ACL info of the original file.
994 The ACL info is also used to check if a file is read-only (when opening the
995file).
996
997 *read-only-share*
998When MS-Windows shares a drive on the network it can be marked as read-only.
999This means that even if the file read-only attribute is absent, and the ACL
1000settings on NT network shared drives allow writing to the file, you can still
1001not write to the file. Vim on Win32 platforms will detect read-only network
1002drives and will mark the file as read-only. You will not be able to override
1003it with |:write|.
1004
1005 *write-device*
1006When the file name is actually a device name, Vim will not make a backup (that
1007would be impossible). You need to use "!", since the device already exists.
1008Example for Unix: >
1009 :w! /dev/lpt0
1010and for MS-DOS or MS-Windows: >
1011 :w! lpt0
1012For Unix a device is detected when the name doesn't refer to a normal file or
1013a directory. A fifo or named pipe also looks like a device to Vim.
1014For MS-DOS and MS-Windows the device is detected by its name:
1015 AUX
1016 CON
1017 CLOCK$
1018 NUL
1019 PRN
1020 COMn n=1,2,3... etc
1021 LPTn n=1,2,3... etc
1022The names can be in upper- or lowercase.
1023
1024==============================================================================
Bram Moolenaar1cd871b2004-12-19 22:46:22 +000010255. Writing and quitting *write-quit*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001026
1027 *:q* *:quit*
1028:q[uit] Quit the current window. Quit Vim if this is the last
1029 window. This fails when changes have been made and
1030 Vim refuses to |abandon| the current buffer, and when
1031 the last file in the argument list has not been
1032 edited.
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00001033 If there are other tab pages and quitting the last
1034 window in the current tab page the current tab page is
1035 closed |tab-page|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001036
1037:conf[irm] q[uit] Quit, but give prompt when changes have been made, or
1038 the last file in the argument list has not been
1039 edited. See |:confirm| and 'confirm'. {not in Vi}
1040
1041:q[uit]! Quit without writing, also when visible buffers have
1042 changes. Does not exit when there are changed hidden
1043 buffers. Use ":qall!" to exit always.
1044
1045:cq[uit] Quit always, without writing, and return an error
1046 code. See |:cq|. Used for Manx's QuickFix mode (see
1047 |quickfix|). {not in Vi}
1048
1049 *:wq*
1050:wq Write the current file and quit. Writing fails when
1051 the file is read-only or the buffer does not have a
1052 name. Quitting fails when the last file in the
1053 argument list has not been edited.
1054
1055:wq! Write the current file and quit. Writing fails when
1056 the current buffer does not have a name.
1057
1058:wq {file} Write to {file} and quit. Quitting fails when the
1059 last file in the argument list has not been edited.
1060
1061:wq! {file} Write to {file} and quit.
1062
1063:[range]wq[!] [file] Same as above, but only write the lines in [range].
1064
1065 *:x* *:xit*
1066:[range]x[it][!] [file]
1067 Like ":wq", but write only when changes have been
1068 made.
1069 When 'hidden' is set and there are more windows, the
1070 current buffer becomes hidden, after writing the file.
1071
1072 *:exi* *:exit*
1073:[range]exi[t][!] [file]
1074 Same as :xit.
1075
1076 *ZZ*
1077ZZ Write current file, if modified, and quit (same as
1078 ":x"). (Note: If there are several windows for the
1079 current file, the file is written if it was modified
1080 and the window is closed).
1081
1082 *ZQ*
1083ZQ Quit without checking for changes (same as ":q!").
1084 {not in Vi}
1085
1086MULTIPLE WINDOWS AND BUFFERS *window-exit*
1087
1088 *:qa* *:qall*
1089:qa[ll] Exit Vim, unless there are some buffers which have been
1090 changed. (Use ":bmod" to go to the next modified buffer).
1091 When 'autowriteall' is set all changed buffers will be
1092 written, like |:wqall|. {not in Vi}
1093
1094:conf[irm] qa[ll]
1095 Exit Vim. Bring up a prompt when some buffers have been
1096 changed. See |:confirm|. {not in Vi}
1097
1098:qa[ll]! Exit Vim. Any changes to buffers are lost. {not in Vi}
1099
1100 *:quita* *:quitall*
1101:quita[ll][!] Same as ":qall". {not in Vi}
1102
1103:wqa[ll] *:wqa* *:wqall* *:xa* *:xall*
1104:xa[ll] Write all changed buffers and exit Vim. If there are buffers
1105 without a file name, which are readonly or which cannot be
1106 written for another reason, Vim will not quit. {not in Vi}
1107
1108:conf[irm] wqa[ll]
1109:conf[irm] xa[ll]
1110 Write all changed buffers and exit Vim. Bring up a prompt
1111 when some buffers are readonly or cannot be written for
1112 another reason. See |:confirm|. {not in Vi}
1113
1114:wqa[ll]!
1115:xa[ll]! Write all changed buffers, even the ones that are readonly,
1116 and exit Vim. If there are buffers without a file name or
1117 which cannot be written for another reason, Vim will not quit.
1118 {not in Vi}
1119
1120==============================================================================
Bram Moolenaar1cd871b2004-12-19 22:46:22 +000011216. Dialogs *edit-dialogs*
1122
1123 *:confirm* *:conf*
1124:conf[irm] {command} Execute {command}, and use a dialog when an
1125 operation has to be confirmed. Can be used on the
1126 ":q", ":qa" and ":w" commands (the latter to over-ride
1127 a read-only setting).
1128
1129Examples: >
1130 :confirm w foo
1131< Will ask for confirmation when "foo" already exists. >
1132 :confirm q
1133< Will ask for confirmation when there are changes. >
1134 :confirm qa
1135< If any modified, unsaved buffers exist, you will be prompted to save
1136 or abandon each one. There are also choices to "save all" or "abandon
1137 all".
1138
1139If you want to always use ":confirm", set the 'confirm' option.
1140
1141 *:browse* *:bro* *E338* *E614* *E615* *E616* *E578*
1142:bro[wse] {command} Open a file selection dialog for an argument to
1143 {command}. At present this works for |:e|, |:w|,
1144 |:r|, |:saveas|, |:sp|, |:mkexrc|, |:mkvimrc| and
1145 |:mksession|.
1146 {only in Win32, Athena, Motif, GTK and Mac GUI}
1147 When ":browse" is not possible you get an error
1148 message. If the |+browse| feature is missing or the
1149 {command} doesn't support browsing, the {command} is
1150 executed without a dialog.
1151 ":browse set" works like |:options|.
1152
1153The syntax is best shown via some examples: >
1154 :browse e $vim/foo
1155< Open the browser in the $vim/foo directory, and edit the
1156 file chosen. >
1157 :browse e
1158< Open the browser in the directory specified with 'browsedir',
1159 and edit the file chosen. >
1160 :browse w
1161< Open the browser in the directory of the current buffer,
1162 with the current buffer filename as default, and save the
1163 buffer under the filename chosen. >
1164 :browse w C:/bar
1165< Open the browser in the C:/bar directory, with the current
1166 buffer filename as default, and save the buffer under the
1167 filename chosen.
1168Also see the |'browsedir'| option.
1169For versions of Vim where browsing is not supported, the command is executed
1170unmodified.
1171
1172 *browsefilter*
1173For MS Windows, you can modify the filters that are used in the browse dialog.
1174By setting the g:browsefilter or b:browsefilter variables, you can change the
1175filters globally or locally to the buffer. The variable is set to a string in
1176the format "{filter label}\t{pattern};{pattern}\n" where {filter label} is the
1177text that appears in the "Files of Type" comboBox, and {pattern} is the
1178pattern which filters the filenames. Several patterns can be given, separated
1179by ';'.
1180
1181For Motif the same format is used, but only the very first pattern is actually
1182used (Motif only offers one pattern, but you can edit it).
1183
1184For example, to have only Vim files in the dialog, you could use the following
1185command: >
1186
1187 let g:browsefilter="Vim Scripts\t*.vim\nVim Startup Files\t*vimrc\n"
1188
1189You can override the filter setting on a per-buffer basis by setting the
1190b:browsefilter variable. You would most likely set b:browsefilter in a
1191filetype plugin, so that the browse dialog would contain entries related to
1192the type of file you are currently editing. Disadvantage: This makes it
1193difficult to start editing a file of a different type. To overcome this, you
1194may want to add "All Files\t*.*\n" as the final filter, so that the user can
1195still access any desired file.
1196
1197==============================================================================
11987. The current directory *current-directory*
1199
1200You may use the |:cd| and |:lcd| commands to change to another directory, so
1201you will not have to type that directory name in front of the file names. It
1202also makes a difference for executing external commands, e.g. ":!ls".
1203
Bram Moolenaardf177f62005-02-22 08:39:57 +00001204Changing directory fails when the current buffer is modified, the '.' flag is
1205present in 'cpoptions' and "!" is not used in the command.
1206
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001207 *:cd* *E472*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001208:cd[!] On non-Unix systems: Print the current directory
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001209 name. On Unix systems: Change the current directory
1210 to the home directory. Use |:pwd| to print the
1211 current directory on all systems.
1212
Bram Moolenaardf177f62005-02-22 08:39:57 +00001213:cd[!] {path} Change the current directory to {path}.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001214 If {path} is relative, it is searched for in the
1215 directories listed in |'cdpath'|.
1216 Does not change the meaning of an already opened file,
1217 because its full path name is remembered. Files from
1218 the |arglist| may change though!
1219 On MS-DOS this also changes the active drive.
1220 To change to the directory of the current file: >
1221 :cd %:h
1222<
1223 *:cd-* *E186*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001224:cd[!] - Change to the previous current directory (before the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001225 previous ":cd {path}" command). {not in Vi}
1226
1227 *:chd* *:chdir*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001228:chd[ir][!] [path] Same as |:cd|.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001229
1230 *:lc* *:lcd*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001231:lc[d][!] {path} Like |:cd|, but only set the current directory for the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001232 current window. The current directory for other
1233 windows is not changed. {not in Vi}
1234
1235 *:lch* *:lchdir*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001236:lch[dir][!] Same as |:lcd|. {not in Vi}
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001237
1238 *:pw* *:pwd* *E187*
1239:pw[d] Print the current directory name. {Vi: no pwd}
1240 Also see |getcwd()|.
1241
1242So long as no |:lcd| command has been used, all windows share the same current
1243directory. Using a command to jump to another window doesn't change anything
1244for the current directory.
1245When a |:lcd| command has been used for a window, the specified directory
1246becomes the current directory for that window. Windows where the |:lcd|
1247command has not been used stick to the global current directory. When jumping
1248to another window the current directory will become the last specified local
1249current directory. If none was specified, the global current directory is
1250used.
1251When a |:cd| command is used, the current window will lose his local current
1252directory and will use the global current directory from now on.
1253
1254After using |:cd| the full path name will be used for reading and writing
1255files. On some networked file systems this may cause problems. The result of
1256using the full path name is that the file names currently in use will remain
1257referring to the same file. Example: If you have a file a:test and a
1258directory a:vim the commands ":e test" ":cd vim" ":w" will overwrite the file
1259a:test and not write a:vim/test. But if you do ":w test" the file a:vim/test
1260will be written, because you gave a new file name and did not refer to a
1261filename before the ":cd".
1262
1263==============================================================================
Bram Moolenaar071d4272004-06-13 20:20:40 +000012648. Editing binary files *edit-binary*
1265
1266Although Vim was made to edit text files, it is possible to edit binary
1267files. The |-b| Vim argument (b for binary) makes Vim do file I/O in binary
1268mode, and sets some options for editing binary files ('binary' on, 'textwidth'
1269to 0, 'modeline' off, 'expandtab' off). Setting the 'binary' option has the
1270same effect. Don't forget to do this before reading the file.
1271
1272There are a few things to remember when editing binary files:
1273- When editing executable files the number of characters must not change.
1274 Use only the "R" or "r" command to change text. Do not delete characters
1275 with "x" or by backspacing.
1276- Set the 'textwidth' option to 0. Otherwise lines will unexpectedly be
1277 split in two.
1278- When there are not many <EOL>s, the lines will become very long. If you
1279 want to edit a line that does not fit on the screen reset the 'wrap' option.
1280 Horizontal scrolling is used then. If a line becomes too long (more than
1281 about 32767 characters on the Amiga, much more on 32-bit systems, see
1282 |limits|) you cannot edit that line. The line will be split when reading
1283 the file. It is also possible that you get an "out of memory" error when
1284 reading the file.
1285- Make sure the 'binary' option is set BEFORE loading the
1286 file. Otherwise both <CR> <NL> and <NL> are considered to end a line
1287 and when the file is written the <NL> will be replaced with <CR> <NL>.
1288- <Nul> characters are shown on the screen as ^@. You can enter them with
1289 "CTRL-V CTRL-@" or "CTRL-V 000" {Vi cannot handle <Nul> characters in the
1290 file}
1291- To insert a <NL> character in the file split up a line. When writing the
1292 buffer to a file a <NL> will be written for the <EOL>.
1293- Vim normally appends an <EOL> at the end of the file if there is none.
1294 Setting the 'binary' option prevents this. If you want to add the final
1295 <EOL>, set the 'endofline' option. You can also read the value of this
1296 option to see if there was an <EOL> for the last line (you cannot see this
1297 in the text).
1298
1299==============================================================================
13009. Encryption *encryption*
1301
1302Vim is able to write files encrypted, and read them back. The encrypted text
1303cannot be read without the right key.
1304
1305Note: The swapfile and text in memory is not encrypted. A system
1306administrator will be able to see your text while you are editing it.
1307When filtering text with ":!filter" or using ":w !command" the text is not
1308encrypted, this may reveal it to others.
1309
1310WARNING: If you make a typo when entering the key and then write the file and
1311exit, the text will be lost!
1312
1313The normal way to work with encryption, is to use the ":X" command, which will
1314ask you to enter a key. A following write command will use that key to
1315encrypt the file. If you later edit the same file, Vim will ask you to enter
1316a key. If you type the same key as that was used for writing, the text will
1317be readable again. If you use a wrong key, it will be a mess.
1318
1319 *:X*
1320:X Prompt for an encryption key. The typing is done without showing the
1321 actual text, so that someone looking at the display won't see it.
1322 The typed key is stored in the 'key' option, which is used to encrypt
1323 the file when it is written. The file will remain unchanged until you
1324 write it. See also |-x|.
1325
1326The value of the 'key' options is used when text is written. When the option
1327is not empty, the written file will be encrypted, using the value as the
1328encryption key. A magic number is prepended, so that Vim can recognize that
1329the file is encrypted.
1330
1331To disable the encryption, reset the 'key' option to an empty value: >
1332 :set key=
1333
1334When reading a file that has been encrypted and this option is not empty, it
1335will be used for decryption. If the value is empty, you will be prompted to
1336enter the key. If you don't enter a key, the file is edited without being
1337decrypted.
1338
1339If want to start reading a file that uses a different key, set the 'key'
1340option to an empty string, so that Vim will prompt for a new one. Don't use
1341the ":set" command to enter the value, other people can read the command over
1342your shoulder.
1343
1344Since the value of the 'key' option is supposed to be a secret, its value can
1345never be viewed. You should not set this option in a vimrc file.
1346
1347An encrypted file can be recognized by the "file" command, if you add this
1348line to "/etc/magic", "/usr/share/misc/magic" or wherever your system has the
1349"magic" file: >
1350 0 string VimCrypt~ Vim encrypted file
1351
1352Notes:
1353- Encryption is not possible when doing conversion with 'charconvert'.
1354- Text you copy or delete goes to the numbered registers. The registers can
1355 be saved in the .viminfo file, where they could be read. Change your
1356 'viminfo' option to be safe.
1357- Someone can type commands in Vim when you walk away for a moment, he should
1358 not be able to get the key.
1359- If you make a typing mistake when entering the key, you might not be able to
1360 get your text back!
1361- If you type the key with a ":set key=value" command, it can be kept in the
1362 history, showing the 'key' value in a viminfo file.
1363- There is never 100% safety. The encryption in Vim has not been tested for
1364 robustness.
1365- The algorithm used is breakable. A 4 character key in about one hour, a 6
1366 character key in one day (on a Pentium 133 PC). This requires that you know
1367 some text that must appear in the file. An expert can break it for any key.
1368 When the text has been decrypted, this also means that the key can be
1369 revealed, and other files encrypted with the same key can be decrypted.
1370- Pkzip uses the same encryption, and US Govt has no objection to its export.
1371 Pkzip's public file APPNOTE.TXT describes this algorithm in detail.
1372- Vim originates from the Netherlands. That is where the sources come from.
1373 Thus the encryption code is not exported from the USA.
1374
1375==============================================================================
137610. Timestamps *timestamp* *timestamps*
1377
1378Vim remembers the modification timestamp of a file when you begin editing it.
1379This is used to avoid that you have two different versions of the same file
1380(without you knowing this).
1381
1382After a shell command is run (|:!cmd| |suspend| |:read!| |K|) timestamps are
1383compared for all buffers in a window. Vim will run any associated
1384|FileChangedShell| autocommands or display a warning for any files that have
1385changed. In the GUI this happens when Vim regains input focus.
1386
1387 *E321* *E462*
1388If you want to automatically reload a file when it has been changed outside of
1389Vim, set the 'autoread' option. This doesn't work at the moment you write the
1390file though, only when the file wasn't changed inside of Vim.
1391
1392Note that if a FileChangedShell autocommand is defined you will not get a
1393warning message or prompt. The autocommand is expected to handle this.
1394
Bram Moolenaar10de2da2005-01-27 14:33:00 +00001395There is no warning for a directory (e.g., with |netrw-browse|). But you do
1396get warned if you started editing a new file and it was created as a directory
1397later.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001398
1399When Vim notices the timestamp of a file has changed, and the file is being
1400edited in a buffer but has not changed, Vim checks if the contents of the file
1401is equal. This is done by reading the file again (into a hidden buffer, which
1402is immediately deleted again) and comparing the text. If the text is equal,
1403you will get no warning.
1404
1405If you don't get warned often enough you can use the following command.
1406
1407 *:checkt* *:checktime*
1408:checkt[ime] Check if any buffers were changed outside of Vim.
1409 This checks and warns you if you would end up with two
1410 versions of a file.
1411 If this is called from an autocommand, a ":global"
1412 command or is not typed the actual check is postponed
1413 until a moment the side effects (reloading the file)
1414 would be harmless.
1415 Each loaded buffer is checked for its associated file
1416 being changed. If the file was changed Vim will take
1417 action. If there are no changes in the buffer and
1418 'autoread' is set, the buffer is reloaded. Otherwise,
1419 you are offered the choice of reloading the file. If
1420 the file was deleted you get an error message.
1421 If the file previously didn't exist you get a warning
1422 if it exists now.
1423 Once a file has been checked the timestamp is reset,
1424 you will not be warned again.
1425
1426:[N]checkt[ime] {filename}
1427:[N]checkt[ime] [N]
1428 Check the timestamp of a specific buffer. The buffer
1429 may be specified by name, number or with a pattern.
1430
1431
1432Before writing a file the timestamp is checked. If it has changed, Vim will
1433ask if you really want to overwrite the file:
1434
1435 WARNING: The file has been changed since reading it!!!
1436 Do you really want to write to it (y/n)?
1437
1438If you hit 'y' Vim will continue writing the file. If you hit 'n' the write is
1439aborted. If you used ":wq" or "ZZ" Vim will not exit, you will get another
1440chance to write the file.
1441
1442The message would normally mean that somebody has written to the file after
1443the edit session started. This could be another person, in which case you
1444probably want to check if your changes to the file and the changes from the
1445other person should be merged. Write the file under another name and check for
1446differences (the "diff" program can be used for this).
1447
1448It is also possible that you modified the file yourself, from another edit
1449session or with another command (e.g., a filter command). Then you will know
1450which version of the file you want to keep.
1451
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001452There is one situation where you get the message while there is nothing wrong:
1453On a Win32 system on the day daylight saving time starts. There is something
1454in the Win32 libraries that confuses Vim about the hour time difference. The
1455problem goes away the next day.
1456
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001457==============================================================================
145811. File Searching *file-searching*
1459
1460{not available when compiled without the |+path_extra| feature}
1461
1462The file searching is currently used for the 'path', 'cdpath' and 'tags'
1463options. There are three different types of searching:
1464
Bram Moolenaar02743632005-07-25 20:42:36 +000014651) Downward search: *starstar*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001466 Downward search uses the wildcards '*', '**' and possibly others
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001467 supported by your operating system. '*' and '**' are handled inside Vim, so
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001468 they work on all operating systems.
1469
1470 The usage of '*' is quite simple: It matches 0 or more characters.
1471
1472 '**' is more sophisticated:
1473 - It ONLY matches directories.
Bram Moolenaar81695252004-12-29 20:58:21 +00001474 - It matches up to 30 directories deep, so you can use it to search an
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001475 entire directory tree
1476 - The maximum number of levels matched can be given by appending a number
1477 to '**'.
1478 Thus '/usr/**2' can match: >
1479 /usr
1480 /usr/include
1481 /usr/include/sys
1482 /usr/include/g++
1483 /usr/lib
1484 /usr/lib/X11
1485 ....
1486< It does NOT match '/usr/include/g++/std' as this would be three
1487 levels.
1488 The allowed number range is 0 ('**0' is removed) to 255.
1489 If the given number is smaller than 0 it defaults to 30, if it's
1490 bigger than 255 it defaults to 255.
1491 - '**' can only be at the end of the path or be followed by a path
1492 separator or by a number and a path separator.
1493
1494 You can combine '*' and '**' in any order: >
1495 /usr/**/sys/*
1496 /usr/*/sys/**
1497 /usr/**2/sys/*
1498
14992) Upward search:
1500 Here you can give a directory and then search the directory tree upward for
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001501 a file. You could give stop-directories to limit the upward search. The
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001502 stop-directories are appended to the path (for the 'path' option) or to
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001503 the filename (for the 'tags' option) with a ';'. If you want several
1504 stop-directories separate them with ';'. If you want no stop-directory
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001505 ("search upward till the root directory) just use ';'. >
1506 /usr/include/sys;/usr
1507< will search in: >
1508 /usr/include/sys
1509 /usr/include
1510 /usr
1511<
1512 If you use a relative path the upward search is started in Vim's current
1513 directory or in the directory of the current file (if the relative path
1514 starts with './' and 'd' is not included in 'cpoptions').
1515
1516 If Vim's current path is /u/user_x/work/release and you do >
1517 :set path=include;/u/user_x
1518< and then search for a file with |gf| the file is searched in: >
1519 /u/user_x/work/release/include
1520 /u/user_x/work/include
1521 /u/user_x/include
1522
Bram Moolenaar402d2fe2005-04-15 21:00:38 +000015233) Combined up/downward search:
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001524 If Vim's current path is /u/user_x/work/release and you do >
1525 set path=**;/u/user_x
1526< and then search for a file with |gf| the file is searched in: >
1527 /u/user_x/work/release/**
1528 /u/user_x/work/**
1529 /u/user_x/**
1530<
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001531 BE CAREFUL! This might consume a lot of time, as the search of
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001532 '/u/user_x/**' includes '/u/user_x/work/**' and
1533 '/u/user_x/work/release/**'. So '/u/user_x/work/release/**' is searched
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001534 three times and '/u/user_x/work/**' is searched twice.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001535
1536 In the above example you might want to set path to: >
1537 :set path=**,/u/user_x/**
1538< This searches: >
1539 /u/user_x/work/release/**
1540 /u/user_x/**
1541< This searches the same directories, but in a different order.
1542
Bram Moolenaar071d4272004-06-13 20:20:40 +00001543
1544 vim:tw=78:ts=8:ft=help:norl: