Mercurial > vim
annotate runtime/doc/starting.txt @ 3294:e7e4dbac7ded v7.3.415
updated for version 7.3.415
Problem: Completion of functions stops once a dictionary is encountered.
(James McCoy)
Solution: Return an empty string instead of NULL.
| author | Bram Moolenaar <bram@vim.org> |
|---|---|
| date | Thu, 26 Jan 2012 14:32:30 +0100 |
| parents | 3502a7f991fc |
| children | 2cfb68fa26cd |
| rev | line source |
|---|---|
| 3082 | 1 *starting.txt* For Vim version 7.3. Last change: 2011 Jul 22 |
| 7 | 2 |
| 3 | |
| 4 VIM REFERENCE MANUAL by Bram Moolenaar | |
| 5 | |
| 6 | |
| 7 Starting Vim *starting* | |
| 8 | |
| 9 1. Vim arguments |vim-arguments| | |
| 10 2. Vim on the Amiga |starting-amiga| | |
| 11 3. Running eVim |evim-keys| | |
| 12 4. Initialization |initialization| | |
| 13 5. $VIM and $VIMRUNTIME |$VIM| | |
| 14 6. Suspending |suspend| | |
| 15 7. Saving settings |save-settings| | |
| 16 8. Views and Sessions |views-sessions| | |
| 17 9. The viminfo file |viminfo-file| | |
| 18 | |
| 19 ============================================================================== | |
| 20 1. Vim arguments *vim-arguments* | |
| 21 | |
| 22 Most often, Vim is started to edit a single file with the command | |
| 23 | |
| 24 vim filename *-vim* | |
| 25 | |
| 26 More generally, Vim is started with: | |
| 27 | |
| 28 vim [option | filename] .. | |
| 29 | |
| 30 Option arguments and file name arguments can be mixed, and any number of them | |
| 31 can be given. However, watch out for options that take an argument. | |
| 32 | |
| 33 For compatibility with various Vi versions, see |cmdline-arguments|. | |
| 34 | |
| 35 Exactly one out of the following five items may be used to choose how to | |
| 36 start editing: | |
| 37 | |
| 38 *-file* *---* | |
| 39 filename One or more file names. The first one will be the current | |
| 40 file and read into the buffer. The cursor will be positioned | |
| 41 on the first line of the buffer. | |
| 42 To avoid a file name starting with a '-' being interpreted as | |
| 43 an option, precede the arglist with "--", e.g.: > | |
| 44 vim -- -filename | |
| 45 < All arguments after the "--" will be interpreted as file names, | |
| 46 no other options or "+command" argument can follow. | |
| 47 | |
| 48 *--* | |
| 49 - This argument can mean two things, depending on whether Ex | |
| 50 mode is to be used. | |
| 51 | |
| 52 Starting in Normal mode: > | |
| 53 vim - | |
| 54 ex -v - | |
| 55 < Start editing a new buffer, which is filled with text | |
| 56 that is read from stdin. The commands that would normally be | |
| 57 read from stdin will now be read from stderr. Example: > | |
| 58 find . -name "*.c" -print | vim - | |
| 59 < The buffer will be marked modified, because it contains text | |
| 60 that needs to be saved. Except when in readonly mode, then | |
| 61 the buffer is not marked modified. Example: > | |
| 62 ls | view - | |
| 63 < | |
| 64 Starting in Ex mode: > | |
| 65 ex - | |
| 66 vim -e - | |
| 67 exim - | |
| 68 vim -E | |
| 69 < Start editing in silent mode. See |-s-ex|. | |
| 70 | |
| 71 *-t* *-tag* | |
| 72 -t {tag} A tag. "tag" is looked up in the tags file, the associated | |
| 73 file becomes the current file, and the associated command is | |
| 74 executed. Mostly this is used for C programs, in which case | |
| 75 "tag" often is a function name. The effect is that the file | |
| 76 containing that function becomes the current file and the | |
| 77 cursor is positioned on the start of the function (see | |
| 78 |tags|). | |
| 79 | |
| 80 *-q* *-qf* | |
| 81 -q [errorfile] QuickFix mode. The file with the name [errorfile] is read | |
| 82 and the first error is displayed. See |quickfix|. | |
| 83 If [errorfile] is not given, the 'errorfile' option is used | |
| 84 for the file name. See 'errorfile' for the default value. | |
| 85 {not in Vi} | |
| 86 | |
| 87 (nothing) Without one of the four items above, Vim will start editing a | |
| 88 new buffer. It's empty and doesn't have a file name. | |
| 89 | |
| 90 | |
| 91 The startup mode can be changed by using another name instead of "vim", which | |
| 92 is equal to giving options: | |
| 93 ex vim -e Start in Ex mode (see |Ex-mode|). *ex* | |
| 94 exim vim -E Start in improved Ex mode (see |Ex-mode|). *exim* | |
| 95 (normally not installed) | |
| 96 view vim -R Start in read-only mode (see |-R|). *view* | |
| 97 gvim vim -g Start the GUI (see |gui|). *gvim* | |
| 2581 | 98 gex vim -eg Start the GUI in Ex mode. *gex* |
| 99 gview vim -Rg Start the GUI in read-only mode. *gview* | |
| 7 | 100 rvim vim -Z Like "vim", but in restricted mode (see |-Z|) *rvim* |
| 2581 | 101 rview vim -RZ Like "view", but in restricted mode. *rview* |
| 102 rgvim vim -gZ Like "gvim", but in restricted mode. *rgvim* | |
| 103 rgview vim -RgZ Like "gview", but in restricted mode. *rgview* | |
| 7 | 104 evim vim -y Easy Vim: set 'insertmode' (see |-y|) *evim* |
| 2581 | 105 eview vim -yR Like "evim" in read-only mode *eview* |
| 7 | 106 vimdiff vim -d Start in diff mode |diff-mode| |
| 107 gvimdiff vim -gd Start in diff mode |diff-mode| | |
| 108 | |
| 109 Additional characters may follow, they are ignored. For example, you can have | |
| 110 "gvim-5" to start the GUI. You must have an executable by that name then, of | |
| 111 course. | |
| 112 | |
| 113 On Unix, you would normally have one executable called Vim, and links from the | |
| 114 different startup-names to that executable. If your system does not support | |
| 115 links and you do not want to have several copies of the executable, you could | |
| 116 use an alias instead. For example: > | |
| 117 alias view vim -R | |
| 118 alias gvim vim -g | |
| 119 < | |
| 120 *startup-options* | |
| 121 The option arguments may be given in any order. Single-letter options can be | |
| 122 combined after one dash. There can be no option arguments after the "--" | |
| 123 argument. | |
| 124 | |
| 125 On VMS all option arguments are assumed to be lowercase, unless preceded with | |
| 126 a slash. Thus "-R" means recovery and "-/R" readonly. | |
| 127 | |
| 128 --help *-h* *--help* | |
| 129 -h Give usage (help) message and exit. {not in Vi} | |
| 130 See |info-message| about capturing the text. | |
| 131 | |
| 132 *--version* | |
| 133 --version Print version information and exit. Same output as for | |
| 134 |:version| command. {not in Vi} | |
| 135 See |info-message| about capturing the text. | |
| 136 | |
| 137 *--noplugin* | |
| 138 --noplugin Skip loading plugins. Resets the 'loadplugins' option. | |
| 139 {not in Vi} | |
| 140 Note that the |-u| argument may also disable loading plugins: | |
| 141 argument load vimrc files load plugins ~ | |
| 142 (nothing) yes yes | |
| 143 -u NONE no no | |
| 144 -u NORC no yes | |
| 145 --noplugin yes no | |
| 146 | |
| 1989 | 147 --startuptime {fname} *--startuptime* |
| 1972 | 148 During startup write timing messages to the file {fname}. |
| 149 This can be used to find out where time is spent while loading | |
| 1989 | 150 your .vimrc, plugins and opening the first file. |
| 1972 | 151 When {fname} already exists new messages are appended. |
| 1989 | 152 (Only available when compiled with the |+startuptime| |
| 153 feature). | |
| 1972 | 154 |
| 7 | 155 *--literal* |
| 156 --literal Take file names literally, don't expand wildcards. Not needed | |
| 157 for Unix, because Vim always takes file names literally (the | |
| 158 shell expands wildcards). | |
| 159 Applies to all the names, also the ones that come before this | |
| 160 argument. | |
| 161 | |
| 162 *-+* | |
| 163 +[num] The cursor will be positioned on line "num" for the first | |
| 164 file being edited. If "num" is missing, the cursor will be | |
| 165 positioned on the last line. | |
| 166 | |
| 167 *-+/* | |
| 168 +/{pat} The cursor will be positioned on the first line containing | |
| 169 "pat" in the first file being edited (see |pattern| for the | |
| 170 available search patterns). | |
| 171 | |
| 172 +{command} *-+c* *-c* | |
| 173 -c {command} {command} will be executed after the first file has been | |
| 174 read (and after autocommands and modelines for that file have | |
| 175 been processed). "command" is interpreted as an Ex command. | |
| 176 If the "command" contains spaces, it must be enclosed in | |
| 177 double quotes (this depends on the shell that is used). | |
| 178 Example: > | |
| 179 vim "+set si" main.c | |
| 180 vim "+find stdio.h" | |
| 181 vim -c "set ff=dos" -c wq mine.mak | |
| 182 < | |
| 183 Note: You can use up to 10 "+" or "-c" arguments in a Vim | |
| 184 command. They are executed in the order given. A "-S" | |
| 185 argument counts as a "-c" argument as well. | |
| 186 {Vi only allows one command} | |
| 187 | |
| 188 --cmd {command} *--cmd* | |
| 189 {command} will be executed before processing any vimrc file. | |
| 190 Otherwise it acts like -c {command}. You can use up to 10 of | |
| 191 these commands, independently from "-c" commands. | |
| 192 {not in Vi} | |
| 193 | |
| 194 *-S* | |
| 195 -S {file} The {file} will be sourced after the first file has been read. | |
| 196 This is an easy way to do the equivalent of: > | |
| 197 -c "source {file}" | |
| 198 < It can be mixed with "-c" arguments and repeated like "-c". | |
| 199 The limit of 10 "-c" arguments applies here as well. | |
| 200 {file} cannot start with a "-". | |
| 201 {not in Vi} | |
| 202 | |
| 203 -S Works like "-S Session.vim". Only when used as the last | |
| 204 argument or when another "-" option follows. | |
| 205 | |
| 206 *-r* | |
| 207 -r Recovery mode. Without a file name argument, a list of | |
| 208 existing swap files is given. With a file name, a swap file | |
| 209 is read to recover a crashed editing session. See | |
| 210 |crash-recovery|. | |
| 211 | |
| 212 *-L* | |
| 213 -L Same as -r. {only in some versions of Vi: "List recoverable | |
| 214 edit sessions"} | |
| 215 | |
| 216 *-R* | |
| 217 -R Readonly mode. The 'readonly' option will be set for all the | |
| 218 files being edited. You can still edit the buffer, but will | |
| 219 be prevented from accidentally overwriting a file. If you | |
| 220 forgot that you are in View mode and did make some changes, | |
| 221 you can overwrite a file by adding an exclamation mark to | |
| 222 the Ex command, as in ":w!". The 'readonly' option can be | |
| 223 reset with ":set noro" (see the options chapter, |options|). | |
| 224 Subsequent edits will not be done in readonly mode. Calling | |
| 225 the executable "view" has the same effect as the -R argument. | |
| 226 The 'updatecount' option will be set to 10000, meaning that | |
| 227 the swap file will not be updated automatically very often. | |
| 228 | |
| 229 *-m* | |
| 230 -m Modifications not allowed to be written. The 'write' option | |
| 231 will be reset, so that writing files is disabled. However, | |
| 232 the 'write' option can be set to enable writing again. | |
| 233 {not in Vi} | |
| 234 | |
| 235 *-M* | |
| 236 -M Modifications not allowed. The 'modifiable' option will be | |
| 237 reset, so that changes are not allowed. The 'write' option | |
| 238 will be reset, so that writing files is disabled. However, | |
| 239 the 'modifiable' and 'write' options can be set to enable | |
| 240 changes and writing. | |
| 241 {not in Vi} | |
| 242 | |
| 243 *-Z* *restricted-mode* *E145* | |
| 244 -Z Restricted mode. All commands that make use of an external | |
| 245 shell are disabled. This includes suspending with CTRL-Z, | |
| 246 ":sh", filtering, the system() function, backtick expansion, | |
| 2581 | 247 delete(), rename(), mkdir(), writefile(), libcall(), etc. |
| 7 | 248 {not in Vi} |
| 249 | |
| 250 *-g* | |
| 251 -g Start Vim in GUI mode. See |gui|. {not in Vi} | |
| 252 | |
| 253 *-v* | |
| 254 -v Start Ex in Vi mode. Only makes a difference when the | |
| 255 executable is called "ex" or "gvim". For gvim the GUI is not | |
| 256 started if possible. | |
| 257 | |
| 258 *-e* | |
| 259 -e Start Vim in Ex mode |Q|. Only makes a difference when the | |
| 260 executable is not called "ex". | |
| 261 | |
| 262 *-E* | |
| 263 -E Start Vim in improved Ex mode |gQ|. Only makes a difference | |
| 264 when the executable is not called "exim". | |
| 265 {not in Vi} | |
| 266 | |
| 267 *-s-ex* | |
| 268 -s Silent or batch mode. Only when Vim was started as "ex" or | |
| 269 when preceded with the "-e" argument. Otherwise see |-s|, | |
| 270 which does take an argument while this use of "-s" doesn't. | |
| 271 To be used when Vim is used to execute Ex commands from a file | |
| 272 instead of a terminal. Switches off most prompts and | |
| 273 informative messages. Also warnings and error messages. | |
| 168 | 274 The output of these commands is displayed (to stdout): |
| 275 :print | |
| 276 :list | |
| 277 :number | |
| 278 :set to display option values. | |
| 279 When 'verbose' is non-zero messages are printed (for | |
| 280 debugging, to stderr). | |
| 281 'term' and $TERM are not used. | |
| 7 | 282 If Vim appears to be stuck try typing "qa!<Enter>". You don't |
| 283 get a prompt thus you can't see Vim is waiting for you to type | |
| 284 something. | |
| 285 Initializations are skipped (except the ones given with the | |
| 286 "-u" argument). | |
| 287 Example: > | |
| 288 vim -e -s < thefilter thefile | |
| 289 < | |
| 290 *-b* | |
| 291 -b Binary mode. File I/O will only recognize <NL> to separate | |
| 237 | 292 lines. The 'expandtab' option will be reset. The 'textwidth' |
| 7 | 293 option is set to 0. 'modeline' is reset. The 'binary' option |
| 294 is set. This is done after reading the vimrc/exrc files but | |
| 295 before reading any file in the arglist. See also | |
| 296 |edit-binary|. {not in Vi} | |
| 297 | |
| 298 *-l* | |
| 299 -l Lisp mode. Sets the 'lisp' and 'showmatch' options on. | |
| 300 | |
| 301 *-A* | |
| 302 -A Arabic mode. Sets the 'arabic' option on. (Only when | |
| 303 compiled with the |+arabic| features (which include | |
| 304 |+rightleft|), otherwise Vim gives an error message | |
| 237 | 305 and exits.) {not in Vi} |
| 7 | 306 |
| 307 *-F* | |
| 308 -F Farsi mode. Sets the 'fkmap' and 'rightleft' options on. | |
| 309 (Only when compiled with |+rightleft| and |+farsi| features, | |
| 237 | 310 otherwise Vim gives an error message and exits.) {not in Vi} |
| 7 | 311 |
| 312 *-H* | |
| 313 -H Hebrew mode. Sets the 'hkmap' and 'rightleft' options on. | |
| 314 (Only when compiled with the |+rightleft| feature, otherwise | |
| 237 | 315 Vim gives an error message and exits.) {not in Vi} |
| 7 | 316 |
| 317 *-V* *verbose* | |
| 318 -V[N] Verbose. Sets the 'verbose' option to [N] (default: 10). | |
| 319 Messages will be given for each file that is ":source"d and | |
| 320 for reading or writing a viminfo file. Can be used to find | |
| 321 out what is happening upon startup and exit. {not in Vi} | |
| 1125 | 322 Example: > |
| 323 vim -V8 foobar | |
| 7 | 324 |
| 294 | 325 -V[N]{filename} |
| 326 Like -V and set 'verbosefile' to {filename}. The result is | |
| 327 that messages are not displayed but written to the file | |
| 328 {filename}. {filename} must not start with a digit. | |
| 1125 | 329 Example: > |
| 330 vim -V20vimlog foobar | |
| 331 < | |
| 7 | 332 *-D* |
| 333 -D Debugging. Go to debugging mode when executing the first | |
| 334 command from a script. |debug-mode| | |
| 335 {not available when compiled without the |+eval| feature} | |
| 336 {not in Vi} | |
| 337 | |
| 338 *-C* | |
| 339 -C Compatible mode. Sets the 'compatible' option. You can use | |
| 340 this to get 'compatible', even though a .vimrc file exists. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1989
diff
changeset
|
341 Keep in mind that the command ":set nocompatible" in some |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1989
diff
changeset
|
342 plugin or startup script overrules this, so you may end up |
| 2072 | 343 with 'nocompatible' anyway. To find out, use: > |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1989
diff
changeset
|
344 :verbose set compatible? |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1989
diff
changeset
|
345 < Several plugins won't work with 'compatible' set. You may |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1989
diff
changeset
|
346 want to set it after startup this way: > |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1989
diff
changeset
|
347 vim "+set cp" filename |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1989
diff
changeset
|
348 < Also see |compatible-default|. {not in Vi} |
| 7 | 349 |
| 350 *-N* | |
| 351 -N Not compatible mode. Resets the 'compatible' option. You can | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1989
diff
changeset
|
352 use this to get 'nocompatible', when there is no .vimrc file |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1989
diff
changeset
|
353 or when using "-u NONE". |
| 7 | 354 Also see |compatible-default|. {not in Vi} |
| 355 | |
| 356 *-y* *easy* | |
| 357 -y Easy mode. Implied for |evim| and |eview|. Starts with | |
| 358 'insertmode' set and behaves like a click-and-type editor. | |
| 359 This sources the script $VIMRUNTIME/evim.vim. Mappings are | |
| 360 set up to work like most click-and-type editors, see | |
| 361 |evim-keys|. The GUI is started when available. | |
| 362 {not in Vi} | |
| 363 | |
| 364 *-n* | |
| 365 -n No swap file will be used. Recovery after a crash will be | |
| 366 impossible. Handy if you want to view or edit a file on a | |
| 367 very slow medium (e.g., a floppy). | |
| 368 Can also be done with ":set updatecount=0". You can switch it | |
| 369 on again by setting the 'updatecount' option to some value, | |
| 370 e.g., ":set uc=100". | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1989
diff
changeset
|
371 NOTE: Don't combine -n with -b, making -nb, because that has a |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1989
diff
changeset
|
372 different meaning: |-nb|. |
| 7 | 373 'updatecount' is set to 0 AFTER executing commands from a |
| 374 vimrc file, but before the GUI initializations. Thus it | |
| 375 overrides a setting for 'updatecount' in a vimrc file, but not | |
| 376 in a gvimrc file. See |startup|. | |
| 377 When you want to reduce accesses to the disk (e.g., for a | |
| 378 laptop), don't use "-n", but set 'updatetime' and | |
| 379 'updatecount' to very big numbers, and type ":preserve" when | |
| 380 you want to save your work. This way you keep the possibility | |
| 381 for crash recovery. | |
| 382 {not in Vi} | |
| 383 | |
| 384 *-o* | |
| 385 -o[N] Open N windows, split horizontally. If [N] is not given, | |
| 386 one window is opened for every file given as argument. If | |
| 387 there is not enough room, only the first few files get a | |
| 388 window. If there are more windows than arguments, the last | |
| 389 few windows will be editing an empty file. | |
| 390 {not in Vi} | |
| 391 | |
| 392 *-O* | |
| 393 -O[N] Open N windows, split vertically. Otherwise it's like -o. | |
| 394 If both the -o and the -O option are given, the last one on | |
| 395 the command line determines how the windows will be split. | |
| 396 {not in Vi} | |
| 397 | |
| 674 | 398 *-p* |
| 399 -p[N] Open N tab pages. If [N] is not given, one tab page is opened | |
| 699 | 400 for every file given as argument. The maximum is set with |
| 401 'tabpagemax' pages (default 10). If there are more tab pages | |
| 402 than arguments, the last few tab pages will be editing an | |
| 805 | 403 empty file. Also see |tabpage|. |
| 674 | 404 {not in Vi} |
| 405 | |
| 7 | 406 *-T* |
| 407 -T {terminal} Set the terminal type to "terminal". This influences the | |
| 408 codes that Vim will send to your terminal. This is normally | |
| 409 not needed, because Vim will be able to find out what type | |
| 237 | 410 of terminal you are using. (See |terminal-info|.) {not in Vi} |
| 7 | 411 |
| 412 *-d* | |
| 413 -d Start in diff mode, like |vimdiff|. | |
| 414 {not in Vi} {not available when compiled without the |+diff| | |
| 415 feature} | |
| 416 | |
| 417 -d {device} Only on the Amiga and when not compiled with the |+diff| | |
| 418 feature. Works like "-dev". | |
| 419 *-dev* | |
| 420 -dev {device} Only on the Amiga: The {device} is opened to be used for | |
| 421 editing. | |
| 422 Normally you would use this to set the window position and | |
| 423 size: "-d con:x/y/width/height", e.g., | |
| 424 "-d con:30/10/600/150". But you can also use it to start | |
| 425 editing on another device, e.g., AUX:. {not in Vi} | |
| 426 *-f* | |
| 3082 | 427 -f GUI: Do not disconnect from the program that started Vim. |
| 7 | 428 'f' stands for "foreground". If omitted, the GUI forks a new |
| 429 process and exits the current one. "-f" should be used when | |
| 430 gvim is started by a program that will wait for the edit | |
| 431 session to finish (e.g., mail or readnews). If you want gvim | |
| 819 | 432 never to fork, include 'f' in 'guioptions' in your |gvimrc|. |
| 7 | 433 Careful: You can use "-gf" to start the GUI in the foreground, |
| 434 but "-fg" is used to specify the foreground color. |gui-fork| | |
| 3082 | 435 |
| 436 Amiga: Do not restart Vim to open a new window. This | |
| 437 option should be used when Vim is started by a program that | |
| 438 will wait for the edit session to finish (e.g., mail or | |
| 439 readnews). See |amiga-window|. | |
| 7 | 440 {not in Vi} |
| 441 | |
| 3082 | 442 |
| 7 | 443 *--nofork* |
| 444 --nofork GUI: Do not fork. Same as |-f|. | |
| 445 *-u* *E282* | |
| 446 -u {vimrc} The file {vimrc} is read for initializations. Most other | |
| 447 initializations are skipped; see |initialization|. This can | |
| 448 be used to start Vim in a special mode, with special | |
| 449 mappings and settings. A shell alias can be used to make | |
| 450 this easy to use. For example: > | |
| 451 alias vimc vim -u ~/.c_vimrc !* | |
| 452 < Also consider using autocommands; see |autocommand|. | |
| 453 When {vimrc} is equal to "NONE" (all uppercase), all | |
| 454 initializations from files and environment variables are | |
| 819 | 455 skipped, including reading the |gvimrc| file when the GUI |
| 7 | 456 starts. Loading plugins is also skipped. |
| 457 When {vimrc} is equal to "NORC" (all uppercase), this has the | |
| 458 same effect as "NONE", but loading plugins is not skipped. | |
| 459 Using the "-u" argument has the side effect that the | |
| 460 'compatible' option will be on by default. This can have | |
| 461 unexpected effects. See |'compatible'|. | |
| 462 {not in Vi} | |
| 463 | |
| 464 *-U* *E230* | |
| 819 | 465 -U {gvimrc} The file {gvimrc} is read for initializations when the GUI |
| 237 | 466 starts. Other GUI initializations are skipped. When {gvimrc} |
| 43 | 467 is equal to "NONE", no file is read for GUI initializations at |
| 468 all. |gui-init| | |
| 7 | 469 Exception: Reading the system-wide menu file is always done. |
| 470 {not in Vi} | |
| 471 | |
| 472 *-i* | |
| 473 -i {viminfo} The file "viminfo" is used instead of the default viminfo | |
| 474 file. If the name "NONE" is used (all uppercase), no viminfo | |
| 475 file is read or written, even if 'viminfo' is set or when | |
| 476 ":rv" or ":wv" are used. See also |viminfo-file|. | |
| 477 {not in Vi} | |
| 478 | |
| 479 *-x* | |
| 480 -x Use encryption to read/write files. Will prompt for a key, | |
| 481 which is then stored in the 'key' option. All writes will | |
| 482 then use this key to encrypt the text. The '-x' argument is | |
| 483 not needed when reading a file, because there is a check if | |
| 484 the file that is being read has been encrypted, and Vim asks | |
| 485 for a key automatically. |encryption| | |
| 486 | |
| 487 *-X* | |
| 488 -X Do not try connecting to the X server to get the current | |
| 489 window title and copy/paste using the X clipboard. This | |
| 490 avoids a long startup time when running Vim in a terminal | |
| 491 emulator and the connection to the X server is slow. | |
| 1972 | 492 See |--startuptime| to find out if affects you. |
| 7 | 493 Only makes a difference on Unix or VMS, when compiled with the |
| 494 |+X11| feature. Otherwise it's ignored. | |
| 495 To disable the connection only for specific terminals, see the | |
| 496 'clipboard' option. | |
| 497 When the X11 Session Management Protocol (XSMP) handler has | |
| 498 been built in, the -X option also disables that connection as | |
| 499 it, too, may have undesirable delays. | |
| 500 When the connection is desired later anyway (e.g., for | |
| 501 client-server messages), call the |serverlist()| function. | |
| 502 This does not enable the XSMP handler though. | |
| 503 {not in Vi} | |
| 504 | |
| 505 *-s* | |
| 506 -s {scriptin} The script file "scriptin" is read. The characters in the | |
| 507 file are interpreted as if you had typed them. The same can | |
| 508 be done with the command ":source! {scriptin}". If the end | |
| 509 of the file is reached before the editor exits, further | |
| 510 characters are read from the keyboard. Only works when not | |
| 511 started in Ex mode, see |-s-ex|. See also |complex-repeat|. | |
| 512 {not in Vi} | |
| 513 | |
| 164 | 514 *-w_nr* |
| 515 -w {number} | |
| 516 -w{number} Set the 'window' option to {number}. | |
| 517 | |
| 7 | 518 *-w* |
| 519 -w {scriptout} All the characters that you type are recorded in the file | |
| 520 "scriptout", until you exit Vim. This is useful if you want | |
| 521 to create a script file to be used with "vim -s" or | |
| 522 ":source!". When the "scriptout" file already exists, new | |
| 523 characters are appended. See also |complex-repeat|. | |
| 164 | 524 {scriptout} cannot start with a digit. |
| 7 | 525 {not in Vi} |
| 526 | |
| 527 *-W* | |
| 528 -W {scriptout} Like -w, but do not append, overwrite an existing file. | |
| 529 {not in Vi} | |
| 530 | |
| 531 --remote [+{cmd}] {file} ... | |
| 532 Open the {file} in another Vim that functions as a server. | |
| 533 Any non-file arguments must come before this. | |
| 534 See |--remote|. {not in Vi} | |
| 535 | |
| 536 --remote-silent [+{cmd}] {file} ... | |
| 537 Like --remote, but don't complain if there is no server. | |
| 538 See |--remote-silent|. {not in Vi} | |
| 539 | |
| 540 --remote-wait [+{cmd}] {file} ... | |
| 541 Like --remote, but wait for the server to finish editing the | |
| 542 file(s). | |
| 543 See |--remote-wait|. {not in Vi} | |
| 544 | |
| 545 --remote-wait-silent [+{cmd}] {file} ... | |
| 546 Like --remote-wait, but don't complain if there is no server. | |
| 547 See |--remote-wait-silent|. {not in Vi} | |
| 548 | |
| 549 --servername {name} | |
| 550 Specify the name of the Vim server to send to or to become. | |
| 551 See |--servername|. {not in Vi} | |
| 552 | |
| 553 --remote-send {keys} | |
| 554 Send {keys} to a Vim server and exit. | |
| 555 See |--remote-send|. {not in Vi} | |
| 556 | |
| 557 --remote-expr {expr} | |
| 558 Evaluate {expr} in another Vim that functions as a server. | |
| 559 The result is printed on stdout. | |
| 560 See |--remote-expr|. {not in Vi} | |
| 561 | |
| 562 --serverlist Output a list of Vim server names and exit. See | |
| 1125 | 563 |--serverlist|. {not in Vi} |
| 7 | 564 |
| 565 --socketid {id} *--socketid* | |
| 566 GTK+ GUI Vim only. Make gvim try to use GtkPlug mechanism, so | |
| 567 that it runs inside another window. See |gui-gtk-socketid| | |
| 568 for details. {not in Vi} | |
| 569 | |
| 1376 | 570 --windowid {id} *--windowid* |
| 571 Win32 GUI Vim only. Make gvim try to use the window {id} as a | |
| 572 parent, so that it runs inside that window. See | |
| 573 |gui-w32-windowid| for details. {not in Vi} | |
| 574 | |
| 7 | 575 --echo-wid *--echo-wid* |
| 576 GTK+ GUI Vim only. Make gvim echo the Window ID on stdout, | |
| 577 which can be used to run gvim in a kpart widget. The format | |
| 578 of the output is: > | |
| 579 WID: 12345\n | |
| 580 < {not in Vi} | |
| 581 | |
| 582 --role {role} *--role* | |
| 583 GTK+ 2 GUI only. Set the role of the main window to {role}. | |
| 584 The window role can be used by a window manager to uniquely | |
| 585 identify a window, in order to restore window placement and | |
| 586 such. The --role argument is passed automatically when | |
| 587 restoring the session on login. See |gui-gnome-session| | |
| 588 {not in Vi} | |
| 589 | |
| 590 -P {parent-title} *-P* *MDI* *E671* *E672* | |
| 591 Win32 only: Specify the title of the parent application. When | |
| 592 possible, Vim will run in an MDI window inside the | |
| 593 application. | |
| 594 {parent-title} must appear in the window title of the parent | |
| 595 application. Make sure that it is specific enough. | |
| 596 Note that the implementation is still primitive. It won't | |
| 597 work with all applications and the menu doesn't work. | |
| 598 | |
| 599 -nb *-nb* | |
| 600 -nb={fname} | |
| 601 -nb:{hostname}:{addr}:{password} | |
| 602 Attempt connecting to Netbeans and become an editor server for | |
| 603 it. The second form specifies a file to read connection info | |
| 604 from. The third form specifies the hostname, address and | |
| 605 password for connecting to Netbeans. |netbeans-run| | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1989
diff
changeset
|
606 {only available when compiled with the |+netbeans_intg| |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1989
diff
changeset
|
607 feature; if not then -nb will make Vim exit} |
| 7 | 608 |
| 609 If the executable is called "view", Vim will start in Readonly mode. This is | |
| 610 useful if you can make a hard or symbolic link from "view" to "vim". | |
| 611 Starting in Readonly mode can also be done with "vim -R". | |
| 612 | |
| 613 If the executable is called "ex", Vim will start in "Ex" mode. This means it | |
| 614 will accept only ":" commands. But when the "-v" argument is given, Vim will | |
| 615 start in Normal mode anyway. | |
| 616 | |
| 617 Additional arguments are available on unix like systems when compiled with | |
| 618 X11 GUI support. See |gui-resources|. | |
| 619 | |
| 620 ============================================================================== | |
| 621 2. Vim on the Amiga *starting-amiga* | |
| 622 | |
| 623 Starting Vim from the Workbench *workbench* | |
| 624 ------------------------------- | |
| 625 | |
| 626 Vim can be started from the Workbench by clicking on its icon twice. It will | |
| 627 then start with an empty buffer. | |
| 628 | |
| 629 Vim can be started to edit one or more files by using a "Project" icon. The | |
| 630 "Default Tool" of the icon must be the full pathname of the Vim executable. | |
| 631 The name of the ".info" file must be the same as the name of the text file. | |
| 632 By clicking on this icon twice, Vim will be started with the file name as | |
| 633 current file name, which will be read into the buffer (if it exists). You can | |
| 634 edit multiple files by pressing the shift key while clicking on icons, and | |
| 635 clicking twice on the last one. The "Default Tool" for all these icons must | |
| 636 be the same. | |
| 637 | |
| 638 It is not possible to give arguments to Vim, other than file names, from the | |
| 639 workbench. | |
| 640 | |
| 641 Vim window *amiga-window* | |
| 642 ---------- | |
| 643 | |
| 644 Vim will run in the CLI window where it was started. If Vim was started with | |
| 645 the "run" or "runback" command, or if Vim was started from the workbench, it | |
| 646 will open a window of its own. | |
| 647 | |
| 648 Technical detail: | |
| 649 To open the new window a little trick is used. As soon as Vim | |
| 650 recognizes that it does not run in a normal CLI window, it will | |
| 651 create a script file in "t:". This script file contains the same | |
| 652 command as the one Vim was started with, and an "endcli" command. | |
| 653 This script file is then executed with a "newcli" command (the "c:run" | |
| 654 and "c:newcli" commands are required for this to work). The script | |
| 655 file will hang around until reboot, or until you delete it. This | |
| 656 method is required to get the ":sh" and ":!" commands to work | |
| 657 correctly. But when Vim was started with the -f option (foreground | |
| 658 mode), this method is not used. The reason for this is that | |
| 659 when a program starts Vim with the -f option it will wait for Vim to | |
| 660 exit. With the script trick, the calling program does not know when | |
| 661 Vim exits. The -f option can be used when Vim is started by a mail | |
| 662 program which also waits for the edit session to finish. As a | |
| 663 consequence, the ":sh" and ":!" commands are not available when the | |
| 664 -f option is used. | |
| 665 | |
| 666 Vim will automatically recognize the window size and react to window | |
| 667 resizing. Under Amiga DOS 1.3, it is advised to use the fastfonts program, | |
| 668 "FF", to speed up display redrawing. | |
| 669 | |
| 670 ============================================================================== | |
| 671 3. Running eVim *evim-keys* | |
| 672 | |
| 673 EVim runs Vim as click-and-type editor. This is very unlike the original Vi | |
| 674 idea. But it helps for people that don't use Vim often enough to learn the | |
| 675 commands. Hopefully they will find out that learning to use Normal mode | |
| 676 commands will make their editing much more effective. | |
| 677 | |
| 678 In Evim these options are changed from their default value: | |
| 679 | |
| 680 :set nocompatible Use Vim improvements | |
| 681 :set insertmode Remain in Insert mode most of the time | |
| 682 :set hidden Keep invisible buffers loaded | |
| 683 :set backup Keep backup files (not for VMS) | |
| 684 :set backspace=2 Backspace over everything | |
| 685 :set autoindent auto-indent new lines | |
| 686 :set history=50 keep 50 lines of Ex commands | |
| 687 :set ruler show the cursor position | |
| 688 :set incsearch show matches halfway typing a pattern | |
| 689 :set mouse=a use the mouse in all modes | |
| 690 :set hlsearch highlight all matches for a search pattern | |
| 691 :set whichwrap+=<,>,[,] <Left> and <Right> wrap around line breaks | |
| 692 :set guioptions-=a non-Unix only: don't do auto-select | |
| 693 | |
| 694 Key mappings: | |
| 695 <Down> moves by screen lines rather than file lines | |
| 696 <Up> idem | |
| 697 Q does "gq", formatting, instead of Ex mode | |
| 698 <BS> in Visual mode: deletes the selection | |
| 699 CTRL-X in Visual mode: Cut to clipboard | |
| 700 <S-Del> idem | |
| 701 CTRL-C in Visual mode: Copy to clipboard | |
| 702 <C-Insert> idem | |
| 703 CTRL-V Pastes from the clipboard (in any mode) | |
| 704 <S-Insert> idem | |
| 705 CTRL-Q do what CTRL-V used to do | |
| 706 CTRL-Z undo | |
| 707 CTRL-Y redo | |
| 708 <M-Space> system menu | |
| 709 CTRL-A select all | |
| 710 <C-Tab> next window, CTRL-W w | |
| 711 <C-F4> close window, CTRL-W c | |
| 712 | |
| 713 Additionally: | |
| 714 - ":behave mswin" is used |:behave| | |
| 715 - syntax highlighting is enabled | |
| 716 - filetype detection is enabled, filetype plugins and indenting is enabled | |
| 717 - in a text file 'textwidth' is set to 78 | |
| 718 | |
| 719 One hint: If you want to go to Normal mode to be able to type a sequence of | |
| 720 commands, use CTRL-L. |i_CTRL-L| | |
| 721 | |
| 722 ============================================================================== | |
| 723 4. Initialization *initialization* *startup* | |
| 724 | |
| 725 This section is about the non-GUI version of Vim. See |gui-fork| for | |
| 726 additional initialization when starting the GUI. | |
| 727 | |
| 728 At startup, Vim checks environment variables and files and sets values | |
| 729 accordingly. Vim proceeds in this order: | |
| 730 | |
| 731 1. Set the 'shell' and 'term' option *SHELL* *COMSPEC* *TERM* | |
| 732 The environment variable SHELL, if it exists, is used to set the | |
| 733 'shell' option. On MS-DOS and Win32, the COMSPEC variable is used | |
| 734 if SHELL is not set. | |
| 735 The environment variable TERM, if it exists, is used to set the 'term' | |
| 667 | 736 option. However, 'term' will change later when starting the GUI (step |
| 737 8 below). | |
| 7 | 738 |
| 739 2. Process the arguments | |
| 740 The options and file names from the command that start Vim are | |
| 741 inspected. Buffers are created for all files (but not loaded yet). | |
| 294 | 742 The |-V| argument can be used to display or log what happens next, |
| 743 useful for debugging the initializations. | |
| 7 | 744 |
| 745 3. Execute Ex commands, from environment variables and/or files | |
| 746 An environment variable is read as one Ex command line, where multiple | |
| 747 commands must be separated with '|' or "<NL>". | |
| 748 *vimrc* *exrc* | |
| 749 A file that contains initialization commands is called a "vimrc" file. | |
| 750 Each line in a vimrc file is executed as an Ex command line. It is | |
| 751 sometimes also referred to as "exrc" file. They are the same type of | |
| 752 file, but "exrc" is what Vi always used, "vimrc" is a Vim specific | |
| 753 name. Also see |vimrc-intro|. | |
| 754 | |
| 755 Recommended place for your personal initializations: | |
| 756 Unix $HOME/.vimrc | |
| 757 OS/2 $HOME/.vimrc or $VIM/.vimrc (or _vimrc) | |
| 758 MS-DOS and Win32 $HOME/_vimrc or $VIM/_vimrc | |
| 759 Amiga s:.vimrc or $VIM/.vimrc | |
| 760 | |
| 761 If Vim was started with "-u filename", the file "filename" is used. | |
| 762 All following initializations until 4. are skipped. | |
| 763 "vim -u NORC" can be used to skip these initializations without | |
| 764 reading a file. "vim -u NONE" also skips loading plugins. |-u| | |
| 765 | |
| 766 If Vim was started in Ex mode with the "-s" argument, all following | |
| 767 initializations until 4. are skipped. Only the "-u" option is | |
| 768 interpreted. | |
| 769 *evim.vim* | |
| 770 a. If vim was started as |evim| or |eview| or with the |-y| argument, the | |
| 771 script $VIMRUNTIME/evim.vim will be loaded. | |
| 772 *system-vimrc* | |
| 773 b. For Unix, MS-DOS, MS-Windows, OS/2, VMS, Macintosh, RISC-OS and Amiga | |
| 774 the system vimrc file is read for initializations. The path of this | |
| 775 file is shown with the ":version" command. Mostly it's "$VIM/vimrc". | |
| 776 Note that this file is ALWAYS read in 'compatible' mode, since the | |
| 777 automatic resetting of 'compatible' is only done later. Add a ":set | |
| 778 nocp" command if you like. | |
| 810 | 779 For the Macintosh the $VIMRUNTIME/macmap.vim is read. |
| 7 | 780 |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1989
diff
changeset
|
781 *VIMINIT* *.vimrc* *_vimrc* *EXINIT* *.exrc* *_exrc* *$MYVIMRC* |
| 7 | 782 c. Four places are searched for initializations. The first that exists |
| 819 | 783 is used, the others are ignored. The $MYVIMRC environment variable is |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1989
diff
changeset
|
784 set to the file that was first found, unless $MYVIMRC was already set |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1989
diff
changeset
|
785 and when using VIMINIT. |
| 7 | 786 - The environment variable VIMINIT (see also |compatible-default|) (*) |
| 787 The value of $VIMINIT is used as an Ex command line. | |
| 788 - The user vimrc file(s): | |
| 789 "$HOME/.vimrc" (for Unix and OS/2) (*) | |
| 790 "s:.vimrc" (for Amiga) (*) | |
| 791 "home:.vimrc" (for Amiga) (*) | |
| 792 "$VIM/.vimrc" (for OS/2 and Amiga) (*) | |
| 793 "$HOME/_vimrc" (for MS-DOS and Win32) (*) | |
| 17 | 794 "$VIM/_vimrc" (for MS-DOS and Win32) (*) |
| 7 | 795 Note: For Unix, OS/2 and Amiga, when ".vimrc" does not exist, |
| 796 "_vimrc" is also tried, in case an MS-DOS compatible file | |
| 797 system is used. For MS-DOS and Win32 ".vimrc" is checked | |
| 798 after "_vimrc", in case long file names are used. | |
| 799 Note: For MS-DOS and Win32, "$HOME" is checked first. If no | |
| 800 "_vimrc" or ".vimrc" is found there, "$VIM" is tried. | |
| 801 See |$VIM| for when $VIM is not set. | |
| 802 - The environment variable EXINIT. | |
| 803 The value of $EXINIT is used as an Ex command line. | |
| 804 - The user exrc file(s). Same as for the user vimrc file, but with | |
| 247 | 805 "vimrc" replaced by "exrc". But only one of ".exrc" and "_exrc" is |
| 806 used, depending on the system. And without the (*)! | |
| 7 | 807 |
| 808 d. If the 'exrc' option is on (which is not the default), the current | |
| 247 | 809 directory is searched for three files. The first that exists is used, |
| 7 | 810 the others are ignored. |
| 811 - The file ".vimrc" (for Unix, Amiga and OS/2) (*) | |
| 812 "_vimrc" (for MS-DOS and Win32) (*) | |
| 813 - The file "_vimrc" (for Unix, Amiga and OS/2) (*) | |
| 814 ".vimrc" (for MS-DOS and Win32) (*) | |
| 815 - The file ".exrc" (for Unix, Amiga and OS/2) | |
| 816 "_exrc" (for MS-DOS and Win32) | |
| 817 | |
| 818 (*) Using this file or environment variable will cause 'compatible' to be | |
| 819 off by default. See |compatible-default|. | |
| 820 | |
| 821 4. Load the plugin scripts. *load-plugins* | |
| 822 This does the same as the command: > | |
| 540 | 823 :runtime! plugin/**/*.vim |
| 7 | 824 < The result is that all directories in the 'runtimepath' option will be |
| 825 searched for the "plugin" sub-directory and all files ending in ".vim" | |
| 540 | 826 will be sourced (in alphabetical order per directory), also in |
| 827 subdirectories. | |
| 7 | 828 Loading plugins won't be done when: |
| 829 - The 'loadplugins' option was reset in a vimrc file. | |
| 830 - The |--noplugin| command line argument is used. | |
| 831 - The "-u NONE" command line argument is used |-u|. | |
| 832 - When Vim was compiled without the |+eval| feature. | |
| 632 | 833 Note that using "-c 'set noloadplugins'" doesn't work, because the |
| 834 commands from the command line have not been executed yet. You can | |
| 835 use "--cmd 'set noloadplugins'" |--cmd|. | |
| 7 | 836 |
| 837 5. Set 'shellpipe' and 'shellredir' | |
| 838 The 'shellpipe' and 'shellredir' options are set according to the | |
| 839 value of the 'shell' option, unless they have been set before. | |
| 840 This means that Vim will figure out the values of 'shellpipe' and | |
| 841 'shellredir' for you, unless you have set them yourself. | |
| 842 | |
| 843 6. Set 'updatecount' to zero, if "-n" command argument used | |
| 844 | |
| 845 7. Set binary options | |
| 846 If the "-b" flag was given to Vim, the options for binary editing will | |
| 847 be set now. See |-b|. | |
| 848 | |
| 849 8. Perform GUI initializations | |
| 850 Only when starting "gvim", the GUI initializations will be done. See | |
| 851 |gui-init|. | |
| 852 | |
| 853 9. Read the viminfo file | |
| 854 If the 'viminfo' option is not empty, the viminfo file is read. See | |
| 855 |viminfo-file|. | |
| 856 | |
| 857 10. Read the quickfix file | |
| 858 If the "-q" flag was given to Vim, the quickfix file is read. If this | |
| 859 fails, Vim exits. | |
| 860 | |
| 861 11. Open all windows | |
| 862 When the |-o| flag was given, windows will be opened (but not | |
| 863 displayed yet). | |
| 674 | 864 When the |-p| flag was given, tab pages will be created (but not |
| 865 displayed yet). | |
| 7 | 866 When switching screens, it happens now. Redrawing starts. |
| 867 If the "-q" flag was given to Vim, the first error is jumped to. | |
| 868 Buffers for all windows will be loaded. | |
| 869 | |
| 870 12. Execute startup commands | |
| 871 If a "-t" flag was given to Vim, the tag is jumped to. | |
| 872 The commands given with the |-c| and |+cmd| arguments are executed. | |
| 2581 | 873 The starting flag is reset, has("vim_starting") will now return zero. |
| 7 | 874 If the 'insertmode' option is set, Insert mode is entered. |
| 875 The |VimEnter| autocommands are executed. | |
| 876 | |
| 877 Some hints on using initializations: | |
| 878 | |
| 879 Standard setup: | |
| 880 Create a vimrc file to set the default settings and mappings for all your edit | |
| 881 sessions. Put it in a place so that it will be found by 3b: | |
| 882 ~/.vimrc (Unix and OS/2) | |
| 883 s:.vimrc (Amiga) | |
| 884 $VIM\_vimrc (MS-DOS and Win32) | |
| 885 Note that creating a vimrc file will cause the 'compatible' option to be off | |
| 886 by default. See |compatible-default|. | |
| 887 | |
| 888 Local setup: | |
| 889 Put all commands that you need for editing a specific directory only into a | |
| 890 vimrc file and place it in that directory under the name ".vimrc" ("_vimrc" | |
| 891 for MS-DOS and Win32). NOTE: To make Vim look for these special files you | |
| 892 have to turn on the option 'exrc'. See |trojan-horse| too. | |
| 893 | |
| 894 System setup: | |
| 895 This only applies if you are managing a Unix system with several users and | |
| 896 want to set the defaults for all users. Create a vimrc file with commands | |
| 897 for default settings and mappings and put it in the place that is given with | |
| 898 the ":version" command. | |
| 899 | |
| 900 Saving the current state of Vim to a file: | |
| 901 Whenever you have changed values of options or when you have created a | |
| 902 mapping, then you may want to save them in a vimrc file for later use. See | |
| 903 |save-settings| about saving the current state of settings to a file. | |
| 904 | |
| 905 Avoiding setup problems for Vi users: | |
| 906 Vi uses the variable EXINIT and the file "~/.exrc". So if you do not want to | |
| 907 interfere with Vi, then use the variable VIMINIT and the file "vimrc" instead. | |
| 908 | |
| 909 Amiga environment variables: | |
| 910 On the Amiga, two types of environment variables exist. The ones set with the | |
| 911 DOS 1.3 (or later) setenv command are recognized. See the AmigaDos 1.3 | |
| 912 manual. The environment variables set with the old Manx Set command (before | |
| 913 version 5.0) are not recognized. | |
| 914 | |
| 915 MS-DOS line separators: | |
| 916 On MS-DOS-like systems (MS-DOS itself, Win32, and OS/2), Vim assumes that all | |
| 917 the vimrc files have <CR> <NL> pairs as line separators. This will give | |
| 918 problems if you have a file with only <NL>s and have a line like | |
| 919 ":map xx yy^M". The trailing ^M will be ignored. | |
| 920 | |
| 921 *compatible-default* | |
| 922 When Vim starts, the 'compatible' option is on. This will be used when Vim | |
| 923 starts its initializations. But as soon as a user vimrc file is found, or a | |
| 924 vimrc file in the current directory, or the "VIMINIT" environment variable is | |
| 925 set, it will be set to 'nocompatible'. This has the side effect of setting or | |
| 926 resetting other options (see 'compatible'). But only the options that have | |
| 927 not been set or reset will be changed. This has the same effect like the | |
| 928 value of 'compatible' had this value when starting Vim. Note that this | |
| 1125 | 929 doesn't happen for the system-wide vimrc file nor when Vim was started with |
| 930 the |-u| command line argument. It does also happen for gvimrc files. The | |
| 931 $MYVIMRC or $MYGVIMRC file will be set to the first found vimrc and/or gvimrc | |
| 932 file. | |
| 7 | 933 |
| 934 But there is a side effect of setting or resetting 'compatible' at the moment | |
| 935 a .vimrc file is found: Mappings are interpreted the moment they are | |
| 936 encountered. This makes a difference when using things like "<CR>". If the | |
| 937 mappings depend on a certain value of 'compatible', set or reset it before | |
| 938 giving the mapping. | |
| 939 | |
| 940 The above behavior can be overridden in these ways: | |
| 941 - If the "-N" command line argument is given, 'nocompatible' will be used, | |
| 942 even when no vimrc file exists. | |
| 943 - If the "-C" command line argument is given, 'compatible' will be used, even | |
| 944 when a vimrc file exists. | |
| 945 - If the "-u {vimrc}" argument is used, 'compatible' will be used. | |
| 946 - When the name of the executable ends in "ex", then this works like the "-C" | |
| 947 argument was given: 'compatible' will be used, even when a vimrc file | |
| 948 exists. This has been done to make Vim behave like "ex", when it is started | |
| 949 as "ex". | |
| 950 | |
| 951 Avoiding trojan horses: *trojan-horse* | |
| 952 While reading the "vimrc" or the "exrc" file in the current directory, some | |
| 953 commands can be disabled for security reasons by setting the 'secure' option. | |
| 954 This is always done when executing the command from a tags file. Otherwise it | |
| 955 would be possible that you accidentally use a vimrc or tags file that somebody | |
| 956 else created and contains nasty commands. The disabled commands are the ones | |
| 957 that start a shell, the ones that write to a file, and ":autocmd". The ":map" | |
| 958 commands are echoed, so you can see which keys are being mapped. | |
| 959 If you want Vim to execute all commands in a local vimrc file, you | |
| 960 can reset the 'secure' option in the EXINIT or VIMINIT environment variable or | |
| 961 in the global "exrc" or "vimrc" file. This is not possible in "vimrc" or | |
| 962 "exrc" in the current directory, for obvious reasons. | |
| 963 On Unix systems, this only happens if you are not the owner of the | |
| 964 vimrc file. Warning: If you unpack an archive that contains a vimrc or exrc | |
| 965 file, it will be owned by you. You won't have the security protection. Check | |
| 966 the vimrc file before you start Vim in that directory, or reset the 'exrc' | |
| 967 option. Some Unix systems allow a user to do "chown" on a file. This makes | |
| 968 it possible for another user to create a nasty vimrc and make you the owner. | |
| 969 Be careful! | |
| 970 When using tag search commands, executing the search command (the last | |
| 971 part of the line in the tags file) is always done in secure mode. This works | |
| 972 just like executing a command from a vimrc/exrc in the current directory. | |
| 973 | |
| 974 *slow-start* | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1989
diff
changeset
|
975 If Vim takes a long time to start up, use the |--startuptime| argument to find |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1989
diff
changeset
|
976 out what happens. There are a few common causes: |
| 7 | 977 - If the Unix version was compiled with the GUI and/or X11 (check the output |
| 978 of ":version" for "+GUI" and "+X11"), it may need to load shared libraries | |
| 979 and connect to the X11 server. Try compiling a version with GUI and X11 | |
| 980 disabled. This also should make the executable smaller. | |
| 981 Use the |-X| command line argument to avoid connecting to the X server when | |
| 982 running in a terminal. | |
| 983 - If you have "viminfo" enabled, the loading of the viminfo file may take a | |
| 984 while. You can find out if this is the problem by disabling viminfo for a | |
| 985 moment (use the Vim argument "-i NONE", |-i|). Try reducing the number of | |
| 986 lines stored in a register with ":set viminfo='20,<50,s10". |viminfo-file|. | |
| 987 | |
| 988 *:intro* | |
| 989 When Vim starts without a file name, an introductory message is displayed (for | |
| 990 those who don't know what Vim is). It is removed as soon as the display is | |
| 991 redrawn in any way. To see the message again, use the ":intro" command (if | |
| 992 there is not enough room, you will see only part of it). | |
| 993 To avoid the intro message on startup, add the 'I' flag to 'shortmess'. | |
| 994 | |
| 995 *info-message* | |
| 996 The |--help| and |--version| arguments cause Vim to print a message and then | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1989
diff
changeset
|
997 exit. Normally the message is sent to stdout, thus can be redirected to a |
| 7 | 998 file with: > |
| 999 | |
| 1000 vim --help >file | |
| 1001 | |
| 1002 From inside Vim: > | |
| 1003 | |
| 1004 :read !vim --help | |
| 1005 | |
| 1006 When using gvim, it detects that it might have been started from the desktop, | |
| 1007 without a terminal to show messages on. This is detected when both stdout and | |
| 1008 stderr are not a tty. This breaks the ":read" command, as used in the example | |
| 1009 above. To make it work again, set 'shellredir' to ">" instead of the default | |
| 1010 ">&": > | |
| 1011 | |
| 1012 :set shellredir=> | |
| 1013 :read !gvim --help | |
| 1014 | |
| 1015 This still won't work for systems where gvim does not use stdout at all | |
| 1016 though. | |
| 1017 | |
| 1018 ============================================================================== | |
| 1019 5. $VIM and $VIMRUNTIME | |
| 1020 *$VIM* | |
| 1021 The environment variable "$VIM" is used to locate various user files for Vim, | |
| 1022 such as the user startup script ".vimrc". This depends on the system, see | |
| 1023 |startup|. | |
| 1024 | |
| 1025 To avoid the need for every user to set the $VIM environment variable, Vim | |
| 1026 will try to get the value for $VIM in this order: | |
| 1027 1. The value defined by the $VIM environment variable. You can use this to | |
| 1028 make Vim look in a specific directory for its support files. Example: > | |
| 1029 setenv VIM /home/paul/vim | |
| 1030 2. The path from 'helpfile' is used, unless it contains some environment | |
| 1031 variable too (the default is "$VIMRUNTIME/doc/help.txt": chicken-egg | |
| 1032 problem). The file name ("help.txt" or any other) is removed. Then | |
| 1033 trailing directory names are removed, in this order: "doc", "runtime" and | |
| 1034 "vim{version}" (e.g., "vim54"). | |
| 1035 3. For MSDOS, Win32 and OS/2 Vim tries to use the directory name of the | |
| 1036 executable. If it ends in "/src", this is removed. This is useful if you | |
| 1037 unpacked the .zip file in some directory, and adjusted the search path to | |
| 1038 find the vim executable. Trailing directory names are removed, in this | |
| 1039 order: "runtime" and "vim{version}" (e.g., "vim54"). | |
| 1040 4. For Unix the compile-time defined installation directory is used (see the | |
| 1041 output of ":version"). | |
| 1042 | |
| 1043 Once Vim has done this once, it will set the $VIM environment variable. To | |
| 1044 change it later, use a ":let" command like this: > | |
| 1045 :let $VIM = "/home/paul/vim/" | |
| 1046 < | |
| 1047 *$VIMRUNTIME* | |
| 1048 The environment variable "$VIMRUNTIME" is used to locate various support | |
| 1049 files, such as the on-line documentation and files used for syntax | |
| 1050 highlighting. For example, the main help file is normally | |
| 1051 "$VIMRUNTIME/doc/help.txt". | |
| 1052 You don't normally set $VIMRUNTIME yourself, but let Vim figure it out. This | |
| 1053 is the order used to find the value of $VIMRUNTIME: | |
| 1054 1. If the environment variable $VIMRUNTIME is set, it is used. You can use | |
| 1055 this when the runtime files are in an unusual location. | |
| 1056 2. If "$VIM/vim{version}" exists, it is used. {version} is the version | |
| 1057 number of Vim, without any '-' or '.'. For example: "$VIM/vim54". This is | |
| 1058 the normal value for $VIMRUNTIME. | |
| 1059 3. If "$VIM/runtime" exists, it is used. | |
| 1060 4. The value of $VIM is used. This is for backwards compatibility with older | |
| 1061 versions. | |
| 1062 5. When the 'helpfile' option is set and doesn't contain a '$', its value is | |
| 1063 used, with "doc/help.txt" removed from the end. | |
| 1064 | |
| 1065 For Unix, when there is a compiled-in default for $VIMRUNTIME (check the | |
| 1066 output of ":version"), steps 2, 3 and 4 are skipped, and the compiled-in | |
| 1067 default is used after step 5. This means that the compiled-in default | |
| 1068 overrules the value of $VIM. This is useful if $VIM is "/etc" and the runtime | |
| 1069 files are in "/usr/share/vim/vim54". | |
| 1070 | |
| 1071 Once Vim has done this once, it will set the $VIMRUNTIME environment variable. | |
| 1072 To change it later, use a ":let" command like this: > | |
| 1073 :let $VIMRUNTIME = "/home/piet/vim/vim54" | |
| 1074 | |
| 8 | 1075 In case you need the value of $VIMRUNTIME in a shell (e.g., for a script that |
| 1076 greps in the help files) you might be able to use this: > | |
| 1077 | |
| 1078 VIMRUNTIME=`vim -e -T dumb --cmd 'exe "set t_cm=\<C-M>"|echo $VIMRUNTIME|quit' | tr -d '\015' ` | |
| 1079 | |
| 7 | 1080 ============================================================================== |
| 1081 6. Suspending *suspend* | |
| 1082 | |
| 1083 *iconize* *iconise* *CTRL-Z* *v_CTRL-Z* | |
| 1084 CTRL-Z Suspend Vim, like ":stop". | |
| 1085 Works in Normal and in Visual mode. In Insert and | |
| 1086 Command-line mode, the CTRL-Z is inserted as a normal | |
| 1087 character. In Visual mode Vim goes back to Normal | |
| 1088 mode. | |
| 83 | 1089 Note: if CTRL-Z undoes a change see |mswin.vim|. |
| 7 | 1090 |
| 1091 | |
| 1092 :sus[pend][!] or *:sus* *:suspend* *:st* *:stop* | |
| 1093 :st[op][!] Suspend Vim. | |
| 1094 If the '!' is not given and 'autowrite' is set, every | |
| 1095 buffer with changes and a file name is written out. | |
| 1096 If the '!' is given or 'autowrite' is not set, changed | |
| 1097 buffers are not written, don't forget to bring Vim | |
| 1098 back to the foreground later! | |
| 1099 | |
| 1100 In the GUI, suspending is implemented as iconising gvim. In Windows 95/NT, | |
| 1101 gvim is minimized. | |
| 1102 | |
| 1103 On many Unix systems, it is possible to suspend Vim with CTRL-Z. This is only | |
| 1104 possible in Normal and Visual mode (see next chapter, |vim-modes|). Vim will | |
| 1105 continue if you make it the foreground job again. On other systems, CTRL-Z | |
| 1106 will start a new shell. This is the same as the ":sh" command. Vim will | |
| 1107 continue if you exit from the shell. | |
| 1108 | |
| 1109 In X-windows the selection is disowned when Vim suspends. this means you | |
| 1110 can't paste it in another application (since Vim is going to sleep an attempt | |
| 1111 to get the selection would make the program hang). | |
| 1112 | |
| 1113 ============================================================================== | |
| 1114 7. Saving settings *save-settings* | |
| 1115 | |
| 1116 Mostly you will edit your vimrc files manually. This gives you the greatest | |
| 1117 flexibility. There are a few commands to generate a vimrc file automatically. | |
| 1118 You can use these files as they are, or copy/paste lines to include in another | |
| 1119 vimrc file. | |
| 1120 | |
| 1121 *:mk* *:mkexrc* | |
| 1122 :mk[exrc] [file] Write current key mappings and changed options to | |
| 1123 [file] (default ".exrc" in the current directory), | |
| 1124 unless it already exists. {not in Vi} | |
| 1125 | |
| 1126 :mk[exrc]! [file] Always write current key mappings and changed | |
| 1127 options to [file] (default ".exrc" in the current | |
| 1128 directory). {not in Vi} | |
| 1129 | |
| 1130 *:mkv* *:mkvimrc* | |
| 1131 :mkv[imrc][!] [file] Like ":mkexrc", but the default is ".vimrc" in the | |
| 1132 current directory. The ":version" command is also | |
| 1133 written to the file. {not in Vi} | |
| 1134 | |
| 1135 These commands will write ":map" and ":set" commands to a file, in such a way | |
| 1136 that when these commands are executed, the current key mappings and options | |
| 1137 will be set to the same values. The options 'columns', 'endofline', | |
| 1138 'fileformat', 'key', 'lines', 'modified', 'scroll', 'term', 'textmode', | |
| 1139 'ttyfast' and 'ttymouse' are not included, because these are terminal or file | |
| 1140 dependent. Note that the options 'binary', 'paste' and 'readonly' are | |
| 1141 included, this might not always be what you want. | |
| 1142 | |
| 1143 When special keys are used in mappings, The 'cpoptions' option will be | |
| 1144 temporarily set to its Vim default, to avoid the mappings to be | |
| 1145 misinterpreted. This makes the file incompatible with Vi, but makes sure it | |
| 1146 can be used with different terminals. | |
| 1147 | |
| 1148 Only global mappings are stored, not mappings local to a buffer. | |
| 1149 | |
| 1150 A common method is to use a default ".vimrc" file, make some modifications | |
| 1151 with ":map" and ":set" commands and write the modified file. First read the | |
| 1152 default ".vimrc" in with a command like ":source ~piet/.vimrc.Cprogs", change | |
| 1153 the settings and then save them in the current directory with ":mkvimrc!". If | |
| 1154 you want to make this file your default .vimrc, move it to your home directory | |
| 1155 (on Unix), s: (Amiga) or $VIM directory (MS-DOS). You could also use | |
| 1156 autocommands |autocommand| and/or modelines |modeline|. | |
| 1157 | |
| 714 | 1158 *vimrc-option-example* |
| 7 | 1159 If you only want to add a single option setting to your vimrc, you can use |
| 1160 these steps: | |
| 1161 1. Edit your vimrc file with Vim. | |
| 1162 2. Play with the option until it's right. E.g., try out different values for | |
| 1163 'guifont'. | |
| 1164 3. Append a line to set the value of the option, using the expression register | |
| 1165 '=' to enter the value. E.g., for the 'guifont' option: > | |
| 1166 o:set guifont=<C-R>=&guifont<CR><Esc> | |
| 1167 < [<C-R> is a CTRL-R, <CR> is a return, <Esc> is the escape key] | |
| 714 | 1168 You need to escape special characters, esp. spaces. |
| 7 | 1169 |
| 1170 Note that when you create a .vimrc file, this can influence the 'compatible' | |
| 1171 option, which has several side effects. See |'compatible'|. | |
| 1172 ":mkvimrc", ":mkexrc" and ":mksession" write the command to set or reset the | |
| 1173 'compatible' option to the output file first, because of these side effects. | |
| 1174 | |
| 1175 ============================================================================== | |
| 1176 8. Views and Sessions *views-sessions* | |
| 1177 | |
| 1178 This is introduced in sections |21.4| and |21.5| of the user manual. | |
| 1179 | |
| 1180 *View* *view-file* | |
| 1181 A View is a collection of settings that apply to one window. You can save a | |
| 1182 View and when you restore it later, the text is displayed in the same way. | |
| 1183 The options and mappings in this window will also be restored, so that you can | |
| 1184 continue editing like when the View was saved. | |
| 1185 | |
| 1186 *Session* *session-file* | |
| 1187 A Session keeps the Views for all windows, plus the global settings. You can | |
| 1188 save a Session and when you restore it later the window layout looks the same. | |
| 1189 You can use a Session to quickly switch between different projects, | |
| 1190 automatically loading the files you were last working on in that project. | |
| 1191 | |
| 1192 Views and Sessions are a nice addition to viminfo-files, which are used to | |
| 1193 remember information for all Views and Sessions together |viminfo-file|. | |
| 1194 | |
| 1195 You can quickly start editing with a previously saved View or Session with the | |
| 1196 |-S| argument: > | |
| 1197 vim -S Session.vim | |
| 1198 < | |
| 1199 All this is {not in Vi} and {not available when compiled without the | |
| 1200 |+mksession| feature}. | |
| 1201 | |
| 1202 *:mks* *:mksession* | |
| 1203 :mks[ession][!] [file] Write a Vim script that restores the current editing | |
| 1204 session. | |
| 1205 When [!] is included an existing file is overwritten. | |
| 1206 When [file] is omitted "Session.vim" is used. | |
| 1207 | |
| 1208 The output of ":mksession" is like ":mkvimrc", but additional commands are | |
| 1209 added to the file. Which ones depends on the 'sessionoptions' option. The | |
| 1210 resulting file, when executed with a ":source" command: | |
| 1211 1. Restores global mappings and options, if 'sessionoptions' contains | |
| 1212 "options". Script-local mappings will not be written. | |
| 1213 2. Restores global variables that start with an uppercase letter and contain | |
| 1214 at least one lowercase letter, if 'sessionoptions' contains "globals". | |
| 1215 3. Unloads all currently loaded buffers. | |
| 1216 4. Restores the current directory if 'sessionoptions' contains "curdir", or | |
| 1217 sets the current directory to where the Session file is if 'sessionoptions' | |
| 1218 contains "sesdir". | |
| 1219 5. Restores GUI Vim window position, if 'sessionoptions' contains "winpos". | |
| 1220 6. Restores screen size, if 'sessionoptions' contains "resize". | |
| 1221 7. Reloads the buffer list, with the last cursor positions. If | |
| 1222 'sessionoptions' contains "buffers" then all buffers are restored, | |
| 1223 including hidden and unloaded buffers. Otherwise only buffers in windows | |
| 1224 are restored. | |
| 1225 8. Restores all windows with the same layout. If 'sessionoptions' contains | |
| 1125 | 1226 "help", help windows are restored. If 'sessionoptions' contains "blank", |
| 1227 windows editing a buffer without a name will be restored. | |
| 7 | 1228 If 'sessionoptions' contains "winsize" and no (help/blank) windows were |
| 1229 left out, the window sizes are restored (relative to the screen size). | |
| 1230 Otherwise, the windows are just given sensible sizes. | |
| 1231 9. Restores the Views for all the windows, as with |:mkview|. But | |
| 1232 'sessionoptions' is used instead of 'viewoptions'. | |
| 1233 10. If a file exists with the same name as the Session file, but ending in | |
| 1234 "x.vim" (for eXtra), executes that as well. You can use *x.vim files to | |
| 1235 specify additional settings and actions associated with a given Session, | |
| 1236 such as creating menu items in the GUI version. | |
| 1237 | |
| 1238 After restoring the Session, the full filename of your current Session is | |
| 1239 available in the internal variable "v:this_session" |this_session-variable|. | |
| 1240 An example mapping: > | |
| 1241 :nmap <F2> :wa<Bar>exe "mksession! " . v:this_session<CR>:so ~/sessions/ | |
| 1242 This saves the current Session, and starts off the command to load another. | |
| 1243 | |
| 841 | 1244 A session includes all tab pages, unless "tabpages" was removed from |
| 1245 'sessionoptions'. |tab-page| | |
| 674 | 1246 |
| 574 | 1247 The |SessionLoadPost| autocmd event is triggered after a session file is |
| 1248 loaded/sourced. | |
| 1249 *SessionLoad-variable* | |
| 1250 While the session file is loading the SessionLoad global variable is set to 1. | |
| 1251 Plugins can use this to postpone some work until the SessionLoadPost event is | |
| 1252 triggered. | |
| 1253 | |
| 7 | 1254 *:mkvie* *:mkview* |
| 1255 :mkvie[w][!] [file] Write a Vim script that restores the contents of the | |
| 1256 current window. | |
| 1257 When [!] is included an existing file is overwritten. | |
| 1258 When [file] is omitted or is a number from 1 to 9, a | |
| 843 | 1259 name is generated and 'viewdir' prepended. When the |
| 1260 last directory name in 'viewdir' does not exist, this | |
| 1261 directory is created. | |
| 7 | 1262 An existing file is always overwritten then. Use |
| 1263 |:loadview| to load this view again. | |
| 1264 When [file] is the name of a file ('viewdir' is not | |
| 1265 used), a command to edit the file is added to the | |
| 1266 generated file. | |
| 1267 | |
| 1268 The output of ":mkview" contains these items: | |
| 1269 1. The argument list used in the window. When the global argument list is | |
| 1270 used it is reset to the global list. | |
| 1271 The index in the argument list is also restored. | |
| 1272 2. The file being edited in the window. If there is no file, the window is | |
| 1273 made empty. | |
| 1274 3. Restore mappings, abbreviations and options local to the window if | |
| 1275 'viewoptions' contains "options" or "localoptions". For the options it | |
| 1276 restores only values that are local to the current buffer and values local | |
| 1277 to the window. | |
| 1278 When storing the view as part of a session and "options" is in | |
| 1279 'sessionoptions', global values for local options will be stored too. | |
| 1280 4. Restore folds when using manual folding and 'viewoptions' contains | |
| 1281 "folds". Restore manually opened and closed folds. | |
| 1282 5. The scroll position and the cursor position in the file. Doesn't work very | |
| 1283 well when there are closed folds. | |
| 1284 6. The local current directory, if it is different from the global current | |
| 1285 directory. | |
| 1286 | |
| 1287 Note that Views and Sessions are not perfect: | |
| 1288 - They don't restore everything. For example, defined functions, autocommands | |
| 1289 and ":syntax on" are not included. Things like register contents and | |
| 1290 command line history are in viminfo, not in Sessions or Views. | |
| 9 | 1291 - Global option values are only set when they differ from the default value. |
| 7 | 1292 When the current value is not the default value, loading a Session will not |
| 1293 set it back to the default value. Local options will be set back to the | |
| 1294 default value though. | |
| 1295 - Existing mappings will be overwritten without warning. An existing mapping | |
| 1296 may cause an error for ambiguity. | |
| 1297 - When storing manual folds and when storing manually opened/closed folds, | |
| 1298 changes in the file between saving and loading the view will mess it up. | |
| 1299 - The Vim script is not very efficient. But still faster than typing the | |
| 1300 commands yourself! | |
| 1301 | |
| 1302 *:lo* *:loadview* | |
| 1303 :lo[adview] [nr] Load the view for the current file. When [nr] is | |
| 1304 omitted, the view stored with ":mkview" is loaded. | |
| 1305 When [nr] is specified, the view stored with ":mkview | |
| 1306 [nr]" is loaded. | |
| 1307 | |
| 1308 The combination of ":mkview" and ":loadview" can be used to store up to ten | |
| 1309 different views of a file. These are remembered in the directory specified | |
| 1310 with the 'viewdir' option. The views are stored using the file name. If a | |
| 1311 file is renamed or accessed through a (symbolic) link the view will not be | |
| 1312 found. | |
| 1313 | |
| 1314 You might want to clean up your 'viewdir' directory now and then. | |
| 1315 | |
| 1316 To automatically save and restore views for *.c files: > | |
| 1317 au BufWinLeave *.c mkview | |
| 1318 au BufWinEnter *.c silent loadview | |
| 1319 | |
| 1320 ============================================================================== | |
| 1321 9. The viminfo file *viminfo* *viminfo-file* *E136* | |
| 1322 *E575* *E576* *E577* | |
| 1323 If you exit Vim and later start it again, you would normally lose a lot of | |
| 1324 information. The viminfo file can be used to remember that information, which | |
| 1325 enables you to continue where you left off. | |
| 1326 | |
| 1327 This is introduced in section |21.3| of the user manual. | |
| 1328 | |
| 1329 The viminfo file is used to store: | |
| 1330 - The command line history. | |
| 1331 - The search string history. | |
| 1332 - The input-line history. | |
| 56 | 1333 - Contents of non-empty registers. |
| 7 | 1334 - Marks for several files. |
| 1335 - File marks, pointing to locations in files. | |
| 1336 - Last search/substitute pattern (for 'n' and '&'). | |
| 1337 - The buffer list. | |
| 1338 - Global variables. | |
| 1339 | |
| 1340 The viminfo file is not supported when the |+viminfo| feature has been | |
| 1341 disabled at compile time. | |
| 1342 | |
| 1343 You could also use a Session file. The difference is that the viminfo file | |
| 1344 does not depend on what you are working on. There normally is only one | |
| 1345 viminfo file. Session files are used to save the state of a specific editing | |
| 1346 Session. You could have several Session files, one for each project you are | |
| 1347 working on. Viminfo and Session files together can be used to effectively | |
| 1348 enter Vim and directly start working in your desired setup. |session-file| | |
| 1349 | |
| 1350 *viminfo-read* | |
| 1351 When Vim is started and the 'viminfo' option is non-empty, the contents of | |
| 1352 the viminfo file are read and the info can be used in the appropriate places. | |
| 1733 | 1353 The |v:oldfiles| variable is filled. The marks are not read in at startup |
| 1354 (but file marks are). See |initialization| for how to set the 'viminfo' | |
| 1355 option upon startup. | |
| 7 | 1356 |
| 1357 *viminfo-write* | |
| 1358 When Vim exits and 'viminfo' is non-empty, the info is stored in the viminfo | |
| 1359 file (it's actually merged with the existing one, if one exists). The | |
| 1360 'viminfo' option is a string containing information about what info should be | |
| 1361 stored, and contains limits on how much should be stored (see 'viminfo'). | |
| 1362 | |
| 1363 Notes for Unix: | |
| 1364 - The file protection for the viminfo file will be set to prevent other users | |
| 1365 from being able to read it, because it may contain any text or commands that | |
| 1366 you have worked with. | |
| 1367 - If you want to share the viminfo file with other users (e.g. when you "su" | |
| 1368 to another user), you can make the file writable for the group or everybody. | |
| 1369 Vim will preserve this when writing new viminfo files. Be careful, don't | |
| 1370 allow just anybody to read and write your viminfo file! | |
| 1371 - Vim will not overwrite a viminfo file that is not writable by the current | |
| 1372 "real" user. This helps for when you did "su" to become root, but your | |
| 1373 $HOME is still set to a normal user's home directory. Otherwise Vim would | |
| 1374 create a viminfo file owned by root that nobody else can read. | |
| 1270 | 1375 - The viminfo file cannot be a symbolic link. This is to avoid security |
| 1376 issues. | |
| 7 | 1377 |
| 1378 Marks are stored for each file separately. When a file is read and 'viminfo' | |
| 1379 is non-empty, the marks for that file are read from the viminfo file. NOTE: | |
| 1380 The marks are only written when exiting Vim, which is fine because marks are | |
| 1381 remembered for all the files you have opened in the current editing session, | |
| 1382 unless ":bdel" is used. If you want to save the marks for a file that you are | |
| 1383 about to abandon with ":bdel", use ":wv". The '[' and ']' marks are not | |
| 1384 stored, but the '"' mark is. The '"' mark is very useful for jumping to the | |
| 1385 cursor position when the file was last exited. No marks are saved for files | |
| 1386 that start with any string given with the "r" flag in 'viminfo'. This can be | |
| 1387 used to avoid saving marks for files on removable media (for MS-DOS you would | |
| 1388 use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:"). | |
| 1733 | 1389 The |v:oldfiles| variable is filled with the file names that the viminfo file |
| 1390 has marks for. | |
| 7 | 1391 |
| 1392 *viminfo-file-marks* | |
| 1393 Uppercase marks ('A to 'Z) are stored when writing the viminfo file. The | |
| 1394 numbered marks ('0 to '9) are a bit special. When the viminfo file is written | |
| 1395 (when exiting or with the ":wviminfo" command), '0 is set to the current cursor | |
| 1396 position and file. The old '0 is moved to '1, '1 to '2, etc. This | |
| 1397 resembles what happens with the "1 to "9 delete registers. If the current | |
| 1398 cursor position is already present in '0 to '9, it is moved to '0, to avoid | |
| 1399 having the same position twice. The result is that with "'0", you can jump | |
| 1400 back to the file and line where you exited Vim. To do that right away, try | |
| 1401 using this command: > | |
| 1402 | |
| 1403 vim -c "normal '0" | |
| 1404 | |
| 1623 | 1405 In a csh compatible shell you could make an alias for it: > |
| 7 | 1406 |
| 1407 alias lvim vim -c '"'normal "'"0'"' | |
| 1408 | |
| 1623 | 1409 For a bash-like shell: > |
| 1410 | |
| 1411 alias lvim='vim -c "normal '\''0"' | |
| 1412 | |
| 7 | 1413 Use the "r" flag in 'viminfo' to specify for which files no marks should be |
| 1414 remembered. | |
| 1415 | |
| 1416 | |
| 1417 VIMINFO FILE NAME *viminfo-file-name* | |
| 1418 | |
| 1419 - The default name of the viminfo file is "$HOME/.viminfo" for Unix and OS/2, | |
| 1420 "s:.viminfo" for Amiga, "$HOME\_viminfo" for MS-DOS and Win32. For the last | |
| 1421 two, when $HOME is not set, "$VIM\_viminfo" is used. When $VIM is also not | |
| 1422 set, "c:\_viminfo" is used. For OS/2 "$VIM/.viminfo" is used when $HOME is | |
| 1423 not set and $VIM is set. | |
| 1424 - The 'n' flag in the 'viminfo' option can be used to specify another viminfo | |
| 1425 file name |'viminfo'|. | |
| 1426 - The "-i" Vim argument can be used to set another file name, |-i|. When the | |
| 1427 file name given is "NONE" (all uppercase), no viminfo file is ever read or | |
| 1428 written. Also not for the commands below! | |
| 1429 - For the commands below, another file name can be given, overriding the | |
| 1430 default and the name given with 'viminfo' or "-i" (unless it's NONE). | |
| 1431 | |
| 1432 | |
| 1433 CHARACTER ENCODING *viminfo-encoding* | |
| 1434 | |
| 1435 The text in the viminfo file is encoded as specified with the 'encoding' | |
| 1436 option. Normally you will always work with the same 'encoding' value, and | |
| 1437 this works just fine. However, if you read the viminfo file with another | |
| 1438 value for 'encoding' than what it was written with, some of the text | |
| 1439 (non-ASCII characters) may be invalid. If this is unacceptable, add the 'c' | |
| 1440 flag to the 'viminfo' option: > | |
| 1441 :set viminfo+=c | |
| 1442 Vim will then attempt to convert the text in the viminfo file from the | |
| 1443 'encoding' value it was written with to the current 'encoding' value. This | |
| 1444 requires Vim to be compiled with the |+iconv| feature. Filenames are not | |
| 1445 converted. | |
| 1446 | |
| 1447 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1989
diff
changeset
|
1448 MANUALLY READING AND WRITING *viminfo-read-write* |
| 7 | 1449 |
| 1450 Two commands can be used to read and write the viminfo file manually. This | |
| 1451 can be used to exchange registers between two running Vim programs: First | |
| 1452 type ":wv" in one and then ":rv" in the other. Note that if the register | |
| 1453 already contained something, then ":rv!" would be required. Also note | |
| 1454 however that this means everything will be overwritten with information from | |
| 1455 the first Vim, including the command line history, etc. | |
| 1456 | |
| 1457 The viminfo file itself can be edited by hand too, although we suggest you | |
| 1458 start with an existing one to get the format right. It is reasonably | |
| 1459 self-explanatory once you're in there. This can be useful in order to | |
| 1460 create a second file, say "~/.my_viminfo" which could contain certain | |
| 1461 settings that you always want when you first start Vim. For example, you | |
| 1462 can preload registers with particular data, or put certain commands in the | |
| 1463 command line history. A line in your .vimrc file like > | |
| 1464 :rviminfo! ~/.my_viminfo | |
| 1465 can be used to load this information. You could even have different viminfos | |
| 1466 for different types of files (e.g., C code) and load them based on the file | |
| 1467 name, using the ":autocmd" command (see |:autocmd|). | |
| 1468 | |
| 1469 *viminfo-errors* | |
| 1470 When Vim detects an error while reading a viminfo file, it will not overwrite | |
| 1471 that file. If there are more than 10 errors, Vim stops reading the viminfo | |
| 1472 file. This was done to avoid accidentally destroying a file when the file | |
| 1473 name of the viminfo file is wrong. This could happen when accidentally typing | |
| 1474 "vim -i file" when you wanted "vim -R file" (yes, somebody accidentally did | |
| 1475 that!). If you want to overwrite a viminfo file with an error in it, you will | |
| 1476 either have to fix the error, or delete the file (while Vim is running, so | |
| 1477 most of the information will be restored). | |
| 1478 | |
| 1479 *:rv* *:rviminfo* *E195* | |
| 1480 :rv[iminfo][!] [file] Read from viminfo file [file] (default: see above). | |
| 1481 If [!] is given, then any information that is | |
| 1733 | 1482 already set (registers, marks, |v:oldfiles|, etc.) |
| 1483 will be overwritten {not in Vi} | |
| 7 | 1484 |
| 1485 *:wv* *:wviminfo* *E137* *E138* *E574* | |
| 1486 :wv[iminfo][!] [file] Write to viminfo file [file] (default: see above). | |
| 1487 The information in the file is first read in to make | |
| 1488 a merge between old and new info. When [!] is used, | |
| 1489 the old information is not read first, only the | |
| 1490 internal info is written. If 'viminfo' is empty, marks | |
| 1491 for up to 100 files will be written. | |
| 1492 When you get error "E138: Can't write viminfo file" | |
| 1493 check that no old temp files were left behind (e.g. | |
| 1494 ~/.viminf*) and that you can write in the directory of | |
| 1495 the .viminfo file. | |
| 1496 {not in Vi} | |
| 1497 | |
| 1733 | 1498 *:ol* *:oldfiles* |
| 1499 :ol[dfiles] List the files that have marks stored in the viminfo | |
| 1500 file. This list is read on startup and only changes | |
| 1501 afterwards with ":rviminfo!". Also see |v:oldfiles|. | |
| 1502 The number can be used with |c_#<|. | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
1503 {not in Vi, only when compiled with the |+eval| |
|
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
1504 feature} |
| 1733 | 1505 |
| 1506 :bro[wse] ol[dfiles][!] | |
| 1507 List file names as with |:oldfiles|, and then prompt | |
| 1508 for a number. When the number is valid that file from | |
| 1509 the list is edited. | |
| 1510 If you get the |press-enter| prompt you can press "q" | |
| 1511 and still get the prompt to enter a file number. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1989
diff
changeset
|
1512 Use ! to abandon a modified buffer. |abandon| |
| 1733 | 1513 {not when compiled with tiny or small features} |
| 1514 | |
| 7 | 1515 vim:tw=78:ts=8:ft=help:norl: |