blob: 1d56980287328a5cfae41dd19280a95e3594a79c [file] [log] [blame]
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001*starting.txt* For Vim version 7.0aa. Last change: 2005 May 31
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Starting Vim *starting*
8
91. Vim arguments |vim-arguments|
102. Vim on the Amiga |starting-amiga|
113. Running eVim |evim-keys|
124. Initialization |initialization|
135. $VIM and $VIMRUNTIME |$VIM|
146. Suspending |suspend|
157. Saving settings |save-settings|
168. Views and Sessions |views-sessions|
179. The viminfo file |viminfo-file|
18
19==============================================================================
201. Vim arguments *vim-arguments*
21
22Most often, Vim is started to edit a single file with the command
23
24 vim filename *-vim*
25
26More generally, Vim is started with:
27
28 vim [option | filename] ..
29
30Option arguments and file name arguments can be mixed, and any number of them
31can be given. However, watch out for options that take an argument.
32
33For compatibility with various Vi versions, see |cmdline-arguments|.
34
35Exactly one out of the following five items may be used to choose how to
36start editing:
37
38 *-file* *---*
39filename 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
91The startup mode can be changed by using another name instead of "vim", which
92is equal to giving options:
93ex vim -e Start in Ex mode (see |Ex-mode|). *ex*
94exim vim -E Start in improved Ex mode (see |Ex-mode|). *exim*
95 (normally not installed)
96view vim -R Start in read-only mode (see |-R|). *view*
97gvim vim -g Start the GUI (see |gui|). *gvim*
98gex vim -eg Start the GUI in Ex mode. *gex*
99gview vim -Rg Start the GUI in read-only mode. *gview*
100rvim vim -Z Like "vim", but in restricted mode (see |-Z|) *rvim*
101rview vim -RZ Like "view", but in restricted mode. *rview*
102rgvim vim -gZ Like "gvim", but in restricted mode. *rgvim*
103rgview vim -RgZ Like "gview", but in restricted mode. *rgview*
104evim vim -y Easy Vim: set 'insertmode' (see |-y|) *evim*
105eview vim -yR Like "evim" in read-only mode *eview*
106vimdiff vim -d Start in diff mode |diff-mode|
107gvimdiff vim -gd Start in diff mode |diff-mode|
108
109Additional 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
111course.
112
113On Unix, you would normally have one executable called Vim, and links from the
114different startup-names to that executable. If your system does not support
115links and you do not want to have several copies of the executable, you could
116use an alias instead. For example: >
117 alias view vim -R
118 alias gvim vim -g
119<
120 *startup-options*
121The option arguments may be given in any order. Single-letter options can be
122combined after one dash. There can be no option arguments after the "--"
123argument.
124
125On VMS all option arguments are assumed to be lowercase, unless preceded with
126a 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
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.
153
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.
158
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).
163
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}
179
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}
185
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}
194
195-S Works like "-S Session.vim". Only when used as the last
196 argument or when another "-" option follows.
197
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|.
203
204 *-L*
205-L Same as -r. {only in some versions of Vi: "List recoverable
206 edit sessions"}
207
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.
220
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}
226
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}
234
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}
241
242 *-g*
243-g Start Vim in GUI mode. See |gui|. {not in Vi}
244
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.
249
250 *-e*
251-e Start Vim in Ex mode |Q|. Only makes a difference when the
252 executable is not called "ex".
253
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}
258
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.
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000266 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.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000274 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
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000284 lines. The 'expandtab' option will be reset. The 'textwidth'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000285 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}
289
290 *-l*
291-l Lisp mode. Sets the 'lisp' and 'showmatch' options on.
292
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
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000297 and exits.) {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000298
299 *-F*
300-F Farsi mode. Sets the 'fkmap' and 'rightleft' options on.
301 (Only when compiled with |+rightleft| and |+farsi| features,
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000302 otherwise Vim gives an error message and exits.) {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000303
304 *-H*
305-H Hebrew mode. Sets the 'hkmap' and 'rightleft' options on.
306 (Only when compiled with the |+rightleft| feature, otherwise
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000307 Vim gives an error message and exits.) {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000308
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
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000315-V[N]{filename}
316 Like -V and set 'verbosefile' to {filename}. The result is
317 that messages are not displayed but written to the file
318 {filename}. {filename} must not start with a digit.
319
Bram Moolenaar071d4272004-06-13 20:20:40 +0000320 *-D*
321-D Debugging. Go to debugging mode when executing the first
322 command from a script. |debug-mode|
323 {not available when compiled without the |+eval| feature}
324 {not in Vi}
325
326 *-C*
327-C Compatible mode. Sets the 'compatible' option. You can use
328 this to get 'compatible', even though a .vimrc file exists.
329 But the command ":set nocompatible" overrules it anyway.
330 Also see |compatible-default|. {not in Vi}
331
332 *-N*
333-N Not compatible mode. Resets the 'compatible' option. You can
334 use this to get 'nocompatible', when there is no .vimrc file.
335 Also see |compatible-default|. {not in Vi}
336
337 *-y* *easy*
338-y Easy mode. Implied for |evim| and |eview|. Starts with
339 'insertmode' set and behaves like a click-and-type editor.
340 This sources the script $VIMRUNTIME/evim.vim. Mappings are
341 set up to work like most click-and-type editors, see
342 |evim-keys|. The GUI is started when available.
343 {not in Vi}
344
345 *-n*
346-n No swap file will be used. Recovery after a crash will be
347 impossible. Handy if you want to view or edit a file on a
348 very slow medium (e.g., a floppy).
349 Can also be done with ":set updatecount=0". You can switch it
350 on again by setting the 'updatecount' option to some value,
351 e.g., ":set uc=100".
352 'updatecount' is set to 0 AFTER executing commands from a
353 vimrc file, but before the GUI initializations. Thus it
354 overrides a setting for 'updatecount' in a vimrc file, but not
355 in a gvimrc file. See |startup|.
356 When you want to reduce accesses to the disk (e.g., for a
357 laptop), don't use "-n", but set 'updatetime' and
358 'updatecount' to very big numbers, and type ":preserve" when
359 you want to save your work. This way you keep the possibility
360 for crash recovery.
361 {not in Vi}
362
363 *-o*
364-o[N] Open N windows, split horizontally. If [N] is not given,
365 one window is opened for every file given as argument. If
366 there is not enough room, only the first few files get a
367 window. If there are more windows than arguments, the last
368 few windows will be editing an empty file.
369 {not in Vi}
370
371 *-O*
372-O[N] Open N windows, split vertically. Otherwise it's like -o.
373 If both the -o and the -O option are given, the last one on
374 the command line determines how the windows will be split.
375 {not in Vi}
376
377 *-T*
378-T {terminal} Set the terminal type to "terminal". This influences the
379 codes that Vim will send to your terminal. This is normally
380 not needed, because Vim will be able to find out what type
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000381 of terminal you are using. (See |terminal-info|.) {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000382
383 *-d*
384-d Start in diff mode, like |vimdiff|.
385 {not in Vi} {not available when compiled without the |+diff|
386 feature}
387
388-d {device} Only on the Amiga and when not compiled with the |+diff|
389 feature. Works like "-dev".
390 *-dev*
391-dev {device} Only on the Amiga: The {device} is opened to be used for
392 editing.
393 Normally you would use this to set the window position and
394 size: "-d con:x/y/width/height", e.g.,
395 "-d con:30/10/600/150". But you can also use it to start
396 editing on another device, e.g., AUX:. {not in Vi}
397 *-f*
398-f Amiga: Do not restart Vim to open a new window. This
399 option should be used when Vim is started by a program that
400 will wait for the edit session to finish (e.g., mail or
401 readnews). See |amiga-window|.
402
403 GUI: Do not disconnect from the program that started Vim.
404 'f' stands for "foreground". If omitted, the GUI forks a new
405 process and exits the current one. "-f" should be used when
406 gvim is started by a program that will wait for the edit
407 session to finish (e.g., mail or readnews). If you want gvim
408 never to fork, include 'f' in 'guioptions' in your .gvimrc.
409 Careful: You can use "-gf" to start the GUI in the foreground,
410 but "-fg" is used to specify the foreground color. |gui-fork|
411 {not in Vi}
412
413 *--nofork*
414--nofork GUI: Do not fork. Same as |-f|.
415 *-u* *E282*
416-u {vimrc} The file {vimrc} is read for initializations. Most other
417 initializations are skipped; see |initialization|. This can
418 be used to start Vim in a special mode, with special
419 mappings and settings. A shell alias can be used to make
420 this easy to use. For example: >
421 alias vimc vim -u ~/.c_vimrc !*
422< Also consider using autocommands; see |autocommand|.
423 When {vimrc} is equal to "NONE" (all uppercase), all
424 initializations from files and environment variables are
425 skipped, including reading the .gvimrc file when the GUI
426 starts. Loading plugins is also skipped.
427 When {vimrc} is equal to "NORC" (all uppercase), this has the
428 same effect as "NONE", but loading plugins is not skipped.
429 Using the "-u" argument has the side effect that the
430 'compatible' option will be on by default. This can have
431 unexpected effects. See |'compatible'|.
432 {not in Vi}
433
434 *-U* *E230*
435-U {gvimrc} The file "gvimrc" is read for initializations when the GUI
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000436 starts. Other GUI initializations are skipped. When {gvimrc}
Bram Moolenaar8fc061c2004-12-29 21:03:02 +0000437 is equal to "NONE", no file is read for GUI initializations at
438 all. |gui-init|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000439 Exception: Reading the system-wide menu file is always done.
440 {not in Vi}
441
442 *-i*
443-i {viminfo} The file "viminfo" is used instead of the default viminfo
444 file. If the name "NONE" is used (all uppercase), no viminfo
445 file is read or written, even if 'viminfo' is set or when
446 ":rv" or ":wv" are used. See also |viminfo-file|.
447 {not in Vi}
448
449 *-x*
450-x Use encryption to read/write files. Will prompt for a key,
451 which is then stored in the 'key' option. All writes will
452 then use this key to encrypt the text. The '-x' argument is
453 not needed when reading a file, because there is a check if
454 the file that is being read has been encrypted, and Vim asks
455 for a key automatically. |encryption|
456
457 *-X*
458-X Do not try connecting to the X server to get the current
459 window title and copy/paste using the X clipboard. This
460 avoids a long startup time when running Vim in a terminal
461 emulator and the connection to the X server is slow.
462 Only makes a difference on Unix or VMS, when compiled with the
463 |+X11| feature. Otherwise it's ignored.
464 To disable the connection only for specific terminals, see the
465 'clipboard' option.
466 When the X11 Session Management Protocol (XSMP) handler has
467 been built in, the -X option also disables that connection as
468 it, too, may have undesirable delays.
469 When the connection is desired later anyway (e.g., for
470 client-server messages), call the |serverlist()| function.
471 This does not enable the XSMP handler though.
472 {not in Vi}
473
474 *-s*
475-s {scriptin} The script file "scriptin" is read. The characters in the
476 file are interpreted as if you had typed them. The same can
477 be done with the command ":source! {scriptin}". If the end
478 of the file is reached before the editor exits, further
479 characters are read from the keyboard. Only works when not
480 started in Ex mode, see |-s-ex|. See also |complex-repeat|.
481 {not in Vi}
482
Bram Moolenaar4399ef42005-02-12 14:29:27 +0000483 *-w_nr*
484-w {number}
485-w{number} Set the 'window' option to {number}.
486
Bram Moolenaar071d4272004-06-13 20:20:40 +0000487 *-w*
488-w {scriptout} All the characters that you type are recorded in the file
489 "scriptout", until you exit Vim. This is useful if you want
490 to create a script file to be used with "vim -s" or
491 ":source!". When the "scriptout" file already exists, new
492 characters are appended. See also |complex-repeat|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +0000493 {scriptout} cannot start with a digit.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000494 {not in Vi}
495
496 *-W*
497-W {scriptout} Like -w, but do not append, overwrite an existing file.
498 {not in Vi}
499
Bram Moolenaar071d4272004-06-13 20:20:40 +0000500--remote [+{cmd}] {file} ...
501 Open the {file} in another Vim that functions as a server.
502 Any non-file arguments must come before this.
503 See |--remote|. {not in Vi}
504
505--remote-silent [+{cmd}] {file} ...
506 Like --remote, but don't complain if there is no server.
507 See |--remote-silent|. {not in Vi}
508
509--remote-wait [+{cmd}] {file} ...
510 Like --remote, but wait for the server to finish editing the
511 file(s).
512 See |--remote-wait|. {not in Vi}
513
514--remote-wait-silent [+{cmd}] {file} ...
515 Like --remote-wait, but don't complain if there is no server.
516 See |--remote-wait-silent|. {not in Vi}
517
518--servername {name}
519 Specify the name of the Vim server to send to or to become.
520 See |--servername|. {not in Vi}
521
522--remote-send {keys}
523 Send {keys} to a Vim server and exit.
524 See |--remote-send|. {not in Vi}
525
526--remote-expr {expr}
527 Evaluate {expr} in another Vim that functions as a server.
528 The result is printed on stdout.
529 See |--remote-expr|. {not in Vi}
530
531--serverlist Output a list of Vim server names and exit. See
532 See |--serverlist|. {not in Vi}
533
534--socketid {id} *--socketid*
535 GTK+ GUI Vim only. Make gvim try to use GtkPlug mechanism, so
536 that it runs inside another window. See |gui-gtk-socketid|
537 for details. {not in Vi}
538
539--echo-wid *--echo-wid*
540 GTK+ GUI Vim only. Make gvim echo the Window ID on stdout,
541 which can be used to run gvim in a kpart widget. The format
542 of the output is: >
543 WID: 12345\n
544< {not in Vi}
545
546--role {role} *--role*
547 GTK+ 2 GUI only. Set the role of the main window to {role}.
548 The window role can be used by a window manager to uniquely
549 identify a window, in order to restore window placement and
550 such. The --role argument is passed automatically when
551 restoring the session on login. See |gui-gnome-session|
552 {not in Vi}
553
554-P {parent-title} *-P* *MDI* *E671* *E672*
555 Win32 only: Specify the title of the parent application. When
556 possible, Vim will run in an MDI window inside the
557 application.
558 {parent-title} must appear in the window title of the parent
559 application. Make sure that it is specific enough.
560 Note that the implementation is still primitive. It won't
561 work with all applications and the menu doesn't work.
562
563-nb *-nb*
564-nb={fname}
565-nb:{hostname}:{addr}:{password}
566 Attempt connecting to Netbeans and become an editor server for
567 it. The second form specifies a file to read connection info
568 from. The third form specifies the hostname, address and
569 password for connecting to Netbeans. |netbeans-run|
570
571Example for using a script file to change a name in several files:
572 Create a file "subs.vi" containing substitute commands and a :wq
573 command: >
574 :%s/Jones/Smith/g
575 :%s/Allen/Peter/g
576 :wq
577<
578 Execute Vim on all files you want to change: >
579
580 foreach i ( *.let ) vim -s subs.vi $i
581
582If the executable is called "view", Vim will start in Readonly mode. This is
583useful if you can make a hard or symbolic link from "view" to "vim".
584Starting in Readonly mode can also be done with "vim -R".
585
586If the executable is called "ex", Vim will start in "Ex" mode. This means it
587will accept only ":" commands. But when the "-v" argument is given, Vim will
588start in Normal mode anyway.
589
590Additional arguments are available on unix like systems when compiled with
591X11 GUI support. See |gui-resources|.
592
593==============================================================================
5942. Vim on the Amiga *starting-amiga*
595
596Starting Vim from the Workbench *workbench*
597-------------------------------
598
599Vim can be started from the Workbench by clicking on its icon twice. It will
600then start with an empty buffer.
601
602Vim can be started to edit one or more files by using a "Project" icon. The
603"Default Tool" of the icon must be the full pathname of the Vim executable.
604The name of the ".info" file must be the same as the name of the text file.
605By clicking on this icon twice, Vim will be started with the file name as
606current file name, which will be read into the buffer (if it exists). You can
607edit multiple files by pressing the shift key while clicking on icons, and
608clicking twice on the last one. The "Default Tool" for all these icons must
609be the same.
610
611It is not possible to give arguments to Vim, other than file names, from the
612workbench.
613
614Vim window *amiga-window*
615----------
616
617Vim will run in the CLI window where it was started. If Vim was started with
618the "run" or "runback" command, or if Vim was started from the workbench, it
619will open a window of its own.
620
621Technical detail:
622 To open the new window a little trick is used. As soon as Vim
623 recognizes that it does not run in a normal CLI window, it will
624 create a script file in "t:". This script file contains the same
625 command as the one Vim was started with, and an "endcli" command.
626 This script file is then executed with a "newcli" command (the "c:run"
627 and "c:newcli" commands are required for this to work). The script
628 file will hang around until reboot, or until you delete it. This
629 method is required to get the ":sh" and ":!" commands to work
630 correctly. But when Vim was started with the -f option (foreground
631 mode), this method is not used. The reason for this is that
632 when a program starts Vim with the -f option it will wait for Vim to
633 exit. With the script trick, the calling program does not know when
634 Vim exits. The -f option can be used when Vim is started by a mail
635 program which also waits for the edit session to finish. As a
636 consequence, the ":sh" and ":!" commands are not available when the
637 -f option is used.
638
639Vim will automatically recognize the window size and react to window
640resizing. Under Amiga DOS 1.3, it is advised to use the fastfonts program,
641"FF", to speed up display redrawing.
642
643==============================================================================
6443. Running eVim *evim-keys*
645
646EVim runs Vim as click-and-type editor. This is very unlike the original Vi
647idea. But it helps for people that don't use Vim often enough to learn the
648commands. Hopefully they will find out that learning to use Normal mode
649commands will make their editing much more effective.
650
651In Evim these options are changed from their default value:
652
653 :set nocompatible Use Vim improvements
654 :set insertmode Remain in Insert mode most of the time
655 :set hidden Keep invisible buffers loaded
656 :set backup Keep backup files (not for VMS)
657 :set backspace=2 Backspace over everything
658 :set autoindent auto-indent new lines
659 :set history=50 keep 50 lines of Ex commands
660 :set ruler show the cursor position
661 :set incsearch show matches halfway typing a pattern
662 :set mouse=a use the mouse in all modes
663 :set hlsearch highlight all matches for a search pattern
664 :set whichwrap+=<,>,[,] <Left> and <Right> wrap around line breaks
665 :set guioptions-=a non-Unix only: don't do auto-select
666
667Key mappings:
668 <Down> moves by screen lines rather than file lines
669 <Up> idem
670 Q does "gq", formatting, instead of Ex mode
671 <BS> in Visual mode: deletes the selection
672 CTRL-X in Visual mode: Cut to clipboard
673 <S-Del> idem
674 CTRL-C in Visual mode: Copy to clipboard
675 <C-Insert> idem
676 CTRL-V Pastes from the clipboard (in any mode)
677 <S-Insert> idem
678 CTRL-Q do what CTRL-V used to do
679 CTRL-Z undo
680 CTRL-Y redo
681 <M-Space> system menu
682 CTRL-A select all
683 <C-Tab> next window, CTRL-W w
684 <C-F4> close window, CTRL-W c
685
686Additionally:
687- ":behave mswin" is used |:behave|
688- syntax highlighting is enabled
689- filetype detection is enabled, filetype plugins and indenting is enabled
690- in a text file 'textwidth' is set to 78
691
692One hint: If you want to go to Normal mode to be able to type a sequence of
693commands, use CTRL-L. |i_CTRL-L|
694
695==============================================================================
6964. Initialization *initialization* *startup*
697
698This section is about the non-GUI version of Vim. See |gui-fork| for
699additional initialization when starting the GUI.
700
701At startup, Vim checks environment variables and files and sets values
702accordingly. Vim proceeds in this order:
703
7041. Set the 'shell' and 'term' option *SHELL* *COMSPEC* *TERM*
705 The environment variable SHELL, if it exists, is used to set the
706 'shell' option. On MS-DOS and Win32, the COMSPEC variable is used
707 if SHELL is not set.
708 The environment variable TERM, if it exists, is used to set the 'term'
709 option.
710
7112. Process the arguments
712 The options and file names from the command that start Vim are
713 inspected. Buffers are created for all files (but not loaded yet).
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000714 The |-V| argument can be used to display or log what happens next,
715 useful for debugging the initializations.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000716
7173. Execute Ex commands, from environment variables and/or files
718 An environment variable is read as one Ex command line, where multiple
719 commands must be separated with '|' or "<NL>".
720 *vimrc* *exrc*
721 A file that contains initialization commands is called a "vimrc" file.
722 Each line in a vimrc file is executed as an Ex command line. It is
723 sometimes also referred to as "exrc" file. They are the same type of
724 file, but "exrc" is what Vi always used, "vimrc" is a Vim specific
725 name. Also see |vimrc-intro|.
726
727 Recommended place for your personal initializations:
728 Unix $HOME/.vimrc
729 OS/2 $HOME/.vimrc or $VIM/.vimrc (or _vimrc)
730 MS-DOS and Win32 $HOME/_vimrc or $VIM/_vimrc
731 Amiga s:.vimrc or $VIM/.vimrc
732
733 If Vim was started with "-u filename", the file "filename" is used.
734 All following initializations until 4. are skipped.
735 "vim -u NORC" can be used to skip these initializations without
736 reading a file. "vim -u NONE" also skips loading plugins. |-u|
737
738 If Vim was started in Ex mode with the "-s" argument, all following
739 initializations until 4. are skipped. Only the "-u" option is
740 interpreted.
741 *evim.vim*
742 a. If vim was started as |evim| or |eview| or with the |-y| argument, the
743 script $VIMRUNTIME/evim.vim will be loaded.
744 *system-vimrc*
745 b. For Unix, MS-DOS, MS-Windows, OS/2, VMS, Macintosh, RISC-OS and Amiga
746 the system vimrc file is read for initializations. The path of this
747 file is shown with the ":version" command. Mostly it's "$VIM/vimrc".
748 Note that this file is ALWAYS read in 'compatible' mode, since the
749 automatic resetting of 'compatible' is only done later. Add a ":set
750 nocp" command if you like.
751
752 *VIMINIT* *.vimrc* *_vimrc* *EXINIT* *.exrc* *_exrc*
753 c. Four places are searched for initializations. The first that exists
754 is used, the others are ignored.
755 - The environment variable VIMINIT (see also |compatible-default|) (*)
756 The value of $VIMINIT is used as an Ex command line.
757 - The user vimrc file(s):
758 "$HOME/.vimrc" (for Unix and OS/2) (*)
759 "s:.vimrc" (for Amiga) (*)
760 "home:.vimrc" (for Amiga) (*)
761 "$VIM/.vimrc" (for OS/2 and Amiga) (*)
762 "$HOME/_vimrc" (for MS-DOS and Win32) (*)
Bram Moolenaar21cf8232004-07-16 20:18:37 +0000763 "$VIM/_vimrc" (for MS-DOS and Win32) (*)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000764 Note: For Unix, OS/2 and Amiga, when ".vimrc" does not exist,
765 "_vimrc" is also tried, in case an MS-DOS compatible file
766 system is used. For MS-DOS and Win32 ".vimrc" is checked
767 after "_vimrc", in case long file names are used.
768 Note: For MS-DOS and Win32, "$HOME" is checked first. If no
769 "_vimrc" or ".vimrc" is found there, "$VIM" is tried.
770 See |$VIM| for when $VIM is not set.
771 - The environment variable EXINIT.
772 The value of $EXINIT is used as an Ex command line.
773 - The user exrc file(s). Same as for the user vimrc file, but with
Bram Moolenaar5c5474b2005-04-19 21:40:26 +0000774 "vimrc" replaced by "exrc". But only one of ".exrc" and "_exrc" is
775 used, depending on the system. And without the (*)!
Bram Moolenaar071d4272004-06-13 20:20:40 +0000776
777 d. If the 'exrc' option is on (which is not the default), the current
Bram Moolenaar5c5474b2005-04-19 21:40:26 +0000778 directory is searched for three files. The first that exists is used,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000779 the others are ignored.
780 - The file ".vimrc" (for Unix, Amiga and OS/2) (*)
781 "_vimrc" (for MS-DOS and Win32) (*)
782 - The file "_vimrc" (for Unix, Amiga and OS/2) (*)
783 ".vimrc" (for MS-DOS and Win32) (*)
784 - The file ".exrc" (for Unix, Amiga and OS/2)
785 "_exrc" (for MS-DOS and Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000786
787 (*) Using this file or environment variable will cause 'compatible' to be
788 off by default. See |compatible-default|.
789
7904. Load the plugin scripts. *load-plugins*
791 This does the same as the command: >
792 :runtime! plugin/*.vim
793< The result is that all directories in the 'runtimepath' option will be
794 searched for the "plugin" sub-directory and all files ending in ".vim"
795 will be sourced (in alphabetical order per directory).
796 Loading plugins won't be done when:
797 - The 'loadplugins' option was reset in a vimrc file.
798 - The |--noplugin| command line argument is used.
799 - The "-u NONE" command line argument is used |-u|.
800 - When Vim was compiled without the |+eval| feature.
801 Note that using "-c set noloadplugins" doesn't work, because the
802 commands from the command line have not been executed yet.
803
8045. Set 'shellpipe' and 'shellredir'
805 The 'shellpipe' and 'shellredir' options are set according to the
806 value of the 'shell' option, unless they have been set before.
807 This means that Vim will figure out the values of 'shellpipe' and
808 'shellredir' for you, unless you have set them yourself.
809
8106. Set 'updatecount' to zero, if "-n" command argument used
811
8127. Set binary options
813 If the "-b" flag was given to Vim, the options for binary editing will
814 be set now. See |-b|.
815
8168. Perform GUI initializations
817 Only when starting "gvim", the GUI initializations will be done. See
818 |gui-init|.
819
8209. Read the viminfo file
821 If the 'viminfo' option is not empty, the viminfo file is read. See
822 |viminfo-file|.
823
82410. Read the quickfix file
825 If the "-q" flag was given to Vim, the quickfix file is read. If this
826 fails, Vim exits.
827
82811. Open all windows
829 When the |-o| flag was given, windows will be opened (but not
830 displayed yet).
831 When switching screens, it happens now. Redrawing starts.
832 If the "-q" flag was given to Vim, the first error is jumped to.
833 Buffers for all windows will be loaded.
834
83512. Execute startup commands
836 If a "-t" flag was given to Vim, the tag is jumped to.
837 The commands given with the |-c| and |+cmd| arguments are executed.
838 If the 'insertmode' option is set, Insert mode is entered.
839 The |VimEnter| autocommands are executed.
840
841Some hints on using initializations:
842
843Standard setup:
844Create a vimrc file to set the default settings and mappings for all your edit
845sessions. Put it in a place so that it will be found by 3b:
846 ~/.vimrc (Unix and OS/2)
847 s:.vimrc (Amiga)
848 $VIM\_vimrc (MS-DOS and Win32)
849Note that creating a vimrc file will cause the 'compatible' option to be off
850by default. See |compatible-default|.
851
852Local setup:
853Put all commands that you need for editing a specific directory only into a
854vimrc file and place it in that directory under the name ".vimrc" ("_vimrc"
855for MS-DOS and Win32). NOTE: To make Vim look for these special files you
856have to turn on the option 'exrc'. See |trojan-horse| too.
857
858System setup:
859This only applies if you are managing a Unix system with several users and
860want to set the defaults for all users. Create a vimrc file with commands
861for default settings and mappings and put it in the place that is given with
862the ":version" command.
863
864Saving the current state of Vim to a file:
865Whenever you have changed values of options or when you have created a
866mapping, then you may want to save them in a vimrc file for later use. See
867|save-settings| about saving the current state of settings to a file.
868
869Avoiding setup problems for Vi users:
870Vi uses the variable EXINIT and the file "~/.exrc". So if you do not want to
871interfere with Vi, then use the variable VIMINIT and the file "vimrc" instead.
872
873Amiga environment variables:
874On the Amiga, two types of environment variables exist. The ones set with the
875DOS 1.3 (or later) setenv command are recognized. See the AmigaDos 1.3
876manual. The environment variables set with the old Manx Set command (before
877version 5.0) are not recognized.
878
879MS-DOS line separators:
880On MS-DOS-like systems (MS-DOS itself, Win32, and OS/2), Vim assumes that all
881the vimrc files have <CR> <NL> pairs as line separators. This will give
882problems if you have a file with only <NL>s and have a line like
883":map xx yy^M". The trailing ^M will be ignored.
884
885 *compatible-default*
886When Vim starts, the 'compatible' option is on. This will be used when Vim
887starts its initializations. But as soon as a user vimrc file is found, or a
888vimrc file in the current directory, or the "VIMINIT" environment variable is
889set, it will be set to 'nocompatible'. This has the side effect of setting or
890resetting other options (see 'compatible'). But only the options that have
891not been set or reset will be changed. This has the same effect like the
892value of 'compatible' had this value when starting Vim. Note that this
893doesn't happen for the system-wide vimrc file.
894
895But there is a side effect of setting or resetting 'compatible' at the moment
896a .vimrc file is found: Mappings are interpreted the moment they are
897encountered. This makes a difference when using things like "<CR>". If the
898mappings depend on a certain value of 'compatible', set or reset it before
899giving the mapping.
900
901The above behavior can be overridden in these ways:
902- If the "-N" command line argument is given, 'nocompatible' will be used,
903 even when no vimrc file exists.
904- If the "-C" command line argument is given, 'compatible' will be used, even
905 when a vimrc file exists.
906- If the "-u {vimrc}" argument is used, 'compatible' will be used.
907- When the name of the executable ends in "ex", then this works like the "-C"
908 argument was given: 'compatible' will be used, even when a vimrc file
909 exists. This has been done to make Vim behave like "ex", when it is started
910 as "ex".
911
912Avoiding trojan horses: *trojan-horse*
913While reading the "vimrc" or the "exrc" file in the current directory, some
914commands can be disabled for security reasons by setting the 'secure' option.
915This is always done when executing the command from a tags file. Otherwise it
916would be possible that you accidentally use a vimrc or tags file that somebody
917else created and contains nasty commands. The disabled commands are the ones
918that start a shell, the ones that write to a file, and ":autocmd". The ":map"
919commands are echoed, so you can see which keys are being mapped.
920 If you want Vim to execute all commands in a local vimrc file, you
921can reset the 'secure' option in the EXINIT or VIMINIT environment variable or
922in the global "exrc" or "vimrc" file. This is not possible in "vimrc" or
923"exrc" in the current directory, for obvious reasons.
924 On Unix systems, this only happens if you are not the owner of the
925vimrc file. Warning: If you unpack an archive that contains a vimrc or exrc
926file, it will be owned by you. You won't have the security protection. Check
927the vimrc file before you start Vim in that directory, or reset the 'exrc'
928option. Some Unix systems allow a user to do "chown" on a file. This makes
929it possible for another user to create a nasty vimrc and make you the owner.
930Be careful!
931 When using tag search commands, executing the search command (the last
932part of the line in the tags file) is always done in secure mode. This works
933just like executing a command from a vimrc/exrc in the current directory.
934
935 *slow-start*
936If Vim takes a long time to start up, there may be a few causes:
937- If the Unix version was compiled with the GUI and/or X11 (check the output
938 of ":version" for "+GUI" and "+X11"), it may need to load shared libraries
939 and connect to the X11 server. Try compiling a version with GUI and X11
940 disabled. This also should make the executable smaller.
941 Use the |-X| command line argument to avoid connecting to the X server when
942 running in a terminal.
943- If you have "viminfo" enabled, the loading of the viminfo file may take a
944 while. You can find out if this is the problem by disabling viminfo for a
945 moment (use the Vim argument "-i NONE", |-i|). Try reducing the number of
946 lines stored in a register with ":set viminfo='20,<50,s10". |viminfo-file|.
947
948 *:intro*
949When Vim starts without a file name, an introductory message is displayed (for
950those who don't know what Vim is). It is removed as soon as the display is
951redrawn in any way. To see the message again, use the ":intro" command (if
952there is not enough room, you will see only part of it).
953 To avoid the intro message on startup, add the 'I' flag to 'shortmess'.
954
955 *info-message*
956The |--help| and |--version| arguments cause Vim to print a message and then
957exit. Normally the message is send to stdout, thus can be redirected to a
958file with: >
959
960 vim --help >file
961
962From inside Vim: >
963
964 :read !vim --help
965
966When using gvim, it detects that it might have been started from the desktop,
967without a terminal to show messages on. This is detected when both stdout and
968stderr are not a tty. This breaks the ":read" command, as used in the example
969above. To make it work again, set 'shellredir' to ">" instead of the default
970">&": >
971
972 :set shellredir=>
973 :read !gvim --help
974
975This still won't work for systems where gvim does not use stdout at all
976though.
977
978==============================================================================
9795. $VIM and $VIMRUNTIME
980 *$VIM*
981The environment variable "$VIM" is used to locate various user files for Vim,
982such as the user startup script ".vimrc". This depends on the system, see
983|startup|.
984
985To avoid the need for every user to set the $VIM environment variable, Vim
986will try to get the value for $VIM in this order:
9871. The value defined by the $VIM environment variable. You can use this to
988 make Vim look in a specific directory for its support files. Example: >
989 setenv VIM /home/paul/vim
9902. The path from 'helpfile' is used, unless it contains some environment
991 variable too (the default is "$VIMRUNTIME/doc/help.txt": chicken-egg
992 problem). The file name ("help.txt" or any other) is removed. Then
993 trailing directory names are removed, in this order: "doc", "runtime" and
994 "vim{version}" (e.g., "vim54").
9953. For MSDOS, Win32 and OS/2 Vim tries to use the directory name of the
996 executable. If it ends in "/src", this is removed. This is useful if you
997 unpacked the .zip file in some directory, and adjusted the search path to
998 find the vim executable. Trailing directory names are removed, in this
999 order: "runtime" and "vim{version}" (e.g., "vim54").
10004. For Unix the compile-time defined installation directory is used (see the
1001 output of ":version").
1002
1003Once Vim has done this once, it will set the $VIM environment variable. To
1004change it later, use a ":let" command like this: >
1005 :let $VIM = "/home/paul/vim/"
1006<
1007 *$VIMRUNTIME*
1008The environment variable "$VIMRUNTIME" is used to locate various support
1009files, such as the on-line documentation and files used for syntax
1010highlighting. For example, the main help file is normally
1011"$VIMRUNTIME/doc/help.txt".
1012You don't normally set $VIMRUNTIME yourself, but let Vim figure it out. This
1013is the order used to find the value of $VIMRUNTIME:
10141. If the environment variable $VIMRUNTIME is set, it is used. You can use
1015 this when the runtime files are in an unusual location.
10162. If "$VIM/vim{version}" exists, it is used. {version} is the version
1017 number of Vim, without any '-' or '.'. For example: "$VIM/vim54". This is
1018 the normal value for $VIMRUNTIME.
10193. If "$VIM/runtime" exists, it is used.
10204. The value of $VIM is used. This is for backwards compatibility with older
1021 versions.
10225. When the 'helpfile' option is set and doesn't contain a '$', its value is
1023 used, with "doc/help.txt" removed from the end.
1024
1025For Unix, when there is a compiled-in default for $VIMRUNTIME (check the
1026output of ":version"), steps 2, 3 and 4 are skipped, and the compiled-in
1027default is used after step 5. This means that the compiled-in default
1028overrules the value of $VIM. This is useful if $VIM is "/etc" and the runtime
1029files are in "/usr/share/vim/vim54".
1030
1031Once Vim has done this once, it will set the $VIMRUNTIME environment variable.
1032To change it later, use a ":let" command like this: >
1033 :let $VIMRUNTIME = "/home/piet/vim/vim54"
1034
Bram Moolenaared203462004-06-16 11:19:22 +00001035In case you need the value of $VIMRUNTIME in a shell (e.g., for a script that
1036greps in the help files) you might be able to use this: >
1037
1038 VIMRUNTIME=`vim -e -T dumb --cmd 'exe "set t_cm=\<C-M>"|echo $VIMRUNTIME|quit' | tr -d '\015' `
1039
Bram Moolenaar071d4272004-06-13 20:20:40 +00001040==============================================================================
10416. Suspending *suspend*
1042
1043 *iconize* *iconise* *CTRL-Z* *v_CTRL-Z*
1044CTRL-Z Suspend Vim, like ":stop".
1045 Works in Normal and in Visual mode. In Insert and
1046 Command-line mode, the CTRL-Z is inserted as a normal
1047 character. In Visual mode Vim goes back to Normal
1048 mode.
Bram Moolenaar0d660222005-01-07 21:51:51 +00001049 Note: if CTRL-Z undoes a change see |mswin.vim|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001050
1051
1052:sus[pend][!] or *:sus* *:suspend* *:st* *:stop*
1053:st[op][!] Suspend Vim.
1054 If the '!' is not given and 'autowrite' is set, every
1055 buffer with changes and a file name is written out.
1056 If the '!' is given or 'autowrite' is not set, changed
1057 buffers are not written, don't forget to bring Vim
1058 back to the foreground later!
1059
1060In the GUI, suspending is implemented as iconising gvim. In Windows 95/NT,
1061gvim is minimized.
1062
1063On many Unix systems, it is possible to suspend Vim with CTRL-Z. This is only
1064possible in Normal and Visual mode (see next chapter, |vim-modes|). Vim will
1065continue if you make it the foreground job again. On other systems, CTRL-Z
1066will start a new shell. This is the same as the ":sh" command. Vim will
1067continue if you exit from the shell.
1068
1069In X-windows the selection is disowned when Vim suspends. this means you
1070can't paste it in another application (since Vim is going to sleep an attempt
1071to get the selection would make the program hang).
1072
1073==============================================================================
10747. Saving settings *save-settings*
1075
1076Mostly you will edit your vimrc files manually. This gives you the greatest
1077flexibility. There are a few commands to generate a vimrc file automatically.
1078You can use these files as they are, or copy/paste lines to include in another
1079vimrc file.
1080
1081 *:mk* *:mkexrc*
1082:mk[exrc] [file] Write current key mappings and changed options to
1083 [file] (default ".exrc" in the current directory),
1084 unless it already exists. {not in Vi}
1085
1086:mk[exrc]! [file] Always write current key mappings and changed
1087 options to [file] (default ".exrc" in the current
1088 directory). {not in Vi}
1089
1090 *:mkv* *:mkvimrc*
1091:mkv[imrc][!] [file] Like ":mkexrc", but the default is ".vimrc" in the
1092 current directory. The ":version" command is also
1093 written to the file. {not in Vi}
1094
1095These commands will write ":map" and ":set" commands to a file, in such a way
1096that when these commands are executed, the current key mappings and options
1097will be set to the same values. The options 'columns', 'endofline',
1098'fileformat', 'key', 'lines', 'modified', 'scroll', 'term', 'textmode',
1099'ttyfast' and 'ttymouse' are not included, because these are terminal or file
1100dependent. Note that the options 'binary', 'paste' and 'readonly' are
1101included, this might not always be what you want.
1102
1103When special keys are used in mappings, The 'cpoptions' option will be
1104temporarily set to its Vim default, to avoid the mappings to be
1105misinterpreted. This makes the file incompatible with Vi, but makes sure it
1106can be used with different terminals.
1107
1108Only global mappings are stored, not mappings local to a buffer.
1109
1110A common method is to use a default ".vimrc" file, make some modifications
1111with ":map" and ":set" commands and write the modified file. First read the
1112default ".vimrc" in with a command like ":source ~piet/.vimrc.Cprogs", change
1113the settings and then save them in the current directory with ":mkvimrc!". If
1114you want to make this file your default .vimrc, move it to your home directory
1115(on Unix), s: (Amiga) or $VIM directory (MS-DOS). You could also use
1116autocommands |autocommand| and/or modelines |modeline|.
1117
1118If you only want to add a single option setting to your vimrc, you can use
1119these steps:
11201. Edit your vimrc file with Vim.
11212. Play with the option until it's right. E.g., try out different values for
1122 'guifont'.
11233. Append a line to set the value of the option, using the expression register
1124 '=' to enter the value. E.g., for the 'guifont' option: >
1125 o:set guifont=<C-R>=&guifont<CR><Esc>
1126< [<C-R> is a CTRL-R, <CR> is a return, <Esc> is the escape key]
1127
1128Note that when you create a .vimrc file, this can influence the 'compatible'
1129option, which has several side effects. See |'compatible'|.
1130":mkvimrc", ":mkexrc" and ":mksession" write the command to set or reset the
1131'compatible' option to the output file first, because of these side effects.
1132
1133==============================================================================
11348. Views and Sessions *views-sessions*
1135
1136This is introduced in sections |21.4| and |21.5| of the user manual.
1137
1138 *View* *view-file*
1139A View is a collection of settings that apply to one window. You can save a
1140View and when you restore it later, the text is displayed in the same way.
1141The options and mappings in this window will also be restored, so that you can
1142continue editing like when the View was saved.
1143
1144 *Session* *session-file*
1145A Session keeps the Views for all windows, plus the global settings. You can
1146save a Session and when you restore it later the window layout looks the same.
1147You can use a Session to quickly switch between different projects,
1148automatically loading the files you were last working on in that project.
1149
1150Views and Sessions are a nice addition to viminfo-files, which are used to
1151remember information for all Views and Sessions together |viminfo-file|.
1152
1153You can quickly start editing with a previously saved View or Session with the
1154|-S| argument: >
1155 vim -S Session.vim
1156<
1157All this is {not in Vi} and {not available when compiled without the
1158|+mksession| feature}.
1159
1160 *:mks* *:mksession*
1161:mks[ession][!] [file] Write a Vim script that restores the current editing
1162 session.
1163 When [!] is included an existing file is overwritten.
1164 When [file] is omitted "Session.vim" is used.
1165
1166The output of ":mksession" is like ":mkvimrc", but additional commands are
1167added to the file. Which ones depends on the 'sessionoptions' option. The
1168resulting file, when executed with a ":source" command:
11691. Restores global mappings and options, if 'sessionoptions' contains
1170 "options". Script-local mappings will not be written.
11712. Restores global variables that start with an uppercase letter and contain
1172 at least one lowercase letter, if 'sessionoptions' contains "globals".
11733. Unloads all currently loaded buffers.
11744. Restores the current directory if 'sessionoptions' contains "curdir", or
1175 sets the current directory to where the Session file is if 'sessionoptions'
1176 contains "sesdir".
11775. Restores GUI Vim window position, if 'sessionoptions' contains "winpos".
11786. Restores screen size, if 'sessionoptions' contains "resize".
11797. Reloads the buffer list, with the last cursor positions. If
1180 'sessionoptions' contains "buffers" then all buffers are restored,
1181 including hidden and unloaded buffers. Otherwise only buffers in windows
1182 are restored.
11838. Restores all windows with the same layout. If 'sessionoptions' contains
1184 contains "help", help windows are restored. If 'sessionoptions' contains
1185 "blank", windows editing a buffer without a name will be restored.
1186 If 'sessionoptions' contains "winsize" and no (help/blank) windows were
1187 left out, the window sizes are restored (relative to the screen size).
1188 Otherwise, the windows are just given sensible sizes.
11899. Restores the Views for all the windows, as with |:mkview|. But
1190 'sessionoptions' is used instead of 'viewoptions'.
119110. If a file exists with the same name as the Session file, but ending in
1192 "x.vim" (for eXtra), executes that as well. You can use *x.vim files to
1193 specify additional settings and actions associated with a given Session,
1194 such as creating menu items in the GUI version.
1195
1196After restoring the Session, the full filename of your current Session is
1197available in the internal variable "v:this_session" |this_session-variable|.
1198An example mapping: >
1199 :nmap <F2> :wa<Bar>exe "mksession! " . v:this_session<CR>:so ~/sessions/
1200This saves the current Session, and starts off the command to load another.
1201
1202 *:mkvie* *:mkview*
1203:mkvie[w][!] [file] Write a Vim script that restores the contents of the
1204 current window.
1205 When [!] is included an existing file is overwritten.
1206 When [file] is omitted or is a number from 1 to 9, a
1207 name is generated and 'viewdir' prepended. When last
1208 directory name in 'viewdir' does not exist, this
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001209 directory is created. *E739*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001210 An existing file is always overwritten then. Use
1211 |:loadview| to load this view again.
1212 When [file] is the name of a file ('viewdir' is not
1213 used), a command to edit the file is added to the
1214 generated file.
1215
1216The output of ":mkview" contains these items:
12171. The argument list used in the window. When the global argument list is
1218 used it is reset to the global list.
1219 The index in the argument list is also restored.
12202. The file being edited in the window. If there is no file, the window is
1221 made empty.
12223. Restore mappings, abbreviations and options local to the window if
1223 'viewoptions' contains "options" or "localoptions". For the options it
1224 restores only values that are local to the current buffer and values local
1225 to the window.
1226 When storing the view as part of a session and "options" is in
1227 'sessionoptions', global values for local options will be stored too.
12284. Restore folds when using manual folding and 'viewoptions' contains
1229 "folds". Restore manually opened and closed folds.
12305. The scroll position and the cursor position in the file. Doesn't work very
1231 well when there are closed folds.
12326. The local current directory, if it is different from the global current
1233 directory.
1234
1235Note that Views and Sessions are not perfect:
1236- They don't restore everything. For example, defined functions, autocommands
1237 and ":syntax on" are not included. Things like register contents and
1238 command line history are in viminfo, not in Sessions or Views.
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001239- Global option values are only set when they differ from the default value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001240 When the current value is not the default value, loading a Session will not
1241 set it back to the default value. Local options will be set back to the
1242 default value though.
1243- Existing mappings will be overwritten without warning. An existing mapping
1244 may cause an error for ambiguity.
1245- When storing manual folds and when storing manually opened/closed folds,
1246 changes in the file between saving and loading the view will mess it up.
1247- The Vim script is not very efficient. But still faster than typing the
1248 commands yourself!
1249
1250 *:lo* *:loadview*
1251:lo[adview] [nr] Load the view for the current file. When [nr] is
1252 omitted, the view stored with ":mkview" is loaded.
1253 When [nr] is specified, the view stored with ":mkview
1254 [nr]" is loaded.
1255
1256The combination of ":mkview" and ":loadview" can be used to store up to ten
1257different views of a file. These are remembered in the directory specified
1258with the 'viewdir' option. The views are stored using the file name. If a
1259file is renamed or accessed through a (symbolic) link the view will not be
1260found.
1261
1262You might want to clean up your 'viewdir' directory now and then.
1263
1264To automatically save and restore views for *.c files: >
1265 au BufWinLeave *.c mkview
1266 au BufWinEnter *.c silent loadview
1267
1268==============================================================================
12699. The viminfo file *viminfo* *viminfo-file* *E136*
1270 *E575* *E576* *E577*
1271If you exit Vim and later start it again, you would normally lose a lot of
1272information. The viminfo file can be used to remember that information, which
1273enables you to continue where you left off.
1274
1275This is introduced in section |21.3| of the user manual.
1276
1277The viminfo file is used to store:
1278- The command line history.
1279- The search string history.
1280- The input-line history.
Bram Moolenaar49cd9572005-01-03 21:06:01 +00001281- Contents of non-empty registers.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001282- Marks for several files.
1283- File marks, pointing to locations in files.
1284- Last search/substitute pattern (for 'n' and '&').
1285- The buffer list.
1286- Global variables.
1287
1288The viminfo file is not supported when the |+viminfo| feature has been
1289disabled at compile time.
1290
1291You could also use a Session file. The difference is that the viminfo file
1292does not depend on what you are working on. There normally is only one
1293viminfo file. Session files are used to save the state of a specific editing
1294Session. You could have several Session files, one for each project you are
1295working on. Viminfo and Session files together can be used to effectively
1296enter Vim and directly start working in your desired setup. |session-file|
1297
1298 *viminfo-read*
1299When Vim is started and the 'viminfo' option is non-empty, the contents of
1300the viminfo file are read and the info can be used in the appropriate places.
1301The marks are not read in at startup (but file marks are). See
1302|initialization| for how to set the 'viminfo' option upon startup.
1303
1304 *viminfo-write*
1305When Vim exits and 'viminfo' is non-empty, the info is stored in the viminfo
1306file (it's actually merged with the existing one, if one exists). The
1307'viminfo' option is a string containing information about what info should be
1308stored, and contains limits on how much should be stored (see 'viminfo').
1309
1310Notes for Unix:
1311- The file protection for the viminfo file will be set to prevent other users
1312 from being able to read it, because it may contain any text or commands that
1313 you have worked with.
1314- If you want to share the viminfo file with other users (e.g. when you "su"
1315 to another user), you can make the file writable for the group or everybody.
1316 Vim will preserve this when writing new viminfo files. Be careful, don't
1317 allow just anybody to read and write your viminfo file!
1318- Vim will not overwrite a viminfo file that is not writable by the current
1319 "real" user. This helps for when you did "su" to become root, but your
1320 $HOME is still set to a normal user's home directory. Otherwise Vim would
1321 create a viminfo file owned by root that nobody else can read.
1322
1323Marks are stored for each file separately. When a file is read and 'viminfo'
1324is non-empty, the marks for that file are read from the viminfo file. NOTE:
1325The marks are only written when exiting Vim, which is fine because marks are
1326remembered for all the files you have opened in the current editing session,
1327unless ":bdel" is used. If you want to save the marks for a file that you are
1328about to abandon with ":bdel", use ":wv". The '[' and ']' marks are not
1329stored, but the '"' mark is. The '"' mark is very useful for jumping to the
1330cursor position when the file was last exited. No marks are saved for files
1331that start with any string given with the "r" flag in 'viminfo'. This can be
1332used to avoid saving marks for files on removable media (for MS-DOS you would
1333use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:").
1334
1335 *viminfo-file-marks*
1336Uppercase marks ('A to 'Z) are stored when writing the viminfo file. The
1337numbered marks ('0 to '9) are a bit special. When the viminfo file is written
1338(when exiting or with the ":wviminfo" command), '0 is set to the current cursor
1339position and file. The old '0 is moved to '1, '1 to '2, etc. This
1340resembles what happens with the "1 to "9 delete registers. If the current
1341cursor position is already present in '0 to '9, it is moved to '0, to avoid
1342having the same position twice. The result is that with "'0", you can jump
1343back to the file and line where you exited Vim. To do that right away, try
1344using this command: >
1345
1346 vim -c "normal '0"
1347
1348In a shell you could make an alias for it: >
1349
1350 alias lvim vim -c '"'normal "'"0'"'
1351
1352Use the "r" flag in 'viminfo' to specify for which files no marks should be
1353remembered.
1354
1355
1356VIMINFO FILE NAME *viminfo-file-name*
1357
1358- The default name of the viminfo file is "$HOME/.viminfo" for Unix and OS/2,
1359 "s:.viminfo" for Amiga, "$HOME\_viminfo" for MS-DOS and Win32. For the last
1360 two, when $HOME is not set, "$VIM\_viminfo" is used. When $VIM is also not
1361 set, "c:\_viminfo" is used. For OS/2 "$VIM/.viminfo" is used when $HOME is
1362 not set and $VIM is set.
1363- The 'n' flag in the 'viminfo' option can be used to specify another viminfo
1364 file name |'viminfo'|.
1365- The "-i" Vim argument can be used to set another file name, |-i|. When the
1366 file name given is "NONE" (all uppercase), no viminfo file is ever read or
1367 written. Also not for the commands below!
1368- For the commands below, another file name can be given, overriding the
1369 default and the name given with 'viminfo' or "-i" (unless it's NONE).
1370
1371
1372CHARACTER ENCODING *viminfo-encoding*
1373
1374The text in the viminfo file is encoded as specified with the 'encoding'
1375option. Normally you will always work with the same 'encoding' value, and
1376this works just fine. However, if you read the viminfo file with another
1377value for 'encoding' than what it was written with, some of the text
1378(non-ASCII characters) may be invalid. If this is unacceptable, add the 'c'
1379flag to the 'viminfo' option: >
1380 :set viminfo+=c
1381Vim will then attempt to convert the text in the viminfo file from the
1382'encoding' value it was written with to the current 'encoding' value. This
1383requires Vim to be compiled with the |+iconv| feature. Filenames are not
1384converted.
1385
1386
1387MANUALLY READING AND WRITING
1388
1389Two commands can be used to read and write the viminfo file manually. This
1390can be used to exchange registers between two running Vim programs: First
1391type ":wv" in one and then ":rv" in the other. Note that if the register
1392already contained something, then ":rv!" would be required. Also note
1393however that this means everything will be overwritten with information from
1394the first Vim, including the command line history, etc.
1395
1396The viminfo file itself can be edited by hand too, although we suggest you
1397start with an existing one to get the format right. It is reasonably
1398self-explanatory once you're in there. This can be useful in order to
1399create a second file, say "~/.my_viminfo" which could contain certain
1400settings that you always want when you first start Vim. For example, you
1401can preload registers with particular data, or put certain commands in the
1402command line history. A line in your .vimrc file like >
1403 :rviminfo! ~/.my_viminfo
1404can be used to load this information. You could even have different viminfos
1405for different types of files (e.g., C code) and load them based on the file
1406name, using the ":autocmd" command (see |:autocmd|).
1407
1408 *viminfo-errors*
1409When Vim detects an error while reading a viminfo file, it will not overwrite
1410that file. If there are more than 10 errors, Vim stops reading the viminfo
1411file. This was done to avoid accidentally destroying a file when the file
1412name of the viminfo file is wrong. This could happen when accidentally typing
1413"vim -i file" when you wanted "vim -R file" (yes, somebody accidentally did
1414that!). If you want to overwrite a viminfo file with an error in it, you will
1415either have to fix the error, or delete the file (while Vim is running, so
1416most of the information will be restored).
1417
1418 *:rv* *:rviminfo* *E195*
1419:rv[iminfo][!] [file] Read from viminfo file [file] (default: see above).
1420 If [!] is given, then any information that is
1421 already set (registers, marks, etc.) will be
1422 overwritten. {not in Vi}
1423
1424 *:wv* *:wviminfo* *E137* *E138* *E574*
1425:wv[iminfo][!] [file] Write to viminfo file [file] (default: see above).
1426 The information in the file is first read in to make
1427 a merge between old and new info. When [!] is used,
1428 the old information is not read first, only the
1429 internal info is written. If 'viminfo' is empty, marks
1430 for up to 100 files will be written.
1431 When you get error "E138: Can't write viminfo file"
1432 check that no old temp files were left behind (e.g.
1433 ~/.viminf*) and that you can write in the directory of
1434 the .viminfo file.
1435 {not in Vi}
1436
1437 vim:tw=78:ts=8:ft=help:norl: