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