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