blob: 7a67a6978e77b54480a3910e9ef80c8bfea1729d [file] [log] [blame]
Bram Moolenaar3991dab2006-03-27 17:01:56 +00001*editing.txt* For Vim version 7.0c. Last change: 2006 Mar 06
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
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000417avoid the special meaning of '"', '|', '%' and '#'. Names are to be separated
418with line breaks. When the result is a |List| then each item is used as a
419name. Line breaks also separate names.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000420
421 *++opt* *[++opt]*
Bram Moolenaarb0bf8582005-12-13 20:02:15 +0000422The [++opt] argument can be used to force the value of 'fileformat',
423'fileencoding' or 'binary' to a value for one command, and to specify the
424behavior for bad characters. The form is: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000425 ++{optname}={value}
426
427Where {optname} is one of: *++ff* *++enc* *++bin* *++nobin*
428 ff or fileformat overrides 'fileformat'
429 enc or encoding overrides 'fileencoding'
430 bin or binary sets 'binary'
431 nobin or nobinary resets 'binary'
Bram Moolenaarb0bf8582005-12-13 20:02:15 +0000432 bad specifies behavior for bad characters
Bram Moolenaar071d4272004-06-13 20:20:40 +0000433
434{value} cannot contain white space. It can be any valid value for these
435options. Examples: >
436 :e ++ff=unix
437This edits the same file again with 'fileformat' set to "unix". >
438
439 :w ++enc=latin1 newfile
440This writes the current buffer to "newfile" in latin1 format.
441
Bram Moolenaarb0bf8582005-12-13 20:02:15 +0000442There may be several ++opt arguments, separated by white space. They must all
443appear before any |+cmd| argument.
444
445 *++bad*
446The argument of "++bad=" specifies what happens with characters that can't be
447converted and illegal bytes. It can be one of three things:
448 ++bad=X A single-byte character that replaces each bad character.
449 ++bad=keep Keep bad characters without conversion. Note that this may
450 result in illegal bytes in your text!
451 ++bad=drop Remove the bad characters.
452
453The default is like "++bad=?": Replace each bad character with a question
454mark.
455
Bram Moolenaar071d4272004-06-13 20:20:40 +0000456Note that when reading, the 'fileformat' and 'fileencoding' options will be
457set to the used format. When writing this doesn't happen, thus a next write
458will use the old value of the option. Same for the 'binary' option.
459
Bram Moolenaar071d4272004-06-13 20:20:40 +0000460
461 *+cmd* *[+cmd]*
462The [+cmd] argument can be used to position the cursor in the newly opened
463file, or execute any other command:
464 + Start at the last line.
465 +{num} Start at line {num}.
466 +/{pat} Start at first line containing {pat}.
467 +{command} Execute {command} after opening the new file.
468 {command} is any Ex command.
469To include a white space in the {pat} or {command}, precede it with a
470backslash. Double the number of backslashes. >
471 :edit +/The\ book file
472 :edit +/dir\ dirname\\ file
473 :edit +set\ dir=c:\\\\temp file
474Note that in the last example the number of backslashes is halved twice: Once
475for the "+cmd" argument and once for the ":set" command.
476
477 *file-formats*
478The 'fileformat' option sets the <EOL> style for a file:
479'fileformat' characters name ~
480 "dos" <CR><NL> or <NL> DOS format *DOS-format*
481 "unix" <NL> Unix format *Unix-format*
482 "mac" <CR> Mac format *Mac-format*
483Previously 'textmode' was used. It is obsolete now.
484
485When reading a file, the mentioned characters are interpreted as the <EOL>.
486In DOS format (default for MS-DOS, OS/2 and Win32), <CR><NL> and <NL> are both
487interpreted as the <EOL>. Note that when writing the file in DOS format,
488<CR> characters will be added for each single <NL>. Also see |file-read|.
489
490When writing a file, the mentioned characters are used for <EOL>. For DOS
491format <CR><NL> is used. Also see |DOS-format-write|.
492
493You can read a file in DOS format and write it in Unix format. This will
494replace all <CR><NL> pairs by <NL> (assuming 'fileformats' includes "dos"): >
495 :e file
496 :set fileformat=unix
497 :w
498If you read a file in Unix format and write with DOS format, all <NL>
499characters will be replaced with <CR><NL> (assuming 'fileformats' includes
500"unix"): >
501 :e file
502 :set fileformat=dos
503 :w
504
505If you start editing a new file and the 'fileformats' option is not empty
506(which is the default), Vim will try to detect whether the lines in the file
507are separated by the specified formats. When set to "unix,dos", Vim will
508check for lines with a single <NL> (as used on Unix and Amiga) or by a <CR>
509<NL> pair (MS-DOS). Only when ALL lines end in <CR><NL>, 'fileformat' is set
510to "dos", otherwise it is set to "unix". When 'fileformats' includes "mac",
511and no <NL> characters are found in the file, 'fileformat' is set to "mac".
512
513If the 'fileformat' option is set to "dos" on non-MS-DOS systems the message
514"[dos format]" is shown to remind you that something unusual is happening. On
515MS-DOS systems you get the message "[unix format]" if 'fileformat' is set to
516"unix". On all systems but the Macintosh you get the message "[mac format]"
517if 'fileformat' is set to "mac".
518
519If the 'fileformats' option is empty and DOS format is used, but while reading
520a file some lines did not end in <CR><NL>, "[CR missing]" will be included in
521the file message.
522If the 'fileformats' option is empty and Mac format is used, but while reading
523a file a <NL> was found, "[NL missing]" will be included in the file message.
524
525If the new file does not exist, the 'fileformat' of the current buffer is used
526when 'fileformats' is empty. Otherwise the first format from 'fileformats' is
527used for the new file.
528
529Before editing binary, executable or Vim script files you should set the
530'binary' option. A simple way to do this is by starting Vim with the "-b"
531option. This will avoid the use of 'fileformat'. Without this you risk that
532single <NL> characters are unexpectedly replaced with <CR><NL>.
533
534You can encrypt files that are written by setting the 'key' option. This
535provides some security against others reading your files. |encryption|
536
537
Bram Moolenaar071d4272004-06-13 20:20:40 +0000538==============================================================================
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005393. The argument list *argument-list* *arglist*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000540
541If you give more than one file name when starting Vim, this list is remembered
542as the argument list. You can jump to each file in this list.
543
544Do not confuse this with the buffer list, which you can see with the
545|:buffers| command. The argument list was already present in Vi, the buffer
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000546list is new in Vim. Every file name in the argument list will also be present
547in the buffer list (unless it was deleted with |:bdel| or |:bwipe|). But it's
548common that names in the buffer list are not in the argument list.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000549
550This subject is introduced in section |07.2| of the user manual.
551
552There is one global argument list, which is used for all windows by default.
553It is possible to create a new argument list local to a window, see
554|:arglocal|.
555
556You can use the argument list with the following commands, and with the
557expression functions |argc()| and |argv()|. These all work on the argument
558list of the current window.
559
560 *:ar* *:args*
561:ar[gs] Print the argument list, with the current file in
562 square brackets.
563
564:ar[gs] [++opt] [+cmd] {arglist} *:args_f*
565 Define {arglist} as the new argument list and edit
566 the first one. This fails when changes have been made
567 and Vim does not want to |abandon| the current buffer.
568 Also see |++opt| and |+cmd|.
569 {Vi: no ++opt}
570
571:ar[gs]! [++opt] [+cmd] {arglist} *:args_f!*
572 Define {arglist} as the new argument list and edit
573 the first one. Discard any changes to the current
574 buffer.
575 Also see |++opt| and |+cmd|.
576 {Vi: no ++opt}
577
578:[count]arge[dit][!] [++opt] [+cmd] {name} *:arge* *:argedit*
579 Add {name} to the argument list and edit it.
580 When {name} already exists in the argument list, this
581 entry is edited.
582 This is like using |:argadd| and then |:edit|.
583 Note that only one file name is allowed, and spaces
584 inside the file name are allowed, like with |:edit|.
585 [count] is used like with |:argadd|.
586 [!] is required if the current file cannot be
587 |abandon|ed.
588 Also see |++opt| and |+cmd|.
589 {not in Vi}
590
591:[count]arga[dd] {name} .. *:arga* *:argadd* *E479*
592 Add the {name}s to the argument list.
593 If [count] is omitted, the {name}s are added just
594 after the current entry in the argument list.
595 Otherwise they are added after the [count]'th file.
596 If the argument list is "a b c", and "b" is the
597 current argument, then these commands result in:
598 command new argument list ~
599 :argadd x a b x c
600 :0argadd x x a b c
601 :1argadd x a x b c
602 :99argadd x a b c x
603 There is no check for duplicates, it is possible to
604 add a file to the argument list twice.
605 The currently edited file is not changed.
606 {not in Vi} {not available when compiled without the
607 |+listcmds| feature}
608 Note: you can also use this method: >
609 :args ## x
610< This will add the "x" item and sort the new list.
611
612:argd[elete] {pattern} .. *:argd* *:argdelete* *E480*
613 Delete files from the argument list that match the
614 {pattern}s. {pattern} is used like a file pattern,
615 see |file-pattern|. "%" can be used to delete the
616 current entry.
617 This command keeps the currently edited file, also
618 when it's deleted from the argument list.
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +0000619 Example: >
620 :argdel *.obj
621< {not in Vi} {not available when compiled without the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000622 |+listcmds| feature}
623
624:{range}argd[elete] Delete the {range} files from the argument list.
625 When the last number in the range is too high, up to
626 the last argument is deleted. Example: >
627 :10,1000argdel
628< Deletes arguments 10 and further, keeping 1-9.
629 {not in Vi} {not available when compiled without the
630 |+listcmds| feature}
631
632 *:argu* *:argument*
633:[count]argu[ment] [count] [++opt] [+cmd]
634 Edit file [count] in the argument list. When [count]
635 is omitted the current entry is used. This fails
636 when changes have been made and Vim does not want to
637 |abandon| the current buffer.
638 Also see |++opt| and |+cmd|.
639 {not in Vi} {not available when compiled without the
640 |+listcmds| feature}
641
642:[count]argu[ment]! [count] [++opt] [+cmd]
643 Edit file [count] in the argument list, discard any
644 changes to the current buffer. When [count] is
645 omitted the current entry is used.
646 Also see |++opt| and |+cmd|.
647 {not in Vi} {not available when compiled without the
648 |+listcmds| feature}
649
650:[count]n[ext] [++opt] [+cmd] *:n* *:ne* *:next* *E165* *E163*
651 Edit [count] next file. This fails when changes have
652 been made and Vim does not want to |abandon| the
653 current buffer. Also see |++opt| and |+cmd|. {Vi: no
654 count or ++opt}.
655
656:[count]n[ext]! [++opt] [+cmd]
657 Edit [count] next file, discard any changes to the
658 buffer. Also see |++opt| and |+cmd|. {Vi: no count
659 or ++opt}.
660
661:n[ext] [++opt] [+cmd] {arglist} *:next_f*
662 Same as |:args_f|.
663
664:n[ext]! [++opt] [+cmd] {arglist}
665 Same as |:args_f!|.
666
667:[count]N[ext] [count] [++opt] [+cmd] *:Next* *:N* *E164*
668 Edit [count] previous file in argument list. This
669 fails when changes have been made and Vim does not
670 want to |abandon| the current buffer.
671 Also see |++opt| and |+cmd|. {Vi: no count or ++opt}.
672
673:[count]N[ext]! [count] [++opt] [+cmd]
674 Edit [count] previous file in argument list. Discard
675 any changes to the buffer. Also see |++opt| and
676 |+cmd|. {Vi: no count or ++opt}.
677
678:[count]prev[ious] [count] [++opt] [+cmd] *:prev* *:previous*
679 Same as :Next. Also see |++opt| and |+cmd|. {Vi:
680 only in some versions}
681
682 *:rew* *:rewind*
683:rew[ind] [++opt] [+cmd]
684 Start editing the first file in the argument list.
685 This fails when changes have been made and Vim does
686 not want to |abandon| the current buffer.
687 Also see |++opt| and |+cmd|. {Vi: no ++opt}
688
689:rew[ind]! [++opt] [+cmd]
690 Start editing the first file in the argument list.
691 Discard any changes to the buffer. Also see |++opt|
692 and |+cmd|. {Vi: no ++opt}
693
694 *:fir* *:first*
695:fir[st][!] [++opt] [+cmd]
696 Other name for ":rewind". {not in Vi}
697
698 *:la* *:last*
699:la[st] [++opt] [+cmd]
700 Start editing the last file in the argument list.
701 This fails when changes have been made and Vim does
702 not want to |abandon| the current buffer.
703 Also see |++opt| and |+cmd|. {not in Vi}
704
705:la[st]! [++opt] [+cmd]
706 Start editing the last file in the argument list.
707 Discard any changes to the buffer. Also see |++opt|
708 and |+cmd|. {not in Vi}
709
710 *:wn* *:wnext*
711:[count]wn[ext] [++opt] [+cmd]
712 Write current file and start editing the [count]
713 next file. Also see |++opt| and |+cmd|. {not in Vi}
714
715:[count]wn[ext] [++opt] [+cmd] {file}
716 Write current file to {file} and start editing the
717 [count] next file, unless {file} already exists and
718 the 'writeany' option is off. Also see |++opt| and
719 |+cmd|. {not in Vi}
720
721:[count]wn[ext]! [++opt] [+cmd] {file}
722 Write current file to {file} and start editing the
723 [count] next file. Also see |++opt| and |+cmd|. {not
724 in Vi}
725
726:[count]wN[ext][!] [++opt] [+cmd] [file] *:wN* *:wNext*
Bram Moolenaar81695252004-12-29 20:58:21 +0000727:[count]wp[revious][!] [++opt] [+cmd] [file] *:wp* *:wprevious*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000728 Same as :wnext, but go to previous file instead of
729 next. {not in Vi}
730
731The [count] in the commands above defaults to one. For some commands it is
732possible to use two counts. The last one (rightmost one) is used.
733
734If no [+cmd] argument is present, the cursor is positioned at the last known
735cursor position for the file. If 'startofline' is set, the cursor will be
736positioned at the first non-blank in the line, otherwise the last know column
737is used. If there is no last known cursor position the cursor will be in the
738first line (the last line in Ex mode).
739
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000740 *{arglist}*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000741The wildcards in the argument list are expanded and the file names are sorted.
742Thus you can use the command "vim *.c" to edit all the C files. From within
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000743Vim the command ":n *.c" does the same.
744
745White space is used to separate file names. Put a backslash before a space or
746Tab to include it in a file name. E.g., to edit the single file "foo bar": >
747 :next foo\ bar
748
749On Unix and a few other systems you can also use backticks, for example: >
750 :next `find . -name \\*.c -print`
Bram Moolenaar071d4272004-06-13 20:20:40 +0000751The backslashes before the star are required to prevent "*.c" to be expanded
752by the shell before executing the find program.
753
754 *arglist-position*
755When there is an argument list you can see which file you are editing in the
756title of the window (if there is one and 'title' is on) and with the file
757message you get with the "CTRL-G" command. You will see something like
758 (file 4 of 11)
759If 'shortmess' contains 'f' it will be
760 (4 of 11)
761If you are not really editing the file at the current position in the argument
762list it will be
763 (file (4) of 11)
764This means that you are position 4 in the argument list, but not editing the
765fourth file in the argument list. This happens when you do ":e file".
766
767
768LOCAL ARGUMENT LIST
769
770{not in Vi}
771{not available when compiled without the |+windows| or |+listcmds| feature}
772
773 *:arglocal*
774:argl[ocal] Make a local copy of the global argument list.
775 Doesn't start editing another file.
776
777:argl[ocal][!] [++opt] [+cmd] {arglist}
778 Define a new argument list, which is local to the
779 current window. Works like |:args_f| otherwise.
780
781 *:argglobal*
782:argg[lobal] Use the global argument list for the current window.
783 Doesn't start editing another file.
784
785:argg[lobal][!] [++opt] [+cmd] {arglist}
786 Use the global argument list for the current window.
787 Define a new global argument list like |:args_f|.
788 All windows using the global argument list will see
789 this new list.
790
791There can be several argument lists. They can be shared between windows.
792When they are shared, changing the argument list in one window will also
793change it in the other window.
794
795When a window is split the new window inherits the argument list from the
796current window. The two windows then share this list, until one of them uses
797|:arglocal| or |:argglobal| to use another argument list.
798
799
800USING THE ARGUMENT LIST
801
802 *:argdo*
803:argdo[!] {cmd} Execute {cmd} for each file in the argument list.
804 It works like doing this: >
805 :rewind
806 :{cmd}
807 :next
808 :{cmd}
809 etc.
810< When the current file can't be |abandon|ed and the [!]
811 is not present, the command fails.
812 When an error is detected on one file, further files
813 in the argument list will not be visited.
814 The last file in the argument list (or where an error
815 occurred) becomes the current file.
816 {cmd} can contain '|' to concatenate several commands.
817 {cmd} must not change the argument list.
818 Note: While this command is executing, the Syntax
819 autocommand event is disabled by adding it to
820 'eventignore'. This considerably speeds up editing
821 each file.
822 {not in Vi} {not available when compiled without the
823 |+listcmds| feature}
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000824 Also see |:windo|, |:tabdo| and |:bufdo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000825
826Example: >
827 :args *.c
828 :argdo set ff=unix | update
829This sets the 'fileformat' option to "unix" and writes the file if is now
830changed. This is done for all *.c files.
831
832Example: >
833 :args *.[ch]
834 :argdo %s/\<my_foo\>/My_Foo/ge | update
835This changes the word "my_foo" to "My_Foo" in all *.c and *.h files. The "e"
836flag is used for the ":substitute" command to avoid an error for files where
837"my_foo" isn't used. ":update" writes the file only if changes were made.
838
839==============================================================================
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00008404. Writing *writing* *save-file*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000841
842Note: When the 'write' option is off, you are not able to write any file.
843
844 *:w* *:write*
845 *E502* *E503* *E504* *E505*
846 *E512* *E514* *E667*
847:w[rite] Write the whole buffer to the current file. This is
848 the normal way to save changes to a file. It fails
849 when the 'readonly' option is set or when there is
850 another reason why the file can't be written.
851
852:w[rite]! Like ":write", but forcefully write when 'readonly' is
853 set or there is another reason why writing was
854 refused.
855 Note: This may change the permission and ownership of
856 the file and break (symbolic) links. Add the 'W' flag
857 to 'cpoptions' to avoid this.
858
859:[range]w[rite][!] Write the specified lines to the current file. This
860 is unusual, because the file will not contain all
861 lines in the buffer.
862
863 *:w_f* *:write_f*
864:[range]w[rite] {file} Write the specified lines to {file}, unless it
865 already exists and the 'writeany' option is off.
866
867 *:w!*
868:[range]w[rite]! {file} Write the specified lines to {file}. Overwrite an
869 existing file.
870
871 *:w_a* *:write_a* *E494*
872:[range]w[rite][!] >> Append the specified lines to the current file.
873
874:[range]w[rite][!] >> {file}
875 Append the specified lines to {file}. '!' forces the
876 write even if file does not exist.
877
878 *:w_c* *:write_c*
879:[range]w[rite] !{cmd} Execute {cmd} with [range] lines as standard input
880 (note the space in front of the '!'). {cmd} is
881 executed like with ":!{cmd}", any '!' is replaced with
882 the previous command |:!|.
883
Bram Moolenaar5c4e21c2004-10-12 19:54:52 +0000884The default [range] for the ":w" command is the whole buffer (1,$). If you
885write the whole buffer, it is no longer considered changed. Also when you
886write it to a different file with ":w somefile"!
887
Bram Moolenaar071d4272004-06-13 20:20:40 +0000888If a file name is given with ":w" it becomes the alternate file. This can be
889used, for example, when the write fails and you want to try again later with
890":w #". This can be switched off by removing the 'A' flag from the
891'cpoptions' option.
892
893 *:sav* *:saveas*
894:sav[eas][!] {file} Save the current buffer under the name {file} and set
895 the filename of the current buffer to {file}. The
896 previous name is used for the alternate file name.
897 The [!] is needed to overwrite an existing file.
Bram Moolenaar2d3f4892006-01-20 23:02:51 +0000898 When 'filetype' is empty filetype detection is done
899 with the new name, before the file is written.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000900 {not in Vi}
901
902 *:up* *:update*
903:[range]up[date][!] [>>] [file]
904 Like ":write", but only write when the buffer has been
905 modified. {not in Vi}
906
907
908WRITING WITH MULTIPLE BUFFERS *buffer-write*
909
910 *:wa* *:wall*
911:wa[ll] Write all changed buffers. Buffers without a file
912 name or which are readonly are not written. {not in
913 Vi}
914
915:wa[ll]! Write all changed buffers, even the ones that are
916 readonly. Buffers without a file name are not
917 written. {not in Vi}
918
919
920Vim will warn you if you try to overwrite a file that has been changed
921elsewhere. See |timestamp|.
922
923 *backup* *E207* *E506* *E507* *E508* *E509* *E510*
924If you write to an existing file (but do not append) while the 'backup',
925'writebackup' or 'patchmode' option is on, a backup of the original file is
926made. The file is either copied or renamed (see 'backupcopy'). After the
927file has been successfully written and when the 'writebackup' option is on and
928the 'backup' option is off, the backup file is deleted. When the 'patchmode'
929option is on the backup file may be renamed.
930
931 *backup-table*
932'backup' 'writebackup' action ~
933 off off no backup made
934 off on backup current file, deleted afterwards (default)
935 on off delete old backup, backup current file
936 on on delete old backup, backup current file
937
938When the 'backupskip' pattern matches with the name of the file which is
939written, no backup file is made. The values of 'backup' and 'writebackup' are
940ignored then.
941
942When the 'backup' option is on, an old backup file (with the same name as the
943new backup file) will be deleted. If 'backup' is not set, but 'writebackup'
944is set, an existing backup file will not be deleted. The backup file that is
945made while the file is being written will have a different name.
946
947On some filesystems it's possible that in a crash you lose both the backup and
948the newly written file (it might be there but contain bogus data). In that
949case try recovery, because the swap file is synced to disk and might still be
950there. |:recover|
951
952The directories given with the 'backupdir' option is used to put the backup
953file in. (default: same directory as the written file).
954
955Whether the backup is a new file, which is a copy of the original file, or the
956original file renamed depends on the 'backupcopy' option. See there for an
957explanation of when the copy is made and when the file is renamed.
958
959If the creation of a backup file fails, the write is not done. If you want
960to write anyway add a '!' to the command.
961
962 *write-readonly*
963When the 'cpoptions' option contains 'W', Vim will refuse to overwrite a
964readonly file. When 'W' is not present, ":w!" will overwrite a readonly file,
965if the system allows it (the directory must be writable).
966
967 *write-fail*
968If the writing of the new file fails, you have to be careful not to lose
969your changes AND the original file. If there is no backup file and writing
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000970the new file failed, you have already lost the original file! DON'T EXIT VIM
971UNTIL YOU WRITE OUT THE FILE! If a backup was made, it is put back in place
Bram Moolenaar071d4272004-06-13 20:20:40 +0000972of the original file (if possible). If you exit Vim, and lose the changes
973you made, the original file will mostly still be there. If putting back the
974original file fails, there will be an error message telling you that you
975lost the original file.
976
977 *DOS-format-write*
978If the 'fileformat' is "dos", <CR> <NL> is used for <EOL>. This is default
979for MS-DOS, Win32 and OS/2. On other systems the message "[dos format]" is
980shown to remind you that an unusual <EOL> was used.
981 *Unix-format-write*
982If the 'fileformat' is "unix", <NL> is used for <EOL>. On MS-DOS, Win32 and
983OS/2 the message "[unix format]" is shown.
984 *Mac-format-write*
985If the 'fileformat' is "mac", <CR> is used for <EOL>. On non-Mac systems the
986message "[mac format]" is shown.
987
988See also |file-formats| and the 'fileformat' and 'fileformats' options.
989
990 *ACL*
991ACL stands for Access Control List. It is an advanced way to control access
992rights for a file. It is used on new MS-Windows and Unix systems, but only
993when the filesystem supports it.
994 Vim attempts to preserve the ACL info when writing a file. The backup file
995will get the ACL info of the original file.
996 The ACL info is also used to check if a file is read-only (when opening the
997file).
998
999 *read-only-share*
1000When MS-Windows shares a drive on the network it can be marked as read-only.
1001This means that even if the file read-only attribute is absent, and the ACL
1002settings on NT network shared drives allow writing to the file, you can still
1003not write to the file. Vim on Win32 platforms will detect read-only network
1004drives and will mark the file as read-only. You will not be able to override
1005it with |:write|.
1006
1007 *write-device*
1008When the file name is actually a device name, Vim will not make a backup (that
1009would be impossible). You need to use "!", since the device already exists.
1010Example for Unix: >
1011 :w! /dev/lpt0
1012and for MS-DOS or MS-Windows: >
1013 :w! lpt0
1014For Unix a device is detected when the name doesn't refer to a normal file or
1015a directory. A fifo or named pipe also looks like a device to Vim.
1016For MS-DOS and MS-Windows the device is detected by its name:
1017 AUX
1018 CON
1019 CLOCK$
1020 NUL
1021 PRN
1022 COMn n=1,2,3... etc
1023 LPTn n=1,2,3... etc
1024The names can be in upper- or lowercase.
1025
1026==============================================================================
Bram Moolenaar1cd871b2004-12-19 22:46:22 +000010275. Writing and quitting *write-quit*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001028
1029 *:q* *:quit*
1030:q[uit] Quit the current window. Quit Vim if this is the last
1031 window. This fails when changes have been made and
1032 Vim refuses to |abandon| the current buffer, and when
1033 the last file in the argument list has not been
1034 edited.
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00001035 If there are other tab pages and quitting the last
1036 window in the current tab page the current tab page is
1037 closed |tab-page|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001038
1039:conf[irm] q[uit] Quit, but give prompt when changes have been made, or
1040 the last file in the argument list has not been
1041 edited. See |:confirm| and 'confirm'. {not in Vi}
1042
1043:q[uit]! Quit without writing, also when visible buffers have
1044 changes. Does not exit when there are changed hidden
1045 buffers. Use ":qall!" to exit always.
1046
1047:cq[uit] Quit always, without writing, and return an error
1048 code. See |:cq|. Used for Manx's QuickFix mode (see
1049 |quickfix|). {not in Vi}
1050
1051 *:wq*
1052:wq Write the current file and quit. Writing fails when
1053 the file is read-only or the buffer does not have a
1054 name. Quitting fails when the last file in the
1055 argument list has not been edited.
1056
1057:wq! Write the current file and quit. Writing fails when
1058 the current buffer does not have a name.
1059
1060:wq {file} Write to {file} and quit. Quitting fails when the
1061 last file in the argument list has not been edited.
1062
1063:wq! {file} Write to {file} and quit.
1064
1065:[range]wq[!] [file] Same as above, but only write the lines in [range].
1066
1067 *:x* *:xit*
1068:[range]x[it][!] [file]
1069 Like ":wq", but write only when changes have been
1070 made.
1071 When 'hidden' is set and there are more windows, the
1072 current buffer becomes hidden, after writing the file.
1073
1074 *:exi* *:exit*
1075:[range]exi[t][!] [file]
1076 Same as :xit.
1077
1078 *ZZ*
1079ZZ Write current file, if modified, and quit (same as
1080 ":x"). (Note: If there are several windows for the
1081 current file, the file is written if it was modified
1082 and the window is closed).
1083
1084 *ZQ*
1085ZQ Quit without checking for changes (same as ":q!").
1086 {not in Vi}
1087
1088MULTIPLE WINDOWS AND BUFFERS *window-exit*
1089
1090 *:qa* *:qall*
1091:qa[ll] Exit Vim, unless there are some buffers which have been
1092 changed. (Use ":bmod" to go to the next modified buffer).
1093 When 'autowriteall' is set all changed buffers will be
1094 written, like |:wqall|. {not in Vi}
1095
1096:conf[irm] qa[ll]
1097 Exit Vim. Bring up a prompt when some buffers have been
1098 changed. See |:confirm|. {not in Vi}
1099
1100:qa[ll]! Exit Vim. Any changes to buffers are lost. {not in Vi}
1101
1102 *:quita* *:quitall*
1103:quita[ll][!] Same as ":qall". {not in Vi}
1104
1105:wqa[ll] *:wqa* *:wqall* *:xa* *:xall*
1106:xa[ll] Write all changed buffers and exit Vim. If there are buffers
1107 without a file name, which are readonly or which cannot be
1108 written for another reason, Vim will not quit. {not in Vi}
1109
1110:conf[irm] wqa[ll]
1111:conf[irm] xa[ll]
1112 Write all changed buffers and exit Vim. Bring up a prompt
1113 when some buffers are readonly or cannot be written for
1114 another reason. See |:confirm|. {not in Vi}
1115
1116:wqa[ll]!
1117:xa[ll]! Write all changed buffers, even the ones that are readonly,
1118 and exit Vim. If there are buffers without a file name or
1119 which cannot be written for another reason, Vim will not quit.
1120 {not in Vi}
1121
1122==============================================================================
Bram Moolenaar1cd871b2004-12-19 22:46:22 +000011236. Dialogs *edit-dialogs*
1124
1125 *:confirm* *:conf*
1126:conf[irm] {command} Execute {command}, and use a dialog when an
1127 operation has to be confirmed. Can be used on the
1128 ":q", ":qa" and ":w" commands (the latter to over-ride
1129 a read-only setting).
1130
1131Examples: >
1132 :confirm w foo
1133< Will ask for confirmation when "foo" already exists. >
1134 :confirm q
1135< Will ask for confirmation when there are changes. >
1136 :confirm qa
1137< If any modified, unsaved buffers exist, you will be prompted to save
1138 or abandon each one. There are also choices to "save all" or "abandon
1139 all".
1140
1141If you want to always use ":confirm", set the 'confirm' option.
1142
1143 *:browse* *:bro* *E338* *E614* *E615* *E616* *E578*
1144:bro[wse] {command} Open a file selection dialog for an argument to
1145 {command}. At present this works for |:e|, |:w|,
1146 |:r|, |:saveas|, |:sp|, |:mkexrc|, |:mkvimrc| and
1147 |:mksession|.
1148 {only in Win32, Athena, Motif, GTK and Mac GUI}
1149 When ":browse" is not possible you get an error
1150 message. If the |+browse| feature is missing or the
1151 {command} doesn't support browsing, the {command} is
1152 executed without a dialog.
1153 ":browse set" works like |:options|.
1154
1155The syntax is best shown via some examples: >
1156 :browse e $vim/foo
1157< Open the browser in the $vim/foo directory, and edit the
1158 file chosen. >
1159 :browse e
1160< Open the browser in the directory specified with 'browsedir',
1161 and edit the file chosen. >
1162 :browse w
1163< Open the browser in the directory of the current buffer,
1164 with the current buffer filename as default, and save the
1165 buffer under the filename chosen. >
1166 :browse w C:/bar
1167< Open the browser in the C:/bar directory, with the current
1168 buffer filename as default, and save the buffer under the
1169 filename chosen.
1170Also see the |'browsedir'| option.
1171For versions of Vim where browsing is not supported, the command is executed
1172unmodified.
1173
1174 *browsefilter*
1175For MS Windows, you can modify the filters that are used in the browse dialog.
1176By setting the g:browsefilter or b:browsefilter variables, you can change the
1177filters globally or locally to the buffer. The variable is set to a string in
1178the format "{filter label}\t{pattern};{pattern}\n" where {filter label} is the
1179text that appears in the "Files of Type" comboBox, and {pattern} is the
1180pattern which filters the filenames. Several patterns can be given, separated
1181by ';'.
1182
1183For Motif the same format is used, but only the very first pattern is actually
1184used (Motif only offers one pattern, but you can edit it).
1185
1186For example, to have only Vim files in the dialog, you could use the following
1187command: >
1188
1189 let g:browsefilter="Vim Scripts\t*.vim\nVim Startup Files\t*vimrc\n"
1190
1191You can override the filter setting on a per-buffer basis by setting the
1192b:browsefilter variable. You would most likely set b:browsefilter in a
1193filetype plugin, so that the browse dialog would contain entries related to
1194the type of file you are currently editing. Disadvantage: This makes it
1195difficult to start editing a file of a different type. To overcome this, you
1196may want to add "All Files\t*.*\n" as the final filter, so that the user can
1197still access any desired file.
1198
1199==============================================================================
12007. The current directory *current-directory*
1201
1202You may use the |:cd| and |:lcd| commands to change to another directory, so
1203you will not have to type that directory name in front of the file names. It
1204also makes a difference for executing external commands, e.g. ":!ls".
1205
Bram Moolenaardf177f62005-02-22 08:39:57 +00001206Changing directory fails when the current buffer is modified, the '.' flag is
1207present in 'cpoptions' and "!" is not used in the command.
1208
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001209 *:cd* *E472*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001210:cd[!] On non-Unix systems: Print the current directory
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001211 name. On Unix systems: Change the current directory
1212 to the home directory. Use |:pwd| to print the
1213 current directory on all systems.
1214
Bram Moolenaardf177f62005-02-22 08:39:57 +00001215:cd[!] {path} Change the current directory to {path}.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001216 If {path} is relative, it is searched for in the
1217 directories listed in |'cdpath'|.
1218 Does not change the meaning of an already opened file,
1219 because its full path name is remembered. Files from
1220 the |arglist| may change though!
1221 On MS-DOS this also changes the active drive.
1222 To change to the directory of the current file: >
1223 :cd %:h
1224<
1225 *:cd-* *E186*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001226:cd[!] - Change to the previous current directory (before the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001227 previous ":cd {path}" command). {not in Vi}
1228
1229 *:chd* *:chdir*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001230:chd[ir][!] [path] Same as |:cd|.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001231
1232 *:lc* *:lcd*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001233:lc[d][!] {path} Like |:cd|, but only set the current directory for the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001234 current window. The current directory for other
1235 windows is not changed. {not in Vi}
1236
1237 *:lch* *:lchdir*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001238:lch[dir][!] Same as |:lcd|. {not in Vi}
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001239
1240 *:pw* *:pwd* *E187*
1241:pw[d] Print the current directory name. {Vi: no pwd}
1242 Also see |getcwd()|.
1243
1244So long as no |:lcd| command has been used, all windows share the same current
1245directory. Using a command to jump to another window doesn't change anything
1246for the current directory.
1247When a |:lcd| command has been used for a window, the specified directory
1248becomes the current directory for that window. Windows where the |:lcd|
1249command has not been used stick to the global current directory. When jumping
1250to another window the current directory will become the last specified local
1251current directory. If none was specified, the global current directory is
1252used.
1253When a |:cd| command is used, the current window will lose his local current
1254directory and will use the global current directory from now on.
1255
1256After using |:cd| the full path name will be used for reading and writing
1257files. On some networked file systems this may cause problems. The result of
1258using the full path name is that the file names currently in use will remain
1259referring to the same file. Example: If you have a file a:test and a
1260directory a:vim the commands ":e test" ":cd vim" ":w" will overwrite the file
1261a:test and not write a:vim/test. But if you do ":w test" the file a:vim/test
1262will be written, because you gave a new file name and did not refer to a
1263filename before the ":cd".
1264
1265==============================================================================
Bram Moolenaar071d4272004-06-13 20:20:40 +000012668. Editing binary files *edit-binary*
1267
1268Although Vim was made to edit text files, it is possible to edit binary
1269files. The |-b| Vim argument (b for binary) makes Vim do file I/O in binary
1270mode, and sets some options for editing binary files ('binary' on, 'textwidth'
1271to 0, 'modeline' off, 'expandtab' off). Setting the 'binary' option has the
1272same effect. Don't forget to do this before reading the file.
1273
1274There are a few things to remember when editing binary files:
1275- When editing executable files the number of characters must not change.
1276 Use only the "R" or "r" command to change text. Do not delete characters
1277 with "x" or by backspacing.
1278- Set the 'textwidth' option to 0. Otherwise lines will unexpectedly be
1279 split in two.
1280- When there are not many <EOL>s, the lines will become very long. If you
1281 want to edit a line that does not fit on the screen reset the 'wrap' option.
1282 Horizontal scrolling is used then. If a line becomes too long (more than
1283 about 32767 characters on the Amiga, much more on 32-bit systems, see
1284 |limits|) you cannot edit that line. The line will be split when reading
1285 the file. It is also possible that you get an "out of memory" error when
1286 reading the file.
1287- Make sure the 'binary' option is set BEFORE loading the
1288 file. Otherwise both <CR> <NL> and <NL> are considered to end a line
1289 and when the file is written the <NL> will be replaced with <CR> <NL>.
1290- <Nul> characters are shown on the screen as ^@. You can enter them with
1291 "CTRL-V CTRL-@" or "CTRL-V 000" {Vi cannot handle <Nul> characters in the
1292 file}
1293- To insert a <NL> character in the file split up a line. When writing the
1294 buffer to a file a <NL> will be written for the <EOL>.
1295- Vim normally appends an <EOL> at the end of the file if there is none.
1296 Setting the 'binary' option prevents this. If you want to add the final
1297 <EOL>, set the 'endofline' option. You can also read the value of this
1298 option to see if there was an <EOL> for the last line (you cannot see this
1299 in the text).
1300
1301==============================================================================
13029. Encryption *encryption*
1303
1304Vim is able to write files encrypted, and read them back. The encrypted text
1305cannot be read without the right key.
1306
1307Note: The swapfile and text in memory is not encrypted. A system
1308administrator will be able to see your text while you are editing it.
1309When filtering text with ":!filter" or using ":w !command" the text is not
1310encrypted, this may reveal it to others.
1311
1312WARNING: If you make a typo when entering the key and then write the file and
1313exit, the text will be lost!
1314
1315The normal way to work with encryption, is to use the ":X" command, which will
1316ask you to enter a key. A following write command will use that key to
1317encrypt the file. If you later edit the same file, Vim will ask you to enter
1318a key. If you type the same key as that was used for writing, the text will
1319be readable again. If you use a wrong key, it will be a mess.
1320
1321 *:X*
1322:X Prompt for an encryption key. The typing is done without showing the
1323 actual text, so that someone looking at the display won't see it.
1324 The typed key is stored in the 'key' option, which is used to encrypt
1325 the file when it is written. The file will remain unchanged until you
1326 write it. See also |-x|.
1327
1328The value of the 'key' options is used when text is written. When the option
1329is not empty, the written file will be encrypted, using the value as the
1330encryption key. A magic number is prepended, so that Vim can recognize that
1331the file is encrypted.
1332
1333To disable the encryption, reset the 'key' option to an empty value: >
1334 :set key=
1335
1336When reading a file that has been encrypted and this option is not empty, it
1337will be used for decryption. If the value is empty, you will be prompted to
1338enter the key. If you don't enter a key, the file is edited without being
1339decrypted.
1340
1341If want to start reading a file that uses a different key, set the 'key'
1342option to an empty string, so that Vim will prompt for a new one. Don't use
1343the ":set" command to enter the value, other people can read the command over
1344your shoulder.
1345
1346Since the value of the 'key' option is supposed to be a secret, its value can
1347never be viewed. You should not set this option in a vimrc file.
1348
1349An encrypted file can be recognized by the "file" command, if you add this
1350line to "/etc/magic", "/usr/share/misc/magic" or wherever your system has the
1351"magic" file: >
1352 0 string VimCrypt~ Vim encrypted file
1353
1354Notes:
1355- Encryption is not possible when doing conversion with 'charconvert'.
1356- Text you copy or delete goes to the numbered registers. The registers can
1357 be saved in the .viminfo file, where they could be read. Change your
1358 'viminfo' option to be safe.
1359- Someone can type commands in Vim when you walk away for a moment, he should
1360 not be able to get the key.
1361- If you make a typing mistake when entering the key, you might not be able to
1362 get your text back!
1363- If you type the key with a ":set key=value" command, it can be kept in the
1364 history, showing the 'key' value in a viminfo file.
1365- There is never 100% safety. The encryption in Vim has not been tested for
1366 robustness.
1367- The algorithm used is breakable. A 4 character key in about one hour, a 6
1368 character key in one day (on a Pentium 133 PC). This requires that you know
1369 some text that must appear in the file. An expert can break it for any key.
1370 When the text has been decrypted, this also means that the key can be
1371 revealed, and other files encrypted with the same key can be decrypted.
1372- Pkzip uses the same encryption, and US Govt has no objection to its export.
1373 Pkzip's public file APPNOTE.TXT describes this algorithm in detail.
1374- Vim originates from the Netherlands. That is where the sources come from.
1375 Thus the encryption code is not exported from the USA.
1376
1377==============================================================================
137810. Timestamps *timestamp* *timestamps*
1379
1380Vim remembers the modification timestamp of a file when you begin editing it.
1381This is used to avoid that you have two different versions of the same file
1382(without you knowing this).
1383
1384After a shell command is run (|:!cmd| |suspend| |:read!| |K|) timestamps are
1385compared for all buffers in a window. Vim will run any associated
1386|FileChangedShell| autocommands or display a warning for any files that have
1387changed. In the GUI this happens when Vim regains input focus.
1388
1389 *E321* *E462*
1390If you want to automatically reload a file when it has been changed outside of
1391Vim, set the 'autoread' option. This doesn't work at the moment you write the
1392file though, only when the file wasn't changed inside of Vim.
1393
1394Note that if a FileChangedShell autocommand is defined you will not get a
1395warning message or prompt. The autocommand is expected to handle this.
1396
Bram Moolenaar10de2da2005-01-27 14:33:00 +00001397There is no warning for a directory (e.g., with |netrw-browse|). But you do
1398get warned if you started editing a new file and it was created as a directory
1399later.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001400
1401When Vim notices the timestamp of a file has changed, and the file is being
1402edited in a buffer but has not changed, Vim checks if the contents of the file
1403is equal. This is done by reading the file again (into a hidden buffer, which
1404is immediately deleted again) and comparing the text. If the text is equal,
1405you will get no warning.
1406
1407If you don't get warned often enough you can use the following command.
1408
1409 *:checkt* *:checktime*
1410:checkt[ime] Check if any buffers were changed outside of Vim.
1411 This checks and warns you if you would end up with two
1412 versions of a file.
1413 If this is called from an autocommand, a ":global"
1414 command or is not typed the actual check is postponed
1415 until a moment the side effects (reloading the file)
1416 would be harmless.
1417 Each loaded buffer is checked for its associated file
1418 being changed. If the file was changed Vim will take
1419 action. If there are no changes in the buffer and
1420 'autoread' is set, the buffer is reloaded. Otherwise,
1421 you are offered the choice of reloading the file. If
1422 the file was deleted you get an error message.
1423 If the file previously didn't exist you get a warning
1424 if it exists now.
1425 Once a file has been checked the timestamp is reset,
1426 you will not be warned again.
1427
1428:[N]checkt[ime] {filename}
1429:[N]checkt[ime] [N]
1430 Check the timestamp of a specific buffer. The buffer
1431 may be specified by name, number or with a pattern.
1432
1433
1434Before writing a file the timestamp is checked. If it has changed, Vim will
1435ask if you really want to overwrite the file:
1436
1437 WARNING: The file has been changed since reading it!!!
1438 Do you really want to write to it (y/n)?
1439
1440If you hit 'y' Vim will continue writing the file. If you hit 'n' the write is
1441aborted. If you used ":wq" or "ZZ" Vim will not exit, you will get another
1442chance to write the file.
1443
1444The message would normally mean that somebody has written to the file after
1445the edit session started. This could be another person, in which case you
1446probably want to check if your changes to the file and the changes from the
1447other person should be merged. Write the file under another name and check for
1448differences (the "diff" program can be used for this).
1449
1450It is also possible that you modified the file yourself, from another edit
1451session or with another command (e.g., a filter command). Then you will know
1452which version of the file you want to keep.
1453
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001454There is one situation where you get the message while there is nothing wrong:
1455On a Win32 system on the day daylight saving time starts. There is something
1456in the Win32 libraries that confuses Vim about the hour time difference. The
1457problem goes away the next day.
1458
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001459==============================================================================
146011. File Searching *file-searching*
1461
1462{not available when compiled without the |+path_extra| feature}
1463
1464The file searching is currently used for the 'path', 'cdpath' and 'tags'
1465options. There are three different types of searching:
1466
Bram Moolenaar02743632005-07-25 20:42:36 +000014671) Downward search: *starstar*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001468 Downward search uses the wildcards '*', '**' and possibly others
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001469 supported by your operating system. '*' and '**' are handled inside Vim, so
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001470 they work on all operating systems.
1471
1472 The usage of '*' is quite simple: It matches 0 or more characters.
1473
1474 '**' is more sophisticated:
1475 - It ONLY matches directories.
Bram Moolenaar81695252004-12-29 20:58:21 +00001476 - It matches up to 30 directories deep, so you can use it to search an
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001477 entire directory tree
1478 - The maximum number of levels matched can be given by appending a number
1479 to '**'.
1480 Thus '/usr/**2' can match: >
1481 /usr
1482 /usr/include
1483 /usr/include/sys
1484 /usr/include/g++
1485 /usr/lib
1486 /usr/lib/X11
1487 ....
1488< It does NOT match '/usr/include/g++/std' as this would be three
1489 levels.
1490 The allowed number range is 0 ('**0' is removed) to 255.
1491 If the given number is smaller than 0 it defaults to 30, if it's
1492 bigger than 255 it defaults to 255.
1493 - '**' can only be at the end of the path or be followed by a path
1494 separator or by a number and a path separator.
1495
1496 You can combine '*' and '**' in any order: >
1497 /usr/**/sys/*
1498 /usr/*/sys/**
1499 /usr/**2/sys/*
1500
15012) Upward search:
1502 Here you can give a directory and then search the directory tree upward for
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001503 a file. You could give stop-directories to limit the upward search. The
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001504 stop-directories are appended to the path (for the 'path' option) or to
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001505 the filename (for the 'tags' option) with a ';'. If you want several
1506 stop-directories separate them with ';'. If you want no stop-directory
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001507 ("search upward till the root directory) just use ';'. >
1508 /usr/include/sys;/usr
1509< will search in: >
1510 /usr/include/sys
1511 /usr/include
1512 /usr
1513<
1514 If you use a relative path the upward search is started in Vim's current
1515 directory or in the directory of the current file (if the relative path
1516 starts with './' and 'd' is not included in 'cpoptions').
1517
1518 If Vim's current path is /u/user_x/work/release and you do >
1519 :set path=include;/u/user_x
1520< and then search for a file with |gf| the file is searched in: >
1521 /u/user_x/work/release/include
1522 /u/user_x/work/include
1523 /u/user_x/include
1524
Bram Moolenaar402d2fe2005-04-15 21:00:38 +000015253) Combined up/downward search:
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001526 If Vim's current path is /u/user_x/work/release and you do >
1527 set path=**;/u/user_x
1528< and then search for a file with |gf| the file is searched in: >
1529 /u/user_x/work/release/**
1530 /u/user_x/work/**
1531 /u/user_x/**
1532<
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001533 BE CAREFUL! This might consume a lot of time, as the search of
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001534 '/u/user_x/**' includes '/u/user_x/work/**' and
1535 '/u/user_x/work/release/**'. So '/u/user_x/work/release/**' is searched
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001536 three times and '/u/user_x/work/**' is searched twice.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001537
1538 In the above example you might want to set path to: >
1539 :set path=**,/u/user_x/**
1540< This searches: >
1541 /u/user_x/work/release/**
1542 /u/user_x/**
1543< This searches the same directories, but in a different order.
1544
Bram Moolenaar071d4272004-06-13 20:20:40 +00001545
1546 vim:tw=78:ts=8:ft=help:norl: