blob: b9a23707116893e0ce9dd988bbc60b9d516d5da0 [file] [log] [blame]
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001*starting.txt* For Vim version 8.2. Last change: 2020 Feb 04
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|
Bram Moolenaare0fa3742016-02-20 15:47:01 +0100157. Exiting |exiting|
168. Saving settings |save-settings|
179. Views and Sessions |views-sessions|
1810. The viminfo file |viminfo-file|
Bram Moolenaar071d4272004-06-13 20:20:40 +000019
20==============================================================================
211. Vim arguments *vim-arguments*
22
23Most often, Vim is started to edit a single file with the command
24
25 vim filename *-vim*
26
27More generally, Vim is started with:
28
29 vim [option | filename] ..
30
31Option arguments and file name arguments can be mixed, and any number of them
32can be given. However, watch out for options that take an argument.
33
34For compatibility with various Vi versions, see |cmdline-arguments|.
35
36Exactly one out of the following five items may be used to choose how to
37start editing:
38
39 *-file* *---*
40filename One or more file names. The first one will be the current
41 file and read into the buffer. The cursor will be positioned
42 on the first line of the buffer.
43 To avoid a file name starting with a '-' being interpreted as
44 an option, precede the arglist with "--", e.g.: >
45 vim -- -filename
46< All arguments after the "--" will be interpreted as file names,
47 no other options or "+command" argument can follow.
Bram Moolenaar5f148ec2016-03-07 22:59:26 +010048 For behavior of quotes on MS-Windows, see |win32-quotes|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000049
50 *--*
51- This argument can mean two things, depending on whether Ex
52 mode is to be used.
53
54 Starting in Normal mode: >
55 vim -
56 ex -v -
57< Start editing a new buffer, which is filled with text
58 that is read from stdin. The commands that would normally be
59 read from stdin will now be read from stderr. Example: >
60 find . -name "*.c" -print | vim -
Bram Moolenaarebdf3c92020-02-15 21:41:42 +010061
62< The buffer will be marked as modified, so that you are
63 reminded to save the text when trying to exit. If you don't
64 like that, put this these lines in your vimrc: >
65 " Don't set 'modified' when reading from stdin
66 au StdinReadPost * set nomodified
Bram Moolenaar071d4272004-06-13 20:20:40 +000067<
68 Starting in Ex mode: >
69 ex -
70 vim -e -
71 exim -
72 vim -E
73< Start editing in silent mode. See |-s-ex|.
74
75 *-t* *-tag*
76-t {tag} A tag. "tag" is looked up in the tags file, the associated
77 file becomes the current file, and the associated command is
78 executed. Mostly this is used for C programs, in which case
79 "tag" often is a function name. The effect is that the file
80 containing that function becomes the current file and the
81 cursor is positioned on the start of the function (see
82 |tags|).
83
84 *-q* *-qf*
85-q [errorfile] QuickFix mode. The file with the name [errorfile] is read
86 and the first error is displayed. See |quickfix|.
87 If [errorfile] is not given, the 'errorfile' option is used
88 for the file name. See 'errorfile' for the default value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000089
90(nothing) Without one of the four items above, Vim will start editing a
91 new buffer. It's empty and doesn't have a file name.
92
93
94The startup mode can be changed by using another name instead of "vim", which
95is equal to giving options:
96ex vim -e Start in Ex mode (see |Ex-mode|). *ex*
97exim vim -E Start in improved Ex mode (see |Ex-mode|). *exim*
98 (normally not installed)
99view vim -R Start in read-only mode (see |-R|). *view*
100gvim vim -g Start the GUI (see |gui|). *gvim*
Bram Moolenaar24ea3ba2010-09-19 19:01:21 +0200101gex vim -eg Start the GUI in Ex mode. *gex*
102gview vim -Rg Start the GUI in read-only mode. *gview*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000103rvim vim -Z Like "vim", but in restricted mode (see |-Z|) *rvim*
Bram Moolenaar24ea3ba2010-09-19 19:01:21 +0200104rview vim -RZ Like "view", but in restricted mode. *rview*
105rgvim vim -gZ Like "gvim", but in restricted mode. *rgvim*
106rgview vim -RgZ Like "gview", but in restricted mode. *rgview*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000107evim vim -y Easy Vim: set 'insertmode' (see |-y|) *evim*
Bram Moolenaar24ea3ba2010-09-19 19:01:21 +0200108eview vim -yR Like "evim" in read-only mode *eview*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000109vimdiff vim -d Start in diff mode |diff-mode|
110gvimdiff vim -gd Start in diff mode |diff-mode|
111
112Additional characters may follow, they are ignored. For example, you can have
Bram Moolenaar8024f932020-01-14 19:29:13 +0100113"gvim-8" to start the GUI. You must have an executable by that name then, of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000114course.
115
116On Unix, you would normally have one executable called Vim, and links from the
117different startup-names to that executable. If your system does not support
118links and you do not want to have several copies of the executable, you could
119use an alias instead. For example: >
120 alias view vim -R
121 alias gvim vim -g
122<
123 *startup-options*
124The option arguments may be given in any order. Single-letter options can be
125combined after one dash. There can be no option arguments after the "--"
126argument.
127
128On VMS all option arguments are assumed to be lowercase, unless preceded with
129a slash. Thus "-R" means recovery and "-/R" readonly.
130
Bram Moolenaar85eee132018-05-06 17:57:30 +0200131--help *-h* *--help* *-?*
132-?
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200133-h Give usage (help) message and exit.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000134 See |info-message| about capturing the text.
135
136 *--version*
137--version Print version information and exit. Same output as for
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200138 |:version| command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000139 See |info-message| about capturing the text.
140
141 *--noplugin*
142--noplugin Skip loading plugins. Resets the 'loadplugins' option.
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200143
Bram Moolenaar071d4272004-06-13 20:20:40 +0000144 Note that the |-u| argument may also disable loading plugins:
Bram Moolenaarc4da1132017-07-15 19:39:43 +0200145 argument load: vimrc files plugins defaults.vim ~
146 (nothing) yes yes yes
147 -u NONE no no no
148 -u DEFAULTS no no yes
149 -u NORC no yes no
150 --noplugin yes no yes
Bram Moolenaar071d4272004-06-13 20:20:40 +0000151
Bram Moolenaaref94eec2009-11-11 13:22:11 +0000152--startuptime {fname} *--startuptime*
Bram Moolenaar3f269672009-11-03 11:11:11 +0000153 During startup write timing messages to the file {fname}.
154 This can be used to find out where time is spent while loading
Bram Moolenaaref94eec2009-11-11 13:22:11 +0000155 your .vimrc, plugins and opening the first file.
Bram Moolenaar3f269672009-11-03 11:11:11 +0000156 When {fname} already exists new messages are appended.
Bram Moolenaar30e9b3c2019-09-07 16:24:12 +0200157 {only available when compiled with the |+startuptime|
158 feature}
Bram Moolenaar3f269672009-11-03 11:11:11 +0000159
Bram Moolenaar071d4272004-06-13 20:20:40 +0000160 *--literal*
161--literal Take file names literally, don't expand wildcards. Not needed
162 for Unix, because Vim always takes file names literally (the
163 shell expands wildcards).
164 Applies to all the names, also the ones that come before this
165 argument.
166
167 *-+*
168+[num] The cursor will be positioned on line "num" for the first
169 file being edited. If "num" is missing, the cursor will be
170 positioned on the last line.
171
172 *-+/*
173+/{pat} The cursor will be positioned on the first line containing
174 "pat" in the first file being edited (see |pattern| for the
Bram Moolenaar946e27a2014-06-25 18:50:27 +0200175 available search patterns). The search starts at the cursor
176 position, which can be the first line or the cursor position
177 last used from |viminfo|. To force a search from the first
178 line use "+1 +/pat".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000179
180+{command} *-+c* *-c*
181-c {command} {command} will be executed after the first file has been
182 read (and after autocommands and modelines for that file have
183 been processed). "command" is interpreted as an Ex command.
184 If the "command" contains spaces, it must be enclosed in
185 double quotes (this depends on the shell that is used).
186 Example: >
187 vim "+set si" main.c
188 vim "+find stdio.h"
189 vim -c "set ff=dos" -c wq mine.mak
190<
191 Note: You can use up to 10 "+" or "-c" arguments in a Vim
192 command. They are executed in the order given. A "-S"
193 argument counts as a "-c" argument as well.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000194
195--cmd {command} *--cmd*
196 {command} will be executed before processing any vimrc file.
197 Otherwise it acts like -c {command}. You can use up to 10 of
198 these commands, independently from "-c" commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000199
200 *-S*
201-S {file} The {file} will be sourced after the first file has been read.
202 This is an easy way to do the equivalent of: >
203 -c "source {file}"
204< It can be mixed with "-c" arguments and repeated like "-c".
205 The limit of 10 "-c" arguments applies here as well.
206 {file} cannot start with a "-".
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200207
208 Do not use this for running a script to do some work and exit
209 Vim, you won't see error messages. Use |-u| instead.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000210
211-S Works like "-S Session.vim". Only when used as the last
212 argument or when another "-" option follows.
213
214 *-r*
215-r Recovery mode. Without a file name argument, a list of
216 existing swap files is given. With a file name, a swap file
217 is read to recover a crashed editing session. See
218 |crash-recovery|.
219
220 *-L*
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200221-L Same as -r.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000222
223 *-R*
224-R Readonly mode. The 'readonly' option will be set for all the
225 files being edited. You can still edit the buffer, but will
226 be prevented from accidentally overwriting a file. If you
227 forgot that you are in View mode and did make some changes,
228 you can overwrite a file by adding an exclamation mark to
229 the Ex command, as in ":w!". The 'readonly' option can be
230 reset with ":set noro" (see the options chapter, |options|).
231 Subsequent edits will not be done in readonly mode. Calling
232 the executable "view" has the same effect as the -R argument.
233 The 'updatecount' option will be set to 10000, meaning that
234 the swap file will not be updated automatically very often.
Bram Moolenaar369b6f52017-01-17 12:22:32 +0100235 See |-M| for disallowing modifications.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000236
237 *-m*
238-m Modifications not allowed to be written. The 'write' option
239 will be reset, so that writing files is disabled. However,
240 the 'write' option can be set to enable writing again.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000241
242 *-M*
243-M Modifications not allowed. The 'modifiable' option will be
244 reset, so that changes are not allowed. The 'write' option
245 will be reset, so that writing files is disabled. However,
246 the 'modifiable' and 'write' options can be set to enable
247 changes and writing.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000248
Bram Moolenaar8c62a082019-02-08 14:34:10 +0100249 *-Z* *restricted-mode* *E145* *E981*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000250-Z Restricted mode. All commands that make use of an external
251 shell are disabled. This includes suspending with CTRL-Z,
Bram Moolenaar8c62a082019-02-08 14:34:10 +0100252 ":sh", filtering, the system() function, backtick expansion
253 and libcall().
254 Also disallowed are delete(), rename(), mkdir(), job_start(),
255 etc.
256 Interfaces, such as Python, Ruby and Lua, are also disabled,
257 since they could be used to execute shell commands. Perl uses
258 the Safe module.
259 Note that the user may still find a loophole to execute a
260 shell command, it has only been made difficult.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000261
262 *-g*
Bram Moolenaar61d35bd2012-03-28 20:51:51 +0200263-g Start Vim in GUI mode. See |gui|. For the opposite see |-v|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000264
265 *-v*
266-v Start Ex in Vi mode. Only makes a difference when the
267 executable is called "ex" or "gvim". For gvim the GUI is not
268 started if possible.
269
270 *-e*
271-e Start Vim in Ex mode |Q|. Only makes a difference when the
272 executable is not called "ex".
273
274 *-E*
275-E Start Vim in improved Ex mode |gQ|. Only makes a difference
276 when the executable is not called "exim".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000277
278 *-s-ex*
279-s Silent or batch mode. Only when Vim was started as "ex" or
280 when preceded with the "-e" argument. Otherwise see |-s|,
281 which does take an argument while this use of "-s" doesn't.
282 To be used when Vim is used to execute Ex commands from a file
283 instead of a terminal. Switches off most prompts and
284 informative messages. Also warnings and error messages.
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000285 The output of these commands is displayed (to stdout):
286 :print
287 :list
288 :number
289 :set to display option values.
290 When 'verbose' is non-zero messages are printed (for
291 debugging, to stderr).
292 'term' and $TERM are not used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000293 If Vim appears to be stuck try typing "qa!<Enter>". You don't
294 get a prompt thus you can't see Vim is waiting for you to type
295 something.
296 Initializations are skipped (except the ones given with the
297 "-u" argument).
298 Example: >
299 vim -e -s < thefilter thefile
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200300< For the opposite, to see errors from the script, execute the
301 file with the |-u| flag: >
302 vim -u thefilter thefile
Bram Moolenaar071d4272004-06-13 20:20:40 +0000303<
304 *-b*
305-b Binary mode. File I/O will only recognize <NL> to separate
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000306 lines. The 'expandtab' option will be reset. The 'textwidth'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000307 option is set to 0. 'modeline' is reset. The 'binary' option
308 is set. This is done after reading the vimrc/exrc files but
309 before reading any file in the arglist. See also
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200310 |edit-binary|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000311
312 *-l*
313-l Lisp mode. Sets the 'lisp' and 'showmatch' options on.
314
315 *-A*
Bram Moolenaar30e9b3c2019-09-07 16:24:12 +0200316-A Arabic mode. Sets the 'arabic' option on. {only when
Bram Moolenaar071d4272004-06-13 20:20:40 +0000317 compiled with the |+arabic| features (which include
318 |+rightleft|), otherwise Vim gives an error message
Bram Moolenaar30e9b3c2019-09-07 16:24:12 +0200319 and exits}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000320
321 *-F*
Bram Moolenaar14184a32019-02-16 15:10:30 +0100322-F This was used for Farsi mode, which has been removed.
323 See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000324
325 *-H*
326-H Hebrew mode. Sets the 'hkmap' and 'rightleft' options on.
Bram Moolenaar30e9b3c2019-09-07 16:24:12 +0200327 {only when compiled with the |+rightleft| feature, otherwise
328 Vim gives an error message and exits}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000329
330 *-V* *verbose*
331-V[N] Verbose. Sets the 'verbose' option to [N] (default: 10).
332 Messages will be given for each file that is ":source"d and
333 for reading or writing a viminfo file. Can be used to find
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200334 out what is happening upon startup and exit.
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000335 Example: >
336 vim -V8 foobar
Bram Moolenaar071d4272004-06-13 20:20:40 +0000337
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000338-V[N]{filename}
339 Like -V and set 'verbosefile' to {filename}. The result is
340 that messages are not displayed but written to the file
341 {filename}. {filename} must not start with a digit.
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000342 Example: >
343 vim -V20vimlog foobar
344<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000345 *-D*
346-D Debugging. Go to debugging mode when executing the first
347 command from a script. |debug-mode|
348 {not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000349
350 *-C*
351-C Compatible mode. Sets the 'compatible' option. You can use
352 this to get 'compatible', even though a .vimrc file exists.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100353 Keep in mind that the command ":set nocompatible" in some
354 plugin or startup script overrules this, so you may end up
Bram Moolenaar6dfc28b2010-02-11 14:19:15 +0100355 with 'nocompatible' anyway. To find out, use: >
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100356 :verbose set compatible?
357< Several plugins won't work with 'compatible' set. You may
358 want to set it after startup this way: >
359 vim "+set cp" filename
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200360< Also see |compatible-default|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000361
362 *-N*
363-N Not compatible mode. Resets the 'compatible' option. You can
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100364 use this to get 'nocompatible', when there is no .vimrc file
365 or when using "-u NONE".
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200366 Also see |compatible-default|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000367
368 *-y* *easy*
369-y Easy mode. Implied for |evim| and |eview|. Starts with
370 'insertmode' set and behaves like a click-and-type editor.
371 This sources the script $VIMRUNTIME/evim.vim. Mappings are
372 set up to work like most click-and-type editors, see
373 |evim-keys|. The GUI is started when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000374
375 *-n*
376-n No swap file will be used. Recovery after a crash will be
377 impossible. Handy if you want to view or edit a file on a
378 very slow medium (e.g., a floppy).
379 Can also be done with ":set updatecount=0". You can switch it
380 on again by setting the 'updatecount' option to some value,
381 e.g., ":set uc=100".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100382 NOTE: Don't combine -n with -b, making -nb, because that has a
383 different meaning: |-nb|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000384 'updatecount' is set to 0 AFTER executing commands from a
385 vimrc file, but before the GUI initializations. Thus it
386 overrides a setting for 'updatecount' in a vimrc file, but not
387 in a gvimrc file. See |startup|.
388 When you want to reduce accesses to the disk (e.g., for a
389 laptop), don't use "-n", but set 'updatetime' and
390 'updatecount' to very big numbers, and type ":preserve" when
391 you want to save your work. This way you keep the possibility
392 for crash recovery.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000393
394 *-o*
395-o[N] Open N windows, split horizontally. If [N] is not given,
396 one window is opened for every file given as argument. If
397 there is not enough room, only the first few files get a
398 window. If there are more windows than arguments, the last
399 few windows will be editing an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000400
401 *-O*
402-O[N] Open N windows, split vertically. Otherwise it's like -o.
403 If both the -o and the -O option are given, the last one on
404 the command line determines how the windows will be split.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000405
Bram Moolenaar7e8fd632006-02-18 22:14:51 +0000406 *-p*
407-p[N] Open N tab pages. If [N] is not given, one tab page is opened
Bram Moolenaarfd2ac762006-03-01 22:09:21 +0000408 for every file given as argument. The maximum is set with
409 'tabpagemax' pages (default 10). If there are more tab pages
410 than arguments, the last few tab pages will be editing an
Bram Moolenaarfa1d1402006-03-25 21:59:56 +0000411 empty file. Also see |tabpage|.
Bram Moolenaar7e8fd632006-02-18 22:14:51 +0000412
Bram Moolenaar071d4272004-06-13 20:20:40 +0000413 *-T*
414-T {terminal} Set the terminal type to "terminal". This influences the
415 codes that Vim will send to your terminal. This is normally
416 not needed, because Vim will be able to find out what type
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200417 of terminal you are using. (See |terminal-info|.)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000418
Bram Moolenaardae8d212016-02-27 22:40:16 +0100419 *--not-a-term*
Bram Moolenaar49c39ff2016-02-25 21:21:52 +0100420--not-a-term Tells Vim that the user knows that the input and/or output is
421 not connected to a terminal. This will avoid the warning and
Bram Moolenaara2a80162017-11-21 23:09:50 +0100422 the two second delay that would happen.
423 Also avoids the "Reading from stdin..." message.
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200424 Also avoids the "N files to edit" message.
Bram Moolenaar49c39ff2016-02-25 21:21:52 +0100425
Bram Moolenaar2cab0e12016-11-24 15:09:07 +0100426 *--ttyfail*
427--ttyfail When the stdin or stdout is not a terminal (tty) then exit
428 right away.
429
Bram Moolenaar071d4272004-06-13 20:20:40 +0000430 *-d*
431-d Start in diff mode, like |vimdiff|.
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200432 {not available when compiled without the |+diff| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000433
434-d {device} Only on the Amiga and when not compiled with the |+diff|
435 feature. Works like "-dev".
436 *-dev*
437-dev {device} Only on the Amiga: The {device} is opened to be used for
438 editing.
439 Normally you would use this to set the window position and
440 size: "-d con:x/y/width/height", e.g.,
441 "-d con:30/10/600/150". But you can also use it to start
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200442 editing on another device, e.g., AUX:.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000443 *-f*
Bram Moolenaar5302d9e2011-09-14 17:55:08 +0200444-f GUI: Do not disconnect from the program that started Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000445 'f' stands for "foreground". If omitted, the GUI forks a new
446 process and exits the current one. "-f" should be used when
447 gvim is started by a program that will wait for the edit
448 session to finish (e.g., mail or readnews). If you want gvim
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000449 never to fork, include 'f' in 'guioptions' in your |gvimrc|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000450 Careful: You can use "-gf" to start the GUI in the foreground,
451 but "-fg" is used to specify the foreground color. |gui-fork|
Bram Moolenaar5302d9e2011-09-14 17:55:08 +0200452
453 Amiga: Do not restart Vim to open a new window. This
454 option should be used when Vim is started by a program that
455 will wait for the edit session to finish (e.g., mail or
456 readnews). See |amiga-window|.
Bram Moolenaare6ae6222013-05-21 21:01:10 +0200457
Bram Moolenaar543b7ef2013-06-01 14:50:56 +0200458 MS-Windows: This option is not supported. However, when
459 running Vim with an installed vim.bat or gvim.bat file it
460 works.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000461
Bram Moolenaar5302d9e2011-09-14 17:55:08 +0200462
Bram Moolenaar071d4272004-06-13 20:20:40 +0000463 *--nofork*
464--nofork GUI: Do not fork. Same as |-f|.
465 *-u* *E282*
466-u {vimrc} The file {vimrc} is read for initializations. Most other
Bram Moolenaarc4da1132017-07-15 19:39:43 +0200467 initializations are skipped; see |initialization|.
468
469 This can be used to start Vim in a special mode, with special
Bram Moolenaar071d4272004-06-13 20:20:40 +0000470 mappings and settings. A shell alias can be used to make
471 this easy to use. For example: >
472 alias vimc vim -u ~/.c_vimrc !*
473< Also consider using autocommands; see |autocommand|.
Bram Moolenaarc4da1132017-07-15 19:39:43 +0200474
Bram Moolenaar071d4272004-06-13 20:20:40 +0000475 When {vimrc} is equal to "NONE" (all uppercase), all
476 initializations from files and environment variables are
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000477 skipped, including reading the |gvimrc| file when the GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +0000478 starts. Loading plugins is also skipped.
Bram Moolenaarc4da1132017-07-15 19:39:43 +0200479
Bram Moolenaar071d4272004-06-13 20:20:40 +0000480 When {vimrc} is equal to "NORC" (all uppercase), this has the
481 same effect as "NONE", but loading plugins is not skipped.
Bram Moolenaarc4da1132017-07-15 19:39:43 +0200482
483 When {vimrc} is equal to "DEFAULTS" (all uppercase), this has
484 the same effect as "NONE", but the |defaults.vim| script is
Bram Moolenaard473c8c2018-08-11 18:00:22 +0200485 loaded, which will also set 'nocompatible'. Also see
486 |--clean|.
Bram Moolenaarc4da1132017-07-15 19:39:43 +0200487
488 Using the "-u" argument with another argument than DEFAULTS
489 has the side effect that the 'compatible' option will be on by
490 default. This can have unexpected effects. See
491 |'compatible'|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000492
493 *-U* *E230*
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000494-U {gvimrc} The file {gvimrc} is read for initializations when the GUI
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000495 starts. Other GUI initializations are skipped. When {gvimrc}
Bram Moolenaar8fc061c2004-12-29 21:03:02 +0000496 is equal to "NONE", no file is read for GUI initializations at
497 all. |gui-init|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000498 Exception: Reading the system-wide menu file is always done.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000499
500 *-i*
501-i {viminfo} The file "viminfo" is used instead of the default viminfo
502 file. If the name "NONE" is used (all uppercase), no viminfo
503 file is read or written, even if 'viminfo' is set or when
504 ":rv" or ":wv" are used. See also |viminfo-file|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000505
Bram Moolenaarc4da1132017-07-15 19:39:43 +0200506 *--clean*
Bram Moolenaara9604e62018-07-21 05:56:22 +0200507--clean Similar to "-u DEFAULTS -U NONE -i NONE":
Bram Moolenaarc4da1132017-07-15 19:39:43 +0200508 - initializations from files and environment variables is
509 skipped
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +0100510 - 'runtimepath' and 'packpath' are set to exclude home
Bram Moolenaara9604e62018-07-21 05:56:22 +0200511 directory entries (does not happen with -u DEFAULTS).
Bram Moolenaarc4da1132017-07-15 19:39:43 +0200512 - the |defaults.vim| script is loaded, which implies
513 'nocompatible': use Vim defaults
Bram Moolenaar62dd4522018-03-14 21:20:02 +0100514 - no |gvimrc| script is loaded
Bram Moolenaarc4da1132017-07-15 19:39:43 +0200515 - no viminfo file is read or written
Bram Moolenaard473c8c2018-08-11 18:00:22 +0200516
Bram Moolenaar071d4272004-06-13 20:20:40 +0000517 *-x*
518-x Use encryption to read/write files. Will prompt for a key,
519 which is then stored in the 'key' option. All writes will
520 then use this key to encrypt the text. The '-x' argument is
521 not needed when reading a file, because there is a check if
522 the file that is being read has been encrypted, and Vim asks
523 for a key automatically. |encryption|
524
525 *-X*
526-X Do not try connecting to the X server to get the current
527 window title and copy/paste using the X clipboard. This
528 avoids a long startup time when running Vim in a terminal
529 emulator and the connection to the X server is slow.
Bram Moolenaar3f269672009-11-03 11:11:11 +0000530 See |--startuptime| to find out if affects you.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000531 Only makes a difference on Unix or VMS, when compiled with the
532 |+X11| feature. Otherwise it's ignored.
533 To disable the connection only for specific terminals, see the
534 'clipboard' option.
535 When the X11 Session Management Protocol (XSMP) handler has
536 been built in, the -X option also disables that connection as
537 it, too, may have undesirable delays.
538 When the connection is desired later anyway (e.g., for
539 client-server messages), call the |serverlist()| function.
540 This does not enable the XSMP handler though.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000541
542 *-s*
543-s {scriptin} The script file "scriptin" is read. The characters in the
544 file are interpreted as if you had typed them. The same can
545 be done with the command ":source! {scriptin}". If the end
546 of the file is reached before the editor exits, further
547 characters are read from the keyboard. Only works when not
548 started in Ex mode, see |-s-ex|. See also |complex-repeat|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000549
Bram Moolenaar4399ef42005-02-12 14:29:27 +0000550 *-w_nr*
551-w {number}
552-w{number} Set the 'window' option to {number}.
553
Bram Moolenaar071d4272004-06-13 20:20:40 +0000554 *-w*
555-w {scriptout} All the characters that you type are recorded in the file
556 "scriptout", until you exit Vim. This is useful if you want
557 to create a script file to be used with "vim -s" or
558 ":source!". When the "scriptout" file already exists, new
559 characters are appended. See also |complex-repeat|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +0000560 {scriptout} cannot start with a digit.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000561
562 *-W*
563-W {scriptout} Like -w, but do not append, overwrite an existing file.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000564
Bram Moolenaar071d4272004-06-13 20:20:40 +0000565--remote [+{cmd}] {file} ...
566 Open the {file} in another Vim that functions as a server.
567 Any non-file arguments must come before this.
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200568 See |--remote|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000569
570--remote-silent [+{cmd}] {file} ...
571 Like --remote, but don't complain if there is no server.
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200572 See |--remote-silent|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000573
574--remote-wait [+{cmd}] {file} ...
575 Like --remote, but wait for the server to finish editing the
576 file(s).
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200577 See |--remote-wait|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000578
579--remote-wait-silent [+{cmd}] {file} ...
580 Like --remote-wait, but don't complain if there is no server.
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200581 See |--remote-wait-silent|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000582
583--servername {name}
584 Specify the name of the Vim server to send to or to become.
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200585 See |--servername|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000586
587--remote-send {keys}
588 Send {keys} to a Vim server and exit.
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200589 See |--remote-send|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000590
591--remote-expr {expr}
592 Evaluate {expr} in another Vim that functions as a server.
593 The result is printed on stdout.
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200594 See |--remote-expr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000595
596--serverlist Output a list of Vim server names and exit. See
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200597 |--serverlist|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000598
599--socketid {id} *--socketid*
600 GTK+ GUI Vim only. Make gvim try to use GtkPlug mechanism, so
601 that it runs inside another window. See |gui-gtk-socketid|
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200602 for details.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000603
Bram Moolenaar78e17622007-08-30 10:26:19 +0000604--windowid {id} *--windowid*
605 Win32 GUI Vim only. Make gvim try to use the window {id} as a
606 parent, so that it runs inside that window. See
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200607 |gui-w32-windowid| for details.
Bram Moolenaar78e17622007-08-30 10:26:19 +0000608
Bram Moolenaar071d4272004-06-13 20:20:40 +0000609--echo-wid *--echo-wid*
610 GTK+ GUI Vim only. Make gvim echo the Window ID on stdout,
611 which can be used to run gvim in a kpart widget. The format
612 of the output is: >
613 WID: 12345\n
Bram Moolenaar071d4272004-06-13 20:20:40 +0000614
615--role {role} *--role*
616 GTK+ 2 GUI only. Set the role of the main window to {role}.
617 The window role can be used by a window manager to uniquely
618 identify a window, in order to restore window placement and
619 such. The --role argument is passed automatically when
620 restoring the session on login. See |gui-gnome-session|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000621
622-P {parent-title} *-P* *MDI* *E671* *E672*
623 Win32 only: Specify the title of the parent application. When
624 possible, Vim will run in an MDI window inside the
625 application.
626 {parent-title} must appear in the window title of the parent
627 application. Make sure that it is specific enough.
628 Note that the implementation is still primitive. It won't
629 work with all applications and the menu doesn't work.
630
631-nb *-nb*
632-nb={fname}
633-nb:{hostname}:{addr}:{password}
634 Attempt connecting to Netbeans and become an editor server for
635 it. The second form specifies a file to read connection info
636 from. The third form specifies the hostname, address and
637 password for connecting to Netbeans. |netbeans-run|
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100638 {only available when compiled with the |+netbeans_intg|
639 feature; if not then -nb will make Vim exit}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000640
641If the executable is called "view", Vim will start in Readonly mode. This is
642useful if you can make a hard or symbolic link from "view" to "vim".
643Starting in Readonly mode can also be done with "vim -R".
644
645If the executable is called "ex", Vim will start in "Ex" mode. This means it
646will accept only ":" commands. But when the "-v" argument is given, Vim will
647start in Normal mode anyway.
648
649Additional arguments are available on unix like systems when compiled with
650X11 GUI support. See |gui-resources|.
651
652==============================================================================
6532. Vim on the Amiga *starting-amiga*
654
655Starting Vim from the Workbench *workbench*
656-------------------------------
657
658Vim can be started from the Workbench by clicking on its icon twice. It will
659then start with an empty buffer.
660
661Vim can be started to edit one or more files by using a "Project" icon. The
662"Default Tool" of the icon must be the full pathname of the Vim executable.
663The name of the ".info" file must be the same as the name of the text file.
664By clicking on this icon twice, Vim will be started with the file name as
665current file name, which will be read into the buffer (if it exists). You can
666edit multiple files by pressing the shift key while clicking on icons, and
667clicking twice on the last one. The "Default Tool" for all these icons must
668be the same.
669
670It is not possible to give arguments to Vim, other than file names, from the
671workbench.
672
673Vim window *amiga-window*
674----------
675
676Vim will run in the CLI window where it was started. If Vim was started with
677the "run" or "runback" command, or if Vim was started from the workbench, it
678will open a window of its own.
679
680Technical detail:
681 To open the new window a little trick is used. As soon as Vim
682 recognizes that it does not run in a normal CLI window, it will
683 create a script file in "t:". This script file contains the same
684 command as the one Vim was started with, and an "endcli" command.
685 This script file is then executed with a "newcli" command (the "c:run"
686 and "c:newcli" commands are required for this to work). The script
687 file will hang around until reboot, or until you delete it. This
688 method is required to get the ":sh" and ":!" commands to work
689 correctly. But when Vim was started with the -f option (foreground
690 mode), this method is not used. The reason for this is that
691 when a program starts Vim with the -f option it will wait for Vim to
692 exit. With the script trick, the calling program does not know when
693 Vim exits. The -f option can be used when Vim is started by a mail
694 program which also waits for the edit session to finish. As a
695 consequence, the ":sh" and ":!" commands are not available when the
696 -f option is used.
697
698Vim will automatically recognize the window size and react to window
699resizing. Under Amiga DOS 1.3, it is advised to use the fastfonts program,
700"FF", to speed up display redrawing.
701
702==============================================================================
7033. Running eVim *evim-keys*
704
705EVim runs Vim as click-and-type editor. This is very unlike the original Vi
706idea. But it helps for people that don't use Vim often enough to learn the
707commands. Hopefully they will find out that learning to use Normal mode
708commands will make their editing much more effective.
709
710In Evim these options are changed from their default value:
711
712 :set nocompatible Use Vim improvements
713 :set insertmode Remain in Insert mode most of the time
714 :set hidden Keep invisible buffers loaded
715 :set backup Keep backup files (not for VMS)
716 :set backspace=2 Backspace over everything
717 :set autoindent auto-indent new lines
718 :set history=50 keep 50 lines of Ex commands
719 :set ruler show the cursor position
720 :set incsearch show matches halfway typing a pattern
721 :set mouse=a use the mouse in all modes
722 :set hlsearch highlight all matches for a search pattern
723 :set whichwrap+=<,>,[,] <Left> and <Right> wrap around line breaks
724 :set guioptions-=a non-Unix only: don't do auto-select
725
726Key mappings:
727 <Down> moves by screen lines rather than file lines
728 <Up> idem
729 Q does "gq", formatting, instead of Ex mode
730 <BS> in Visual mode: deletes the selection
731 CTRL-X in Visual mode: Cut to clipboard
732 <S-Del> idem
733 CTRL-C in Visual mode: Copy to clipboard
734 <C-Insert> idem
735 CTRL-V Pastes from the clipboard (in any mode)
736 <S-Insert> idem
737 CTRL-Q do what CTRL-V used to do
738 CTRL-Z undo
739 CTRL-Y redo
740 <M-Space> system menu
741 CTRL-A select all
742 <C-Tab> next window, CTRL-W w
743 <C-F4> close window, CTRL-W c
744
745Additionally:
746- ":behave mswin" is used |:behave|
747- syntax highlighting is enabled
748- filetype detection is enabled, filetype plugins and indenting is enabled
749- in a text file 'textwidth' is set to 78
750
751One hint: If you want to go to Normal mode to be able to type a sequence of
752commands, use CTRL-L. |i_CTRL-L|
753
754==============================================================================
7554. Initialization *initialization* *startup*
756
757This section is about the non-GUI version of Vim. See |gui-fork| for
758additional initialization when starting the GUI.
759
760At startup, Vim checks environment variables and files and sets values
761accordingly. Vim proceeds in this order:
762
7631. Set the 'shell' and 'term' option *SHELL* *COMSPEC* *TERM*
764 The environment variable SHELL, if it exists, is used to set the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100765 'shell' option. On Win32, the COMSPEC variable is used
Bram Moolenaar071d4272004-06-13 20:20:40 +0000766 if SHELL is not set.
767 The environment variable TERM, if it exists, is used to set the 'term'
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000768 option. However, 'term' will change later when starting the GUI (step
769 8 below).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000770
7712. Process the arguments
772 The options and file names from the command that start Vim are
773 inspected. Buffers are created for all files (but not loaded yet).
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000774 The |-V| argument can be used to display or log what happens next,
775 useful for debugging the initializations.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000776
7773. Execute Ex commands, from environment variables and/or files
778 An environment variable is read as one Ex command line, where multiple
779 commands must be separated with '|' or "<NL>".
780 *vimrc* *exrc*
781 A file that contains initialization commands is called a "vimrc" file.
782 Each line in a vimrc file is executed as an Ex command line. It is
783 sometimes also referred to as "exrc" file. They are the same type of
784 file, but "exrc" is what Vi always used, "vimrc" is a Vim specific
785 name. Also see |vimrc-intro|.
786
Bram Moolenaarec7944a2013-06-12 21:29:15 +0200787 Places for your personal initializations:
788 Unix $HOME/.vimrc or $HOME/.vim/vimrc
Bram Moolenaarec7944a2013-06-12 21:29:15 +0200789 MS-Windows $HOME/_vimrc, $HOME/vimfiles/vimrc
790 or $VIM/_vimrc
791 Amiga s:.vimrc, home:.vimrc, home:vimfiles:vimrc
792 or $VIM/.vimrc
793
794 The files are searched in the order specified above and only the first
795 one that is found is read.
796
797 RECOMMENDATION: Put all your Vim configuration stuff in the
798 $HOME/.vim/ directory ($HOME/vimfiles/ for MS-Windows). That makes it
799 easy to copy it to another system.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000800
801 If Vim was started with "-u filename", the file "filename" is used.
Bram Moolenaare2db6952013-07-24 19:53:36 +0200802 All following initializations until 4. are skipped. $MYVIMRC is not
803 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000804 "vim -u NORC" can be used to skip these initializations without
805 reading a file. "vim -u NONE" also skips loading plugins. |-u|
806
807 If Vim was started in Ex mode with the "-s" argument, all following
808 initializations until 4. are skipped. Only the "-u" option is
809 interpreted.
810 *evim.vim*
811 a. If vim was started as |evim| or |eview| or with the |-y| argument, the
812 script $VIMRUNTIME/evim.vim will be loaded.
813 *system-vimrc*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100814 b. For Unix, MS-Windows, VMS, Macintosh and Amiga the system vimrc file
815 is read for initializations. The path of this file is shown with the
816 ":version" command. Mostly it's "$VIM/vimrc". Note that this file is
817 ALWAYS read in 'compatible' mode, since the automatic resetting of
818 'compatible' is only done later. Add a ":set nocp" command if you
819 like. For the Macintosh the $VIMRUNTIME/macmap.vim is read.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000820
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100821 *VIMINIT* *.vimrc* *_vimrc* *EXINIT* *.exrc* *_exrc* *$MYVIMRC*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200822 c. Five places are searched for initializations. The first that exists
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000823 is used, the others are ignored. The $MYVIMRC environment variable is
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100824 set to the file that was first found, unless $MYVIMRC was already set
825 and when using VIMINIT.
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200826 I The environment variable VIMINIT (see also |compatible-default|) (*)
827 The value of $VIMINIT is used as an Ex command line.
828 II The user vimrc file(s):
Bram Moolenaar6f345a12019-12-17 21:27:18 +0100829 "$HOME/.vimrc" (for Unix) (*)
830 "$HOME/.vim/vimrc" (for Unix) (*)
Bram Moolenaarec7944a2013-06-12 21:29:15 +0200831 "s:.vimrc" (for Amiga) (*)
832 "home:.vimrc" (for Amiga) (*)
833 "home:vimfiles:vimrc" (for Amiga) (*)
Bram Moolenaar6f345a12019-12-17 21:27:18 +0100834 "$VIM/.vimrc" (for Amiga) (*)
835 "$HOME/_vimrc" (for Win32) (*)
836 "$HOME/vimfiles/vimrc" (for Win32) (*)
837 "$VIM/_vimrc" (for Win32) (*)
838 Note: For Unix and Amiga, when ".vimrc" does not exist,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000839 "_vimrc" is also tried, in case an MS-DOS compatible file
Bram Moolenaar6f345a12019-12-17 21:27:18 +0100840 system is used. For MS-Windows ".vimrc" is checked after
841 "_vimrc", in case long file names are used.
842 Note: For Win32, "$HOME" is checked first. If no "_vimrc" or
843 ".vimrc" is found there, "$VIM" is tried. See |$VIM| for when
844 $VIM is not set.
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200845 III The environment variable EXINIT.
846 The value of $EXINIT is used as an Ex command line.
847 IV The user exrc file(s). Same as for the user vimrc file, but with
848 "vimrc" replaced by "exrc". But only one of ".exrc" and "_exrc" is
849 used, depending on the system. And without the (*)!
850 V The default vimrc file, $VIMRUNTIME/defaults.vim. This sets up
851 options values and has "syntax on" and "filetype on" commands,
852 which is what most new users will want. See |defaults.vim|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000853
Bram Moolenaar36f44c22016-08-28 18:17:20 +0200854 d. If the 'exrc' option is on (which is NOT the default), the current
Bram Moolenaar5c5474b2005-04-19 21:40:26 +0000855 directory is searched for three files. The first that exists is used,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000856 the others are ignored.
Bram Moolenaar6f345a12019-12-17 21:27:18 +0100857 - The file ".vimrc" (for Unix, Amiga) (*)
858 "_vimrc" (for Win32) (*)
859 - The file "_vimrc" (for Unix, Amiga) (*)
860 ".vimrc" (for Win32) (*)
861 - The file ".exrc" (for Unix, Amiga)
862 "_exrc" (for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000863
864 (*) Using this file or environment variable will cause 'compatible' to be
865 off by default. See |compatible-default|.
866
Bram Moolenaarb0d45e72017-11-05 18:19:24 +0100867 Note: When using the |mzscheme| interface, it is initialized after loading
Bram Moolenaar01164a62017-11-02 22:58:42 +0100868 the vimrc file. Changing 'mzschemedll' later has no effect.
869
Bram Moolenaar071d4272004-06-13 20:20:40 +00008704. Load the plugin scripts. *load-plugins*
871 This does the same as the command: >
Bram Moolenaar1c7715d2005-10-03 22:02:18 +0000872 :runtime! plugin/**/*.vim
Bram Moolenaar071d4272004-06-13 20:20:40 +0000873< The result is that all directories in the 'runtimepath' option will be
874 searched for the "plugin" sub-directory and all files ending in ".vim"
Bram Moolenaar1c7715d2005-10-03 22:02:18 +0000875 will be sourced (in alphabetical order per directory), also in
876 subdirectories.
Bram Moolenaar66459b72016-08-06 19:01:55 +0200877 However, directories in 'runtimepath' ending in "after" are skipped
878 here and only loaded after packages, see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000879 Loading plugins won't be done when:
880 - The 'loadplugins' option was reset in a vimrc file.
881 - The |--noplugin| command line argument is used.
Bram Moolenaarc4da1132017-07-15 19:39:43 +0200882 - The |--clean| command line argument is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000883 - The "-u NONE" command line argument is used |-u|.
884 - When Vim was compiled without the |+eval| feature.
Bram Moolenaar8ada17c2006-01-19 22:16:24 +0000885 Note that using "-c 'set noloadplugins'" doesn't work, because the
886 commands from the command line have not been executed yet. You can
Bram Moolenaar66459b72016-08-06 19:01:55 +0200887 use "--cmd 'set noloadplugins'" or "--cmd 'set loadplugins'" |--cmd|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000888
Bram Moolenaar03413f42016-04-12 21:07:15 +0200889 Packages are loaded. These are plugins, as above, but found in the
890 "start" directory of each entry in 'packpath'. Every plugin directory
891 found is added in 'runtimepath' and then the plugins are sourced. See
892 |packages|.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +0100893
Bram Moolenaar66459b72016-08-06 19:01:55 +0200894 The plugins scripts are loaded, as above, but now only the directories
895 ending in "after" are used. Note that 'runtimepath' will have changed
896 if packages have been found, but that should not add a directory
897 ending in "after".
898
Bram Moolenaar071d4272004-06-13 20:20:40 +00008995. Set 'shellpipe' and 'shellredir'
900 The 'shellpipe' and 'shellredir' options are set according to the
901 value of the 'shell' option, unless they have been set before.
902 This means that Vim will figure out the values of 'shellpipe' and
903 'shellredir' for you, unless you have set them yourself.
904
9056. Set 'updatecount' to zero, if "-n" command argument used
906
9077. Set binary options
908 If the "-b" flag was given to Vim, the options for binary editing will
909 be set now. See |-b|.
910
9118. Perform GUI initializations
912 Only when starting "gvim", the GUI initializations will be done. See
913 |gui-init|.
914
9159. Read the viminfo file
916 If the 'viminfo' option is not empty, the viminfo file is read. See
917 |viminfo-file|.
918
91910. Read the quickfix file
920 If the "-q" flag was given to Vim, the quickfix file is read. If this
921 fails, Vim exits.
922
92311. Open all windows
924 When the |-o| flag was given, windows will be opened (but not
925 displayed yet).
Bram Moolenaar7e8fd632006-02-18 22:14:51 +0000926 When the |-p| flag was given, tab pages will be created (but not
927 displayed yet).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000928 When switching screens, it happens now. Redrawing starts.
929 If the "-q" flag was given to Vim, the first error is jumped to.
Bram Moolenaar469bdbd2019-12-11 23:05:48 +0100930 Buffers for all windows will be loaded, without triggering |BufAdd|
931 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000932
93312. Execute startup commands
934 If a "-t" flag was given to Vim, the tag is jumped to.
935 The commands given with the |-c| and |+cmd| arguments are executed.
936 If the 'insertmode' option is set, Insert mode is entered.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +0100937 The starting flag is reset, has("vim_starting") will now return zero.
938 The |v:vim_did_enter| variable is set to 1.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000939 The |VimEnter| autocommands are executed.
940
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200941The $MYVIMRC or $MYGVIMRC file will be set to the first found vimrc and/or
942gvimrc file.
943
Bram Moolenaar7b668e82016-08-23 23:51:21 +0200944
945Some hints on using initializations ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000946
947Standard setup:
948Create a vimrc file to set the default settings and mappings for all your edit
949sessions. Put it in a place so that it will be found by 3b:
Bram Moolenaar6f345a12019-12-17 21:27:18 +0100950 ~/.vimrc (Unix)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000951 s:.vimrc (Amiga)
Bram Moolenaar6f345a12019-12-17 21:27:18 +0100952 $VIM\_vimrc (Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000953Note that creating a vimrc file will cause the 'compatible' option to be off
954by default. See |compatible-default|.
955
956Local setup:
957Put all commands that you need for editing a specific directory only into a
958vimrc file and place it in that directory under the name ".vimrc" ("_vimrc"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100959for Win32). NOTE: To make Vim look for these special files you have to turn
960on the option 'exrc'. See |trojan-horse| too.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000961
962System setup:
963This only applies if you are managing a Unix system with several users and
964want to set the defaults for all users. Create a vimrc file with commands
965for default settings and mappings and put it in the place that is given with
966the ":version" command.
967
Bram Moolenaar7b668e82016-08-23 23:51:21 +0200968
969Saving the current state of Vim to a file ~
970
Bram Moolenaar071d4272004-06-13 20:20:40 +0000971Whenever you have changed values of options or when you have created a
972mapping, then you may want to save them in a vimrc file for later use. See
973|save-settings| about saving the current state of settings to a file.
974
Bram Moolenaar7b668e82016-08-23 23:51:21 +0200975
976Avoiding setup problems for Vi users ~
977
Bram Moolenaar071d4272004-06-13 20:20:40 +0000978Vi uses the variable EXINIT and the file "~/.exrc". So if you do not want to
979interfere with Vi, then use the variable VIMINIT and the file "vimrc" instead.
980
Bram Moolenaar7b668e82016-08-23 23:51:21 +0200981
982Amiga environment variables ~
983
Bram Moolenaar071d4272004-06-13 20:20:40 +0000984On the Amiga, two types of environment variables exist. The ones set with the
985DOS 1.3 (or later) setenv command are recognized. See the AmigaDos 1.3
986manual. The environment variables set with the old Manx Set command (before
987version 5.0) are not recognized.
988
Bram Moolenaar7b668e82016-08-23 23:51:21 +0200989
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100990MS-Windows line separators ~
Bram Moolenaar7b668e82016-08-23 23:51:21 +0200991
Bram Moolenaar6f345a12019-12-17 21:27:18 +0100992On MS-Windows, Vim assumes that all the vimrc files have <CR> <NL> pairs as
993line separators. This will give problems if you have a file with only <NL>s
994and have a line like ":map xx yy^M". The trailing ^M will be ignored.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000995
Bram Moolenaar7b668e82016-08-23 23:51:21 +0200996
997Vi compatible default value ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000998 *compatible-default*
999When Vim starts, the 'compatible' option is on. This will be used when Vim
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001000starts its initializations. But as soon as:
1001- a user vimrc file is found, or
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001002- a vimrc file in the current directory is found, or
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001003- the "VIMINIT" environment variable is set, or
1004- the "-N" command line argument is given, or
Bram Moolenaarc4da1132017-07-15 19:39:43 +02001005- the "--clean" command line argument is given, or
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001006- the |defaults.vim| script is loaded, or
Bram Moolenaar72540672018-02-09 22:00:53 +01001007- a gvimrc file was found,
1008then the option will be set to 'nocompatible'.
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001009
1010Note that this does NOT happen when a system-wide vimrc file was found.
1011
1012This has the side effect of setting or resetting other options (see
1013'compatible'). But only the options that have not been set or reset will be
1014changed. This has the same effect like the value of 'compatible' had this
1015value when starting Vim.
1016
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02001017'compatible' is NOT reset, and |defaults.vim| is not loaded:
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001018- when Vim was started with the |-u| command line argument, especially with
1019 "-u NONE", or
1020- when started with the |-C| command line argument, or
1021- when the name of the executable ends in "ex". (This has been done to make
1022 Vim behave like "ex", when it is started as "ex")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001023
1024But there is a side effect of setting or resetting 'compatible' at the moment
1025a .vimrc file is found: Mappings are interpreted the moment they are
1026encountered. This makes a difference when using things like "<CR>". If the
1027mappings depend on a certain value of 'compatible', set or reset it before
1028giving the mapping.
1029
Bram Moolenaar7b668e82016-08-23 23:51:21 +02001030
1031Defaults without a .vimrc file ~
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001032 *defaults.vim*
1033If Vim is started normally and no user vimrc file is found, the
Bram Moolenaar40962ec2018-01-28 22:47:25 +01001034$VIMRUNTIME/defaults.vim script is loaded. This will set 'compatible' off,
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001035switch on syntax highlighting and a few more things. See the script for
1036details. NOTE: this is done since Vim 8.0, not in Vim 7.4. (it was added in
1037patch 7.4.2111 to be exact).
1038
1039This should work well for new Vim users. If you create your own .vimrc, it is
Bram Moolenaar01164a62017-11-02 22:58:42 +01001040recommended to add these lines somewhere near the top: >
Bram Moolenaar7e1479b2016-09-11 15:07:27 +02001041 unlet! skip_defaults_vim
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001042 source $VIMRUNTIME/defaults.vim
1043Then Vim works like before you had a .vimrc. Copying $VIMRUNTIME/vimrc_example
1044is way to do this. Alternatively, you can copy defaults.vim to your .vimrc
Bram Moolenaar7e1479b2016-09-11 15:07:27 +02001045and modify it (but then you won't get updates when it changes).
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001046
1047If you don't like some of the defaults, you can still source defaults.vim and
1048revert individual settings. See the defaults.vim file for hints on how to
1049revert each item.
Bram Moolenaar7e1479b2016-09-11 15:07:27 +02001050 *skip_defaults_vim*
Bram Moolenaar64d8e252016-09-06 22:12:34 +02001051If you use a system-wide vimrc and don't want defaults.vim to change settings,
Bram Moolenaar7e1479b2016-09-11 15:07:27 +02001052set the "skip_defaults_vim" variable. If this was set and you want to load
1053defaults.vim from your .vimrc, first unlet skip_defaults_vim, as in the
1054example above.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02001055
Bram Moolenaar071d4272004-06-13 20:20:40 +00001056
Bram Moolenaar7b668e82016-08-23 23:51:21 +02001057Avoiding trojan horses ~
1058 *trojan-horse*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001059While reading the "vimrc" or the "exrc" file in the current directory, some
1060commands can be disabled for security reasons by setting the 'secure' option.
1061This is always done when executing the command from a tags file. Otherwise it
1062would be possible that you accidentally use a vimrc or tags file that somebody
1063else created and contains nasty commands. The disabled commands are the ones
1064that start a shell, the ones that write to a file, and ":autocmd". The ":map"
1065commands are echoed, so you can see which keys are being mapped.
1066 If you want Vim to execute all commands in a local vimrc file, you
1067can reset the 'secure' option in the EXINIT or VIMINIT environment variable or
1068in the global "exrc" or "vimrc" file. This is not possible in "vimrc" or
1069"exrc" in the current directory, for obvious reasons.
1070 On Unix systems, this only happens if you are not the owner of the
1071vimrc file. Warning: If you unpack an archive that contains a vimrc or exrc
1072file, it will be owned by you. You won't have the security protection. Check
1073the vimrc file before you start Vim in that directory, or reset the 'exrc'
1074option. Some Unix systems allow a user to do "chown" on a file. This makes
1075it possible for another user to create a nasty vimrc and make you the owner.
1076Be careful!
1077 When using tag search commands, executing the search command (the last
1078part of the line in the tags file) is always done in secure mode. This works
1079just like executing a command from a vimrc/exrc in the current directory.
1080
Bram Moolenaar7b668e82016-08-23 23:51:21 +02001081
1082If Vim startup is slow ~
Bram Moolenaar071d4272004-06-13 20:20:40 +00001083 *slow-start*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001084If Vim takes a long time to start up, use the |--startuptime| argument to find
1085out what happens. There are a few common causes:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001086- If the Unix version was compiled with the GUI and/or X11 (check the output
1087 of ":version" for "+GUI" and "+X11"), it may need to load shared libraries
1088 and connect to the X11 server. Try compiling a version with GUI and X11
1089 disabled. This also should make the executable smaller.
1090 Use the |-X| command line argument to avoid connecting to the X server when
1091 running in a terminal.
1092- If you have "viminfo" enabled, the loading of the viminfo file may take a
1093 while. You can find out if this is the problem by disabling viminfo for a
1094 moment (use the Vim argument "-i NONE", |-i|). Try reducing the number of
1095 lines stored in a register with ":set viminfo='20,<50,s10". |viminfo-file|.
1096
Bram Moolenaar7b668e82016-08-23 23:51:21 +02001097
1098Intro message ~
Bram Moolenaar071d4272004-06-13 20:20:40 +00001099 *:intro*
1100When Vim starts without a file name, an introductory message is displayed (for
1101those who don't know what Vim is). It is removed as soon as the display is
1102redrawn in any way. To see the message again, use the ":intro" command (if
1103there is not enough room, you will see only part of it).
1104 To avoid the intro message on startup, add the 'I' flag to 'shortmess'.
1105
1106 *info-message*
1107The |--help| and |--version| arguments cause Vim to print a message and then
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001108exit. Normally the message is sent to stdout, thus can be redirected to a
Bram Moolenaar071d4272004-06-13 20:20:40 +00001109file with: >
1110
1111 vim --help >file
1112
1113From inside Vim: >
1114
1115 :read !vim --help
1116
1117When using gvim, it detects that it might have been started from the desktop,
1118without a terminal to show messages on. This is detected when both stdout and
1119stderr are not a tty. This breaks the ":read" command, as used in the example
1120above. To make it work again, set 'shellredir' to ">" instead of the default
1121">&": >
1122
1123 :set shellredir=>
1124 :read !gvim --help
1125
1126This still won't work for systems where gvim does not use stdout at all
1127though.
1128
1129==============================================================================
11305. $VIM and $VIMRUNTIME
1131 *$VIM*
1132The environment variable "$VIM" is used to locate various user files for Vim,
1133such as the user startup script ".vimrc". This depends on the system, see
1134|startup|.
1135
1136To avoid the need for every user to set the $VIM environment variable, Vim
1137will try to get the value for $VIM in this order:
11381. The value defined by the $VIM environment variable. You can use this to
1139 make Vim look in a specific directory for its support files. Example: >
1140 setenv VIM /home/paul/vim
11412. The path from 'helpfile' is used, unless it contains some environment
1142 variable too (the default is "$VIMRUNTIME/doc/help.txt": chicken-egg
1143 problem). The file name ("help.txt" or any other) is removed. Then
1144 trailing directory names are removed, in this order: "doc", "runtime" and
Bram Moolenaar8024f932020-01-14 19:29:13 +01001145 "vim{version}" (e.g., "vim82").
Bram Moolenaar6f345a12019-12-17 21:27:18 +010011463. For Win32 Vim tries to use the directory name of the executable. If it
1147 ends in "/src", this is removed. This is useful if you unpacked the .zip
1148 file in some directory, and adjusted the search path to find the vim
1149 executable. Trailing directory names are removed, in this order: "runtime"
Bram Moolenaar8024f932020-01-14 19:29:13 +01001150 and "vim{version}" (e.g., "vim82").
Bram Moolenaar071d4272004-06-13 20:20:40 +000011514. For Unix the compile-time defined installation directory is used (see the
1152 output of ":version").
1153
1154Once Vim has done this once, it will set the $VIM environment variable. To
1155change it later, use a ":let" command like this: >
1156 :let $VIM = "/home/paul/vim/"
1157<
1158 *$VIMRUNTIME*
1159The environment variable "$VIMRUNTIME" is used to locate various support
1160files, such as the on-line documentation and files used for syntax
1161highlighting. For example, the main help file is normally
1162"$VIMRUNTIME/doc/help.txt".
1163You don't normally set $VIMRUNTIME yourself, but let Vim figure it out. This
1164is the order used to find the value of $VIMRUNTIME:
11651. If the environment variable $VIMRUNTIME is set, it is used. You can use
1166 this when the runtime files are in an unusual location.
11672. If "$VIM/vim{version}" exists, it is used. {version} is the version
Bram Moolenaar8024f932020-01-14 19:29:13 +01001168 number of Vim, without any '-' or '.'. For example: "$VIM/vim82". This is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001169 the normal value for $VIMRUNTIME.
11703. If "$VIM/runtime" exists, it is used.
11714. The value of $VIM is used. This is for backwards compatibility with older
1172 versions.
11735. When the 'helpfile' option is set and doesn't contain a '$', its value is
1174 used, with "doc/help.txt" removed from the end.
1175
1176For Unix, when there is a compiled-in default for $VIMRUNTIME (check the
1177output of ":version"), steps 2, 3 and 4 are skipped, and the compiled-in
1178default is used after step 5. This means that the compiled-in default
1179overrules the value of $VIM. This is useful if $VIM is "/etc" and the runtime
Bram Moolenaar8024f932020-01-14 19:29:13 +01001180files are in "/usr/share/vim/vim82".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001181
1182Once Vim has done this once, it will set the $VIMRUNTIME environment variable.
1183To change it later, use a ":let" command like this: >
Bram Moolenaar8024f932020-01-14 19:29:13 +01001184 :let $VIMRUNTIME = "/home/piet/vim/vim82"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001185
Bram Moolenaared203462004-06-16 11:19:22 +00001186In case you need the value of $VIMRUNTIME in a shell (e.g., for a script that
1187greps in the help files) you might be able to use this: >
1188
1189 VIMRUNTIME=`vim -e -T dumb --cmd 'exe "set t_cm=\<C-M>"|echo $VIMRUNTIME|quit' | tr -d '\015' `
1190
Bram Moolenaar54775062019-07-31 21:07:14 +02001191Don't set $VIMRUNTIME to an empty value, some things may stop working.
1192
Bram Moolenaar071d4272004-06-13 20:20:40 +00001193==============================================================================
11946. Suspending *suspend*
1195
1196 *iconize* *iconise* *CTRL-Z* *v_CTRL-Z*
1197CTRL-Z Suspend Vim, like ":stop".
1198 Works in Normal and in Visual mode. In Insert and
1199 Command-line mode, the CTRL-Z is inserted as a normal
1200 character. In Visual mode Vim goes back to Normal
1201 mode.
Bram Moolenaar0d660222005-01-07 21:51:51 +00001202 Note: if CTRL-Z undoes a change see |mswin.vim|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001203
1204
1205:sus[pend][!] or *:sus* *:suspend* *:st* *:stop*
1206:st[op][!] Suspend Vim.
1207 If the '!' is not given and 'autowrite' is set, every
1208 buffer with changes and a file name is written out.
1209 If the '!' is given or 'autowrite' is not set, changed
1210 buffers are not written, don't forget to bring Vim
1211 back to the foreground later!
1212
Bram Moolenaar8024f932020-01-14 19:29:13 +01001213In the GUI, suspending is implemented as iconising gvim. In MS-Windows, gvim
1214is minimized.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001215
1216On many Unix systems, it is possible to suspend Vim with CTRL-Z. This is only
1217possible in Normal and Visual mode (see next chapter, |vim-modes|). Vim will
1218continue if you make it the foreground job again. On other systems, CTRL-Z
1219will start a new shell. This is the same as the ":sh" command. Vim will
1220continue if you exit from the shell.
1221
1222In X-windows the selection is disowned when Vim suspends. this means you
1223can't paste it in another application (since Vim is going to sleep an attempt
1224to get the selection would make the program hang).
1225
1226==============================================================================
Bram Moolenaare0fa3742016-02-20 15:47:01 +010012277. Exiting *exiting*
1228
1229There are several ways to exit Vim:
1230- Close the last window with `:quit`. Only when there are no changes.
1231- Close the last window with `:quit!`. Also when there are changes.
1232- Close all windows with `:qall`. Only when there are no changes.
1233- Close all windows with `:qall!`. Also when there are changes.
1234- Use `:cquit`. Also when there are changes.
1235
1236When using `:cquit` or when there was an error message Vim exits with exit
Bram Moolenaar369b6f52017-01-17 12:22:32 +01001237code 1. Errors can be avoided by using `:silent!` or with `:catch`.
Bram Moolenaare0fa3742016-02-20 15:47:01 +01001238
1239==============================================================================
12408. Saving settings *save-settings*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001241
1242Mostly you will edit your vimrc files manually. This gives you the greatest
1243flexibility. There are a few commands to generate a vimrc file automatically.
1244You can use these files as they are, or copy/paste lines to include in another
1245vimrc file.
1246
1247 *:mk* *:mkexrc*
1248:mk[exrc] [file] Write current key mappings and changed options to
1249 [file] (default ".exrc" in the current directory),
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001250 unless it already exists.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001251
1252:mk[exrc]! [file] Always write current key mappings and changed
1253 options to [file] (default ".exrc" in the current
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001254 directory).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001255
Bram Moolenaar61da1bf2019-06-06 12:14:49 +02001256 *:mkv* *:mkvi* *:mkvimrc*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001257:mkv[imrc][!] [file] Like ":mkexrc", but the default is ".vimrc" in the
1258 current directory. The ":version" command is also
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001259 written to the file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001260
1261These commands will write ":map" and ":set" commands to a file, in such a way
1262that when these commands are executed, the current key mappings and options
1263will be set to the same values. The options 'columns', 'endofline',
1264'fileformat', 'key', 'lines', 'modified', 'scroll', 'term', 'textmode',
1265'ttyfast' and 'ttymouse' are not included, because these are terminal or file
1266dependent. Note that the options 'binary', 'paste' and 'readonly' are
1267included, this might not always be what you want.
1268
1269When special keys are used in mappings, The 'cpoptions' option will be
1270temporarily set to its Vim default, to avoid the mappings to be
1271misinterpreted. This makes the file incompatible with Vi, but makes sure it
1272can be used with different terminals.
1273
1274Only global mappings are stored, not mappings local to a buffer.
1275
1276A common method is to use a default ".vimrc" file, make some modifications
1277with ":map" and ":set" commands and write the modified file. First read the
1278default ".vimrc" in with a command like ":source ~piet/.vimrc.Cprogs", change
1279the settings and then save them in the current directory with ":mkvimrc!". If
1280you want to make this file your default .vimrc, move it to your home directory
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001281(on Unix), s: (Amiga) or $VIM directory (MS-Windows). You could also use
Bram Moolenaar071d4272004-06-13 20:20:40 +00001282autocommands |autocommand| and/or modelines |modeline|.
1283
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001284 *vimrc-option-example*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001285If you only want to add a single option setting to your vimrc, you can use
1286these steps:
12871. Edit your vimrc file with Vim.
12882. Play with the option until it's right. E.g., try out different values for
1289 'guifont'.
12903. Append a line to set the value of the option, using the expression register
1291 '=' to enter the value. E.g., for the 'guifont' option: >
1292 o:set guifont=<C-R>=&guifont<CR><Esc>
1293< [<C-R> is a CTRL-R, <CR> is a return, <Esc> is the escape key]
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001294 You need to escape special characters, esp. spaces.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001295
1296Note that when you create a .vimrc file, this can influence the 'compatible'
1297option, which has several side effects. See |'compatible'|.
1298":mkvimrc", ":mkexrc" and ":mksession" write the command to set or reset the
1299'compatible' option to the output file first, because of these side effects.
1300
1301==============================================================================
Bram Moolenaare0fa3742016-02-20 15:47:01 +010013029. Views and Sessions *views-sessions*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001303
1304This is introduced in sections |21.4| and |21.5| of the user manual.
1305
1306 *View* *view-file*
1307A View is a collection of settings that apply to one window. You can save a
1308View and when you restore it later, the text is displayed in the same way.
1309The options and mappings in this window will also be restored, so that you can
1310continue editing like when the View was saved.
1311
1312 *Session* *session-file*
1313A Session keeps the Views for all windows, plus the global settings. You can
1314save a Session and when you restore it later the window layout looks the same.
1315You can use a Session to quickly switch between different projects,
1316automatically loading the files you were last working on in that project.
1317
1318Views and Sessions are a nice addition to viminfo-files, which are used to
1319remember information for all Views and Sessions together |viminfo-file|.
1320
1321You can quickly start editing with a previously saved View or Session with the
1322|-S| argument: >
1323 vim -S Session.vim
1324<
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001325All this is {not available when compiled without the |+mksession| feature}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001326
1327 *:mks* *:mksession*
1328:mks[ession][!] [file] Write a Vim script that restores the current editing
1329 session.
1330 When [!] is included an existing file is overwritten.
1331 When [file] is omitted "Session.vim" is used.
1332
1333The output of ":mksession" is like ":mkvimrc", but additional commands are
1334added to the file. Which ones depends on the 'sessionoptions' option. The
1335resulting file, when executed with a ":source" command:
13361. Restores global mappings and options, if 'sessionoptions' contains
1337 "options". Script-local mappings will not be written.
13382. Restores global variables that start with an uppercase letter and contain
1339 at least one lowercase letter, if 'sessionoptions' contains "globals".
13403. Unloads all currently loaded buffers.
13414. Restores the current directory if 'sessionoptions' contains "curdir", or
1342 sets the current directory to where the Session file is if 'sessionoptions'
1343 contains "sesdir".
13445. Restores GUI Vim window position, if 'sessionoptions' contains "winpos".
13456. Restores screen size, if 'sessionoptions' contains "resize".
13467. Reloads the buffer list, with the last cursor positions. If
1347 'sessionoptions' contains "buffers" then all buffers are restored,
1348 including hidden and unloaded buffers. Otherwise only buffers in windows
1349 are restored.
13508. Restores all windows with the same layout. If 'sessionoptions' contains
Bram Moolenaarc81e5e72007-05-05 18:24:42 +00001351 "help", help windows are restored. If 'sessionoptions' contains "blank",
1352 windows editing a buffer without a name will be restored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001353 If 'sessionoptions' contains "winsize" and no (help/blank) windows were
1354 left out, the window sizes are restored (relative to the screen size).
1355 Otherwise, the windows are just given sensible sizes.
13569. Restores the Views for all the windows, as with |:mkview|. But
1357 'sessionoptions' is used instead of 'viewoptions'.
135810. If a file exists with the same name as the Session file, but ending in
1359 "x.vim" (for eXtra), executes that as well. You can use *x.vim files to
1360 specify additional settings and actions associated with a given Session,
1361 such as creating menu items in the GUI version.
1362
1363After restoring the Session, the full filename of your current Session is
1364available in the internal variable "v:this_session" |this_session-variable|.
1365An example mapping: >
1366 :nmap <F2> :wa<Bar>exe "mksession! " . v:this_session<CR>:so ~/sessions/
1367This saves the current Session, and starts off the command to load another.
1368
Bram Moolenaar4a85b412006-04-23 22:40:29 +00001369A session includes all tab pages, unless "tabpages" was removed from
1370'sessionoptions'. |tab-page|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00001371
Bram Moolenaar9372a112005-12-06 19:59:18 +00001372The |SessionLoadPost| autocmd event is triggered after a session file is
1373loaded/sourced.
1374 *SessionLoad-variable*
1375While the session file is loading the SessionLoad global variable is set to 1.
1376Plugins can use this to postpone some work until the SessionLoadPost event is
1377triggered.
1378
Bram Moolenaar071d4272004-06-13 20:20:40 +00001379 *:mkvie* *:mkview*
1380:mkvie[w][!] [file] Write a Vim script that restores the contents of the
1381 current window.
1382 When [!] is included an existing file is overwritten.
1383 When [file] is omitted or is a number from 1 to 9, a
Bram Moolenaar551dbcc2006-04-25 22:13:59 +00001384 name is generated and 'viewdir' prepended. When the
Bram Moolenaar7e38ea22014-04-05 22:55:53 +02001385 last path part of 'viewdir' does not exist, this
1386 directory is created. E.g., when 'viewdir' is
1387 "$VIM/vimfiles/view" then "view" is created in
1388 "$VIM/vimfiles".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001389 An existing file is always overwritten then. Use
1390 |:loadview| to load this view again.
1391 When [file] is the name of a file ('viewdir' is not
1392 used), a command to edit the file is added to the
1393 generated file.
1394
1395The output of ":mkview" contains these items:
13961. The argument list used in the window. When the global argument list is
1397 used it is reset to the global list.
1398 The index in the argument list is also restored.
13992. The file being edited in the window. If there is no file, the window is
1400 made empty.
14013. Restore mappings, abbreviations and options local to the window if
1402 'viewoptions' contains "options" or "localoptions". For the options it
1403 restores only values that are local to the current buffer and values local
1404 to the window.
1405 When storing the view as part of a session and "options" is in
1406 'sessionoptions', global values for local options will be stored too.
14074. Restore folds when using manual folding and 'viewoptions' contains
1408 "folds". Restore manually opened and closed folds.
14095. The scroll position and the cursor position in the file. Doesn't work very
1410 well when there are closed folds.
14116. The local current directory, if it is different from the global current
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01001412 directory and 'viewoptions' contains "curdir".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001413
1414Note that Views and Sessions are not perfect:
1415- They don't restore everything. For example, defined functions, autocommands
1416 and ":syntax on" are not included. Things like register contents and
1417 command line history are in viminfo, not in Sessions or Views.
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001418- Global option values are only set when they differ from the default value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001419 When the current value is not the default value, loading a Session will not
1420 set it back to the default value. Local options will be set back to the
1421 default value though.
1422- Existing mappings will be overwritten without warning. An existing mapping
1423 may cause an error for ambiguity.
1424- When storing manual folds and when storing manually opened/closed folds,
1425 changes in the file between saving and loading the view will mess it up.
1426- The Vim script is not very efficient. But still faster than typing the
1427 commands yourself!
1428
1429 *:lo* *:loadview*
1430:lo[adview] [nr] Load the view for the current file. When [nr] is
1431 omitted, the view stored with ":mkview" is loaded.
1432 When [nr] is specified, the view stored with ":mkview
1433 [nr]" is loaded.
1434
1435The combination of ":mkview" and ":loadview" can be used to store up to ten
1436different views of a file. These are remembered in the directory specified
1437with the 'viewdir' option. The views are stored using the file name. If a
1438file is renamed or accessed through a (symbolic) link the view will not be
1439found.
1440
1441You might want to clean up your 'viewdir' directory now and then.
1442
1443To automatically save and restore views for *.c files: >
1444 au BufWinLeave *.c mkview
1445 au BufWinEnter *.c silent loadview
1446
1447==============================================================================
Bram Moolenaare0fa3742016-02-20 15:47:01 +0100144810. The viminfo file *viminfo* *viminfo-file* *E136*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001449 *E575* *E576* *E577*
1450If you exit Vim and later start it again, you would normally lose a lot of
1451information. The viminfo file can be used to remember that information, which
1452enables you to continue where you left off.
1453
1454This is introduced in section |21.3| of the user manual.
1455
1456The viminfo file is used to store:
1457- The command line history.
1458- The search string history.
1459- The input-line history.
Bram Moolenaar49cd9572005-01-03 21:06:01 +00001460- Contents of non-empty registers.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001461- Marks for several files.
1462- File marks, pointing to locations in files.
1463- Last search/substitute pattern (for 'n' and '&').
1464- The buffer list.
1465- Global variables.
1466
1467The viminfo file is not supported when the |+viminfo| feature has been
1468disabled at compile time.
1469
1470You could also use a Session file. The difference is that the viminfo file
1471does not depend on what you are working on. There normally is only one
1472viminfo file. Session files are used to save the state of a specific editing
1473Session. You could have several Session files, one for each project you are
1474working on. Viminfo and Session files together can be used to effectively
1475enter Vim and directly start working in your desired setup. |session-file|
1476
1477 *viminfo-read*
1478When Vim is started and the 'viminfo' option is non-empty, the contents of
1479the viminfo file are read and the info can be used in the appropriate places.
Bram Moolenaard812df62008-11-09 12:46:09 +00001480The |v:oldfiles| variable is filled. The marks are not read in at startup
1481(but file marks are). See |initialization| for how to set the 'viminfo'
1482option upon startup.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001483
1484 *viminfo-write*
1485When Vim exits and 'viminfo' is non-empty, the info is stored in the viminfo
1486file (it's actually merged with the existing one, if one exists). The
1487'viminfo' option is a string containing information about what info should be
1488stored, and contains limits on how much should be stored (see 'viminfo').
1489
Bram Moolenaarc95a3022016-06-12 23:01:46 +02001490Merging happens in two ways. Most items that have been changed or set in the
1491current Vim session are stored, and what was not changed is filled from what
1492is currently in the viminfo file. For example:
1493- Vim session A reads the viminfo, which contains variable START.
1494- Vim session B does the same
1495- Vim session A sets the variables AAA and BOTH and exits
1496- Vim session B sets the variables BBB and BOTH and exits
1497Now the viminfo will have:
1498 START - it was in the viminfo and wasn't changed in session A or B
1499 AAA - value from session A, session B kept it
1500 BBB - value from session B
1501 BOTH - value from session B, value from session A is lost
1502
Bram Moolenaar063b9d12016-07-09 20:21:48 +02001503 *viminfo-timestamp*
Bram Moolenaarc95a3022016-06-12 23:01:46 +02001504For some items a timestamp is used to keep the last changed version. Here it
1505doesn't matter in which sequence Vim sessions exit, the newest item(s) are
1506always kept. This is used for:
1507- The command line history.
1508- The search string history.
1509- The input-line history.
1510- Contents of non-empty registers.
1511- The jump list
1512- File marks
Bram Moolenaara02a5512016-06-17 12:48:11 +02001513The timestamp feature was added before Vim 8.0. Older versions of Vim,
1514starting with 7.4.1131, will keep the items with timestamp, but not use them.
1515Thus when using both an older and a newer version of Vim the most recent data
1516will be kept.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02001517
Bram Moolenaar071d4272004-06-13 20:20:40 +00001518Notes for Unix:
1519- The file protection for the viminfo file will be set to prevent other users
1520 from being able to read it, because it may contain any text or commands that
1521 you have worked with.
1522- If you want to share the viminfo file with other users (e.g. when you "su"
1523 to another user), you can make the file writable for the group or everybody.
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01001524 Vim will preserve this when replacing the viminfo file. Be careful, don't
Bram Moolenaar071d4272004-06-13 20:20:40 +00001525 allow just anybody to read and write your viminfo file!
1526- Vim will not overwrite a viminfo file that is not writable by the current
1527 "real" user. This helps for when you did "su" to become root, but your
1528 $HOME is still set to a normal user's home directory. Otherwise Vim would
1529 create a viminfo file owned by root that nobody else can read.
Bram Moolenaar69c2f172007-05-12 14:57:31 +00001530- The viminfo file cannot be a symbolic link. This is to avoid security
1531 issues.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001532
1533Marks are stored for each file separately. When a file is read and 'viminfo'
1534is non-empty, the marks for that file are read from the viminfo file. NOTE:
1535The marks are only written when exiting Vim, which is fine because marks are
1536remembered for all the files you have opened in the current editing session,
1537unless ":bdel" is used. If you want to save the marks for a file that you are
1538about to abandon with ":bdel", use ":wv". The '[' and ']' marks are not
1539stored, but the '"' mark is. The '"' mark is very useful for jumping to the
1540cursor position when the file was last exited. No marks are saved for files
1541that start with any string given with the "r" flag in 'viminfo'. This can be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001542used to avoid saving marks for files on removable media (for MS-Windows you
1543would use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:").
Bram Moolenaard812df62008-11-09 12:46:09 +00001544The |v:oldfiles| variable is filled with the file names that the viminfo file
1545has marks for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001546
1547 *viminfo-file-marks*
1548Uppercase marks ('A to 'Z) are stored when writing the viminfo file. The
1549numbered marks ('0 to '9) are a bit special. When the viminfo file is written
1550(when exiting or with the ":wviminfo" command), '0 is set to the current cursor
1551position and file. The old '0 is moved to '1, '1 to '2, etc. This
1552resembles what happens with the "1 to "9 delete registers. If the current
1553cursor position is already present in '0 to '9, it is moved to '0, to avoid
1554having the same position twice. The result is that with "'0", you can jump
1555back to the file and line where you exited Vim. To do that right away, try
1556using this command: >
1557
1558 vim -c "normal '0"
1559
Bram Moolenaar864207d2008-06-24 22:14:38 +00001560In a csh compatible shell you could make an alias for it: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00001561
1562 alias lvim vim -c '"'normal "'"0'"'
1563
Bram Moolenaar864207d2008-06-24 22:14:38 +00001564For a bash-like shell: >
1565
1566 alias lvim='vim -c "normal '\''0"'
1567
Bram Moolenaar071d4272004-06-13 20:20:40 +00001568Use the "r" flag in 'viminfo' to specify for which files no marks should be
1569remembered.
1570
1571
1572VIMINFO FILE NAME *viminfo-file-name*
1573
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001574- The default name of the viminfo file is "$HOME/.viminfo" for Unix,
Bram Moolenaarade0d392020-01-21 22:33:58 +01001575 "s:.viminfo" for Amiga, "$HOME\_viminfo" for Win32. For Win32, when $HOME
1576 is not set, "$VIM\_viminfo" is used. When $VIM is also not set,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001577 "c:\_viminfo" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001578- The 'n' flag in the 'viminfo' option can be used to specify another viminfo
1579 file name |'viminfo'|.
1580- The "-i" Vim argument can be used to set another file name, |-i|. When the
1581 file name given is "NONE" (all uppercase), no viminfo file is ever read or
1582 written. Also not for the commands below!
Bram Moolenaarb477af22018-07-15 20:20:18 +02001583- The 'viminfofile' option can be used like the "-i" argument. In fact, the
1584 value form the "-i" argument is stored in the 'viminfofile' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001585- For the commands below, another file name can be given, overriding the
1586 default and the name given with 'viminfo' or "-i" (unless it's NONE).
1587
1588
1589CHARACTER ENCODING *viminfo-encoding*
1590
1591The text in the viminfo file is encoded as specified with the 'encoding'
1592option. Normally you will always work with the same 'encoding' value, and
1593this works just fine. However, if you read the viminfo file with another
1594value for 'encoding' than what it was written with, some of the text
1595(non-ASCII characters) may be invalid. If this is unacceptable, add the 'c'
1596flag to the 'viminfo' option: >
1597 :set viminfo+=c
1598Vim will then attempt to convert the text in the viminfo file from the
1599'encoding' value it was written with to the current 'encoding' value. This
1600requires Vim to be compiled with the |+iconv| feature. Filenames are not
1601converted.
1602
1603
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001604MANUALLY READING AND WRITING *viminfo-read-write*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001605
1606Two commands can be used to read and write the viminfo file manually. This
1607can be used to exchange registers between two running Vim programs: First
1608type ":wv" in one and then ":rv" in the other. Note that if the register
1609already contained something, then ":rv!" would be required. Also note
1610however that this means everything will be overwritten with information from
1611the first Vim, including the command line history, etc.
1612
1613The viminfo file itself can be edited by hand too, although we suggest you
1614start with an existing one to get the format right. It is reasonably
1615self-explanatory once you're in there. This can be useful in order to
1616create a second file, say "~/.my_viminfo" which could contain certain
1617settings that you always want when you first start Vim. For example, you
1618can preload registers with particular data, or put certain commands in the
1619command line history. A line in your .vimrc file like >
1620 :rviminfo! ~/.my_viminfo
1621can be used to load this information. You could even have different viminfos
1622for different types of files (e.g., C code) and load them based on the file
1623name, using the ":autocmd" command (see |:autocmd|).
1624
1625 *viminfo-errors*
1626When Vim detects an error while reading a viminfo file, it will not overwrite
1627that file. If there are more than 10 errors, Vim stops reading the viminfo
1628file. This was done to avoid accidentally destroying a file when the file
1629name of the viminfo file is wrong. This could happen when accidentally typing
1630"vim -i file" when you wanted "vim -R file" (yes, somebody accidentally did
1631that!). If you want to overwrite a viminfo file with an error in it, you will
1632either have to fix the error, or delete the file (while Vim is running, so
1633most of the information will be restored).
1634
1635 *:rv* *:rviminfo* *E195*
1636:rv[iminfo][!] [file] Read from viminfo file [file] (default: see above).
1637 If [!] is given, then any information that is
Bram Moolenaard812df62008-11-09 12:46:09 +00001638 already set (registers, marks, |v:oldfiles|, etc.)
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001639 will be overwritten
Bram Moolenaar071d4272004-06-13 20:20:40 +00001640
Bram Moolenaarc95a3022016-06-12 23:01:46 +02001641 *:wv* *:wviminfo* *E137* *E138* *E574* *E886* *E929*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001642:wv[iminfo][!] [file] Write to viminfo file [file] (default: see above).
1643 The information in the file is first read in to make
1644 a merge between old and new info. When [!] is used,
1645 the old information is not read first, only the
1646 internal info is written. If 'viminfo' is empty, marks
1647 for up to 100 files will be written.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02001648 When you get error "E929: Too many viminfo temp files"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001649 check that no old temp files were left behind (e.g.
1650 ~/.viminf*) and that you can write in the directory of
1651 the .viminfo file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001652
Bram Moolenaard812df62008-11-09 12:46:09 +00001653 *:ol* *:oldfiles*
1654:ol[dfiles] List the files that have marks stored in the viminfo
1655 file. This list is read on startup and only changes
Bram Moolenaare11d61a2016-08-20 18:36:54 +02001656 afterwards with `:rviminfo!`. Also see |v:oldfiles|.
Bram Moolenaard812df62008-11-09 12:46:09 +00001657 The number can be used with |c_#<|.
Bram Moolenaar7b668e82016-08-23 23:51:21 +02001658 The output can be filtered with |:filter|, e.g.: >
Bram Moolenaar818078d2016-08-27 21:58:42 +02001659 filter /\.vim/ oldfiles
Bram Moolenaar7b668e82016-08-23 23:51:21 +02001660< The filtering happens on the file name.
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001661 {only when compiled with the |+eval| feature}
Bram Moolenaard812df62008-11-09 12:46:09 +00001662
1663:bro[wse] ol[dfiles][!]
1664 List file names as with |:oldfiles|, and then prompt
1665 for a number. When the number is valid that file from
1666 the list is edited.
1667 If you get the |press-enter| prompt you can press "q"
1668 and still get the prompt to enter a file number.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001669 Use ! to abandon a modified buffer. |abandon|
Bram Moolenaard812df62008-11-09 12:46:09 +00001670 {not when compiled with tiny or small features}
1671
Bram Moolenaar91f84f62018-07-29 15:07:52 +02001672 vim:tw=78:ts=8:noet:ft=help:norl: