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