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