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