xref: /vim-8.2.3635/runtime/doc/editing.txt (revision 25c9c680)
1*editing.txt*   For Vim version 8.1.  Last change: 2019 May 05
2
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|
113.  The argument list		|argument-list|
124.  Writing			|writing|
135.  Writing and quitting	|write-quit|
146.  Dialogs			|edit-dialogs|
157.  The current directory	|current-directory|
168.  Editing binary files	|edit-binary|
179.  Encryption			|encryption|
1810. Timestamps			|timestamps|
1911. File Searching		|file-searching|
20
21==============================================================================
221. Introduction						*edit-intro*
23
24Editing a file with Vim means:
25
261. reading the file into a buffer
272. 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
33remembered as the "current file name".  This is also known as the name of the
34current buffer.  It can be used with "%" on the command line |:_%|.
35
36							*alternate-file*
37If there already was a current file name, then that one becomes the alternate
38file 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.
41An alternate file name is remembered for each window.
42
43							*:keepalt* *:keepa*
44:keepalt {cmd}		Execute {cmd} while keeping the current alternate file
45			name.  Note that commands invoked indirectly (e.g.,
46			with a function) may still set the alternate file
47			name.
48
49All file names are remembered in the buffer list.  When you enter a file name,
50for editing (e.g., with ":e filename") or writing (e.g., with ":w filename"),
51the file name is added to the list.  You can use the buffer list to remember
52which files you edited and to quickly switch from one file to another (e.g.,
53to copy text) with the |CTRL-^| command.  First type the number of the file
54and then hit CTRL-^.  {Vi: only one alternate file name is remembered}
55
56
57CTRL-G		or				*CTRL-G* *:f* *:fi* *:file*
58:f[ile]			Prints the current file name (as typed, unless ":cd"
59			was used), the cursor position (unless the 'ruler'
60			option is set), and the file status (readonly,
61			modified, read errors, new file).  See the 'shortmess'
62			option about how to make this message shorter.
63
64:f[ile]!		like |:file|, but don't truncate the name even when
65			'shortmess' indicates this.
66
67{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.
70
71					*g_CTRL-G* *word-count* *byte-count*
72g 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			Also see the 'ruler' option and the |wordcount()|
81			function.
82
83							*v_g_CTRL-G*
84{Visual}g CTRL-G	Similar to "g CTRL-G", but Word, Character, Line, and
85			Byte counts for the visually selected region are
86			displayed.
87			In Blockwise mode, Column count is also shown.  (For
88			{Visual} see |Visual-mode|.)
89
90							*:file_f*
91:f[ile][!] {name}	Sets the current file name to {name}.  The optional !
92			avoids truncating the message, as with |:file|.
93			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.
96							*:0file*
97:0f[ile][!]		Remove the name of the current buffer.  The optional !
98			avoids truncating the message, as with |:file|.
99
100:buffers
101:files
102:ls			List all the currently known file names.  See
103			'windows.txt' |:files| |:buffers| |:ls|.
104
105Vim will remember the full path name of a file name that you enter.  In most
106cases when the file name is displayed only the name you typed is shown, but
107the full path name is being used if you used the ":cd" command |:cd|.
108
109							*home-replace*
110If the environment variable $HOME is set, and the file name starts with that
111string, it is often displayed with HOME replaced with "~".  This was done to
112keep file names short.  When reading or writing files the full name is still
113used, the "~" is only used when displaying file names.  When replacing the
114file name would result in just "~", "~/" is used instead (to avoid confusion
115between options set to $HOME with 'backupext' set to "~").
116
117When writing the buffer, the default is to use the current file name.  Thus
118when you give the "ZZ" or ":wq" command, the original file will be
119overwritten.  If you do not want this, the buffer can be written into another
120file by giving a file name argument to the ":write" command.  For example: >
121
122	vim testfile
123	[change the buffer with editor commands]
124	:w newfile
125	:q
126
127This will create a file "newfile", that is a modified copy of "testfile".
128The file "testfile" will remain unchanged.  Anyway, if the 'backup' option is
129set, Vim renames or copies the original file before it will be overwritten.
130You can use this file if you discover that you need the original file.  See
131also the 'patchmode' option.  The name of the backup file is normally the same
132as the original file with 'backupext' appended.  The default "~" is a bit
133strange to avoid accidentally overwriting existing files.  If you prefer ".bak"
134change the 'backupext' option.  Extra dots are replaced with '_' on MS-DOS
135machines, when Vim has detected that an MS-DOS-like filesystem is being used
136(e.g., messydos or crossdos) or when the 'shortname' option is on.  The
137backup file can be placed in another directory by setting 'backupdir'.
138
139							*auto-shortname*
140Technical: On the Amiga you can use 30 characters for a file name.  But on an
141	   MS-DOS-compatible filesystem only 8 plus 3 characters are
142	   available.  Vim tries to detect the type of filesystem when it is
143	   creating the .swp file.  If an MS-DOS-like filesystem is suspected,
144	   a flag is set that has the same effect as setting the 'shortname'
145	   option.  This flag will be reset as soon as you start editing a
146	   new file.  The flag will be used when making the file name for the
147	   ".swp" and ".~" files for the current file.  But when you are
148	   editing a file in a normal filesystem and write to an MS-DOS-like
149	   filesystem the flag will not have been set.  In that case the
150	   creation of the ".~" file may fail and you will get an error
151	   message.  Use the 'shortname' option in this case.
152
153When you started editing without giving a file name, "No File" is displayed in
154messages.  If the ":write" command is used with a file name argument, the file
155name for the current file is set to that file name.  This only happens when
156the 'F' flag is included in 'cpoptions' (by default it is included) |cpo-F|.
157This is useful when entering text in an empty buffer and then writing it to a
158file.  If 'cpoptions' contains the 'f' flag (by default it is NOT included)
159|cpo-f| the file name is set for the ":read file" command.  This is useful
160when starting Vim without an argument and then doing ":read file" to start
161editing a file.
162When the file name was set and 'filetype' is empty the filetype detection
163autocommands will be triggered.
164							*not-edited*
165Because the file name was set without really starting to edit that file, you
166are protected from overwriting that file.  This is done by setting the
167"notedited" flag.  You can see if this flag is set with the CTRL-G or ":file"
168command.  It will include "[Not edited]" when the "notedited" flag is set.
169When writing the buffer to the current file name (with ":w!"), the "notedited"
170flag is reset.
171
172							*abandon*
173Vim remembers whether you have changed the buffer.  You are protected from
174losing the changes you made.  If you try to quit without writing, or want to
175start editing another file, Vim will refuse this.  In order to overrule this
176protection, add a '!' to the command.  The changes will then be lost.  For
177example: ":q" will not work if the buffer was changed, but ":q!" will.  To see
178whether the buffer was changed use the "CTRL-G" command.  The message includes
179the string "[Modified]" if the buffer has been changed, or "+" if the 'm' flag
180is in 'shortmess'.
181
182If you want to automatically save the changes without asking, switch on the
183'autowriteall' option.  'autowrite' is the associated Vi-compatible option
184that does not work for all commands.
185
186If you want to keep the changed buffer without saving it, switch on the
187'hidden' option.  See |hidden-buffer|.  Some commands work like this even when
188'hidden' is not set, check the help for the command.
189
190==============================================================================
1912. Editing a file					*edit-a-file*
192
193							*:e* *:edit* *reload*
194:e[dit] [++opt] [+cmd]	Edit the current file.  This is useful to re-edit the
195			current file, when it has been changed outside of Vim.
196			This fails when changes have been made to the current
197			buffer and 'autowriteall' isn't set or the file can't
198			be written.
199			Also see |++opt| and |+cmd|.
200			{Vi: no ++opt}
201
202							*:edit!* *discard*
203:e[dit]! [++opt] [+cmd]
204			Edit the current file always.  Discard any changes to
205			the current buffer.  This is useful if you want to
206			start all over again.
207			Also see |++opt| and |+cmd|.
208			{Vi: no ++opt}
209
210							*:edit_f*
211:e[dit] [++opt] [+cmd] {file}
212			Edit {file}.
213			This fails when changes have been made to the current
214			buffer, unless 'hidden' is set or 'autowriteall' is
215			set and the file can be written.
216			Also see |++opt| and |+cmd|.
217			{Vi: no ++opt}
218
219							*:edit!_f*
220:e[dit]! [++opt] [+cmd] {file}
221			Edit {file} always.  Discard any changes to the
222			current buffer.
223			Also see |++opt| and |+cmd|.
224			{Vi: no ++opt}
225
226:e[dit] [++opt] [+cmd] #[count]
227			Edit the [count]th buffer (as shown by |:files|).
228			This command does the same as [count] CTRL-^.  But ":e
229			#" doesn't work if the alternate buffer doesn't have a
230			file name, while CTRL-^ still works then.
231			Also see |++opt| and |+cmd|.
232			{Vi: no ++opt}
233
234							*:ene* *:enew*
235:ene[w]			Edit a new, unnamed buffer.  This fails when changes
236			have been made to the current buffer, unless 'hidden'
237			is set or 'autowriteall' is set and the file can be
238			written.
239			If 'fileformats' is not empty, the first format given
240			will be used for the new buffer.  If 'fileformats' is
241			empty, the 'fileformat' of the current buffer is used.
242
243							*:ene!* *:enew!*
244:ene[w]!		Edit a new, unnamed buffer.  Discard any changes to
245			the current buffer.
246			Set 'fileformat' like |:enew|.
247
248							*:fin* *:find*
249:fin[d][!] [++opt] [+cmd] {file}
250			Find {file} in 'path' and then |:edit| it.
251			{not available when the |+file_in_path| feature was
252			disabled at compile time}
253
254:{count}fin[d][!] [++opt] [+cmd] {file}
255			Just like ":find", but use the {count} match in
256			'path'.  Thus ":2find file" will find the second
257			"file" found in 'path'.  When there are fewer matches
258			for the file in 'path' than asked for, you get an
259			error message.
260
261							*:ex*
262:ex [++opt] [+cmd] [file]
263			Same as |:edit|.
264
265							*:vi* *:visual*
266:vi[sual][!] [++opt] [+cmd] [file]
267			When used in Ex mode: Leave |Ex-mode|, go back to
268			Normal mode.  Otherwise same as |:edit|.
269
270							*:vie* *:view*
271:vie[w][!] [++opt] [+cmd] file
272			When used in Ex mode: Leave |Ex-mode|, go back to
273			Normal mode.  Otherwise same as |:edit|, but set
274			'readonly' option for this buffer.
275
276							*CTRL-^* *CTRL-6*
277CTRL-^			Edit the alternate file.  Mostly the alternate file is
278			the previously edited file.  This is a quick way to
279			toggle between two files.  It is equivalent to ":e #",
280			except that it also works when there is no file name.
281
282			If the 'autowrite' or 'autowriteall' option is on and
283			the buffer was changed, write it.
284			Mostly the ^ character is positioned on the 6 key,
285			pressing CTRL and 6 then gets you what we call CTRL-^.
286			But on some non-US keyboards CTRL-^ is produced in
287			another way.
288
289{count}CTRL-^		Edit [count]th file in the buffer list (equivalent to
290			":e #[count]").  This is a quick way to switch between
291			files.
292			See |CTRL-^| above for further details.
293
294[count]]f						*]f* *[f*
295[count][f		Same as "gf".  Deprecated.
296
297							*gf* *E446* *E447*
298[count]gf		Edit the file whose name is under or after the cursor.
299			Mnemonic: "goto file".
300			Uses the 'isfname' option to find out which characters
301			are supposed to be in a file name.  Trailing
302			punctuation characters ".,:;!" are ignored. Escaped
303			spaces "\ " are reduced to a single space.
304			Uses the 'path' option as a list of directory names to
305			look for the file.  See the 'path' option for details
306			about relative directories and wildcards.
307			Uses the 'suffixesadd' option to check for file names
308			with a suffix added.
309			If the file can't be found, 'includeexpr' is used to
310			modify the name and another attempt is done.
311			If a [count] is given, the count'th file that is found
312			in the 'path' is edited.
313			This command fails if Vim refuses to |abandon| the
314			current file.
315			If you want to edit the file in a new window use
316			|CTRL-W_CTRL-F|.
317			If you do want to edit a new file, use: >
318				:e <cfile>
319<			To make gf always work like that: >
320				:map gf :e <cfile><CR>
321<			If the name is a hypertext link, that looks like
322			"type://machine/path", you need the |netrw| plugin.
323			For Unix the '~' character is expanded, like in
324			"~user/file".  Environment variables are expanded too
325			|expand-env|.
326			{not available when the |+file_in_path| feature was
327			disabled at compile time}
328
329							*v_gf*
330{Visual}[count]gf	Same as "gf", but the highlighted text is used as the
331			name of the file to edit.  'isfname' is ignored.
332			Leading blanks are skipped, otherwise all blanks and
333			special characters are included in the file name.
334			(For {Visual} see |Visual-mode|.)
335
336							*gF*
337[count]gF		Same as "gf", except if a number follows the file
338			name, then the cursor is positioned on that line in
339			the file. The file name and the number must be
340			separated by a non-filename (see 'isfname') and
341			non-numeric character. White space between the
342			filename, the separator and the number are ignored.
343			Examples:
344				eval.c:10 ~
345				eval.c @ 20 ~
346				eval.c (30) ~
347				eval.c 40 ~
348
349							*v_gF*
350{Visual}[count]gF	Same as "v_gf".
351
352These commands are used to start editing a single file.  This means that the
353file is read into the buffer and the current file name is set.  The file that
354is opened depends on the current directory, see |:cd|.
355
356See |read-messages| for an explanation of the message that is given after the
357file has been read.
358
359You can use the ":e!" command if you messed up the buffer and want to start
360all over again.  The ":e" command is only useful if you have changed the
361current file name.
362
363							*:filename* *{file}*
364Besides the things mentioned here, more special items for where a filename is
365expected are mentioned at |cmdline-special|.
366
367Note for systems other than Unix: When using a command that accepts a single
368file name (like ":edit file") spaces in the file name are allowed, but
369trailing spaces are ignored.  This is useful on systems that regularly embed
370spaces in file names (like MS-Windows and the Amiga).  Example: The command
371":e   Long File Name " will edit the file "Long File Name".  When using a
372command that accepts more than one file name (like ":next file1 file2")
373embedded spaces must be escaped with a backslash.
374
375						*wildcard* *wildcards*
376Wildcards in {file} are expanded, but as with file completion, 'wildignore'
377and 'suffixes' apply.  Which wildcards are supported depends on the system.
378These are the common ones:
379	?	matches one character
380	*	matches anything, including nothing
381	**	matches anything, including nothing, recurses into directories
382	[abc]	match 'a', 'b' or 'c'
383
384To avoid the special meaning of the wildcards prepend a backslash.  However,
385on MS-Windows the backslash is a path separator and "path\[abc]" is still seen
386as a wildcard when "[" is in the 'isfname' option.  A simple way to avoid this
387is to use "path\[[]abc]", this matches the file "path\[abc]".
388
389					*starstar-wildcard*
390Expanding "**" is possible on Unix, Win32, Mac OS/X and a few other systems.
391This allows searching a directory tree.  This goes up to 100 directories deep.
392Note there are some commands where this works slightly differently, see
393|file-searching|.
394Example: >
395	:n **/*.txt
396Finds files:
397	aaa.txt ~
398	subdir/bbb.txt ~
399	a/b/c/d/ccc.txt ~
400When non-wildcard characters are used right before or after "**" these are
401only matched in the top directory.  They are not used for directories further
402down in the tree. For example: >
403	:n /usr/inc**/types.h
404Finds files:
405	/usr/include/types.h ~
406	/usr/include/sys/types.h ~
407	/usr/inc/old/types.h ~
408Note that the path with "/sys" is included because it does not need to match
409"/inc".  Thus it's like matching "/usr/inc*/*/*...", not
410"/usr/inc*/inc*/inc*".
411
412					*backtick-expansion* *`-expansion*
413On Unix and a few other systems you can also use backticks for the file name
414argument, for example: >
415	:next `find . -name ver\\*.c -print`
416	:view `ls -t *.patch  \| head -n1`
417Vim will run the command in backticks using the 'shell' and use the standard
418output as argument for the given Vim command (error messages from the shell
419command will be discarded).
420To see what shell command Vim is running, set the 'verbose' option to 4. When
421the shell command returns a non-zero exit code, an error message will be
422displayed and the Vim command will be aborted. To avoid this make the shell
423always return zero like so: >
424       :next `find . -name ver\\*.c -print \|\| true`
425
426The backslashes before the star are required to prevent the shell from
427expanding "ver*.c" prior to execution of the find program.  The backslash
428before the shell pipe symbol "|" prevents Vim from parsing it as command
429termination.
430This also works for most other systems, with the restriction that the
431backticks must be around the whole item.  It is not possible to have text
432directly before the first or just after the last backtick.
433
434							*`=*
435You can have the backticks expanded as a Vim expression, instead of as an
436external command, by putting an equal sign right after the first backtick,
437e.g.: >
438	:e `=tempname()`
439The expression can contain just about anything, thus this can also be used to
440avoid the special meaning of '"', '|', '%' and '#'.  However, 'wildignore'
441does apply like to other wildcards.
442
443Environment variables in the expression are expanded when evaluating the
444expression, thus this works: >
445	:e `=$HOME . '/.vimrc'`
446This does not work, $HOME is inside a string and used literally: >
447	:e `='$HOME' . '/.vimrc'`
448
449If the expression returns a string then names are to be separated with line
450breaks.  When the result is a |List| then each item is used as a name.  Line
451breaks also separate names.
452Note that such expressions are only supported in places where a filename is
453expected as an argument to an Ex-command.
454
455							*++opt* *[++opt]*
456The [++opt] argument can be used to force the value of 'fileformat',
457'fileencoding' or 'binary' to a value for one command, and to specify the
458behavior for bad characters.  The form is: >
459	++{optname}
460Or: >
461	++{optname}={value}
462
463Where {optname} is one of:	    *++ff* *++enc* *++bin* *++nobin* *++edit*
464    ff     or  fileformat   overrides 'fileformat'
465    enc    or  encoding	    overrides 'fileencoding'
466    bin    or  binary	    sets 'binary'
467    nobin  or  nobinary	    resets 'binary'
468    bad			    specifies behavior for bad characters
469    edit		    for |:read| only: keep option values as if editing
470			    a file
471
472{value} cannot contain white space.  It can be any valid value for these
473options.  Examples: >
474	:e ++ff=unix
475This edits the same file again with 'fileformat' set to "unix". >
476
477	:w ++enc=latin1 newfile
478This writes the current buffer to "newfile" in latin1 format.
479
480There may be several ++opt arguments, separated by white space.  They must all
481appear before any |+cmd| argument.
482
483								*++bad*
484The argument of "++bad=" specifies what happens with characters that can't be
485converted and illegal bytes.  It can be one of three things:
486    ++bad=X      A single-byte character that replaces each bad character.
487    ++bad=keep   Keep bad characters without conversion.  Note that this may
488		 result in illegal bytes in your text!
489    ++bad=drop   Remove the bad characters.
490
491The default is like "++bad=?": Replace each bad character with a question
492mark.  In some places an inverted question mark is used (0xBF).
493
494Note that not all commands use the ++bad argument, even though they do not
495give an error when you add it.  E.g. |:write|.
496
497Note that when reading, the 'fileformat' and 'fileencoding' options will be
498set to the used format.  When writing this doesn't happen, thus a next write
499will use the old value of the option.  Same for the 'binary' option.
500
501
502							*+cmd* *[+cmd]*
503The [+cmd] argument can be used to position the cursor in the newly opened
504file, or execute any other command:
505	+		Start at the last line.
506	+{num}		Start at line {num}.
507	+/{pat}		Start at first line containing {pat}.
508	+{command}	Execute {command} after opening the new file.
509			{command} is any Ex command.
510To include a white space in the {pat} or {command}, precede it with a
511backslash.  Double the number of backslashes. >
512	:edit  +/The\ book	     file
513	:edit  +/dir\ dirname\\      file
514	:edit  +set\ dir=c:\\\\temp  file
515Note that in the last example the number of backslashes is halved twice: Once
516for the "+cmd" argument and once for the ":set" command.
517
518							*file-formats*
519The 'fileformat' option sets the <EOL> style for a file:
520'fileformat'    characters	   name				~
521  "dos"		<CR><NL> or <NL>   DOS format		*DOS-format*
522  "unix"	<NL>		   Unix format		*Unix-format*
523  "mac"		<CR>		   Mac format		*Mac-format*
524Previously 'textmode' was used.  It is obsolete now.
525
526When reading a file, the mentioned characters are interpreted as the <EOL>.
527In DOS format (default for MS-DOS, OS/2 and Win32), <CR><NL> and <NL> are both
528interpreted as the <EOL>.  Note that when writing the file in DOS format,
529<CR> characters will be added for each single <NL>.  Also see |file-read|.
530
531When writing a file, the mentioned characters are used for <EOL>.  For DOS
532format <CR><NL> is used.  Also see |DOS-format-write|.
533
534You can read a file in DOS format and write it in Unix format.  This will
535replace all <CR><NL> pairs by <NL> (assuming 'fileformats' includes "dos"): >
536	:e file
537	:set fileformat=unix
538	:w
539If you read a file in Unix format and write with DOS format, all <NL>
540characters will be replaced with <CR><NL> (assuming 'fileformats' includes
541"unix"): >
542	:e file
543	:set fileformat=dos
544	:w
545
546If you start editing a new file and the 'fileformats' option is not empty
547(which is the default), Vim will try to detect whether the lines in the file
548are separated by the specified formats.  When set to "unix,dos", Vim will
549check for lines with a single <NL> (as used on Unix and Amiga) or by a <CR>
550<NL> pair (MS-DOS).  Only when ALL lines end in <CR><NL>, 'fileformat' is set
551to "dos", otherwise it is set to "unix".  When 'fileformats' includes "mac",
552and no <NL> characters are found in the file, 'fileformat' is set to "mac".
553
554If the 'fileformat' option is set to "dos" on non-MS-DOS systems the message
555"[dos format]" is shown to remind you that something unusual is happening.  On
556MS-DOS systems you get the message "[unix format]" if 'fileformat' is set to
557"unix".  On all systems but the Macintosh you get the message "[mac format]"
558if 'fileformat' is set to "mac".
559
560If the 'fileformats' option is empty and DOS format is used, but while reading
561a file some lines did not end in <CR><NL>, "[CR missing]" will be included in
562the file message.
563If the 'fileformats' option is empty and Mac format is used, but while reading
564a file a <NL> was found, "[NL missing]" will be included in the file message.
565
566If the new file does not exist, the 'fileformat' of the current buffer is used
567when 'fileformats' is empty.  Otherwise the first format from 'fileformats' is
568used for the new file.
569
570Before editing binary, executable or Vim script files you should set the
571'binary' option.  A simple way to do this is by starting Vim with the "-b"
572option.  This will avoid the use of 'fileformat'.  Without this you risk that
573single <NL> characters are unexpectedly replaced with <CR><NL>.
574
575You can encrypt files that are written by setting the 'key' option.  This
576provides some security against others reading your files. |encryption|
577
578
579==============================================================================
5803. The argument list				*argument-list* *arglist*
581
582If you give more than one file name when starting Vim, this list is remembered
583as the argument list.  You can jump to each file in this list.
584
585Do not confuse this with the buffer list, which you can see with the
586|:buffers| command.  The argument list was already present in Vi, the buffer
587list is new in Vim.  Every file name in the argument list will also be present
588in the buffer list (unless it was deleted with |:bdel| or |:bwipe|).  But it's
589common that names in the buffer list are not in the argument list.
590
591This subject is introduced in section |07.2| of the user manual.
592
593There is one global argument list, which is used for all windows by default.
594It is possible to create a new argument list local to a window, see
595|:arglocal|.
596
597You can use the argument list with the following commands, and with the
598expression functions |argc()| and |argv()|.  These all work on the argument
599list of the current window.
600
601							*:ar* *:args*
602:ar[gs]			Print the argument list, with the current file in
603			square brackets.
604
605:ar[gs] [++opt] [+cmd] {arglist}			*:args_f*
606			Define {arglist} as the new argument list and edit
607			the first one.  This fails when changes have been made
608			and Vim does not want to |abandon| the current buffer.
609			Also see |++opt| and |+cmd|.
610			{Vi: no ++opt}
611
612:ar[gs]! [++opt] [+cmd] {arglist}			*:args_f!*
613			Define {arglist} as the new argument list and edit
614			the first one.  Discard any changes to the current
615			buffer.
616			Also see |++opt| and |+cmd|.
617			{Vi: no ++opt}
618
619:[count]arge[dit][!] [++opt] [+cmd] {name} ..		*:arge* *:argedit*
620			Add {name}s to the argument list and edit it.
621			When {name} already exists in the argument list, this
622			entry is edited.
623			This is like using |:argadd| and then |:edit|.
624			Spaces in filenames have to be escaped with "\".
625			[count] is used like with |:argadd|.
626			If the current file cannot be |abandon|ed {name}s will
627			still be added to the argument list, but won't be
628			edited. No check for duplicates is done.
629			Also see |++opt| and |+cmd|.
630
631:[count]arga[dd] {name} ..			*:arga* *:argadd* *E479*
632:[count]arga[dd]
633			Add the {name}s to the argument list.  When {name} is
634			omitted add the current buffer name to the argument
635			list.
636			If [count] is omitted, the {name}s are added just
637			after the current entry in the argument list.
638			Otherwise they are added after the [count]'th file.
639			If the argument list is "a b c", and "b" is the
640			current argument, then these commands result in:
641				command		new argument list ~
642				:argadd x	a b x c
643				:0argadd x	x a b c
644				:1argadd x	a x b c
645				:$argadd x	a b c x
646			And after the last one:
647				:+2argadd y	a b c x y
648			There is no check for duplicates, it is possible to
649			add a file to the argument list twice.
650			The currently edited file is not changed.
651			Note: you can also use this method: >
652				:args ## x
653<			This will add the "x" item and sort the new list.
654
655:argd[elete] {pattern} ..			*:argd* *:argdelete* *E480*
656			Delete files from the argument list that match the
657			{pattern}s.  {pattern} is used like a file pattern,
658			see |file-pattern|.  "%" can be used to delete the
659			current entry.
660			This command keeps the currently edited file, also
661			when it's deleted from the argument list.
662			Example: >
663				:argdel *.obj
664
665:[range]argd[elete]	Delete the {range} files from the argument list.
666			Example: >
667				:10,$argdel
668<			Deletes arguments 10 and further, keeping 1-9. >
669				:$argd
670<			Deletes just the last one. >
671				:argd
672				:.argd
673<			Deletes the current argument. >
674				:%argd
675<			Removes all the files from the arglist.
676			When the last number in the range is too high, up to
677			the last argument is deleted.
678
679							*:argu* *:argument*
680:[count]argu[ment] [count] [++opt] [+cmd]
681			Edit file [count] in the argument list.  When [count]
682			is omitted the current entry is used.  This fails
683			when changes have been made and Vim does not want to
684			|abandon| the current buffer.
685			Also see |++opt| and |+cmd|.
686
687:[count]argu[ment]! [count] [++opt] [+cmd]
688			Edit file [count] in the argument list, discard any
689			changes to the current buffer.  When [count] is
690			omitted the current entry is used.
691			Also see |++opt| and |+cmd|.
692
693:[count]n[ext] [++opt] [+cmd]			*:n* *:ne* *:next* *E165* *E163*
694			Edit [count] next file.  This fails when changes have
695			been made and Vim does not want to |abandon| the
696			current buffer.  Also see |++opt| and |+cmd|.  {Vi: no
697			count or ++opt}.
698
699:[count]n[ext]! [++opt] [+cmd]
700			Edit [count] next file, discard any changes to the
701			buffer.  Also see |++opt| and |+cmd|.  {Vi: no count
702			or ++opt}.
703
704:n[ext] [++opt] [+cmd] {arglist}			*:next_f*
705			Same as |:args_f|.
706
707:n[ext]! [++opt] [+cmd] {arglist}
708			Same as |:args_f!|.
709
710:[count]N[ext] [count] [++opt] [+cmd]			*:Next* *:N* *E164*
711			Edit [count] previous file in argument list.  This
712			fails when changes have been made and Vim does not
713			want to |abandon| the current buffer.
714			Also see |++opt| and |+cmd|.
715
716:[count]N[ext]! [count] [++opt] [+cmd]
717			Edit [count] previous file in argument list.  Discard
718			any changes to the buffer.  Also see |++opt| and
719			|+cmd|.  {Vi: no count or ++opt}.
720
721:[count]prev[ious] [count] [++opt] [+cmd]		*:prev* *:previous*
722			Same as :Next.  Also see |++opt| and |+cmd|.  {Vi:
723			only in some versions}
724
725							*:rew* *:rewind*
726:rew[ind] [++opt] [+cmd]
727			Start editing the first file in the argument list.
728			This fails when changes have been made and Vim does
729			not want to |abandon| the current buffer.
730			Also see |++opt| and |+cmd|. {Vi: no ++opt}
731
732:rew[ind]! [++opt] [+cmd]
733			Start editing the first file in the argument list.
734			Discard any changes to the buffer.  Also see |++opt|
735			and |+cmd|.
736
737							*:fir* *:first*
738:fir[st][!] [++opt] [+cmd]
739			Other name for ":rewind".
740
741							*:la* *:last*
742:la[st] [++opt] [+cmd]
743			Start editing the last file in the argument list.
744			This fails when changes have been made and Vim does
745			not want to |abandon| the current buffer.
746			Also see |++opt| and |+cmd|.
747
748:la[st]! [++opt] [+cmd]
749			Start editing the last file in the argument list.
750			Discard any changes to the buffer.  Also see |++opt|
751			and |+cmd|.
752
753							*:wn* *:wnext*
754:[count]wn[ext] [++opt]
755			Write current file and start editing the [count]
756			next file.  Also see |++opt| and |+cmd|.
757
758:[count]wn[ext] [++opt] {file}
759			Write current file to {file} and start editing the
760			[count] next file, unless {file} already exists and
761			the 'writeany' option is off.  Also see |++opt| and
762			|+cmd|.
763
764:[count]wn[ext]! [++opt] {file}
765			Write current file to {file} and start editing the
766			[count] next file.  Also see |++opt| and |+cmd|.
767
768:[count]wN[ext][!] [++opt] [file]		*:wN* *:wNext*
769:[count]wp[revious][!] [++opt] [file]		*:wp* *:wprevious*
770			Same as :wnext, but go to previous file instead of
771			next.
772
773The [count] in the commands above defaults to one.  For some commands it is
774possible to use two counts.  The last one (rightmost one) is used.
775
776If no [+cmd] argument is present, the cursor is positioned at the last known
777cursor position for the file.  If 'startofline' is set, the cursor will be
778positioned at the first non-blank in the line, otherwise the last know column
779is used.  If there is no last known cursor position the cursor will be in the
780first line (the last line in Ex mode).
781
782							*{arglist}*
783The wildcards in the argument list are expanded and the file names are sorted.
784Thus you can use the command "vim *.c" to edit all the C files.  From within
785Vim the command ":n *.c" does the same.
786
787White space is used to separate file names.  Put a backslash before a space or
788tab to include it in a file name.  E.g., to edit the single file "foo bar": >
789	:next foo\ bar
790
791On Unix and a few other systems you can also use backticks, for example: >
792	:next `find . -name \\*.c -print`
793The backslashes before the star are required to prevent "*.c" to be expanded
794by the shell before executing the find program.
795
796							*arglist-position*
797When there is an argument list you can see which file you are editing in the
798title of the window (if there is one and 'title' is on) and with the file
799message you get with the "CTRL-G" command.  You will see something like
800	(file 4 of 11)
801If 'shortmess' contains 'f' it will be
802	(4 of 11)
803If you are not really editing the file at the current position in the argument
804list it will be
805	(file (4) of 11)
806This means that you are position 4 in the argument list, but not editing the
807fourth file in the argument list.  This happens when you do ":e file".
808
809
810LOCAL ARGUMENT LIST
811
812							*:arglocal*
813:argl[ocal]		Make a local copy of the global argument list.
814			Doesn't start editing another file.
815
816:argl[ocal][!] [++opt] [+cmd] {arglist}
817			Define a new argument list, which is local to the
818			current window.  Works like |:args_f| otherwise.
819
820							*:argglobal*
821:argg[lobal]		Use the global argument list for the current window.
822			Doesn't start editing another file.
823
824:argg[lobal][!] [++opt] [+cmd] {arglist}
825			Use the global argument list for the current window.
826			Define a new global argument list like |:args_f|.
827			All windows using the global argument list will see
828			this new list.
829
830There can be several argument lists.  They can be shared between windows.
831When they are shared, changing the argument list in one window will also
832change it in the other window.
833
834When a window is split the new window inherits the argument list from the
835current window.  The two windows then share this list, until one of them uses
836|:arglocal| or |:argglobal| to use another argument list.
837
838
839USING THE ARGUMENT LIST
840
841						*:argdo*
842:[range]argdo[!] {cmd}	Execute {cmd} for each file in the argument list or
843			if [range] is specified only for arguments in that
844			range.  It works like doing this: >
845				:rewind
846				:{cmd}
847				:next
848				:{cmd}
849				etc.
850<			When the current file can't be |abandon|ed and the [!]
851			is not present, the command fails.
852			When an error is detected on one file, further files
853			in the argument list will not be visited.
854			The last file in the argument list (or where an error
855			occurred) becomes the current file.
856			{cmd} can contain '|' to concatenate several commands.
857			{cmd} must not change the argument list.
858			Note: While this command is executing, the Syntax
859			autocommand event is disabled by adding it to
860			'eventignore'.  This considerably speeds up editing
861			each file.
862			Also see |:windo|, |:tabdo|, |:bufdo|, |:cdo|, |:ldo|,
863			|:cfdo| and |:lfdo|
864
865Example: >
866	:args *.c
867	:argdo set ff=unix | update
868This sets the 'fileformat' option to "unix" and writes the file if it is now
869changed.  This is done for all *.c files.
870
871Example: >
872	:args *.[ch]
873	:argdo %s/\<my_foo\>/My_Foo/ge | update
874This changes the word "my_foo" to "My_Foo" in all *.c and *.h files.  The "e"
875flag is used for the ":substitute" command to avoid an error for files where
876"my_foo" isn't used.  ":update" writes the file only if changes were made.
877
878==============================================================================
8794. Writing					*writing* *save-file*
880
881Note: When the 'write' option is off, you are not able to write any file.
882
883							*:w* *:write*
884					*E502* *E503* *E504* *E505*
885					*E512* *E514* *E667* *E796* *E949*
886:w[rite] [++opt]	Write the whole buffer to the current file.  This is
887			the normal way to save changes to a file.  It fails
888			when the 'readonly' option is set or when there is
889			another reason why the file can't be written.
890			For ++opt see |++opt|, but only ++bin, ++nobin, ++ff
891			and ++enc are effective.
892
893:w[rite]! [++opt]	Like ":write", but forcefully write when 'readonly' is
894			set or there is another reason why writing was
895			refused.
896			Note: This may change the permission and ownership of
897			the file and break (symbolic) links.  Add the 'W' flag
898			to 'cpoptions' to avoid this.
899
900:[range]w[rite][!] [++opt]
901			Write the specified lines to the current file.  This
902			is unusual, because the file will not contain all
903			lines in the buffer.
904
905							*:w_f* *:write_f*
906:[range]w[rite] [++opt]	{file}
907			Write the specified lines to {file}, unless it
908			already exists and the 'writeany' option is off.
909
910							*:w!*
911:[range]w[rite]! [++opt] {file}
912			Write the specified lines to {file}.  Overwrite an
913			existing file.
914
915						*:w_a* *:write_a* *E494*
916:[range]w[rite][!] [++opt] >>
917			Append the specified lines to the current file.
918
919:[range]w[rite][!] [++opt] >> {file}
920			Append the specified lines to {file}.  '!' forces the
921			write even if file does not exist.
922
923							*:w_c* *:write_c*
924:[range]w[rite] [++opt] !{cmd}
925			Execute {cmd} with [range] lines as standard input
926			(note the space in front of the '!').  {cmd} is
927			executed like with ":!{cmd}", any '!' is replaced with
928			the previous command |:!|.
929
930The default [range] for the ":w" command is the whole buffer (1,$).  If you
931write the whole buffer, it is no longer considered changed.  When you
932write it to a different file with ":w somefile" it depends on the "+" flag in
933'cpoptions'.  When included, the write command will reset the 'modified' flag,
934even though the buffer itself may still be different from its file.
935
936If a file name is given with ":w" it becomes the alternate file.  This can be
937used, for example, when the write fails and you want to try again later with
938":w #".  This can be switched off by removing the 'A' flag from the
939'cpoptions' option.
940
941Note that the 'fsync' option matters here.  If it's set it may make writes
942slower (but safer).
943
944							*:sav* *:saveas*
945:sav[eas][!] [++opt] {file}
946			Save the current buffer under the name {file} and set
947			the filename of the current buffer to {file}.  The
948			previous name is used for the alternate file name.
949			The [!] is needed to overwrite an existing file.
950			When 'filetype' is empty filetype detection is done
951			with the new name, before the file is written.
952			When the write was successful 'readonly' is reset.
953
954							*:up* *:update*
955:[range]up[date][!] [++opt] [>>] [file]
956			Like ":write", but only write when the buffer has been
957			modified.
958
959
960WRITING WITH MULTIPLE BUFFERS				*buffer-write*
961
962							*:wa* *:wall*
963:wa[ll]			Write all changed buffers.  Buffers without a file
964			name cause an error message.  Buffers which are
965			readonly are not written.
966
967:wa[ll]!		Write all changed buffers, even the ones that are
968			readonly.  Buffers without a file name are not
969			written and cause an error message.
970
971
972Vim will warn you if you try to overwrite a file that has been changed
973elsewhere.  See |timestamp|.
974
975			    *backup* *E207* *E506* *E507* *E508* *E509* *E510*
976If you write to an existing file (but do not append) while the 'backup',
977'writebackup' or 'patchmode' option is on, a backup of the original file is
978made.  The file is either copied or renamed (see 'backupcopy').  After the
979file has been successfully written and when the 'writebackup' option is on and
980the 'backup' option is off, the backup file is deleted.  When the 'patchmode'
981option is on the backup file may be renamed.
982
983							*backup-table*
984'backup' 'writebackup'	action	~
985   off	     off	no backup made
986   off	     on		backup current file, deleted afterwards (default)
987   on	     off	delete old backup, backup current file
988   on	     on		delete old backup, backup current file
989
990When the 'backupskip' pattern matches with the name of the file which is
991written, no backup file is made.  The values of 'backup' and 'writebackup' are
992ignored then.
993
994When the 'backup' option is on, an old backup file (with the same name as the
995new backup file) will be deleted.  If 'backup' is not set, but 'writebackup'
996is set, an existing backup file will not be deleted.  The backup file that is
997made while the file is being written will have a different name.
998
999On some filesystems it's possible that in a crash you lose both the backup and
1000the newly written file (it might be there but contain bogus data).  In that
1001case try recovery, because the swap file is synced to disk and might still be
1002there. |:recover|
1003
1004The directories given with the 'backupdir' option are used to put the backup
1005file in.  (default: same directory as the written file).
1006
1007Whether the backup is a new file, which is a copy of the original file, or the
1008original file renamed depends on the 'backupcopy' option.  See there for an
1009explanation of when the copy is made and when the file is renamed.
1010
1011If the creation of a backup file fails, the write is not done.  If you want
1012to write anyway add a '!' to the command.
1013
1014							*write-permissions*
1015When writing a new file the permissions are read-write.  For unix the mask is
10160666 with additionally umask applied.  When writing a file that was read Vim
1017will preserve the permissions, but clear the s-bit.
1018
1019							*write-readonly*
1020When the 'cpoptions' option contains 'W', Vim will refuse to overwrite a
1021readonly file.  When 'W' is not present, ":w!" will overwrite a readonly file,
1022if the system allows it (the directory must be writable).
1023
1024							*write-fail*
1025If the writing of the new file fails, you have to be careful not to lose
1026your changes AND the original file.  If there is no backup file and writing
1027the new file failed, you have already lost the original file!  DON'T EXIT VIM
1028UNTIL YOU WRITE OUT THE FILE!  If a backup was made, it is put back in place
1029of the original file (if possible).  If you exit Vim, and lose the changes
1030you made, the original file will mostly still be there.  If putting back the
1031original file fails, there will be an error message telling you that you
1032lost the original file.
1033
1034						*DOS-format-write*
1035If the 'fileformat' is "dos", <CR> <NL> is used for <EOL>.  This is default
1036for MS-DOS, Win32 and OS/2.  On other systems the message "[dos format]" is
1037shown to remind you that an unusual <EOL> was used.
1038						*Unix-format-write*
1039If the 'fileformat' is "unix", <NL> is used for <EOL>.  On MS-DOS, Win32 and
1040OS/2 the message "[unix format]" is shown.
1041						*Mac-format-write*
1042If the 'fileformat' is "mac", <CR> is used for <EOL>.  On non-Mac systems the
1043message "[mac format]" is shown.
1044
1045See also |file-formats| and the 'fileformat' and 'fileformats' options.
1046
1047						*ACL*
1048ACL stands for Access Control List.  It is an advanced way to control access
1049rights for a file.  It is used on new MS-Windows and Unix systems, but only
1050when the filesystem supports it.
1051   Vim attempts to preserve the ACL info when writing a file.  The backup file
1052will get the ACL info of the original file.
1053   The ACL info is also used to check if a file is read-only (when opening the
1054file).
1055
1056						*read-only-share*
1057When MS-Windows shares a drive on the network it can be marked as read-only.
1058This means that even if the file read-only attribute is absent, and the ACL
1059settings on NT network shared drives allow writing to the file, you can still
1060not write to the file.  Vim on Win32 platforms will detect read-only network
1061drives and will mark the file as read-only.  You will not be able to override
1062it with |:write|.
1063
1064						*write-device*
1065When the file name is actually a device name, Vim will not make a backup (that
1066would be impossible).  You need to use "!", since the device already exists.
1067Example for Unix: >
1068	:w! /dev/lpt0
1069and for MS-DOS or MS-Windows: >
1070	:w! lpt0
1071For Unix a device is detected when the name doesn't refer to a normal file or
1072a directory.  A fifo or named pipe also looks like a device to Vim.
1073For MS-DOS and MS-Windows the device is detected by its name:
1074	AUX
1075	CON
1076	CLOCK$
1077	NUL
1078	PRN
1079	COMn	n=1,2,3... etc
1080	LPTn	n=1,2,3... etc
1081The names can be in upper- or lowercase.
1082
1083==============================================================================
10845. Writing and quitting					*write-quit*
1085
1086							*:q* *:quit*
1087:q[uit]			Quit the current window.  Quit Vim if this is the last
1088			window.  This fails when changes have been made and
1089			Vim refuses to |abandon| the current buffer, and when
1090			the last file in the argument list has not been
1091			edited.
1092			If there are other tab pages and quitting the last
1093			window in the current tab page the current tab page is
1094			closed |tab-page|.
1095			Triggers the |QuitPre| autocommand event.
1096			See |CTRL-W_q| for quitting another window.
1097
1098:conf[irm] q[uit]	Quit, but give prompt when changes have been made, or
1099			the last file in the argument list has not been
1100			edited.  See |:confirm| and 'confirm'.
1101
1102:q[uit]!		Quit without writing, also when the current buffer has
1103			changes.  The buffer is unloaded, also when it has
1104			'hidden' set.
1105			If this is the last window and there is a modified
1106			hidden buffer, the current buffer is abandoned and the
1107			first changed hidden buffer becomes the current
1108			buffer.
1109			Use ":qall!" to exit always.
1110
1111:cq[uit]		Quit always, without writing, and return an error
1112			code.  See |:cq|.  Used for Manx's QuickFix mode (see
1113			|quickfix|).
1114
1115							*:wq*
1116:wq [++opt]		Write the current file and quit.  Writing fails when
1117			the file is read-only or the buffer does not have a
1118			name.  Quitting fails when the last file in the
1119			argument list has not been edited.
1120
1121:wq! [++opt]		Write the current file and quit.  Writing fails when
1122			the current buffer does not have a name.
1123
1124:wq [++opt] {file}	Write to {file} and quit.  Quitting fails when the
1125			last file in the argument list has not been edited.
1126
1127:wq! [++opt] {file}	Write to {file} and quit.
1128
1129:[range]wq[!] [++opt] [file]
1130			Same as above, but only write the lines in [range].
1131
1132							*:x* *:xit*
1133:[range]x[it][!] [++opt] [file]
1134			Like ":wq", but write only when changes have been
1135			made.
1136			When 'hidden' is set and there are more windows, the
1137			current buffer becomes hidden, after writing the file.
1138
1139							*:exi* *:exit*
1140:[range]exi[t][!] [++opt] [file]
1141			Same as :xit.
1142
1143							*ZZ*
1144ZZ			Write current file, if modified, and quit (same as
1145			":x").  (Note: If there are several windows for the
1146			current file, the file is written if it was modified
1147			and the window is closed).
1148
1149							*ZQ*
1150ZQ			Quit without checking for changes (same as ":q!").
1151
1152
1153MULTIPLE WINDOWS AND BUFFERS				*window-exit*
1154
1155							*:qa* *:qall*
1156:qa[ll]		Exit Vim, unless there are some buffers which have been
1157		changed.  (Use ":bmod" to go to the next modified buffer).
1158		When 'autowriteall' is set all changed buffers will be
1159		written, like |:wqall|.
1160
1161:conf[irm] qa[ll]
1162		Exit Vim.  Bring up a prompt when some buffers have been
1163		changed.  See |:confirm|.
1164
1165:qa[ll]!	Exit Vim.  Any changes to buffers are lost.
1166		Also see |:cquit|, it does the same but exits with a non-zero
1167		value.
1168
1169							*:quita* *:quitall*
1170:quita[ll][!]	Same as ":qall".
1171
1172:wqa[ll] [++opt]				*:wqa* *:wqall* *:xa* *:xall*
1173:xa[ll]		Write all changed buffers and exit Vim.  If there are buffers
1174		without a file name, which are readonly or which cannot be
1175		written for another reason, Vim will not quit.
1176
1177:conf[irm] wqa[ll] [++opt]
1178:conf[irm] xa[ll]
1179		Write all changed buffers and exit Vim.  Bring up a prompt
1180		when some buffers are readonly or cannot be written for
1181		another reason.  See |:confirm|.
1182
1183:wqa[ll]! [++opt]
1184:xa[ll]!	Write all changed buffers, even the ones that are readonly,
1185		and exit Vim.  If there are buffers without a file name or
1186		which cannot be written for another reason, or there is a
1187		terminal with a running job, Vim will not quit.
1188
1189==============================================================================
11906. Dialogs						*edit-dialogs*
1191
1192							*:confirm* *:conf*
1193:conf[irm] {command}	Execute {command}, and use a dialog when an
1194			operation has to be confirmed.  Can be used on the
1195			|:q|, |:qa| and |:w| commands (the latter to override
1196			a read-only setting), and any other command that can
1197			fail in such a way, such as |:only|, |:buffer|,
1198			|:bdelete|, etc.
1199
1200Examples: >
1201  :confirm w foo
1202<	Will ask for confirmation when "foo" already exists. >
1203  :confirm q
1204<	Will ask for confirmation when there are changes. >
1205  :confirm qa
1206<	If any modified, unsaved buffers exist, you will be prompted to save
1207	or abandon each one.  There are also choices to "save all" or "abandon
1208	all".
1209
1210If you want to always use ":confirm", set the 'confirm' option.
1211
1212			*:browse* *:bro* *E338* *E614* *E615* *E616*
1213:bro[wse] {command}	Open a file selection dialog for an argument to
1214			{command}.  At present this works for |:e|, |:w|,
1215			|:wall|, |:wq|, |:wqall|, |:x|, |:xall|, |:exit|,
1216			|:view|, |:sview|, |:r|, |:saveas|, |:sp|, |:mkexrc|,
1217			|:mkvimrc|, |:mksession|, |:mkview|, |:split|,
1218			|:vsplit|, |:tabe|, |:tabnew|, |:cfile|, |:cgetfile|,
1219			|:caddfile|, |:lfile|, |:lgetfile|, |:laddfile|,
1220			|:diffsplit|, |:diffpatch|, |:open|, |:pedit|,
1221			|:redir|, |:source|, |:update|, |:visual|, |:vsplit|,
1222			and |:qall| if 'confirm' is set.
1223			{only in Win32, Athena, Motif, GTK and Mac GUI}
1224			When ":browse" is not possible you get an error
1225			message.  If the |+browse| feature is missing or the
1226			{command} doesn't support browsing, the {command} is
1227			executed without a dialog.
1228			":browse set" works like |:options|.
1229			See also |:oldfiles| for ":browse oldfiles".
1230
1231The syntax is best shown via some examples: >
1232	:browse e $vim/foo
1233<		Open the browser in the $vim/foo directory, and edit the
1234		file chosen. >
1235	:browse e
1236<		Open the browser in the directory specified with 'browsedir',
1237		and edit the file chosen. >
1238	:browse w
1239<		Open the browser in the directory of the current buffer,
1240		with the current buffer filename as default, and save the
1241		buffer under the filename chosen. >
1242	:browse w C:/bar
1243<		Open the browser in the C:/bar directory, with the current
1244		buffer filename as default, and save the buffer under the
1245		filename chosen.
1246Also see the |'browsedir'| option.
1247For versions of Vim where browsing is not supported, the command is executed
1248unmodified.
1249
1250							*browsefilter*
1251For MS Windows and GTK, you can modify the filters that are used in the browse
1252dialog.  By setting the g:browsefilter or b:browsefilter variables, you can
1253change the filters globally or locally to the buffer.  The variable is set to
1254a string in the format "{filter label}\t{pattern};{pattern}\n" where {filter
1255label} is the text that appears in the "Files of Type" comboBox, and {pattern}
1256is the pattern which filters the filenames.  Several patterns can be given,
1257separated by ';'.
1258
1259For Motif the same format is used, but only the very first pattern is actually
1260used (Motif only offers one pattern, but you can edit it).
1261
1262For example, to have only Vim files in the dialog, you could use the following
1263command: >
1264
1265     let g:browsefilter = "Vim Scripts\t*.vim\nVim Startup Files\t*vimrc\n"
1266
1267You can override the filter setting on a per-buffer basis by setting the
1268b:browsefilter variable.  You would most likely set b:browsefilter in a
1269filetype plugin, so that the browse dialog would contain entries related to
1270the type of file you are currently editing.  Disadvantage: This makes it
1271difficult to start editing a file of a different type.  To overcome this, you
1272may want to add "All Files\t*.*\n" as the final filter, so that the user can
1273still access any desired file.
1274
1275To avoid setting browsefilter when Vim does not actually support it, you can
1276use has("browsefilter"): >
1277
1278	if has("browsefilter")
1279	   let g:browsefilter = "whatever"
1280	endif
1281
1282==============================================================================
12837. The current directory				*current-directory*
1284
1285You can use the |:cd|, |:tcd| and |:lcd| commands to change to another
1286directory, so you will not have to type that directory name in front of the
1287file names.  It also makes a difference for executing external commands, e.g.
1288":!ls".
1289
1290Changing directory fails when the current buffer is modified, the '.' flag is
1291present in 'cpoptions' and "!" is not used in the command.
1292
1293							*:cd* *E747* *E472*
1294:cd[!]			On non-Unix systems: Print the current directory
1295			name.  On Unix systems: Change the current directory
1296			to the home directory.  Use |:pwd| to print the
1297			current directory on all systems.
1298			On Unix systems: clear any window-local directory.
1299
1300:cd[!] {path}		Change the current directory to {path}.
1301			If {path} is relative, it is searched for in the
1302			directories listed in |'cdpath'|.
1303			Clear any window-local directory.
1304			Does not change the meaning of an already opened file,
1305			because its full path name is remembered.  Files from
1306			the |arglist| may change though!
1307			On MS-DOS this also changes the active drive.
1308			To change to the directory of the current file: >
1309				:cd %:h
1310<
1311							*:cd-* *E186*
1312:cd[!] -		Change to the previous current directory (before the
1313			previous ":cd {path}" command).
1314
1315							*:chd* *:chdir*
1316:chd[ir][!] [path]	Same as |:cd|.
1317
1318							*:tcd*
1319:tcd[!] {path}		Like |:cd|, but only set the directory for the current
1320			tab.  The current window will also use this directory.
1321			The current directory is not changed for windows in
1322			other tabs and for windows in the current tab that
1323			have their own window-local directory.
1324
1325							*:tch* *:tchdir*
1326:tch[dir][!]		Same as |:tcd|.
1327
1328							*:lc* *:lcd*
1329:lc[d][!] {path}	Like |:cd|, but only set the current directory when
1330			the cursor is in the current window.  The current
1331			directory for other windows is not changed, switching
1332			to another window will stop using {path}.
1333
1334							*:lch* *:lchdir*
1335:lch[dir][!]		Same as |:lcd|.
1336
1337							*:pw* *:pwd* *E187*
1338:pw[d]			Print the current directory name.  {Vi: no pwd}
1339			Also see |getcwd()|.
1340
1341So long as no |:lcd| or |:tcd| command has been used, all windows share the
1342same current directory.  Using a command to jump to another window doesn't
1343change anything for the current directory.
1344
1345When a |:lcd| command has been used for a window, the specified directory
1346becomes the current directory for that window.  Windows where the |:lcd|
1347command has not been used stick to the global or tab-local current directory.
1348When jumping to another window the current directory will become the last
1349specified local current directory.  If none was specified, the global or
1350tab-local current directory is used.
1351
1352When a |:tcd| command has been used for a tab page, the specified directory
1353becomes the current directory for the current tab page and the current window.
1354The current directory of other tab pages is not affected.  When jumping to
1355another tab page, the current directory will become the last specified local
1356directory for that tab page. If the current tab has no local current directory
1357the global current directory is used.
1358
1359When a |:cd| command is used, the current window and tab page will lose the
1360local current directory and will use the global current directory from now on.
1361
1362After using |:cd| the full path name will be used for reading and writing
1363files.  On some networked file systems this may cause problems.  The result of
1364using the full path name is that the file names currently in use will remain
1365referring to the same file.  Example: If you have a file a:test and a
1366directory a:vim the commands ":e test" ":cd vim" ":w" will overwrite the file
1367a:test and not write a:vim/test.  But if you do ":w test" the file a:vim/test
1368will be written, because you gave a new file name and did not refer to a
1369filename before the ":cd".
1370
1371==============================================================================
13728. Editing binary files					*edit-binary*
1373
1374Although Vim was made to edit text files, it is possible to edit binary
1375files.  The |-b| Vim argument (b for binary) makes Vim do file I/O in binary
1376mode, and sets some options for editing binary files ('binary' on, 'textwidth'
1377to 0, 'modeline' off, 'expandtab' off).  Setting the 'binary' option has the
1378same effect.  Don't forget to do this before reading the file.
1379
1380There are a few things to remember when editing binary files:
1381- When editing executable files the number of characters must not change.
1382  Use only the "R" or "r" command to change text.  Do not delete characters
1383  with "x" or by backspacing.
1384- Set the 'textwidth' option to 0.  Otherwise lines will unexpectedly be
1385  split in two.
1386- When there are not many <EOL>s, the lines will become very long.  If you
1387  want to edit a line that does not fit on the screen reset the 'wrap' option.
1388  Horizontal scrolling is used then.  If a line becomes too long (more than
1389  about 32767 characters on the Amiga, much more on 32-bit systems, see
1390  |limits|) you cannot edit that line.  The line will be split when reading
1391  the file.  It is also possible that you get an "out of memory" error when
1392  reading the file.
1393- Make sure the 'binary' option is set BEFORE loading the
1394  file.  Otherwise both <CR> <NL> and <NL> are considered to end a line
1395  and when the file is written the <NL> will be replaced with <CR> <NL>.
1396- <Nul> characters are shown on the screen as ^@.  You can enter them with
1397  "CTRL-V CTRL-@" or "CTRL-V 000"
1398- To insert a <NL> character in the file split a line.  When writing the
1399  buffer to a file a <NL> will be written for the <EOL>.
1400- Vim normally appends an <EOL> at the end of the file if there is none.
1401  Setting the 'binary' option prevents this.  If you want to add the final
1402  <EOL>, set the 'endofline' option.  You can also read the value of this
1403  option to see if there was an <EOL> for the last line (you cannot see this
1404  in the text).
1405
1406==============================================================================
14079. Encryption						*encryption*
1408
1409Vim is able to write files encrypted, and read them back.  The encrypted text
1410cannot be read without the right key.
1411{only available when compiled with the |+cryptv| feature}  *E833*
1412
1413The text in the swap file and the undo file is also encrypted.  *E843*
1414However, this is done block-by-block and may reduce the time needed to crack a
1415password.  You can disable the swap file, but then a crash will cause you to
1416lose your work.  The undo file can be disabled without too much disadvantage. >
1417	:set noundofile
1418	:noswapfile edit secrets
1419
1420Note: The text in memory is not encrypted.  A system administrator may be able
1421to see your text while you are editing it.  When filtering text with
1422":!filter" or using ":w !command" the text is also not encrypted, this may
1423reveal it to others.  The 'viminfo' file is not encrypted.
1424
1425You could do this to edit very secret text: >
1426	:set noundofile viminfo=
1427	:noswapfile edit secrets.txt
1428Keep in mind that without a swap file you risk losing your work in the event
1429of a crash or a power failure.
1430
1431WARNING: If you make a typo when entering the key and then write the file and
1432exit, the text will be lost!
1433
1434The normal way to work with encryption, is to use the ":X" command, which will
1435ask you to enter a key.  A following write command will use that key to
1436encrypt the file.  If you later edit the same file, Vim will ask you to enter
1437a key.  If you type the same key as that was used for writing, the text will
1438be readable again.  If you use a wrong key, it will be a mess.
1439
1440							*:X*
1441:X	Prompt for an encryption key.  The typing is done without showing the
1442	actual text, so that someone looking at the display won't see it.
1443	The typed key is stored in the 'key' option, which is used to encrypt
1444	the file when it is written.  The file will remain unchanged until you
1445	write it.  See also |-x|.
1446
1447The value of the 'key' options is used when text is written.  When the option
1448is not empty, the written file will be encrypted, using the value as the
1449encryption key.  A magic number is prepended, so that Vim can recognize that
1450the file is encrypted.
1451
1452To disable the encryption, reset the 'key' option to an empty value: >
1453	:set key=
1454
1455You can use the 'cryptmethod' option to select the type of encryption, use one
1456of these: >
1457	:setlocal cm=zip        " weak method, backwards compatible
1458	:setlocal cm=blowfish   " method with flaws
1459	:setlocal cm=blowfish2  " medium strong method
1460
1461Do this before writing the file.  When reading an encrypted file it will be
1462set automatically to the method used when that file was written.  You can
1463change 'cryptmethod' before writing that file to change the method.
1464
1465To set the default method, used for new files, use this in your |vimrc|
1466file: >
1467	set cm=blowfish2
1468Using "blowfish2" is highly recommended.  Only use another method if you
1469must use an older Vim version that does not support it.
1470
1471The message given for reading and writing a file will show "[crypted]" when
1472using zip, "[blowfish]" when using blowfish, etc.
1473
1474When writing an undo file, the same key and method will be used for the text
1475in the undo file. |persistent-undo|.
1476
1477To test for blowfish support you can use these conditions: >
1478	has('crypt-blowfish')
1479	has('crypt-blowfish2')
1480This works since Vim 7.4.1099 while blowfish support was added earlier.
1481Thus the condition failing doesn't mean blowfish is not supported. You can
1482test for blowfish with: >
1483	v:version >= 703
1484And for blowfish2 with: >
1485	v:version > 704 || (v:version == 704 && has('patch401'))
1486If you are sure Vim includes patch 7.4.237 a simpler check is: >
1487	has('patch-7.4.401')
1488<
1489						*E817* *E818* *E819* *E820*
1490When encryption does not work properly, you would be able to write your text
1491to a file and never be able to read it back.  Therefore a test is performed to
1492check if the encryption works as expected.  If you get one of these errors
1493don't write the file encrypted!  You need to rebuild the Vim binary to fix
1494this.
1495
1496*E831* This is an internal error, "cannot happen".  If you can reproduce it,
1497please report to the developers.
1498
1499When reading a file that has been encrypted and the 'key' option is not empty,
1500it will be used for decryption.  If the value is empty, you will be prompted
1501to enter the key.  If you don't enter a key, or you enter the wrong key, the
1502file is edited without being decrypted.  There is no warning about using the
1503wrong key (this makes brute force methods to find the key more difficult).
1504
1505If want to start reading a file that uses a different key, set the 'key'
1506option to an empty string, so that Vim will prompt for a new one.  Don't use
1507the ":set" command to enter the value, other people can read the command over
1508your shoulder.
1509
1510Since the value of the 'key' option is supposed to be a secret, its value can
1511never be viewed.  You should not set this option in a vimrc file.
1512
1513An encrypted file can be recognized by the "file" command, if you add these
1514lines to "/etc/magic", "/usr/share/misc/magic" or wherever your system has the
1515"magic" file: >
1516     0	string	VimCrypt~	Vim encrypted file
1517     >9	string	01	- "zip" cryptmethod
1518     >9	string	02	- "blowfish" cryptmethod
1519     >9	string	03	- "blowfish2" cryptmethod
1520
1521Notes:
1522- Encryption is not possible when doing conversion with 'charconvert'.
1523- Text you copy or delete goes to the numbered registers.  The registers can
1524  be saved in the .viminfo file, where they could be read.  Change your
1525  'viminfo' option to be safe.
1526- Someone can type commands in Vim when you walk away for a moment, he should
1527  not be able to get the key.
1528- If you make a typing mistake when entering the key, you might not be able to
1529  get your text back!
1530- If you type the key with a ":set key=value" command, it can be kept in the
1531  history, showing the 'key' value in a viminfo file.
1532- There is never 100% safety.  The encryption in Vim has not been tested for
1533  robustness.
1534- The algorithm used for 'cryptmethod' "zip" is breakable.  A 4 character key
1535  in about one hour, a 6 character key in one day (on a Pentium 133 PC).  This
1536  requires that you know some text that must appear in the file.  An expert
1537  can break it for any key.  When the text has been decrypted, this also means
1538  that the key can be revealed, and other files encrypted with the same key
1539  can be decrypted.
1540- Pkzip uses the same encryption as 'cryptmethod' "zip", and US Govt has no
1541  objection to its export.  Pkzip's public file APPNOTE.TXT describes this
1542  algorithm in detail.
1543- The implementation of 'cryptmethod' "blowfish" has a flaw.  It is possible
1544  to crack the first 64 bytes of a file and in some circumstances more of the
1545  file. Use of it is not recommended, but it's still the strongest method
1546  supported by Vim 7.3 and 7.4.  The "zip" method is even weaker.
1547- Vim originates from the Netherlands.  That is where the sources come from.
1548  Thus the encryption code is not exported from the USA.
1549
1550==============================================================================
155110. Timestamps					*timestamp* *timestamps*
1552
1553Vim remembers the modification timestamp, mode and size of a file when you
1554begin editing it.  This is used to avoid that you have two different versions
1555of the same file (without you knowing this).
1556
1557After a shell command is run (|:!cmd| |suspend| |:read!| |K|) timestamps,
1558file modes and file sizes are compared for all buffers in a window.   Vim will
1559run any associated |FileChangedShell| autocommands or display a warning for
1560any files that have changed.  In the GUI this happens when Vim regains input
1561focus.
1562
1563							*E321* *E462*
1564If you want to automatically reload a file when it has been changed outside of
1565Vim, set the 'autoread' option.  This doesn't work at the moment you write the
1566file though, only when the file wasn't changed inside of Vim.
1567
1568If you do not want to be asked or automatically reload the file, you can use
1569this: >
1570	set buftype=nofile
1571
1572Or, when starting gvim from a shell: >
1573	gvim file.log -c "set buftype=nofile"
1574
1575Note that if a FileChangedShell autocommand is defined you will not get a
1576warning message or prompt.  The autocommand is expected to handle this.
1577
1578There is no warning for a directory (e.g., with |netrw-browse|).  But you do
1579get warned if you started editing a new file and it was created as a directory
1580later.
1581
1582When Vim notices the timestamp of a file has changed, and the file is being
1583edited in a buffer but has not changed, Vim checks if the contents of the file
1584is equal.  This is done by reading the file again (into a hidden buffer, which
1585is immediately deleted again) and comparing the text.  If the text is equal,
1586you will get no warning.
1587
1588If you don't get warned often enough you can use the following command.
1589
1590							*:checkt* *:checktime*
1591:checkt[ime]		Check if any buffers were changed outside of Vim.
1592			This checks and warns you if you would end up with two
1593			versions of a file.
1594			If this is called from an autocommand, a ":global"
1595			command or is not typed the actual check is postponed
1596			until a moment the side effects (reloading the file)
1597			would be harmless.
1598			Each loaded buffer is checked for its associated file
1599			being changed.  If the file was changed Vim will take
1600			action.  If there are no changes in the buffer and
1601			'autoread' is set, the buffer is reloaded.  Otherwise,
1602			you are offered the choice of reloading the file.  If
1603			the file was deleted you get an error message.
1604			If the file previously didn't exist you get a warning
1605			if it exists now.
1606			Once a file has been checked the timestamp is reset,
1607			you will not be warned again.
1608
1609:[N]checkt[ime] {filename}
1610:[N]checkt[ime] [N]
1611			Check the timestamp of a specific buffer.  The buffer
1612			may be specified by name, number or with a pattern.
1613
1614
1615							*E813* *E814*
1616Vim will reload the buffer if you chose to.  If a window is visible that
1617contains this buffer, the reloading will happen in the context of this window.
1618Otherwise a special window is used, so that most autocommands will work.  You
1619can't close this window.  A few other restrictions apply.  Best is to make
1620sure nothing happens outside of the current buffer.  E.g., setting
1621window-local options may end up in the wrong window.  Splitting the window,
1622doing something there and closing it should be OK (if there are no side
1623effects from other autocommands).  Closing unrelated windows and buffers will
1624get you into trouble.
1625
1626Before writing a file the timestamp is checked.  If it has changed, Vim will
1627ask if you really want to overwrite the file:
1628
1629	WARNING: The file has been changed since reading it!!!
1630	Do you really want to write to it (y/n)?
1631
1632If you hit 'y' Vim will continue writing the file.  If you hit 'n' the write is
1633aborted.  If you used ":wq" or "ZZ" Vim will not exit, you will get another
1634chance to write the file.
1635
1636The message would normally mean that somebody has written to the file after
1637the edit session started.  This could be another person, in which case you
1638probably want to check if your changes to the file and the changes from the
1639other person should be merged.  Write the file under another name and check for
1640differences (the "diff" program can be used for this).
1641
1642It is also possible that you modified the file yourself, from another edit
1643session or with another command (e.g., a filter command).  Then you will know
1644which version of the file you want to keep.
1645
1646There is one situation where you get the message while there is nothing wrong:
1647On a Win32 system on the day daylight saving time starts.  There is something
1648in the Win32 libraries that confuses Vim about the hour time difference.  The
1649problem goes away the next day.
1650
1651==============================================================================
165211. File Searching					*file-searching*
1653
1654{not available when compiled without the |+path_extra| feature}
1655
1656The file searching is currently used for the 'path', 'cdpath' and 'tags'
1657options, for |finddir()| and |findfile()|.  Other commands use |wildcards|
1658which is slightly different.
1659
1660There are three different types of searching:
1661
16621) Downward search:					*starstar*
1663   Downward search uses the wildcards '*', '**' and possibly others
1664   supported by your operating system.  '*' and '**' are handled inside Vim,
1665   so they work on all operating systems.  Note that "**" only acts as a
1666   special wildcard when it is at the start of a name.
1667
1668   The usage of '*' is quite simple: It matches 0 or more characters.  In a
1669   search pattern this would be ".*".  Note that the "." is not used for file
1670   searching.
1671
1672   '**' is more sophisticated:
1673      - It ONLY matches directories.
1674      - It matches up to 30 directories deep by default, so you can use it to
1675	search an entire directory tree
1676      - The maximum number of levels matched can be given by appending a number
1677	to '**'.
1678	Thus '/usr/**2' can match: >
1679		/usr
1680		/usr/include
1681		/usr/include/sys
1682		/usr/include/g++
1683		/usr/lib
1684		/usr/lib/X11
1685		....
1686<	It does NOT match '/usr/include/g++/std' as this would be three
1687	levels.
1688	The allowed number range is 0 ('**0' is removed) to 100
1689	If the given number is smaller than 0 it defaults to 30, if it's
1690	bigger than 100 then 100 is used.  The system also has a limit on the
1691	path length, usually 256 or 1024 bytes.
1692      - '**' can only be at the end of the path or be followed by a path
1693	separator or by a number and a path separator.
1694
1695   You can combine '*' and '**' in any order: >
1696	/usr/**/sys/*
1697	/usr/*tory/sys/**
1698	/usr/**2/sys/*
1699
17002) Upward search:
1701   Here you can give a directory and then search the directory tree upward for
1702   a file.  You could give stop-directories to limit the upward search.  The
1703   stop-directories are appended to the path (for the 'path' option) or to
1704   the filename (for the 'tags' option) with a ';'.  If you want several
1705   stop-directories separate them with ';'.  If you want no stop-directory
1706   ("search upward till the root directory) just use ';'. >
1707	/usr/include/sys;/usr
1708<   will search in: >
1709	   /usr/include/sys
1710	   /usr/include
1711	   /usr
1712<
1713   If you use a relative path the upward search is started in Vim's current
1714   directory or in the directory of the current file (if the relative path
1715   starts with './' and 'd' is not included in 'cpoptions').
1716
1717   If Vim's current path is /u/user_x/work/release and you do >
1718	:set path=include;/u/user_x
1719<  and then search for a file with |gf| the file is searched in: >
1720	/u/user_x/work/release/include
1721	/u/user_x/work/include
1722	/u/user_x/include
1723
17243) Combined up/downward search:
1725   If Vim's current path is /u/user_x/work/release and you do >
1726	set path=**;/u/user_x
1727<  and then search for a file with |gf| the file is searched in: >
1728	/u/user_x/work/release/**
1729	/u/user_x/work/**
1730	/u/user_x/**
1731<
1732   BE CAREFUL!  This might consume a lot of time, as the search of
1733   '/u/user_x/**' includes '/u/user_x/work/**' and
1734   '/u/user_x/work/release/**'.  So '/u/user_x/work/release/**' is searched
1735   three times and '/u/user_x/work/**' is searched twice.
1736
1737   In the above example you might want to set path to: >
1738	:set path=**,/u/user_x/**
1739<  This searches:
1740	/u/user_x/work/release/** ~
1741	/u/user_x/** ~
1742   This searches the same directories, but in a different order.
1743
1744   Note that completion for ":find", ":sfind", and ":tabfind" commands do not
1745   currently work with 'path' items that contain a URL or use the double star
1746   with depth limiter (/usr/**2) or upward search (;) notations.
1747
1748 vim:tw=78:ts=8:noet:ft=help:norl:
1749