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