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