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