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