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