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