blob: c745f902ec7b90d56999089f0b75d571df4dd256 [file] [log] [blame]
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001*editing.txt* For Vim version 7.2. Last change: 2008 Aug 09
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Editing files *edit-files*
8
91. Introduction |edit-intro|
102. Editing a file |edit-a-file|
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000113. The argument list |argument-list|
124. Writing |writing|
135. Writing and quitting |write-quit|
146. Dialogs |edit-dialogs|
157. The current directory |current-directory|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000168. Editing binary files |edit-binary|
179. Encryption |encryption|
1810. Timestamps |timestamps|
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001911. File Searching |file-searching|
Bram Moolenaar071d4272004-06-13 20:20:40 +000020
21==============================================================================
221. Introduction *edit-intro*
23
24Editing a file with Vim means:
25
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000261. reading the file into a buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +0000272. changing the buffer with editor commands
283. writing the buffer into a file
29
30 *current-file*
31As long as you don't write the buffer, the original file remains unchanged.
32If you start editing a file (read a file into the buffer), the file name is
Bram Moolenaard4755bb2004-09-02 19:12:26 +000033remembered as the "current file name". This is also known as the name of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +000034current buffer. It can be used with "%" on the command line |:_%|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000035
36 *alternate-file*
37If there already was a current file name, then that one becomes the alternate
Bram Moolenaar1cd871b2004-12-19 22:46:22 +000038file name. It can be used with "#" on the command line |:_#| and you can use
39the |CTRL-^| command to toggle between the current and the alternate file.
40However, the alternate file name is not changed when |:keepalt| is used.
Bram Moolenaard4755bb2004-09-02 19:12:26 +000041
42 *:keepalt* *:keepa*
43:keepalt {cmd} Execute {cmd} while keeping the current alternate file
44 name. Note that commands invoked indirectly (e.g.,
45 with a function) may still set the alternate file
46 name. {not in Vi}
47
Bram Moolenaar1cd871b2004-12-19 22:46:22 +000048All file names are remembered in the buffer list. When you enter a file name,
Bram Moolenaar402d2fe2005-04-15 21:00:38 +000049for editing (e.g., with ":e filename") or writing (e.g., with ":w filename"),
Bram Moolenaar1cd871b2004-12-19 22:46:22 +000050the file name is added to the list. You can use the buffer list to remember
51which files you edited and to quickly switch from one file to another (e.g.,
52to copy text) with the |CTRL-^| command. First type the number of the file
53and then hit CTRL-^. {Vi: only one alternate file name is remembered}
54
Bram Moolenaar071d4272004-06-13 20:20:40 +000055
56CTRL-G or *CTRL-G* *:f* *:fi* *:file*
Bram Moolenaard9d30582005-05-18 22:10:28 +000057:f[ile] Prints the current file name (as typed, unless ":cd"
58 was used), the cursor position (unless the 'ruler'
59 option is set), and the file status (readonly,
60 modified, read errors, new file). See the 'shortmess'
61 option about how to make this message shorter.
62 {Vi does not include column number}
Bram Moolenaar071d4272004-06-13 20:20:40 +000063
Bram Moolenaar325b7a22004-07-05 15:58:32 +000064:f[ile]! like |:file|, but don't truncate the name even when
65 'shortmess' indicates this.
66
Bram Moolenaar071d4272004-06-13 20:20:40 +000067{count}CTRL-G Like CTRL-G, but prints the current file name with
68 full path. If the count is higher than 1 the current
69 buffer number is also given. {not in Vi}
70
71 *g_CTRL-G* *word-count* *byte-count*
Bram Moolenaar7c626922005-02-07 22:01:03 +000072g CTRL-G Prints the current position of the cursor in five
73 ways: Column, Line, Word, Character and Byte. If the
74 number of Characters and Bytes is the same then the
75 Character position is omitted.
76 If there are characters in the line that take more
77 than one position on the screen (<Tab> or special
78 character), both the "real" column and the screen
79 column are shown, separated with a dash.
80 See also 'ruler' option. {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +000081
82 *v_g_CTRL-G*
Bram Moolenaar7c626922005-02-07 22:01:03 +000083{Visual}g CTRL-G Similar to "g CTRL-G", but Word, Character, Line, and
84 Byte counts for the visually selected region are
85 displayed.
86 In Blockwise mode, Column count is also shown. (For
Bram Moolenaar071d4272004-06-13 20:20:40 +000087 {Visual} see |Visual-mode|.)
88 {not in VI}
89
90 *:file_f*
Bram Moolenaar325b7a22004-07-05 15:58:32 +000091:f[ile][!] {name} Sets the current file name to {name}. The optional !
92 avoids truncating the message, as with |:file|.
Bram Moolenaar7171abe2004-10-11 10:06:20 +000093 If the buffer did have a name, that name becomes the
94 |alternate-file| name. An unlisted buffer is created
95 to hold the old name.
Bram Moolenaar10de2da2005-01-27 14:33:00 +000096 *:0file*
Bram Moolenaar325b7a22004-07-05 15:58:32 +000097:0f[ile][!] Remove the name of the current buffer. The optional !
98 avoids truncating the message, as with |:file|. {not
99 in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000100
101:buffers
102:files
103:ls List all the currently known file names. See
104 'windows.txt' |:files| |:buffers| |:ls|. {not in
105 Vi}
106
107Vim will remember the full path name of a file name that you enter. In most
108cases when the file name is displayed only the name you typed is shown, but
109the full path name is being used if you used the ":cd" command |:cd|.
110
111 *home-replace*
112If the environment variable $HOME is set, and the file name starts with that
113string, it is often displayed with HOME replaced with "~". This was done to
114keep file names short. When reading or writing files the full name is still
115used, the "~" is only used when displaying file names. When replacing the
116file name would result in just "~", "~/" is used instead (to avoid confusion
Bram Moolenaar81695252004-12-29 20:58:21 +0000117between options set to $HOME with 'backupext' set to "~").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000118
119When writing the buffer, the default is to use the current file name. Thus
120when you give the "ZZ" or ":wq" command, the original file will be
121overwritten. If you do not want this, the buffer can be written into another
122file by giving a file name argument to the ":write" command. For example: >
123
124 vim testfile
125 [change the buffer with editor commands]
126 :w newfile
127 :q
128
129This will create a file "newfile", that is a modified copy of "testfile".
130The file "testfile" will remain unchanged. Anyway, if the 'backup' option is
131set, Vim renames or copies the original file before it will be overwritten.
132You can use this file if you discover that you need the original file. See
133also the 'patchmode' option. The name of the backup file is normally the same
134as the original file with 'backupext' appended. The default "~" is a bit
135strange to avoid accidentally overwriting existing files. If you prefer ".bak"
136change the 'backupext' option. Extra dots are replaced with '_' on MS-DOS
137machines, when Vim has detected that an MS-DOS-like filesystem is being used
138(e.g., messydos or crossdos) or when the 'shortname' option is on. The
139backup file can be placed in another directory by setting 'backupdir'.
140
141 *auto-shortname*
142Technical: On the Amiga you can use 30 characters for a file name. But on an
143 MS-DOS-compatible filesystem only 8 plus 3 characters are
144 available. Vim tries to detect the type of filesystem when it is
145 creating the .swp file. If an MS-DOS-like filesystem is suspected,
146 a flag is set that has the same effect as setting the 'shortname'
147 option. This flag will be reset as soon as you start editing a
148 new file. The flag will be used when making the file name for the
149 ".swp" and ".~" files for the current file. But when you are
150 editing a file in a normal filesystem and write to an MS-DOS-like
151 filesystem the flag will not have been set. In that case the
152 creation of the ".~" file may fail and you will get an error
153 message. Use the 'shortname' option in this case.
154
155When you started editing without giving a file name, "No File" is displayed in
156messages. If the ":write" command is used with a file name argument, the file
157name for the current file is set to that file name. This only happens when
Bram Moolenaar2d3f4892006-01-20 23:02:51 +0000158the 'F' flag is included in 'cpoptions' (by default it is included) |cpo-F|.
159This is useful when entering text in an empty buffer and then writing it to a
160file. If 'cpoptions' contains the 'f' flag (by default it is NOT included)
161|cpo-f| the file name is set for the ":read file" command. This is useful
162when starting Vim without an argument and then doing ":read file" to start
163editing a file.
164When the file name was set and 'filetype' is empty the filetype detection
165autocommands will be triggered.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000166 *not-edited*
167Because the file name was set without really starting to edit that file, you
168are protected from overwriting that file. This is done by setting the
169"notedited" flag. You can see if this flag is set with the CTRL-G or ":file"
170command. It will include "[Not edited]" when the "notedited" flag is set.
171When writing the buffer to the current file name (with ":w!"), the "notedited"
172flag is reset.
173
174 *abandon*
175Vim remembers whether you have changed the buffer. You are protected from
176losing the changes you made. If you try to quit without writing, or want to
177start editing another file, Vim will refuse this. In order to overrule this
178protection, add a '!' to the command. The changes will then be lost. For
179example: ":q" will not work if the buffer was changed, but ":q!" will. To see
180whether the buffer was changed use the "CTRL-G" command. The message includes
181the string "[Modified]" if the buffer has been changed.
182
183If you want to automatically save the changes without asking, switch on the
184'autowriteall' option. 'autowrite' is the associated Vi-compatible option
185that does not work for all commands.
186
187If you want to keep the changed buffer without saving it, switch on the
188'hidden' option. See |hidden-buffer|.
189
190==============================================================================
1912. Editing a file *edit-a-file*
192
193 *:e* *:edit*
194:e[dit] [++opt] [+cmd] Edit the current file. This is useful to re-edit the
195 current file, when it has been changed outside of Vim.
196 This fails when changes have been made to the current
197 buffer and 'autowriteall' isn't set or the file can't
198 be written.
199 Also see |++opt| and |+cmd|.
200 {Vi: no ++opt}
201
202 *:edit!*
203:e[dit]! [++opt] [+cmd]
204 Edit the current file always. Discard any changes to
205 the current buffer. This is useful if you want to
206 start all over again.
207 Also see |++opt| and |+cmd|.
208 {Vi: no ++opt}
209
210 *:edit_f*
211:e[dit] [++opt] [+cmd] {file}
212 Edit {file}.
213 This fails when changes have been made to the current
214 buffer, unless 'hidden' is set or 'autowriteall' is
215 set and the file can be written.
216 Also see |++opt| and |+cmd|.
217 {Vi: no ++opt}
218
219 *:edit!_f*
220:e[dit]! [++opt] [+cmd] {file}
221 Edit {file} always. Discard any changes to the
222 current buffer.
223 Also see |++opt| and |+cmd|.
224 {Vi: no ++opt}
225
226:e[dit] [++opt] [+cmd] #[count]
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000227 Edit the [count]th buffer (as shown by |:files|).
228 This command does the same as [count] CTRL-^. But ":e
229 #" doesn't work if the alternate buffer doesn't have a
230 file name, while CTRL-^ still works then.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000231 Also see |++opt| and |+cmd|.
232 {Vi: no ++opt}
233
234 *:ene* *:enew*
235:ene[w] Edit a new, unnamed buffer. This fails when changes
236 have been made to the current buffer, unless 'hidden'
237 is set or 'autowriteall' is set and the file can be
238 written.
239 If 'fileformats' is not empty, the first format given
240 will be used for the new buffer. If 'fileformats' is
241 empty, the 'fileformat' of the current buffer is used.
242 {not in Vi}
243
244 *:ene!* *:enew!*
245:ene[w]! Edit a new, unnamed buffer. Discard any changes to
246 the current buffer.
247 Set 'fileformat' like |:enew|.
248 {not in Vi}
249
250 *:fin* *:find*
251:fin[d][!] [++opt] [+cmd] {file}
252 Find {file} in 'path' and then |:edit| it.
253 {not in Vi} {not available when the |+file_in_path|
254 feature was disabled at compile time}
255
256:{count}fin[d][!] [++opt] [+cmd] {file}
257 Just like ":find", but use the {count} match in
258 'path'. Thus ":2find file" will find the second
259 "file" found in 'path'. When there are fewer matches
260 for the file in 'path' than asked for, you get an
261 error message.
262
263 *:ex*
264:ex [++opt] [+cmd] [file]
265 Same as |:edit|.
266
267 *:vi* *:visual*
268:vi[sual][!] [++opt] [+cmd] [file]
Bram Moolenaar81695252004-12-29 20:58:21 +0000269 When used in Ex mode: Leave |Ex-mode|, go back to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000270 Normal mode. Otherwise same as |:edit|.
271
272 *:vie* *:view*
273:vie[w] [++opt] [+cmd] file
Bram Moolenaar81695252004-12-29 20:58:21 +0000274 When used in Ex mode: Leave |Ex mode|, go back to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000275 Normal mode. Otherwise same as |:edit|, but set
276 'readonly' option for this buffer. {not in Vi}
277
278 *CTRL-^* *CTRL-6*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000279CTRL-^ Edit the alternate file (equivalent to ":e #").
280 Mostly the alternate file is the previously edited
281 file. This is a quick way to toggle between two
282 files.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000283 If the 'autowrite' or 'autowriteall' option is on and
284 the buffer was changed, write it.
285 Mostly the ^ character is positioned on the 6 key,
286 pressing CTRL and 6 then gets you what we call CTRL-^.
287 But on some non-US keyboards CTRL-^ is produced in
288 another way.
289
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000290{count}CTRL-^ Edit [count]th file in the buffer list (equivalent to
291 ":e #[count]"). This is a quick way to switch between
292 files.
293 See |CTRL-^| above for further details.
294 {not in Vi}
295
Bram Moolenaar071d4272004-06-13 20:20:40 +0000296[count]]f *]f* *[f*
297[count][f Same as "gf". Deprecated.
298
299 *gf* *E446* *E447*
300[count]gf Edit the file whose name is under or after the cursor.
301 Mnemonic: "goto file".
302 Uses the 'isfname' option to find out which characters
303 are supposed to be in a file name. Trailing
304 punctuation characters ".,:;!" are ignored.
Bram Moolenaarc236c162008-07-13 17:41:49 +0000305 Uses the 'path' option as a list of directory names to
306 look for the file. See the 'path' option for details
307 about relative directories and wildcards.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000308 Uses the 'suffixesadd' option to check for file names
309 with a suffix added.
310 If the file can't be found, 'includeexpr' is used to
311 modify the name and another attempt is done.
312 If a [count] is given, the count'th file that is found
313 in the 'path' is edited.
314 This command fails if Vim refuses to |abandon| the
315 current file.
Bram Moolenaar8dff8182006-04-06 20:18:50 +0000316 If you want to edit the file in a new window use
317 |CTRL-W_CTRL-F|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000318 If you do want to edit a new file, use: >
319 :e <cfile>
320< To make gf always work like that: >
321 :map gf :e <cfile><CR>
322< If the name is a hypertext link, that looks like
323 "type://machine/path", you need the |netrw| plugin.
324 For Unix the '~' character is expanded, like in
325 "~user/file". Environment variables are expanded too
326 |expand-env|.
327 {not in Vi}
328 {not available when the |+file_in_path| feature was
329 disabled at compile time}
330
331 *v_gf*
332{Visual}[count]gf Same as "gf", but the highlighted text is used as the
333 name of the file to edit. 'isfname' is ignored.
334 Leading blanks are skipped, otherwise all blanks and
335 special characters are included in the file name.
336 (For {Visual} see |Visual-mode|.)
337 {not in VI}
338
Bram Moolenaard1f56e62006-02-22 21:25:37 +0000339 *gF*
340[count]gF Same as "gf", except if a number follows the file
341 name, then the cursor is positioned on that line in
342 the file. The file name and the number must be
343 separated by a non-filename (see 'isfname') and
344 non-numeric character. White space between the
345 filename, the separator and the number are ignored.
Bram Moolenaard8fc5c02006-04-29 21:55:22 +0000346 Examples:
347 eval.c:10 ~
348 eval.c @ 20 ~
349 eval.c (30) ~
350 eval.c 40 ~
351
Bram Moolenaard1f56e62006-02-22 21:25:37 +0000352 *v_gF*
353{Visual}[count]gF Same as "v_gf".
354
Bram Moolenaar071d4272004-06-13 20:20:40 +0000355These commands are used to start editing a single file. This means that the
356file is read into the buffer and the current file name is set. The file that
357is opened depends on the current directory, see |:cd|.
358
359See |read-messages| for an explanation of the message that is given after the
360file has been read.
361
362You can use the ":e!" command if you messed up the buffer and want to start
363all over again. The ":e" command is only useful if you have changed the
364current file name.
365
366 *:filename* *{file}*
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000367Besides the things mentioned here, more special items for where a filename is
368expected are mentioned at |cmdline-special|.
369
Bram Moolenaarc236c162008-07-13 17:41:49 +0000370Note for systems other than Unix: When using a command that accepts a single
371file name (like ":edit file") spaces in the file name are allowed, but
372trailing spaces are ignored. This is useful on systems that regularly embed
373spaces in file names (like MS-Windows and the Amiga). Example: The command
374":e Long File Name " will edit the file "Long File Name". When using a
375command that accepts more than one file name (like ":next file1 file2")
376embedded spaces must be escaped with a backslash.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000377
Bram Moolenaar9964e462007-05-05 17:54:07 +0000378 *wildcard* *wildcards*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000379Wildcards in {file} are expanded. Which wildcards are supported depends on
380the system. These are the common ones:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000381 ? matches one character
Bram Moolenaar02743632005-07-25 20:42:36 +0000382 * matches anything, including nothing
383 ** matches anything, including nothing, recurses into directories
Bram Moolenaar071d4272004-06-13 20:20:40 +0000384 [abc] match 'a', 'b' or 'c'
Bram Moolenaar02743632005-07-25 20:42:36 +0000385
Bram Moolenaar071d4272004-06-13 20:20:40 +0000386To avoid the special meaning of the wildcards prepend a backslash. However,
387on MS-Windows the backslash is a path separator and "path\[abc]" is still seen
388as a wildcard when "[" is in the 'isfname' option. A simple way to avoid this
389is to use "path\[[]abc]". Then the file "path[abc]" literally.
390
Bram Moolenaar02743632005-07-25 20:42:36 +0000391 *starstar-wildcard*
392Expanding "**" is possible on Unix, Win32, Mac OS/X and a few other systems.
393This allows searching a directory tree. This goes up to 100 directories deep.
Bram Moolenaarc236c162008-07-13 17:41:49 +0000394Note there are some commands where this works slightly different, see
395|file-searching|.
Bram Moolenaar02743632005-07-25 20:42:36 +0000396Example: >
397 :n **/*.txt
398Finds files:
399 ttt.txt
400 subdir/ttt.txt
401 a/b/c/d/ttt.txt
402When non-wildcard characters are used these are only matched in the first
403directory. Example: >
404 :n /usr/inc**/*.h
405Finds files:
406 /usr/include/types.h
407 /usr/include/sys/types.h
408 /usr/inc_old/types.h
Bram Moolenaar071d4272004-06-13 20:20:40 +0000409 *backtick-expansion* *`-expansion*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000410On Unix and a few other systems you can also use backticks in the file name,
411for example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000412 :e `find . -name ver\\*.c -print`
413The backslashes before the star are required to prevent "ver*.c" to be
414expanded by the shell before executing the find program.
415This also works for most other systems, with the restriction that the
416backticks must be around the whole item. It is not possible to have text
417directly before the first or just after the last backtick.
418
Bram Moolenaared203462004-06-16 11:19:22 +0000419 *`=*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000420You can have the backticks expanded as a Vim expression, instead of an
421external command, by using the syntax `={expr}` e.g.: >
422 :e `=tempname()`
423The expression can contain just about anything, thus this can also be used to
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000424avoid the special meaning of '"', '|', '%' and '#'. Names are to be separated
425with line breaks. When the result is a |List| then each item is used as a
426name. Line breaks also separate names.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000427
428 *++opt* *[++opt]*
Bram Moolenaarb0bf8582005-12-13 20:02:15 +0000429The [++opt] argument can be used to force the value of 'fileformat',
430'fileencoding' or 'binary' to a value for one command, and to specify the
431behavior for bad characters. The form is: >
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000432 ++{optname}
433Or: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000434 ++{optname}={value}
435
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000436Where {optname} is one of: *++ff* *++enc* *++bin* *++nobin* *++edit*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000437 ff or fileformat overrides 'fileformat'
438 enc or encoding overrides 'fileencoding'
439 bin or binary sets 'binary'
440 nobin or nobinary resets 'binary'
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000441 bad specifies behavior for bad characters
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000442 edit for |:read| only: keep option values as if editing
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000443 a file
Bram Moolenaar071d4272004-06-13 20:20:40 +0000444
445{value} cannot contain white space. It can be any valid value for these
446options. Examples: >
447 :e ++ff=unix
448This edits the same file again with 'fileformat' set to "unix". >
449
450 :w ++enc=latin1 newfile
451This writes the current buffer to "newfile" in latin1 format.
452
Bram Moolenaarb0bf8582005-12-13 20:02:15 +0000453There may be several ++opt arguments, separated by white space. They must all
454appear before any |+cmd| argument.
455
456 *++bad*
457The argument of "++bad=" specifies what happens with characters that can't be
458converted and illegal bytes. It can be one of three things:
459 ++bad=X A single-byte character that replaces each bad character.
460 ++bad=keep Keep bad characters without conversion. Note that this may
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000461 result in illegal bytes in your text!
Bram Moolenaarb0bf8582005-12-13 20:02:15 +0000462 ++bad=drop Remove the bad characters.
463
464The default is like "++bad=?": Replace each bad character with a question
465mark.
466
Bram Moolenaar071d4272004-06-13 20:20:40 +0000467Note that when reading, the 'fileformat' and 'fileencoding' options will be
468set to the used format. When writing this doesn't happen, thus a next write
469will use the old value of the option. Same for the 'binary' option.
470
Bram Moolenaar071d4272004-06-13 20:20:40 +0000471
472 *+cmd* *[+cmd]*
473The [+cmd] argument can be used to position the cursor in the newly opened
474file, or execute any other command:
475 + Start at the last line.
476 +{num} Start at line {num}.
477 +/{pat} Start at first line containing {pat}.
478 +{command} Execute {command} after opening the new file.
479 {command} is any Ex command.
480To include a white space in the {pat} or {command}, precede it with a
481backslash. Double the number of backslashes. >
482 :edit +/The\ book file
483 :edit +/dir\ dirname\\ file
484 :edit +set\ dir=c:\\\\temp file
485Note that in the last example the number of backslashes is halved twice: Once
486for the "+cmd" argument and once for the ":set" command.
487
488 *file-formats*
489The 'fileformat' option sets the <EOL> style for a file:
490'fileformat' characters name ~
491 "dos" <CR><NL> or <NL> DOS format *DOS-format*
492 "unix" <NL> Unix format *Unix-format*
493 "mac" <CR> Mac format *Mac-format*
494Previously 'textmode' was used. It is obsolete now.
495
496When reading a file, the mentioned characters are interpreted as the <EOL>.
497In DOS format (default for MS-DOS, OS/2 and Win32), <CR><NL> and <NL> are both
498interpreted as the <EOL>. Note that when writing the file in DOS format,
499<CR> characters will be added for each single <NL>. Also see |file-read|.
500
501When writing a file, the mentioned characters are used for <EOL>. For DOS
502format <CR><NL> is used. Also see |DOS-format-write|.
503
504You can read a file in DOS format and write it in Unix format. This will
505replace all <CR><NL> pairs by <NL> (assuming 'fileformats' includes "dos"): >
506 :e file
507 :set fileformat=unix
508 :w
509If you read a file in Unix format and write with DOS format, all <NL>
510characters will be replaced with <CR><NL> (assuming 'fileformats' includes
511"unix"): >
512 :e file
513 :set fileformat=dos
514 :w
515
516If you start editing a new file and the 'fileformats' option is not empty
517(which is the default), Vim will try to detect whether the lines in the file
518are separated by the specified formats. When set to "unix,dos", Vim will
519check for lines with a single <NL> (as used on Unix and Amiga) or by a <CR>
520<NL> pair (MS-DOS). Only when ALL lines end in <CR><NL>, 'fileformat' is set
521to "dos", otherwise it is set to "unix". When 'fileformats' includes "mac",
522and no <NL> characters are found in the file, 'fileformat' is set to "mac".
523
524If the 'fileformat' option is set to "dos" on non-MS-DOS systems the message
525"[dos format]" is shown to remind you that something unusual is happening. On
526MS-DOS systems you get the message "[unix format]" if 'fileformat' is set to
527"unix". On all systems but the Macintosh you get the message "[mac format]"
528if 'fileformat' is set to "mac".
529
530If the 'fileformats' option is empty and DOS format is used, but while reading
531a file some lines did not end in <CR><NL>, "[CR missing]" will be included in
532the file message.
533If the 'fileformats' option is empty and Mac format is used, but while reading
534a file a <NL> was found, "[NL missing]" will be included in the file message.
535
536If the new file does not exist, the 'fileformat' of the current buffer is used
537when 'fileformats' is empty. Otherwise the first format from 'fileformats' is
538used for the new file.
539
540Before editing binary, executable or Vim script files you should set the
541'binary' option. A simple way to do this is by starting Vim with the "-b"
542option. This will avoid the use of 'fileformat'. Without this you risk that
543single <NL> characters are unexpectedly replaced with <CR><NL>.
544
545You can encrypt files that are written by setting the 'key' option. This
546provides some security against others reading your files. |encryption|
547
548
Bram Moolenaar071d4272004-06-13 20:20:40 +0000549==============================================================================
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005503. The argument list *argument-list* *arglist*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000551
552If you give more than one file name when starting Vim, this list is remembered
553as the argument list. You can jump to each file in this list.
554
555Do not confuse this with the buffer list, which you can see with the
556|:buffers| command. The argument list was already present in Vi, the buffer
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000557list is new in Vim. Every file name in the argument list will also be present
558in the buffer list (unless it was deleted with |:bdel| or |:bwipe|). But it's
559common that names in the buffer list are not in the argument list.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000560
561This subject is introduced in section |07.2| of the user manual.
562
563There is one global argument list, which is used for all windows by default.
564It is possible to create a new argument list local to a window, see
565|:arglocal|.
566
567You can use the argument list with the following commands, and with the
568expression functions |argc()| and |argv()|. These all work on the argument
569list of the current window.
570
571 *:ar* *:args*
572:ar[gs] Print the argument list, with the current file in
573 square brackets.
574
575:ar[gs] [++opt] [+cmd] {arglist} *:args_f*
576 Define {arglist} as the new argument list and edit
577 the first one. This fails when changes have been made
578 and Vim does not want to |abandon| the current buffer.
579 Also see |++opt| and |+cmd|.
580 {Vi: no ++opt}
581
582:ar[gs]! [++opt] [+cmd] {arglist} *:args_f!*
583 Define {arglist} as the new argument list and edit
584 the first one. Discard any changes to the current
585 buffer.
586 Also see |++opt| and |+cmd|.
587 {Vi: no ++opt}
588
589:[count]arge[dit][!] [++opt] [+cmd] {name} *:arge* *:argedit*
590 Add {name} to the argument list and edit it.
591 When {name} already exists in the argument list, this
592 entry is edited.
593 This is like using |:argadd| and then |:edit|.
594 Note that only one file name is allowed, and spaces
595 inside the file name are allowed, like with |:edit|.
596 [count] is used like with |:argadd|.
597 [!] is required if the current file cannot be
598 |abandon|ed.
599 Also see |++opt| and |+cmd|.
600 {not in Vi}
601
602:[count]arga[dd] {name} .. *:arga* *:argadd* *E479*
603 Add the {name}s to the argument list.
604 If [count] is omitted, the {name}s are added just
605 after the current entry in the argument list.
606 Otherwise they are added after the [count]'th file.
607 If the argument list is "a b c", and "b" is the
608 current argument, then these commands result in:
609 command new argument list ~
610 :argadd x a b x c
611 :0argadd x x a b c
612 :1argadd x a x b c
613 :99argadd x a b c x
614 There is no check for duplicates, it is possible to
615 add a file to the argument list twice.
616 The currently edited file is not changed.
617 {not in Vi} {not available when compiled without the
618 |+listcmds| feature}
619 Note: you can also use this method: >
620 :args ## x
621< This will add the "x" item and sort the new list.
622
623:argd[elete] {pattern} .. *:argd* *:argdelete* *E480*
624 Delete files from the argument list that match the
625 {pattern}s. {pattern} is used like a file pattern,
626 see |file-pattern|. "%" can be used to delete the
627 current entry.
628 This command keeps the currently edited file, also
629 when it's deleted from the argument list.
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +0000630 Example: >
631 :argdel *.obj
632< {not in Vi} {not available when compiled without the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000633 |+listcmds| feature}
634
635:{range}argd[elete] Delete the {range} files from the argument list.
636 When the last number in the range is too high, up to
637 the last argument is deleted. Example: >
638 :10,1000argdel
639< Deletes arguments 10 and further, keeping 1-9.
640 {not in Vi} {not available when compiled without the
641 |+listcmds| feature}
642
643 *:argu* *:argument*
644:[count]argu[ment] [count] [++opt] [+cmd]
645 Edit file [count] in the argument list. When [count]
646 is omitted the current entry is used. This fails
647 when changes have been made and Vim does not want to
648 |abandon| the current buffer.
649 Also see |++opt| and |+cmd|.
650 {not in Vi} {not available when compiled without the
651 |+listcmds| feature}
652
653:[count]argu[ment]! [count] [++opt] [+cmd]
654 Edit file [count] in the argument list, discard any
655 changes to the current buffer. When [count] is
656 omitted the current entry is used.
657 Also see |++opt| and |+cmd|.
658 {not in Vi} {not available when compiled without the
659 |+listcmds| feature}
660
661:[count]n[ext] [++opt] [+cmd] *:n* *:ne* *:next* *E165* *E163*
662 Edit [count] next file. This fails when changes have
663 been made and Vim does not want to |abandon| the
664 current buffer. Also see |++opt| and |+cmd|. {Vi: no
665 count or ++opt}.
666
667:[count]n[ext]! [++opt] [+cmd]
668 Edit [count] next file, discard any changes to the
669 buffer. Also see |++opt| and |+cmd|. {Vi: no count
670 or ++opt}.
671
672:n[ext] [++opt] [+cmd] {arglist} *:next_f*
673 Same as |:args_f|.
674
675:n[ext]! [++opt] [+cmd] {arglist}
676 Same as |:args_f!|.
677
678:[count]N[ext] [count] [++opt] [+cmd] *:Next* *:N* *E164*
679 Edit [count] previous file in argument list. This
680 fails when changes have been made and Vim does not
681 want to |abandon| the current buffer.
682 Also see |++opt| and |+cmd|. {Vi: no count or ++opt}.
683
684:[count]N[ext]! [count] [++opt] [+cmd]
685 Edit [count] previous file in argument list. Discard
686 any changes to the buffer. Also see |++opt| and
687 |+cmd|. {Vi: no count or ++opt}.
688
689:[count]prev[ious] [count] [++opt] [+cmd] *:prev* *:previous*
690 Same as :Next. Also see |++opt| and |+cmd|. {Vi:
691 only in some versions}
692
693 *:rew* *:rewind*
694:rew[ind] [++opt] [+cmd]
695 Start editing the first file in the argument list.
696 This fails when changes have been made and Vim does
697 not want to |abandon| the current buffer.
698 Also see |++opt| and |+cmd|. {Vi: no ++opt}
699
700:rew[ind]! [++opt] [+cmd]
701 Start editing the first file in the argument list.
702 Discard any changes to the buffer. Also see |++opt|
703 and |+cmd|. {Vi: no ++opt}
704
705 *:fir* *:first*
706:fir[st][!] [++opt] [+cmd]
707 Other name for ":rewind". {not in Vi}
708
709 *:la* *:last*
710:la[st] [++opt] [+cmd]
711 Start editing the last file in the argument list.
712 This fails when changes have been made and Vim does
713 not want to |abandon| the current buffer.
714 Also see |++opt| and |+cmd|. {not in Vi}
715
716:la[st]! [++opt] [+cmd]
717 Start editing the last file in the argument list.
718 Discard any changes to the buffer. Also see |++opt|
719 and |+cmd|. {not in Vi}
720
721 *:wn* *:wnext*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000722:[count]wn[ext] [++opt]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000723 Write current file and start editing the [count]
724 next file. Also see |++opt| and |+cmd|. {not in Vi}
725
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000726:[count]wn[ext] [++opt] {file}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000727 Write current file to {file} and start editing the
728 [count] next file, unless {file} already exists and
729 the 'writeany' option is off. Also see |++opt| and
730 |+cmd|. {not in Vi}
731
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000732:[count]wn[ext]! [++opt] {file}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000733 Write current file to {file} and start editing the
734 [count] next file. Also see |++opt| and |+cmd|. {not
735 in Vi}
736
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000737:[count]wN[ext][!] [++opt] [file] *:wN* *:wNext*
738:[count]wp[revious][!] [++opt] [file] *:wp* *:wprevious*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000739 Same as :wnext, but go to previous file instead of
740 next. {not in Vi}
741
742The [count] in the commands above defaults to one. For some commands it is
743possible to use two counts. The last one (rightmost one) is used.
744
745If no [+cmd] argument is present, the cursor is positioned at the last known
746cursor position for the file. If 'startofline' is set, the cursor will be
747positioned at the first non-blank in the line, otherwise the last know column
748is used. If there is no last known cursor position the cursor will be in the
749first line (the last line in Ex mode).
750
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000751 *{arglist}*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000752The wildcards in the argument list are expanded and the file names are sorted.
753Thus you can use the command "vim *.c" to edit all the C files. From within
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000754Vim the command ":n *.c" does the same.
755
756White space is used to separate file names. Put a backslash before a space or
Bram Moolenaar9e368db2007-05-12 13:25:01 +0000757tab to include it in a file name. E.g., to edit the single file "foo bar": >
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000758 :next foo\ bar
759
760On Unix and a few other systems you can also use backticks, for example: >
761 :next `find . -name \\*.c -print`
Bram Moolenaar071d4272004-06-13 20:20:40 +0000762The backslashes before the star are required to prevent "*.c" to be expanded
763by the shell before executing the find program.
764
765 *arglist-position*
766When there is an argument list you can see which file you are editing in the
767title of the window (if there is one and 'title' is on) and with the file
768message you get with the "CTRL-G" command. You will see something like
769 (file 4 of 11)
770If 'shortmess' contains 'f' it will be
771 (4 of 11)
772If you are not really editing the file at the current position in the argument
773list it will be
774 (file (4) of 11)
775This means that you are position 4 in the argument list, but not editing the
776fourth file in the argument list. This happens when you do ":e file".
777
778
779LOCAL ARGUMENT LIST
780
781{not in Vi}
782{not available when compiled without the |+windows| or |+listcmds| feature}
783
784 *:arglocal*
785:argl[ocal] Make a local copy of the global argument list.
786 Doesn't start editing another file.
787
788:argl[ocal][!] [++opt] [+cmd] {arglist}
789 Define a new argument list, which is local to the
790 current window. Works like |:args_f| otherwise.
791
792 *:argglobal*
793:argg[lobal] Use the global argument list for the current window.
794 Doesn't start editing another file.
795
796:argg[lobal][!] [++opt] [+cmd] {arglist}
797 Use the global argument list for the current window.
798 Define a new global argument list like |:args_f|.
799 All windows using the global argument list will see
800 this new list.
801
802There can be several argument lists. They can be shared between windows.
803When they are shared, changing the argument list in one window will also
804change it in the other window.
805
806When a window is split the new window inherits the argument list from the
807current window. The two windows then share this list, until one of them uses
808|:arglocal| or |:argglobal| to use another argument list.
809
810
811USING THE ARGUMENT LIST
812
813 *:argdo*
814:argdo[!] {cmd} Execute {cmd} for each file in the argument list.
815 It works like doing this: >
816 :rewind
817 :{cmd}
818 :next
819 :{cmd}
820 etc.
821< When the current file can't be |abandon|ed and the [!]
822 is not present, the command fails.
823 When an error is detected on one file, further files
824 in the argument list will not be visited.
825 The last file in the argument list (or where an error
826 occurred) becomes the current file.
827 {cmd} can contain '|' to concatenate several commands.
828 {cmd} must not change the argument list.
829 Note: While this command is executing, the Syntax
830 autocommand event is disabled by adding it to
831 'eventignore'. This considerably speeds up editing
832 each file.
833 {not in Vi} {not available when compiled without the
834 |+listcmds| feature}
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000835 Also see |:windo|, |:tabdo| and |:bufdo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000836
837Example: >
838 :args *.c
839 :argdo set ff=unix | update
840This sets the 'fileformat' option to "unix" and writes the file if is now
841changed. This is done for all *.c files.
842
843Example: >
844 :args *.[ch]
845 :argdo %s/\<my_foo\>/My_Foo/ge | update
846This changes the word "my_foo" to "My_Foo" in all *.c and *.h files. The "e"
847flag is used for the ":substitute" command to avoid an error for files where
848"my_foo" isn't used. ":update" writes the file only if changes were made.
849
850==============================================================================
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00008514. Writing *writing* *save-file*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000852
853Note: When the 'write' option is off, you are not able to write any file.
854
855 *:w* *:write*
856 *E502* *E503* *E504* *E505*
Bram Moolenaar9964e462007-05-05 17:54:07 +0000857 *E512* *E514* *E667* *E796*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000858:w[rite] [++opt] Write the whole buffer to the current file. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000859 the normal way to save changes to a file. It fails
860 when the 'readonly' option is set or when there is
861 another reason why the file can't be written.
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000862 For ++opt see |++opt|, but only ++bin, ++nobin, ++ff
863 and ++enc are effective.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000864
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000865:w[rite]! [++opt] Like ":write", but forcefully write when 'readonly' is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000866 set or there is another reason why writing was
867 refused.
868 Note: This may change the permission and ownership of
869 the file and break (symbolic) links. Add the 'W' flag
870 to 'cpoptions' to avoid this.
871
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000872:[range]w[rite][!] [++opt]
873 Write the specified lines to the current file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000874 is unusual, because the file will not contain all
875 lines in the buffer.
876
877 *:w_f* *:write_f*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000878:[range]w[rite] [++opt] {file}
879 Write the specified lines to {file}, unless it
Bram Moolenaar071d4272004-06-13 20:20:40 +0000880 already exists and the 'writeany' option is off.
881
882 *:w!*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000883:[range]w[rite]! [++opt] {file}
884 Write the specified lines to {file}. Overwrite an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000885 existing file.
886
887 *:w_a* *:write_a* *E494*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000888:[range]w[rite][!] [++opt] >>
889 Append the specified lines to the current file.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000890
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000891:[range]w[rite][!] [++opt] >> {file}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000892 Append the specified lines to {file}. '!' forces the
893 write even if file does not exist.
894
895 *:w_c* *:write_c*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000896:[range]w[rite] [++opt] !{cmd}
897 Execute {cmd} with [range] lines as standard input
Bram Moolenaar071d4272004-06-13 20:20:40 +0000898 (note the space in front of the '!'). {cmd} is
899 executed like with ":!{cmd}", any '!' is replaced with
900 the previous command |:!|.
901
Bram Moolenaar5c4e21c2004-10-12 19:54:52 +0000902The default [range] for the ":w" command is the whole buffer (1,$). If you
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000903write the whole buffer, it is no longer considered changed. When you
904write it to a different file with ":w somefile" it depends on the "+" flag in
905'cpoptions'. When included, the write command will reset the 'modified' flag,
906even though the buffer itself may still be different from its file.
Bram Moolenaar5c4e21c2004-10-12 19:54:52 +0000907
Bram Moolenaar071d4272004-06-13 20:20:40 +0000908If a file name is given with ":w" it becomes the alternate file. This can be
909used, for example, when the write fails and you want to try again later with
910":w #". This can be switched off by removing the 'A' flag from the
911'cpoptions' option.
912
913 *:sav* *:saveas*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000914:sav[eas][!] [++opt] {file}
915 Save the current buffer under the name {file} and set
Bram Moolenaar071d4272004-06-13 20:20:40 +0000916 the filename of the current buffer to {file}. The
917 previous name is used for the alternate file name.
918 The [!] is needed to overwrite an existing file.
Bram Moolenaar2d3f4892006-01-20 23:02:51 +0000919 When 'filetype' is empty filetype detection is done
920 with the new name, before the file is written.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000921 When the write was successful 'readonly' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000922 {not in Vi}
923
924 *:up* *:update*
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000925:[range]up[date][!] [++opt] [>>] [file]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000926 Like ":write", but only write when the buffer has been
927 modified. {not in Vi}
928
929
930WRITING WITH MULTIPLE BUFFERS *buffer-write*
931
932 *:wa* *:wall*
933:wa[ll] Write all changed buffers. Buffers without a file
934 name or which are readonly are not written. {not in
935 Vi}
936
937:wa[ll]! Write all changed buffers, even the ones that are
938 readonly. Buffers without a file name are not
939 written. {not in Vi}
940
941
942Vim will warn you if you try to overwrite a file that has been changed
943elsewhere. See |timestamp|.
944
945 *backup* *E207* *E506* *E507* *E508* *E509* *E510*
946If you write to an existing file (but do not append) while the 'backup',
947'writebackup' or 'patchmode' option is on, a backup of the original file is
948made. The file is either copied or renamed (see 'backupcopy'). After the
949file has been successfully written and when the 'writebackup' option is on and
950the 'backup' option is off, the backup file is deleted. When the 'patchmode'
951option is on the backup file may be renamed.
952
953 *backup-table*
954'backup' 'writebackup' action ~
955 off off no backup made
956 off on backup current file, deleted afterwards (default)
957 on off delete old backup, backup current file
958 on on delete old backup, backup current file
959
960When the 'backupskip' pattern matches with the name of the file which is
961written, no backup file is made. The values of 'backup' and 'writebackup' are
962ignored then.
963
964When the 'backup' option is on, an old backup file (with the same name as the
965new backup file) will be deleted. If 'backup' is not set, but 'writebackup'
966is set, an existing backup file will not be deleted. The backup file that is
967made while the file is being written will have a different name.
968
969On some filesystems it's possible that in a crash you lose both the backup and
970the newly written file (it might be there but contain bogus data). In that
971case try recovery, because the swap file is synced to disk and might still be
972there. |:recover|
973
974The directories given with the 'backupdir' option is used to put the backup
975file in. (default: same directory as the written file).
976
977Whether the backup is a new file, which is a copy of the original file, or the
978original file renamed depends on the 'backupcopy' option. See there for an
979explanation of when the copy is made and when the file is renamed.
980
981If the creation of a backup file fails, the write is not done. If you want
982to write anyway add a '!' to the command.
983
984 *write-readonly*
985When the 'cpoptions' option contains 'W', Vim will refuse to overwrite a
986readonly file. When 'W' is not present, ":w!" will overwrite a readonly file,
987if the system allows it (the directory must be writable).
988
989 *write-fail*
990If the writing of the new file fails, you have to be careful not to lose
991your changes AND the original file. If there is no backup file and writing
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000992the new file failed, you have already lost the original file! DON'T EXIT VIM
993UNTIL YOU WRITE OUT THE FILE! If a backup was made, it is put back in place
Bram Moolenaar071d4272004-06-13 20:20:40 +0000994of the original file (if possible). If you exit Vim, and lose the changes
995you made, the original file will mostly still be there. If putting back the
996original file fails, there will be an error message telling you that you
997lost the original file.
998
999 *DOS-format-write*
1000If the 'fileformat' is "dos", <CR> <NL> is used for <EOL>. This is default
1001for MS-DOS, Win32 and OS/2. On other systems the message "[dos format]" is
1002shown to remind you that an unusual <EOL> was used.
1003 *Unix-format-write*
1004If the 'fileformat' is "unix", <NL> is used for <EOL>. On MS-DOS, Win32 and
1005OS/2 the message "[unix format]" is shown.
1006 *Mac-format-write*
1007If the 'fileformat' is "mac", <CR> is used for <EOL>. On non-Mac systems the
1008message "[mac format]" is shown.
1009
1010See also |file-formats| and the 'fileformat' and 'fileformats' options.
1011
1012 *ACL*
1013ACL stands for Access Control List. It is an advanced way to control access
1014rights for a file. It is used on new MS-Windows and Unix systems, but only
1015when the filesystem supports it.
1016 Vim attempts to preserve the ACL info when writing a file. The backup file
1017will get the ACL info of the original file.
1018 The ACL info is also used to check if a file is read-only (when opening the
1019file).
1020
1021 *read-only-share*
1022When MS-Windows shares a drive on the network it can be marked as read-only.
1023This means that even if the file read-only attribute is absent, and the ACL
1024settings on NT network shared drives allow writing to the file, you can still
1025not write to the file. Vim on Win32 platforms will detect read-only network
1026drives and will mark the file as read-only. You will not be able to override
1027it with |:write|.
1028
1029 *write-device*
1030When the file name is actually a device name, Vim will not make a backup (that
1031would be impossible). You need to use "!", since the device already exists.
1032Example for Unix: >
1033 :w! /dev/lpt0
1034and for MS-DOS or MS-Windows: >
1035 :w! lpt0
1036For Unix a device is detected when the name doesn't refer to a normal file or
1037a directory. A fifo or named pipe also looks like a device to Vim.
1038For MS-DOS and MS-Windows the device is detected by its name:
1039 AUX
1040 CON
1041 CLOCK$
1042 NUL
1043 PRN
1044 COMn n=1,2,3... etc
1045 LPTn n=1,2,3... etc
1046The names can be in upper- or lowercase.
1047
1048==============================================================================
Bram Moolenaar1cd871b2004-12-19 22:46:22 +000010495. Writing and quitting *write-quit*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001050
1051 *:q* *:quit*
1052:q[uit] Quit the current window. Quit Vim if this is the last
1053 window. This fails when changes have been made and
1054 Vim refuses to |abandon| the current buffer, and when
1055 the last file in the argument list has not been
1056 edited.
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00001057 If there are other tab pages and quitting the last
1058 window in the current tab page the current tab page is
1059 closed |tab-page|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001060
1061:conf[irm] q[uit] Quit, but give prompt when changes have been made, or
1062 the last file in the argument list has not been
1063 edited. See |:confirm| and 'confirm'. {not in Vi}
1064
1065:q[uit]! Quit without writing, also when visible buffers have
1066 changes. Does not exit when there are changed hidden
1067 buffers. Use ":qall!" to exit always.
1068
1069:cq[uit] Quit always, without writing, and return an error
1070 code. See |:cq|. Used for Manx's QuickFix mode (see
1071 |quickfix|). {not in Vi}
1072
1073 *:wq*
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001074:wq [++opt] Write the current file and quit. Writing fails when
Bram Moolenaar071d4272004-06-13 20:20:40 +00001075 the file is read-only or the buffer does not have a
1076 name. Quitting fails when the last file in the
1077 argument list has not been edited.
1078
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001079:wq! [++opt] Write the current file and quit. Writing fails when
Bram Moolenaar071d4272004-06-13 20:20:40 +00001080 the current buffer does not have a name.
1081
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001082:wq [++opt] {file} Write to {file} and quit. Quitting fails when the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001083 last file in the argument list has not been edited.
1084
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001085:wq! [++opt] {file} Write to {file} and quit.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001086
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001087:[range]wq[!] [++opt] [file]
1088 Same as above, but only write the lines in [range].
Bram Moolenaar071d4272004-06-13 20:20:40 +00001089
1090 *:x* *:xit*
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001091:[range]x[it][!] [++opt] [file]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001092 Like ":wq", but write only when changes have been
1093 made.
1094 When 'hidden' is set and there are more windows, the
1095 current buffer becomes hidden, after writing the file.
1096
1097 *:exi* *:exit*
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001098:[range]exi[t][!] [++opt] [file]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001099 Same as :xit.
1100
1101 *ZZ*
1102ZZ Write current file, if modified, and quit (same as
1103 ":x"). (Note: If there are several windows for the
1104 current file, the file is written if it was modified
1105 and the window is closed).
1106
1107 *ZQ*
1108ZQ Quit without checking for changes (same as ":q!").
1109 {not in Vi}
1110
1111MULTIPLE WINDOWS AND BUFFERS *window-exit*
1112
1113 *:qa* *:qall*
1114:qa[ll] Exit Vim, unless there are some buffers which have been
1115 changed. (Use ":bmod" to go to the next modified buffer).
1116 When 'autowriteall' is set all changed buffers will be
1117 written, like |:wqall|. {not in Vi}
1118
1119:conf[irm] qa[ll]
1120 Exit Vim. Bring up a prompt when some buffers have been
1121 changed. See |:confirm|. {not in Vi}
1122
1123:qa[ll]! Exit Vim. Any changes to buffers are lost. {not in Vi}
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00001124 Also see |:cquit|, it does the same but exits with a non-zero
1125 value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001126
1127 *:quita* *:quitall*
1128:quita[ll][!] Same as ":qall". {not in Vi}
1129
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001130:wqa[ll] [++opt] *:wqa* *:wqall* *:xa* *:xall*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001131:xa[ll] Write all changed buffers and exit Vim. If there are buffers
1132 without a file name, which are readonly or which cannot be
1133 written for another reason, Vim will not quit. {not in Vi}
1134
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001135:conf[irm] wqa[ll] [++opt]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001136:conf[irm] xa[ll]
1137 Write all changed buffers and exit Vim. Bring up a prompt
1138 when some buffers are readonly or cannot be written for
1139 another reason. See |:confirm|. {not in Vi}
1140
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001141:wqa[ll]! [++opt]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001142:xa[ll]! Write all changed buffers, even the ones that are readonly,
1143 and exit Vim. If there are buffers without a file name or
1144 which cannot be written for another reason, Vim will not quit.
1145 {not in Vi}
1146
1147==============================================================================
Bram Moolenaar1cd871b2004-12-19 22:46:22 +000011486. Dialogs *edit-dialogs*
1149
1150 *:confirm* *:conf*
1151:conf[irm] {command} Execute {command}, and use a dialog when an
1152 operation has to be confirmed. Can be used on the
1153 ":q", ":qa" and ":w" commands (the latter to over-ride
1154 a read-only setting).
1155
1156Examples: >
1157 :confirm w foo
1158< Will ask for confirmation when "foo" already exists. >
1159 :confirm q
1160< Will ask for confirmation when there are changes. >
1161 :confirm qa
1162< If any modified, unsaved buffers exist, you will be prompted to save
1163 or abandon each one. There are also choices to "save all" or "abandon
1164 all".
1165
1166If you want to always use ":confirm", set the 'confirm' option.
1167
1168 *:browse* *:bro* *E338* *E614* *E615* *E616* *E578*
1169:bro[wse] {command} Open a file selection dialog for an argument to
1170 {command}. At present this works for |:e|, |:w|,
Bram Moolenaar9964e462007-05-05 17:54:07 +00001171 |:r|, |:saveas|, |:sp|, |:mkexrc|, |:mkvimrc|,
1172 |:mksession|, |:split|, |:vsplit|, and |:tabe|.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001173 {only in Win32, Athena, Motif, GTK and Mac GUI}
1174 When ":browse" is not possible you get an error
1175 message. If the |+browse| feature is missing or the
1176 {command} doesn't support browsing, the {command} is
1177 executed without a dialog.
1178 ":browse set" works like |:options|.
1179
1180The syntax is best shown via some examples: >
1181 :browse e $vim/foo
1182< Open the browser in the $vim/foo directory, and edit the
1183 file chosen. >
1184 :browse e
1185< Open the browser in the directory specified with 'browsedir',
1186 and edit the file chosen. >
1187 :browse w
1188< Open the browser in the directory of the current buffer,
1189 with the current buffer filename as default, and save the
1190 buffer under the filename chosen. >
1191 :browse w C:/bar
1192< Open the browser in the C:/bar directory, with the current
1193 buffer filename as default, and save the buffer under the
1194 filename chosen.
1195Also see the |'browsedir'| option.
1196For versions of Vim where browsing is not supported, the command is executed
1197unmodified.
1198
1199 *browsefilter*
1200For MS Windows, you can modify the filters that are used in the browse dialog.
1201By setting the g:browsefilter or b:browsefilter variables, you can change the
1202filters globally or locally to the buffer. The variable is set to a string in
1203the format "{filter label}\t{pattern};{pattern}\n" where {filter label} is the
1204text that appears in the "Files of Type" comboBox, and {pattern} is the
1205pattern which filters the filenames. Several patterns can be given, separated
1206by ';'.
1207
1208For Motif the same format is used, but only the very first pattern is actually
1209used (Motif only offers one pattern, but you can edit it).
1210
1211For example, to have only Vim files in the dialog, you could use the following
1212command: >
1213
1214 let g:browsefilter="Vim Scripts\t*.vim\nVim Startup Files\t*vimrc\n"
1215
1216You can override the filter setting on a per-buffer basis by setting the
1217b:browsefilter variable. You would most likely set b:browsefilter in a
1218filetype plugin, so that the browse dialog would contain entries related to
1219the type of file you are currently editing. Disadvantage: This makes it
1220difficult to start editing a file of a different type. To overcome this, you
1221may want to add "All Files\t*.*\n" as the final filter, so that the user can
1222still access any desired file.
1223
1224==============================================================================
12257. The current directory *current-directory*
1226
1227You may use the |:cd| and |:lcd| commands to change to another directory, so
1228you will not have to type that directory name in front of the file names. It
1229also makes a difference for executing external commands, e.g. ":!ls".
1230
Bram Moolenaardf177f62005-02-22 08:39:57 +00001231Changing directory fails when the current buffer is modified, the '.' flag is
1232present in 'cpoptions' and "!" is not used in the command.
1233
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00001234 *:cd* *E747* *E472*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001235:cd[!] On non-Unix systems: Print the current directory
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001236 name. On Unix systems: Change the current directory
1237 to the home directory. Use |:pwd| to print the
1238 current directory on all systems.
1239
Bram Moolenaardf177f62005-02-22 08:39:57 +00001240:cd[!] {path} Change the current directory to {path}.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001241 If {path} is relative, it is searched for in the
1242 directories listed in |'cdpath'|.
1243 Does not change the meaning of an already opened file,
1244 because its full path name is remembered. Files from
1245 the |arglist| may change though!
1246 On MS-DOS this also changes the active drive.
1247 To change to the directory of the current file: >
1248 :cd %:h
1249<
1250 *:cd-* *E186*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001251:cd[!] - Change to the previous current directory (before the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001252 previous ":cd {path}" command). {not in Vi}
1253
1254 *:chd* *:chdir*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001255:chd[ir][!] [path] Same as |:cd|.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001256
1257 *:lc* *:lcd*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001258:lc[d][!] {path} Like |:cd|, but only set the current directory for the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001259 current window. The current directory for other
1260 windows is not changed. {not in Vi}
1261
1262 *:lch* *:lchdir*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001263:lch[dir][!] Same as |:lcd|. {not in Vi}
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001264
1265 *:pw* *:pwd* *E187*
1266:pw[d] Print the current directory name. {Vi: no pwd}
1267 Also see |getcwd()|.
1268
1269So long as no |:lcd| command has been used, all windows share the same current
1270directory. Using a command to jump to another window doesn't change anything
1271for the current directory.
1272When a |:lcd| command has been used for a window, the specified directory
1273becomes the current directory for that window. Windows where the |:lcd|
1274command has not been used stick to the global current directory. When jumping
1275to another window the current directory will become the last specified local
1276current directory. If none was specified, the global current directory is
1277used.
1278When a |:cd| command is used, the current window will lose his local current
1279directory and will use the global current directory from now on.
1280
1281After using |:cd| the full path name will be used for reading and writing
1282files. On some networked file systems this may cause problems. The result of
1283using the full path name is that the file names currently in use will remain
1284referring to the same file. Example: If you have a file a:test and a
1285directory a:vim the commands ":e test" ":cd vim" ":w" will overwrite the file
1286a:test and not write a:vim/test. But if you do ":w test" the file a:vim/test
1287will be written, because you gave a new file name and did not refer to a
1288filename before the ":cd".
1289
1290==============================================================================
Bram Moolenaar071d4272004-06-13 20:20:40 +000012918. Editing binary files *edit-binary*
1292
1293Although Vim was made to edit text files, it is possible to edit binary
1294files. The |-b| Vim argument (b for binary) makes Vim do file I/O in binary
1295mode, and sets some options for editing binary files ('binary' on, 'textwidth'
1296to 0, 'modeline' off, 'expandtab' off). Setting the 'binary' option has the
1297same effect. Don't forget to do this before reading the file.
1298
1299There are a few things to remember when editing binary files:
1300- When editing executable files the number of characters must not change.
1301 Use only the "R" or "r" command to change text. Do not delete characters
1302 with "x" or by backspacing.
1303- Set the 'textwidth' option to 0. Otherwise lines will unexpectedly be
1304 split in two.
1305- When there are not many <EOL>s, the lines will become very long. If you
1306 want to edit a line that does not fit on the screen reset the 'wrap' option.
1307 Horizontal scrolling is used then. If a line becomes too long (more than
1308 about 32767 characters on the Amiga, much more on 32-bit systems, see
1309 |limits|) you cannot edit that line. The line will be split when reading
1310 the file. It is also possible that you get an "out of memory" error when
1311 reading the file.
1312- Make sure the 'binary' option is set BEFORE loading the
1313 file. Otherwise both <CR> <NL> and <NL> are considered to end a line
1314 and when the file is written the <NL> will be replaced with <CR> <NL>.
1315- <Nul> characters are shown on the screen as ^@. You can enter them with
1316 "CTRL-V CTRL-@" or "CTRL-V 000" {Vi cannot handle <Nul> characters in the
1317 file}
1318- To insert a <NL> character in the file split up a line. When writing the
1319 buffer to a file a <NL> will be written for the <EOL>.
1320- Vim normally appends an <EOL> at the end of the file if there is none.
1321 Setting the 'binary' option prevents this. If you want to add the final
1322 <EOL>, set the 'endofline' option. You can also read the value of this
1323 option to see if there was an <EOL> for the last line (you cannot see this
1324 in the text).
1325
1326==============================================================================
13279. Encryption *encryption*
1328
1329Vim is able to write files encrypted, and read them back. The encrypted text
1330cannot be read without the right key.
1331
1332Note: The swapfile and text in memory is not encrypted. A system
1333administrator will be able to see your text while you are editing it.
1334When filtering text with ":!filter" or using ":w !command" the text is not
1335encrypted, this may reveal it to others.
1336
1337WARNING: If you make a typo when entering the key and then write the file and
1338exit, the text will be lost!
1339
1340The normal way to work with encryption, is to use the ":X" command, which will
1341ask you to enter a key. A following write command will use that key to
1342encrypt the file. If you later edit the same file, Vim will ask you to enter
1343a key. If you type the same key as that was used for writing, the text will
1344be readable again. If you use a wrong key, it will be a mess.
1345
1346 *:X*
1347:X Prompt for an encryption key. The typing is done without showing the
1348 actual text, so that someone looking at the display won't see it.
1349 The typed key is stored in the 'key' option, which is used to encrypt
1350 the file when it is written. The file will remain unchanged until you
1351 write it. See also |-x|.
1352
1353The value of the 'key' options is used when text is written. When the option
1354is not empty, the written file will be encrypted, using the value as the
1355encryption key. A magic number is prepended, so that Vim can recognize that
1356the file is encrypted.
1357
1358To disable the encryption, reset the 'key' option to an empty value: >
1359 :set key=
1360
1361When reading a file that has been encrypted and this option is not empty, it
1362will be used for decryption. If the value is empty, you will be prompted to
1363enter the key. If you don't enter a key, the file is edited without being
1364decrypted.
1365
1366If want to start reading a file that uses a different key, set the 'key'
1367option to an empty string, so that Vim will prompt for a new one. Don't use
1368the ":set" command to enter the value, other people can read the command over
1369your shoulder.
1370
1371Since the value of the 'key' option is supposed to be a secret, its value can
1372never be viewed. You should not set this option in a vimrc file.
1373
1374An encrypted file can be recognized by the "file" command, if you add this
1375line to "/etc/magic", "/usr/share/misc/magic" or wherever your system has the
1376"magic" file: >
1377 0 string VimCrypt~ Vim encrypted file
1378
1379Notes:
1380- Encryption is not possible when doing conversion with 'charconvert'.
1381- Text you copy or delete goes to the numbered registers. The registers can
1382 be saved in the .viminfo file, where they could be read. Change your
1383 'viminfo' option to be safe.
1384- Someone can type commands in Vim when you walk away for a moment, he should
1385 not be able to get the key.
1386- If you make a typing mistake when entering the key, you might not be able to
1387 get your text back!
1388- If you type the key with a ":set key=value" command, it can be kept in the
1389 history, showing the 'key' value in a viminfo file.
1390- There is never 100% safety. The encryption in Vim has not been tested for
1391 robustness.
1392- The algorithm used is breakable. A 4 character key in about one hour, a 6
1393 character key in one day (on a Pentium 133 PC). This requires that you know
1394 some text that must appear in the file. An expert can break it for any key.
1395 When the text has been decrypted, this also means that the key can be
1396 revealed, and other files encrypted with the same key can be decrypted.
1397- Pkzip uses the same encryption, and US Govt has no objection to its export.
1398 Pkzip's public file APPNOTE.TXT describes this algorithm in detail.
1399- Vim originates from the Netherlands. That is where the sources come from.
1400 Thus the encryption code is not exported from the USA.
1401
1402==============================================================================
140310. Timestamps *timestamp* *timestamps*
1404
1405Vim remembers the modification timestamp of a file when you begin editing it.
1406This is used to avoid that you have two different versions of the same file
1407(without you knowing this).
1408
1409After a shell command is run (|:!cmd| |suspend| |:read!| |K|) timestamps are
1410compared for all buffers in a window. Vim will run any associated
1411|FileChangedShell| autocommands or display a warning for any files that have
1412changed. In the GUI this happens when Vim regains input focus.
1413
1414 *E321* *E462*
1415If you want to automatically reload a file when it has been changed outside of
1416Vim, set the 'autoread' option. This doesn't work at the moment you write the
1417file though, only when the file wasn't changed inside of Vim.
1418
1419Note that if a FileChangedShell autocommand is defined you will not get a
1420warning message or prompt. The autocommand is expected to handle this.
1421
Bram Moolenaar10de2da2005-01-27 14:33:00 +00001422There is no warning for a directory (e.g., with |netrw-browse|). But you do
1423get warned if you started editing a new file and it was created as a directory
1424later.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001425
1426When Vim notices the timestamp of a file has changed, and the file is being
1427edited in a buffer but has not changed, Vim checks if the contents of the file
1428is equal. This is done by reading the file again (into a hidden buffer, which
1429is immediately deleted again) and comparing the text. If the text is equal,
1430you will get no warning.
1431
1432If you don't get warned often enough you can use the following command.
1433
1434 *:checkt* *:checktime*
1435:checkt[ime] Check if any buffers were changed outside of Vim.
1436 This checks and warns you if you would end up with two
1437 versions of a file.
1438 If this is called from an autocommand, a ":global"
1439 command or is not typed the actual check is postponed
1440 until a moment the side effects (reloading the file)
1441 would be harmless.
1442 Each loaded buffer is checked for its associated file
1443 being changed. If the file was changed Vim will take
1444 action. If there are no changes in the buffer and
1445 'autoread' is set, the buffer is reloaded. Otherwise,
1446 you are offered the choice of reloading the file. If
1447 the file was deleted you get an error message.
1448 If the file previously didn't exist you get a warning
1449 if it exists now.
1450 Once a file has been checked the timestamp is reset,
1451 you will not be warned again.
1452
1453:[N]checkt[ime] {filename}
1454:[N]checkt[ime] [N]
1455 Check the timestamp of a specific buffer. The buffer
1456 may be specified by name, number or with a pattern.
1457
1458
1459Before writing a file the timestamp is checked. If it has changed, Vim will
1460ask if you really want to overwrite the file:
1461
1462 WARNING: The file has been changed since reading it!!!
1463 Do you really want to write to it (y/n)?
1464
1465If you hit 'y' Vim will continue writing the file. If you hit 'n' the write is
1466aborted. If you used ":wq" or "ZZ" Vim will not exit, you will get another
1467chance to write the file.
1468
1469The message would normally mean that somebody has written to the file after
1470the edit session started. This could be another person, in which case you
1471probably want to check if your changes to the file and the changes from the
1472other person should be merged. Write the file under another name and check for
1473differences (the "diff" program can be used for this).
1474
1475It is also possible that you modified the file yourself, from another edit
1476session or with another command (e.g., a filter command). Then you will know
1477which version of the file you want to keep.
1478
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001479There is one situation where you get the message while there is nothing wrong:
1480On a Win32 system on the day daylight saving time starts. There is something
1481in the Win32 libraries that confuses Vim about the hour time difference. The
1482problem goes away the next day.
1483
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001484==============================================================================
148511. File Searching *file-searching*
1486
1487{not available when compiled without the |+path_extra| feature}
1488
1489The file searching is currently used for the 'path', 'cdpath' and 'tags'
Bram Moolenaarc236c162008-07-13 17:41:49 +00001490options, for |finddir()| and |findfile()|. Other commands use |wildcards|
1491which is slightly different.
Bram Moolenaar9964e462007-05-05 17:54:07 +00001492
1493There are three different types of searching:
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001494
Bram Moolenaar02743632005-07-25 20:42:36 +000014951) Downward search: *starstar*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001496 Downward search uses the wildcards '*', '**' and possibly others
Bram Moolenaarc236c162008-07-13 17:41:49 +00001497 supported by your operating system. '*' and '**' are handled inside Vim,
1498 so they work on all operating systems. Note that "**" only acts as a
1499 special wildcard when it is at the start of a name.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001500
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00001501 The usage of '*' is quite simple: It matches 0 or more characters. In a
1502 search pattern this would be ".*". Note that the "." is not used for file
1503 searching.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001504
1505 '**' is more sophisticated:
1506 - It ONLY matches directories.
Bram Moolenaarc236c162008-07-13 17:41:49 +00001507 - It matches up to 30 directories deep by default, so you can use it to
1508 search an entire directory tree
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001509 - The maximum number of levels matched can be given by appending a number
1510 to '**'.
1511 Thus '/usr/**2' can match: >
1512 /usr
1513 /usr/include
1514 /usr/include/sys
1515 /usr/include/g++
1516 /usr/lib
1517 /usr/lib/X11
1518 ....
1519< It does NOT match '/usr/include/g++/std' as this would be three
1520 levels.
Bram Moolenaarc236c162008-07-13 17:41:49 +00001521 The allowed number range is 0 ('**0' is removed) to 100
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001522 If the given number is smaller than 0 it defaults to 30, if it's
Bram Moolenaarc236c162008-07-13 17:41:49 +00001523 bigger than 100 then 100 is used. The system also has a limit on the
1524 path length, usually 256 or 1024 bytes.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001525 - '**' can only be at the end of the path or be followed by a path
1526 separator or by a number and a path separator.
1527
1528 You can combine '*' and '**' in any order: >
1529 /usr/**/sys/*
Bram Moolenaarc236c162008-07-13 17:41:49 +00001530 /usr/*tory/sys/**
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001531 /usr/**2/sys/*
1532
15332) Upward search:
1534 Here you can give a directory and then search the directory tree upward for
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001535 a file. You could give stop-directories to limit the upward search. The
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001536 stop-directories are appended to the path (for the 'path' option) or to
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001537 the filename (for the 'tags' option) with a ';'. If you want several
1538 stop-directories separate them with ';'. If you want no stop-directory
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001539 ("search upward till the root directory) just use ';'. >
1540 /usr/include/sys;/usr
1541< will search in: >
1542 /usr/include/sys
1543 /usr/include
1544 /usr
1545<
1546 If you use a relative path the upward search is started in Vim's current
1547 directory or in the directory of the current file (if the relative path
1548 starts with './' and 'd' is not included in 'cpoptions').
1549
1550 If Vim's current path is /u/user_x/work/release and you do >
1551 :set path=include;/u/user_x
1552< and then search for a file with |gf| the file is searched in: >
1553 /u/user_x/work/release/include
1554 /u/user_x/work/include
1555 /u/user_x/include
1556
Bram Moolenaar402d2fe2005-04-15 21:00:38 +000015573) Combined up/downward search:
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001558 If Vim's current path is /u/user_x/work/release and you do >
1559 set path=**;/u/user_x
1560< and then search for a file with |gf| the file is searched in: >
1561 /u/user_x/work/release/**
1562 /u/user_x/work/**
1563 /u/user_x/**
1564<
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001565 BE CAREFUL! This might consume a lot of time, as the search of
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001566 '/u/user_x/**' includes '/u/user_x/work/**' and
1567 '/u/user_x/work/release/**'. So '/u/user_x/work/release/**' is searched
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001568 three times and '/u/user_x/work/**' is searched twice.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001569
1570 In the above example you might want to set path to: >
1571 :set path=**,/u/user_x/**
1572< This searches: >
1573 /u/user_x/work/release/**
1574 /u/user_x/**
1575< This searches the same directories, but in a different order.
1576
Bram Moolenaar071d4272004-06-13 20:20:40 +00001577
1578 vim:tw=78:ts=8:ft=help:norl: