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