blob: 0b64ca3a19b0402811a7dfea150874431e08b6a6 [file] [log] [blame]
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00001*starting.txt* For Vim version 7.0aa. Last change: 2006 Feb 18
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
Bram Moolenaar7e8fd632006-02-18 22:14:51 +0000377 *-p*
378-p[N] Open N tab pages. If [N] is not given, one tab page is opened
379 for every file given as argument. The maximum is 10 tab
380 pages. If there are more tab pages than arguments, the last
381 few tab pages will be editing an empty file.
382 {not in Vi}
383
Bram Moolenaar071d4272004-06-13 20:20:40 +0000384 *-T*
385-T {terminal} Set the terminal type to "terminal". This influences the
386 codes that Vim will send to your terminal. This is normally
387 not needed, because Vim will be able to find out what type
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000388 of terminal you are using. (See |terminal-info|.) {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000389
390 *-d*
391-d Start in diff mode, like |vimdiff|.
392 {not in Vi} {not available when compiled without the |+diff|
393 feature}
394
395-d {device} Only on the Amiga and when not compiled with the |+diff|
396 feature. Works like "-dev".
397 *-dev*
398-dev {device} Only on the Amiga: The {device} is opened to be used for
399 editing.
400 Normally you would use this to set the window position and
401 size: "-d con:x/y/width/height", e.g.,
402 "-d con:30/10/600/150". But you can also use it to start
403 editing on another device, e.g., AUX:. {not in Vi}
404 *-f*
405-f Amiga: Do not restart Vim to open a new window. This
406 option should be used when Vim is started by a program that
407 will wait for the edit session to finish (e.g., mail or
408 readnews). See |amiga-window|.
409
410 GUI: Do not disconnect from the program that started Vim.
411 'f' stands for "foreground". If omitted, the GUI forks a new
412 process and exits the current one. "-f" should be used when
413 gvim is started by a program that will wait for the edit
414 session to finish (e.g., mail or readnews). If you want gvim
415 never to fork, include 'f' in 'guioptions' in your .gvimrc.
416 Careful: You can use "-gf" to start the GUI in the foreground,
417 but "-fg" is used to specify the foreground color. |gui-fork|
418 {not in Vi}
419
420 *--nofork*
421--nofork GUI: Do not fork. Same as |-f|.
422 *-u* *E282*
423-u {vimrc} The file {vimrc} is read for initializations. Most other
424 initializations are skipped; see |initialization|. This can
425 be used to start Vim in a special mode, with special
426 mappings and settings. A shell alias can be used to make
427 this easy to use. For example: >
428 alias vimc vim -u ~/.c_vimrc !*
429< Also consider using autocommands; see |autocommand|.
430 When {vimrc} is equal to "NONE" (all uppercase), all
431 initializations from files and environment variables are
432 skipped, including reading the .gvimrc file when the GUI
433 starts. Loading plugins is also skipped.
434 When {vimrc} is equal to "NORC" (all uppercase), this has the
435 same effect as "NONE", but loading plugins is not skipped.
436 Using the "-u" argument has the side effect that the
437 'compatible' option will be on by default. This can have
438 unexpected effects. See |'compatible'|.
439 {not in Vi}
440
441 *-U* *E230*
442-U {gvimrc} The file "gvimrc" is read for initializations when the GUI
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000443 starts. Other GUI initializations are skipped. When {gvimrc}
Bram Moolenaar8fc061c2004-12-29 21:03:02 +0000444 is equal to "NONE", no file is read for GUI initializations at
445 all. |gui-init|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000446 Exception: Reading the system-wide menu file is always done.
447 {not in Vi}
448
449 *-i*
450-i {viminfo} The file "viminfo" is used instead of the default viminfo
451 file. If the name "NONE" is used (all uppercase), no viminfo
452 file is read or written, even if 'viminfo' is set or when
453 ":rv" or ":wv" are used. See also |viminfo-file|.
454 {not in Vi}
455
456 *-x*
457-x Use encryption to read/write files. Will prompt for a key,
458 which is then stored in the 'key' option. All writes will
459 then use this key to encrypt the text. The '-x' argument is
460 not needed when reading a file, because there is a check if
461 the file that is being read has been encrypted, and Vim asks
462 for a key automatically. |encryption|
463
464 *-X*
465-X Do not try connecting to the X server to get the current
466 window title and copy/paste using the X clipboard. This
467 avoids a long startup time when running Vim in a terminal
468 emulator and the connection to the X server is slow.
469 Only makes a difference on Unix or VMS, when compiled with the
470 |+X11| feature. Otherwise it's ignored.
471 To disable the connection only for specific terminals, see the
472 'clipboard' option.
473 When the X11 Session Management Protocol (XSMP) handler has
474 been built in, the -X option also disables that connection as
475 it, too, may have undesirable delays.
476 When the connection is desired later anyway (e.g., for
477 client-server messages), call the |serverlist()| function.
478 This does not enable the XSMP handler though.
479 {not in Vi}
480
481 *-s*
482-s {scriptin} The script file "scriptin" is read. The characters in the
483 file are interpreted as if you had typed them. The same can
484 be done with the command ":source! {scriptin}". If the end
485 of the file is reached before the editor exits, further
486 characters are read from the keyboard. Only works when not
487 started in Ex mode, see |-s-ex|. See also |complex-repeat|.
488 {not in Vi}
489
Bram Moolenaar4399ef42005-02-12 14:29:27 +0000490 *-w_nr*
491-w {number}
492-w{number} Set the 'window' option to {number}.
493
Bram Moolenaar071d4272004-06-13 20:20:40 +0000494 *-w*
495-w {scriptout} All the characters that you type are recorded in the file
496 "scriptout", until you exit Vim. This is useful if you want
497 to create a script file to be used with "vim -s" or
498 ":source!". When the "scriptout" file already exists, new
499 characters are appended. See also |complex-repeat|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +0000500 {scriptout} cannot start with a digit.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000501 {not in Vi}
502
503 *-W*
504-W {scriptout} Like -w, but do not append, overwrite an existing file.
505 {not in Vi}
506
Bram Moolenaar071d4272004-06-13 20:20:40 +0000507--remote [+{cmd}] {file} ...
508 Open the {file} in another Vim that functions as a server.
509 Any non-file arguments must come before this.
510 See |--remote|. {not in Vi}
511
512--remote-silent [+{cmd}] {file} ...
513 Like --remote, but don't complain if there is no server.
514 See |--remote-silent|. {not in Vi}
515
516--remote-wait [+{cmd}] {file} ...
517 Like --remote, but wait for the server to finish editing the
518 file(s).
519 See |--remote-wait|. {not in Vi}
520
521--remote-wait-silent [+{cmd}] {file} ...
522 Like --remote-wait, but don't complain if there is no server.
523 See |--remote-wait-silent|. {not in Vi}
524
525--servername {name}
526 Specify the name of the Vim server to send to or to become.
527 See |--servername|. {not in Vi}
528
529--remote-send {keys}
530 Send {keys} to a Vim server and exit.
531 See |--remote-send|. {not in Vi}
532
533--remote-expr {expr}
534 Evaluate {expr} in another Vim that functions as a server.
535 The result is printed on stdout.
536 See |--remote-expr|. {not in Vi}
537
538--serverlist Output a list of Vim server names and exit. See
539 See |--serverlist|. {not in Vi}
540
541--socketid {id} *--socketid*
542 GTK+ GUI Vim only. Make gvim try to use GtkPlug mechanism, so
543 that it runs inside another window. See |gui-gtk-socketid|
544 for details. {not in Vi}
545
546--echo-wid *--echo-wid*
547 GTK+ GUI Vim only. Make gvim echo the Window ID on stdout,
548 which can be used to run gvim in a kpart widget. The format
549 of the output is: >
550 WID: 12345\n
551< {not in Vi}
552
553--role {role} *--role*
554 GTK+ 2 GUI only. Set the role of the main window to {role}.
555 The window role can be used by a window manager to uniquely
556 identify a window, in order to restore window placement and
557 such. The --role argument is passed automatically when
558 restoring the session on login. See |gui-gnome-session|
559 {not in Vi}
560
561-P {parent-title} *-P* *MDI* *E671* *E672*
562 Win32 only: Specify the title of the parent application. When
563 possible, Vim will run in an MDI window inside the
564 application.
565 {parent-title} must appear in the window title of the parent
566 application. Make sure that it is specific enough.
567 Note that the implementation is still primitive. It won't
568 work with all applications and the menu doesn't work.
569
570-nb *-nb*
571-nb={fname}
572-nb:{hostname}:{addr}:{password}
573 Attempt connecting to Netbeans and become an editor server for
574 it. The second form specifies a file to read connection info
575 from. The third form specifies the hostname, address and
576 password for connecting to Netbeans. |netbeans-run|
577
578Example for using a script file to change a name in several files:
579 Create a file "subs.vi" containing substitute commands and a :wq
580 command: >
581 :%s/Jones/Smith/g
582 :%s/Allen/Peter/g
583 :wq
584<
585 Execute Vim on all files you want to change: >
586
587 foreach i ( *.let ) vim -s subs.vi $i
588
589If the executable is called "view", Vim will start in Readonly mode. This is
590useful if you can make a hard or symbolic link from "view" to "vim".
591Starting in Readonly mode can also be done with "vim -R".
592
593If the executable is called "ex", Vim will start in "Ex" mode. This means it
594will accept only ":" commands. But when the "-v" argument is given, Vim will
595start in Normal mode anyway.
596
597Additional arguments are available on unix like systems when compiled with
598X11 GUI support. See |gui-resources|.
599
600==============================================================================
6012. Vim on the Amiga *starting-amiga*
602
603Starting Vim from the Workbench *workbench*
604-------------------------------
605
606Vim can be started from the Workbench by clicking on its icon twice. It will
607then start with an empty buffer.
608
609Vim can be started to edit one or more files by using a "Project" icon. The
610"Default Tool" of the icon must be the full pathname of the Vim executable.
611The name of the ".info" file must be the same as the name of the text file.
612By clicking on this icon twice, Vim will be started with the file name as
613current file name, which will be read into the buffer (if it exists). You can
614edit multiple files by pressing the shift key while clicking on icons, and
615clicking twice on the last one. The "Default Tool" for all these icons must
616be the same.
617
618It is not possible to give arguments to Vim, other than file names, from the
619workbench.
620
621Vim window *amiga-window*
622----------
623
624Vim will run in the CLI window where it was started. If Vim was started with
625the "run" or "runback" command, or if Vim was started from the workbench, it
626will open a window of its own.
627
628Technical detail:
629 To open the new window a little trick is used. As soon as Vim
630 recognizes that it does not run in a normal CLI window, it will
631 create a script file in "t:". This script file contains the same
632 command as the one Vim was started with, and an "endcli" command.
633 This script file is then executed with a "newcli" command (the "c:run"
634 and "c:newcli" commands are required for this to work). The script
635 file will hang around until reboot, or until you delete it. This
636 method is required to get the ":sh" and ":!" commands to work
637 correctly. But when Vim was started with the -f option (foreground
638 mode), this method is not used. The reason for this is that
639 when a program starts Vim with the -f option it will wait for Vim to
640 exit. With the script trick, the calling program does not know when
641 Vim exits. The -f option can be used when Vim is started by a mail
642 program which also waits for the edit session to finish. As a
643 consequence, the ":sh" and ":!" commands are not available when the
644 -f option is used.
645
646Vim will automatically recognize the window size and react to window
647resizing. Under Amiga DOS 1.3, it is advised to use the fastfonts program,
648"FF", to speed up display redrawing.
649
650==============================================================================
6513. Running eVim *evim-keys*
652
653EVim runs Vim as click-and-type editor. This is very unlike the original Vi
654idea. But it helps for people that don't use Vim often enough to learn the
655commands. Hopefully they will find out that learning to use Normal mode
656commands will make their editing much more effective.
657
658In Evim these options are changed from their default value:
659
660 :set nocompatible Use Vim improvements
661 :set insertmode Remain in Insert mode most of the time
662 :set hidden Keep invisible buffers loaded
663 :set backup Keep backup files (not for VMS)
664 :set backspace=2 Backspace over everything
665 :set autoindent auto-indent new lines
666 :set history=50 keep 50 lines of Ex commands
667 :set ruler show the cursor position
668 :set incsearch show matches halfway typing a pattern
669 :set mouse=a use the mouse in all modes
670 :set hlsearch highlight all matches for a search pattern
671 :set whichwrap+=<,>,[,] <Left> and <Right> wrap around line breaks
672 :set guioptions-=a non-Unix only: don't do auto-select
673
674Key mappings:
675 <Down> moves by screen lines rather than file lines
676 <Up> idem
677 Q does "gq", formatting, instead of Ex mode
678 <BS> in Visual mode: deletes the selection
679 CTRL-X in Visual mode: Cut to clipboard
680 <S-Del> idem
681 CTRL-C in Visual mode: Copy to clipboard
682 <C-Insert> idem
683 CTRL-V Pastes from the clipboard (in any mode)
684 <S-Insert> idem
685 CTRL-Q do what CTRL-V used to do
686 CTRL-Z undo
687 CTRL-Y redo
688 <M-Space> system menu
689 CTRL-A select all
690 <C-Tab> next window, CTRL-W w
691 <C-F4> close window, CTRL-W c
692
693Additionally:
694- ":behave mswin" is used |:behave|
695- syntax highlighting is enabled
696- filetype detection is enabled, filetype plugins and indenting is enabled
697- in a text file 'textwidth' is set to 78
698
699One hint: If you want to go to Normal mode to be able to type a sequence of
700commands, use CTRL-L. |i_CTRL-L|
701
702==============================================================================
7034. Initialization *initialization* *startup*
704
705This section is about the non-GUI version of Vim. See |gui-fork| for
706additional initialization when starting the GUI.
707
708At startup, Vim checks environment variables and files and sets values
709accordingly. Vim proceeds in this order:
710
7111. Set the 'shell' and 'term' option *SHELL* *COMSPEC* *TERM*
712 The environment variable SHELL, if it exists, is used to set the
713 'shell' option. On MS-DOS and Win32, the COMSPEC variable is used
714 if SHELL is not set.
715 The environment variable TERM, if it exists, is used to set the 'term'
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000716 option. However, 'term' will change later when starting the GUI (step
717 8 below).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000718
7192. Process the arguments
720 The options and file names from the command that start Vim are
721 inspected. Buffers are created for all files (but not loaded yet).
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000722 The |-V| argument can be used to display or log what happens next,
723 useful for debugging the initializations.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000724
7253. Execute Ex commands, from environment variables and/or files
726 An environment variable is read as one Ex command line, where multiple
727 commands must be separated with '|' or "<NL>".
728 *vimrc* *exrc*
729 A file that contains initialization commands is called a "vimrc" file.
730 Each line in a vimrc file is executed as an Ex command line. It is
731 sometimes also referred to as "exrc" file. They are the same type of
732 file, but "exrc" is what Vi always used, "vimrc" is a Vim specific
733 name. Also see |vimrc-intro|.
734
735 Recommended place for your personal initializations:
736 Unix $HOME/.vimrc
737 OS/2 $HOME/.vimrc or $VIM/.vimrc (or _vimrc)
738 MS-DOS and Win32 $HOME/_vimrc or $VIM/_vimrc
739 Amiga s:.vimrc or $VIM/.vimrc
740
741 If Vim was started with "-u filename", the file "filename" is used.
742 All following initializations until 4. are skipped.
743 "vim -u NORC" can be used to skip these initializations without
744 reading a file. "vim -u NONE" also skips loading plugins. |-u|
745
746 If Vim was started in Ex mode with the "-s" argument, all following
747 initializations until 4. are skipped. Only the "-u" option is
748 interpreted.
749 *evim.vim*
750 a. If vim was started as |evim| or |eview| or with the |-y| argument, the
751 script $VIMRUNTIME/evim.vim will be loaded.
752 *system-vimrc*
753 b. For Unix, MS-DOS, MS-Windows, OS/2, VMS, Macintosh, RISC-OS and Amiga
754 the system vimrc file is read for initializations. The path of this
755 file is shown with the ":version" command. Mostly it's "$VIM/vimrc".
756 Note that this file is ALWAYS read in 'compatible' mode, since the
757 automatic resetting of 'compatible' is only done later. Add a ":set
758 nocp" command if you like.
759
760 *VIMINIT* *.vimrc* *_vimrc* *EXINIT* *.exrc* *_exrc*
761 c. Four places are searched for initializations. The first that exists
762 is used, the others are ignored.
763 - The environment variable VIMINIT (see also |compatible-default|) (*)
764 The value of $VIMINIT is used as an Ex command line.
765 - The user vimrc file(s):
766 "$HOME/.vimrc" (for Unix and OS/2) (*)
767 "s:.vimrc" (for Amiga) (*)
768 "home:.vimrc" (for Amiga) (*)
769 "$VIM/.vimrc" (for OS/2 and Amiga) (*)
770 "$HOME/_vimrc" (for MS-DOS and Win32) (*)
Bram Moolenaar21cf8232004-07-16 20:18:37 +0000771 "$VIM/_vimrc" (for MS-DOS and Win32) (*)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000772 Note: For Unix, OS/2 and Amiga, when ".vimrc" does not exist,
773 "_vimrc" is also tried, in case an MS-DOS compatible file
774 system is used. For MS-DOS and Win32 ".vimrc" is checked
775 after "_vimrc", in case long file names are used.
776 Note: For MS-DOS and Win32, "$HOME" is checked first. If no
777 "_vimrc" or ".vimrc" is found there, "$VIM" is tried.
778 See |$VIM| for when $VIM is not set.
779 - The environment variable EXINIT.
780 The value of $EXINIT is used as an Ex command line.
781 - The user exrc file(s). Same as for the user vimrc file, but with
Bram Moolenaar5c5474b2005-04-19 21:40:26 +0000782 "vimrc" replaced by "exrc". But only one of ".exrc" and "_exrc" is
783 used, depending on the system. And without the (*)!
Bram Moolenaar071d4272004-06-13 20:20:40 +0000784
785 d. If the 'exrc' option is on (which is not the default), the current
Bram Moolenaar5c5474b2005-04-19 21:40:26 +0000786 directory is searched for three files. The first that exists is used,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000787 the others are ignored.
788 - The file ".vimrc" (for Unix, Amiga and OS/2) (*)
789 "_vimrc" (for MS-DOS and Win32) (*)
790 - The file "_vimrc" (for Unix, Amiga and OS/2) (*)
791 ".vimrc" (for MS-DOS and Win32) (*)
792 - The file ".exrc" (for Unix, Amiga and OS/2)
793 "_exrc" (for MS-DOS and Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000794
795 (*) Using this file or environment variable will cause 'compatible' to be
796 off by default. See |compatible-default|.
797
7984. Load the plugin scripts. *load-plugins*
799 This does the same as the command: >
Bram Moolenaar1c7715d2005-10-03 22:02:18 +0000800 :runtime! plugin/**/*.vim
Bram Moolenaar071d4272004-06-13 20:20:40 +0000801< The result is that all directories in the 'runtimepath' option will be
802 searched for the "plugin" sub-directory and all files ending in ".vim"
Bram Moolenaar1c7715d2005-10-03 22:02:18 +0000803 will be sourced (in alphabetical order per directory), also in
804 subdirectories.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000805 Loading plugins won't be done when:
806 - The 'loadplugins' option was reset in a vimrc file.
807 - The |--noplugin| command line argument is used.
808 - The "-u NONE" command line argument is used |-u|.
809 - When Vim was compiled without the |+eval| feature.
Bram Moolenaar8ada17c2006-01-19 22:16:24 +0000810 Note that using "-c 'set noloadplugins'" doesn't work, because the
811 commands from the command line have not been executed yet. You can
812 use "--cmd 'set noloadplugins'" |--cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000813
8145. Set 'shellpipe' and 'shellredir'
815 The 'shellpipe' and 'shellredir' options are set according to the
816 value of the 'shell' option, unless they have been set before.
817 This means that Vim will figure out the values of 'shellpipe' and
818 'shellredir' for you, unless you have set them yourself.
819
8206. Set 'updatecount' to zero, if "-n" command argument used
821
8227. Set binary options
823 If the "-b" flag was given to Vim, the options for binary editing will
824 be set now. See |-b|.
825
8268. Perform GUI initializations
827 Only when starting "gvim", the GUI initializations will be done. See
828 |gui-init|.
829
8309. Read the viminfo file
831 If the 'viminfo' option is not empty, the viminfo file is read. See
832 |viminfo-file|.
833
83410. Read the quickfix file
835 If the "-q" flag was given to Vim, the quickfix file is read. If this
836 fails, Vim exits.
837
83811. Open all windows
839 When the |-o| flag was given, windows will be opened (but not
840 displayed yet).
Bram Moolenaar7e8fd632006-02-18 22:14:51 +0000841 When the |-p| flag was given, tab pages will be created (but not
842 displayed yet).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000843 When switching screens, it happens now. Redrawing starts.
844 If the "-q" flag was given to Vim, the first error is jumped to.
845 Buffers for all windows will be loaded.
846
84712. Execute startup commands
848 If a "-t" flag was given to Vim, the tag is jumped to.
849 The commands given with the |-c| and |+cmd| arguments are executed.
850 If the 'insertmode' option is set, Insert mode is entered.
851 The |VimEnter| autocommands are executed.
852
853Some hints on using initializations:
854
855Standard setup:
856Create a vimrc file to set the default settings and mappings for all your edit
857sessions. Put it in a place so that it will be found by 3b:
858 ~/.vimrc (Unix and OS/2)
859 s:.vimrc (Amiga)
860 $VIM\_vimrc (MS-DOS and Win32)
861Note that creating a vimrc file will cause the 'compatible' option to be off
862by default. See |compatible-default|.
863
864Local setup:
865Put all commands that you need for editing a specific directory only into a
866vimrc file and place it in that directory under the name ".vimrc" ("_vimrc"
867for MS-DOS and Win32). NOTE: To make Vim look for these special files you
868have to turn on the option 'exrc'. See |trojan-horse| too.
869
870System setup:
871This only applies if you are managing a Unix system with several users and
872want to set the defaults for all users. Create a vimrc file with commands
873for default settings and mappings and put it in the place that is given with
874the ":version" command.
875
876Saving the current state of Vim to a file:
877Whenever you have changed values of options or when you have created a
878mapping, then you may want to save them in a vimrc file for later use. See
879|save-settings| about saving the current state of settings to a file.
880
881Avoiding setup problems for Vi users:
882Vi uses the variable EXINIT and the file "~/.exrc". So if you do not want to
883interfere with Vi, then use the variable VIMINIT and the file "vimrc" instead.
884
885Amiga environment variables:
886On the Amiga, two types of environment variables exist. The ones set with the
887DOS 1.3 (or later) setenv command are recognized. See the AmigaDos 1.3
888manual. The environment variables set with the old Manx Set command (before
889version 5.0) are not recognized.
890
891MS-DOS line separators:
892On MS-DOS-like systems (MS-DOS itself, Win32, and OS/2), Vim assumes that all
893the vimrc files have <CR> <NL> pairs as line separators. This will give
894problems if you have a file with only <NL>s and have a line like
895":map xx yy^M". The trailing ^M will be ignored.
896
897 *compatible-default*
898When Vim starts, the 'compatible' option is on. This will be used when Vim
899starts its initializations. But as soon as a user vimrc file is found, or a
900vimrc file in the current directory, or the "VIMINIT" environment variable is
901set, it will be set to 'nocompatible'. This has the side effect of setting or
902resetting other options (see 'compatible'). But only the options that have
903not been set or reset will be changed. This has the same effect like the
904value of 'compatible' had this value when starting Vim. Note that this
Bram Moolenaard042c562005-06-30 22:04:15 +0000905doesn't happen for the system-wide vimrc file. It does also happen for gvimrc
906files.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000907
908But there is a side effect of setting or resetting 'compatible' at the moment
909a .vimrc file is found: Mappings are interpreted the moment they are
910encountered. This makes a difference when using things like "<CR>". If the
911mappings depend on a certain value of 'compatible', set or reset it before
912giving the mapping.
913
914The above behavior can be overridden in these ways:
915- If the "-N" command line argument is given, 'nocompatible' will be used,
916 even when no vimrc file exists.
917- If the "-C" command line argument is given, 'compatible' will be used, even
918 when a vimrc file exists.
919- If the "-u {vimrc}" argument is used, 'compatible' will be used.
920- When the name of the executable ends in "ex", then this works like the "-C"
921 argument was given: 'compatible' will be used, even when a vimrc file
922 exists. This has been done to make Vim behave like "ex", when it is started
923 as "ex".
924
925Avoiding trojan horses: *trojan-horse*
926While reading the "vimrc" or the "exrc" file in the current directory, some
927commands can be disabled for security reasons by setting the 'secure' option.
928This is always done when executing the command from a tags file. Otherwise it
929would be possible that you accidentally use a vimrc or tags file that somebody
930else created and contains nasty commands. The disabled commands are the ones
931that start a shell, the ones that write to a file, and ":autocmd". The ":map"
932commands are echoed, so you can see which keys are being mapped.
933 If you want Vim to execute all commands in a local vimrc file, you
934can reset the 'secure' option in the EXINIT or VIMINIT environment variable or
935in the global "exrc" or "vimrc" file. This is not possible in "vimrc" or
936"exrc" in the current directory, for obvious reasons.
937 On Unix systems, this only happens if you are not the owner of the
938vimrc file. Warning: If you unpack an archive that contains a vimrc or exrc
939file, it will be owned by you. You won't have the security protection. Check
940the vimrc file before you start Vim in that directory, or reset the 'exrc'
941option. Some Unix systems allow a user to do "chown" on a file. This makes
942it possible for another user to create a nasty vimrc and make you the owner.
943Be careful!
944 When using tag search commands, executing the search command (the last
945part of the line in the tags file) is always done in secure mode. This works
946just like executing a command from a vimrc/exrc in the current directory.
947
948 *slow-start*
949If Vim takes a long time to start up, there may be a few causes:
950- If the Unix version was compiled with the GUI and/or X11 (check the output
951 of ":version" for "+GUI" and "+X11"), it may need to load shared libraries
952 and connect to the X11 server. Try compiling a version with GUI and X11
953 disabled. This also should make the executable smaller.
954 Use the |-X| command line argument to avoid connecting to the X server when
955 running in a terminal.
956- If you have "viminfo" enabled, the loading of the viminfo file may take a
957 while. You can find out if this is the problem by disabling viminfo for a
958 moment (use the Vim argument "-i NONE", |-i|). Try reducing the number of
959 lines stored in a register with ":set viminfo='20,<50,s10". |viminfo-file|.
960
961 *:intro*
962When Vim starts without a file name, an introductory message is displayed (for
963those who don't know what Vim is). It is removed as soon as the display is
964redrawn in any way. To see the message again, use the ":intro" command (if
965there is not enough room, you will see only part of it).
966 To avoid the intro message on startup, add the 'I' flag to 'shortmess'.
967
968 *info-message*
969The |--help| and |--version| arguments cause Vim to print a message and then
970exit. Normally the message is send to stdout, thus can be redirected to a
971file with: >
972
973 vim --help >file
974
975From inside Vim: >
976
977 :read !vim --help
978
979When using gvim, it detects that it might have been started from the desktop,
980without a terminal to show messages on. This is detected when both stdout and
981stderr are not a tty. This breaks the ":read" command, as used in the example
982above. To make it work again, set 'shellredir' to ">" instead of the default
983">&": >
984
985 :set shellredir=>
986 :read !gvim --help
987
988This still won't work for systems where gvim does not use stdout at all
989though.
990
991==============================================================================
9925. $VIM and $VIMRUNTIME
993 *$VIM*
994The environment variable "$VIM" is used to locate various user files for Vim,
995such as the user startup script ".vimrc". This depends on the system, see
996|startup|.
997
998To avoid the need for every user to set the $VIM environment variable, Vim
999will try to get the value for $VIM in this order:
10001. The value defined by the $VIM environment variable. You can use this to
1001 make Vim look in a specific directory for its support files. Example: >
1002 setenv VIM /home/paul/vim
10032. The path from 'helpfile' is used, unless it contains some environment
1004 variable too (the default is "$VIMRUNTIME/doc/help.txt": chicken-egg
1005 problem). The file name ("help.txt" or any other) is removed. Then
1006 trailing directory names are removed, in this order: "doc", "runtime" and
1007 "vim{version}" (e.g., "vim54").
10083. For MSDOS, Win32 and OS/2 Vim tries to use the directory name of the
1009 executable. If it ends in "/src", this is removed. This is useful if you
1010 unpacked the .zip file in some directory, and adjusted the search path to
1011 find the vim executable. Trailing directory names are removed, in this
1012 order: "runtime" and "vim{version}" (e.g., "vim54").
10134. For Unix the compile-time defined installation directory is used (see the
1014 output of ":version").
1015
1016Once Vim has done this once, it will set the $VIM environment variable. To
1017change it later, use a ":let" command like this: >
1018 :let $VIM = "/home/paul/vim/"
1019<
1020 *$VIMRUNTIME*
1021The environment variable "$VIMRUNTIME" is used to locate various support
1022files, such as the on-line documentation and files used for syntax
1023highlighting. For example, the main help file is normally
1024"$VIMRUNTIME/doc/help.txt".
1025You don't normally set $VIMRUNTIME yourself, but let Vim figure it out. This
1026is the order used to find the value of $VIMRUNTIME:
10271. If the environment variable $VIMRUNTIME is set, it is used. You can use
1028 this when the runtime files are in an unusual location.
10292. If "$VIM/vim{version}" exists, it is used. {version} is the version
1030 number of Vim, without any '-' or '.'. For example: "$VIM/vim54". This is
1031 the normal value for $VIMRUNTIME.
10323. If "$VIM/runtime" exists, it is used.
10334. The value of $VIM is used. This is for backwards compatibility with older
1034 versions.
10355. When the 'helpfile' option is set and doesn't contain a '$', its value is
1036 used, with "doc/help.txt" removed from the end.
1037
1038For Unix, when there is a compiled-in default for $VIMRUNTIME (check the
1039output of ":version"), steps 2, 3 and 4 are skipped, and the compiled-in
1040default is used after step 5. This means that the compiled-in default
1041overrules the value of $VIM. This is useful if $VIM is "/etc" and the runtime
1042files are in "/usr/share/vim/vim54".
1043
1044Once Vim has done this once, it will set the $VIMRUNTIME environment variable.
1045To change it later, use a ":let" command like this: >
1046 :let $VIMRUNTIME = "/home/piet/vim/vim54"
1047
Bram Moolenaared203462004-06-16 11:19:22 +00001048In case you need the value of $VIMRUNTIME in a shell (e.g., for a script that
1049greps in the help files) you might be able to use this: >
1050
1051 VIMRUNTIME=`vim -e -T dumb --cmd 'exe "set t_cm=\<C-M>"|echo $VIMRUNTIME|quit' | tr -d '\015' `
1052
Bram Moolenaar071d4272004-06-13 20:20:40 +00001053==============================================================================
10546. Suspending *suspend*
1055
1056 *iconize* *iconise* *CTRL-Z* *v_CTRL-Z*
1057CTRL-Z Suspend Vim, like ":stop".
1058 Works in Normal and in Visual mode. In Insert and
1059 Command-line mode, the CTRL-Z is inserted as a normal
1060 character. In Visual mode Vim goes back to Normal
1061 mode.
Bram Moolenaar0d660222005-01-07 21:51:51 +00001062 Note: if CTRL-Z undoes a change see |mswin.vim|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001063
1064
1065:sus[pend][!] or *:sus* *:suspend* *:st* *:stop*
1066:st[op][!] Suspend Vim.
1067 If the '!' is not given and 'autowrite' is set, every
1068 buffer with changes and a file name is written out.
1069 If the '!' is given or 'autowrite' is not set, changed
1070 buffers are not written, don't forget to bring Vim
1071 back to the foreground later!
1072
1073In the GUI, suspending is implemented as iconising gvim. In Windows 95/NT,
1074gvim is minimized.
1075
1076On many Unix systems, it is possible to suspend Vim with CTRL-Z. This is only
1077possible in Normal and Visual mode (see next chapter, |vim-modes|). Vim will
1078continue if you make it the foreground job again. On other systems, CTRL-Z
1079will start a new shell. This is the same as the ":sh" command. Vim will
1080continue if you exit from the shell.
1081
1082In X-windows the selection is disowned when Vim suspends. this means you
1083can't paste it in another application (since Vim is going to sleep an attempt
1084to get the selection would make the program hang).
1085
1086==============================================================================
10877. Saving settings *save-settings*
1088
1089Mostly you will edit your vimrc files manually. This gives you the greatest
1090flexibility. There are a few commands to generate a vimrc file automatically.
1091You can use these files as they are, or copy/paste lines to include in another
1092vimrc file.
1093
1094 *:mk* *:mkexrc*
1095:mk[exrc] [file] Write current key mappings and changed options to
1096 [file] (default ".exrc" in the current directory),
1097 unless it already exists. {not in Vi}
1098
1099:mk[exrc]! [file] Always write current key mappings and changed
1100 options to [file] (default ".exrc" in the current
1101 directory). {not in Vi}
1102
1103 *:mkv* *:mkvimrc*
1104:mkv[imrc][!] [file] Like ":mkexrc", but the default is ".vimrc" in the
1105 current directory. The ":version" command is also
1106 written to the file. {not in Vi}
1107
1108These commands will write ":map" and ":set" commands to a file, in such a way
1109that when these commands are executed, the current key mappings and options
1110will be set to the same values. The options 'columns', 'endofline',
1111'fileformat', 'key', 'lines', 'modified', 'scroll', 'term', 'textmode',
1112'ttyfast' and 'ttymouse' are not included, because these are terminal or file
1113dependent. Note that the options 'binary', 'paste' and 'readonly' are
1114included, this might not always be what you want.
1115
1116When special keys are used in mappings, The 'cpoptions' option will be
1117temporarily set to its Vim default, to avoid the mappings to be
1118misinterpreted. This makes the file incompatible with Vi, but makes sure it
1119can be used with different terminals.
1120
1121Only global mappings are stored, not mappings local to a buffer.
1122
1123A common method is to use a default ".vimrc" file, make some modifications
1124with ":map" and ":set" commands and write the modified file. First read the
1125default ".vimrc" in with a command like ":source ~piet/.vimrc.Cprogs", change
1126the settings and then save them in the current directory with ":mkvimrc!". If
1127you want to make this file your default .vimrc, move it to your home directory
1128(on Unix), s: (Amiga) or $VIM directory (MS-DOS). You could also use
1129autocommands |autocommand| and/or modelines |modeline|.
1130
1131If you only want to add a single option setting to your vimrc, you can use
1132these steps:
11331. Edit your vimrc file with Vim.
11342. Play with the option until it's right. E.g., try out different values for
1135 'guifont'.
11363. Append a line to set the value of the option, using the expression register
1137 '=' to enter the value. E.g., for the 'guifont' option: >
1138 o:set guifont=<C-R>=&guifont<CR><Esc>
1139< [<C-R> is a CTRL-R, <CR> is a return, <Esc> is the escape key]
1140
1141Note that when you create a .vimrc file, this can influence the 'compatible'
1142option, which has several side effects. See |'compatible'|.
1143":mkvimrc", ":mkexrc" and ":mksession" write the command to set or reset the
1144'compatible' option to the output file first, because of these side effects.
1145
1146==============================================================================
11478. Views and Sessions *views-sessions*
1148
1149This is introduced in sections |21.4| and |21.5| of the user manual.
1150
1151 *View* *view-file*
1152A View is a collection of settings that apply to one window. You can save a
1153View and when you restore it later, the text is displayed in the same way.
1154The options and mappings in this window will also be restored, so that you can
1155continue editing like when the View was saved.
1156
1157 *Session* *session-file*
1158A Session keeps the Views for all windows, plus the global settings. You can
1159save a Session and when you restore it later the window layout looks the same.
1160You can use a Session to quickly switch between different projects,
1161automatically loading the files you were last working on in that project.
1162
1163Views and Sessions are a nice addition to viminfo-files, which are used to
1164remember information for all Views and Sessions together |viminfo-file|.
1165
1166You can quickly start editing with a previously saved View or Session with the
1167|-S| argument: >
1168 vim -S Session.vim
1169<
1170All this is {not in Vi} and {not available when compiled without the
1171|+mksession| feature}.
1172
1173 *:mks* *:mksession*
1174:mks[ession][!] [file] Write a Vim script that restores the current editing
1175 session.
1176 When [!] is included an existing file is overwritten.
1177 When [file] is omitted "Session.vim" is used.
1178
1179The output of ":mksession" is like ":mkvimrc", but additional commands are
1180added to the file. Which ones depends on the 'sessionoptions' option. The
1181resulting file, when executed with a ":source" command:
11821. Restores global mappings and options, if 'sessionoptions' contains
1183 "options". Script-local mappings will not be written.
11842. Restores global variables that start with an uppercase letter and contain
1185 at least one lowercase letter, if 'sessionoptions' contains "globals".
11863. Unloads all currently loaded buffers.
11874. Restores the current directory if 'sessionoptions' contains "curdir", or
1188 sets the current directory to where the Session file is if 'sessionoptions'
1189 contains "sesdir".
11905. Restores GUI Vim window position, if 'sessionoptions' contains "winpos".
11916. Restores screen size, if 'sessionoptions' contains "resize".
11927. Reloads the buffer list, with the last cursor positions. If
1193 'sessionoptions' contains "buffers" then all buffers are restored,
1194 including hidden and unloaded buffers. Otherwise only buffers in windows
1195 are restored.
11968. Restores all windows with the same layout. If 'sessionoptions' contains
1197 contains "help", help windows are restored. If 'sessionoptions' contains
1198 "blank", windows editing a buffer without a name will be restored.
1199 If 'sessionoptions' contains "winsize" and no (help/blank) windows were
1200 left out, the window sizes are restored (relative to the screen size).
1201 Otherwise, the windows are just given sensible sizes.
12029. Restores the Views for all the windows, as with |:mkview|. But
1203 'sessionoptions' is used instead of 'viewoptions'.
120410. If a file exists with the same name as the Session file, but ending in
1205 "x.vim" (for eXtra), executes that as well. You can use *x.vim files to
1206 specify additional settings and actions associated with a given Session,
1207 such as creating menu items in the GUI version.
1208
1209After restoring the Session, the full filename of your current Session is
1210available in the internal variable "v:this_session" |this_session-variable|.
1211An example mapping: >
1212 :nmap <F2> :wa<Bar>exe "mksession! " . v:this_session<CR>:so ~/sessions/
1213This saves the current Session, and starts off the command to load another.
1214
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00001215A session only includes the current tab page. There currently is no option to
1216store all tab pages. |tab-page|
1217
Bram Moolenaar9372a112005-12-06 19:59:18 +00001218The |SessionLoadPost| autocmd event is triggered after a session file is
1219loaded/sourced.
1220 *SessionLoad-variable*
1221While the session file is loading the SessionLoad global variable is set to 1.
1222Plugins can use this to postpone some work until the SessionLoadPost event is
1223triggered.
1224
Bram Moolenaar071d4272004-06-13 20:20:40 +00001225 *:mkvie* *:mkview*
1226:mkvie[w][!] [file] Write a Vim script that restores the contents of the
1227 current window.
1228 When [!] is included an existing file is overwritten.
1229 When [file] is omitted or is a number from 1 to 9, a
1230 name is generated and 'viewdir' prepended. When last
1231 directory name in 'viewdir' does not exist, this
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001232 directory is created. *E739*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001233 An existing file is always overwritten then. Use
1234 |:loadview| to load this view again.
1235 When [file] is the name of a file ('viewdir' is not
1236 used), a command to edit the file is added to the
1237 generated file.
1238
1239The output of ":mkview" contains these items:
12401. The argument list used in the window. When the global argument list is
1241 used it is reset to the global list.
1242 The index in the argument list is also restored.
12432. The file being edited in the window. If there is no file, the window is
1244 made empty.
12453. Restore mappings, abbreviations and options local to the window if
1246 'viewoptions' contains "options" or "localoptions". For the options it
1247 restores only values that are local to the current buffer and values local
1248 to the window.
1249 When storing the view as part of a session and "options" is in
1250 'sessionoptions', global values for local options will be stored too.
12514. Restore folds when using manual folding and 'viewoptions' contains
1252 "folds". Restore manually opened and closed folds.
12535. The scroll position and the cursor position in the file. Doesn't work very
1254 well when there are closed folds.
12556. The local current directory, if it is different from the global current
1256 directory.
1257
1258Note that Views and Sessions are not perfect:
1259- They don't restore everything. For example, defined functions, autocommands
1260 and ":syntax on" are not included. Things like register contents and
1261 command line history are in viminfo, not in Sessions or Views.
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001262- Global option values are only set when they differ from the default value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001263 When the current value is not the default value, loading a Session will not
1264 set it back to the default value. Local options will be set back to the
1265 default value though.
1266- Existing mappings will be overwritten without warning. An existing mapping
1267 may cause an error for ambiguity.
1268- When storing manual folds and when storing manually opened/closed folds,
1269 changes in the file between saving and loading the view will mess it up.
1270- The Vim script is not very efficient. But still faster than typing the
1271 commands yourself!
1272
1273 *:lo* *:loadview*
1274:lo[adview] [nr] Load the view for the current file. When [nr] is
1275 omitted, the view stored with ":mkview" is loaded.
1276 When [nr] is specified, the view stored with ":mkview
1277 [nr]" is loaded.
1278
1279The combination of ":mkview" and ":loadview" can be used to store up to ten
1280different views of a file. These are remembered in the directory specified
1281with the 'viewdir' option. The views are stored using the file name. If a
1282file is renamed or accessed through a (symbolic) link the view will not be
1283found.
1284
1285You might want to clean up your 'viewdir' directory now and then.
1286
1287To automatically save and restore views for *.c files: >
1288 au BufWinLeave *.c mkview
1289 au BufWinEnter *.c silent loadview
1290
1291==============================================================================
12929. The viminfo file *viminfo* *viminfo-file* *E136*
1293 *E575* *E576* *E577*
1294If you exit Vim and later start it again, you would normally lose a lot of
1295information. The viminfo file can be used to remember that information, which
1296enables you to continue where you left off.
1297
1298This is introduced in section |21.3| of the user manual.
1299
1300The viminfo file is used to store:
1301- The command line history.
1302- The search string history.
1303- The input-line history.
Bram Moolenaar49cd9572005-01-03 21:06:01 +00001304- Contents of non-empty registers.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001305- Marks for several files.
1306- File marks, pointing to locations in files.
1307- Last search/substitute pattern (for 'n' and '&').
1308- The buffer list.
1309- Global variables.
1310
1311The viminfo file is not supported when the |+viminfo| feature has been
1312disabled at compile time.
1313
1314You could also use a Session file. The difference is that the viminfo file
1315does not depend on what you are working on. There normally is only one
1316viminfo file. Session files are used to save the state of a specific editing
1317Session. You could have several Session files, one for each project you are
1318working on. Viminfo and Session files together can be used to effectively
1319enter Vim and directly start working in your desired setup. |session-file|
1320
1321 *viminfo-read*
1322When Vim is started and the 'viminfo' option is non-empty, the contents of
1323the viminfo file are read and the info can be used in the appropriate places.
1324The marks are not read in at startup (but file marks are). See
1325|initialization| for how to set the 'viminfo' option upon startup.
1326
1327 *viminfo-write*
1328When Vim exits and 'viminfo' is non-empty, the info is stored in the viminfo
1329file (it's actually merged with the existing one, if one exists). The
1330'viminfo' option is a string containing information about what info should be
1331stored, and contains limits on how much should be stored (see 'viminfo').
1332
1333Notes for Unix:
1334- The file protection for the viminfo file will be set to prevent other users
1335 from being able to read it, because it may contain any text or commands that
1336 you have worked with.
1337- If you want to share the viminfo file with other users (e.g. when you "su"
1338 to another user), you can make the file writable for the group or everybody.
1339 Vim will preserve this when writing new viminfo files. Be careful, don't
1340 allow just anybody to read and write your viminfo file!
1341- Vim will not overwrite a viminfo file that is not writable by the current
1342 "real" user. This helps for when you did "su" to become root, but your
1343 $HOME is still set to a normal user's home directory. Otherwise Vim would
1344 create a viminfo file owned by root that nobody else can read.
1345
1346Marks are stored for each file separately. When a file is read and 'viminfo'
1347is non-empty, the marks for that file are read from the viminfo file. NOTE:
1348The marks are only written when exiting Vim, which is fine because marks are
1349remembered for all the files you have opened in the current editing session,
1350unless ":bdel" is used. If you want to save the marks for a file that you are
1351about to abandon with ":bdel", use ":wv". The '[' and ']' marks are not
1352stored, but the '"' mark is. The '"' mark is very useful for jumping to the
1353cursor position when the file was last exited. No marks are saved for files
1354that start with any string given with the "r" flag in 'viminfo'. This can be
1355used to avoid saving marks for files on removable media (for MS-DOS you would
1356use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:").
1357
1358 *viminfo-file-marks*
1359Uppercase marks ('A to 'Z) are stored when writing the viminfo file. The
1360numbered marks ('0 to '9) are a bit special. When the viminfo file is written
1361(when exiting or with the ":wviminfo" command), '0 is set to the current cursor
1362position and file. The old '0 is moved to '1, '1 to '2, etc. This
1363resembles what happens with the "1 to "9 delete registers. If the current
1364cursor position is already present in '0 to '9, it is moved to '0, to avoid
1365having the same position twice. The result is that with "'0", you can jump
1366back to the file and line where you exited Vim. To do that right away, try
1367using this command: >
1368
1369 vim -c "normal '0"
1370
1371In a shell you could make an alias for it: >
1372
1373 alias lvim vim -c '"'normal "'"0'"'
1374
1375Use the "r" flag in 'viminfo' to specify for which files no marks should be
1376remembered.
1377
1378
1379VIMINFO FILE NAME *viminfo-file-name*
1380
1381- The default name of the viminfo file is "$HOME/.viminfo" for Unix and OS/2,
1382 "s:.viminfo" for Amiga, "$HOME\_viminfo" for MS-DOS and Win32. For the last
1383 two, when $HOME is not set, "$VIM\_viminfo" is used. When $VIM is also not
1384 set, "c:\_viminfo" is used. For OS/2 "$VIM/.viminfo" is used when $HOME is
1385 not set and $VIM is set.
1386- The 'n' flag in the 'viminfo' option can be used to specify another viminfo
1387 file name |'viminfo'|.
1388- The "-i" Vim argument can be used to set another file name, |-i|. When the
1389 file name given is "NONE" (all uppercase), no viminfo file is ever read or
1390 written. Also not for the commands below!
1391- For the commands below, another file name can be given, overriding the
1392 default and the name given with 'viminfo' or "-i" (unless it's NONE).
1393
1394
1395CHARACTER ENCODING *viminfo-encoding*
1396
1397The text in the viminfo file is encoded as specified with the 'encoding'
1398option. Normally you will always work with the same 'encoding' value, and
1399this works just fine. However, if you read the viminfo file with another
1400value for 'encoding' than what it was written with, some of the text
1401(non-ASCII characters) may be invalid. If this is unacceptable, add the 'c'
1402flag to the 'viminfo' option: >
1403 :set viminfo+=c
1404Vim will then attempt to convert the text in the viminfo file from the
1405'encoding' value it was written with to the current 'encoding' value. This
1406requires Vim to be compiled with the |+iconv| feature. Filenames are not
1407converted.
1408
1409
1410MANUALLY READING AND WRITING
1411
1412Two commands can be used to read and write the viminfo file manually. This
1413can be used to exchange registers between two running Vim programs: First
1414type ":wv" in one and then ":rv" in the other. Note that if the register
1415already contained something, then ":rv!" would be required. Also note
1416however that this means everything will be overwritten with information from
1417the first Vim, including the command line history, etc.
1418
1419The viminfo file itself can be edited by hand too, although we suggest you
1420start with an existing one to get the format right. It is reasonably
1421self-explanatory once you're in there. This can be useful in order to
1422create a second file, say "~/.my_viminfo" which could contain certain
1423settings that you always want when you first start Vim. For example, you
1424can preload registers with particular data, or put certain commands in the
1425command line history. A line in your .vimrc file like >
1426 :rviminfo! ~/.my_viminfo
1427can be used to load this information. You could even have different viminfos
1428for different types of files (e.g., C code) and load them based on the file
1429name, using the ":autocmd" command (see |:autocmd|).
1430
1431 *viminfo-errors*
1432When Vim detects an error while reading a viminfo file, it will not overwrite
1433that file. If there are more than 10 errors, Vim stops reading the viminfo
1434file. This was done to avoid accidentally destroying a file when the file
1435name of the viminfo file is wrong. This could happen when accidentally typing
1436"vim -i file" when you wanted "vim -R file" (yes, somebody accidentally did
1437that!). If you want to overwrite a viminfo file with an error in it, you will
1438either have to fix the error, or delete the file (while Vim is running, so
1439most of the information will be restored).
1440
1441 *:rv* *:rviminfo* *E195*
1442:rv[iminfo][!] [file] Read from viminfo file [file] (default: see above).
1443 If [!] is given, then any information that is
1444 already set (registers, marks, etc.) will be
1445 overwritten. {not in Vi}
1446
1447 *:wv* *:wviminfo* *E137* *E138* *E574*
1448:wv[iminfo][!] [file] Write to viminfo file [file] (default: see above).
1449 The information in the file is first read in to make
1450 a merge between old and new info. When [!] is used,
1451 the old information is not read first, only the
1452 internal info is written. If 'viminfo' is empty, marks
1453 for up to 100 files will be written.
1454 When you get error "E138: Can't write viminfo file"
1455 check that no old temp files were left behind (e.g.
1456 ~/.viminf*) and that you can write in the directory of
1457 the .viminfo file.
1458 {not in Vi}
1459
1460 vim:tw=78:ts=8:ft=help:norl: