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