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