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