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