blob: 8ae870a5a6d1c3e346298005128964991ce966fa [file] [log] [blame]
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001*editing.txt* For Vim version 7.0aa. Last change: 2005 Apr 04
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*
57:f[ile] Prints the current file name (as typed), the
58 cursor position (unless the 'ruler' option is set),
59 and the file status (readonly, modified, read errors,
Bram Moolenaar402d2fe2005-04-15 21:00:38 +000060 new file). See the 'shortmess' option about how to
Bram Moolenaar071d4272004-06-13 20:20:40 +000061 make this message shorter. {Vi does not include
62 column number}
63
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.
566 {not in Vi} {not available when compiled without the
567 |+listcmds| feature}
568
569:{range}argd[elete] Delete the {range} files from the argument list.
570 When the last number in the range is too high, up to
571 the last argument is deleted. Example: >
572 :10,1000argdel
573< Deletes arguments 10 and further, keeping 1-9.
574 {not in Vi} {not available when compiled without the
575 |+listcmds| feature}
576
577 *:argu* *:argument*
578:[count]argu[ment] [count] [++opt] [+cmd]
579 Edit file [count] in the argument list. When [count]
580 is omitted the current entry is used. This fails
581 when changes have been made and Vim does not want to
582 |abandon| the current buffer.
583 Also see |++opt| and |+cmd|.
584 {not in Vi} {not available when compiled without the
585 |+listcmds| feature}
586
587:[count]argu[ment]! [count] [++opt] [+cmd]
588 Edit file [count] in the argument list, discard any
589 changes to the current buffer. When [count] is
590 omitted the current entry is used.
591 Also see |++opt| and |+cmd|.
592 {not in Vi} {not available when compiled without the
593 |+listcmds| feature}
594
595:[count]n[ext] [++opt] [+cmd] *:n* *:ne* *:next* *E165* *E163*
596 Edit [count] next file. This fails when changes have
597 been made and Vim does not want to |abandon| the
598 current buffer. Also see |++opt| and |+cmd|. {Vi: no
599 count or ++opt}.
600
601:[count]n[ext]! [++opt] [+cmd]
602 Edit [count] next file, discard any changes to the
603 buffer. Also see |++opt| and |+cmd|. {Vi: no count
604 or ++opt}.
605
606:n[ext] [++opt] [+cmd] {arglist} *:next_f*
607 Same as |:args_f|.
608
609:n[ext]! [++opt] [+cmd] {arglist}
610 Same as |:args_f!|.
611
612:[count]N[ext] [count] [++opt] [+cmd] *:Next* *:N* *E164*
613 Edit [count] previous file in argument list. This
614 fails when changes have been made and Vim does not
615 want to |abandon| the current buffer.
616 Also see |++opt| and |+cmd|. {Vi: no count or ++opt}.
617
618:[count]N[ext]! [count] [++opt] [+cmd]
619 Edit [count] previous file in argument list. Discard
620 any changes to the buffer. Also see |++opt| and
621 |+cmd|. {Vi: no count or ++opt}.
622
623:[count]prev[ious] [count] [++opt] [+cmd] *:prev* *:previous*
624 Same as :Next. Also see |++opt| and |+cmd|. {Vi:
625 only in some versions}
626
627 *:rew* *:rewind*
628:rew[ind] [++opt] [+cmd]
629 Start editing the first file in the argument list.
630 This fails when changes have been made and Vim does
631 not want to |abandon| the current buffer.
632 Also see |++opt| and |+cmd|. {Vi: no ++opt}
633
634:rew[ind]! [++opt] [+cmd]
635 Start editing the first file in the argument list.
636 Discard any changes to the buffer. Also see |++opt|
637 and |+cmd|. {Vi: no ++opt}
638
639 *:fir* *:first*
640:fir[st][!] [++opt] [+cmd]
641 Other name for ":rewind". {not in Vi}
642
643 *:la* *:last*
644:la[st] [++opt] [+cmd]
645 Start editing the last file in the argument list.
646 This fails when changes have been made and Vim does
647 not want to |abandon| the current buffer.
648 Also see |++opt| and |+cmd|. {not in Vi}
649
650:la[st]! [++opt] [+cmd]
651 Start editing the last file in the argument list.
652 Discard any changes to the buffer. Also see |++opt|
653 and |+cmd|. {not in Vi}
654
655 *:wn* *:wnext*
656:[count]wn[ext] [++opt] [+cmd]
657 Write current file and start editing the [count]
658 next file. Also see |++opt| and |+cmd|. {not in Vi}
659
660:[count]wn[ext] [++opt] [+cmd] {file}
661 Write current file to {file} and start editing the
662 [count] next file, unless {file} already exists and
663 the 'writeany' option is off. Also see |++opt| and
664 |+cmd|. {not in Vi}
665
666:[count]wn[ext]! [++opt] [+cmd] {file}
667 Write current file to {file} and start editing the
668 [count] next file. Also see |++opt| and |+cmd|. {not
669 in Vi}
670
671:[count]wN[ext][!] [++opt] [+cmd] [file] *:wN* *:wNext*
Bram Moolenaar81695252004-12-29 20:58:21 +0000672:[count]wp[revious][!] [++opt] [+cmd] [file] *:wp* *:wprevious*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000673 Same as :wnext, but go to previous file instead of
674 next. {not in Vi}
675
676The [count] in the commands above defaults to one. For some commands it is
677possible to use two counts. The last one (rightmost one) is used.
678
679If no [+cmd] argument is present, the cursor is positioned at the last known
680cursor position for the file. If 'startofline' is set, the cursor will be
681positioned at the first non-blank in the line, otherwise the last know column
682is used. If there is no last known cursor position the cursor will be in the
683first line (the last line in Ex mode).
684
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000685 *{arglist}*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000686The wildcards in the argument list are expanded and the file names are sorted.
687Thus you can use the command "vim *.c" to edit all the C files. From within
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000688Vim the command ":n *.c" does the same.
689
690White space is used to separate file names. Put a backslash before a space or
691Tab to include it in a file name. E.g., to edit the single file "foo bar": >
692 :next foo\ bar
693
694On Unix and a few other systems you can also use backticks, for example: >
695 :next `find . -name \\*.c -print`
Bram Moolenaar071d4272004-06-13 20:20:40 +0000696The backslashes before the star are required to prevent "*.c" to be expanded
697by the shell before executing the find program.
698
699 *arglist-position*
700When there is an argument list you can see which file you are editing in the
701title of the window (if there is one and 'title' is on) and with the file
702message you get with the "CTRL-G" command. You will see something like
703 (file 4 of 11)
704If 'shortmess' contains 'f' it will be
705 (4 of 11)
706If you are not really editing the file at the current position in the argument
707list it will be
708 (file (4) of 11)
709This means that you are position 4 in the argument list, but not editing the
710fourth file in the argument list. This happens when you do ":e file".
711
712
713LOCAL ARGUMENT LIST
714
715{not in Vi}
716{not available when compiled without the |+windows| or |+listcmds| feature}
717
718 *:arglocal*
719:argl[ocal] Make a local copy of the global argument list.
720 Doesn't start editing another file.
721
722:argl[ocal][!] [++opt] [+cmd] {arglist}
723 Define a new argument list, which is local to the
724 current window. Works like |:args_f| otherwise.
725
726 *:argglobal*
727:argg[lobal] Use the global argument list for the current window.
728 Doesn't start editing another file.
729
730:argg[lobal][!] [++opt] [+cmd] {arglist}
731 Use the global argument list for the current window.
732 Define a new global argument list like |:args_f|.
733 All windows using the global argument list will see
734 this new list.
735
736There can be several argument lists. They can be shared between windows.
737When they are shared, changing the argument list in one window will also
738change it in the other window.
739
740When a window is split the new window inherits the argument list from the
741current window. The two windows then share this list, until one of them uses
742|:arglocal| or |:argglobal| to use another argument list.
743
744
745USING THE ARGUMENT LIST
746
747 *:argdo*
748:argdo[!] {cmd} Execute {cmd} for each file in the argument list.
749 It works like doing this: >
750 :rewind
751 :{cmd}
752 :next
753 :{cmd}
754 etc.
755< When the current file can't be |abandon|ed and the [!]
756 is not present, the command fails.
757 When an error is detected on one file, further files
758 in the argument list will not be visited.
759 The last file in the argument list (or where an error
760 occurred) becomes the current file.
761 {cmd} can contain '|' to concatenate several commands.
762 {cmd} must not change the argument list.
763 Note: While this command is executing, the Syntax
764 autocommand event is disabled by adding it to
765 'eventignore'. This considerably speeds up editing
766 each file.
767 {not in Vi} {not available when compiled without the
768 |+listcmds| feature}
769 Also see |:windo| and |:bufdo|.
770
771Example: >
772 :args *.c
773 :argdo set ff=unix | update
774This sets the 'fileformat' option to "unix" and writes the file if is now
775changed. This is done for all *.c files.
776
777Example: >
778 :args *.[ch]
779 :argdo %s/\<my_foo\>/My_Foo/ge | update
780This changes the word "my_foo" to "My_Foo" in all *.c and *.h files. The "e"
781flag is used for the ":substitute" command to avoid an error for files where
782"my_foo" isn't used. ":update" writes the file only if changes were made.
783
784==============================================================================
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00007854. Writing *writing* *save-file*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000786
787Note: When the 'write' option is off, you are not able to write any file.
788
789 *:w* *:write*
790 *E502* *E503* *E504* *E505*
791 *E512* *E514* *E667*
792:w[rite] Write the whole buffer to the current file. This is
793 the normal way to save changes to a file. It fails
794 when the 'readonly' option is set or when there is
795 another reason why the file can't be written.
796
797:w[rite]! Like ":write", but forcefully write when 'readonly' is
798 set or there is another reason why writing was
799 refused.
800 Note: This may change the permission and ownership of
801 the file and break (symbolic) links. Add the 'W' flag
802 to 'cpoptions' to avoid this.
803
804:[range]w[rite][!] Write the specified lines to the current file. This
805 is unusual, because the file will not contain all
806 lines in the buffer.
807
808 *:w_f* *:write_f*
809:[range]w[rite] {file} Write the specified lines to {file}, unless it
810 already exists and the 'writeany' option is off.
811
812 *:w!*
813:[range]w[rite]! {file} Write the specified lines to {file}. Overwrite an
814 existing file.
815
816 *:w_a* *:write_a* *E494*
817:[range]w[rite][!] >> Append the specified lines to the current file.
818
819:[range]w[rite][!] >> {file}
820 Append the specified lines to {file}. '!' forces the
821 write even if file does not exist.
822
823 *:w_c* *:write_c*
824:[range]w[rite] !{cmd} Execute {cmd} with [range] lines as standard input
825 (note the space in front of the '!'). {cmd} is
826 executed like with ":!{cmd}", any '!' is replaced with
827 the previous command |:!|.
828
Bram Moolenaar5c4e21c2004-10-12 19:54:52 +0000829The default [range] for the ":w" command is the whole buffer (1,$). If you
830write the whole buffer, it is no longer considered changed. Also when you
831write it to a different file with ":w somefile"!
832
Bram Moolenaar071d4272004-06-13 20:20:40 +0000833If a file name is given with ":w" it becomes the alternate file. This can be
834used, for example, when the write fails and you want to try again later with
835":w #". This can be switched off by removing the 'A' flag from the
836'cpoptions' option.
837
838 *:sav* *:saveas*
839:sav[eas][!] {file} Save the current buffer under the name {file} and set
840 the filename of the current buffer to {file}. The
841 previous name is used for the alternate file name.
842 The [!] is needed to overwrite an existing file.
843 {not in Vi}
844
845 *:up* *:update*
846:[range]up[date][!] [>>] [file]
847 Like ":write", but only write when the buffer has been
848 modified. {not in Vi}
849
850
851WRITING WITH MULTIPLE BUFFERS *buffer-write*
852
853 *:wa* *:wall*
854:wa[ll] Write all changed buffers. Buffers without a file
855 name or which are readonly are not written. {not in
856 Vi}
857
858:wa[ll]! Write all changed buffers, even the ones that are
859 readonly. Buffers without a file name are not
860 written. {not in Vi}
861
862
863Vim will warn you if you try to overwrite a file that has been changed
864elsewhere. See |timestamp|.
865
866 *backup* *E207* *E506* *E507* *E508* *E509* *E510*
867If you write to an existing file (but do not append) while the 'backup',
868'writebackup' or 'patchmode' option is on, a backup of the original file is
869made. The file is either copied or renamed (see 'backupcopy'). After the
870file has been successfully written and when the 'writebackup' option is on and
871the 'backup' option is off, the backup file is deleted. When the 'patchmode'
872option is on the backup file may be renamed.
873
874 *backup-table*
875'backup' 'writebackup' action ~
876 off off no backup made
877 off on backup current file, deleted afterwards (default)
878 on off delete old backup, backup current file
879 on on delete old backup, backup current file
880
881When the 'backupskip' pattern matches with the name of the file which is
882written, no backup file is made. The values of 'backup' and 'writebackup' are
883ignored then.
884
885When the 'backup' option is on, an old backup file (with the same name as the
886new backup file) will be deleted. If 'backup' is not set, but 'writebackup'
887is set, an existing backup file will not be deleted. The backup file that is
888made while the file is being written will have a different name.
889
890On some filesystems it's possible that in a crash you lose both the backup and
891the newly written file (it might be there but contain bogus data). In that
892case try recovery, because the swap file is synced to disk and might still be
893there. |:recover|
894
895The directories given with the 'backupdir' option is used to put the backup
896file in. (default: same directory as the written file).
897
898Whether the backup is a new file, which is a copy of the original file, or the
899original file renamed depends on the 'backupcopy' option. See there for an
900explanation of when the copy is made and when the file is renamed.
901
902If the creation of a backup file fails, the write is not done. If you want
903to write anyway add a '!' to the command.
904
905 *write-readonly*
906When the 'cpoptions' option contains 'W', Vim will refuse to overwrite a
907readonly file. When 'W' is not present, ":w!" will overwrite a readonly file,
908if the system allows it (the directory must be writable).
909
910 *write-fail*
911If the writing of the new file fails, you have to be careful not to lose
912your changes AND the original file. If there is no backup file and writing
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000913the new file failed, you have already lost the original file! DON'T EXIT VIM
914UNTIL YOU WRITE OUT THE FILE! If a backup was made, it is put back in place
Bram Moolenaar071d4272004-06-13 20:20:40 +0000915of the original file (if possible). If you exit Vim, and lose the changes
916you made, the original file will mostly still be there. If putting back the
917original file fails, there will be an error message telling you that you
918lost the original file.
919
920 *DOS-format-write*
921If the 'fileformat' is "dos", <CR> <NL> is used for <EOL>. This is default
922for MS-DOS, Win32 and OS/2. On other systems the message "[dos format]" is
923shown to remind you that an unusual <EOL> was used.
924 *Unix-format-write*
925If the 'fileformat' is "unix", <NL> is used for <EOL>. On MS-DOS, Win32 and
926OS/2 the message "[unix format]" is shown.
927 *Mac-format-write*
928If the 'fileformat' is "mac", <CR> is used for <EOL>. On non-Mac systems the
929message "[mac format]" is shown.
930
931See also |file-formats| and the 'fileformat' and 'fileformats' options.
932
933 *ACL*
934ACL stands for Access Control List. It is an advanced way to control access
935rights for a file. It is used on new MS-Windows and Unix systems, but only
936when the filesystem supports it.
937 Vim attempts to preserve the ACL info when writing a file. The backup file
938will get the ACL info of the original file.
939 The ACL info is also used to check if a file is read-only (when opening the
940file).
941
942 *read-only-share*
943When MS-Windows shares a drive on the network it can be marked as read-only.
944This means that even if the file read-only attribute is absent, and the ACL
945settings on NT network shared drives allow writing to the file, you can still
946not write to the file. Vim on Win32 platforms will detect read-only network
947drives and will mark the file as read-only. You will not be able to override
948it with |:write|.
949
950 *write-device*
951When the file name is actually a device name, Vim will not make a backup (that
952would be impossible). You need to use "!", since the device already exists.
953Example for Unix: >
954 :w! /dev/lpt0
955and for MS-DOS or MS-Windows: >
956 :w! lpt0
957For Unix a device is detected when the name doesn't refer to a normal file or
958a directory. A fifo or named pipe also looks like a device to Vim.
959For MS-DOS and MS-Windows the device is detected by its name:
960 AUX
961 CON
962 CLOCK$
963 NUL
964 PRN
965 COMn n=1,2,3... etc
966 LPTn n=1,2,3... etc
967The names can be in upper- or lowercase.
968
969==============================================================================
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00009705. Writing and quitting *write-quit*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000971
972 *:q* *:quit*
973:q[uit] Quit the current window. Quit Vim if this is the last
974 window. This fails when changes have been made and
975 Vim refuses to |abandon| the current buffer, and when
976 the last file in the argument list has not been
977 edited.
978
979:conf[irm] q[uit] Quit, but give prompt when changes have been made, or
980 the last file in the argument list has not been
981 edited. See |:confirm| and 'confirm'. {not in Vi}
982
983:q[uit]! Quit without writing, also when visible buffers have
984 changes. Does not exit when there are changed hidden
985 buffers. Use ":qall!" to exit always.
986
987:cq[uit] Quit always, without writing, and return an error
988 code. See |:cq|. Used for Manx's QuickFix mode (see
989 |quickfix|). {not in Vi}
990
991 *:wq*
992:wq Write the current file and quit. Writing fails when
993 the file is read-only or the buffer does not have a
994 name. Quitting fails when the last file in the
995 argument list has not been edited.
996
997:wq! Write the current file and quit. Writing fails when
998 the current buffer does not have a name.
999
1000:wq {file} Write to {file} and quit. Quitting fails when the
1001 last file in the argument list has not been edited.
1002
1003:wq! {file} Write to {file} and quit.
1004
1005:[range]wq[!] [file] Same as above, but only write the lines in [range].
1006
1007 *:x* *:xit*
1008:[range]x[it][!] [file]
1009 Like ":wq", but write only when changes have been
1010 made.
1011 When 'hidden' is set and there are more windows, the
1012 current buffer becomes hidden, after writing the file.
1013
1014 *:exi* *:exit*
1015:[range]exi[t][!] [file]
1016 Same as :xit.
1017
1018 *ZZ*
1019ZZ Write current file, if modified, and quit (same as
1020 ":x"). (Note: If there are several windows for the
1021 current file, the file is written if it was modified
1022 and the window is closed).
1023
1024 *ZQ*
1025ZQ Quit without checking for changes (same as ":q!").
1026 {not in Vi}
1027
1028MULTIPLE WINDOWS AND BUFFERS *window-exit*
1029
1030 *:qa* *:qall*
1031:qa[ll] Exit Vim, unless there are some buffers which have been
1032 changed. (Use ":bmod" to go to the next modified buffer).
1033 When 'autowriteall' is set all changed buffers will be
1034 written, like |:wqall|. {not in Vi}
1035
1036:conf[irm] qa[ll]
1037 Exit Vim. Bring up a prompt when some buffers have been
1038 changed. See |:confirm|. {not in Vi}
1039
1040:qa[ll]! Exit Vim. Any changes to buffers are lost. {not in Vi}
1041
1042 *:quita* *:quitall*
1043:quita[ll][!] Same as ":qall". {not in Vi}
1044
1045:wqa[ll] *:wqa* *:wqall* *:xa* *:xall*
1046:xa[ll] Write all changed buffers and exit Vim. If there are buffers
1047 without a file name, which are readonly or which cannot be
1048 written for another reason, Vim will not quit. {not in Vi}
1049
1050:conf[irm] wqa[ll]
1051:conf[irm] xa[ll]
1052 Write all changed buffers and exit Vim. Bring up a prompt
1053 when some buffers are readonly or cannot be written for
1054 another reason. See |:confirm|. {not in Vi}
1055
1056:wqa[ll]!
1057:xa[ll]! Write all changed buffers, even the ones that are readonly,
1058 and exit Vim. If there are buffers without a file name or
1059 which cannot be written for another reason, Vim will not quit.
1060 {not in Vi}
1061
1062==============================================================================
Bram Moolenaar1cd871b2004-12-19 22:46:22 +000010636. Dialogs *edit-dialogs*
1064
1065 *:confirm* *:conf*
1066:conf[irm] {command} Execute {command}, and use a dialog when an
1067 operation has to be confirmed. Can be used on the
1068 ":q", ":qa" and ":w" commands (the latter to over-ride
1069 a read-only setting).
1070
1071Examples: >
1072 :confirm w foo
1073< Will ask for confirmation when "foo" already exists. >
1074 :confirm q
1075< Will ask for confirmation when there are changes. >
1076 :confirm qa
1077< If any modified, unsaved buffers exist, you will be prompted to save
1078 or abandon each one. There are also choices to "save all" or "abandon
1079 all".
1080
1081If you want to always use ":confirm", set the 'confirm' option.
1082
1083 *:browse* *:bro* *E338* *E614* *E615* *E616* *E578*
1084:bro[wse] {command} Open a file selection dialog for an argument to
1085 {command}. At present this works for |:e|, |:w|,
1086 |:r|, |:saveas|, |:sp|, |:mkexrc|, |:mkvimrc| and
1087 |:mksession|.
1088 {only in Win32, Athena, Motif, GTK and Mac GUI}
1089 When ":browse" is not possible you get an error
1090 message. If the |+browse| feature is missing or the
1091 {command} doesn't support browsing, the {command} is
1092 executed without a dialog.
1093 ":browse set" works like |:options|.
1094
1095The syntax is best shown via some examples: >
1096 :browse e $vim/foo
1097< Open the browser in the $vim/foo directory, and edit the
1098 file chosen. >
1099 :browse e
1100< Open the browser in the directory specified with 'browsedir',
1101 and edit the file chosen. >
1102 :browse w
1103< Open the browser in the directory of the current buffer,
1104 with the current buffer filename as default, and save the
1105 buffer under the filename chosen. >
1106 :browse w C:/bar
1107< Open the browser in the C:/bar directory, with the current
1108 buffer filename as default, and save the buffer under the
1109 filename chosen.
1110Also see the |'browsedir'| option.
1111For versions of Vim where browsing is not supported, the command is executed
1112unmodified.
1113
1114 *browsefilter*
1115For MS Windows, you can modify the filters that are used in the browse dialog.
1116By setting the g:browsefilter or b:browsefilter variables, you can change the
1117filters globally or locally to the buffer. The variable is set to a string in
1118the format "{filter label}\t{pattern};{pattern}\n" where {filter label} is the
1119text that appears in the "Files of Type" comboBox, and {pattern} is the
1120pattern which filters the filenames. Several patterns can be given, separated
1121by ';'.
1122
1123For Motif the same format is used, but only the very first pattern is actually
1124used (Motif only offers one pattern, but you can edit it).
1125
1126For example, to have only Vim files in the dialog, you could use the following
1127command: >
1128
1129 let g:browsefilter="Vim Scripts\t*.vim\nVim Startup Files\t*vimrc\n"
1130
1131You can override the filter setting on a per-buffer basis by setting the
1132b:browsefilter variable. You would most likely set b:browsefilter in a
1133filetype plugin, so that the browse dialog would contain entries related to
1134the type of file you are currently editing. Disadvantage: This makes it
1135difficult to start editing a file of a different type. To overcome this, you
1136may want to add "All Files\t*.*\n" as the final filter, so that the user can
1137still access any desired file.
1138
1139==============================================================================
11407. The current directory *current-directory*
1141
1142You may use the |:cd| and |:lcd| commands to change to another directory, so
1143you will not have to type that directory name in front of the file names. It
1144also makes a difference for executing external commands, e.g. ":!ls".
1145
Bram Moolenaardf177f62005-02-22 08:39:57 +00001146Changing directory fails when the current buffer is modified, the '.' flag is
1147present in 'cpoptions' and "!" is not used in the command.
1148
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001149 *:cd* *E472*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001150:cd[!] On non-Unix systems: Print the current directory
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001151 name. On Unix systems: Change the current directory
1152 to the home directory. Use |:pwd| to print the
1153 current directory on all systems.
1154
Bram Moolenaardf177f62005-02-22 08:39:57 +00001155:cd[!] {path} Change the current directory to {path}.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001156 If {path} is relative, it is searched for in the
1157 directories listed in |'cdpath'|.
1158 Does not change the meaning of an already opened file,
1159 because its full path name is remembered. Files from
1160 the |arglist| may change though!
1161 On MS-DOS this also changes the active drive.
1162 To change to the directory of the current file: >
1163 :cd %:h
1164<
1165 *:cd-* *E186*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001166:cd[!] - Change to the previous current directory (before the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001167 previous ":cd {path}" command). {not in Vi}
1168
1169 *:chd* *:chdir*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001170:chd[ir][!] [path] Same as |:cd|.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001171
1172 *:lc* *:lcd*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001173:lc[d][!] {path} Like |:cd|, but only set the current directory for the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001174 current window. The current directory for other
1175 windows is not changed. {not in Vi}
1176
1177 *:lch* *:lchdir*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001178:lch[dir][!] Same as |:lcd|. {not in Vi}
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001179
1180 *:pw* *:pwd* *E187*
1181:pw[d] Print the current directory name. {Vi: no pwd}
1182 Also see |getcwd()|.
1183
1184So long as no |:lcd| command has been used, all windows share the same current
1185directory. Using a command to jump to another window doesn't change anything
1186for the current directory.
1187When a |:lcd| command has been used for a window, the specified directory
1188becomes the current directory for that window. Windows where the |:lcd|
1189command has not been used stick to the global current directory. When jumping
1190to another window the current directory will become the last specified local
1191current directory. If none was specified, the global current directory is
1192used.
1193When a |:cd| command is used, the current window will lose his local current
1194directory and will use the global current directory from now on.
1195
1196After using |:cd| the full path name will be used for reading and writing
1197files. On some networked file systems this may cause problems. The result of
1198using the full path name is that the file names currently in use will remain
1199referring to the same file. Example: If you have a file a:test and a
1200directory a:vim the commands ":e test" ":cd vim" ":w" will overwrite the file
1201a:test and not write a:vim/test. But if you do ":w test" the file a:vim/test
1202will be written, because you gave a new file name and did not refer to a
1203filename before the ":cd".
1204
1205==============================================================================
Bram Moolenaar071d4272004-06-13 20:20:40 +000012068. Editing binary files *edit-binary*
1207
1208Although Vim was made to edit text files, it is possible to edit binary
1209files. The |-b| Vim argument (b for binary) makes Vim do file I/O in binary
1210mode, and sets some options for editing binary files ('binary' on, 'textwidth'
1211to 0, 'modeline' off, 'expandtab' off). Setting the 'binary' option has the
1212same effect. Don't forget to do this before reading the file.
1213
1214There are a few things to remember when editing binary files:
1215- When editing executable files the number of characters must not change.
1216 Use only the "R" or "r" command to change text. Do not delete characters
1217 with "x" or by backspacing.
1218- Set the 'textwidth' option to 0. Otherwise lines will unexpectedly be
1219 split in two.
1220- When there are not many <EOL>s, the lines will become very long. If you
1221 want to edit a line that does not fit on the screen reset the 'wrap' option.
1222 Horizontal scrolling is used then. If a line becomes too long (more than
1223 about 32767 characters on the Amiga, much more on 32-bit systems, see
1224 |limits|) you cannot edit that line. The line will be split when reading
1225 the file. It is also possible that you get an "out of memory" error when
1226 reading the file.
1227- Make sure the 'binary' option is set BEFORE loading the
1228 file. Otherwise both <CR> <NL> and <NL> are considered to end a line
1229 and when the file is written the <NL> will be replaced with <CR> <NL>.
1230- <Nul> characters are shown on the screen as ^@. You can enter them with
1231 "CTRL-V CTRL-@" or "CTRL-V 000" {Vi cannot handle <Nul> characters in the
1232 file}
1233- To insert a <NL> character in the file split up a line. When writing the
1234 buffer to a file a <NL> will be written for the <EOL>.
1235- Vim normally appends an <EOL> at the end of the file if there is none.
1236 Setting the 'binary' option prevents this. If you want to add the final
1237 <EOL>, set the 'endofline' option. You can also read the value of this
1238 option to see if there was an <EOL> for the last line (you cannot see this
1239 in the text).
1240
1241==============================================================================
12429. Encryption *encryption*
1243
1244Vim is able to write files encrypted, and read them back. The encrypted text
1245cannot be read without the right key.
1246
1247Note: The swapfile and text in memory is not encrypted. A system
1248administrator will be able to see your text while you are editing it.
1249When filtering text with ":!filter" or using ":w !command" the text is not
1250encrypted, this may reveal it to others.
1251
1252WARNING: If you make a typo when entering the key and then write the file and
1253exit, the text will be lost!
1254
1255The normal way to work with encryption, is to use the ":X" command, which will
1256ask you to enter a key. A following write command will use that key to
1257encrypt the file. If you later edit the same file, Vim will ask you to enter
1258a key. If you type the same key as that was used for writing, the text will
1259be readable again. If you use a wrong key, it will be a mess.
1260
1261 *:X*
1262:X Prompt for an encryption key. The typing is done without showing the
1263 actual text, so that someone looking at the display won't see it.
1264 The typed key is stored in the 'key' option, which is used to encrypt
1265 the file when it is written. The file will remain unchanged until you
1266 write it. See also |-x|.
1267
1268The value of the 'key' options is used when text is written. When the option
1269is not empty, the written file will be encrypted, using the value as the
1270encryption key. A magic number is prepended, so that Vim can recognize that
1271the file is encrypted.
1272
1273To disable the encryption, reset the 'key' option to an empty value: >
1274 :set key=
1275
1276When reading a file that has been encrypted and this option is not empty, it
1277will be used for decryption. If the value is empty, you will be prompted to
1278enter the key. If you don't enter a key, the file is edited without being
1279decrypted.
1280
1281If want to start reading a file that uses a different key, set the 'key'
1282option to an empty string, so that Vim will prompt for a new one. Don't use
1283the ":set" command to enter the value, other people can read the command over
1284your shoulder.
1285
1286Since the value of the 'key' option is supposed to be a secret, its value can
1287never be viewed. You should not set this option in a vimrc file.
1288
1289An encrypted file can be recognized by the "file" command, if you add this
1290line to "/etc/magic", "/usr/share/misc/magic" or wherever your system has the
1291"magic" file: >
1292 0 string VimCrypt~ Vim encrypted file
1293
1294Notes:
1295- Encryption is not possible when doing conversion with 'charconvert'.
1296- Text you copy or delete goes to the numbered registers. The registers can
1297 be saved in the .viminfo file, where they could be read. Change your
1298 'viminfo' option to be safe.
1299- Someone can type commands in Vim when you walk away for a moment, he should
1300 not be able to get the key.
1301- If you make a typing mistake when entering the key, you might not be able to
1302 get your text back!
1303- If you type the key with a ":set key=value" command, it can be kept in the
1304 history, showing the 'key' value in a viminfo file.
1305- There is never 100% safety. The encryption in Vim has not been tested for
1306 robustness.
1307- The algorithm used is breakable. A 4 character key in about one hour, a 6
1308 character key in one day (on a Pentium 133 PC). This requires that you know
1309 some text that must appear in the file. An expert can break it for any key.
1310 When the text has been decrypted, this also means that the key can be
1311 revealed, and other files encrypted with the same key can be decrypted.
1312- Pkzip uses the same encryption, and US Govt has no objection to its export.
1313 Pkzip's public file APPNOTE.TXT describes this algorithm in detail.
1314- Vim originates from the Netherlands. That is where the sources come from.
1315 Thus the encryption code is not exported from the USA.
1316
1317==============================================================================
131810. Timestamps *timestamp* *timestamps*
1319
1320Vim remembers the modification timestamp of a file when you begin editing it.
1321This is used to avoid that you have two different versions of the same file
1322(without you knowing this).
1323
1324After a shell command is run (|:!cmd| |suspend| |:read!| |K|) timestamps are
1325compared for all buffers in a window. Vim will run any associated
1326|FileChangedShell| autocommands or display a warning for any files that have
1327changed. In the GUI this happens when Vim regains input focus.
1328
1329 *E321* *E462*
1330If you want to automatically reload a file when it has been changed outside of
1331Vim, set the 'autoread' option. This doesn't work at the moment you write the
1332file though, only when the file wasn't changed inside of Vim.
1333
1334Note that if a FileChangedShell autocommand is defined you will not get a
1335warning message or prompt. The autocommand is expected to handle this.
1336
Bram Moolenaar10de2da2005-01-27 14:33:00 +00001337There is no warning for a directory (e.g., with |netrw-browse|). But you do
1338get warned if you started editing a new file and it was created as a directory
1339later.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001340
1341When Vim notices the timestamp of a file has changed, and the file is being
1342edited in a buffer but has not changed, Vim checks if the contents of the file
1343is equal. This is done by reading the file again (into a hidden buffer, which
1344is immediately deleted again) and comparing the text. If the text is equal,
1345you will get no warning.
1346
1347If you don't get warned often enough you can use the following command.
1348
1349 *:checkt* *:checktime*
1350:checkt[ime] Check if any buffers were changed outside of Vim.
1351 This checks and warns you if you would end up with two
1352 versions of a file.
1353 If this is called from an autocommand, a ":global"
1354 command or is not typed the actual check is postponed
1355 until a moment the side effects (reloading the file)
1356 would be harmless.
1357 Each loaded buffer is checked for its associated file
1358 being changed. If the file was changed Vim will take
1359 action. If there are no changes in the buffer and
1360 'autoread' is set, the buffer is reloaded. Otherwise,
1361 you are offered the choice of reloading the file. If
1362 the file was deleted you get an error message.
1363 If the file previously didn't exist you get a warning
1364 if it exists now.
1365 Once a file has been checked the timestamp is reset,
1366 you will not be warned again.
1367
1368:[N]checkt[ime] {filename}
1369:[N]checkt[ime] [N]
1370 Check the timestamp of a specific buffer. The buffer
1371 may be specified by name, number or with a pattern.
1372
1373
1374Before writing a file the timestamp is checked. If it has changed, Vim will
1375ask if you really want to overwrite the file:
1376
1377 WARNING: The file has been changed since reading it!!!
1378 Do you really want to write to it (y/n)?
1379
1380If you hit 'y' Vim will continue writing the file. If you hit 'n' the write is
1381aborted. If you used ":wq" or "ZZ" Vim will not exit, you will get another
1382chance to write the file.
1383
1384The message would normally mean that somebody has written to the file after
1385the edit session started. This could be another person, in which case you
1386probably want to check if your changes to the file and the changes from the
1387other person should be merged. Write the file under another name and check for
1388differences (the "diff" program can be used for this).
1389
1390It is also possible that you modified the file yourself, from another edit
1391session or with another command (e.g., a filter command). Then you will know
1392which version of the file you want to keep.
1393
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001394There is one situation where you get the message while there is nothing wrong:
1395On a Win32 system on the day daylight saving time starts. There is something
1396in the Win32 libraries that confuses Vim about the hour time difference. The
1397problem goes away the next day.
1398
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001399==============================================================================
140011. File Searching *file-searching*
1401
1402{not available when compiled without the |+path_extra| feature}
1403
1404The file searching is currently used for the 'path', 'cdpath' and 'tags'
1405options. There are three different types of searching:
1406
14071) Downward search:
1408 Downward search uses the wildcards '*', '**' and possibly others
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001409 supported by your operating system. '*' and '**' are handled inside Vim, so
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001410 they work on all operating systems.
1411
1412 The usage of '*' is quite simple: It matches 0 or more characters.
1413
1414 '**' is more sophisticated:
1415 - It ONLY matches directories.
Bram Moolenaar81695252004-12-29 20:58:21 +00001416 - It matches up to 30 directories deep, so you can use it to search an
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001417 entire directory tree
1418 - The maximum number of levels matched can be given by appending a number
1419 to '**'.
1420 Thus '/usr/**2' can match: >
1421 /usr
1422 /usr/include
1423 /usr/include/sys
1424 /usr/include/g++
1425 /usr/lib
1426 /usr/lib/X11
1427 ....
1428< It does NOT match '/usr/include/g++/std' as this would be three
1429 levels.
1430 The allowed number range is 0 ('**0' is removed) to 255.
1431 If the given number is smaller than 0 it defaults to 30, if it's
1432 bigger than 255 it defaults to 255.
1433 - '**' can only be at the end of the path or be followed by a path
1434 separator or by a number and a path separator.
1435
1436 You can combine '*' and '**' in any order: >
1437 /usr/**/sys/*
1438 /usr/*/sys/**
1439 /usr/**2/sys/*
1440
14412) Upward search:
1442 Here you can give a directory and then search the directory tree upward for
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001443 a file. You could give stop-directories to limit the upward search. The
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001444 stop-directories are appended to the path (for the 'path' option) or to
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001445 the filename (for the 'tags' option) with a ';'. If you want several
1446 stop-directories separate them with ';'. If you want no stop-directory
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001447 ("search upward till the root directory) just use ';'. >
1448 /usr/include/sys;/usr
1449< will search in: >
1450 /usr/include/sys
1451 /usr/include
1452 /usr
1453<
1454 If you use a relative path the upward search is started in Vim's current
1455 directory or in the directory of the current file (if the relative path
1456 starts with './' and 'd' is not included in 'cpoptions').
1457
1458 If Vim's current path is /u/user_x/work/release and you do >
1459 :set path=include;/u/user_x
1460< and then search for a file with |gf| the file is searched in: >
1461 /u/user_x/work/release/include
1462 /u/user_x/work/include
1463 /u/user_x/include
1464
Bram Moolenaar402d2fe2005-04-15 21:00:38 +000014653) Combined up/downward search:
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001466 If Vim's current path is /u/user_x/work/release and you do >
1467 set path=**;/u/user_x
1468< and then search for a file with |gf| the file is searched in: >
1469 /u/user_x/work/release/**
1470 /u/user_x/work/**
1471 /u/user_x/**
1472<
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001473 BE CAREFUL! This might consume a lot of time, as the search of
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001474 '/u/user_x/**' includes '/u/user_x/work/**' and
1475 '/u/user_x/work/release/**'. So '/u/user_x/work/release/**' is searched
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001476 three times and '/u/user_x/work/**' is searched twice.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001477
1478 In the above example you might want to set path to: >
1479 :set path=**,/u/user_x/**
1480< This searches: >
1481 /u/user_x/work/release/**
1482 /u/user_x/**
1483< This searches the same directories, but in a different order.
1484
Bram Moolenaar071d4272004-06-13 20:20:40 +00001485
1486 vim:tw=78:ts=8:ft=help:norl: