Mercurial > vim
annotate runtime/doc/options.txt @ 6843:50cdebea094f v7.4.742
patch 7.4.742
Problem: Cannot specify a vertical split when loading a buffer for a
quickfix command.
Solution: Add the "vsplit" value to 'switchbuf'. (Brook Hong)
author | Bram Moolenaar <bram@vim.org> |
---|---|
date | Fri, 19 Jun 2015 14:41:49 +0200 |
parents | 0303182665d5 |
children | ee45d3b0579b |
rev | line source |
---|---|
6823 | 1 *options.txt* For Vim version 7.4. Last change: 2015 May 04 |
7 | 2 |
3 | |
4 VIM REFERENCE MANUAL by Bram Moolenaar | |
5 | |
6 | |
7 Options *options* | |
8 | |
9 1. Setting options |set-option| | |
10 2. Automatically setting options |auto-setting| | |
11 3. Options summary |option-summary| | |
12 | |
13 For an overview of options see help.txt |option-list|. | |
14 | |
15 Vim has a number of internal variables and switches which can be set to | |
16 achieve special effects. These options come in three forms: | |
17 boolean can only be on or off *boolean* *toggle* | |
18 number has a numeric value | |
19 string has a string value | |
20 | |
21 ============================================================================== | |
523 | 22 1. Setting options *set-option* *E764* |
7 | 23 |
24 *:se* *:set* | |
25 :se[t] Show all options that differ from their default value. | |
26 | |
27 :se[t] all Show all but terminal options. | |
28 | |
29 :se[t] termcap Show all terminal options. Note that in the GUI the | |
30 key codes are not shown, because they are generated | |
31 internally and can't be changed. Changing the terminal | |
32 codes in the GUI is not useful either... | |
33 | |
34 *E518* *E519* | |
35 :se[t] {option}? Show value of {option}. | |
36 | |
37 :se[t] {option} Toggle option: set, switch it on. | |
38 Number option: show value. | |
39 String option: show value. | |
40 | |
41 :se[t] no{option} Toggle option: Reset, switch it off. | |
42 | |
2152 | 43 *:set-!* *:set-inv* |
7 | 44 :se[t] {option}! or |
45 :se[t] inv{option} Toggle option: Invert value. {not in Vi} | |
46 | |
47 *:set-default* *:set-&* *:set-&vi* *:set-&vim* | |
48 :se[t] {option}& Reset option to its default value. May depend on the | |
49 current value of 'compatible'. {not in Vi} | |
50 :se[t] {option}&vi Reset option to its Vi default value. {not in Vi} | |
51 :se[t] {option}&vim Reset option to its Vim default value. {not in Vi} | |
52 | |
53 :se[t] all& Set all options, except terminal options, to their | |
10 | 54 default value. The values of 'term', 'lines' and |
7 | 55 'columns' are not changed. {not in Vi} |
56 | |
57 *:set-args* *E487* *E521* | |
58 :se[t] {option}={value} or | |
59 :se[t] {option}:{value} | |
60 Set string or number option to {value}. | |
61 For numeric options the value can be given in decimal, | |
6551 | 62 hex (preceded with 0x) or octal (preceded with '0'). |
7 | 63 The old value can be inserted by typing 'wildchar' (by |
64 default this is a <Tab> or CTRL-E if 'compatible' is | |
65 set). See |cmdline-completion|. | |
66 White space between {option} and '=' is allowed and | |
67 will be ignored. White space between '=' and {value} | |
68 is not allowed. | |
69 See |option-backslash| for using white space and | |
70 backslashes in {value}. | |
71 | |
72 :se[t] {option}+={value} *:set+=* | |
73 Add the {value} to a number option, or append the | |
74 {value} to a string option. When the option is a | |
75 comma separated list, a comma is added, unless the | |
76 value was empty. | |
77 If the option is a list of flags, superfluous flags | |
557 | 78 are removed. When adding a flag that was already |
79 present the option value doesn't change. | |
809 | 80 Also see |:set-args| above. |
7 | 81 {not in Vi} |
82 | |
83 :se[t] {option}^={value} *:set^=* | |
84 Multiply the {value} to a number option, or prepend | |
85 the {value} to a string option. When the option is a | |
86 comma separated list, a comma is added, unless the | |
87 value was empty. | |
88 Also see |:set-args| above. | |
89 {not in Vi} | |
90 | |
91 :se[t] {option}-={value} *:set-=* | |
92 Subtract the {value} from a number option, or remove | |
93 the {value} from a string option, if it is there. | |
94 If the {value} is not found in a string option, there | |
95 is no error or warning. When the option is a comma | |
96 separated list, a comma is deleted, unless the option | |
97 becomes empty. | |
98 When the option is a list of flags, {value} must be | |
99 exactly as they appear in the option. Remove flags | |
100 one by one to avoid problems. | |
101 Also see |:set-args| above. | |
102 {not in Vi} | |
103 | |
104 The {option} arguments to ":set" may be repeated. For example: > | |
105 :set ai nosi sw=3 ts=3 | |
106 If you make an error in one of the arguments, an error message will be given | |
107 and the following arguments will be ignored. | |
108 | |
109 *:set-verbose* | |
110 When 'verbose' is non-zero, displaying an option value will also tell where it | |
111 was last set. Example: > | |
112 :verbose set shiftwidth cindent? | |
1621 | 113 < shiftwidth=4 ~ |
114 Last set from modeline ~ | |
115 cindent ~ | |
116 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim ~ | |
117 This is only done when specific option values are requested, not for ":verbose | |
118 set all" or ":verbose set" without an argument. | |
119 When the option was set by hand there is no "Last set" message. | |
7 | 120 When the option was set while executing a function, user command or |
121 autocommand, the script in which it was defined is reported. | |
122 Note that an option may also have been set as a side effect of setting | |
123 'compatible'. | |
1621 | 124 A few special texts: |
125 Last set from modeline ~ | |
126 Option was set in a |modeline|. | |
127 Last set from --cmd argument ~ | |
128 Option was set with command line argument |--cmd| or +. | |
129 Last set from -c argument ~ | |
130 Option was set with command line argument |-c|, +, |-S| or | |
131 |-q|. | |
132 Last set from environment variable ~ | |
133 Option was set from an environment variable, $VIMINIT, | |
134 $GVIMINIT or $EXINIT. | |
135 Last set from error handler ~ | |
136 Option was cleared when evaluating it resulted in an error. | |
137 | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
138 {not available when compiled without the |+eval| feature} |
7 | 139 |
140 *:set-termcap* *E522* | |
667 | 141 For {option} the form "t_xx" may be used to set a terminal option. This will |
7 | 142 override the value from the termcap. You can then use it in a mapping. If |
143 the "xx" part contains special characters, use the <t_xx> form: > | |
144 :set <t_#4>=^[Ot | |
145 This can also be used to translate a special code for a normal key. For | |
146 example, if Alt-b produces <Esc>b, use this: > | |
147 :set <M-b>=^[b | |
148 (the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it) | |
149 The advantage over a mapping is that it works in all situations. | |
150 | |
2726 | 151 You can define any key codes, e.g.: > |
152 :set t_xy=^[foo; | |
153 There is no warning for using a name that isn't recognized. You can map these | |
154 codes as you like: > | |
155 :map <t_xy> something | |
156 < *E846* | |
157 When a key code is not set, it's like it does not exist. Trying to get its | |
158 value will result in an error: > | |
159 :set t_kb= | |
160 :set t_kb | |
161 E846: Key code not set: t_kb | |
162 | |
36 | 163 The t_xx options cannot be set from a |modeline| or in the |sandbox|, for |
164 security reasons. | |
165 | |
7 | 166 The listing from ":set" looks different from Vi. Long string options are put |
10 | 167 at the end of the list. The number of options is quite large. The output of |
7 | 168 "set all" probably does not fit on the screen, causing Vim to give the |
169 |more-prompt|. | |
170 | |
171 *option-backslash* | |
172 To include white space in a string option value it has to be preceded with a | |
173 backslash. To include a backslash you have to use two. Effectively this | |
174 means that the number of backslashes in an option value is halved (rounded | |
175 down). | |
176 A few examples: > | |
177 :set tags=tags\ /usr/tags results in "tags /usr/tags" | |
178 :set tags=tags\\,file results in "tags\,file" | |
179 :set tags=tags\\\ file results in "tags\ file" | |
180 | |
10 | 181 The "|" character separates a ":set" command from a following command. To |
182 include the "|" in the option value, use "\|" instead. This example sets the | |
7 | 183 'titlestring' option to "hi|there": > |
184 :set titlestring=hi\|there | |
185 This sets the 'titlestring' option to "hi" and 'iconstring' to "there": > | |
186 :set titlestring=hi|set iconstring=there | |
187 | |
642 | 188 Similarly, the double quote character starts a comment. To include the '"' in |
189 the option value, use '\"' instead. This example sets the 'titlestring' | |
190 option to 'hi "there"': > | |
191 :set titlestring=hi\ \"there\" | |
192 | |
10 | 193 For MS-DOS and WIN32 backslashes in file names are mostly not removed. More |
7 | 194 precise: For options that expect a file name (those where environment |
195 variables are expanded) a backslash before a normal file name character is not | |
196 removed. But a backslash before a special character (space, backslash, comma, | |
197 etc.) is used like explained above. | |
198 There is one special situation, when the value starts with "\\": > | |
199 :set dir=\\machine\path results in "\\machine\path" | |
200 :set dir=\\\\machine\\path results in "\\machine\path" | |
201 :set dir=\\path\\file results in "\\path\file" (wrong!) | |
202 For the first one the start is kept, but for the second one the backslashes | |
203 are halved. This makes sure it works both when you expect backslashes to be | |
10 | 204 halved and when you expect the backslashes to be kept. The third gives a |
7 | 205 result which is probably not what you want. Avoid it. |
206 | |
207 *add-option-flags* *remove-option-flags* | |
208 *E539* *E550* *E551* *E552* | |
209 Some options are a list of flags. When you want to add a flag to such an | |
210 option, without changing the existing ones, you can do it like this: > | |
211 :set guioptions+=a | |
212 Remove a flag from an option like this: > | |
213 :set guioptions-=a | |
214 This removes the 'a' flag from 'guioptions'. | |
10 | 215 Note that you should add or remove one flag at a time. If 'guioptions' has |
7 | 216 the value "ab", using "set guioptions-=ba" won't work, because the string "ba" |
217 doesn't appear. | |
218 | |
219 *:set_env* *expand-env* *expand-environment-var* | |
22 | 220 Environment variables in specific string options will be expanded. If the |
7 | 221 environment variable exists the '$' and the following environment variable |
222 name is replaced with its value. If it does not exist the '$' and the name | |
223 are not modified. Any non-id character (not a letter, digit or '_') may | |
224 follow the environment variable name. That character and what follows is | |
225 appended to the value of the environment variable. Examples: > | |
226 :set term=$TERM.new | |
227 :set path=/usr/$INCLUDE,$HOME/include,. | |
228 When adding or removing a string from an option with ":set opt-=val" or ":set | |
229 opt+=val" the expansion is done before the adding or removing. | |
230 | |
231 | |
232 Handling of local options *local-options* | |
233 | |
234 Some of the options only apply to a window or buffer. Each window or buffer | |
235 has its own copy of this option, thus can each have their own value. This | |
236 allows you to set 'list' in one window but not in another. And set | |
237 'shiftwidth' to 3 in one buffer and 4 in another. | |
238 | |
239 The following explains what happens to these local options in specific | |
240 situations. You don't really need to know all of this, since Vim mostly uses | |
241 the option values you would expect. Unfortunately, doing what the user | |
242 expects is a bit complicated... | |
243 | |
244 When splitting a window, the local options are copied to the new window. Thus | |
245 right after the split the contents of the two windows look the same. | |
246 | |
247 When editing a new buffer, its local option values must be initialized. Since | |
248 the local options of the current buffer might be specifically for that buffer, | |
249 these are not used. Instead, for each buffer-local option there also is a | |
250 global value, which is used for new buffers. With ":set" both the local and | |
251 global value is changed. With "setlocal" only the local value is changed, | |
252 thus this value is not used when editing a new buffer. | |
253 | |
254 When editing a buffer that has been edited before, the last used window | |
255 options are used again. If this buffer has been edited in this window, the | |
256 values from back then are used. Otherwise the values from the window where | |
257 the buffer was edited last are used. | |
258 | |
259 It's possible to set a local window option specifically for a type of buffer. | |
260 When you edit another buffer in the same window, you don't want to keep | |
261 using these local window options. Therefore Vim keeps a global value of the | |
262 local window options, which is used when editing another buffer. Each window | |
263 has its own copy of these values. Thus these are local to the window, but | |
264 global to all buffers in the window. With this you can do: > | |
265 :e one | |
266 :set list | |
267 :e two | |
268 Now the 'list' option will also be set in "two", since with the ":set list" | |
269 command you have also set the global value. > | |
270 :set nolist | |
271 :e one | |
272 :setlocal list | |
273 :e two | |
274 Now the 'list' option is not set, because ":set nolist" resets the global | |
275 value, ":setlocal list" only changes the local value and ":e two" gets the | |
276 global value. Note that if you do this next: > | |
277 :e one | |
4358 | 278 You will get back the 'list' value as it was the last time you edited "one". |
279 The options local to a window are remembered for each buffer. This also | |
280 happens when the buffer is not loaded, but they are lost when the buffer is | |
281 wiped out |:bwipe|. | |
7 | 282 |
283 *:setl* *:setlocal* | |
284 :setl[ocal] ... Like ":set" but set only the value local to the | |
285 current buffer or window. Not all options have a | |
286 local value. If the option does not have a local | |
287 value the global value is set. | |
2413 | 288 With the "all" argument: display local values for all |
289 local options. | |
290 Without argument: Display local values for all local | |
291 options which are different from the default. | |
7 | 292 When displaying a specific local option, show the |
1621 | 293 local value. For a global/local boolean option, when |
294 the global value is being used, "--" is displayed | |
295 before the option name. | |
296 For a global option the global value is | |
7 | 297 shown (but that might change in the future). |
298 {not in Vi} | |
299 | |
809 | 300 :setl[ocal] {option}< Set the local value of {option} to its global value by |
301 copying the value. | |
302 {not in Vi} | |
303 | |
3281 | 304 :se[t] {option}< For |global-local| options: Remove the local value of |
305 {option}, so that the global value will be used. | |
7 | 306 {not in Vi} |
307 | |
308 *:setg* *:setglobal* | |
309 :setg[lobal] ... Like ":set" but set only the global value for a local | |
310 option without changing the local value. | |
311 When displaying an option, the global value is shown. | |
2413 | 312 With the "all" argument: display global values for all |
313 local options. | |
314 Without argument: display global values for all local | |
315 options which are different from the default. | |
7 | 316 {not in Vi} |
317 | |
318 For buffer-local and window-local options: | |
319 Command global value local value ~ | |
320 :set option=value set set | |
321 :setlocal option=value - set | |
322 :setglobal option=value set - | |
323 :set option? - display | |
324 :setlocal option? - display | |
325 :setglobal option? display - | |
326 | |
327 | |
328 Global options with a local value *global-local* | |
329 | |
40 | 330 Options are global when you mostly use one value for all buffers and windows. |
331 For some global options it's useful to sometimes have a different local value. | |
332 You can set the local value with ":setlocal". That buffer or window will then | |
333 use the local value, while other buffers and windows continue using the global | |
334 value. | |
7 | 335 |
336 For example, you have two windows, both on C source code. They use the global | |
337 'makeprg' option. If you do this in one of the two windows: > | |
338 :set makeprg=gmake | |
339 then the other window will switch to the same value. There is no need to set | |
340 the 'makeprg' option in the other C source window too. | |
341 However, if you start editing a Perl file in a new window, you want to use | |
1152 | 342 another 'makeprg' for it, without changing the value used for the C source |
10 | 343 files. You use this command: > |
7 | 344 :setlocal makeprg=perlmake |
345 You can switch back to using the global value by making the local value empty: > | |
346 :setlocal makeprg= | |
347 This only works for a string option. For a boolean option you need to use the | |
348 "<" flag, like this: > | |
349 :setlocal autoread< | |
350 Note that for non-boolean options using "<" copies the global value to the | |
351 local value, it doesn't switch back to using the global value (that matters | |
809 | 352 when the global value changes later). You can also use: > |
353 :set path< | |
354 This will make the local value of 'path' empty, so that the global value is | |
355 used. Thus it does the same as: > | |
356 :setlocal path= | |
7 | 357 Note: In the future more global options can be made global-local. Using |
358 ":setlocal" on a global option might work differently then. | |
359 | |
360 | |
361 Setting the filetype | |
362 | |
363 :setf[iletype] {filetype} *:setf* *:setfiletype* | |
364 Set the 'filetype' option to {filetype}, but only if | |
365 not done yet in a sequence of (nested) autocommands. | |
366 This is short for: > | |
367 :if !did_filetype() | |
368 : setlocal filetype={filetype} | |
369 :endif | |
370 < This command is used in a filetype.vim file to avoid | |
371 setting the 'filetype' option twice, causing different | |
372 settings and syntax files to be loaded. | |
373 {not in Vi} | |
374 | |
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
375 *option-window* *optwin* |
7 | 376 :bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options* |
377 :opt[ions] Open a window for viewing and setting all options. | |
378 Options are grouped by function. | |
379 Offers short help for each option. Hit <CR> on the | |
380 short help to open a help window with more help for | |
381 the option. | |
382 Modify the value of the option and hit <CR> on the | |
383 "set" line to set the new value. For window and | |
384 buffer specific options, the last accessed window is | |
385 used to set the option value in, unless this is a help | |
386 window, in which case the window below help window is | |
387 used (skipping the option-window). | |
388 {not available when compiled without the |+eval| or | |
389 |+autocmd| features} | |
390 | |
391 *$HOME* | |
392 Using "~" is like using "$HOME", but it is only recognized at the start of an | |
393 option and after a space or comma. | |
394 | |
395 On Unix systems "~user" can be used too. It is replaced by the home directory | |
396 of user "user". Example: > | |
397 :set path=~mool/include,/usr/include,. | |
398 | |
399 On Unix systems the form "${HOME}" can be used too. The name between {} can | |
400 contain non-id characters then. Note that if you want to use this for the | |
401 "gf" command, you need to add the '{' and '}' characters to 'isfname'. | |
402 | |
3224 | 403 On MS-Windows, if $HOME is not defined as an environment variable, then |
404 at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH. | |
405 | |
7 | 406 NOTE: expanding environment variables and "~/" is only done with the ":set" |
407 command, not when assigning a value to an option with ":let". | |
408 | |
409 | |
410 Note the maximum length of an expanded option is limited. How much depends on | |
411 the system, mostly it is something like 256 or 1024 characters. | |
412 | |
413 *:fix* *:fixdel* | |
414 :fix[del] Set the value of 't_kD': | |
415 't_kb' is 't_kD' becomes ~ | |
416 CTRL-? CTRL-H | |
417 not CTRL-? CTRL-? | |
418 | |
419 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi} | |
420 | |
421 If your delete key terminal code is wrong, but the | |
422 code for backspace is alright, you can put this in | |
423 your .vimrc: > | |
424 :fixdel | |
425 < This works no matter what the actual code for | |
426 backspace is. | |
427 | |
428 If the backspace key terminal code is wrong you can | |
429 use this: > | |
430 :if &term == "termname" | |
431 : set t_kb=^V<BS> | |
432 : fixdel | |
433 :endif | |
434 < Where "^V" is CTRL-V and "<BS>" is the backspace key | |
10 | 435 (don't type four characters!). Replace "termname" |
7 | 436 with your terminal name. |
437 | |
438 If your <Delete> key sends a strange key sequence (not | |
439 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: > | |
440 :if &term == "termname" | |
441 : set t_kD=^V<Delete> | |
442 :endif | |
443 < Where "^V" is CTRL-V and "<Delete>" is the delete key | |
444 (don't type eight characters!). Replace "termname" | |
445 with your terminal name. | |
446 | |
447 *Linux-backspace* | |
448 Note about Linux: By default the backspace key | |
449 produces CTRL-?, which is wrong. You can fix it by | |
450 putting this line in your rc.local: > | |
451 echo "keycode 14 = BackSpace" | loadkeys | |
452 < | |
453 *NetBSD-backspace* | |
454 Note about NetBSD: If your backspace doesn't produce | |
455 the right code, try this: > | |
456 xmodmap -e "keycode 22 = BackSpace" | |
457 < If this works, add this in your .Xmodmap file: > | |
458 keysym 22 = BackSpace | |
459 < You need to restart for this to take effect. | |
460 | |
461 ============================================================================== | |
462 2. Automatically setting options *auto-setting* | |
463 | |
464 Besides changing options with the ":set" command, there are three alternatives | |
465 to set options automatically for one or more files: | |
466 | |
467 1. When starting Vim initializations are read from various places. See | |
468 |initialization|. Most of them are performed for all editing sessions, | |
469 and some of them depend on the directory where Vim is started. | |
470 You can create an initialization file with |:mkvimrc|, |:mkview| and | |
471 |:mksession|. | |
472 2. If you start editing a new file, the automatic commands are executed. | |
473 This can be used to set options for files matching a particular pattern and | |
474 many other things. See |autocommand|. | |
475 3. If you start editing a new file, and the 'modeline' option is on, a | |
476 number of lines at the beginning and end of the file are checked for | |
477 modelines. This is explained here. | |
478 | |
479 *modeline* *vim:* *vi:* *ex:* *E520* | |
480 There are two forms of modelines. The first form: | |
5055 | 481 [text]{white}{vi:|vim:|ex:}[white]{options} |
5024
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
482 |
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
483 [text] any text or empty |
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
484 {white} at least one blank character (<Space> or <Tab>) |
5055 | 485 {vi:|vim:|ex:} the string "vi:", "vim:" or "ex:" |
5024
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
486 [white] optional white space |
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
487 {options} a list of option settings, separated with white space |
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
488 or ':', where each part between ':' is the argument |
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
489 for a ":set" command (can be empty) |
7 | 490 |
5055 | 491 Examples: |
782 | 492 vi:noai:sw=3 ts=6 ~ |
5055 | 493 vim: tw=77 ~ |
7 | 494 |
495 The second form (this is compatible with some versions of Vi): | |
496 | |
5024
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
497 [text]{white}{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text] |
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
498 |
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
499 [text] any text or empty |
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
500 {white} at least one blank character (<Space> or <Tab>) |
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
501 {vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:" |
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
502 [white] optional white space |
5055 | 503 se[t] the string "set " or "se " (note the space); When |
504 "Vim" is used it must be "set". | |
5024
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
505 {options} a list of options, separated with white space, which |
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
506 is the argument for a ":set" command |
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
507 : a colon |
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
508 [text] any text or empty |
7 | 509 |
5055 | 510 Examples: |
782 | 511 /* vim: set ai tw=75: */ ~ |
5055 | 512 /* Vim: set ai tw=75: */ ~ |
7 | 513 |
5024
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
514 The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the |
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
515 chance that a normal word like "lex:" is caught. There is one exception: |
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
516 "vi:" and "vim:" can also be at the start of the line (for compatibility with |
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
517 version 3.0). Using "ex:" at the start of the line will be ignored (this |
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
518 could be short for "example:"). |
7 | 519 |
520 *modeline-local* | |
521 The options are set like with ":setlocal": The new value only applies to the | |
11 | 522 buffer and window that contain the file. Although it's possible to set global |
523 options from a modeline, this is unusual. If you have two windows open and | |
524 the files in it set the same global option to a different value, the result | |
525 depends on which one was opened last. | |
7 | 526 |
23 | 527 When editing a file that was already loaded, only the window-local options |
528 from the modeline are used. Thus if you manually changed a buffer-local | |
529 option after opening the file, it won't be changed if you edit the same buffer | |
530 in another window. But window-local options will be set. | |
531 | |
7 | 532 *modeline-version* |
533 If the modeline is only to be used for some versions of Vim, the version | |
5024
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
534 number can be specified where "vim:" or "Vim:" is used: |
7 | 535 vim{vers}: version {vers} or later |
536 vim<{vers}: version before {vers} | |
537 vim={vers}: version {vers} | |
538 vim>{vers}: version after {vers} | |
6647 | 539 {vers} is 700 for Vim 7.0 (hundred times the major version plus minor). |
540 For example, to use a modeline only for Vim 7.0: | |
541 /* vim700: set foldmethod=marker */ ~ | |
542 To use a modeline for Vim after version 7.2: | |
543 /* vim>702: set cole=2: */ ~ | |
7 | 544 There can be no blanks between "vim" and the ":". |
545 | |
546 | |
547 The number of lines that are checked can be set with the 'modelines' option. | |
548 If 'modeline' is off or 'modelines' is 0 no lines are checked. | |
549 | |
550 Note that for the first form all of the rest of the line is used, thus a line | |
782 | 551 like: |
552 /* vi:ts=4: */ ~ | |
553 will give an error message for the trailing "*/". This line is OK: | |
554 /* vi:set ts=4: */ ~ | |
7 | 555 |
556 If an error is detected the rest of the line is skipped. | |
557 | |
558 If you want to include a ':' in a set command precede it with a '\'. The | |
782 | 559 backslash in front of the ':' will be removed. Example: |
560 /* vi:set dir=c\:\tmp: */ ~ | |
7 | 561 This sets the 'dir' option to "c:\tmp". Only a single backslash before the |
562 ':' is removed. Thus to include "\:" you have to specify "\\:". | |
563 | |
564 No other commands than "set" are supported, for security reasons (somebody | |
1111 | 565 might create a Trojan horse text file with modelines). And not all options |
566 can be set. For some options a flag is set, so that when it's used the | |
1152 | 567 |sandbox| is effective. Still, there is always a small risk that a modeline |
1111 | 568 causes trouble. E.g., when some joker sets 'textwidth' to 5 all your lines |
569 are wrapped unexpectedly. So disable modelines before editing untrusted text. | |
570 The mail ftplugin does this, for example. | |
7 | 571 |
572 Hint: If you would like to do something else than setting an option, you could | |
573 define an autocommand that checks the file for a specific string. For | |
574 example: > | |
575 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif | |
576 And define a function SetVar() that does something with the line containing | |
577 "VAR". | |
578 | |
579 ============================================================================== | |
580 3. Options summary *option-summary* | |
581 | |
582 In the list below all the options are mentioned with their full name and with | |
583 an abbreviation if there is one. Both forms may be used. | |
584 | |
585 In this document when a boolean option is "set" that means that ":set option" | |
586 is entered. When an option is "reset", ":set nooption" is used. | |
587 | |
588 For some options there are two default values: The "Vim default", which is | |
589 used when 'compatible' is not set, and the "Vi default", which is used when | |
590 'compatible' is set. | |
591 | |
592 Most options are the same in all windows and buffers. There are a few that | |
10 | 593 are specific to how the text is presented in a window. These can be set to a |
7 | 594 different value in each window. For example the 'list' option can be set in |
595 one window and reset in another for the same text, giving both types of view | |
596 at the same time. There are a few options that are specific to a certain | |
597 file. These can have a different value for each file or buffer. For example | |
598 the 'textwidth' option can be 78 for a normal text file and 0 for a C | |
599 program. | |
600 | |
601 global one option for all buffers and windows | |
602 local to window each window has its own copy of this option | |
603 local to buffer each buffer has its own copy of this option | |
604 | |
605 When creating a new window the option values from the currently active window | |
606 are used as a default value for the window-specific options. For the | |
607 buffer-specific options this depends on the 's' and 'S' flags in the | |
608 'cpoptions' option. If 's' is included (which is the default) the values for | |
609 buffer options are copied from the currently active buffer when a buffer is | |
10 | 610 first entered. If 'S' is present the options are copied each time the buffer |
611 is entered, this is almost like having global options. If 's' and 'S' are not | |
7 | 612 present, the options are copied from the currently active buffer when the |
613 buffer is created. | |
614 | |
519 | 615 Hidden options *hidden-options* |
616 | |
617 Not all options are supported in all versions. This depends on the supported | |
618 features and sometimes on the system. A remark about this is in curly braces | |
619 below. When an option is not supported it may still be set without getting an | |
620 error, this is called a hidden option. You can't get the value of a hidden | |
621 option though, it is not stored. | |
622 | |
623 To test if option "foo" can be used with ":set" use something like this: > | |
624 if exists('&foo') | |
625 This also returns true for a hidden option. To test if option "foo" is really | |
626 supported use something like this: > | |
627 if exists('+foo') | |
628 < | |
7 | 629 *E355* |
630 A jump table for the options with a short description can be found at |Q_op|. | |
631 | |
632 *'aleph'* *'al'* *aleph* *Aleph* | |
633 'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise) | |
634 global | |
635 {not in Vi} | |
636 {only available when compiled with the |+rightleft| | |
637 feature} | |
638 The ASCII code for the first letter of the Hebrew alphabet. The | |
639 routine that maps the keyboard in Hebrew mode, both in Insert mode | |
640 (when hkmap is set) and on the command-line (when hitting CTRL-_) | |
641 outputs the Hebrew characters in the range [aleph..aleph+26]. | |
642 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8. | |
643 See |rileft.txt|. | |
644 | |
645 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'* | |
646 'allowrevins' 'ari' boolean (default off) | |
647 global | |
648 {not in Vi} | |
649 {only available when compiled with the |+rightleft| | |
650 feature} | |
651 Allow CTRL-_ in Insert and Command-line mode. This is default off, to | |
652 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get | |
653 into reverse Insert mode, and don't know how to get out. See | |
654 'revins'. | |
655 NOTE: This option is reset when 'compatible' is set. | |
656 | |
657 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'* | |
658 'altkeymap' 'akm' boolean (default off) | |
659 global | |
660 {not in Vi} | |
661 {only available when compiled with the |+farsi| | |
662 feature} | |
233 | 663 When on, the second language is Farsi. In editing mode CTRL-_ toggles |
7 | 664 the keyboard map between Farsi and English, when 'allowrevins' set. |
665 | |
233 | 666 When off, the keyboard map toggles between Hebrew and English. This |
7 | 667 is useful to start the Vim in native mode i.e. English (left-to-right |
668 mode) and have default second language Farsi or Hebrew (right-to-left | |
10 | 669 mode). See |farsi.txt|. |
7 | 670 |
671 *'ambiwidth'* *'ambw'* | |
672 'ambiwidth' 'ambw' string (default: "single") | |
673 global | |
674 {not in Vi} | |
675 {only available when compiled with the |+multi_byte| | |
676 feature} | |
677 Only effective when 'encoding' is "utf-8" or another Unicode encoding. | |
678 Tells Vim what to do with characters with East Asian Width Class | |
679 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek | |
680 letters, Cyrillic letters). | |
681 | |
682 There are currently two possible values: | |
233 | 683 "single": Use the same width as characters in US-ASCII. This is |
7 | 684 expected by most users. |
685 "double": Use twice the width of ASCII characters. | |
2492
c945fdb34ce3
Disallow setting 'ambiwidth' to "double" when 'listchars' or 'fillchars'
Bram Moolenaar <bram@vim.org>
parents:
2490
diff
changeset
|
686 *E834* *E835* |
c945fdb34ce3
Disallow setting 'ambiwidth' to "double" when 'listchars' or 'fillchars'
Bram Moolenaar <bram@vim.org>
parents:
2490
diff
changeset
|
687 The value "double" cannot be used if 'listchars' or 'fillchars' |
c945fdb34ce3
Disallow setting 'ambiwidth' to "double" when 'listchars' or 'fillchars'
Bram Moolenaar <bram@vim.org>
parents:
2490
diff
changeset
|
688 contains a character that would be double width. |
7 | 689 |
690 There are a number of CJK fonts for which the width of glyphs for | |
691 those characters are solely based on how many octets they take in | |
692 legacy/traditional CJK encodings. In those encodings, Euro, | |
693 Registered sign, Greek/Cyrillic letters are represented by two octets, | |
233 | 694 therefore those fonts have "wide" glyphs for them. This is also |
7 | 695 true of some line drawing characters used to make tables in text |
233 | 696 file. Therefore, when a CJK font is used for GUI Vim or |
7 | 697 Vim is running inside a terminal (emulators) that uses a CJK font |
698 (or Vim is run inside an xterm invoked with "-cjkwidth" option.), | |
699 this option should be set to "double" to match the width perceived | |
700 by Vim with the width of glyphs in the font. Perhaps it also has | |
701 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP | |
702 when the system locale is set to one of CJK locales. See Unicode | |
703 Standard Annex #11 (http://www.unicode.org/reports/tr11). | |
704 | |
4229 | 705 Vim may set this option automatically at startup time when Vim is |
706 compiled with the |+termresponse| feature and if |t_u7| is set to the | |
4264 | 707 escape sequence to request cursor position report. |
4229 | 708 |
7 | 709 *'antialias'* *'anti'* *'noantialias'* *'noanti'* |
710 'antialias' 'anti' boolean (default: off) | |
711 global | |
712 {not in Vi} | |
713 {only available when compiled with GUI enabled | |
714 on Mac OS X} | |
715 This option only has an effect in the GUI version of Vim on Mac OS X | |
716 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts, | |
717 which can be easier to read at certain sizes on certain displays. | |
718 Setting this option can sometimes cause problems if 'guifont' is set | |
719 to its default (empty string). | |
720 | |
721 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'* | |
722 'autochdir' 'acd' boolean (default off) | |
723 global | |
724 {not in Vi} | |
2152 | 725 {only available when compiled with it, use |
726 exists("+autochdir") to check} | |
438 | 727 When on, Vim will change the current working directory whenever you |
728 open a file, switch buffers, delete a buffer or open/close a window. | |
729 It will change to the directory containing the file which was opened | |
730 or selected. | |
819 | 731 Note: When this option is on some plugins may not work. |
7 | 732 |
733 *'arabic'* *'arab'* *'noarabic'* *'noarab'* | |
734 'arabic' 'arab' boolean (default off) | |
735 local to window | |
736 {not in Vi} | |
737 {only available when compiled with the |+arabic| | |
738 feature} | |
739 This option can be set to start editing Arabic text. | |
740 Setting this option will: | |
741 - Set the 'rightleft' option, unless 'termbidi' is set. | |
742 - Set the 'arabicshape' option, unless 'termbidi' is set. | |
743 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles | |
744 between typing English and Arabic key mapping. | |
745 - Set the 'delcombine' option | |
746 Note that 'encoding' must be "utf-8" for working with Arabic text. | |
747 | |
748 Resetting this option will: | |
749 - Reset the 'rightleft' option. | |
750 - Disable the use of 'keymap' (without changing its value). | |
751 Note that 'arabicshape' and 'delcombine' are not reset (it is a global | |
3557 | 752 option). |
7 | 753 Also see |arabic.txt|. |
754 | |
755 *'arabicshape'* *'arshape'* | |
756 *'noarabicshape'* *'noarshape'* | |
757 'arabicshape' 'arshape' boolean (default on) | |
758 global | |
759 {not in Vi} | |
760 {only available when compiled with the |+arabic| | |
761 feature} | |
762 When on and 'termbidi' is off, the required visual character | |
763 corrections that need to take place for displaying the Arabic language | |
3893 | 764 take effect. Shaping, in essence, gets enabled; the term is a broad |
7 | 765 one which encompasses: |
766 a) the changing/morphing of characters based on their location | |
767 within a word (initial, medial, final and stand-alone). | |
768 b) the enabling of the ability to compose characters | |
769 c) the enabling of the required combining of some characters | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
770 When disabled the display shows each character's true stand-alone |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
771 form. |
7 | 772 Arabic is a complex language which requires other settings, for |
773 further details see |arabic.txt|. | |
774 | |
775 *'autoindent'* *'ai'* *'noautoindent'* *'noai'* | |
776 'autoindent' 'ai' boolean (default off) | |
777 local to buffer | |
778 Copy indent from current line when starting a new line (typing <CR> | |
779 in Insert mode or when using the "o" or "O" command). If you do not | |
780 type anything on the new line except <BS> or CTRL-D and then type | |
1152 | 781 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor |
782 to another line has the same effect, unless the 'I' flag is included | |
783 in 'cpoptions'. | |
10 | 784 When autoindent is on, formatting (with the "gq" command or when you |
785 reach 'textwidth' in Insert mode) uses the indentation of the first | |
786 line. | |
7 | 787 When 'smartindent' or 'cindent' is on the indent is changed in |
788 a different way. | |
789 The 'autoindent' option is reset when the 'paste' option is set. | |
790 {small difference from Vi: After the indent is deleted when typing | |
791 <Esc> or <CR>, the cursor position when moving up or down is after the | |
792 deleted indent; Vi puts the cursor somewhere in the deleted indent}. | |
793 | |
794 *'autoread'* *'ar'* *'noautoread'* *'noar'* | |
795 'autoread' 'ar' boolean (default off) | |
796 global or local to buffer |global-local| | |
797 {not in Vi} | |
798 When a file has been detected to have been changed outside of Vim and | |
799 it has not been changed inside of Vim, automatically read it again. | |
800 When the file has been deleted this is not done. |timestamp| | |
801 If this option has a local value, use this command to switch back to | |
802 using the global value: > | |
803 :set autoread< | |
804 < | |
805 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'* | |
806 'autowrite' 'aw' boolean (default off) | |
807 global | |
808 Write the contents of the file, if it has been modified, on each | |
809 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!, | |
864 | 810 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I, |
7 | 811 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file. |
812 Note that for some commands the 'autowrite' option is not used, see | |
813 'autowriteall' for that. | |
814 | |
815 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'* | |
816 'autowriteall' 'awa' boolean (default off) | |
817 global | |
818 {not in Vi} | |
819 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit", | |
820 ":qall", ":exit", ":xit", ":recover" and closing the Vim window. | |
821 Setting this option also implies that Vim behaves like 'autowrite' has | |
822 been set. | |
823 | |
824 *'background'* *'bg'* | |
2826 | 825 'background' 'bg' string (default "dark" or "light", see below) |
7 | 826 global |
827 {not in Vi} | |
828 When set to "dark", Vim will try to use colors that look good on a | |
829 dark background. When set to "light", Vim will try to use colors that | |
830 look good on a light background. Any other value is illegal. | |
831 Vim tries to set the default value according to the terminal used. | |
832 This will not always be correct. | |
833 Setting this option does not change the background color, it tells Vim | |
834 what the background color looks like. For changing the background | |
835 color, see |:hi-normal|. | |
836 | |
837 When 'background' is set Vim will adjust the default color groups for | |
10 | 838 the new value. But the colors used for syntax highlighting will not |
1621 | 839 change. *g:colors_name* |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
840 When a color scheme is loaded (the "g:colors_name" variable is set) |
7 | 841 setting 'background' will cause the color scheme to be reloaded. If |
842 the color scheme adjusts to the value of 'background' this will work. | |
843 However, if the color scheme sets 'background' itself the effect may | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
844 be undone. First delete the "g:colors_name" variable when needed. |
7 | 845 |
846 When setting 'background' to the default value with: > | |
847 :set background& | |
848 < Vim will guess the value. In the GUI this should work correctly, | |
849 in other cases Vim might not be able to guess the right value. | |
850 | |
851 When starting the GUI, the default value for 'background' will be | |
852 "light". When the value is not set in the .gvimrc, and Vim detects | |
853 that the background is actually quite dark, 'background' is set to | |
854 "dark". But this happens only AFTER the .gvimrc file has been read | |
855 (because the window needs to be opened to find the actual background | |
856 color). To get around this, force the GUI window to be opened by | |
857 putting a ":gui" command in the .gvimrc file, before where the value | |
858 of 'background' is used (e.g., before ":syntax on"). | |
2826 | 859 |
860 For MS-DOS, Windows and OS/2 the default is "dark". | |
861 For other systems "dark" is used when 'term' is "linux", | |
862 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark | |
863 background. Otherwise the default is "light". | |
864 | |
7 | 865 Normally this option would be set in the .vimrc file. Possibly |
866 depending on the terminal name. Example: > | |
867 :if &term == "pcterm" | |
868 : set background=dark | |
869 :endif | |
870 < When this option is set, the default settings for the highlight groups | |
871 will change. To use other settings, place ":highlight" commands AFTER | |
872 the setting of the 'background' option. | |
873 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file | |
874 to select the colors for syntax highlighting. After changing this | |
875 option, you must load syntax.vim again to see the result. This can be | |
876 done with ":syntax on". | |
877 | |
878 *'backspace'* *'bs'* | |
879 'backspace' 'bs' string (default "") | |
880 global | |
881 {not in Vi} | |
882 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert | |
883 mode. This is a list of items, separated by commas. Each item allows | |
884 a way to backspace over something: | |
885 value effect ~ | |
886 indent allow backspacing over autoindent | |
887 eol allow backspacing over line breaks (join lines) | |
888 start allow backspacing over the start of insert; CTRL-W and CTRL-U | |
889 stop once at the start of insert. | |
890 | |
891 When the value is empty, Vi compatible backspacing is used. | |
892 | |
893 For backwards compatibility with version 5.4 and earlier: | |
894 value effect ~ | |
895 0 same as ":set backspace=" (Vi compatible) | |
896 1 same as ":set backspace=indent,eol" | |
897 2 same as ":set backspace=indent,eol,start" | |
898 | |
899 See |:fixdel| if your <BS> or <Del> key does not do what you want. | |
900 NOTE: This option is set to "" when 'compatible' is set. | |
901 | |
902 *'backup'* *'bk'* *'nobackup'* *'nobk'* | |
903 'backup' 'bk' boolean (default off) | |
904 global | |
905 {not in Vi} | |
906 Make a backup before overwriting a file. Leave it around after the | |
907 file has been successfully written. If you do not want to keep the | |
908 backup file, but you do want a backup while the file is being | |
909 written, reset this option and set the 'writebackup' option (this is | |
910 the default). If you do not want a backup file at all reset both | |
10 | 911 options (use this if your file system is almost full). See the |
7 | 912 |backup-table| for more explanations. |
913 When the 'backupskip' pattern matches, a backup is not made anyway. | |
914 When 'patchmode' is set, the backup may be renamed to become the | |
915 oldest version of a file. | |
916 NOTE: This option is reset when 'compatible' is set. | |
917 | |
918 *'backupcopy'* *'bkc'* | |
919 'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto") | |
6243 | 920 global or local to buffer |global-local| |
7 | 921 {not in Vi} |
922 When writing a file and a backup is made, this option tells how it's | |
923 done. This is a comma separated list of words. | |
924 | |
925 The main values are: | |
926 "yes" make a copy of the file and overwrite the original one | |
927 "no" rename the file and write a new one | |
928 "auto" one of the previous, what works best | |
929 | |
930 Extra values that can be combined with the ones above are: | |
931 "breaksymlink" always break symlinks when writing | |
932 "breakhardlink" always break hardlinks when writing | |
933 | |
934 Making a copy and overwriting the original file: | |
935 - Takes extra time to copy the file. | |
936 + When the file has special attributes, is a (hard/symbolic) link or | |
937 has a resource fork, all this is preserved. | |
938 - When the file is a link the backup will have the name of the link, | |
939 not of the real file. | |
940 | |
941 Renaming the file and writing a new one: | |
942 + It's fast. | |
943 - Sometimes not all attributes of the file can be copied to the new | |
944 file. | |
945 - When the file is a link the new file will not be a link. | |
946 | |
947 The "auto" value is the middle way: When Vim sees that renaming file | |
948 is possible without side effects (the attributes can be passed on and | |
1152 | 949 the file is not a link) that is used. When problems are expected, a |
950 copy will be made. | |
7 | 951 |
952 The "breaksymlink" and "breakhardlink" values can be used in | |
953 combination with any of "yes", "no" and "auto". When included, they | |
954 force Vim to always break either symbolic or hard links by doing | |
955 exactly what the "no" option does, renaming the original file to | |
956 become the backup and writing a new file in its place. This can be | |
957 useful for example in source trees where all the files are symbolic or | |
958 hard links and any changes should stay in the local source tree, not | |
959 be propagated back to the original source. | |
960 *crontab* | |
961 One situation where "no" and "auto" will cause problems: A program | |
962 that opens a file, invokes Vim to edit that file, and then tests if | |
963 the open file was changed (through the file descriptor) will check the | |
10 | 964 backup file instead of the newly created file. "crontab -e" is an |
7 | 965 example. |
966 | |
967 When a copy is made, the original file is truncated and then filled | |
968 with the new text. This means that protection bits, owner and | |
969 symbolic links of the original file are unmodified. The backup file | |
10 | 970 however, is a new file, owned by the user who edited the file. The |
7 | 971 group of the backup is set to the group of the original file. If this |
972 fails, the protection bits for the group are made the same as for | |
973 others. | |
974 | |
975 When the file is renamed this is the other way around: The backup has | |
976 the same attributes of the original file, and the newly written file | |
977 is owned by the current user. When the file was a (hard/symbolic) | |
978 link, the new file will not! That's why the "auto" value doesn't | |
979 rename when the file is a link. The owner and group of the newly | |
980 written file will be set to the same ones as the original file, but | |
981 the system may refuse to do this. In that case the "auto" value will | |
982 again not rename the file. | |
983 | |
984 *'backupdir'* *'bdir'* | |
985 'backupdir' 'bdir' string (default for Amiga: ".,t:", | |
5555 | 986 for MS-DOS and Win32: ".,$TEMP,c:/tmp,c:/temp" |
7 | 987 for Unix: ".,~/tmp,~/") |
988 global | |
989 {not in Vi} | |
990 List of directories for the backup file, separated with commas. | |
991 - The backup file will be created in the first directory in the list | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
992 where this is possible. The directory must exist, Vim will not |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
993 create it for you. |
4186 | 994 - Empty means that no backup file will be created ( 'patchmode' is |
7 | 995 impossible!). Writing may fail because of this. |
996 - A directory "." means to put the backup file in the same directory | |
997 as the edited file. | |
33 | 998 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to |
7 | 999 put the backup file relative to where the edited file is. The |
1000 leading "." is replaced with the path name of the edited file. | |
1001 ("." inside a directory name has no special meaning). | |
1002 - Spaces after the comma are ignored, other spaces are considered part | |
1003 of the directory name. To have a space at the start of a directory | |
1004 name, precede it with a backslash. | |
1005 - To include a comma in a directory name precede it with a backslash. | |
1006 - A directory name may end in an '/'. | |
1007 - Environment variables are expanded |:set_env|. | |
1008 - Careful with '\' characters, type one before a space, type two to | |
1009 get one in the option (see |option-backslash|), for example: > | |
1010 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces | |
1011 < - For backwards compatibility with Vim version 3.0 a '>' at the start | |
1012 of the option is removed. | |
1013 See also 'backup' and 'writebackup' options. | |
1014 If you want to hide your backup files on Unix, consider this value: > | |
1015 :set backupdir=./.backup,~/.backup,.,/tmp | |
1016 < You must create a ".backup" directory in each directory and in your | |
1017 home directory for this to work properly. | |
1018 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
1019 directories from the list. This avoids problems when a future version | |
1020 uses another default. | |
1021 This option cannot be set from a |modeline| or in the |sandbox|, for | |
1022 security reasons. | |
1023 | |
1024 *'backupext'* *'bex'* *E589* | |
1025 'backupext' 'bex' string (default "~", for VMS: "_") | |
1026 global | |
1027 {not in Vi} | |
1028 String which is appended to a file name to make the name of the | |
1029 backup file. The default is quite unusual, because this avoids | |
1030 accidentally overwriting existing files with a backup file. You might | |
1031 prefer using ".bak", but make sure that you don't have files with | |
1032 ".bak" that you want to keep. | |
36 | 1033 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
7 | 1034 |
26 | 1035 If you like to keep a lot of backups, you could use a BufWritePre |
1036 autocommand to change 'backupext' just before writing the file to | |
1037 include a timestamp. > | |
1038 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~' | |
1039 < Use 'backupdir' to put the backup in a different directory. | |
1040 | |
7 | 1041 *'backupskip'* *'bsk'* |
1042 'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*") | |
1043 global | |
1044 {not in Vi} | |
1045 {not available when compiled without the |+wildignore| | |
1046 feature} | |
1047 A list of file patterns. When one of the patterns matches with the | |
1048 name of the file which is written, no backup file is created. Both | |
1049 the specified file name and the full path name of the file are used. | |
1050 The pattern is used like with |:autocmd|, see |autocmd-patterns|. | |
1051 Watch out for special characters, see |option-backslash|. | |
1052 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the | |
233 | 1053 default value. "/tmp/*" is only used for Unix. |
1152 | 1054 |
3513 | 1055 WARNING: Not having a backup file means that when Vim fails to write |
1056 your buffer correctly and then, for whatever reason, Vim exits, you | |
1057 lose both the original file and what you were writing. Only disable | |
1058 backups if you don't care about losing the file. | |
1059 | |
1152 | 1060 Note that environment variables are not expanded. If you want to use |
1061 $HOME you must expand it explicitly, e.g.: > | |
1062 :let backupskip = escape(expand('$HOME'), '\') . '/tmp/*' | |
1063 | |
1064 < Note that the default also makes sure that "crontab -e" works (when a | |
557 | 1065 backup would be made by renaming the original file crontab won't see |
1066 the newly created file). Also see 'backupcopy' and |crontab|. | |
7 | 1067 |
1068 *'balloondelay'* *'bdlay'* | |
1069 'balloondelay' 'bdlay' number (default: 600) | |
1070 global | |
1071 {not in Vi} | |
1072 {only available when compiled with the |+balloon_eval| | |
1073 feature} | |
1074 Delay in milliseconds before a balloon may pop up. See |balloon-eval|. | |
1075 | |
1076 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'* | |
1077 'ballooneval' 'beval' boolean (default off) | |
1078 global | |
1079 {not in Vi} | |
1080 {only available when compiled with the |+balloon_eval| | |
189 | 1081 feature} |
7 | 1082 Switch on the |balloon-eval| functionality. |
1083 | |
189 | 1084 *'balloonexpr'* *'bexpr'* |
1085 'balloonexpr' 'bexpr' string (default "") | |
790 | 1086 global or local to buffer |global-local| |
189 | 1087 {not in Vi} |
1088 {only available when compiled with the |+balloon_eval| | |
1089 feature} | |
782 | 1090 Expression for text to show in evaluation balloon. It is only used |
1091 when 'ballooneval' is on. These variables can be used: | |
189 | 1092 |
1093 v:beval_bufnr number of the buffer in which balloon is going to show | |
1094 v:beval_winnr number of the window | |
1095 v:beval_lnum line number | |
1096 v:beval_col column number (byte index) | |
1097 v:beval_text word under or after the mouse pointer | |
1098 | |
1099 The evaluation of the expression must not have side effects! | |
1100 Example: > | |
1101 function! MyBalloonExpr() | |
435 | 1102 return 'Cursor is at line ' . v:beval_lnum . |
189 | 1103 \', column ' . v:beval_col . |
1104 \ ' of file ' . bufname(v:beval_bufnr) . | |
1105 \ ' on word "' . v:beval_text . '"' | |
1106 endfunction | |
1107 set bexpr=MyBalloonExpr() | |
1108 set ballooneval | |
1109 < | |
1110 NOTE: The balloon is displayed only if the cursor is on a text | |
1111 character. If the result of evaluating 'balloonexpr' is not empty, | |
1112 Vim does not try to send a message to an external debugger (Netbeans | |
1113 or Sun Workshop). | |
1114 | |
3682 | 1115 The expression will be evaluated in the |sandbox| when set from a |
1116 modeline, see |sandbox-option|. | |
634 | 1117 |
1118 It is not allowed to change text or jump to another window while | |
1119 evaluating 'balloonexpr' |textlock|. | |
1120 | |
446 | 1121 To check whether line breaks in the balloon text work use this check: > |
435 | 1122 if has("balloon_multiline") |
714 | 1123 < When they are supported "\n" characters will start a new line. If the |
1124 expression evaluates to a |List| this is equal to using each List item | |
1125 as a string and putting "\n" in between them. | |
1126 | |
7 | 1127 *'binary'* *'bin'* *'nobinary'* *'nobin'* |
1128 'binary' 'bin' boolean (default off) | |
1129 local to buffer | |
1130 {not in Vi} | |
1131 This option should be set before editing a binary file. You can also | |
1132 use the |-b| Vim argument. When this option is switched on a few | |
1133 options will be changed (also when it already was on): | |
1134 'textwidth' will be set to 0 | |
1135 'wrapmargin' will be set to 0 | |
1136 'modeline' will be off | |
1137 'expandtab' will be off | |
1138 Also, 'fileformat' and 'fileformats' options will not be used, the | |
1139 file is read and written like 'fileformat' was "unix" (a single <NL> | |
1140 separates lines). | |
1141 The 'fileencoding' and 'fileencodings' options will not be used, the | |
1142 file is read without conversion. | |
1143 NOTE: When you start editing a(nother) file while the 'bin' option is | |
1144 on, settings from autocommands may change the settings again (e.g., | |
1145 'textwidth'), causing trouble when editing. You might want to set | |
1146 'bin' again when the file has been loaded. | |
1147 The previous values of these options are remembered and restored when | |
1148 'bin' is switched from on to off. Each buffer has its own set of | |
1149 saved option values. | |
1150 To edit a file with 'binary' set you can use the |++bin| argument. | |
1151 This avoids you have to do ":set bin", which would have effect for all | |
1152 files you edit. | |
1153 When writing a file the <EOL> for the last line is only written if | |
1154 there was one in the original file (normally Vim appends an <EOL> to | |
1155 the last line if there is none; this would make the file longer). See | |
1156 the 'endofline' option. | |
1157 | |
1158 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'* | |
1159 'bioskey' 'biosk' boolean (default on) | |
1160 global | |
1161 {not in Vi} {only for MS-DOS} | |
446 | 1162 When on the BIOS is called to obtain a keyboard character. This works |
7 | 1163 better to detect CTRL-C, but only works for the console. When using a |
1164 terminal over a serial port reset this option. | |
1165 Also see |'conskey'|. | |
1166 | |
1167 *'bomb'* *'nobomb'* | |
1168 'bomb' boolean (default off) | |
1169 local to buffer | |
1170 {not in Vi} | |
1171 {only available when compiled with the |+multi_byte| | |
1172 feature} | |
1173 When writing a file and the following conditions are met, a BOM (Byte | |
1174 Order Mark) is prepended to the file: | |
1175 - this option is on | |
1176 - the 'binary' option is off | |
1177 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big | |
1178 endian variants. | |
1179 Some applications use the BOM to recognize the encoding of the file. | |
1180 Often used for UCS-2 files on MS-Windows. For other applications it | |
1181 causes trouble, for example: "cat file1 file2" makes the BOM of file2 | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
1182 appear halfway the resulting file. Gcc doesn't accept a BOM. |
7 | 1183 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a |
1184 check for the presence of the BOM is done and 'bomb' set accordingly. | |
1185 Unless 'binary' is set, it is removed from the first line, so that you | |
1186 don't see it when editing. When you don't change the options, the BOM | |
1187 will be restored when writing the file. | |
1188 | |
1189 *'breakat'* *'brk'* | |
1190 'breakat' 'brk' string (default " ^I!@*-+;:,./?") | |
1191 global | |
1192 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
1193 {not available when compiled without the |+linebreak| |
7 | 1194 feature} |
1195 This option lets you choose which characters might cause a line | |
500 | 1196 break if 'linebreak' is on. Only works for ASCII and also for 8-bit |
1197 characters when 'encoding' is an 8-bit encoding. | |
7 | 1198 |
6009 | 1199 *'breakindent'* *'bri'* |
1200 'breakindent' 'bri' boolean (default off) | |
1201 local to window | |
1202 {not in Vi} | |
1203 {not available when compiled without the |+linebreak| | |
1204 feature} | |
1205 Every wrapped line will continue visually indented (same amount of | |
1206 space as the beginning of that line), thus preserving horizontal blocks | |
1207 of text. | |
1208 | |
1209 *'breakindentopt'* *'briopt'* | |
1210 'breakindentopt' 'briopt' string (default empty) | |
1211 local to window | |
1212 {not in Vi} | |
1213 {not available when compiled without the |+linebreak| | |
1214 feature} | |
1215 Settings for 'breakindent'. It can consist of the following optional | |
6026 | 1216 items and must be separated by a comma: |
6009 | 1217 min:{n} Minimum text width that will be kept after |
1218 applying 'breakindent', even if the resulting | |
1219 text should normally be narrower. This prevents | |
1220 text indented almost to the right window border | |
1221 occupying lot of vertical space when broken. | |
6026 | 1222 shift:{n} After applying 'breakindent', the wrapped line's |
1223 beginning will be shifted by the given number of | |
1224 characters. It permits dynamic French paragraph | |
6009 | 1225 indentation (negative) or emphasizing the line |
1226 continuation (positive). | |
1227 sbr Display the 'showbreak' value before applying the | |
1228 additional indent. | |
1229 The default value for min is 20 and shift is 0. | |
1230 | |
7 | 1231 *'browsedir'* *'bsdir'* |
29 | 1232 'browsedir' 'bsdir' string (default: "last") |
7 | 1233 global |
1621 | 1234 {not in Vi} {only for Motif, Athena, GTK, Mac and |
1235 Win32 GUI} | |
7 | 1236 Which directory to use for the file browser: |
1621 | 1237 last Use same directory as with last file browser, where a |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
1238 file was opened or saved. |
7 | 1239 buffer Use the directory of the related buffer. |
1240 current Use the current directory. | |
1241 {path} Use the specified directory | |
1242 | |
1243 *'bufhidden'* *'bh'* | |
1244 'bufhidden' 'bh' string (default: "") | |
1245 local to buffer | |
1246 {not in Vi} | |
1247 {not available when compiled without the |+quickfix| | |
1248 feature} | |
1249 This option specifies what happens when a buffer is no longer | |
1250 displayed in a window: | |
1251 <empty> follow the global 'hidden' option | |
1252 hide hide the buffer (don't unload it), also when 'hidden' | |
1253 is not set | |
1254 unload unload the buffer, also when 'hidden' is set or using | |
1255 |:hide| | |
1256 delete delete the buffer from the buffer list, also when | |
1257 'hidden' is set or using |:hide|, like using | |
1258 |:bdelete| | |
1259 wipe wipe out the buffer from the buffer list, also when | |
1260 'hidden' is set or using |:hide|, like using | |
1261 |:bwipeout| | |
1262 | |
82 | 1263 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer |
3224 | 1264 are lost without a warning. Also, these values may break autocommands |
1265 that switch between buffers temporarily. | |
7 | 1266 This option is used together with 'buftype' and 'swapfile' to specify |
1267 special kinds of buffers. See |special-buffers|. | |
1268 | |
1269 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85* | |
1270 'buflisted' 'bl' boolean (default: on) | |
1271 local to buffer | |
1272 {not in Vi} | |
1273 When this option is set, the buffer shows up in the buffer list. If | |
1274 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc. | |
1275 This option is reset by Vim for buffers that are only used to remember | |
1276 a file name or marks. Vim sets it when starting to edit a buffer. | |
1277 But not when moving to a buffer with ":buffer". | |
1278 | |
1279 *'buftype'* *'bt'* *E382* | |
1280 'buftype' 'bt' string (default: "") | |
1281 local to buffer | |
1282 {not in Vi} | |
1283 {not available when compiled without the |+quickfix| | |
1284 feature} | |
1285 The value of this option specifies the type of a buffer: | |
1286 <empty> normal buffer | |
1287 nofile buffer which is not related to a file and will not be | |
1288 written | |
1289 nowrite buffer which will not be written | |
17 | 1290 acwrite buffer which will always be written with BufWriteCmd |
856 | 1291 autocommands. {not available when compiled without the |
17 | 1292 |+autocmd| feature} |
7 | 1293 quickfix quickfix buffer, contains list of errors |:cwindow| |
648 | 1294 or list of locations |:lwindow| |
7 | 1295 help help buffer (you are not supposed to set this |
1296 manually) | |
1297 | |
1298 This option is used together with 'bufhidden' and 'swapfile' to | |
1299 specify special kinds of buffers. See |special-buffers|. | |
1300 | |
1301 Be careful with changing this option, it can have many side effects! | |
1302 | |
648 | 1303 A "quickfix" buffer is only used for the error list and the location |
1304 list. This value is set by the |:cwindow| and |:lwindow| commands and | |
1305 you are not supposed to change it. | |
7 | 1306 |
1307 "nofile" and "nowrite" buffers are similar: | |
1308 both: The buffer is not to be written to disk, ":w" doesn't | |
1309 work (":w filename" does work though). | |
1310 both: The buffer is never considered to be |'modified'|. | |
1311 There is no warning when the changes will be lost, for | |
1312 example when you quit Vim. | |
1313 both: A swap file is only created when using too much memory | |
1314 (when 'swapfile' has been reset there is never a swap | |
1315 file). | |
1316 nofile only: The buffer name is fixed, it is not handled like a | |
1317 file name. It is not modified in response to a |:cd| | |
1318 command. | |
6647 | 1319 both: When using ":e bufname" and already editing "bufname" |
1320 the buffer is made empty and autocommands are | |
1321 triggered as usual for |:edit|. | |
17 | 1322 *E676* |
1323 "acwrite" implies that the buffer name is not related to a file, like | |
1324 "nofile", but it will be written. Thus, in contrast to "nofile" and | |
1325 "nowrite", ":w" does work and a modified buffer can't be abandoned | |
1326 without saving. For writing there must be matching |BufWriteCmd|, | |
1327 |FileWriteCmd| or |FileAppendCmd| autocommands. | |
7 | 1328 |
1329 *'casemap'* *'cmp'* | |
1330 'casemap' 'cmp' string (default: "internal,keepascii") | |
1331 global | |
1332 {not in Vi} | |
804 | 1333 {only available when compiled with the |+multi_byte| |
1334 feature} | |
7 | 1335 Specifies details about changing the case of letters. It may contain |
1336 these words, separated by a comma: | |
1337 internal Use internal case mapping functions, the current | |
1338 locale does not change the case mapping. This only | |
493 | 1339 matters when 'encoding' is a Unicode encoding, |
1340 "latin1" or "iso-8859-15". When "internal" is | |
1341 omitted, the towupper() and towlower() system library | |
1342 functions are used when available. | |
7 | 1343 keepascii For the ASCII characters (0x00 to 0x7f) use the US |
1344 case mapping, the current locale is not effective. | |
1345 This probably only matters for Turkish. | |
1346 | |
1347 *'cdpath'* *'cd'* *E344* *E346* | |
1348 'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,") | |
1349 global | |
1350 {not in Vi} | |
1351 {not available when compiled without the | |
1352 |+file_in_path| feature} | |
1353 This is a list of directories which will be searched when using the | |
1354 |:cd| and |:lcd| commands, provided that the directory being searched | |
1668 | 1355 for has a relative path, not an absolute part starting with "/", "./" |
1356 or "../", the 'cdpath' option is not used then. | |
7 | 1357 The 'cdpath' option's value has the same form and semantics as |
1358 |'path'|. Also see |file-searching|. | |
1359 The default value is taken from $CDPATH, with a "," prepended to look | |
1360 in the current directory first. | |
1361 If the default value taken from $CDPATH is not what you want, include | |
1362 a modified version of the following command in your vimrc file to | |
1363 override it: > | |
1364 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g') | |
1365 < This option cannot be set from a |modeline| or in the |sandbox|, for | |
1366 security reasons. | |
1367 (parts of 'cdpath' can be passed to the shell to expand file names). | |
1368 | |
1369 *'cedit'* | |
1370 'cedit' string (Vi default: "", Vim default: CTRL-F) | |
1371 global | |
1372 {not in Vi} | |
1373 {not available when compiled without the |+vertsplit| | |
1374 feature} | |
1375 The key used in Command-line Mode to open the command-line window. | |
1376 The default is CTRL-F when 'compatible' is off. | |
1377 Only non-printable keys are allowed. | |
1378 The key can be specified as a single character, but it is difficult to | |
1379 type. The preferred way is to use the <> notation. Examples: > | |
1380 :set cedit=<C-Y> | |
1381 :set cedit=<Esc> | |
1382 < |Nvi| also has this option, but it only uses the first character. | |
1383 See |cmdwin|. | |
1384 | |
1385 *'charconvert'* *'ccv'* *E202* *E214* *E513* | |
1386 'charconvert' 'ccv' string (default "") | |
1387 global | |
1388 {only available when compiled with the |+multi_byte| | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
1389 and |+eval| features} |
7 | 1390 {not in Vi} |
1391 An expression that is used for character encoding conversion. It is | |
1392 evaluated when a file that is to be read or has been written has a | |
1393 different encoding from what is desired. | |
1394 'charconvert' is not used when the internal iconv() function is | |
1395 supported and is able to do the conversion. Using iconv() is | |
1396 preferred, because it is much faster. | |
1397 'charconvert' is not used when reading stdin |--|, because there is no | |
1398 file to convert from. You will have to save the text in a file first. | |
1399 The expression must return zero or an empty string for success, | |
1400 non-zero for failure. | |
1401 The possible encoding names encountered are in 'encoding'. | |
1402 Additionally, names given in 'fileencodings' and 'fileencoding' are | |
1403 used. | |
1404 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8" | |
1405 is done internally by Vim, 'charconvert' is not used for this. | |
1406 'charconvert' is also used to convert the viminfo file, if the 'c' | |
1407 flag is present in 'viminfo'. Also used for Unicode conversion. | |
1408 Example: > | |
1409 set charconvert=CharConvert() | |
1410 fun CharConvert() | |
1411 system("recode " | |
1412 \ . v:charconvert_from . ".." . v:charconvert_to | |
1413 \ . " <" . v:fname_in . " >" v:fname_out) | |
1414 return v:shell_error | |
1415 endfun | |
1416 < The related Vim variables are: | |
1417 v:charconvert_from name of the current encoding | |
1418 v:charconvert_to name of the desired encoding | |
1419 v:fname_in name of the input file | |
1420 v:fname_out name of the output file | |
1421 Note that v:fname_in and v:fname_out will never be the same. | |
1422 Note that v:charconvert_from and v:charconvert_to may be different | |
1423 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4. | |
1424 Encryption is not done by Vim when using 'charconvert'. If you want | |
1425 to encrypt the file after conversion, 'charconvert' should take care | |
1426 of this. | |
1427 This option cannot be set from a |modeline| or in the |sandbox|, for | |
1428 security reasons. | |
1429 | |
1430 *'cindent'* *'cin'* *'nocindent'* *'nocin'* | |
1431 'cindent' 'cin' boolean (default off) | |
1432 local to buffer | |
1433 {not in Vi} | |
1434 {not available when compiled without the |+cindent| | |
1435 feature} | |
1621 | 1436 Enables automatic C program indenting. See 'cinkeys' to set the keys |
7 | 1437 that trigger reindenting in insert mode and 'cinoptions' to set your |
1438 preferred indent style. | |
1439 If 'indentexpr' is not empty, it overrules 'cindent'. | |
1440 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty, | |
1441 the "=" operator indents using this algorithm rather than calling an | |
1442 external program. | |
1443 See |C-indenting|. | |
1444 When you don't like the way 'cindent' works, try the 'smartindent' | |
1445 option or 'indentexpr'. | |
1446 This option is not used when 'paste' is set. | |
1447 NOTE: This option is reset when 'compatible' is set. | |
1448 | |
1449 *'cinkeys'* *'cink'* | |
1450 'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e") | |
1451 local to buffer | |
1452 {not in Vi} | |
1453 {not available when compiled without the |+cindent| | |
1454 feature} | |
1455 A list of keys that, when typed in Insert mode, cause reindenting of | |
1456 the current line. Only used if 'cindent' is on and 'indentexpr' is | |
1457 empty. | |
1458 For the format of this option see |cinkeys-format|. | |
1459 See |C-indenting|. | |
1460 | |
1461 *'cinoptions'* *'cino'* | |
1462 'cinoptions' 'cino' string (default "") | |
1463 local to buffer | |
1464 {not in Vi} | |
1465 {not available when compiled without the |+cindent| | |
1466 feature} | |
1467 The 'cinoptions' affect the way 'cindent' reindents lines in a C | |
1468 program. See |cinoptions-values| for the values of this option, and | |
1469 |C-indenting| for info on C indenting in general. | |
1470 | |
1471 | |
1472 *'cinwords'* *'cinw'* | |
1473 'cinwords' 'cinw' string (default "if,else,while,do,for,switch") | |
1474 local to buffer | |
1475 {not in Vi} | |
1476 {not available when compiled without both the | |
1477 |+cindent| and the |+smartindent| features} | |
1478 These keywords start an extra indent in the next line when | |
1479 'smartindent' or 'cindent' is set. For 'cindent' this is only done at | |
1480 an appropriate place (inside {}). | |
1481 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't | |
1482 matter, include the keyword both the uppercase and lowercase: | |
1483 "if,If,IF". | |
1484 | |
1485 *'clipboard'* *'cb'* | |
1486 'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux" | |
1487 for X-windows, "" otherwise) | |
1488 global | |
1489 {not in Vi} | |
1490 {only in GUI versions or when the |+xterm_clipboard| | |
1491 feature is included} | |
1492 This option is a list of comma separated names. | |
1493 These names are recognized: | |
1494 | |
3674 | 1495 *clipboard-unnamed* |
7 | 1496 unnamed When included, Vim will use the clipboard register '*' |
1497 for all yank, delete, change and put operations which | |
1498 would normally go to the unnamed register. When a | |
1499 register is explicitly specified, it will always be | |
1500 used regardless of whether "unnamed" is in 'clipboard' | |
1501 or not. The clipboard register can always be | |
1502 explicitly accessed using the "* notation. Also see | |
1503 |gui-clipboard|. | |
1504 | |
3682 | 1505 *clipboard-unnamedplus* |
4119 | 1506 unnamedplus A variant of the "unnamed" flag which uses the |
1507 clipboard register '+' (|quoteplus|) instead of | |
1508 register '*' for all yank, delete, change and put | |
1509 operations which would normally go to the unnamed | |
1510 register. When "unnamed" is also included to the | |
1511 option, yank operations (but not delete, change or | |
1512 put) will additionally copy the text into register | |
1513 '*'. | |
2662 | 1514 Only available with the |+X11| feature. |
2654 | 1515 Availability can be checked with: > |
1516 if has('unnamedplus') | |
1517 < | |
3682 | 1518 *clipboard-autoselect* |
7 | 1519 autoselect Works like the 'a' flag in 'guioptions': If present, |
1520 then whenever Visual mode is started, or the Visual | |
1521 area extended, Vim tries to become the owner of the | |
1522 windowing system's global selection or put the | |
1523 selected text on the clipboard used by the selection | |
1524 register "*. See |guioptions_a| and |quotestar| for | |
1525 details. When the GUI is active, the 'a' flag in | |
1526 'guioptions' is used, when the GUI is not active, this | |
1527 "autoselect" flag is used. | |
1528 Also applies to the modeless selection. | |
1529 | |
3674 | 1530 *clipboard-autoselectplus* |
1531 autoselectplus Like "autoselect" but using the + register instead of | |
1532 the * register. Compare to the 'P' flag in | |
1533 'guioptions'. | |
1534 | |
1535 *clipboard-autoselectml* | |
7 | 1536 autoselectml Like "autoselect", but for the modeless selection |
1537 only. Compare to the 'A' flag in 'guioptions'. | |
1538 | |
3674 | 1539 *clipboard-html* |
1904 | 1540 html When the clipboard contains HTML, use this when |
1541 pasting. When putting text on the clipboard, mark it | |
1542 as HTML. This works to copy rendered HTML from | |
1543 Firefox, paste it as raw HTML in Vim, select the HTML | |
1544 in Vim and paste it in a rich edit box in Firefox. | |
2240
6b4879aea261
Add test for gettabvar() and settabvar().
Bram Moolenaar <bram@vim.org>
parents:
2220
diff
changeset
|
1545 You probably want to add this only temporarily, |
6b4879aea261
Add test for gettabvar() and settabvar().
Bram Moolenaar <bram@vim.org>
parents:
2220
diff
changeset
|
1546 possibly use BufEnter autocommands. |
1904 | 1547 Only supported for GTK version 2 and later. |
1548 Only available with the |+multi_byte| feature. | |
1549 | |
3674 | 1550 *clipboard-exclude* |
7 | 1551 exclude:{pattern} |
1552 Defines a pattern that is matched against the name of | |
1553 the terminal 'term'. If there is a match, no | |
1554 connection will be made to the X server. This is | |
1555 useful in this situation: | |
1556 - Running Vim in a console. | |
1557 - $DISPLAY is set to start applications on another | |
1558 display. | |
1559 - You do not want to connect to the X server in the | |
1560 console, but do want this in a terminal emulator. | |
1561 To never connect to the X server use: > | |
1562 exclude:.* | |
1563 < This has the same effect as using the |-X| argument. | |
1564 Note that when there is no connection to the X server | |
1565 the window title won't be restored and the clipboard | |
1566 cannot be accessed. | |
1567 The value of 'magic' is ignored, {pattern} is | |
1568 interpreted as if 'magic' was on. | |
1569 The rest of the option value will be used for | |
1570 {pattern}, this must be the last entry. | |
1571 | |
1572 *'cmdheight'* *'ch'* | |
1573 'cmdheight' 'ch' number (default 1) | |
1574 global | |
1575 {not in Vi} | |
1576 Number of screen lines to use for the command-line. Helps avoiding | |
1577 |hit-enter| prompts. | |
824 | 1578 The value of this option is stored with the tab page, so that each tab |
1579 page can have a different value. | |
7 | 1580 |
1581 *'cmdwinheight'* *'cwh'* | |
1582 'cmdwinheight' 'cwh' number (default 7) | |
1583 global | |
1584 {not in Vi} | |
1585 {not available when compiled without the |+vertsplit| | |
1586 feature} | |
1587 Number of screen lines to use for the command-line window. |cmdwin| | |
1588 | |
2608
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1589 *'colorcolumn'* *'cc'* |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1590 'colorcolumn' 'cc' string (default "") |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1591 local to window |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1592 {not in Vi} |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1593 {not available when compiled without the |+syntax| |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1594 feature} |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1595 'colorcolumn' is a comma separated list of screen columns that are |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1596 highlighted with ColorColumn |hl-ColorColumn|. Useful to align |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1597 text. Will make screen redrawing slower. |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1598 The screen column can be an absolute number, or a number preceded with |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1599 '+' or '-', which is added to or subtracted from 'textwidth'. > |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1600 |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1601 :set cc=+1 " highlight column after 'textwidth' |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1602 :set cc=+1,+2,+3 " highlight three columns after 'textwidth' |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1603 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1604 < |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1605 When 'textwidth' is zero then the items with '-' and '+' are not used. |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1606 A maximum of 256 columns are highlighted. |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1607 |
7 | 1608 *'columns'* *'co'* *E594* |
1609 'columns' 'co' number (default 80 or terminal width) | |
1610 global | |
1611 {not in Vi} | |
1612 Number of columns of the screen. Normally this is set by the terminal | |
161 | 1613 initialization and does not have to be set by hand. Also see |
1614 |posix-screen-size|. | |
7 | 1615 When Vim is running in the GUI or in a resizable window, setting this |
1616 option will cause the window size to be changed. When you only want | |
1617 to use the size for the GUI, put the command in your |gvimrc| file. | |
1618 When you set this option and Vim is unable to change the physical | |
1152 | 1619 number of columns of the display, the display may be messed up. For |
1620 the GUI it is always possible and Vim limits the number of columns to | |
1621 what fits on the screen. You can use this command to get the widest | |
1622 window possible: > | |
1623 :set columns=9999 | |
1624 < Minimum value is 12, maximum value is 10000. | |
7 | 1625 |
1626 *'comments'* *'com'* *E524* *E525* | |
1627 'comments' 'com' string (default | |
1628 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-") | |
1629 local to buffer | |
1630 {not in Vi} | |
1631 {not available when compiled without the |+comments| | |
1632 feature} | |
1633 A comma separated list of strings that can start a comment line. See | |
1634 |format-comments|. See |option-backslash| about using backslashes to | |
1635 insert a space. | |
1636 | |
1637 *'commentstring'* *'cms'* *E537* | |
1638 'commentstring' 'cms' string (default "/*%s*/") | |
1639 local to buffer | |
1640 {not in Vi} | |
1641 {not available when compiled without the |+folding| | |
1642 feature} | |
1643 A template for a comment. The "%s" in the value is replaced with the | |
1644 comment text. Currently only used to add markers for folding, see | |
1645 |fold-marker|. | |
1646 | |
1647 *'compatible'* *'cp'* *'nocompatible'* *'nocp'* | |
819 | 1648 'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc| |
1649 file is found) | |
7 | 1650 global |
1651 {not in Vi} | |
1652 This option has the effect of making Vim either more Vi-compatible, or | |
1653 make Vim behave in a more useful way. | |
1654 This is a special kind of option, because when it's set or reset, | |
1655 other options are also changed as a side effect. CAREFUL: Setting or | |
1656 resetting this option can have a lot of unexpected effects: Mappings | |
10 | 1657 are interpreted in another way, undo behaves differently, etc. If you |
7 | 1658 set this option in your vimrc file, you should probably put it at the |
1659 very start. | |
1660 By default this option is on and the Vi defaults are used for the | |
1661 options. This default was chosen for those people who want to use Vim | |
1662 just like Vi, and don't even (want to) know about the 'compatible' | |
1663 option. | |
819 | 1664 When a |vimrc| or |gvimrc| file is found while Vim is starting up, |
378 | 1665 this option is switched off, and all options that have not been |
1666 modified will be set to the Vim defaults. Effectively, this means | |
819 | 1667 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim |
378 | 1668 defaults, otherwise it will use the Vi defaults. (Note: This doesn't |
1152 | 1669 happen for the system-wide vimrc or gvimrc file, nor for a file given |
1670 with the |-u| argument). Also see |compatible-default| and | |
1671 |posix-compliance|. | |
7 | 1672 You can also set this option with the "-C" argument, and reset it with |
1673 "-N". See |-C| and |-N|. | |
1674 Switching this option off makes the Vim defaults be used for options | |
1675 that have a different Vi and Vim default value. See the options | |
1676 marked with a '+' below. Other options are not modified. | |
1677 At the moment this option is set, several other options will be set | |
1678 or reset to make Vim as Vi-compatible as possible. See the table | |
10 | 1679 below. This can be used if you want to revert to Vi compatible |
7 | 1680 editing. |
1681 See also 'cpoptions'. | |
1682 | |
1683 option + set value effect ~ | |
1684 | |
1685 'allowrevins' off no CTRL-_ command | |
1686 'backupcopy' Unix: "yes" backup file is a copy | |
1687 others: "auto" copy or rename backup file | |
1688 'backspace' "" normal backspace | |
1689 'backup' off no backup file | |
1690 'cindent' off no C code indentation | |
1691 'cedit' + "" no key to open the |cmdwin| | |
1692 'cpoptions' + (all flags) Vi-compatible flags | |
1693 'cscopetag' off don't use cscope for ":tag" | |
1694 'cscopetagorder' 0 see |cscopetagorder| | |
1695 'cscopeverbose' off see |cscopeverbose| | |
1696 'digraph' off no digraphs | |
1697 'esckeys' + off no <Esc>-keys in Insert mode | |
1698 'expandtab' off tabs not expanded to spaces | |
1699 'fileformats' + "" no automatic file format detection, | |
1700 "dos,unix" except for DOS, Windows and OS/2 | |
1701 'formatoptions' + "vt" Vi compatible formatting | |
1702 'gdefault' off no default 'g' flag for ":s" | |
1703 'history' + 0 no commandline history | |
1704 'hkmap' off no Hebrew keyboard mapping | |
1705 'hkmapp' off no phonetic Hebrew keyboard mapping | |
1706 'hlsearch' off no highlighting of search matches | |
1707 'incsearch' off no incremental searching | |
1708 'indentexpr' "" no indenting by expression | |
1709 'insertmode' off do not start in Insert mode | |
1710 'iskeyword' + "@,48-57,_" keywords contain alphanumeric | |
1711 characters and '_' | |
1712 'joinspaces' on insert 2 spaces after period | |
1713 'modeline' + off no modelines | |
1714 'more' + off no pauses in listings | |
1715 'revins' off no reverse insert | |
1716 'ruler' off no ruler | |
1717 'scrolljump' 1 no jump scroll | |
1718 'scrolloff' 0 no scroll offset | |
1719 'shiftround' off indent not rounded to shiftwidth | |
1720 'shortmess' + "" no shortening of messages | |
1721 'showcmd' + off command characters not shown | |
1722 'showmode' + off current mode not shown | |
1723 'smartcase' off no automatic ignore case switch | |
1724 'smartindent' off no smart indentation | |
1725 'smarttab' off no smart tab size | |
1726 'softtabstop' 0 tabs are always 'tabstop' positions | |
1727 'startofline' on goto startofline with some commands | |
1728 'tagrelative' + off tag file names are not relative | |
1729 'textauto' + off no automatic textmode detection | |
1730 'textwidth' 0 no automatic line wrap | |
1731 'tildeop' off tilde is not an operator | |
1732 'ttimeout' off no terminal timeout | |
1733 'whichwrap' + "" left-right movements don't wrap | |
1734 'wildchar' + CTRL-E only when the current value is <Tab> | |
1735 use CTRL-E for cmdline completion | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
1736 'writebackup' on or off depends on the |+writebackup| feature |
7 | 1737 |
1738 *'complete'* *'cpt'* *E535* | |
1739 'complete' 'cpt' string (default: ".,w,b,u,t,i") | |
1740 local to buffer | |
1741 {not in Vi} | |
1742 This option specifies how keyword completion |ins-completion| works | |
1743 when CTRL-P or CTRL-N are used. It is also used for whole-line | |
1744 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion | |
1745 and the places to scan. It is a comma separated list of flags: | |
4186 | 1746 . scan the current buffer ( 'wrapscan' is ignored) |
7 | 1747 w scan buffers from other windows |
1748 b scan other loaded buffers that are in the buffer list | |
1749 u scan the unloaded buffers that are in the buffer list | |
1750 U scan the buffers that are not in the buffer list | |
1751 k scan the files given with the 'dictionary' option | |
703 | 1752 kspell use the currently active spell checking |spell| |
7 | 1753 k{dict} scan the file {dict}. Several "k" flags can be given, |
1754 patterns are valid too. For example: > | |
1755 :set cpt=k/usr/dict/*,k~/spanish | |
1756 < s scan the files given with the 'thesaurus' option | |
1757 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns | |
1758 are valid too. | |
1759 i scan current and included files | |
1760 d scan current and included files for defined name or macro | |
1761 |i_CTRL-X_CTRL-D| | |
1762 ] tag completion | |
1763 t same as "]" | |
1764 | |
1765 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are | |
1766 not executed, this may lead to unexpected completions from some files | |
1767 (gzipped files for example). Unloaded buffers are not scanned for | |
1768 whole-line completion. | |
1769 | |
1770 The default is ".,w,b,u,t,i", which means to scan: | |
1771 1. the current buffer | |
1772 2. buffers in other windows | |
1773 3. other loaded buffers | |
1774 4. unloaded buffers | |
1775 5. tags | |
1776 6. included files | |
1777 | |
1778 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'- | |
233 | 1779 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns |
1780 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions). | |
7 | 1781 |
12 | 1782 *'completefunc'* *'cfu'* |
1783 'completefunc' 'cfu' string (default: empty) | |
1784 local to buffer | |
1785 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
1786 {not available when compiled without the |+eval| |
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
1787 or |+insert_expand| features} |
623 | 1788 This option specifies a function to be used for Insert mode completion |
1789 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U| | |
648 | 1790 See |complete-functions| for an explanation of how the function is |
1791 invoked and what it should return. | |
2642 | 1792 This option cannot be set from a |modeline| or in the |sandbox|, for |
1793 security reasons. | |
14 | 1794 |
540 | 1795 *'completeopt'* *'cot'* |
730 | 1796 'completeopt' 'cot' string (default: "menu,preview") |
540 | 1797 global |
766 | 1798 {not available when compiled without the |
1799 |+insert_expand| feature} | |
540 | 1800 {not in Vi} |
665 | 1801 A comma separated list of options for Insert mode completion |
1802 |ins-completion|. The supported values are: | |
540 | 1803 |
1804 menu Use a popup menu to show the possible completions. The | |
1805 menu is only shown when there is more than one match and | |
1806 sufficient colors are available. |ins-completion-menu| | |
1807 | |
707 | 1808 menuone Use the popup menu also when there is only one match. |
856 | 1809 Useful when there is additional information about the |
707 | 1810 match, e.g., what file it comes from. |
1811 | |
836 | 1812 longest Only insert the longest common text of the matches. If |
1813 the menu is displayed you can use CTRL-L to add more | |
1814 characters. Whether case is ignored depends on the kind | |
1815 of completion. For buffer text the 'ignorecase' option is | |
1816 used. | |
665 | 1817 |
730 | 1818 preview Show extra information about the currently selected |
1152 | 1819 completion in the preview window. Only works in |
1820 combination with "menu" or "menuone". | |
1821 | |
730 | 1822 |
2378
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1823 *'concealcursor'* *'cocu'* |
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1824 'concealcursor' 'cocu' string (default: "") |
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1825 local to window |
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1826 {not in Vi} |
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1827 {not available when compiled without the |+conceal| |
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1828 feature} |
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1829 Sets the modes in which text in the cursor line can also be concealed. |
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1830 When the current mode is listed then concealing happens just like in |
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1831 other lines. |
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1832 n Normal mode |
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1833 v Visual mode |
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1834 i Insert mode |
2382
3a5ededa240a
Add the 'c' flag to 'concealcursor'.
Bram Moolenaar <bram@vim.org>
parents:
2380
diff
changeset
|
1835 c Command line editing, for 'incsearch' |
3a5ededa240a
Add the 'c' flag to 'concealcursor'.
Bram Moolenaar <bram@vim.org>
parents:
2380
diff
changeset
|
1836 |
2400
e6f1424dd66a
Let 'v' flag in 'concealcursor' apply to all lines in the Visual area.
Bram Moolenaar <bram@vim.org>
parents:
2394
diff
changeset
|
1837 'v' applies to all lines in the Visual area, not only the cursor. |
2382
3a5ededa240a
Add the 'c' flag to 'concealcursor'.
Bram Moolenaar <bram@vim.org>
parents:
2380
diff
changeset
|
1838 A useful value is "nc". This is used in help files. So long as you |
2378
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1839 are moving around text is concealed, but when starting to insert text |
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1840 or selecting a Visual area the concealed text is displayed, so that |
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1841 you can see what you are doing. |
2380
b47748aa3236
Don't conceal text in lines inside the Visual area.
Bram Moolenaar <bram@vim.org>
parents:
2378
diff
changeset
|
1842 Keep in mind that the cursor position is not always where it's |
b47748aa3236
Don't conceal text in lines inside the Visual area.
Bram Moolenaar <bram@vim.org>
parents:
2378
diff
changeset
|
1843 displayed. E.g., when moving vertically it may change column. |
2378
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1844 |
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1845 |
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1846 'conceallevel' 'cole' *'conceallevel'* *'cole'* |
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
1847 number (default 0) |
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
1848 local to window |
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
1849 {not in Vi} |
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
1850 {not available when compiled without the |+conceal| |
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
1851 feature} |
2340
99c1eba60b2d
Make automatic prototype generation work with more interfaces.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
1852 Determine how text with the "conceal" syntax attribute |:syn-conceal| |
99c1eba60b2d
Make automatic prototype generation work with more interfaces.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
1853 is shown: |
99c1eba60b2d
Make automatic prototype generation work with more interfaces.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
1854 |
99c1eba60b2d
Make automatic prototype generation work with more interfaces.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
1855 Value Effect ~ |
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
1856 0 Text is shown normally |
2426 | 1857 1 Each block of concealed text is replaced with one |
1858 character. If the syntax item does not have a custom | |
1859 replacement character defined (see |:syn-cchar|) the | |
1860 character defined in 'listchars' is used (default is a | |
1861 space). | |
1862 It is highlighted with the "Conceal" highlight group. | |
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
1863 2 Concealed text is completely hidden unless it has a |
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
1864 custom replacement character defined (see |
2426 | 1865 |:syn-cchar|). |
2349
586a459f3980
Never hide text for conceal in cursor line. Do hide when there is
Bram Moolenaar <bram@vim.org>
parents:
2348
diff
changeset
|
1866 3 Concealed text is completely hidden. |
586a459f3980
Never hide text for conceal in cursor line. Do hide when there is
Bram Moolenaar <bram@vim.org>
parents:
2348
diff
changeset
|
1867 |
586a459f3980
Never hide text for conceal in cursor line. Do hide when there is
Bram Moolenaar <bram@vim.org>
parents:
2348
diff
changeset
|
1868 Note: in the cursor line concealed text is not hidden, so that you can |
2378
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1869 edit and copy the text. This can be changed with the 'concealcursor' |
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1870 option. |
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
1871 |
7 | 1872 *'confirm'* *'cf'* *'noconfirm'* *'nocf'* |
1873 'confirm' 'cf' boolean (default off) | |
1874 global | |
1875 {not in Vi} | |
1876 When 'confirm' is on, certain operations that would normally | |
1877 fail because of unsaved changes to a buffer, e.g. ":q" and ":e", | |
1878 instead raise a |dialog| asking if you wish to save the current | |
1879 file(s). You can still use a ! to unconditionally |abandon| a buffer. | |
1880 If 'confirm' is off you can still activate confirmation for one | |
1881 command only (this is most useful in mappings) with the |:confirm| | |
1882 command. | |
1883 Also see the |confirm()| function and the 'v' flag in 'guioptions'. | |
1884 | |
1885 *'conskey'* *'consk'* *'noconskey'* *'noconsk'* | |
1886 'conskey' 'consk' boolean (default off) | |
1887 global | |
1888 {not in Vi} {only for MS-DOS} | |
1889 When on direct console I/O is used to obtain a keyboard character. | |
10 | 1890 This should work in most cases. Also see |'bioskey'|. Together, |
7 | 1891 three methods of console input are available: |
1892 'conskey' 'bioskey' action ~ | |
1893 on on or off direct console input | |
1894 off on BIOS | |
1895 off off STDIN | |
1896 | |
1897 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'* | |
1898 'copyindent' 'ci' boolean (default off) | |
1899 local to buffer | |
1900 {not in Vi} | |
1901 Copy the structure of the existing lines indent when autoindenting a | |
1902 new line. Normally the new indent is reconstructed by a series of | |
1903 tabs followed by spaces as required (unless |'expandtab'| is enabled, | |
1904 in which case only spaces are used). Enabling this option makes the | |
1905 new line copy whatever characters were used for indenting on the | |
1621 | 1906 existing line. 'expandtab' has no effect on these characters, a Tab |
1907 remains a Tab. If the new indent is greater than on the existing | |
7 | 1908 line, the remaining space is filled in the normal manner. |
1909 NOTE: 'copyindent' is reset when 'compatible' is set. | |
1910 Also see 'preserveindent'. | |
1911 | |
1912 *'cpoptions'* *'cpo'* | |
1913 'cpoptions' 'cpo' string (Vim default: "aABceFs", | |
1914 Vi default: all flags) | |
1915 global | |
1916 {not in Vi} | |
1917 A sequence of single character flags. When a character is present | |
5340 | 1918 this indicates Vi-compatible behavior. This is used for things where |
1919 not being Vi-compatible is mostly or sometimes preferred. | |
7 | 1920 'cpoptions' stands for "compatible-options". |
1921 Commas can be added for readability. | |
1922 To avoid problems with flags that are added in the future, use the | |
1923 "+=" and "-=" feature of ":set" |add-option-flags|. | |
1924 NOTE: This option is set to the Vi default value when 'compatible' is | |
1925 set and to the Vim default value when 'compatible' is reset. | |
164 | 1926 NOTE: This option is set to the POSIX default value at startup when |
1927 the Vi default value would be used and the $VIM_POSIX environment | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
1928 variable exists |posix|. This means Vim tries to behave like the |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
1929 POSIX specification. |
7 | 1930 |
1931 contains behavior ~ | |
1932 *cpo-a* | |
1933 a When included, a ":read" command with a file name | |
1934 argument will set the alternate file name for the | |
1935 current window. | |
1936 *cpo-A* | |
1937 A When included, a ":write" command with a file name | |
1938 argument will set the alternate file name for the | |
1939 current window. | |
1940 *cpo-b* | |
1941 b "\|" in a ":map" command is recognized as the end of | |
1942 the map command. The '\' is included in the mapping, | |
1943 the text after the '|' is interpreted as the next | |
1944 command. Use a CTRL-V instead of a backslash to | |
1945 include the '|' in the mapping. Applies to all | |
1946 mapping, abbreviation, menu and autocmd commands. | |
1947 See also |map_bar|. | |
1948 *cpo-B* | |
1949 B A backslash has no special meaning in mappings, | |
1950 abbreviations and the "to" part of the menu commands. | |
1951 Remove this flag to be able to use a backslash like a | |
1952 CTRL-V. For example, the command ":map X \<Esc>" | |
1953 results in X being mapped to: | |
1954 'B' included: "\^[" (^[ is a real <Esc>) | |
1955 'B' excluded: "<Esc>" (5 characters) | |
1956 ('<' excluded in both cases) | |
1957 *cpo-c* | |
1958 c Searching continues at the end of any match at the | |
1959 cursor position, but not further than the start of the | |
1960 next line. When not present searching continues | |
1961 one character from the cursor position. With 'c' | |
1962 "abababababab" only gets three matches when repeating | |
1963 "/abab", without 'c' there are five matches. | |
1964 *cpo-C* | |
1965 C Do not concatenate sourced lines that start with a | |
1966 backslash. See |line-continuation|. | |
1967 *cpo-d* | |
1968 d Using "./" in the 'tags' option doesn't mean to use | |
1969 the tags file relative to the current file, but the | |
1970 tags file in the current directory. | |
1971 *cpo-D* | |
1972 D Can't use CTRL-K to enter a digraph after Normal mode | |
1973 commands with a character argument, like |r|, |f| and | |
1974 |t|. | |
1975 *cpo-e* | |
1976 e When executing a register with ":@r", always add a | |
1977 <CR> to the last line, also when the register is not | |
1978 linewise. If this flag is not present, the register | |
1979 is not linewise and the last line does not end in a | |
1980 <CR>, then the last line is put on the command-line | |
1981 and can be edited before hitting <CR>. | |
1982 *cpo-E* | |
1983 E It is an error when using "y", "d", "c", "g~", "gu" or | |
1984 "gU" on an Empty region. The operators only work when | |
1985 at least one character is to be operate on. Example: | |
1986 This makes "y0" fail in the first column. | |
1987 *cpo-f* | |
1988 f When included, a ":read" command with a file name | |
1989 argument will set the file name for the current buffer, | |
1990 if the current buffer doesn't have a file name yet. | |
1991 *cpo-F* | |
1992 F When included, a ":write" command with a file name | |
1993 argument will set the file name for the current | |
1994 buffer, if the current buffer doesn't have a file name | |
590 | 1995 yet. Also see |cpo-P|. |
7 | 1996 *cpo-g* |
1997 g Goto line 1 when using ":edit" without argument. | |
164 | 1998 *cpo-H* |
1999 H When using "I" on a line with only blanks, insert | |
2000 before the last blank. Without this flag insert after | |
2001 the last blank. | |
7 | 2002 *cpo-i* |
2003 i When included, interrupting the reading of a file will | |
2004 leave it modified. | |
10 | 2005 *cpo-I* |
2006 I When moving the cursor up or down just after inserting | |
2007 indent for 'autoindent', do not delete the indent. | |
7 | 2008 *cpo-j* |
2009 j When joining lines, only add two spaces after a '.', | |
2010 not after '!' or '?'. Also see 'joinspaces'. | |
2011 *cpo-J* | |
2012 J A |sentence| has to be followed by two spaces after | |
233 | 2013 the '.', '!' or '?'. A <Tab> is not recognized as |
7 | 2014 white space. |
2015 *cpo-k* | |
2016 k Disable the recognition of raw key codes in | |
2017 mappings, abbreviations, and the "to" part of menu | |
2018 commands. For example, if <Key> sends ^[OA (where ^[ | |
2019 is <Esc>), the command ":map X ^[OA" results in X | |
2020 being mapped to: | |
2021 'k' included: "^[OA" (3 characters) | |
2022 'k' excluded: "<Key>" (one key code) | |
2023 Also see the '<' flag below. | |
2024 *cpo-K* | |
2025 K Don't wait for a key code to complete when it is | |
2026 halfway a mapping. This breaks mapping <F1><F1> when | |
2027 only part of the second <F1> has been read. It | |
2028 enables cancelling the mapping by typing <F1><Esc>. | |
2029 *cpo-l* | |
2030 l Backslash in a [] range in a search pattern is taken | |
168 | 2031 literally, only "\]", "\^", "\-" and "\\" are special. |
2032 See |/[]| | |
7 | 2033 'l' included: "/[ \t]" finds <Space>, '\' and 't' |
2034 'l' excluded: "/[ \t]" finds <Space> and <Tab> | |
168 | 2035 Also see |cpo-\|. |
7 | 2036 *cpo-L* |
2037 L When the 'list' option is set, 'wrapmargin', | |
2038 'textwidth', 'softtabstop' and Virtual Replace mode | |
2039 (see |gR|) count a <Tab> as two characters, instead of | |
2040 the normal behavior of a <Tab>. | |
2041 *cpo-m* | |
2042 m When included, a showmatch will always wait half a | |
2043 second. When not included, a showmatch will wait half | |
2044 a second or until a character is typed. |'showmatch'| | |
2045 *cpo-M* | |
2046 M When excluded, "%" matching will take backslashes into | |
2047 account. Thus in "( \( )" and "\( ( \)" the outer | |
2048 parenthesis match. When included "%" ignores | |
2049 backslashes, which is Vi compatible. | |
2050 *cpo-n* | |
2178
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2051 n When included, the column used for 'number' and |
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2052 'relativenumber' will also be used for text of wrapped |
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2053 lines. |
7 | 2054 *cpo-o* |
2055 o Line offset to search command is not remembered for | |
2056 next search. | |
2057 *cpo-O* | |
2058 O Don't complain if a file is being overwritten, even | |
2059 when it didn't exist when editing it. This is a | |
2060 protection against a file unexpectedly created by | |
2061 someone else. Vi didn't complain about this. | |
2062 *cpo-p* | |
2063 p Vi compatible Lisp indenting. When not present, a | |
2064 slightly better algorithm is used. | |
590 | 2065 *cpo-P* |
2066 P When included, a ":write" command that appends to a | |
2067 file will set the file name for the current buffer, if | |
2068 the current buffer doesn't have a file name yet and | |
2069 the 'F' flag is also included |cpo-F|. | |
164 | 2070 *cpo-q* |
2071 q When joining multiple lines leave the cursor at the | |
2072 position where it would be when joining two lines. | |
7 | 2073 *cpo-r* |
2074 r Redo ("." command) uses "/" to repeat a search | |
2075 command, instead of the actually used search string. | |
2076 *cpo-R* | |
2077 R Remove marks from filtered lines. Without this flag | |
2078 marks are kept like |:keepmarks| was used. | |
2079 *cpo-s* | |
2080 s Set buffer options when entering the buffer for the | |
2081 first time. This is like it is in Vim version 3.0. | |
10 | 2082 And it is the default. If not present the options are |
7 | 2083 set when the buffer is created. |
2084 *cpo-S* | |
2085 S Set buffer options always when entering a buffer | |
2086 (except 'readonly', 'fileformat', 'filetype' and | |
2087 'syntax'). This is the (most) Vi compatible setting. | |
2088 The options are set to the values in the current | |
2089 buffer. When you change an option and go to another | |
2090 buffer, the value is copied. Effectively makes the | |
2091 buffer options global to all buffers. | |
2092 | |
2093 's' 'S' copy buffer options | |
2094 no no when buffer created | |
2095 yes no when buffer first entered (default) | |
2096 X yes each time when buffer entered (vi comp.) | |
2097 *cpo-t* | |
2098 t Search pattern for the tag command is remembered for | |
2099 "n" command. Otherwise Vim only puts the pattern in | |
2100 the history for search pattern, but doesn't change the | |
2101 last used search pattern. | |
2102 *cpo-u* | |
10 | 2103 u Undo is Vi compatible. See |undo-two-ways|. |
7 | 2104 *cpo-v* |
2105 v Backspaced characters remain visible on the screen in | |
2106 Insert mode. Without this flag the characters are | |
2107 erased from the screen right away. With this flag the | |
2108 screen newly typed text overwrites backspaced | |
2109 characters. | |
2110 *cpo-w* | |
2111 w When using "cw" on a blank character, only change one | |
2112 character and not all blanks until the start of the | |
2113 next word. | |
2114 *cpo-W* | |
2115 W Don't overwrite a readonly file. When omitted, ":w!" | |
2116 overwrites a readonly file, if possible. | |
2117 *cpo-x* | |
2118 x <Esc> on the command-line executes the command-line. | |
2119 The default in Vim is to abandon the command-line, | |
2120 because <Esc> normally aborts a command. |c_<Esc>| | |
164 | 2121 *cpo-X* |
2122 X When using a count with "R" the replaced text is | |
2123 deleted only once. Also when repeating "R" with "." | |
2124 and a count. | |
7 | 2125 *cpo-y* |
2126 y A yank command can be redone with ".". | |
164 | 2127 *cpo-Z* |
2128 Z When using "w!" while the 'readonly' option is set, | |
2129 don't reset 'readonly'. | |
7 | 2130 *cpo-!* |
2131 ! When redoing a filter command, use the last used | |
2132 external command, whatever it was. Otherwise the last | |
2133 used -filter- command is used. | |
2134 *cpo-$* | |
2135 $ When making a change to one line, don't redisplay the | |
2136 line, but put a '$' at the end of the changed text. | |
2137 The changed text will be overwritten when you type the | |
2138 new text. The line is redisplayed if you type any | |
2139 command that moves the cursor from the insertion | |
2140 point. | |
2141 *cpo-%* | |
2142 % Vi-compatible matching is done for the "%" command. | |
2143 Does not recognize "#if", "#endif", etc. | |
2144 Does not recognize "/*" and "*/". | |
2145 Parens inside single and double quotes are also | |
2146 counted, causing a string that contains a paren to | |
2147 disturb the matching. For example, in a line like | |
2148 "if (strcmp("foo(", s))" the first paren does not | |
2149 match the last one. When this flag is not included, | |
2150 parens inside single and double quotes are treated | |
2151 specially. When matching a paren outside of quotes, | |
2152 everything inside quotes is ignored. When matching a | |
2153 paren inside quotes, it will find the matching one (if | |
10 | 2154 there is one). This works very well for C programs. |
36 | 2155 This flag is also used for other features, such as |
2156 C-indenting. | |
161 | 2157 *cpo--* |
2158 - When included, a vertical movement command fails when | |
632 | 2159 it would go above the first line or below the last |
2160 line. Without it the cursor moves to the first or | |
2161 last line, unless it already was in that line. | |
161 | 2162 Applies to the commands "-", "k", CTRL-P, "+", "j", |
632 | 2163 CTRL-N, CTRL-J and ":1234". |
39 | 2164 *cpo-+* |
2165 + When included, a ":write file" command will reset the | |
2166 'modified' flag of the buffer, even though the buffer | |
2167 itself may still be different from its file. | |
856 | 2168 *cpo-star* |
7 | 2169 * Use ":*" in the same way as ":@". When not included, |
2170 ":*" is an alias for ":'<,'>", select the Visual area. | |
2171 *cpo-<* | |
2172 < Disable the recognition of special key codes in |<>| | |
2173 form in mappings, abbreviations, and the "to" part of | |
10 | 2174 menu commands. For example, the command |
7 | 2175 ":map X <Tab>" results in X being mapped to: |
2176 '<' included: "<Tab>" (5 characters) | |
2177 '<' excluded: "^I" (^I is a real <Tab>) | |
2178 Also see the 'k' flag above. | |
164 | 2179 *cpo->* |
2180 > When appending to a register, put a line break before | |
2181 the appended text. | |
2925 | 2182 *cpo-;* |
2183 ; When using |,| or |;| to repeat the last |t| search | |
2184 and the cursor is right in front of the searched | |
2185 character, the cursor won't move. When not included, | |
2186 the cursor would skip over it and jump to the | |
3557 | 2187 following occurrence. |
164 | 2188 |
2189 POSIX flags. These are not included in the Vi default value, except | |
2190 when $VIM_POSIX was set on startup. |posix| | |
2191 | |
2192 contains behavior ~ | |
856 | 2193 *cpo-#* |
164 | 2194 # A count before "D", "o" and "O" has no effect. |
168 | 2195 *cpo-&* |
2196 & When ":preserve" was used keep the swap file when | |
2197 exiting normally while this buffer is still loaded. | |
2198 This flag is tested when exiting. | |
2199 *cpo-\* | |
2200 \ Backslash in a [] range in a search pattern is taken | |
2201 literally, only "\]" is special See |/[]| | |
488 | 2202 '\' included: "/[ \-]" finds <Space>, '\' and '-' |
2203 '\' excluded: "/[ \-]" finds <Space> and '-' | |
2204 Also see |cpo-l|. | |
168 | 2205 *cpo-/* |
2206 / When "%" is used as the replacement string in a |:s| | |
2207 command, use the previous replacement string. |:s%| | |
164 | 2208 *cpo-{* |
2209 { The |{| and |}| commands also stop at a "{" character | |
2210 at the start of a line. | |
168 | 2211 *cpo-.* |
2212 . The ":chdir" and ":cd" commands fail if the current | |
2213 buffer is modified, unless ! is used. Vim doesn't | |
2214 need this, since it remembers the full path of an | |
2215 opened file. | |
164 | 2216 *cpo-bar* |
2217 | The value of the $LINES and $COLUMNS environment | |
2218 variables overrule the terminal size values obtained | |
2219 with system specific functions. | |
2220 | |
7 | 2221 |
2180
f60a0c9cbe6c
Add the blowfish encryption patch from Mohsin Ahmed. Needs more work.
Bram Moolenaar <bram@vim.org>
parents:
2178
diff
changeset
|
2222 *'cryptmethod'* *'cm'* |
6336 | 2223 'cryptmethod' 'cm' string (default "zip") |
2360
d8e4b27cef80
Change 'cryptmethod' from a number to a string option. Make it global-local.
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
2224 global or local to buffer |global-local| |
2180
f60a0c9cbe6c
Add the blowfish encryption patch from Mohsin Ahmed. Needs more work.
Bram Moolenaar <bram@vim.org>
parents:
2178
diff
changeset
|
2225 {not in Vi} |
f60a0c9cbe6c
Add the blowfish encryption patch from Mohsin Ahmed. Needs more work.
Bram Moolenaar <bram@vim.org>
parents:
2178
diff
changeset
|
2226 Method used for encryption when the buffer is written to a file: |
2184
5028c4d6d825
Fixed encryption big/little endian test.
Bram Moolenaar <bram@vim.org>
parents:
2180
diff
changeset
|
2227 *pkzip* |
2360
d8e4b27cef80
Change 'cryptmethod' from a number to a string option. Make it global-local.
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
2228 zip PkZip compatible method. A weak kind of encryption. |
2204
c493d6bfde09
A few more changes for encryption. Add test that encrypted file can be read.
Bram Moolenaar <bram@vim.org>
parents:
2184
diff
changeset
|
2229 Backwards compatible with Vim 7.2 and older. |
2184
5028c4d6d825
Fixed encryption big/little endian test.
Bram Moolenaar <bram@vim.org>
parents:
2180
diff
changeset
|
2230 *blowfish* |
6122 | 2231 blowfish Blowfish method. Medium strong encryption but it has |
2232 an implementation flaw. Requires Vim 7.3 or later, | |
2233 files can NOT be read by Vim 7.2 and older. This adds | |
2234 a "seed" to the file, every time you write the file | |
2235 the encrypted bytes will be different. | |
2236 *blowfish2* | |
2237 blowfish2 Blowfish method. Medium strong encryption. Requires | |
2238 Vim 7.4.399 or later, files can NOT be read by Vim 7.3 | |
2239 and older. This adds a "seed" to the file, every time | |
2240 you write the file the encrypted bytes will be | |
2241 different. The whole undo file is encrypted, not just | |
2242 the pieces of text. | |
2204
c493d6bfde09
A few more changes for encryption. Add test that encrypted file can be read.
Bram Moolenaar <bram@vim.org>
parents:
2184
diff
changeset
|
2243 |
2180
f60a0c9cbe6c
Add the blowfish encryption patch from Mohsin Ahmed. Needs more work.
Bram Moolenaar <bram@vim.org>
parents:
2178
diff
changeset
|
2244 When reading an encrypted file 'cryptmethod' will be set automatically |
2204
c493d6bfde09
A few more changes for encryption. Add test that encrypted file can be read.
Bram Moolenaar <bram@vim.org>
parents:
2184
diff
changeset
|
2245 to the detected method of the file being read. Thus if you write it |
c493d6bfde09
A few more changes for encryption. Add test that encrypted file can be read.
Bram Moolenaar <bram@vim.org>
parents:
2184
diff
changeset
|
2246 without changing 'cryptmethod' the same method will be used. |
c493d6bfde09
A few more changes for encryption. Add test that encrypted file can be read.
Bram Moolenaar <bram@vim.org>
parents:
2184
diff
changeset
|
2247 Changing 'cryptmethod' does not mark the file as modified, you have to |
2360
d8e4b27cef80
Change 'cryptmethod' from a number to a string option. Make it global-local.
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
2248 explicitly write it, you don't get a warning unless there are other |
d8e4b27cef80
Change 'cryptmethod' from a number to a string option. Make it global-local.
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
2249 modifications. Also see |:X|. |
d8e4b27cef80
Change 'cryptmethod' from a number to a string option. Make it global-local.
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
2250 |
d8e4b27cef80
Change 'cryptmethod' from a number to a string option. Make it global-local.
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
2251 When setting the global value to an empty string, it will end up with |
d8e4b27cef80
Change 'cryptmethod' from a number to a string option. Make it global-local.
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
2252 the value "zip". When setting the local value to an empty string the |
d8e4b27cef80
Change 'cryptmethod' from a number to a string option. Make it global-local.
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
2253 buffer will use the global value. |
d8e4b27cef80
Change 'cryptmethod' from a number to a string option. Make it global-local.
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
2254 |
2204
c493d6bfde09
A few more changes for encryption. Add test that encrypted file can be read.
Bram Moolenaar <bram@vim.org>
parents:
2184
diff
changeset
|
2255 When a new encryption method is added in a later version of Vim, and |
c493d6bfde09
A few more changes for encryption. Add test that encrypted file can be read.
Bram Moolenaar <bram@vim.org>
parents:
2184
diff
changeset
|
2256 the current version does not recognize it, you will get *E821* . |
2360
d8e4b27cef80
Change 'cryptmethod' from a number to a string option. Make it global-local.
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
2257 You need to edit this file with the later version of Vim. |
2180
f60a0c9cbe6c
Add the blowfish encryption patch from Mohsin Ahmed. Needs more work.
Bram Moolenaar <bram@vim.org>
parents:
2178
diff
changeset
|
2258 |
f60a0c9cbe6c
Add the blowfish encryption patch from Mohsin Ahmed. Needs more work.
Bram Moolenaar <bram@vim.org>
parents:
2178
diff
changeset
|
2259 |
7 | 2260 *'cscopepathcomp'* *'cspc'* |
2261 'cscopepathcomp' 'cspc' number (default 0) | |
2262 global | |
2263 {not available when compiled without the |+cscope| | |
2264 feature} | |
2265 {not in Vi} | |
2266 Determines how many components of the path to show in a list of tags. | |
2267 See |cscopepathcomp|. | |
2268 | |
2269 *'cscopeprg'* *'csprg'* | |
2270 'cscopeprg' 'csprg' string (default "cscope") | |
2271 global | |
2272 {not available when compiled without the |+cscope| | |
2273 feature} | |
2274 {not in Vi} | |
2275 Specifies the command to execute cscope. See |cscopeprg|. | |
2276 This option cannot be set from a |modeline| or in the |sandbox|, for | |
2277 security reasons. | |
2278 | |
2279 *'cscopequickfix'* *'csqf'* | |
2280 'cscopequickfix' 'csqf' string (default "") | |
2281 global | |
2282 {not available when compiled without the |+cscope| | |
2283 or |+quickfix| features} | |
2284 {not in Vi} | |
2285 Specifies whether to use quickfix window to show cscope results. | |
2286 See |cscopequickfix|. | |
2287 | |
4869 | 2288 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'* |
2873 | 2289 'cscoperelative' 'csre' boolean (default off) |
2290 global | |
2291 {not available when compiled without the |+cscope| | |
2292 feature} | |
2293 {not in Vi} | |
2294 In the absence of a prefix (-P) for cscope. setting this option enables | |
2295 to use the basename of cscope.out path as the prefix. | |
2296 See |cscoperelative|. | |
2297 | |
7 | 2298 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'* |
2299 'cscopetag' 'cst' boolean (default off) | |
2300 global | |
2301 {not available when compiled without the |+cscope| | |
2302 feature} | |
2303 {not in Vi} | |
2304 Use cscope for tag commands. See |cscope-options|. | |
2305 NOTE: This option is reset when 'compatible' is set. | |
2306 | |
2307 *'cscopetagorder'* *'csto'* | |
2308 'cscopetagorder' 'csto' number (default 0) | |
2309 global | |
2310 {not available when compiled without the |+cscope| | |
2311 feature} | |
2312 {not in Vi} | |
2313 Determines the order in which ":cstag" performs a search. See | |
2314 |cscopetagorder|. | |
2315 NOTE: This option is set to 0 when 'compatible' is set. | |
2316 | |
2317 *'cscopeverbose'* *'csverb'* | |
2318 *'nocscopeverbose'* *'nocsverb'* | |
2319 'cscopeverbose' 'csverb' boolean (default off) | |
2320 global | |
2321 {not available when compiled without the |+cscope| | |
2322 feature} | |
2323 {not in Vi} | |
2324 Give messages when adding a cscope database. See |cscopeverbose|. | |
2325 NOTE: This option is reset when 'compatible' is set. | |
2326 | |
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2327 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'* |
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2328 'cursorbind' 'crb' boolean (default off) |
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2329 local to window |
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2330 {not in Vi} |
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2331 {not available when compiled without the |+cursorbind| |
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2332 feature} |
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2333 When this option is set, as the cursor in the current |
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2334 window moves other cursorbound windows (windows that also have |
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2335 this option set) move their cursors to the corresponding line and |
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2336 column. This option is useful for viewing the |
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2337 differences between two versions of a file (see 'diff'); in diff mode, |
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2338 inserted and deleted lines (though not characters within a line) are |
2314
233eb4412f5d
Added 'colorcolumn' option. Partly by Gregor Uhlenheuer.
Bram Moolenaar <bram@vim.org>
parents:
2302
diff
changeset
|
2339 taken into account. |
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2340 |
743 | 2341 |
2342 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'* | |
2343 'cursorcolumn' 'cuc' boolean (default off) | |
2344 local to window | |
2345 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
2346 {not available when compiled without the |+syntax| |
743 | 2347 feature} |
2348 Highlight the screen column of the cursor with CursorColumn | |
2349 |hl-CursorColumn|. Useful to align text. Will make screen redrawing | |
2350 slower. | |
826 | 2351 If you only want the highlighting in the current window you can use |
2352 these autocommands: > | |
2353 au WinLeave * set nocursorline nocursorcolumn | |
2354 au WinEnter * set cursorline cursorcolumn | |
2355 < | |
743 | 2356 |
2357 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'* | |
2358 'cursorline' 'cul' boolean (default off) | |
2359 local to window | |
2360 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
2361 {not available when compiled without the |+syntax| |
743 | 2362 feature} |
2363 Highlight the screen line of the cursor with CursorLine | |
2364 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen | |
2365 redrawing slower. | |
818 | 2366 When Visual mode is active the highlighting isn't used to make it |
825 | 2367 easier to see the selected text. |
743 | 2368 |
2369 | |
7 | 2370 *'debug'* |
2371 'debug' string (default "") | |
2372 global | |
2373 {not in Vi} | |
839 | 2374 These values can be used: |
2375 msg Error messages that would otherwise be omitted will be given | |
2376 anyway. | |
2377 throw Error messages that would otherwise be omitted will be given | |
2378 anyway and also throw an exception and set |v:errmsg|. | |
2379 beep A message will be given when otherwise only a beep would be | |
2380 produced. | |
168 | 2381 The values can be combined, separated by a comma. |
839 | 2382 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or |
2383 'indentexpr'. | |
7 | 2384 |
2385 *'define'* *'def'* | |
2386 'define' 'def' string (default "^\s*#\s*define") | |
2387 global or local to buffer |global-local| | |
2388 {not in Vi} | |
10 | 2389 Pattern to be used to find a macro definition. It is a search |
7 | 2390 pattern, just like for the "/" command. This option is used for the |
2391 commands like "[i" and "[d" |include-search|. The 'isident' option is | |
2392 used to recognize the defined name after the match: | |
2393 {match with 'define'}{non-ID chars}{defined name}{non-ID char} | |
2394 See |option-backslash| about inserting backslashes to include a space | |
2395 or backslash. | |
2396 The default value is for C programs. For C++ this value would be | |
2397 useful, to include const type declarations: > | |
2398 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\) | |
2399 < When using the ":set" command, you need to double the backslashes! | |
2400 | |
2401 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'* | |
2402 'delcombine' 'deco' boolean (default off) | |
2403 global | |
2404 {not in Vi} | |
2405 {only available when compiled with the |+multi_byte| | |
2406 feature} | |
2407 If editing Unicode and this option is set, backspace and Normal mode | |
2408 "x" delete each combining character on its own. When it is off (the | |
2409 default) the character along with its combining characters are | |
2410 deleted. | |
2411 Note: When 'delcombine' is set "xx" may work different from "2x"! | |
2412 | |
2413 This is useful for Arabic, Hebrew and many other languages where one | |
2414 may have combining characters overtop of base characters, and want | |
2415 to remove only the combining ones. | |
2416 | |
2417 *'dictionary'* *'dict'* | |
2418 'dictionary' 'dict' string (default "") | |
2419 global or local to buffer |global-local| | |
2420 {not in Vi} | |
2421 List of file names, separated by commas, that are used to lookup words | |
2422 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should | |
2423 contain a list of words. This can be one word per line, or several | |
2424 words per line, separated by non-keyword characters (white space is | |
2425 preferred). Maximum line length is 510 bytes. | |
703 | 2426 When this option is empty, or an entry "spell" is present, spell |
2427 checking is enabled the currently active spelling is used. |spell| | |
10 | 2428 To include a comma in a file name precede it with a backslash. Spaces |
7 | 2429 after a comma are ignored, otherwise spaces are included in the file |
2430 name. See |option-backslash| about using backslashes. | |
99 | 2431 This has nothing to do with the |Dictionary| variable type. |
7 | 2432 Where to find a list of words? |
2433 - On FreeBSD, there is the file "/usr/share/dict/words". | |
2434 - In the Simtel archive, look in the "msdos/linguist" directory. | |
2435 - In "miscfiles" of the GNU collection. | |
2436 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
2437 directories from the list. This avoids problems when a future version | |
2438 uses another default. | |
2439 Backticks cannot be used in this option for security reasons. | |
2440 | |
2441 *'diff'* *'nodiff'* | |
2442 'diff' boolean (default off) | |
2443 local to window | |
2444 {not in Vi} | |
2445 {not available when compiled without the |+diff| | |
2446 feature} | |
2447 Join the current window in the group of windows that shows differences | |
10 | 2448 between files. See |vimdiff|. |
7 | 2449 |
2450 *'dex'* *'diffexpr'* | |
2451 'diffexpr' 'dex' string (default "") | |
2452 global | |
2453 {not in Vi} | |
2454 {not available when compiled without the |+diff| | |
2455 feature} | |
2456 Expression which is evaluated to obtain an ed-style diff file from two | |
2457 versions of a file. See |diff-diffexpr|. | |
2458 This option cannot be set from a |modeline| or in the |sandbox|, for | |
2459 security reasons. | |
2460 | |
2461 *'dip'* *'diffopt'* | |
2462 'diffopt' 'dip' string (default "filler") | |
2463 global | |
2464 {not in Vi} | |
2465 {not available when compiled without the |+diff| | |
2466 feature} | |
10 | 2467 Option settings for diff mode. It can consist of the following items. |
7 | 2468 All are optional. Items must be separated by a comma. |
2469 | |
2470 filler Show filler lines, to keep the text | |
2471 synchronized with a window that has inserted | |
2472 lines at the same position. Mostly useful | |
2473 when windows are side-by-side and 'scrollbind' | |
2474 is set. | |
2475 | |
2476 context:{n} Use a context of {n} lines between a change | |
2477 and a fold that contains unchanged lines. | |
2478 When omitted a context of six lines is used. | |
2479 See |fold-diff|. | |
2480 | |
2481 icase Ignore changes in case of text. "a" and "A" | |
2482 are considered the same. Adds the "-i" flag | |
2483 to the "diff" command if 'diffexpr' is empty. | |
2484 | |
2485 iwhite Ignore changes in amount of white space. Adds | |
2486 the "-b" flag to the "diff" command if | |
2487 'diffexpr' is empty. Check the documentation | |
2488 of the "diff" command for what this does | |
2489 exactly. It should ignore adding trailing | |
2490 white space, but not leading white space. | |
2491 | |
766 | 2492 horizontal Start diff mode with horizontal splits (unless |
2493 explicitly specified otherwise). | |
2494 | |
2495 vertical Start diff mode with vertical splits (unless | |
2496 explicitly specified otherwise). | |
2497 | |
2498 foldcolumn:{n} Set the 'foldcolumn' option to {n} when | |
2499 starting diff mode. Without this 2 is used. | |
2500 | |
7 | 2501 Examples: > |
2502 | |
2503 :set diffopt=filler,context:4 | |
2504 :set diffopt= | |
766 | 2505 :set diffopt=filler,foldcolumn:3 |
7 | 2506 < |
2507 *'digraph'* *'dg'* *'nodigraph'* *'nodg'* | |
2508 'digraph' 'dg' boolean (default off) | |
2509 global | |
2510 {not in Vi} | |
2511 {not available when compiled without the |+digraphs| | |
2512 feature} | |
2513 Enable the entering of digraphs in Insert mode with {char1} <BS> | |
2514 {char2}. See |digraphs|. | |
2515 NOTE: This option is reset when 'compatible' is set. | |
2516 | |
2517 *'directory'* *'dir'* | |
2518 'directory' 'dir' string (default for Amiga: ".,t:", | |
5555 | 2519 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp" |
7 | 2520 for Unix: ".,~/tmp,/var/tmp,/tmp") |
2521 global | |
2522 List of directory names for the swap file, separated with commas. | |
2523 - The swap file will be created in the first directory where this is | |
2524 possible. | |
2525 - Empty means that no swap file will be used (recovery is | |
2526 impossible!). | |
2527 - A directory "." means to put the swap file in the same directory as | |
2528 the edited file. On Unix, a dot is prepended to the file name, so | |
2529 it doesn't show in a directory listing. On MS-Windows the "hidden" | |
2530 attribute is set and a dot prepended if possible. | |
33 | 2531 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to |
7 | 2532 put the swap file relative to where the edited file is. The leading |
2533 "." is replaced with the path name of the edited file. | |
459 | 2534 - For Unix and Win32, if a directory ends in two path separators "//" |
2535 or "\\", the swap file name will be built from the complete path to | |
2536 the file with all path separators substituted to percent '%' signs. | |
2537 This will ensure file name uniqueness in the preserve directory. | |
1698 | 2538 On Win32, when a separating comma is following, you must use "//", |
2539 since "\\" will include the comma in the file name. | |
7 | 2540 - Spaces after the comma are ignored, other spaces are considered part |
2541 of the directory name. To have a space at the start of a directory | |
2542 name, precede it with a backslash. | |
2543 - To include a comma in a directory name precede it with a backslash. | |
2544 - A directory name may end in an ':' or '/'. | |
2545 - Environment variables are expanded |:set_env|. | |
2546 - Careful with '\' characters, type one before a space, type two to | |
2547 get one in the option (see |option-backslash|), for example: > | |
2548 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces | |
2549 < - For backwards compatibility with Vim version 3.0 a '>' at the start | |
2550 of the option is removed. | |
2551 Using "." first in the list is recommended. This means that editing | |
2552 the same file twice will result in a warning. Using "/tmp" on Unix is | |
2553 discouraged: When the system crashes you lose the swap file. | |
2554 "/var/tmp" is often not cleared when rebooting, thus is a better | |
2555 choice than "/tmp". But it can contain a lot of files, your swap | |
2556 files get lost in the crowd. That is why a "tmp" directory in your | |
2557 home directory is tried first. | |
2558 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
2559 directories from the list. This avoids problems when a future version | |
2560 uses another default. | |
2561 This option cannot be set from a |modeline| or in the |sandbox|, for | |
2562 security reasons. | |
2563 {Vi: directory to put temp file in, defaults to "/tmp"} | |
2564 | |
2565 *'display'* *'dy'* | |
2566 'display' 'dy' string (default "") | |
2567 global | |
2568 {not in Vi} | |
2569 Change the way text is displayed. This is comma separated list of | |
2570 flags: | |
2571 lastline When included, as much as possible of the last line | |
10 | 2572 in a window will be displayed. When not included, a |
7 | 2573 last line that doesn't fit is replaced with "@" lines. |
2574 uhex Show unprintable characters hexadecimal as <xx> | |
2575 instead of using ^C and ~C. | |
2576 | |
2577 *'eadirection'* *'ead'* | |
2578 'eadirection' 'ead' string (default "both") | |
2579 global | |
2580 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
2581 {not available when compiled without the |+vertsplit| |
7 | 2582 feature} |
2583 Tells when the 'equalalways' option applies: | |
2584 ver vertically, width of windows is not affected | |
2585 hor horizontally, height of windows is not affected | |
2586 both width and height of windows is affected | |
2587 | |
2588 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'* | |
2589 'edcompatible' 'ed' boolean (default off) | |
2590 global | |
2591 Makes the 'g' and 'c' flags of the ":substitute" command to be | |
2592 toggled each time the flag is given. See |complex-change|. See | |
2593 also 'gdefault' option. | |
2594 Switching this option on is discouraged! | |
2595 | |
2596 *'encoding'* *'enc'* *E543* | |
2597 'encoding' 'enc' string (default: "latin1" or value from $LANG) | |
2598 global | |
2599 {only available when compiled with the |+multi_byte| | |
2600 feature} | |
2601 {not in Vi} | |
2602 Sets the character encoding used inside Vim. It applies to text in | |
2603 the buffers, registers, Strings in expressions, text stored in the | |
2604 viminfo file, etc. It sets the kind of characters which Vim can work | |
2605 with. See |encoding-names| for the possible values. | |
2606 | |
2607 NOTE: Changing this option will not change the encoding of the | |
39 | 2608 existing text in Vim. It may cause non-ASCII text to become invalid. |
7 | 2609 It should normally be kept at its default value, or set when Vim |
1152 | 2610 starts up. See |multibyte|. To reload the menus see |:menutrans|. |
7 | 2611 |
2317
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
2612 This option cannot be set from a |modeline|. It would most likely |
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
2613 corrupt the text. |
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
2614 |
7 | 2615 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to |
2616 "utf-8". Although care has been taken to allow different values of | |
2617 'encoding', "utf-8" is the natural choice for the environment and | |
2618 avoids unnecessary conversion overhead. "utf-8" has not been made | |
10 | 2619 the default to prevent different behavior of the GUI and terminal |
7 | 2620 versions, and to avoid changing the encoding of newly created files |
2621 without your knowledge (in case 'fileencodings' is empty). | |
2622 | |
2623 The character encoding of files can be different from 'encoding'. | |
10 | 2624 This is specified with 'fileencoding'. The conversion is done with |
7 | 2625 iconv() or as specified with 'charconvert'. |
2626 | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2627 If you need to know whether 'encoding' is a multi-byte encoding, you |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2628 can use: > |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2629 if has("multi_byte_encoding") |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2630 < |
7 | 2631 Normally 'encoding' will be equal to your current locale. This will |
2632 be the default if Vim recognizes your environment settings. If | |
2633 'encoding' is not set to the current locale, 'termencoding' must be | |
2634 set to convert typed and displayed text. See |encoding-table|. | |
2635 | |
2636 When you set this option, it fires the |EncodingChanged| autocommand | |
2637 event so that you can set up fonts if necessary. | |
2638 | |
2639 When the option is set, the value is converted to lowercase. Thus | |
2640 you can set it with uppercase values too. Underscores are translated | |
2641 to '-' signs. | |
2642 When the encoding is recognized, it is changed to the standard name. | |
2643 For example "Latin-1" becomes "latin1", "ISO_88592" becomes | |
2644 "iso-8859-2" and "utf8" becomes "utf-8". | |
2645 | |
2646 Note: "latin1" is also used when the encoding could not be detected. | |
2647 This only works when editing files in the same encoding! When the | |
2648 actual character set is not latin1, make sure 'fileencoding' and | |
2649 'fileencodings' are empty. When conversion is needed, switch to using | |
2650 utf-8. | |
2651 | |
2652 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8. | |
2653 You don't notice this while editing, but it does matter for the | |
2654 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus | |
2655 setting 'encoding' to one of these values instead of utf-8 only has | |
2656 effect for encoding used for files when 'fileencoding' is empty. | |
448 | 2657 |
2658 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was | |
2659 not set yet, the default for 'fileencodings' is changed. | |
7 | 2660 |
2661 *'endofline'* *'eol'* *'noendofline'* *'noeol'* | |
2662 'endofline' 'eol' boolean (default on) | |
2663 local to buffer | |
2664 {not in Vi} | |
2665 When writing a file and this option is off and the 'binary' option | |
10 | 2666 is on, no <EOL> will be written for the last line in the file. This |
7 | 2667 option is automatically set when starting to edit a new file, unless |
2668 the file does not have an <EOL> for the last line in the file, in | |
2669 which case it is reset. Normally you don't have to set or reset this | |
2670 option. When 'binary' is off the value is not used when writing the | |
2671 file. When 'binary' is on it is used to remember the presence of a | |
2672 <EOL> for the last line in the file, so that when you write the file | |
2673 the situation from the original file can be kept. But you can change | |
2674 it if you want to. | |
2675 | |
2676 *'equalalways'* *'ea'* *'noequalalways'* *'noea'* | |
2677 'equalalways' 'ea' boolean (default on) | |
2678 global | |
2679 {not in Vi} | |
2680 When on, all the windows are automatically made the same size after | |
33 | 2681 splitting or closing a window. This also happens the moment the |
2682 option is switched on. When off, splitting a window will reduce the | |
2683 size of the current window and leave the other windows the same. When | |
2684 closing a window the extra lines are given to the window next to it | |
2685 (depending on 'splitbelow' and 'splitright'). | |
7 | 2686 When mixing vertically and horizontally split windows, a minimal size |
2687 is computed and some windows may be larger if there is room. The | |
2688 'eadirection' option tells in which direction the size is affected. | |
1354 | 2689 Changing the height and width of a window can be avoided by setting |
2690 'winfixheight' and 'winfixwidth', respectively. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2691 If a window size is specified when creating a new window sizes are |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2692 currently not equalized (it's complicated, but may be implemented in |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2693 the future). |
7 | 2694 |
2695 *'equalprg'* *'ep'* | |
2696 'equalprg' 'ep' string (default "") | |
2697 global or local to buffer |global-local| | |
2698 {not in Vi} | |
2699 External program to use for "=" command. When this option is empty | |
1621 | 2700 the internal formatting functions are used; either 'lisp', 'cindent' |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2701 or 'indentexpr'. When Vim was compiled without internal formatting, |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2702 the "indent" program is used. |
10 | 2703 Environment variables are expanded |:set_env|. See |option-backslash| |
7 | 2704 about including spaces and backslashes. |
2705 This option cannot be set from a |modeline| or in the |sandbox|, for | |
2706 security reasons. | |
2707 | |
2708 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'* | |
2709 'errorbells' 'eb' boolean (default off) | |
2710 global | |
2711 Ring the bell (beep or screen flash) for error messages. This only | |
2712 makes a difference for error messages, the bell will be used always | |
2713 for a lot of errors without a message (e.g., hitting <Esc> in Normal | |
10 | 2714 mode). See 'visualbell' on how to make the bell behave like a beep, |
7 | 2715 screen flash or do nothing. |
2716 | |
2717 *'errorfile'* *'ef'* | |
2718 'errorfile' 'ef' string (Amiga default: "AztecC.Err", | |
2719 others: "errors.err") | |
2720 global | |
2721 {not in Vi} | |
2722 {not available when compiled without the |+quickfix| | |
2723 feature} | |
2724 Name of the errorfile for the QuickFix mode (see |:cf|). | |
2725 When the "-q" command-line argument is used, 'errorfile' is set to the | |
2726 following argument. See |-q|. | |
2727 NOT used for the ":make" command. See 'makeef' for that. | |
2728 Environment variables are expanded |:set_env|. | |
2729 See |option-backslash| about including spaces and backslashes. | |
2730 This option cannot be set from a |modeline| or in the |sandbox|, for | |
2731 security reasons. | |
2732 | |
2733 *'errorformat'* *'efm'* | |
2734 'errorformat' 'efm' string (default is very long) | |
2735 global or local to buffer |global-local| | |
2736 {not in Vi} | |
2737 {not available when compiled without the |+quickfix| | |
2738 feature} | |
2739 Scanf-like description of the format for the lines in the error file | |
2740 (see |errorformat|). | |
2741 | |
2742 *'esckeys'* *'ek'* *'noesckeys'* *'noek'* | |
2743 'esckeys' 'ek' boolean (Vim default: on, Vi default: off) | |
2744 global | |
2745 {not in Vi} | |
2746 Function keys that start with an <Esc> are recognized in Insert | |
2747 mode. When this option is off, the cursor and function keys cannot be | |
2748 used in Insert mode if they start with an <Esc>. The advantage of | |
2749 this is that the single <Esc> is recognized immediately, instead of | |
2750 after one second. Instead of resetting this option, you might want to | |
2751 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that | |
2752 when 'esckeys' is off, you can still map anything, but the cursor keys | |
2753 won't work by default. | |
2754 NOTE: This option is set to the Vi default value when 'compatible' is | |
2755 set and to the Vim default value when 'compatible' is reset. | |
2756 | |
2757 *'eventignore'* *'ei'* | |
2758 'eventignore' 'ei' string (default "") | |
2759 global | |
2760 {not in Vi} | |
2761 {not available when compiled without the |+autocmd| | |
2762 feature} | |
2763 A list of autocommand event names, which are to be ignored. | |
844 | 2764 When set to "all" or when "all" is one of the items, all autocommand |
2765 events are ignored, autocommands will not be executed. | |
7 | 2766 Otherwise this is a comma separated list of event names. Example: > |
2767 :set ei=WinEnter,WinLeave | |
2768 < | |
2769 *'expandtab'* *'et'* *'noexpandtab'* *'noet'* | |
2770 'expandtab' 'et' boolean (default off) | |
2771 local to buffer | |
2772 {not in Vi} | |
2773 In Insert mode: Use the appropriate number of spaces to insert a | |
10 | 2774 <Tab>. Spaces are used in indents with the '>' and '<' commands and |
7 | 2775 when 'autoindent' is on. To insert a real tab when 'expandtab' is |
2776 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|. | |
2777 NOTE: This option is reset when 'compatible' is set. | |
2778 | |
2779 *'exrc'* *'ex'* *'noexrc'* *'noex'* | |
2780 'exrc' 'ex' boolean (default off) | |
2781 global | |
2782 {not in Vi} | |
2783 Enables the reading of .vimrc, .exrc and .gvimrc in the current | |
2784 directory. If you switch this option on you should also consider | |
2785 setting the 'secure' option (see |initialization|). Using a local | |
2786 .exrc, .vimrc or .gvimrc is a potential security leak, use with care! | |
2787 also see |.vimrc| and |gui-init|. | |
2788 This option cannot be set from a |modeline| or in the |sandbox|, for | |
2789 security reasons. | |
2790 | |
2791 *'fileencoding'* *'fenc'* *E213* | |
2792 'fileencoding' 'fenc' string (default: "") | |
2793 local to buffer | |
2794 {only available when compiled with the |+multi_byte| | |
2795 feature} | |
2796 {not in Vi} | |
2797 Sets the character encoding for the file of this buffer. | |
2317
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
2798 |
7 | 2799 When 'fileencoding' is different from 'encoding', conversion will be |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2800 done when writing the file. For reading see below. |
7 | 2801 When 'fileencoding' is empty, the same value as 'encoding' will be |
2802 used (no conversion when reading or writing a file). | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2803 Conversion will also be done when 'encoding' and 'fileencoding' are |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2804 both a Unicode encoding and 'fileencoding' is not utf-8. That's |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2805 because internally Unicode is always stored as utf-8. |
7 | 2806 WARNING: Conversion can cause loss of information! When |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2807 'encoding' is "utf-8" or another Unicode encoding, conversion |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2808 is most likely done in a way that the reverse conversion |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2809 results in the same text. When 'encoding' is not "utf-8" some |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2810 characters may be lost! |
2317
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
2811 |
7 | 2812 See 'encoding' for the possible values. Additionally, values may be |
2813 specified that can be handled by the converter, see | |
2814 |mbyte-conversion|. | |
2317
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
2815 |
7 | 2816 When reading a file 'fileencoding' will be set from 'fileencodings'. |
2817 To read a file in a certain encoding it won't work by setting | |
1152 | 2818 'fileencoding', use the |++enc| argument. One exception: when |
2819 'fileencodings' is empty the value of 'fileencoding' is used. | |
692 | 2820 For a new file the global value of 'fileencoding' is used. |
2317
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
2821 |
7 | 2822 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored. |
2823 When the option is set, the value is converted to lowercase. Thus | |
2824 you can set it with uppercase values too. '_' characters are | |
2825 replaced with '-'. If a name is recognized from the list for | |
2826 'encoding', it is replaced by the standard name. For example | |
2827 "ISO8859-2" becomes "iso-8859-2". | |
2317
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
2828 |
7 | 2829 When this option is set, after starting to edit a file, the 'modified' |
2830 option is set, because the file would be different when written. | |
2317
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
2831 |
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
2832 Keep in mind that changing 'fenc' from a modeline happens |
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
2833 AFTER the text has been read, thus it applies to when the file will be |
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
2834 written. If you do set 'fenc' in a modeline, you might want to set |
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
2835 'nomodified' to avoid not being able to ":q". |
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
2836 |
7 | 2837 This option can not be changed when 'modifiable' is off. |
2838 | |
2839 *'fe'* | |
2840 NOTE: Before version 6.0 this option specified the encoding for the | |
10 | 2841 whole of Vim, this was a mistake. Now use 'encoding' instead. The |
7 | 2842 old short name was 'fe', which is no longer used. |
2843 | |
2844 *'fileencodings'* *'fencs'* | |
39 | 2845 'fileencodings' 'fencs' string (default: "ucs-bom", |
2846 "ucs-bom,utf-8,default,latin1" when | |
2847 'encoding' is set to a Unicode value) | |
7 | 2848 global |
2849 {only available when compiled with the |+multi_byte| | |
2850 feature} | |
2851 {not in Vi} | |
2852 This is a list of character encodings considered when starting to edit | |
2853 an existing file. When a file is read, Vim tries to use the first | |
2854 mentioned character encoding. If an error is detected, the next one | |
2855 in the list is tried. When an encoding is found that works, | |
10 | 2856 'fileencoding' is set to it. If all fail, 'fileencoding' is set to |
7 | 2857 an empty string, which means the value of 'encoding' is used. |
2858 WARNING: Conversion can cause loss of information! When | |
2859 'encoding' is "utf-8" (or one of the other Unicode variants) | |
2860 conversion is most likely done in a way that the reverse | |
2861 conversion results in the same text. When 'encoding' is not | |
596 | 2862 "utf-8" some non-ASCII characters may be lost! You can use |
2863 the |++bad| argument to specify what is done with characters | |
2864 that can't be converted. | |
7 | 2865 For an empty file or a file with only ASCII characters most encodings |
2866 will work and the first entry of 'fileencodings' will be used (except | |
2867 "ucs-bom", which requires the BOM to be present). If you prefer | |
2868 another encoding use an BufReadPost autocommand event to test if your | |
2869 preferred encoding is to be used. Example: > | |
2870 au BufReadPost * if search('\S', 'w') == 0 | | |
2871 \ set fenc=iso-2022-jp | endif | |
2872 < This sets 'fileencoding' to "iso-2022-jp" if the file does not contain | |
2873 non-blank characters. | |
596 | 2874 When the |++enc| argument is used then the value of 'fileencodings' is |
2875 not used. | |
692 | 2876 Note that 'fileencodings' is not used for a new file, the global value |
2877 of 'fileencoding' is used instead. You can set it with: > | |
2878 :setglobal fenc=iso-8859-2 | |
2879 < This means that a non-existing file may get a different encoding than | |
2880 an empty file. | |
7 | 2881 The special value "ucs-bom" can be used to check for a Unicode BOM |
2882 (Byte Order Mark) at the start of the file. It must not be preceded | |
2883 by "utf-8" or another Unicode encoding for this to work properly. | |
2884 An entry for an 8-bit encoding (e.g., "latin1") should be the last, | |
2885 because Vim cannot detect an error, thus the encoding is always | |
2886 accepted. | |
39 | 2887 The special value "default" can be used for the encoding from the |
2888 environment. This is the default value for 'encoding'. It is useful | |
2889 when 'encoding' is set to "utf-8" and your environment uses a | |
2890 non-latin1 encoding, such as Russian. | |
777 | 2891 When 'encoding' is "utf-8" and a file contains an illegal byte |
2892 sequence it won't be recognized as UTF-8. You can use the |8g8| | |
2893 command to find the illegal byte sequence. | |
7 | 2894 WRONG VALUES: WHAT'S WRONG: |
2895 latin1,utf-8 "latin1" will always be used | |
2896 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8 | |
2897 file | |
2898 cp1250,latin1 "cp1250" will always be used | |
2899 If 'fileencodings' is empty, 'fileencoding' is not modified. | |
2900 See 'fileencoding' for the possible values. | |
2901 Setting this option does not have an effect until the next time a file | |
2902 is read. | |
2903 | |
2904 *'fileformat'* *'ff'* | |
2905 'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos", | |
2906 Unix default: "unix", | |
2907 Macintosh default: "mac") | |
2908 local to buffer | |
2909 {not in Vi} | |
2910 This gives the <EOL> of the current buffer, which is used for | |
2911 reading/writing the buffer from/to a file: | |
2912 dos <CR> <NL> | |
2913 unix <NL> | |
2914 mac <CR> | |
2915 When "dos" is used, CTRL-Z at the end of a file is ignored. | |
2916 See |file-formats| and |file-read|. | |
2917 For the character encoding of the file see 'fileencoding'. | |
2918 When 'binary' is set, the value of 'fileformat' is ignored, file I/O | |
4264 | 2919 works like it was set to "unix". |
7 | 2920 This option is set automatically when starting to edit a file and |
2921 'fileformats' is not empty and 'binary' is off. | |
2922 When this option is set, after starting to edit a file, the 'modified' | |
2923 option is set, because the file would be different when written. | |
2924 This option can not be changed when 'modifiable' is off. | |
2925 For backwards compatibility: When this option is set to "dos", | |
2926 'textmode' is set, otherwise 'textmode' is reset. | |
2927 | |
2928 *'fileformats'* *'ffs'* | |
2929 'fileformats' 'ffs' string (default: | |
2930 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix", | |
2931 Vim Unix: "unix,dos", | |
2932 Vim Mac: "mac,unix,dos", | |
2933 Vi Cygwin: "unix,dos", | |
2934 Vi others: "") | |
2935 global | |
2936 {not in Vi} | |
2937 This gives the end-of-line (<EOL>) formats that will be tried when | |
2938 starting to edit a new buffer and when reading a file into an existing | |
2939 buffer: | |
2940 - When empty, the format defined with 'fileformat' will be used | |
2941 always. It is not set automatically. | |
2942 - When set to one name, that format will be used whenever a new buffer | |
10 | 2943 is opened. 'fileformat' is set accordingly for that buffer. The |
7 | 2944 'fileformats' name will be used when a file is read into an existing |
2945 buffer, no matter what 'fileformat' for that buffer is set to. | |
2946 - When more than one name is present, separated by commas, automatic | |
2947 <EOL> detection will be done when reading a file. When starting to | |
2948 edit a file, a check is done for the <EOL>: | |
2949 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos", | |
2950 'fileformat' is set to "dos". | |
2951 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat' | |
10 | 2952 is set to "unix". Note that when a <NL> is found without a |
7 | 2953 preceding <CR>, "unix" is preferred over "dos". |
6647 | 2954 3. If 'fileformat' has not yet been set, and if a <CR> is found, and |
2955 if 'fileformats' includes "mac", 'fileformat' is set to "mac". | |
2587 | 2956 This means that "mac" is only chosen when: |
2957 "unix" is not present or no <NL> is found in the file, and | |
2958 "dos" is not present or no <CR><NL> is found in the file. | |
2959 Except: if "unix" was chosen, but there is a <CR> before | |
2960 the first <NL>, and there appear to be more <CR>s than <NL>s in | |
2642 | 2961 the first few lines, "mac" is used. |
7 | 2962 4. If 'fileformat' is still not set, the first name from |
2963 'fileformats' is used. | |
2964 When reading a file into an existing buffer, the same is done, but | |
2965 this happens like 'fileformat' has been set appropriately for that | |
2966 file only, the option is not changed. | |
2967 When 'binary' is set, the value of 'fileformats' is not used. | |
2968 | |
2662 | 2969 Note that when Vim starts up with an empty buffer this option is not |
2681 | 2970 used. Set 'fileformat' in your .vimrc instead. |
2662 | 2971 |
7 | 2972 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that |
2973 are ":source"ed and for vimrc files, automatic <EOL> detection may be | |
2974 done: | |
2975 - When 'fileformats' is empty, there is no automatic detection. Dos | |
2976 format will be used. | |
2977 - When 'fileformats' is set to one or more names, automatic detection | |
2978 is done. This is based on the first <NL> in the file: If there is a | |
2979 <CR> in front of it, Dos format is used, otherwise Unix format is | |
2980 used. | |
2981 Also see |file-formats|. | |
2982 For backwards compatibility: When this option is set to an empty | |
2983 string or one format (no comma is included), 'textauto' is reset, | |
2984 otherwise 'textauto' is set. | |
2985 NOTE: This option is set to the Vi default value when 'compatible' is | |
2986 set and to the Vim default value when 'compatible' is reset. | |
2987 | |
4264 | 2988 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'* |
2989 'fileignorecase' 'fic' boolean (default on for systems where case in file | |
2990 names is normally ignored) | |
4242 | 2991 global |
2992 {not in Vi} | |
2993 When set case is ignored when using file names and directories. | |
2994 See 'wildignorecase' for only ignoring case when doing completion. | |
2995 | |
7 | 2996 *'filetype'* *'ft'* |
2997 'filetype' 'ft' string (default: "") | |
2998 local to buffer | |
2999 {not in Vi} | |
3000 {not available when compiled without the |+autocmd| | |
3001 feature} | |
3002 When this option is set, the FileType autocommand event is triggered. | |
3003 All autocommands that match with the value of this option will be | |
3004 executed. Thus the value of 'filetype' is used in place of the file | |
3005 name. | |
3006 Otherwise this option does not always reflect the current file type. | |
3007 This option is normally set when the file type is detected. To enable | |
3008 this use the ":filetype on" command. |:filetype| | |
3009 Setting this option to a different value is most useful in a modeline, | |
3010 for a file for which the file type is not automatically recognized. | |
782 | 3011 Example, for in an IDL file: |
3012 /* vim: set filetype=idl : */ ~ | |
3013 |FileType| |filetypes| | |
3014 When a dot appears in the value then this separates two filetype | |
3015 names. Example: | |
3016 /* vim: set filetype=c.doxygen : */ ~ | |
3017 This will use the "c" filetype first, then the "doxygen" filetype. | |
3018 This works both for filetype plugins and for syntax files. More than | |
3019 one dot may appear. | |
7 | 3020 This option is not copied to another buffer, independent of the 's' or |
3021 'S' flag in 'cpoptions'. | |
36 | 3022 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
7 | 3023 |
3024 *'fillchars'* *'fcs'* | |
3025 'fillchars' 'fcs' string (default "vert:|,fold:-") | |
3026 global | |
3027 {not in Vi} | |
3028 {not available when compiled without the |+windows| | |
3029 and |+folding| features} | |
3030 Characters to fill the statuslines and vertical separators. | |
3031 It is a comma separated list of items: | |
3032 | |
3033 item default Used for ~ | |
3034 stl:c ' ' or '^' statusline of the current window | |
3035 stlnc:c ' ' or '-' statusline of the non-current windows | |
3036 vert:c '|' vertical separators |:vsplit| | |
3037 fold:c '-' filling 'foldtext' | |
3038 diff:c '-' deleted lines of the 'diff' option | |
3039 | |
10 | 3040 Any one that is omitted will fall back to the default. For "stl" and |
7 | 3041 "stlnc" the space will be used when there is highlighting, '^' or '-' |
3042 otherwise. | |
3043 | |
3044 Example: > | |
3045 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:- | |
3046 < This is similar to the default, except that these characters will also | |
3047 be used when there is highlighting. | |
3048 | |
819 | 3049 for "stl" and "stlnc" only single-byte values are supported. |
3050 | |
7 | 3051 The highlighting used for these items: |
3052 item highlight group ~ | |
3053 stl:c StatusLine |hl-StatusLine| | |
3054 stlnc:c StatusLineNC |hl-StatusLineNC| | |
3055 vert:c VertSplit |hl-VertSplit| | |
3056 fold:c Folded |hl-Folded| | |
3057 diff:c DiffDelete |hl-DiffDelete| | |
3058 | |
3059 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'* | |
3060 'fkmap' 'fk' boolean (default off) *E198* | |
3061 global | |
3062 {not in Vi} | |
3063 {only available when compiled with the |+rightleft| | |
3064 feature} | |
3065 When on, the keyboard is mapped for the Farsi character set. | |
3066 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to | |
10 | 3067 toggle this option |i_CTRL-_|. See |farsi.txt|. |
7 | 3068 |
3069 *'foldclose'* *'fcl'* | |
3070 'foldclose' 'fcl' string (default "") | |
3071 global | |
3072 {not in Vi} | |
3073 {not available when compiled without the |+folding| | |
3074 feature} | |
3075 When set to "all", a fold is closed when the cursor isn't in it and | |
3076 its level is higher than 'foldlevel'. Useful if you want folds to | |
3077 automatically close when moving out of them. | |
3078 | |
3079 *'foldcolumn'* *'fdc'* | |
3080 'foldcolumn' 'fdc' number (default 0) | |
3081 local to window | |
3082 {not in Vi} | |
3083 {not available when compiled without the |+folding| | |
3084 feature} | |
3085 When non-zero, a column with the specified width is shown at the side | |
3086 of the window which indicates open and closed folds. The maximum | |
3087 value is 12. | |
3088 See |folding|. | |
3089 | |
3090 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'* | |
3091 'foldenable' 'fen' boolean (default on) | |
3092 local to window | |
3093 {not in Vi} | |
3094 {not available when compiled without the |+folding| | |
3095 feature} | |
3096 When off, all folds are open. This option can be used to quickly | |
3097 switch between showing all text unfolded and viewing the text with | |
3098 folds (including manually opened or closed folds). It can be toggled | |
10 | 3099 with the |zi| command. The 'foldcolumn' will remain blank when |
7 | 3100 'foldenable' is off. |
3101 This option is set by commands that create a new fold or close a fold. | |
3102 See |folding|. | |
3103 | |
3104 *'foldexpr'* *'fde'* | |
3105 'foldexpr' 'fde' string (default: "0") | |
3106 local to window | |
3107 {not in Vi} | |
3108 {not available when compiled without the |+folding| | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
3109 or |+eval| features} |
7 | 3110 The expression used for when 'foldmethod' is "expr". It is evaluated |
634 | 3111 for each line to obtain its fold level. See |fold-expr|. |
782 | 3112 |
3682 | 3113 The expression will be evaluated in the |sandbox| if set from a |
3114 modeline, see |sandbox-option|. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3115 This option can't be set from a |modeline| when the 'diff' option is |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3116 on. |
634 | 3117 |
3118 It is not allowed to change text or jump to another window while | |
3119 evaluating 'foldexpr' |textlock|. | |
7 | 3120 |
3121 *'foldignore'* *'fdi'* | |
3122 'foldignore' 'fdi' string (default: "#") | |
3123 local to window | |
3124 {not in Vi} | |
3125 {not available when compiled without the |+folding| | |
3126 feature} | |
3127 Used only when 'foldmethod' is "indent". Lines starting with | |
3128 characters in 'foldignore' will get their fold level from surrounding | |
10 | 3129 lines. White space is skipped before checking for this character. |
7 | 3130 The default "#" works well for C programs. See |fold-indent|. |
3131 | |
3132 *'foldlevel'* *'fdl'* | |
3133 'foldlevel' 'fdl' number (default: 0) | |
3134 local to window | |
3135 {not in Vi} | |
3136 {not available when compiled without the |+folding| | |
3137 feature} | |
3138 Sets the fold level: Folds with a higher level will be closed. | |
3139 Setting this option to zero will close all folds. Higher numbers will | |
3140 close fewer folds. | |
3141 This option is set by commands like |zm|, |zM| and |zR|. | |
3142 See |fold-foldlevel|. | |
3143 | |
3144 *'foldlevelstart'* *'fdls'* | |
3145 'foldlevelstart' 'fdls' number (default: -1) | |
3146 global | |
3147 {not in Vi} | |
3148 {not available when compiled without the |+folding| | |
3149 feature} | |
3150 Sets 'foldlevel' when starting to edit another buffer in a window. | |
3151 Useful to always start editing with all folds closed (value zero), | |
3152 some folds closed (one) or no folds closed (99). | |
3153 This is done before reading any modeline, thus a setting in a modeline | |
10 | 3154 overrules this option. Starting to edit a file for |diff-mode| also |
7 | 3155 ignores this option and closes all folds. |
3156 It is also done before BufReadPre autocommands, to allow an autocmd to | |
3157 overrule the 'foldlevel' value for specific files. | |
3158 When the value is negative, it is not used. | |
3159 | |
3160 *'foldmarker'* *'fmr'* *E536* | |
3161 'foldmarker' 'fmr' string (default: "{{{,}}}") | |
3162 local to window | |
3163 {not in Vi} | |
3164 {not available when compiled without the |+folding| | |
3165 feature} | |
3166 The start and end marker used when 'foldmethod' is "marker". There | |
3167 must be one comma, which separates the start and end marker. The | |
3168 marker is a literal string (a regular expression would be too slow). | |
3169 See |fold-marker|. | |
3170 | |
3171 *'foldmethod'* *'fdm'* | |
3172 'foldmethod' 'fdm' string (default: "manual") | |
3173 local to window | |
3174 {not in Vi} | |
3175 {not available when compiled without the |+folding| | |
3176 feature} | |
3177 The kind of folding used for the current window. Possible values: | |
3178 |fold-manual| manual Folds are created manually. | |
3179 |fold-indent| indent Lines with equal indent form a fold. | |
3180 |fold-expr| expr 'foldexpr' gives the fold level of a line. | |
3181 |fold-marker| marker Markers are used to specify folds. | |
3182 |fold-syntax| syntax Syntax highlighting items specify folds. | |
3183 |fold-diff| diff Fold text that is not changed. | |
3184 | |
3185 *'foldminlines'* *'fml'* | |
3186 'foldminlines' 'fml' number (default: 1) | |
3187 local to window | |
3188 {not in Vi} | |
3189 {not available when compiled without the |+folding| | |
3190 feature} | |
2709 | 3191 Sets the number of screen lines above which a fold can be displayed |
3192 closed. Also for manually closed folds. With the default value of | |
3193 one a fold can only be closed if it takes up two or more screen lines. | |
3194 Set to zero to be able to close folds of just one screen line. | |
2826 | 3195 Note that this only has an effect on what is displayed. After using |
7 | 3196 "zc" to close a fold, which is displayed open because it's smaller |
3197 than 'foldminlines', a following "zc" may close a containing fold. | |
3198 | |
3199 *'foldnestmax'* *'fdn'* | |
3200 'foldnestmax' 'fdn' number (default: 20) | |
3201 local to window | |
3202 {not in Vi} | |
3203 {not available when compiled without the |+folding| | |
3204 feature} | |
3205 Sets the maximum nesting of folds for the "indent" and "syntax" | |
3206 methods. This avoids that too many folds will be created. Using more | |
3207 than 20 doesn't work, because the internal limit is 20. | |
3208 | |
3209 *'foldopen'* *'fdo'* | |
3210 'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix, | |
3211 search,tag,undo") | |
3212 global | |
3213 {not in Vi} | |
3214 {not available when compiled without the |+folding| | |
3215 feature} | |
3216 Specifies for which type of commands folds will be opened, if the | |
3217 command moves the cursor into a closed fold. It is a comma separated | |
3218 list of items. | |
2625 | 3219 NOTE: When the command is part of a mapping this option is not used. |
3220 Add the |zv| command to the mapping to get the same effect. | |
3221 (rationale: the mapping may want to control opening folds itself) | |
3222 | |
7 | 3223 item commands ~ |
3224 all any | |
3225 block "(", "{", "[[", "[{", etc. | |
3226 hor horizontal movements: "l", "w", "fx", etc. | |
3227 insert any command in Insert mode | |
3228 jump far jumps: "G", "gg", etc. | |
3229 mark jumping to a mark: "'m", CTRL-O, etc. | |
3230 percent "%" | |
3231 quickfix ":cn", ":crew", ":make", etc. | |
3232 search search for a pattern: "/", "n", "*", "gd", etc. | |
3233 (not for a search pattern in a ":" command) | |
819 | 3234 Also for |[s| and |]s|. |
7 | 3235 tag jumping to a tag: ":ta", CTRL-T, etc. |
3236 undo undo or redo: "u" and CTRL-R | |
3237 When a movement command is used for an operator (e.g., "dl" or "y%") | |
3238 this option is not used. This means the operator will include the | |
3239 whole closed fold. | |
3240 Note that vertical movements are not here, because it would make it | |
3241 very difficult to move onto a closed fold. | |
3242 In insert mode the folds containing the cursor will always be open | |
3243 when text is inserted. | |
3244 To close folds you can re-apply 'foldlevel' with the |zx| command or | |
3245 set the 'foldclose' option to "all". | |
3246 | |
3247 *'foldtext'* *'fdt'* | |
3248 'foldtext' 'fdt' string (default: "foldtext()") | |
3249 local to window | |
3250 {not in Vi} | |
3251 {not available when compiled without the |+folding| | |
3252 feature} | |
3253 An expression which is used to specify the text displayed for a closed | |
3254 fold. See |fold-foldtext|. | |
3255 | |
3682 | 3256 The expression will be evaluated in the |sandbox| if set from a |
3257 modeline, see |sandbox-option|. | |
634 | 3258 |
3259 It is not allowed to change text or jump to another window while | |
3260 evaluating 'foldtext' |textlock|. | |
3261 | |
7 | 3262 *'formatoptions'* *'fo'* |
3263 'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt") | |
3264 local to buffer | |
3265 {not in Vi} | |
3266 This is a sequence of letters which describes how automatic | |
3267 formatting is to be done. See |fo-table|. When the 'paste' option is | |
3268 on, no formatting is done (like 'formatoptions' is empty). Commas can | |
3269 be inserted for readability. | |
3270 To avoid problems with flags that are added in the future, use the | |
3271 "+=" and "-=" feature of ":set" |add-option-flags|. | |
3272 NOTE: This option is set to the Vi default value when 'compatible' is | |
3273 set and to the Vim default value when 'compatible' is reset. | |
3274 | |
41 | 3275 *'formatlistpat'* *'flp'* |
3276 'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*") | |
3277 local to buffer | |
3278 {not in Vi} | |
3279 A pattern that is used to recognize a list header. This is used for | |
3280 the "n" flag in 'formatoptions'. | |
3281 The pattern must match exactly the text that will be the indent for | |
140 | 3282 the line below it. You can use |/\ze| to mark the end of the match |
41 | 3283 while still checking more characters. There must be a character |
3284 following the pattern, when it matches the whole line it is handled | |
3285 like there is no match. | |
3286 The default recognizes a number, followed by an optional punctuation | |
3287 character and white space. | |
3288 | |
7 | 3289 *'formatprg'* *'fp'* |
3290 'formatprg' 'fp' string (default "") | |
3291 global | |
3292 {not in Vi} | |
3293 The name of an external program that will be used to format the lines | |
667 | 3294 selected with the |gq| operator. The program must take the input on |
7 | 3295 stdin and produce the output on stdout. The Unix program "fmt" is |
557 | 3296 such a program. |
667 | 3297 If the 'formatexpr' option is not empty it will be used instead. |
3298 Otherwise, if 'formatprg' option is an empty string, the internal | |
3299 format function will be used |C-indenting|. | |
557 | 3300 Environment variables are expanded |:set_env|. See |option-backslash| |
3301 about including spaces and backslashes. | |
3682 | 3302 This option cannot be set from a |modeline| or in the |sandbox|, for |
3303 security reasons. | |
667 | 3304 |
3305 *'formatexpr'* *'fex'* | |
3306 'formatexpr' 'fex' string (default "") | |
3307 local to buffer | |
3308 {not in Vi} | |
3309 {not available when compiled without the |+eval| | |
3310 feature} | |
3311 Expression which is evaluated to format a range of lines for the |gq| | |
2350
06feaf4fe36a
Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents:
2349
diff
changeset
|
3312 operator or automatic formatting (see 'formatoptions'). When this |
06feaf4fe36a
Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents:
2349
diff
changeset
|
3313 option is empty 'formatprg' is used. |
844 | 3314 |
3315 The |v:lnum| variable holds the first line to be formatted. | |
856 | 3316 The |v:count| variable holds the number of lines to be formatted. |
3317 The |v:char| variable holds the character that is going to be | |
2350
06feaf4fe36a
Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents:
2349
diff
changeset
|
3318 inserted if the expression is being evaluated due to |
06feaf4fe36a
Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents:
2349
diff
changeset
|
3319 automatic formatting. This can be empty. Don't insert |
06feaf4fe36a
Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents:
2349
diff
changeset
|
3320 it yet! |
844 | 3321 |
667 | 3322 Example: > |
681 | 3323 :set formatexpr=mylang#Format() |
667 | 3324 < This will invoke the mylang#Format() function in the |
3325 autoload/mylang.vim file in 'runtimepath'. |autoload| | |
3326 | |
3327 The expression is also evaluated when 'textwidth' is set and adding | |
3328 text beyond that limit. This happens under the same conditions as | |
3329 when internal formatting is used. Make sure the cursor is kept in the | |
3330 same spot relative to the text then! The |mode()| function will | |
2298
a3562a127cf6
When 'formatexpr' evaluates to non-zero fall back to internal formatting, also
Bram Moolenaar <bram@vim.org>
parents:
2290
diff
changeset
|
3331 return "i" or "R" in this situation. |
a3562a127cf6
When 'formatexpr' evaluates to non-zero fall back to internal formatting, also
Bram Moolenaar <bram@vim.org>
parents:
2290
diff
changeset
|
3332 |
a3562a127cf6
When 'formatexpr' evaluates to non-zero fall back to internal formatting, also
Bram Moolenaar <bram@vim.org>
parents:
2290
diff
changeset
|
3333 When the expression evaluates to non-zero Vim will fall back to using |
a3562a127cf6
When 'formatexpr' evaluates to non-zero fall back to internal formatting, also
Bram Moolenaar <bram@vim.org>
parents:
2290
diff
changeset
|
3334 the internal format mechanism. |
667 | 3335 |
3682 | 3336 The expression will be evaluated in the |sandbox| when set from a |
3337 modeline, see |sandbox-option|. That stops the option from working, | |
3338 since changing the buffer text is not allowed. | |
667 | 3339 |
3340 *'fsync'* *'fs'* | |
36 | 3341 'fsync' 'fs' boolean (default on) |
3342 global | |
3343 {not in Vi} | |
3344 When on, the library function fsync() will be called after writing a | |
3345 file. This will flush a file to disk, ensuring that it is safely | |
3346 written even on filesystems which do metadata-only journaling. This | |
3347 will force the harddrive to spin up on Linux systems running in laptop | |
3348 mode, so it may be undesirable in some situations. Be warned that | |
3349 turning this off increases the chances of data loss after a crash. On | |
3350 systems without an fsync() implementation, this variable is always | |
3351 off. | |
3352 Also see 'swapsync' for controlling fsync() on swap files. | |
3353 | |
7 | 3354 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'* |
3355 'gdefault' 'gd' boolean (default off) | |
3356 global | |
3357 {not in Vi} | |
3358 When on, the ":substitute" flag 'g' is default on. This means that | |
3359 all matches in a line are substituted instead of one. When a 'g' flag | |
3360 is given to a ":substitute" command, this will toggle the substitution | |
3361 of all or one match. See |complex-change|. | |
3362 | |
3363 command 'gdefault' on 'gdefault' off ~ | |
3364 :s/// subst. all subst. one | |
3365 :s///g subst. one subst. all | |
3366 :s///gg subst. all subst. one | |
3367 | |
3368 NOTE: This option is reset when 'compatible' is set. | |
3369 | |
3370 *'grepformat'* *'gfm'* | |
6213 | 3371 'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m") |
7 | 3372 global |
3373 {not in Vi} | |
3374 Format to recognize for the ":grep" command output. | |
3375 This is a scanf-like string that uses the same format as the | |
3376 'errorformat' option: see |errorformat|. | |
3377 | |
3378 *'grepprg'* *'gp'* | |
3379 'grepprg' 'gp' string (default "grep -n ", | |
3380 Unix: "grep -n $* /dev/null", | |
3381 Win32: "findstr /n" or "grep -n", | |
3382 VMS: "SEARCH/NUMBERS ") | |
3383 global or local to buffer |global-local| | |
3384 {not in Vi} | |
233 | 3385 Program to use for the |:grep| command. This option may contain '%' |
7 | 3386 and '#' characters, which are expanded like when used in a command- |
3387 line. The placeholder "$*" is allowed to specify where the arguments | |
3388 will be included. Environment variables are expanded |:set_env|. See | |
3389 |option-backslash| about including spaces and backslashes. | |
3390 When your "grep" accepts the "-H" argument, use this to make ":grep" | |
3391 also work well with a single file: > | |
3392 :set grepprg=grep\ -nH | |
161 | 3393 < Special value: When 'grepprg' is set to "internal" the |:grep| command |
657 | 3394 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like |
3395 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|. | |
41 | 3396 See also the section |:make_makeprg|, since most of the comments there |
7 | 3397 apply equally to 'grepprg'. |
3398 For Win32, the default is "findstr /n" if "findstr.exe" can be found, | |
3399 otherwise it's "grep -n". | |
3400 This option cannot be set from a |modeline| or in the |sandbox|, for | |
3401 security reasons. | |
3402 | |
3403 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549* | |
3404 'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor, | |
3405 ve:ver35-Cursor, | |
3406 o:hor50-Cursor, | |
3407 i-ci:ver25-Cursor/lCursor, | |
3408 r-cr:hor20-Cursor/lCursor, | |
3409 sm:block-Cursor | |
3410 -blinkwait175-blinkoff150-blinkon175", | |
3411 for MS-DOS and Win32 console: | |
3412 "n-v-c:block,o:hor50,i-ci:hor15, | |
3413 r-cr:hor30,sm:block") | |
3414 global | |
3415 {not in Vi} | |
3416 {only available when compiled with GUI enabled, and | |
3417 for MS-DOS and Win32 console} | |
3418 This option tells Vim what the cursor should look like in different | |
10 | 3419 modes. It fully works in the GUI. In an MSDOS or Win32 console, only |
7 | 3420 the height of the cursor can be changed. This can be done by |
3421 specifying a block cursor, or a percentage for a vertical or | |
3422 horizontal cursor. | |
6727 | 3423 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are |
3424 used. | |
7 | 3425 |
10 | 3426 The option is a comma separated list of parts. Each part consist of a |
7 | 3427 mode-list and an argument-list: |
3428 mode-list:argument-list,mode-list:argument-list,.. | |
3429 The mode-list is a dash separated list of these modes: | |
3430 n Normal mode | |
3431 v Visual mode | |
3432 ve Visual mode with 'selection' "exclusive" (same as 'v', | |
3433 if not specified) | |
3434 o Operator-pending mode | |
3435 i Insert mode | |
3436 r Replace mode | |
3437 c Command-line Normal (append) mode | |
3438 ci Command-line Insert mode | |
3439 cr Command-line Replace mode | |
3440 sm showmatch in Insert mode | |
3441 a all modes | |
3442 The argument-list is a dash separated list of these arguments: | |
3443 hor{N} horizontal bar, {N} percent of the character height | |
3444 ver{N} vertical bar, {N} percent of the character width | |
3445 block block cursor, fills the whole character | |
3446 [only one of the above three should be present] | |
3447 blinkwait{N} *cursor-blinking* | |
3448 blinkon{N} | |
3449 blinkoff{N} | |
3450 blink times for cursor: blinkwait is the delay before | |
3451 the cursor starts blinking, blinkon is the time that | |
3452 the cursor is shown and blinkoff is the time that the | |
3453 cursor is not shown. The times are in msec. When one | |
3454 of the numbers is zero, there is no blinking. The | |
3455 default is: "blinkwait700-blinkon400-blinkoff250". | |
3456 These numbers are used for a missing entry. This | |
3457 means that blinking is enabled by default. To switch | |
3458 blinking off you can use "blinkon0". The cursor only | |
3459 blinks when Vim is waiting for input, not while | |
3460 executing a command. | |
3461 To make the cursor blink in an xterm, see | |
3462 |xterm-blink|. | |
3463 {group-name} | |
3464 a highlight group name, that sets the color and font | |
3465 for the cursor | |
3466 {group-name}/{group-name} | |
3467 Two highlight group names, the first is used when | |
3468 no language mappings are used, the other when they | |
3469 are. |language-mapping| | |
3470 | |
3471 Examples of parts: | |
3472 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a | |
3473 block cursor with colors from the "nCursor" | |
3474 highlight group | |
3475 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150 | |
3476 In Insert and Command-line Insert mode, use a | |
3477 30% vertical bar cursor with colors from the | |
3478 "iCursor" highlight group. Blink a bit | |
3479 faster. | |
3480 | |
3481 The 'a' mode is different. It will set the given argument-list for | |
3482 all modes. It does not reset anything to defaults. This can be used | |
3483 to do a common setting for all modes. For example, to switch off | |
3484 blinking: "a:blinkon0" | |
3485 | |
3486 Examples of cursor highlighting: > | |
3487 :highlight Cursor gui=reverse guifg=NONE guibg=NONE | |
3488 :highlight Cursor gui=NONE guifg=bg guibg=fg | |
3489 < | |
3490 *'guifont'* *'gfn'* | |
2908 | 3491 *E235* *E596* |
7 | 3492 'guifont' 'gfn' string (default "") |
3493 global | |
3494 {not in Vi} | |
3495 {only available when compiled with GUI enabled} | |
3496 This is a list of fonts which will be used for the GUI version of Vim. | |
3497 In its simplest form the value is just one font name. When | |
3498 the font cannot be found you will get an error message. To try other | |
3499 font names a list can be specified, font names separated with commas. | |
3500 The first valid font is used. | |
8 | 3501 |
170 | 3502 On systems where 'guifontset' is supported (X11) and 'guifontset' is |
3503 not empty, then 'guifont' is not used. | |
8 | 3504 |
7 | 3505 Spaces after a comma are ignored. To include a comma in a font name |
3506 precede it with a backslash. Setting an option requires an extra | |
3507 backslash before a space and a backslash. See also | |
3508 |option-backslash|. For example: > | |
3509 :set guifont=Screen15,\ 7x13,font\\,with\\,commas | |
8 | 3510 < will make Vim try to use the font "Screen15" first, and if it fails it |
7 | 3511 will try to use "7x13" and then "font,with,commas" instead. |
8 | 3512 |
3513 If none of the fonts can be loaded, Vim will keep the current setting. | |
3514 If an empty font list is given, Vim will try using other resource | |
3515 settings (for X, it will use the Vim.font resource), and finally it | |
3516 will try some builtin default which should always be there ("7x13" in | |
3517 the case of X). The font names given should be "normal" fonts. Vim | |
3518 will try to find the related bold and italic fonts. | |
3519 | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3520 For Win32, GTK, Motif, Mac OS and Photon: > |
8 | 3521 :set guifont=* |
3522 < will bring up a font requester, where you can pick the font you want. | |
3523 | |
3524 The font name depends on the GUI used. See |setting-guifont| for a | |
3525 way to set 'guifont' for various systems. | |
3526 | |
7 | 3527 For the GTK+ 2 GUI the font name looks like this: > |
3528 :set guifont=Andale\ Mono\ 11 | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3529 < That's all. XLFDs are not used. For Chinese this is reported to work |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3530 well: > |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3531 if has("gui_gtk2") |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3532 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12 |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3533 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12 |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3534 endif |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3535 < |
170 | 3536 For Mac OSX you can use something like this: > |
3537 :set guifont=Monaco:h10 | |
853 | 3538 < Also see 'macatsui', it can help fix display problems. |
3539 *E236* | |
7 | 3540 Note that the fonts must be mono-spaced (all characters have the same |
8 | 3541 width). An exception is GTK 2: all fonts are accepted, but |
3542 mono-spaced fonts look best. | |
3543 | |
7 | 3544 To preview a font on X11, you might be able to use the "xfontsel" |
3545 program. The "xlsfonts" program gives a list of all available fonts. | |
8 | 3546 |
7 | 3547 For the Win32 GUI *E244* *E245* |
3548 - takes these options in the font name: | |
3549 hXX - height is XX (points, can be floating-point) | |
3550 wXX - width is XX (points, can be floating-point) | |
3551 b - bold | |
3552 i - italic | |
3553 u - underline | |
3554 s - strikeout | |
233 | 3555 cXX - character set XX. Valid charsets are: ANSI, ARABIC, |
7 | 3556 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK, |
3557 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS, | |
3558 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC. | |
22 | 3559 Normally you would use "cDEFAULT". |
7 | 3560 |
3561 Use a ':' to separate the options. | |
3562 - A '_' can be used in the place of a space, so you don't need to use | |
3563 backslashes to escape the spaces. | |
3564 - Examples: > | |
3565 :set guifont=courier_new:h12:w5:b:cRUSSIAN | |
3566 :set guifont=Andale_Mono:h7.5:w4.5 | |
3567 < See also |font-sizes|. | |
3568 | |
3569 *'guifontset'* *'gfs'* | |
3570 *E250* *E252* *E234* *E597* *E598* | |
3571 'guifontset' 'gfs' string (default "") | |
3572 global | |
3573 {not in Vi} | |
3574 {only available when compiled with GUI enabled and | |
3575 with the |+xfontset| feature} | |
3576 {not available in the GTK+ 2 GUI} | |
3577 When not empty, specifies two (or more) fonts to be used. The first | |
3578 one for normal English, the second one for your special language. See | |
3579 |xfontset|. | |
3580 Setting this option also means that all font names will be handled as | |
3581 a fontset name. Also the ones used for the "font" argument of the | |
3582 |:highlight| command. | |
3583 The fonts must match with the current locale. If fonts for the | |
3584 character sets that the current locale uses are not included, setting | |
3585 'guifontset' will fail. | |
3586 Note the difference between 'guifont' and 'guifontset': In 'guifont' | |
3587 the comma-separated names are alternative names, one of which will be | |
3588 used. In 'guifontset' the whole string is one fontset name, | |
3589 including the commas. It is not possible to specify alternative | |
3590 fontset names. | |
3591 This example works on many X11 systems: > | |
3592 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-* | |
3593 < | |
3594 *'guifontwide'* *'gfw'* *E231* *E533* *E534* | |
3595 'guifontwide' 'gfw' string (default "") | |
3596 global | |
3597 {not in Vi} | |
3598 {only available when compiled with GUI enabled} | |
3599 When not empty, specifies a comma-separated list of fonts to be used | |
3600 for double-width characters. The first font that can be loaded is | |
3601 used. | |
3602 Note: The size of these fonts must be exactly twice as wide as the one | |
3603 specified with 'guifont' and the same height. | |
3604 | |
3605 All GUI versions but GTK+ 2: | |
3606 | |
3607 'guifontwide' is only used when 'encoding' is set to "utf-8" and | |
3608 'guifontset' is empty or invalid. | |
3609 When 'guifont' is set and a valid font is found in it and | |
3610 'guifontwide' is empty Vim will attempt to find a matching | |
3611 double-width font and set 'guifontwide' to it. | |
3612 | |
3613 GTK+ 2 GUI only: *guifontwide_gtk2* | |
3614 | |
3615 If set and valid, 'guifontwide' is always used for double width | |
3616 characters, even if 'encoding' is not set to "utf-8". | |
3617 Vim does not attempt to find an appropriate value for 'guifontwide' | |
10 | 3618 automatically. If 'guifontwide' is empty Pango/Xft will choose the |
7 | 3619 font for characters not available in 'guifont'. Thus you do not need |
3620 to set 'guifontwide' at all unless you want to override the choice | |
3621 made by Pango/Xft. | |
3622 | |
4055 | 3623 Windows +multibyte only: *guifontwide_win_mbyte* |
3624 | |
4073 | 3625 If set and valid, 'guifontwide' is used for IME instead of 'guifont'. |
4055 | 3626 |
7 | 3627 *'guiheadroom'* *'ghr'* |
3628 'guiheadroom' 'ghr' number (default 50) | |
3629 global | |
3630 {not in Vi} {only for GTK and X11 GUI} | |
3631 The number of pixels subtracted from the screen height when fitting | |
3632 the GUI window on the screen. Set this before the GUI is started, | |
3633 e.g., in your |gvimrc| file. When zero, the whole screen height will | |
10 | 3634 be used by the window. When positive, the specified number of pixel |
7 | 3635 lines will be left for window decorations and other items on the |
3636 screen. Set it to a negative value to allow windows taller than the | |
3637 screen. | |
3638 | |
3639 *'guioptions'* *'go'* | |
3224 | 3640 'guioptions' 'go' string (default "egmrLtT" (MS-Windows), |
3641 "aegimrLtT" (GTK, Motif and Athena)) | |
7 | 3642 global |
3643 {not in Vi} | |
3644 {only available when compiled with GUI enabled} | |
8 | 3645 This option only has an effect in the GUI version of Vim. It is a |
7 | 3646 sequence of letters which describes what components and options of the |
3647 GUI should be used. | |
3648 To avoid problems with flags that are added in the future, use the | |
3649 "+=" and "-=" feature of ":set" |add-option-flags|. | |
3650 | |
3651 Valid letters are as follows: | |
1152 | 3652 *guioptions_a* *'go-a'* |
7 | 3653 'a' Autoselect: If present, then whenever VISUAL mode is started, |
3654 or the Visual area extended, Vim tries to become the owner of | |
3655 the windowing system's global selection. This means that the | |
3656 Visually highlighted text is available for pasting into other | |
3657 applications as well as into Vim itself. When the Visual mode | |
3658 ends, possibly due to an operation on the text, or when an | |
3659 application wants to paste the selection, the highlighted text | |
3660 is automatically yanked into the "* selection register. | |
3661 Thus the selection is still available for pasting into other | |
3662 applications after the VISUAL mode has ended. | |
3663 If not present, then Vim won't become the owner of the | |
3664 windowing system's global selection unless explicitly told to | |
3665 by a yank or delete operation for the "* register. | |
3666 The same applies to the modeless selection. | |
3674 | 3667 *'go-P'* |
3668 'P' Like autoselect but using the "+ register instead of the "* | |
3669 register. | |
1152 | 3670 *'go-A'* |
10 | 3671 'A' Autoselect for the modeless selection. Like 'a', but only |
7 | 3672 applies to the modeless selection. |
3673 | |
3674 'guioptions' autoselect Visual autoselect modeless ~ | |
3675 "" - - | |
3676 "a" yes yes | |
3677 "A" - yes | |
3678 "aA" yes yes | |
3679 | |
1152 | 3680 *'go-c'* |
7 | 3681 'c' Use console dialogs instead of popup dialogs for simple |
3682 choices. | |
1152 | 3683 *'go-e'* |
697 | 3684 'e' Add tab pages when indicated with 'showtabline'. |
688 | 3685 'guitablabel' can be used to change the text in the labels. |
3686 When 'e' is missing a non-GUI tab pages line may be used. | |
857 | 3687 The GUI tabs are only supported on some systems, currently |
1621 | 3688 GTK, Motif, Mac OS/X and MS-Windows. |
1152 | 3689 *'go-f'* |
7 | 3690 'f' Foreground: Don't use fork() to detach the GUI from the shell |
3691 where it was started. Use this for programs that wait for the | |
3692 editor to finish (e.g., an e-mail program). Alternatively you | |
3693 can use "gvim -f" or ":gui -f" to start the GUI in the | |
3694 foreground. |gui-fork| | |
3695 Note: Set this option in the vimrc file. The forking may have | |
819 | 3696 happened already when the |gvimrc| file is read. |
1152 | 3697 *'go-i'* |
7 | 3698 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper |
3699 corner of the window. It's black&white on non-GTK, because of | |
3700 limitations of X11. For a color icon, see |X11-icon|. | |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3701 *'go-m'* |
7 | 3702 'm' Menu bar is present. |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3703 *'go-M'* |
10 | 3704 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note |
7 | 3705 that this flag must be added in the .vimrc file, before |
819 | 3706 switching on syntax or filetype recognition (when the |gvimrc| |
7 | 3707 file is sourced the system menu has already been loaded; the |
3708 ":syntax on" and ":filetype on" commands load the menu too). | |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3709 *'go-g'* |
7 | 3710 'g' Grey menu items: Make menu items that are not active grey. If |
3711 'g' is not included inactive menu items are not shown at all. | |
3712 Exception: Athena will always use grey menu items. | |
1152 | 3713 *'go-t'* |
7 | 3714 't' Include tearoff menu items. Currently only works for Win32, |
3715 GTK+, and Motif 1.2 GUI. | |
1152 | 3716 *'go-T'* |
236 | 3717 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon |
856 | 3718 and Athena GUIs. |
1152 | 3719 *'go-r'* |
7 | 3720 'r' Right-hand scrollbar is always present. |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3721 *'go-R'* |
7 | 3722 'R' Right-hand scrollbar is present when there is a vertically |
3723 split window. | |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3724 *'go-l'* |
7 | 3725 'l' Left-hand scrollbar is always present. |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3726 *'go-L'* |
7 | 3727 'L' Left-hand scrollbar is present when there is a vertically |
3728 split window. | |
1152 | 3729 *'go-b'* |
7 | 3730 'b' Bottom (horizontal) scrollbar is present. Its size depends on |
3731 the longest visible line, or on the cursor line if the 'h' | |
3732 flag is included. |gui-horiz-scroll| | |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3733 *'go-h'* |
7 | 3734 'h' Limit horizontal scrollbar size to the length of the cursor |
3735 line. Reduces computations. |gui-horiz-scroll| | |
3736 | |
3737 And yes, you may even have scrollbars on the left AND the right if | |
3738 you really want to :-). See |gui-scrollbars| for more information. | |
3739 | |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3740 *'go-v'* |
7 | 3741 'v' Use a vertical button layout for dialogs. When not included, |
3742 a horizontal layout is preferred, but when it doesn't fit a | |
3743 vertical layout is used anyway. | |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3744 *'go-p'* |
7 | 3745 'p' Use Pointer callbacks for X11 GUI. This is required for some |
3746 window managers. If the cursor is not blinking or hollow at | |
3747 the right moment, try adding this flag. This must be done | |
819 | 3748 before starting the GUI. Set it in your |gvimrc|. Adding or |
7 | 3749 removing it after the GUI has started has no effect. |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3750 *'go-F'* |
10 | 3751 'F' Add a footer. Only for Motif. See |gui-footer|. |
7 | 3752 |
1152 | 3753 |
7 | 3754 *'guipty'* *'noguipty'* |
3755 'guipty' boolean (default on) | |
3756 global | |
3757 {not in Vi} | |
3758 {only available when compiled with GUI enabled} | |
3759 Only in the GUI: If on, an attempt is made to open a pseudo-tty for | |
3760 I/O to/from shell commands. See |gui-pty|. | |
3761 | |
688 | 3762 *'guitablabel'* *'gtl'* |
3763 'guitablabel' 'gtl' string (default empty) | |
3764 global | |
3765 {not in Vi} | |
692 | 3766 {only available when compiled with GUI enabled and |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
3767 with the |+windows| feature} |
688 | 3768 When nonempty describes the text to use in a label of the GUI tab |
857 | 3769 pages line. When empty and when the result is empty Vim will use a |
3770 default label. See |setting-guitablabel| for more info. | |
688 | 3771 |
692 | 3772 The format of this option is like that of 'statusline'. |
839 | 3773 'guitabtooltip' is used for the tooltip, see below. |
692 | 3774 |
688 | 3775 Only used when the GUI tab pages line is displayed. 'e' must be |
3776 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is | |
3777 used. | |
3778 | |
839 | 3779 *'guitabtooltip'* *'gtt'* |
3780 'guitabtooltip' 'gtt' string (default empty) | |
3781 global | |
3782 {not in Vi} | |
3783 {only available when compiled with GUI enabled and | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
3784 with the |+windows| feature} |
839 | 3785 When nonempty describes the text to use in a tooltip for the GUI tab |
3786 pages line. When empty Vim will use a default tooltip. | |
3787 This option is otherwise just like 'guitablabel' above. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3788 You can include a line break. Simplest method is to use |:let|: > |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3789 :let &guitabtooltip = "line one\nline two" |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3790 < |
839 | 3791 |
7 | 3792 *'helpfile'* *'hf'* |
3793 'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt" | |
3794 (others) "$VIMRUNTIME/doc/help.txt") | |
3795 global | |
3796 {not in Vi} | |
3797 Name of the main help file. All distributed help files should be | |
3798 placed together in one directory. Additionally, all "doc" directories | |
3799 in 'runtimepath' will be used. | |
3800 Environment variables are expanded |:set_env|. For example: | |
3801 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also | |
10 | 3802 tried. Also see |$VIMRUNTIME| and |option-backslash| about including |
7 | 3803 spaces and backslashes. |
3804 This option cannot be set from a |modeline| or in the |sandbox|, for | |
3805 security reasons. | |
3806 | |
3807 *'helpheight'* *'hh'* | |
3808 'helpheight' 'hh' number (default 20) | |
3809 global | |
3810 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
3811 {not available when compiled without the |+windows| |
7 | 3812 feature} |
3813 Minimal initial height of the help window when it is opened with the | |
3814 ":help" command. The initial height of the help window is half of the | |
3815 current window, or (when the 'ea' option is on) the same as other | |
3816 windows. When the height is less than 'helpheight', the height is | |
3817 set to 'helpheight'. Set to zero to disable. | |
3818 | |
3819 *'helplang'* *'hlg'* | |
3820 'helplang' 'hlg' string (default: messages language or empty) | |
3821 global | |
3822 {only available when compiled with the |+multi_lang| | |
3823 feature} | |
3824 {not in Vi} | |
3825 Comma separated list of languages. Vim will use the first language | |
3826 for which the desired help can be found. The English help will always | |
3827 be used as a last resort. You can add "en" to prefer English over | |
3828 another language, but that will only find tags that exist in that | |
3829 language and not in the English help. | |
3830 Example: > | |
3831 :set helplang=de,it | |
3832 < This will first search German, then Italian and finally English help | |
3833 files. | |
3834 When using |CTRL-]| and ":help!" in a non-English help file Vim will | |
3835 try to find the tag in the current language before using this option. | |
3836 See |help-translated|. | |
3837 | |
3838 *'hidden'* *'hid'* *'nohidden'* *'nohid'* | |
3839 'hidden' 'hid' boolean (default off) | |
3840 global | |
3841 {not in Vi} | |
3842 When off a buffer is unloaded when it is |abandon|ed. When on a | |
3843 buffer becomes hidden when it is |abandon|ed. If the buffer is still | |
3844 displayed in another window, it does not become hidden, of course. | |
3845 The commands that move through the buffer list sometimes make a buffer | |
3846 hidden although the 'hidden' option is off: When the buffer is | |
3847 modified, 'autowrite' is off or writing is not possible, and the '!' | |
10 | 3848 flag was used. See also |windows.txt|. |
12 | 3849 To only make one buffer hidden use the 'bufhidden' option. |
7 | 3850 This option is set for one command with ":hide {command}" |:hide|. |
3851 WARNING: It's easy to forget that you have changes in hidden buffers. | |
3852 Think twice when using ":q!" or ":qa!". | |
3853 | |
3854 *'highlight'* *'hl'* | |
3855 'highlight' 'hl' string (default (as a single string): | |
3856 "8:SpecialKey,@:NonText,d:Directory, | |
3857 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg, | |
3445 | 3858 M:ModeMsg,n:LineNr,N:CursorLineNr, |
3859 r:Question,s:StatusLine,S:StatusLineNC, | |
3860 c:VertSplit, t:Title,v:Visual, | |
3861 w:WarningMsg,W:WildMenu, | |
7 | 3862 f:Folded,F:FoldColumn,A:DiffAdd, |
3863 C:DiffChange,D:DiffDelete,T:DiffText, | |
386 | 3864 >:SignColumn,B:SpellBad,P:SpellCap, |
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
3865 R:SpellRare,L:SpellLocal,-:Conceal, |
540 | 3866 +:Pmenu,=:PmenuSel, |
3867 x:PmenuSbar,X:PmenuThumb") | |
7 | 3868 global |
3869 {not in Vi} | |
3870 This option can be used to set highlighting mode for various | |
3871 occasions. It is a comma separated list of character pairs. The | |
3872 first character in a pair gives the occasion, the second the mode to | |
10 | 3873 use for that occasion. The occasions are: |
7 | 3874 |hl-SpecialKey| 8 Meta and special keys listed with ":map" |
3875 |hl-NonText| @ '~' and '@' at the end of the window and | |
3876 characters from 'showbreak' | |
3877 |hl-Directory| d directories in CTRL-D listing and other special | |
3878 things in listings | |
3879 |hl-ErrorMsg| e error messages | |
3880 h (obsolete, ignored) | |
3881 |hl-IncSearch| i 'incsearch' highlighting | |
3882 |hl-Search| l last search pattern highlighting (see 'hlsearch') | |
3883 |hl-MoreMsg| m |more-prompt| | |
3884 |hl-ModeMsg| M Mode (e.g., "-- INSERT --") | |
2178
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3885 |hl-LineNr| n line number for ":number" and ":#" commands, and |
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3886 when 'number' or 'relativenumber' option is set. |
4073 | 3887 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is |
3888 set. | |
7 | 3889 |hl-Question| r |hit-enter| prompt and yes/no questions |
3890 |hl-StatusLine| s status line of current window |status-line| | |
3891 |hl-StatusLineNC| S status lines of not-current windows | |
3892 |hl-Title| t Titles for output from ":set all", ":autocmd" etc. | |
3893 |hl-VertSplit| c column used to separate vertically split windows | |
3894 |hl-Visual| v Visual mode | |
3895 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the | |
3896 Selection" Only X11 Gui's |gui-x11| and | |
3897 |xterm-clipboard|. | |
3898 |hl-WarningMsg| w warning messages | |
3899 |hl-WildMenu| W wildcard matches displayed for 'wildmenu' | |
3900 |hl-Folded| f line used for closed folds | |
3901 |hl-FoldColumn| F 'foldcolumn' | |
386 | 3902 |hl-DiffAdd| A added line in diff mode |
3903 |hl-DiffChange| C changed line in diff mode | |
3904 |hl-DiffDelete| D deleted line in diff mode | |
3905 |hl-DiffText| T inserted text in diff mode | |
7 | 3906 |hl-SignColumn| > column used for |signs| |
221 | 3907 |hl-SpellBad| B misspelled word |spell| |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2324
diff
changeset
|
3908 |hl-SpellCap| P word that should start with capital |spell| |
221 | 3909 |hl-SpellRare| R rare word |spell| |
3910 |hl-SpellLocal| L word from other region |spell| | |
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
3911 |hl-Conceal| - the placeholders used for concealed characters |
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
3912 (see 'conceallevel') |
540 | 3913 |hl-Pmenu| + popup menu normal line |
3914 |hl-PmenuSel| = popup menu normal line | |
3915 |hl-PmenuSbar| x popup menu scrollbar | |
3916 |hl-PmenuThumb| X popup menu scrollbar thumb | |
7 | 3917 |
3918 The display modes are: | |
3919 r reverse (termcap entry "mr" and "me") | |
3920 i italic (termcap entry "ZH" and "ZR") | |
3921 b bold (termcap entry "md" and "me") | |
3922 s standout (termcap entry "so" and "se") | |
3923 u underline (termcap entry "us" and "ue") | |
205 | 3924 c undercurl (termcap entry "Cs" and "Ce") |
7 | 3925 n no highlighting |
3926 - no highlighting | |
3927 : use a highlight group | |
3928 The default is used for occasions that are not included. | |
3929 If you want to change what the display modes do, see |dos-colors| | |
3930 for an example. | |
3931 When using the ':' display mode, this must be followed by the name of | |
3932 a highlight group. A highlight group can be used to define any type | |
3933 of highlighting, including using color. See |:highlight| on how to | |
3934 define one. The default uses a different group for each occasion. | |
3935 See |highlight-default| for the default highlight groups. | |
3936 | |
3937 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'* | |
3938 'hlsearch' 'hls' boolean (default off) | |
3939 global | |
3940 {not in Vi} | |
3941 {not available when compiled without the | |
3942 |+extra_search| feature} | |
3943 When there is a previous search pattern, highlight all its matches. | |
3944 The type of highlighting used can be set with the 'l' occasion in the | |
3945 'highlight' option. This uses the "Search" highlight group by | |
3946 default. Note that only the matching text is highlighted, any offsets | |
3947 are not applied. | |
3948 See also: 'incsearch' and |:match|. | |
3949 When you get bored looking at the highlighted matches, you can turn it | |
3224 | 3950 off with |:nohlsearch|. This does not change the option value, as |
3951 soon as you use a search command, the highlighting comes back. | |
1621 | 3952 'redrawtime' specifies the maximum time spent on finding matches. |
7 | 3953 When the search pattern can match an end-of-line, Vim will try to |
3954 highlight all of the matched text. However, this depends on where the | |
10 | 3955 search starts. This will be the first line in the window or the first |
7 | 3956 line below a closed fold. A match in a previous line which is not |
819 | 3957 drawn may not continue in a newly drawn line. |
3224 | 3958 You can specify whether the highlight status is restored on startup |
3959 with the 'h' flag in 'viminfo' |viminfo-h|. | |
7 | 3960 NOTE: This option is reset when 'compatible' is set. |
3961 | |
3962 *'history'* *'hi'* | |
5991 | 3963 'history' 'hi' number (Vim default: 50, Vi default: 0) |
7 | 3964 global |
3965 {not in Vi} | |
3966 A history of ":" commands, and a history of previous search patterns | |
5991 | 3967 is remembered. This option decides how many entries may be stored in |
7 | 3968 each of these histories (see |cmdline-editing|). |
5991 | 3969 The maximum value is 10000. |
7 | 3970 NOTE: This option is set to the Vi default value when 'compatible' is |
3971 set and to the Vim default value when 'compatible' is reset. | |
3972 | |
3973 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'* | |
3974 'hkmap' 'hk' boolean (default off) | |
3975 global | |
3976 {not in Vi} | |
3977 {only available when compiled with the |+rightleft| | |
3978 feature} | |
3979 When on, the keyboard is mapped for the Hebrew character set. | |
3980 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to | |
3981 toggle this option. See |rileft.txt|. | |
3982 NOTE: This option is reset when 'compatible' is set. | |
3983 | |
3984 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'* | |
3985 'hkmapp' 'hkp' boolean (default off) | |
3986 global | |
3987 {not in Vi} | |
3988 {only available when compiled with the |+rightleft| | |
3989 feature} | |
3990 When on, phonetic keyboard mapping is used. 'hkmap' must also be on. | |
3991 This is useful if you have a non-Hebrew keyboard. | |
3992 See |rileft.txt|. | |
3993 NOTE: This option is reset when 'compatible' is set. | |
3994 | |
3995 *'icon'* *'noicon'* | |
3996 'icon' boolean (default off, on when title can be restored) | |
3997 global | |
3998 {not in Vi} | |
3999 {not available when compiled without the |+title| | |
4000 feature} | |
4001 When on, the icon text of the window will be set to the value of | |
4002 'iconstring' (if it is not empty), or to the name of the file | |
4003 currently being edited. Only the last part of the name is used. | |
4004 Overridden by the 'iconstring' option. | |
4005 Only works if the terminal supports setting window icons (currently | |
4006 only X11 GUI and terminals with a non-empty 't_IS' option - these are | |
4007 Unix xterm and iris-ansi by default, where 't_IS' is taken from the | |
4008 builtin termcap). | |
4009 When Vim was compiled with HAVE_X11 defined, the original icon will be | |
233 | 4010 restored if possible |X11|. See |X11-icon| for changing the icon on |
7 | 4011 X11. |
6259 | 4012 For MS-Windows the icon can be changed, see |windows-icon|. |
7 | 4013 |
4014 *'iconstring'* | |
4015 'iconstring' string (default "") | |
4016 global | |
4017 {not in Vi} | |
4018 {not available when compiled without the |+title| | |
4019 feature} | |
4020 When this option is not empty, it will be used for the icon text of | |
4021 the window. This happens only when the 'icon' option is on. | |
4022 Only works if the terminal supports setting window icon text | |
4023 (currently only X11 GUI and terminals with a non-empty 't_IS' option). | |
4024 Does not work for MS Windows. | |
4025 When Vim was compiled with HAVE_X11 defined, the original icon will be | |
4026 restored if possible |X11|. | |
4027 When this option contains printf-style '%' items, they will be | |
10 | 4028 expanded according to the rules used for 'statusline'. See |
7 | 4029 'titlestring' for example settings. |
4030 {not available when compiled without the |+statusline| feature} | |
4031 | |
4032 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'* | |
4033 'ignorecase' 'ic' boolean (default off) | |
4034 global | |
4035 Ignore case in search patterns. Also used when searching in the tags | |
4036 file. | |
4037 Also see 'smartcase'. | |
4038 Can be overruled by using "\c" or "\C" in the pattern, see | |
4039 |/ignorecase|. | |
4040 | |
5008
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4041 *'imactivatefunc'* *'imaf'* |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4042 'imactivatefunc' 'imaf' string (default "") |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4043 global |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4044 {not in Vi} |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4045 {only available when compiled with |+xim| and |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4046 |+GUI_GTK|} |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4047 This option specifies a function that will be called to |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4048 activate/inactivate Input Method. |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4049 |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4050 Example: > |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4051 function ImActivateFunc(active) |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4052 if a:active |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4053 ... do something |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4054 else |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4055 ... do something |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4056 endif |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4057 " return value is not used |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4058 endfunction |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4059 set imactivatefunc=ImActivateFunc |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4060 < |
7 | 4061 *'imactivatekey'* *'imak'* |
4062 'imactivatekey' 'imak' string (default "") | |
4063 global | |
4064 {not in Vi} | |
4065 {only available when compiled with |+xim| and | |
2209
d0ddf7ba1630
Included the patch to support netbeans in a terminal.
Bram Moolenaar <bram@vim.org>
parents:
2207
diff
changeset
|
4066 |+GUI_GTK|} *E599* |
7 | 4067 Specifies the key that your Input Method in X-Windows uses for |
4068 activation. When this is specified correctly, vim can fully control | |
4069 IM with 'imcmdline', 'iminsert' and 'imsearch'. | |
4070 You can't use this option to change the activation key, the option | |
4071 tells Vim what the key is. | |
4072 Format: | |
4073 [MODIFIER_FLAG-]KEY_STRING | |
4074 | |
4075 These characters can be used for MODIFIER_FLAG (case is ignored): | |
4076 S Shift key | |
4077 L Lock key | |
4078 C Control key | |
4079 1 Mod1 key | |
4080 2 Mod2 key | |
4081 3 Mod3 key | |
4082 4 Mod4 key | |
4083 5 Mod5 key | |
4084 Combinations are allowed, for example "S-C-space" or "SC-space" are | |
4085 both shift+ctrl+space. | |
4086 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING. | |
4087 | |
4088 Example: > | |
4089 :set imactivatekey=S-space | |
4090 < "S-space" means shift+space. This is the activation key for kinput2 + | |
4091 canna (Japanese), and ami (Korean). | |
4092 | |
4093 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'* | |
4094 'imcmdline' 'imc' boolean (default off) | |
4095 global | |
4096 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
4097 {only available when compiled with the |+xim|, |
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
4098 |+multi_byte_ime| or |global-ime| features} |
7 | 4099 When set the Input Method is always on when starting to edit a command |
4100 line, unless entering a search pattern (see 'imsearch' for that). | |
4101 Setting this option is useful when your input method allows entering | |
4102 English characters directly, e.g., when it's used to type accented | |
4103 characters with dead keys. | |
4104 | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4105 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'* |
7 | 4106 'imdisable' 'imd' boolean (default off, on for some systems (SGI)) |
4107 global | |
4108 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
4109 {only available when compiled with the |+xim|, |
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
4110 |+multi_byte_ime| or |global-ime| features} |
7 | 4111 When set the Input Method is never used. This is useful to disable |
4112 the IM when it doesn't work properly. | |
4113 Currently this option is on by default for SGI/IRIX machines. This | |
4114 may change in later releases. | |
4115 | |
4116 *'iminsert'* *'imi'* | |
4117 'iminsert' 'imi' number (default 0, 2 when an input method is supported) | |
4118 local to buffer | |
4119 {not in Vi} | |
4120 Specifies whether :lmap or an Input Method (IM) is to be used in | |
4121 Insert mode. Valid values: | |
4122 0 :lmap is off and IM is off | |
4123 1 :lmap is ON and IM is off | |
4124 2 :lmap is off and IM is ON | |
4125 2 is available only when compiled with the |+multi_byte_ime|, |+xim| | |
4126 or |global-ime|. | |
4127 To always reset the option to zero when leaving Insert mode with <Esc> | |
4128 this can be used: > | |
4129 :inoremap <ESC> <ESC>:set iminsert=0<CR> | |
4130 < This makes :lmap and IM turn off automatically when leaving Insert | |
4131 mode. | |
4132 Note that this option changes when using CTRL-^ in Insert mode | |
4133 |i_CTRL-^|. | |
4134 The value is set to 1 when setting 'keymap' to a valid keymap name. | |
4135 It is also used for the argument of commands like "r" and "f". | |
4136 The value 0 may not work correctly with Athena and Motif with some XIM | |
4137 methods. Use 'imdisable' to disable XIM then. | |
4138 | |
4139 *'imsearch'* *'ims'* | |
4140 'imsearch' 'ims' number (default 0, 2 when an input method is supported) | |
4141 local to buffer | |
4142 {not in Vi} | |
4143 Specifies whether :lmap or an Input Method (IM) is to be used when | |
4144 entering a search pattern. Valid values: | |
4145 -1 the value of 'iminsert' is used, makes it look like | |
4146 'iminsert' is also used when typing a search pattern | |
4147 0 :lmap is off and IM is off | |
4148 1 :lmap is ON and IM is off | |
4149 2 :lmap is off and IM is ON | |
4150 Note that this option changes when using CTRL-^ in Command-line mode | |
4151 |c_CTRL-^|. | |
4152 The value is set to 1 when it is not -1 and setting the 'keymap' | |
4153 option to a valid keymap name. | |
4154 The value 0 may not work correctly with Athena and Motif with some XIM | |
4155 methods. Use 'imdisable' to disable XIM then. | |
4156 | |
5008
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4157 *'imstatusfunc'* *'imsf'* |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4158 'imstatusfunc' 'imsf' string (default "") |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4159 global |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4160 {not in Vi} |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4161 {only available when compiled with |+xim| and |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4162 |+GUI_GTK|} |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4163 This option specifies a function that is called to obtain the status |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4164 of Input Method. It must return a positive number when IME is active. |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4165 |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4166 Example: > |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4167 function ImStatusFunc() |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4168 let is_active = ...do something |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4169 return is_active ? 1 : 0 |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4170 endfunction |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4171 set imstatusfunc=ImStatusFunc |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4172 < |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4173 NOTE: This function is invoked very often. Keep it fast. |
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4174 |
7 | 4175 *'include'* *'inc'* |
4176 'include' 'inc' string (default "^\s*#\s*include") | |
4177 global or local to buffer |global-local| | |
4178 {not in Vi} | |
4179 {not available when compiled without the | |
4180 |+find_in_path| feature} | |
10 | 4181 Pattern to be used to find an include command. It is a search |
7 | 4182 pattern, just like for the "/" command (See |pattern|). The default |
4183 value is for C programs. This option is used for the commands "[i", | |
532 | 4184 "]I", "[d", etc. |
4185 Normally the 'isfname' option is used to recognize the file name that | |
534 | 4186 comes after the matched pattern. But if "\zs" appears in the pattern |
4187 then the text matched from "\zs" to the end, or until "\ze" if it | |
4188 appears, is used as the file name. Use this to include characters | |
4189 that are not in 'isfname', such as a space. You can then use | |
4190 'includeexpr' to process the matched text. | |
532 | 4191 See |option-backslash| about including spaces and backslashes. |
7 | 4192 |
4193 *'includeexpr'* *'inex'* | |
4194 'includeexpr' 'inex' string (default "") | |
4195 local to buffer | |
4196 {not in Vi} | |
4197 {not available when compiled without the | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
4198 |+find_in_path| or |+eval| features} |
7 | 4199 Expression to be used to transform the string found with the 'include' |
10 | 4200 option to a file name. Mostly useful to change "." to "/" for Java: > |
7 | 4201 :set includeexpr=substitute(v:fname,'\\.','/','g') |
4202 < The "v:fname" variable will be set to the file name that was detected. | |
634 | 4203 |
7 | 4204 Also used for the |gf| command if an unmodified file name can't be |
10 | 4205 found. Allows doing "gf" on the name after an 'include' statement. |
7 | 4206 Also used for |<cfile>|. |
4207 | |
3682 | 4208 The expression will be evaluated in the |sandbox| when set from a |
4209 modeline, see |sandbox-option|. | |
634 | 4210 |
4211 It is not allowed to change text or jump to another window while | |
4212 evaluating 'includeexpr' |textlock|. | |
4213 | |
7 | 4214 *'incsearch'* *'is'* *'noincsearch'* *'nois'* |
4215 'incsearch' 'is' boolean (default off) | |
4216 global | |
4217 {not in Vi} | |
4218 {not available when compiled without the | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
4219 |+extra_search| features} |
17 | 4220 While typing a search command, show where the pattern, as it was typed |
4221 so far, matches. The matched string is highlighted. If the pattern | |
4222 is invalid or not found, nothing is shown. The screen will be updated | |
4223 often, this is only useful on fast terminals. | |
4224 Note that the match will be shown, but the cursor will return to its | |
4225 original position when no match is found and when pressing <Esc>. You | |
4226 still need to finish the search command with <Enter> to move the | |
4227 cursor to the match. | |
1521 | 4228 When compiled with the |+reltime| feature Vim only searches for about |
4229 half a second. With a complicated pattern and/or a lot of text the | |
4230 match may not be found. This is to avoid that Vim hangs while you | |
4231 are typing the pattern. | |
17 | 4232 The highlighting can be set with the 'i' flag in 'highlight'. |
4233 See also: 'hlsearch'. | |
772 | 4234 CTRL-L can be used to add one character from after the current match |
2302
488be8cbe19c
Make CTRL-L in command line mode respect 'ignorecase' and 'smartcase'. (Martin
Bram Moolenaar <bram@vim.org>
parents:
2301
diff
changeset
|
4235 to the command line. If 'ignorecase' and 'smartcase' are set and the |
488be8cbe19c
Make CTRL-L in command line mode respect 'ignorecase' and 'smartcase'. (Martin
Bram Moolenaar <bram@vim.org>
parents:
2301
diff
changeset
|
4236 command line has no uppercase characters, the added character is |
488be8cbe19c
Make CTRL-L in command line mode respect 'ignorecase' and 'smartcase'. (Martin
Bram Moolenaar <bram@vim.org>
parents:
2301
diff
changeset
|
4237 converted to lowercase. |
772 | 4238 CTRL-R CTRL-W can be used to add the word at the end of the current |
4239 match, excluding the characters that were already typed. | |
7 | 4240 NOTE: This option is reset when 'compatible' is set. |
4241 | |
4242 *'indentexpr'* *'inde'* | |
4243 'indentexpr' 'inde' string (default "") | |
4244 local to buffer | |
4245 {not in Vi} | |
4246 {not available when compiled without the |+cindent| | |
4247 or |+eval| features} | |
4248 Expression which is evaluated to obtain the proper indent for a line. | |
4249 It is used when a new line is created, for the |=| operator and | |
4250 in Insert mode as specified with the 'indentkeys' option. | |
4251 When this option is not empty, it overrules the 'cindent' and | |
2833 | 4252 'smartindent' indenting. When 'lisp' is set, this option is |
4253 overridden by the Lisp indentation algorithm. | |
7 | 4254 When 'paste' is set this option is not used for indenting. |
4255 The expression is evaluated with |v:lnum| set to the line number for | |
534 | 4256 which the indent is to be computed. The cursor is also in this line |
7 | 4257 when the expression is evaluated (but it may be moved around). |
4258 The expression must return the number of spaces worth of indent. It | |
4259 can return "-1" to keep the current indent (this means 'autoindent' is | |
4260 used for the indent). | |
4261 Functions useful for computing the indent are |indent()|, |cindent()| | |
4262 and |lispindent()|. | |
4263 The evaluation of the expression must not have side effects! It must | |
4264 not change the text, jump to another window, etc. Afterwards the | |
4265 cursor position is always restored, thus the cursor may be moved. | |
4266 Normally this option would be set to call a function: > | |
4267 :set indentexpr=GetMyIndent() | |
4268 < Error messages will be suppressed, unless the 'debug' option contains | |
4269 "msg". | |
634 | 4270 See |indent-expression|. |
7 | 4271 NOTE: This option is made empty when 'compatible' is set. |
4272 | |
3682 | 4273 The expression will be evaluated in the |sandbox| when set from a |
4274 modeline, see |sandbox-option|. | |
634 | 4275 |
4276 It is not allowed to change text or jump to another window while | |
4277 evaluating 'indentexpr' |textlock|. | |
4278 | |
4279 | |
7 | 4280 *'indentkeys'* *'indk'* |
4281 'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e") | |
4282 local to buffer | |
4283 {not in Vi} | |
4284 {not available when compiled without the |+cindent| | |
4285 feature} | |
4286 A list of keys that, when typed in Insert mode, cause reindenting of | |
4287 the current line. Only happens if 'indentexpr' isn't empty. | |
4288 The format is identical to 'cinkeys', see |indentkeys-format|. | |
4289 See |C-indenting| and |indent-expression|. | |
4290 | |
4291 *'infercase'* *'inf'* *'noinfercase'* *'noinf'* | |
4292 'infercase' 'inf' boolean (default off) | |
4293 local to buffer | |
4294 {not in Vi} | |
4295 When doing keyword completion in insert mode |ins-completion|, and | |
1621 | 4296 'ignorecase' is also on, the case of the match is adjusted depending |
4297 on the typed text. If the typed text contains a lowercase letter | |
4298 where the match has an upper case letter, the completed part is made | |
4299 lowercase. If the typed text has no lowercase letters and the match | |
4300 has a lowercase letter where the typed text has an uppercase letter, | |
4301 and there is a letter before it, the completed part is made uppercase. | |
4302 With 'noinfercase' the match is used as-is. | |
7 | 4303 |
4304 *'insertmode'* *'im'* *'noinsertmode'* *'noim'* | |
4305 'insertmode' 'im' boolean (default off) | |
4306 global | |
4307 {not in Vi} | |
4308 Makes Vim work in a way that Insert mode is the default mode. Useful | |
4309 if you want to use Vim as a modeless editor. Used for |evim|. | |
4310 These Insert mode commands will be useful: | |
4311 - Use the cursor keys to move around. | |
4312 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When | |
4313 this is a mapping, it is executed as if 'insertmode' was off. | |
4314 Normal mode remains active until the mapping is finished. | |
4315 - Use CTRL-L to execute a number of Normal mode commands, then use | |
477 | 4316 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor |
4317 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L| | |
7 | 4318 |
4319 These items change when 'insertmode' is set: | |
4320 - when starting to edit of a file, Vim goes to Insert mode. | |
4321 - <Esc> in Insert mode is a no-op and beeps. | |
4322 - <Esc> in Normal mode makes Vim go to Insert mode. | |
4323 - CTRL-L in Insert mode is a command, it is not inserted. | |
4324 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z* | |
4325 However, when <Esc> is used inside a mapping, it behaves like | |
4326 'insertmode' was not set. This was done to be able to use the same | |
4327 mappings with 'insertmode' set or not set. | |
4328 When executing commands with |:normal| 'insertmode' is not used. | |
4329 | |
4330 NOTE: This option is reset when 'compatible' is set. | |
4331 | |
4332 *'isfname'* *'isf'* | |
4333 'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2: | |
4334 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,=" | |
4335 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:" | |
4336 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~" | |
4337 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,=" | |
4338 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=") | |
4339 global | |
4340 {not in Vi} | |
4341 The characters specified by this option are included in file names and | |
4342 path names. Filenames are used for commands like "gf", "[i" and in | |
10 | 4343 the tags file. It is also used for "\f" in a |pattern|. |
7 | 4344 Multi-byte characters 256 and above are always included, only the |
4345 characters up to 255 are specified with this option. | |
4346 For UTF-8 the characters 0xa0 to 0xff are included as well. | |
1621 | 4347 Think twice before adding white space to this option. Although a |
4348 space may appear inside a file name, the effect will be that Vim | |
4349 doesn't know where a file name starts or ends when doing completion. | |
4350 It most likely works better without a space in 'isfname'. | |
7 | 4351 |
4352 Note that on systems using a backslash as path separator, Vim tries to | |
4353 do its best to make it work as you would expect. That is a bit | |
4354 tricky, since Vi originally used the backslash to escape special | |
4355 characters. Vim will not remove a backslash in front of a normal file | |
4356 name character on these systems, but it will on Unix and alikes. The | |
4357 '&' and '^' are not included by default, because these are special for | |
4358 cmd.exe. | |
4359 | |
4360 The format of this option is a list of parts, separated with commas. | |
10 | 4361 Each part can be a single character number or a range. A range is two |
4362 character numbers with '-' in between. A character number can be a | |
7 | 4363 decimal number between 0 and 255 or the ASCII character itself (does |
4364 not work for digits). Example: | |
4365 "_,-,128-140,#-43" (include '_' and '-' and the range | |
4366 128 to 140 and '#' to 43) | |
4367 If a part starts with '^', the following character number or range | |
4368 will be excluded from the option. The option is interpreted from left | |
4369 to right. Put the excluded character after the range where it is | |
4370 included. To include '^' itself use it as the last character of the | |
4371 option or the end of a range. Example: | |
4372 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^') | |
4373 If the character is '@', all characters where isalpha() returns TRUE | |
4374 are included. Normally these are the characters a to z and A to Z, | |
4375 plus accented characters. To include '@' itself use "@-@". Examples: | |
4376 "@,^a-z" All alphabetic characters, excluding lower | |
1621 | 4377 case ASCII letters. |
7 | 4378 "a-z,A-Z,@-@" All letters plus the '@' character. |
4379 A comma can be included by using it where a character number is | |
4380 expected. Example: | |
4381 "48-57,,,_" Digits, comma and underscore. | |
4382 A comma can be excluded by prepending a '^'. Example: | |
4383 " -~,^,,9" All characters from space to '~', excluding | |
4384 comma, plus <Tab>. | |
4385 See |option-backslash| about including spaces and backslashes. | |
4386 | |
4387 *'isident'* *'isi'* | |
4388 'isident' 'isi' string (default for MS-DOS, Win32 and OS/2: | |
4389 "@,48-57,_,128-167,224-235" | |
4390 otherwise: "@,48-57,_,192-255") | |
4391 global | |
4392 {not in Vi} | |
4393 The characters given by this option are included in identifiers. | |
4394 Identifiers are used in recognizing environment variables and after a | |
4395 match of the 'define' option. It is also used for "\i" in a | |
233 | 4396 |pattern|. See 'isfname' for a description of the format of this |
7 | 4397 option. |
4398 Careful: If you change this option, it might break expanding | |
10 | 4399 environment variables. E.g., when '/' is included and Vim tries to |
7 | 4400 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead. |
4401 | |
4402 *'iskeyword'* *'isk'* | |
4403 'iskeyword' 'isk' string (Vim default for MS-DOS and Win32: | |
4404 "@,48-57,_,128-167,224-235" | |
4405 otherwise: "@,48-57,_,192-255" | |
4406 Vi default: "@,48-57,_") | |
4407 local to buffer | |
4408 {not in Vi} | |
4409 Keywords are used in searching and recognizing with many commands: | |
10 | 4410 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See |
7 | 4411 'isfname' for a description of the format of this option. For C |
4412 programs you could use "a-z,A-Z,48-57,_,.,-,>". | |
4413 For a help file it is set to all non-blank printable characters except | |
4414 '*', '"' and '|' (so that CTRL-] on a command finds the help for that | |
4415 command). | |
4416 When the 'lisp' option is on the '-' character is always included. | |
4417 NOTE: This option is set to the Vi default value when 'compatible' is | |
4418 set and to the Vim default value when 'compatible' is reset. | |
4419 | |
4420 *'isprint'* *'isp'* | |
4421 'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh: | |
4422 "@,~-255"; otherwise: "@,161-255") | |
4423 global | |
4424 {not in Vi} | |
4425 The characters given by this option are displayed directly on the | |
4426 screen. It is also used for "\p" in a |pattern|. The characters from | |
4427 space (ASCII 32) to '~' (ASCII 126) are always displayed directly, | |
4428 even when they are not included in 'isprint' or excluded. See | |
4429 'isfname' for a description of the format of this option. | |
4430 | |
4431 Non-printable characters are displayed with two characters: | |
4432 0 - 31 "^@" - "^_" | |
4433 32 - 126 always single characters | |
4434 127 "^?" | |
4435 128 - 159 "~@" - "~_" | |
4436 160 - 254 "| " - "|~" | |
4437 255 "~?" | |
4438 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are | |
4439 displayed as <xx>, with the hexadecimal value of the byte. | |
4440 When 'display' contains "uhex" all unprintable characters are | |
4441 displayed as <xx>. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4442 The SpecialKey highlighting will be used for unprintable characters. |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4443 |hl-SpecialKey| |
7 | 4444 |
4445 Multi-byte characters 256 and above are always included, only the | |
4446 characters up to 255 are specified with this option. When a character | |
4447 is printable but it is not available in the current font, a | |
4448 replacement character will be shown. | |
4449 Unprintable and zero-width Unicode characters are displayed as <xxxx>. | |
4450 There is no option to specify these characters. | |
4451 | |
4452 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'* | |
4453 'joinspaces' 'js' boolean (default on) | |
4454 global | |
4455 {not in Vi} | |
4456 Insert two spaces after a '.', '?' and '!' with a join command. | |
4457 When 'cpoptions' includes the 'j' flag, only do this after a '.'. | |
4458 Otherwise only one space is inserted. | |
4459 NOTE: This option is set when 'compatible' is set. | |
4460 | |
4461 *'key'* | |
4462 'key' string (default "") | |
4463 local to buffer | |
4464 {not in Vi} | |
2283
7e1bd501306d
Mainly documentation updates.
Bram Moolenaar <bram@vim.org>
parents:
2265
diff
changeset
|
4465 {only available when compiled with the |+cryptv| |
7e1bd501306d
Mainly documentation updates.
Bram Moolenaar <bram@vim.org>
parents:
2265
diff
changeset
|
4466 feature} |
7 | 4467 The key that is used for encrypting and decrypting the current buffer. |
2180
f60a0c9cbe6c
Add the blowfish encryption patch from Mohsin Ahmed. Needs more work.
Bram Moolenaar <bram@vim.org>
parents:
2178
diff
changeset
|
4468 See |encryption| and 'cryptmethod'. |
7 | 4469 Careful: Do not set the key value by hand, someone might see the typed |
4470 key. Use the |:X| command. But you can make 'key' empty: > | |
4471 :set key= | |
4472 < It is not possible to get the value of this option with ":set key" or | |
4473 "echo &key". This is to avoid showing it to someone who shouldn't | |
4474 know. It also means you cannot see it yourself once you have set it, | |
4475 be careful not to make a typing error! | |
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
4476 You can use "&key" in an expression to detect whether encryption is |
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
4477 enabled. When 'key' is set it returns "*****" (five stars). |
7 | 4478 |
4479 *'keymap'* *'kmp'* *E544* | |
4480 'keymap' 'kmp' string (default "") | |
4481 local to buffer | |
4482 {not in Vi} | |
4483 {only available when compiled with the |+keymap| | |
4484 feature} | |
4485 Name of a keyboard mapping. See |mbyte-keymap|. | |
4486 Setting this option to a valid keymap name has the side effect of | |
4487 setting 'iminsert' to one, so that the keymap becomes effective. | |
4488 'imsearch' is also set to one, unless it was -1 | |
36 | 4489 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
7 | 4490 |
4491 *'keymodel'* *'km'* | |
4492 'keymodel' 'km' string (default "") | |
4493 global | |
4494 {not in Vi} | |
4495 List of comma separated words, which enable special things that keys | |
4496 can do. These values can be used: | |
4497 startsel Using a shifted special key starts selection (either | |
4498 Select mode or Visual mode, depending on "key" being | |
4499 present in 'selectmode'). | |
4500 stopsel Using a not-shifted special key stops selection. | |
4501 Special keys in this context are the cursor keys, <End>, <Home>, | |
4502 <PageUp> and <PageDown>. | |
4503 The 'keymodel' option is set by the |:behave| command. | |
4504 | |
4505 *'keywordprg'* *'kp'* | |
4506 'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help", | |
4507 OS/2: "view /", VMS: "help") | |
4508 global or local to buffer |global-local| | |
4509 {not in Vi} | |
4510 Program to use for the |K| command. Environment variables are | |
4511 expanded |:set_env|. ":help" may be used to access the Vim internal | |
4512 help. (Note that previously setting the global option to the empty | |
4513 value did this, which is now deprecated.) | |
4514 When "man" is used, Vim will automatically translate a count for the | |
4515 "K" command to a section number. Also for "man -s", in which case the | |
4516 "-s" is removed when there is no count. | |
4517 See |option-backslash| about including spaces and backslashes. | |
4518 Example: > | |
4519 :set keywordprg=man\ -s | |
4520 < This option cannot be set from a |modeline| or in the |sandbox|, for | |
4521 security reasons. | |
4522 | |
4523 *'langmap'* *'lmap'* *E357* *E358* | |
4524 'langmap' 'lmap' string (default "") | |
4525 global | |
4526 {not in Vi} | |
4527 {only available when compiled with the |+langmap| | |
4528 feature} | |
4529 This option allows switching your keyboard into a special language | |
10 | 4530 mode. When you are typing text in Insert mode the characters are |
7 | 4531 inserted directly. When in command mode the 'langmap' option takes |
4532 care of translating these special characters to the original meaning | |
4533 of the key. This means you don't have to change the keyboard mode to | |
4534 be able to execute Normal mode commands. | |
4535 This is the opposite of the 'keymap' option, where characters are | |
4536 mapped in Insert mode. | |
6369 | 4537 Also consider setting 'langnoremap' to avoid 'langmap' applies to |
4538 characters resulting from a mapping. | |
5908 | 4539 This option cannot be set from a |modeline| or in the |sandbox|, for |
4540 security reasons. | |
7 | 4541 |
699 | 4542 Example (for Greek, in UTF-8): *greek* > |
4543 :set langmap=ΑA,ΒB,ΨC,ΔD,ΕE,ΦF,ΓG,ΗH,ΙI,ΞJ,ΚK,ΛL,ΜM,ΝN,ΟO,ΠP,QQ,ΡR,ΣS,ΤT,ΘU,ΩV,WW,ΧX,ΥY,ΖZ,αa,βb,ψc,δd,εe,φf,γg,ηh,ιi,ξj,κk,λl,μm,νn,οo,πp,qq,ρr,σs,τt,θu,ωv,ςw,χx,υy,ζz | |
7 | 4544 < Example (exchanges meaning of z and y for commands): > |
4545 :set langmap=zy,yz,ZY,YZ | |
4546 < | |
4547 The 'langmap' option is a list of parts, separated with commas. Each | |
4548 part can be in one of two forms: | |
4549 1. A list of pairs. Each pair is a "from" character immediately | |
4550 followed by the "to" character. Examples: "aA", "aAbBcC". | |
4551 2. A list of "from" characters, a semi-colon and a list of "to" | |
4552 characters. Example: "abc;ABC" | |
4553 Example: "aA,fgh;FGH,cCdDeE" | |
4554 Special characters need to be preceded with a backslash. These are | |
4555 ";", ',' and backslash itself. | |
4556 | |
4557 This will allow you to activate vim actions without having to switch | |
4558 back and forth between the languages. Your language characters will | |
4559 be understood as normal vim English characters (according to the | |
4560 langmap mappings) in the following cases: | |
4561 o Normal/Visual mode (commands, buffer/register names, user mappings) | |
4562 o Insert/Replace Mode: Register names after CTRL-R | |
4563 o Insert/Replace Mode: Mappings | |
4564 Characters entered in Command-line mode will NOT be affected by | |
4565 this option. Note that this option can be changed at any time | |
4566 allowing to switch between mappings for different languages/encodings. | |
4567 Use a mapping to avoid having to type it each time! | |
4568 | |
4569 *'langmenu'* *'lm'* | |
4570 'langmenu' 'lm' string (default "") | |
4571 global | |
4572 {not in Vi} | |
4573 {only available when compiled with the |+menu| and | |
4574 |+multi_lang| features} | |
4575 Language to use for menu translation. Tells which file is loaded | |
4576 from the "lang" directory in 'runtimepath': > | |
4577 "lang/menu_" . &langmenu . ".vim" | |
4578 < (without the spaces). For example, to always use the Dutch menus, no | |
4579 matter what $LANG is set to: > | |
4580 :set langmenu=nl_NL.ISO_8859-1 | |
4581 < When 'langmenu' is empty, |v:lang| is used. | |
36 | 4582 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
7 | 4583 If your $LANG is set to a non-English language but you do want to use |
4584 the English menus: > | |
4585 :set langmenu=none | |
4586 < This option must be set before loading menus, switching on filetype | |
4587 detection or syntax highlighting. Once the menus are defined setting | |
4588 this option has no effect. But you could do this: > | |
4589 :source $VIMRUNTIME/delmenu.vim | |
4590 :set langmenu=de_DE.ISO_8859-1 | |
4591 :source $VIMRUNTIME/menu.vim | |
4592 < Warning: This deletes all menus that you defined yourself! | |
4593 | |
6339 | 4594 *'langnoremap'* *'lnr'* |
4595 'langnoremap' 'lnr' boolean (default off) | |
4596 global | |
4597 {not in Vi} | |
4598 {only available when compiled with the |+langmap| | |
4599 feature} | |
4600 When on, setting 'langmap' does not apply to characters resulting from | |
4601 a mapping. This basically means, if you noticed that setting | |
4602 'langmap' disables some of your mappings, try setting this option. | |
4603 This option defaults to off for backwards compatibility. Set it on if | |
4604 that works for you to avoid mappings to break. | |
4605 | |
7 | 4606 *'laststatus'* *'ls'* |
4607 'laststatus' 'ls' number (default 1) | |
4608 global | |
4609 {not in Vi} | |
4610 The value of this option influences when the last window will have a | |
4611 status line: | |
4612 0: never | |
4613 1: only if there are at least two windows | |
4614 2: always | |
4615 The screen looks nicer with a status line if you have several | |
4616 windows, but it takes another screen line. |status-line| | |
4617 | |
4618 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'* | |
4619 'lazyredraw' 'lz' boolean (default off) | |
4620 global | |
4621 {not in Vi} | |
4622 When this option is set, the screen will not be redrawn while | |
4623 executing macros, registers and other commands that have not been | |
10 | 4624 typed. Also, updating the window title is postponed. To force an |
7 | 4625 update use |:redraw|. |
4626 | |
4627 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'* | |
4628 'linebreak' 'lbr' boolean (default off) | |
4629 local to window | |
4630 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
4631 {not available when compiled without the |+linebreak| |
7 | 4632 feature} |
6009 | 4633 If on, Vim will wrap long lines at a character in 'breakat' rather |
7 | 4634 than at the last character that fits on the screen. Unlike |
4635 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file, | |
6009 | 4636 it only affects the way the file is displayed, not its contents. |
4637 If 'breakindent' is set, line is visually indented. Then, the value | |
4638 of 'showbreak' is used to put in front of wrapped lines. This option | |
6026 | 4639 is not used when the 'wrap' option is off. |
7 | 4640 Note that <Tab> characters after an <EOL> are mostly not displayed |
4641 with the right amount of white space. | |
4642 | |
4643 *'lines'* *E593* | |
4644 'lines' number (default 24 or terminal height) | |
4645 global | |
4646 Number of lines of the Vim window. | |
4647 Normally you don't need to set this. It is done automatically by the | |
161 | 4648 terminal initialization code. Also see |posix-screen-size|. |
7 | 4649 When Vim is running in the GUI or in a resizable window, setting this |
4650 option will cause the window size to be changed. When you only want | |
4651 to use the size for the GUI, put the command in your |gvimrc| file. | |
4652 Vim limits the number of lines to what fits on the screen. You can | |
4653 use this command to get the tallest window possible: > | |
4654 :set lines=999 | |
571 | 4655 < Minimum value is 2, maximum value is 1000. |
4656 If you get less lines than expected, check the 'guiheadroom' option. | |
7 | 4657 When you set this option and Vim is unable to change the physical |
4658 number of lines of the display, the display may be messed up. | |
4659 | |
4660 *'linespace'* *'lsp'* | |
4661 'linespace' 'lsp' number (default 0, 1 for Win32 GUI) | |
4662 global | |
4663 {not in Vi} | |
4664 {only in the GUI} | |
4665 Number of pixel lines inserted between characters. Useful if the font | |
4666 uses the full character cell height, making lines touch each other. | |
4667 When non-zero there is room for underlining. | |
180 | 4668 With some fonts there can be too much room between lines (to have |
4669 space for ascents and descents). Then it makes sense to set | |
4670 'linespace' to a negative value. This may cause display problems | |
4671 though! | |
7 | 4672 |
4673 *'lisp'* *'nolisp'* | |
4674 'lisp' boolean (default off) | |
4675 local to buffer | |
4676 {not available when compiled without the |+lispindent| | |
4677 feature} | |
4678 Lisp mode: When <Enter> is typed in insert mode set the indent for | |
4679 the next line to Lisp standards (well, sort of). Also happens with | |
4680 "cc" or "S". 'autoindent' must also be on for this to work. The 'p' | |
4681 flag in 'cpoptions' changes the method of indenting: Vi compatible or | |
4682 better. Also see 'lispwords'. | |
4683 The '-' character is included in keyword characters. Redefines the | |
4684 "=" operator to use this same indentation algorithm rather than | |
4685 calling an external program if 'equalprg' is empty. | |
4686 This option is not used when 'paste' is set. | |
4687 {Vi: Does it a little bit differently} | |
4688 | |
4689 *'lispwords'* *'lw'* | |
4690 'lispwords' 'lw' string (default is very long) | |
5712 | 4691 global or local to buffer |global-local| |
7 | 4692 {not in Vi} |
4693 {not available when compiled without the |+lispindent| | |
4694 feature} | |
4695 Comma separated list of words that influence the Lisp indenting. | |
4696 |'lisp'| | |
4697 | |
4698 *'list'* *'nolist'* | |
4699 'list' boolean (default off) | |
4700 local to window | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4701 List mode: Show tabs as CTRL-I is displayed, display $ after end of |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4702 line. Useful to see the difference between tabs and spaces and for |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4703 trailing blanks. Further changed by the 'listchars' option. |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4704 |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4705 The cursor is displayed at the start of the space a Tab character |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4706 occupies, not at the end as usual in Normal mode. To get this cursor |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4707 position while displaying Tabs with spaces, use: > |
5161
f7add3891e95
Updated runtime files. Fix NL translations.
Bram Moolenaar <bram@vim.org>
parents:
5146
diff
changeset
|
4708 :set list lcs=tab:\ \ |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4709 < |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4710 Note that list mode will also affect formatting (set with 'textwidth' |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4711 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for |
7 | 4712 changing the way tabs are displayed. |
4713 | |
4714 *'listchars'* *'lcs'* | |
4715 'listchars' 'lcs' string (default "eol:$") | |
4716 global | |
4717 {not in Vi} | |
2458 | 4718 Strings to use in 'list' mode and for the |:list| command. It is a |
4719 comma separated list of string settings. | |
6777 | 4720 *lcs-eol* |
7 | 4721 eol:c Character to show at the end of each line. When |
4722 omitted, there is no extra character at the end of the | |
4723 line. | |
6777 | 4724 *lcs-tab* |
1263 | 4725 tab:xy Two characters to be used to show a tab. The first |
7 | 4726 char is used once. The second char is repeated to |
1263 | 4727 fill the space that the tab normally occupies. |
4728 "tab:>-" will show a tab that takes four spaces as | |
4729 ">---". When omitted, a tab is show as ^I. | |
6777 | 4730 *lcs-space* |
4731 space:c Character to show for a space. When omitted, spaces | |
4732 are left blank. | |
4733 *lcs-trail* | |
10 | 4734 trail:c Character to show for trailing spaces. When omitted, |
6777 | 4735 trailing spaces are blank. Overrides the "space" |
4736 setting for trailing spaces. | |
4737 *lcs-extends* | |
7 | 4738 extends:c Character to show in the last column, when 'wrap' is |
4739 off and the line continues beyond the right of the | |
4740 screen. | |
6777 | 4741 *lcs-precedes* |
7 | 4742 precedes:c Character to show in the first column, when 'wrap' |
4743 is off and there is text preceding the character | |
4744 visible in the first column. | |
6777 | 4745 *lcs-conceal* |
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
4746 conceal:c Character to show in place of concealed text, when |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
4747 'conceallevel' is set to 1. |
6777 | 4748 *lcs-nbsp* |
6801 | 4749 nbsp:c Character to show for a non-breakable space character |
4750 (0xA0 (160 decimal) and U+202F). Left blank when | |
4751 omitted. | |
7 | 4752 |
10 | 4753 The characters ':' and ',' should not be used. UTF-8 characters can |
7 | 4754 be used when 'encoding' is "utf-8", otherwise only printable |
819 | 4755 characters are allowed. All characters must be single width. |
7 | 4756 |
4757 Examples: > | |
4758 :set lcs=tab:>-,trail:- | |
12 | 4759 :set lcs=tab:>-,eol:<,nbsp:% |
7 | 4760 :set lcs=extends:>,precedes:< |
4761 < The "NonText" highlighting will be used for "eol", "extends" and | |
6777 | 4762 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail". |
1152 | 4763 |hl-NonText| |hl-SpecialKey| |
7 | 4764 |
4765 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'* | |
4766 'loadplugins' 'lpl' boolean (default on) | |
4767 global | |
4768 {not in Vi} | |
4769 When on the plugin scripts are loaded when starting up |load-plugins|. | |
4770 This option can be reset in your |vimrc| file to disable the loading | |
4771 of plugins. | |
4772 Note that using the "-u NONE" and "--noplugin" command line arguments | |
4773 reset this option. |-u| |--noplugin| | |
4774 | |
842 | 4775 *'macatsui'* *'nomacatsui'* |
4776 'macatsui' boolean (default on) | |
4777 global | |
4778 {only available in Mac GUI version} | |
4779 This is a workaround for when drawing doesn't work properly. When set | |
4780 and compiled with multi-byte support ATSUI text drawing is used. When | |
4781 not set ATSUI text drawing is not used. Switch this option off when | |
4782 you experience drawing problems. In a future version the problems may | |
4783 be solved and this option becomes obsolete. Therefore use this method | |
4784 to unset it: > | |
4785 if exists('&macatsui') | |
4786 set nomacatsui | |
4787 endif | |
1152 | 4788 < Another option to check if you have drawing problems is |
4789 'termencoding'. | |
4790 | |
7 | 4791 *'magic'* *'nomagic'* |
4792 'magic' boolean (default on) | |
4793 global | |
4794 Changes the special characters that can be used in search patterns. | |
4795 See |pattern|. | |
4796 NOTE: To avoid portability problems with using patterns, always keep | |
4797 this option at the default "on". Only switch it off when working with | |
4798 old Vi scripts. In any other situation write patterns that work when | |
20 | 4799 'magic' is on. Include "\M" when you want to |/\M|. |
7 | 4800 |
4801 *'makeef'* *'mef'* | |
4802 'makeef' 'mef' string (default: "") | |
4803 global | |
4804 {not in Vi} | |
4805 {not available when compiled without the |+quickfix| | |
4806 feature} | |
4807 Name of the errorfile for the |:make| command (see |:make_makeprg|) | |
4808 and the |:grep| command. | |
4809 When it is empty, an internally generated temp file will be used. | |
4810 When "##" is included, it is replaced by a number to make the name | |
4811 unique. This makes sure that the ":make" command doesn't overwrite an | |
4812 existing file. | |
4813 NOT used for the ":cf" command. See 'errorfile' for that. | |
4814 Environment variables are expanded |:set_env|. | |
4815 See |option-backslash| about including spaces and backslashes. | |
4816 This option cannot be set from a |modeline| or in the |sandbox|, for | |
4817 security reasons. | |
4818 | |
4819 *'makeprg'* *'mp'* | |
4820 'makeprg' 'mp' string (default "make", VMS: "MMS") | |
4821 global or local to buffer |global-local| | |
4822 {not in Vi} | |
1152 | 4823 Program to use for the ":make" command. See |:make_makeprg|. |
5690 | 4824 This option may contain '%' and '#' characters (see |:_%| and |:_#|), |
4825 which are expanded to the current and alternate file name. Use |::S| | |
4826 to escape file names in case they contain special characters. | |
1152 | 4827 Environment variables are expanded |:set_env|. See |option-backslash| |
4828 about including spaces and backslashes. | |
4829 Note that a '|' must be escaped twice: once for ":set" and once for | |
4830 the interpretation of a command. When you use a filter called | |
4831 "myfilter" do it like this: > | |
7 | 4832 :set makeprg=gmake\ \\\|\ myfilter |
4833 < The placeholder "$*" can be given (even multiple times) to specify | |
4834 where the arguments will be included, for example: > | |
4835 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*} | |
4836 < This option cannot be set from a |modeline| or in the |sandbox|, for | |
4837 security reasons. | |
4838 | |
4839 *'matchpairs'* *'mps'* | |
4840 'matchpairs' 'mps' string (default "(:),{:},[:]") | |
4841 local to buffer | |
4842 {not in Vi} | |
4843 Characters that form pairs. The |%| command jumps from one to the | |
4073 | 4844 other. |
4845 Only character pairs are allowed that are different, thus you cannot | |
4846 jump between two double quotes. | |
4847 The characters must be separated by a colon. | |
1152 | 4848 The pairs must be separated by a comma. Example for including '<' and |
4849 '>' (HTML): > | |
7 | 4850 :set mps+=<:> |
4851 | |
4852 < A more exotic example, to jump between the '=' and ';' in an | |
4853 assignment, useful for languages like C and Java: > | |
4854 :au FileType c,cpp,java set mps+==:; | |
4855 | |
4856 < For a more advanced way of using "%", see the matchit.vim plugin in | |
4857 the $VIMRUNTIME/macros directory. |add-local-help| | |
4858 | |
4859 *'matchtime'* *'mat'* | |
4860 'matchtime' 'mat' number (default 5) | |
4861 global | |
4862 {not in Vi}{in Nvi} | |
4863 Tenths of a second to show the matching paren, when 'showmatch' is | |
4864 set. Note that this is not in milliseconds, like other options that | |
4865 set a time. This is to be compatible with Nvi. | |
4866 | |
714 | 4867 *'maxcombine'* *'mco'* |
4868 'maxcombine' 'mco' number (default 2) | |
4869 global | |
4870 {not in Vi} | |
4871 {only available when compiled with the |+multi_byte| | |
4872 feature} | |
4873 The maximum number of combining characters supported for displaying. | |
4874 Only used when 'encoding' is "utf-8". | |
4875 The default is OK for most languages. Hebrew may require 4. | |
4876 Maximum value is 6. | |
4877 Even when this option is set to 2 you can still edit text with more | |
4878 combining characters, you just can't see them. Use |g8| or |ga|. | |
4879 See |mbyte-combining|. | |
4880 | |
7 | 4881 *'maxfuncdepth'* *'mfd'* |
4882 'maxfuncdepth' 'mfd' number (default 100) | |
4883 global | |
4884 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
4885 {not available when compiled without the |+eval| |
1152 | 4886 feature} |
7 | 4887 Maximum depth of function calls for user functions. This normally |
4888 catches endless recursion. When using a recursive function with | |
4889 more depth, set 'maxfuncdepth' to a bigger number. But this will use | |
4890 more memory, there is the danger of failing when memory is exhausted. | |
4891 See also |:function|. | |
4892 | |
4893 *'maxmapdepth'* *'mmd'* *E223* | |
4894 'maxmapdepth' 'mmd' number (default 1000) | |
4895 global | |
4896 {not in Vi} | |
4897 Maximum number of times a mapping is done without resulting in a | |
4898 character to be used. This normally catches endless mappings, like | |
4899 ":map x y" with ":map y x". It still does not catch ":map g wg", | |
4900 because the 'w' is used before the next mapping is done. See also | |
4901 |key-mapping|. | |
4902 | |
4903 *'maxmem'* *'mm'* | |
4904 'maxmem' 'mm' number (default between 256 to 5120 (system | |
4905 dependent) or half the amount of memory | |
4906 available) | |
4907 global | |
4908 {not in Vi} | |
4909 Maximum amount of memory (in Kbyte) to use for one buffer. When this | |
4910 limit is reached allocating extra memory for a buffer will cause | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4911 other memory to be freed. The maximum usable value is about 2000000. |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4912 Use this to work without a limit. Also see 'maxmemtot'. |
7 | 4913 |
189 | 4914 *'maxmempattern'* *'mmp'* |
4915 'maxmempattern' 'mmp' number (default 1000) | |
4916 global | |
4917 {not in Vi} | |
4918 Maximum amount of memory (in Kbyte) to use for pattern matching. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4919 The maximum value is about 2000000. Use this to work without a limit. |
189 | 4920 *E363* |
1152 | 4921 When Vim runs into the limit it gives an error message and mostly |
4922 behaves like CTRL-C was typed. | |
189 | 4923 Running into the limit often means that the pattern is very |
4924 inefficient or too complex. This may already happen with the pattern | |
4925 "\(.\)*" on a very long line. ".*" works much better. | |
4926 Vim may run out of memory before hitting the 'maxmempattern' limit. | |
4927 | |
7 | 4928 *'maxmemtot'* *'mmt'* |
4929 'maxmemtot' 'mmt' number (default between 2048 and 10240 (system | |
4930 dependent) or half the amount of memory | |
4931 available) | |
4932 global | |
4933 {not in Vi} | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4934 Maximum amount of memory in Kbyte to use for all buffers together. |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4935 The maximum usable value is about 2000000 (2 Gbyte). Use this to work |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4936 without a limit. On 64 bit machines higher values might work. But |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4937 hey, do you really need more than 2 Gbyte for text editing? |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4938 Also see 'maxmem'. |
7 | 4939 |
4940 *'menuitems'* *'mis'* | |
4941 'menuitems' 'mis' number (default 25) | |
4942 global | |
4943 {not in Vi} | |
4944 {not available when compiled without the |+menu| | |
4945 feature} | |
4946 Maximum number of items to use in a menu. Used for menus that are | |
4947 generated from a list of items, e.g., the Buffers menu. Changing this | |
4948 option has no direct effect, the menu must be refreshed first. | |
4949 | |
484 | 4950 *'mkspellmem'* *'msm'* |
4951 'mkspellmem' 'msm' string (default "460000,2000,500") | |
4952 global | |
4953 {not in Vi} | |
4954 {not available when compiled without the |+syntax| | |
4955 feature} | |
4956 Parameters for |:mkspell|. This tunes when to start compressing the | |
4957 word tree. Compression can be slow when there are many words, but | |
4958 it's needed to avoid running out of memory. The amount of memory used | |
4959 per word depends very much on how similar the words are, that's why | |
4960 this tuning is complicated. | |
4961 | |
4962 There are three numbers, separated by commas: | |
4963 {start},{inc},{added} | |
4964 | |
4965 For most languages the uncompressed word tree fits in memory. {start} | |
4966 gives the amount of memory in Kbyte that can be used before any | |
4967 compression is done. It should be a bit smaller than the amount of | |
4968 memory that is available to Vim. | |
4969 | |
4970 When going over the {start} limit the {inc} number specifies the | |
4971 amount of memory in Kbyte that can be allocated before another | |
4972 compression is done. A low number means compression is done after | |
4973 less words are added, which is slow. A high number means more memory | |
4974 will be allocated. | |
4975 | |
4976 After doing compression, {added} times 1024 words can be added before | |
4977 the {inc} limit is ignored and compression is done when any extra | |
4978 amount of memory is needed. A low number means there is a smaller | |
4979 chance of hitting the {inc} limit, less memory is used but it's | |
4980 slower. | |
4981 | |
4982 The languages for which these numbers are important are Italian and | |
4983 Hungarian. The default works for when you have about 512 Mbyte. If | |
4984 you have 1 Gbyte you could use: > | |
4985 :set mkspellmem=900000,3000,800 | |
4986 < If you have less than 512 Mbyte |:mkspell| may fail for some | |
4987 languages, no matter what you set 'mkspellmem' to. | |
4988 | |
7 | 4989 *'modeline'* *'ml'* *'nomodeline'* *'noml'* |
1111 | 4990 'modeline' 'ml' boolean (Vim default: on (off for root), |
4991 Vi default: off) | |
7 | 4992 local to buffer |
4993 *'modelines'* *'mls'* | |
4994 'modelines' 'mls' number (default 5) | |
4995 global | |
4996 {not in Vi} | |
4997 If 'modeline' is on 'modelines' gives the number of lines that is | |
4998 checked for set commands. If 'modeline' is off or 'modelines' is zero | |
4999 no lines are checked. See |modeline|. | |
5000 NOTE: 'modeline' is set to the Vi default value when 'compatible' is | |
5001 set and to the Vim default value when 'compatible' is reset. | |
5002 | |
5003 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'* | |
5004 'modifiable' 'ma' boolean (default on) | |
5005 local to buffer | |
5006 {not in Vi} *E21* | |
5007 When off the buffer contents cannot be changed. The 'fileformat' and | |
5008 'fileencoding' options also can't be changed. | |
5009 Can be reset with the |-M| command line argument. | |
5010 | |
5011 *'modified'* *'mod'* *'nomodified'* *'nomod'* | |
5012 'modified' 'mod' boolean (default off) | |
5013 local to buffer | |
5014 {not in Vi} | |
5015 When on, the buffer is considered to be modified. This option is set | |
5016 when: | |
5017 1. A change was made to the text since it was last written. Using the | |
5018 |undo| command to go back to the original text will reset the | |
5019 option. But undoing changes that were made before writing the | |
5020 buffer will set the option again, since the text is different from | |
5021 when it was written. | |
5022 2. 'fileformat' or 'fileencoding' is different from its original | |
5023 value. The original value is set when the buffer is read or | |
5024 written. A ":set nomodified" command also resets the original | |
5025 values to the current values and the 'modified' option will be | |
5026 reset. | |
3082 | 5027 This option is not set when a change is made to the buffer as the |
5028 result of a BufNewFile, BufRead/BufReadPost, BufWritePost, | |
5029 FileAppendPost or VimLeave autocommand event. See |gzip-example| for | |
5030 an explanation. | |
7 | 5031 When 'buftype' is "nowrite" or "nofile" this option may be set, but |
5032 will be ignored. | |
5033 | |
5034 *'more'* *'nomore'* | |
5035 'more' boolean (Vim default: on, Vi default: off) | |
5036 global | |
5037 {not in Vi} | |
5038 When on, listings pause when the whole screen is filled. You will get | |
5039 the |more-prompt|. When this option is off there are no pauses, the | |
5040 listing continues until finished. | |
5041 NOTE: This option is set to the Vi default value when 'compatible' is | |
5042 set and to the Vim default value when 'compatible' is reset. | |
5043 | |
5044 *'mouse'* *E538* | |
5045 'mouse' string (default "", "a" for GUI, MS-DOS and Win32) | |
5046 global | |
5047 {not in Vi} | |
5048 Enable the use of the mouse. Only works for certain terminals | |
1621 | 5049 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with |
5050 sysmouse and Linux console with gpm). For using the mouse in the | |
5051 GUI, see |gui-mouse|. | |
7 | 5052 The mouse can be enabled for different modes: |
5053 n Normal mode | |
5054 v Visual mode | |
5055 i Insert mode | |
5056 c Command-line mode | |
5057 h all previous modes when editing a help file | |
5058 a all previous modes | |
5059 r for |hit-enter| and |more-prompt| prompt | |
5060 Normally you would enable the mouse in all four modes with: > | |
5061 :set mouse=a | |
5062 < When the mouse is not enabled, the GUI will still use the mouse for | |
5063 modeless selection. This doesn't move the text cursor. | |
5064 | |
5065 See |mouse-using|. Also see |'clipboard'|. | |
5066 | |
5067 Note: When enabling the mouse in a terminal, copy/paste will use the | |
10 | 5068 "* register if there is access to an X-server. The xterm handling of |
7 | 5069 the mouse buttons can still be used by keeping the shift key pressed. |
5070 Also see the 'clipboard' option. | |
5071 | |
5072 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'* | |
5073 'mousefocus' 'mousef' boolean (default off) | |
5074 global | |
5075 {not in Vi} | |
5076 {only works in the GUI} | |
5077 The window that the mouse pointer is on is automatically activated. | |
5078 When changing the window layout or window focus in another way, the | |
5079 mouse pointer is moved to the window with keyboard focus. Off is the | |
5080 default because it makes using the pull down menus a little goofy, as | |
5081 a pointer transit may activate a window unintentionally. | |
5082 | |
5083 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'* | |
5084 'mousehide' 'mh' boolean (default on) | |
5085 global | |
5086 {not in Vi} | |
5087 {only works in the GUI} | |
5088 When on, the mouse pointer is hidden when characters are typed. | |
5089 The mouse pointer is restored when the mouse is moved. | |
5090 | |
5091 *'mousemodel'* *'mousem'* | |
5092 'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32) | |
5093 global | |
5094 {not in Vi} | |
5095 Sets the model to use for the mouse. The name mostly specifies what | |
5096 the right mouse button is used for: | |
5097 extend Right mouse button extends a selection. This works | |
5098 like in an xterm. | |
5099 popup Right mouse button pops up a menu. The shifted left | |
5100 mouse button extends a selection. This works like | |
233 | 5101 with Microsoft Windows. |
7 | 5102 popup_setpos Like "popup", but the cursor will be moved to the |
5103 position where the mouse was clicked, and thus the | |
5104 selected operation will act upon the clicked object. | |
5105 If clicking inside a selection, that selection will | |
233 | 5106 be acted upon, i.e. no cursor move. This implies of |
7 | 5107 course, that right clicking outside a selection will |
5108 end Visual mode. | |
5109 Overview of what button does what for each model: | |
5110 mouse extend popup(_setpos) ~ | |
5111 left click place cursor place cursor | |
5112 left drag start selection start selection | |
5113 shift-left search word extend selection | |
5114 right click extend selection popup menu (place cursor) | |
5115 right drag extend selection - | |
5116 middle click paste paste | |
5117 | |
5118 In the "popup" model the right mouse button produces a pop-up menu. | |
5119 You need to define this first, see |popup-menu|. | |
5120 | |
5121 Note that you can further refine the meaning of buttons with mappings. | |
5122 See |gui-mouse-mapping|. But mappings are NOT used for modeless | |
5123 selection (because that's handled in the GUI code directly). | |
5124 | |
5125 The 'mousemodel' option is set by the |:behave| command. | |
5126 | |
5127 *'mouseshape'* *'mouses'* *E547* | |
5128 'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross, | |
233 | 5129 m:no,ml:up-arrow,v:rightup-arrow") |
7 | 5130 global |
5131 {not in Vi} | |
5132 {only available when compiled with the |+mouseshape| | |
5133 feature} | |
5134 This option tells Vim what the mouse pointer should look like in | |
5135 different modes. The option is a comma separated list of parts, much | |
5136 like used for 'guicursor'. Each part consist of a mode/location-list | |
5137 and an argument-list: | |
5138 mode-list:shape,mode-list:shape,.. | |
5139 The mode-list is a dash separated list of these modes/locations: | |
5140 In a normal window: ~ | |
5141 n Normal mode | |
5142 v Visual mode | |
5143 ve Visual mode with 'selection' "exclusive" (same as 'v', | |
5144 if not specified) | |
5145 o Operator-pending mode | |
5146 i Insert mode | |
5147 r Replace mode | |
5148 | |
5149 Others: ~ | |
5150 c appending to the command-line | |
5151 ci inserting in the command-line | |
5152 cr replacing in the command-line | |
5153 m at the 'Hit ENTER' or 'More' prompts | |
5154 ml idem, but cursor in the last line | |
5155 e any mode, pointer below last window | |
5156 s any mode, pointer on a status line | |
5157 sd any mode, while dragging a status line | |
5158 vs any mode, pointer on a vertical separator line | |
5159 vd any mode, while dragging a vertical separator line | |
5160 a everywhere | |
5161 | |
5162 The shape is one of the following: | |
5163 avail name looks like ~ | |
5164 w x arrow Normal mouse pointer | |
5165 w x blank no pointer at all (use with care!) | |
5166 w x beam I-beam | |
5167 w x updown up-down sizing arrows | |
5168 w x leftright left-right sizing arrows | |
5169 w x busy The system's usual busy pointer | |
5170 w x no The system's usual 'no input' pointer | |
5171 x udsizing indicates up-down resizing | |
5172 x lrsizing indicates left-right resizing | |
5173 x crosshair like a big thin + | |
5174 x hand1 black hand | |
5175 x hand2 white hand | |
5176 x pencil what you write with | |
5177 x question big ? | |
5178 x rightup-arrow arrow pointing right-up | |
5179 w x up-arrow arrow pointing up | |
5180 x <number> any X11 pointer number (see X11/cursorfont.h) | |
5181 | |
5182 The "avail" column contains a 'w' if the shape is available for Win32, | |
5183 x for X11. | |
5184 Any modes not specified or shapes not available use the normal mouse | |
5185 pointer. | |
5186 | |
5187 Example: > | |
5188 :set mouseshape=s:udsizing,m:no | |
5189 < will make the mouse turn to a sizing arrow over the status lines and | |
5190 indicate no input when the hit-enter prompt is displayed (since | |
5191 clicking the mouse has no effect in this state.) | |
5192 | |
5193 *'mousetime'* *'mouset'* | |
5194 'mousetime' 'mouset' number (default 500) | |
5195 global | |
5196 {not in Vi} | |
5197 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum | |
5198 time in msec between two mouse clicks for the second click to be | |
5199 recognized as a multi click. | |
5200 | |
14 | 5201 *'mzquantum'* *'mzq'* |
5202 'mzquantum' 'mzq' number (default 100) | |
5203 global | |
5204 {not in Vi} | |
5205 {not available when compiled without the |+mzscheme| | |
5206 feature} | |
5207 The number of milliseconds between polls for MzScheme threads. | |
5208 Negative or zero value means no thread scheduling. | |
5209 | |
7 | 5210 *'nrformats'* *'nf'* |
5211 'nrformats' 'nf' string (default "octal,hex") | |
5212 local to buffer | |
5213 {not in Vi} | |
5214 This defines what bases Vim will consider for numbers when using the | |
5215 CTRL-A and CTRL-X commands for adding to and subtracting from a number | |
5216 respectively; see |CTRL-A| for more info on these commands. | |
625 | 5217 alpha If included, single alphabetical characters will be |
7 | 5218 incremented or decremented. This is useful for a list with a |
3237 | 5219 letter index a), b), etc. *octal-nrformats* |
625 | 5220 octal If included, numbers that start with a zero will be considered |
7 | 5221 to be octal. Example: Using CTRL-A on "007" results in "010". |
625 | 5222 hex If included, numbers starting with "0x" or "0X" will be |
7 | 5223 considered to be hexadecimal. Example: Using CTRL-X on |
5224 "0x100" results in "0x0ff". | |
5225 Numbers which simply begin with a digit in the range 1-9 are always | |
5226 considered decimal. This also happens for numbers that are not | |
5227 recognized as octal or hex. | |
5228 | |
5229 *'number'* *'nu'* *'nonumber'* *'nonu'* | |
5230 'number' 'nu' boolean (default off) | |
5231 local to window | |
5232 Print the line number in front of each line. When the 'n' option is | |
5233 excluded from 'cpoptions' a wrapped line will not use the column of | |
5234 line numbers (this is the default when 'compatible' isn't set). | |
13 | 5235 The 'numberwidth' option can be used to set the room used for the line |
5236 number. | |
7 | 5237 When a long, wrapped line doesn't start with the first character, '-' |
5238 characters are put before the number. | |
3445 | 5239 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for |
5240 the number. | |
4780 | 5241 *number_relativenumber* |
5242 The 'relativenumber' option changes the displayed number to be | |
5243 relative to the cursor. Together with 'number' there are these | |
5244 four combinations (cursor in line 3): | |
5245 | |
5246 'nonu' 'nu' 'nonu' 'nu' | |
5247 'nornu' 'nornu' 'rnu' 'rnu' | |
5248 | |
5249 |apple | 1 apple | 2 apple | 2 apple | |
5250 |pear | 2 pear | 1 pear | 1 pear | |
5251 |nobody | 3 nobody | 0 nobody |3 nobody | |
5252 |there | 4 there | 1 there | 1 there | |
7 | 5253 |
13 | 5254 *'numberwidth'* *'nuw'* |
5255 'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8) | |
5256 local to window | |
14 | 5257 {not in Vi} |
5258 {only available when compiled with the |+linebreak| | |
5259 feature} | |
13 | 5260 Minimal number of columns to use for the line number. Only relevant |
2178
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5261 when the 'number' or 'relativenumber' option is set or printing lines |
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5262 with a line number. Since one space is always between the number and |
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5263 the text, there is one less character for the number itself. |
13 | 5264 The value is the minimum width. A bigger width is used when needed to |
2178
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5265 fit the highest line number in the buffer respectively the number of |
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5266 rows in the window, depending on whether 'number' or 'relativenumber' |
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5267 is set. Thus with the Vim default of 4 there is room for a line number |
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5268 up to 999. When the buffer has 1000 lines five columns will be used. |
13 | 5269 The minimum value is 1, the maximum value is 10. |
5270 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set. | |
5271 | |
523 | 5272 *'omnifunc'* *'ofu'* |
5273 'omnifunc' 'ofu' string (default: empty) | |
502 | 5274 local to buffer |
5275 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
5276 {not available when compiled without the |+eval| |
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
5277 or |+insert_expand| features} |
623 | 5278 This option specifies a function to be used for Insert mode omni |
5279 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O| | |
648 | 5280 See |complete-functions| for an explanation of how the function is |
5281 invoked and what it should return. | |
1004 | 5282 This option is usually set by a filetype plugin: |
859 | 5283 |:filetype-plugin-on| |
3682 | 5284 This option cannot be set from a |modeline| or in the |sandbox|, for |
5285 security reasons. | |
502 | 5286 |
5287 | |
1152 | 5288 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'* |
1004 | 5289 'opendevice' 'odev' boolean (default off) |
5290 global | |
5291 {not in Vi} | |
5292 {only for MS-DOS, MS-Windows and OS/2} | |
5293 Enable reading and writing from devices. This may get Vim stuck on a | |
5294 device that can be opened but doesn't actually do the I/O. Therefore | |
5295 it is off by default. | |
5296 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also | |
5297 result in editing a device. | |
5298 | |
5299 | |
593 | 5300 *'operatorfunc'* *'opfunc'* |
5301 'operatorfunc' 'opfunc' string (default: empty) | |
5302 global | |
5303 {not in Vi} | |
5304 This option specifies a function to be called by the |g@| operator. | |
5305 See |:map-operator| for more info and an example. | |
5306 | |
5307 This option cannot be set from a |modeline| or in the |sandbox|, for | |
5308 security reasons. | |
5309 | |
5310 | |
2908 | 5311 *'osfiletype'* *'oft'* |
5312 'osfiletype' 'oft' string (default: "") | |
7 | 5313 local to buffer |
5314 {not in Vi} | |
2908 | 5315 This option was supported on RISC OS, which has been removed. |
5316 | |
7 | 5317 |
5318 *'paragraphs'* *'para'* | |
1564 | 5319 'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp") |
7 | 5320 global |
5321 Specifies the nroff macros that separate paragraphs. These are pairs | |
5322 of two letters (see |object-motions|). | |
5323 | |
5324 *'paste'* *'nopaste'* | |
5325 'paste' boolean (default off) | |
5326 global | |
5327 {not in Vi} | |
10 | 5328 Put Vim in Paste mode. This is useful if you want to cut or copy |
5329 some text from one window and paste it in Vim. This will avoid | |
7 | 5330 unexpected effects. |
5331 Setting this option is useful when using Vim in a terminal, where Vim | |
10 | 5332 cannot distinguish between typed text and pasted text. In the GUI, Vim |
7 | 5333 knows about pasting and will mostly do the right thing without 'paste' |
5334 being set. The same is true for a terminal where Vim handles the | |
5335 mouse clicks itself. | |
148 | 5336 This option is reset when starting the GUI. Thus if you set it in |
5337 your .vimrc it will work in a terminal, but not in the GUI. Setting | |
5338 'paste' in the GUI has side effects: e.g., the Paste toolbar button | |
5339 will no longer work in Insert mode, because it uses a mapping. | |
7 | 5340 When the 'paste' option is switched on (also when it was already on): |
5341 - mapping in Insert mode and Command-line mode is disabled | |
5342 - abbreviations are disabled | |
5343 - 'textwidth' is set to 0 | |
5344 - 'wrapmargin' is set to 0 | |
5345 - 'autoindent' is reset | |
5346 - 'smartindent' is reset | |
5347 - 'softtabstop' is set to 0 | |
5348 - 'revins' is reset | |
5349 - 'ruler' is reset | |
5350 - 'showmatch' is reset | |
5351 - 'formatoptions' is used like it is empty | |
5352 These options keep their value, but their effect is disabled: | |
5353 - 'lisp' | |
5354 - 'indentexpr' | |
5355 - 'cindent' | |
5356 NOTE: When you start editing another file while the 'paste' option is | |
5357 on, settings from the modelines or autocommands may change the | |
5358 settings again, causing trouble when pasting text. You might want to | |
5359 set the 'paste' option again. | |
5360 When the 'paste' option is reset the mentioned options are restored to | |
5361 the value before the moment 'paste' was switched from off to on. | |
5362 Resetting 'paste' before ever setting it does not have any effect. | |
5363 Since mapping doesn't work while 'paste' is active, you need to use | |
5364 the 'pastetoggle' option to toggle the 'paste' option with some key. | |
5365 | |
5366 *'pastetoggle'* *'pt'* | |
5367 'pastetoggle' 'pt' string (default "") | |
5368 global | |
5369 {not in Vi} | |
5370 When non-empty, specifies the key sequence that toggles the 'paste' | |
5371 option. This is like specifying a mapping: > | |
5372 :map {keys} :set invpaste<CR> | |
5373 < Where {keys} is the value of 'pastetoggle'. | |
5374 The difference is that it will work even when 'paste' is set. | |
5375 'pastetoggle' works in Insert mode and Normal mode, but not in | |
5376 Command-line mode. | |
5377 Mappings are checked first, thus overrule 'pastetoggle'. However, | |
5378 when 'paste' is on mappings are ignored in Insert mode, thus you can do | |
5379 this: > | |
5380 :map <F10> :set paste<CR> | |
5381 :map <F11> :set nopaste<CR> | |
5382 :imap <F10> <C-O>:set paste<CR> | |
5383 :imap <F11> <nop> | |
5384 :set pastetoggle=<F11> | |
5385 < This will make <F10> start paste mode and <F11> stop paste mode. | |
5386 Note that typing <F10> in paste mode inserts "<F10>", since in paste | |
5387 mode everything is inserted literally, except the 'pastetoggle' key | |
5388 sequence. | |
1621 | 5389 When the value has several bytes 'ttimeoutlen' applies. |
7 | 5390 |
5391 *'pex'* *'patchexpr'* | |
5392 'patchexpr' 'pex' string (default "") | |
5393 global | |
5394 {not in Vi} | |
5395 {not available when compiled without the |+diff| | |
5396 feature} | |
5397 Expression which is evaluated to apply a patch to a file and generate | |
10 | 5398 the resulting new version of the file. See |diff-patchexpr|. |
7 | 5399 |
6091
7090d7f160f7
Update runtime files. Add vroom file support.
Bram Moolenaar <bram@vim.org>
parents:
6032
diff
changeset
|
5400 *'patchmode'* *'pm'* *E205* *E206* |
7 | 5401 'patchmode' 'pm' string (default "") |
5402 global | |
5403 {not in Vi} | |
5404 When non-empty the oldest version of a file is kept. This can be used | |
5405 to keep the original version of a file if you are changing files in a | |
5406 source distribution. Only the first time that a file is written a | |
5407 copy of the original file will be kept. The name of the copy is the | |
5408 name of the original file with the string in the 'patchmode' option | |
5409 appended. This option should start with a dot. Use a string like | |
5410 ".org". 'backupdir' must not be empty for this to work (Detail: The | |
5411 backup file is renamed to the patchmode file after the new file has | |
5412 been successfully written, that's why it must be possible to write a | |
5413 backup file). If there was no file to be backed up, an empty file is | |
5414 created. | |
5415 When the 'backupskip' pattern matches, a patchmode file is not made. | |
5416 Using 'patchmode' for compressed files appends the extension at the | |
5417 end (e.g., "file.gz.orig"), thus the resulting name isn't always | |
5418 recognized as a compressed file. | |
36 | 5419 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
7 | 5420 |
3224 | 5421 *'path'* *'pa'* *E343* *E345* *E347* *E854* |
7 | 5422 'path' 'pa' string (default on Unix: ".,/usr/include,," |
5423 on OS/2: ".,/emx/include,," | |
5424 other systems: ".,,") | |
5425 global or local to buffer |global-local| | |
5426 {not in Vi} | |
5427 This is a list of directories which will be searched when using the | |
1668 | 5428 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands, |
5429 provided that the file being searched for has a relative path (not | |
5430 starting with "/", "./" or "../"). The directories in the 'path' | |
5431 option may be relative or absolute. | |
7 | 5432 - Use commas to separate directory names: > |
5433 :set path=.,/usr/local/include,/usr/include | |
5434 < - Spaces can also be used to separate directory names (for backwards | |
5435 compatibility with version 3.0). To have a space in a directory | |
5436 name, precede it with an extra backslash, and escape the space: > | |
5437 :set path=.,/dir/with\\\ space | |
5438 < - To include a comma in a directory name precede it with an extra | |
5439 backslash: > | |
5440 :set path=.,/dir/with\\,comma | |
5441 < - To search relative to the directory of the current file, use: > | |
5442 :set path=. | |
5443 < - To search in the current directory use an empty string between two | |
5444 commas: > | |
5445 :set path=,, | |
5446 < - A directory name may end in a ':' or '/'. | |
5447 - Environment variables are expanded |:set_env|. | |
5448 - When using |netrw.vim| URLs can be used. For example, adding | |
5449 "http://www.vim.org" will make ":find index.html" work. | |
1668 | 5450 - Search upwards and downwards in a directory tree using "*", "**" and |
5451 ";". See |file-searching| for info and syntax. | |
7 | 5452 {not available when compiled without the |+path_extra| feature} |
5453 - Careful with '\' characters, type two to get one in the option: > | |
5454 :set path=.,c:\\include | |
5455 < Or just use '/' instead: > | |
5456 :set path=.,c:/include | |
5457 < Don't forget "." or files won't even be found in the same directory as | |
5458 the file! | |
10 | 5459 The maximum length is limited. How much depends on the system, mostly |
7 | 5460 it is something like 256 or 1024 characters. |
5461 You can check if all the include files are found, using the value of | |
5462 'path', see |:checkpath|. | |
5463 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
5464 directories from the list. This avoids problems when a future version | |
5465 uses another default. To remove the current directory use: > | |
5466 :set path-= | |
5467 < To add the current directory use: > | |
5468 :set path+= | |
5469 < To use an environment variable, you probably need to replace the | |
5470 separator. Here is an example to append $INCL, in which directory | |
5471 names are separated with a semi-colon: > | |
5472 :let &path = &path . "," . substitute($INCL, ';', ',', 'g') | |
5473 < Replace the ';' with a ':' or whatever separator is used. Note that | |
5474 this doesn't work when $INCL contains a comma or white space. | |
5475 | |
5476 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'* | |
5477 'preserveindent' 'pi' boolean (default off) | |
5478 local to buffer | |
5479 {not in Vi} | |
5480 When changing the indent of the current line, preserve as much of the | |
5481 indent structure as possible. Normally the indent is replaced by a | |
5482 series of tabs followed by spaces as required (unless |'expandtab'| is | |
5483 enabled, in which case only spaces are used). Enabling this option | |
5484 means the indent will preserve as many existing characters as possible | |
5485 for indenting, and only add additional tabs or spaces as required. | |
1621 | 5486 'expandtab' does not apply to the preserved white space, a Tab remains |
5487 a Tab. | |
7 | 5488 NOTE: When using ">>" multiple times the resulting indent is a mix of |
5489 tabs and spaces. You might not like this. | |
5490 NOTE: 'preserveindent' is reset when 'compatible' is set. | |
5491 Also see 'copyindent'. | |
5492 Use |:retab| to clean up white space. | |
5493 | |
5494 *'previewheight'* *'pvh'* | |
5495 'previewheight' 'pvh' number (default 12) | |
5496 global | |
5497 {not in Vi} | |
5498 {not available when compiled without the |+windows| or | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
5499 |+quickfix| features} |
7 | 5500 Default height for a preview window. Used for |:ptag| and associated |
5501 commands. Used for |CTRL-W_}| when no count is given. | |
5502 | |
5503 *'previewwindow'* *'nopreviewwindow'* | |
5504 *'pvw'* *'nopvw'* *E590* | |
5505 'previewwindow' 'pvw' boolean (default off) | |
5506 local to window | |
5507 {not in Vi} | |
5508 {not available when compiled without the |+windows| or | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
5509 |+quickfix| features} |
10 | 5510 Identifies the preview window. Only one window can have this option |
7 | 5511 set. It's normally not set directly, but by using one of the commands |
5512 |:ptag|, |:pedit|, etc. | |
5513 | |
5514 *'printdevice'* *'pdev'* | |
5515 'printdevice' 'pdev' string (default empty) | |
5516 global | |
5517 {not in Vi} | |
5518 {only available when compiled with the |+printer| | |
5519 feature} | |
15 | 5520 The name of the printer to be used for |:hardcopy|. |
5521 See |pdev-option|. | |
36 | 5522 This option cannot be set from a |modeline| or in the |sandbox|, for |
5523 security reasons. | |
15 | 5524 |
5525 *'printencoding'* *'penc'* | |
5526 'printencoding' 'penc' String (default empty, except for some systems) | |
7 | 5527 global |
5528 {not in Vi} | |
5529 {only available when compiled with the |+printer| | |
5530 and |+postscript| features} | |
15 | 5531 Sets the character encoding used when printing. |
5532 See |penc-option|. | |
7 | 5533 |
5534 *'printexpr'* *'pexpr'* | |
5535 'printexpr' 'pexpr' String (default: see below) | |
5536 global | |
5537 {not in Vi} | |
5538 {only available when compiled with the |+printer| | |
5539 and |+postscript| features} | |
15 | 5540 Expression used to print the PostScript produced with |:hardcopy|. |
5541 See |pexpr-option|. | |
5542 | |
5543 *'printfont'* *'pfn'* | |
7 | 5544 'printfont' 'pfn' string (default "courier") |
5545 global | |
5546 {not in Vi} | |
5547 {only available when compiled with the |+printer| | |
5548 feature} | |
15 | 5549 The name of the font that will be used for |:hardcopy|. |
5550 See |pfn-option|. | |
7 | 5551 |
5552 *'printheader'* *'pheader'* | |
5553 'printheader' 'pheader' string (default "%<%f%h%m%=Page %N") | |
5554 global | |
5555 {not in Vi} | |
5556 {only available when compiled with the |+printer| | |
5557 feature} | |
15 | 5558 The format of the header produced in |:hardcopy| output. |
5559 See |pheader-option|. | |
5560 | |
5561 *'printmbcharset'* *'pmbcs'* | |
5562 'printmbcharset' 'pmbcs' string (default "") | |
5563 global | |
5564 {not in Vi} | |
180 | 5565 {only available when compiled with the |+printer|, |
5566 |+postscript| and |+multi_byte| features} | |
15 | 5567 The CJK character set to be used for CJK output from |:hardcopy|. |
5568 See |pmbcs-option|. | |
5569 | |
5570 *'printmbfont'* *'pmbfn'* | |
5571 'printmbfont' 'pmbfn' string (default "") | |
5572 global | |
5573 {not in Vi} | |
180 | 5574 {only available when compiled with the |+printer|, |
5575 |+postscript| and |+multi_byte| features} | |
15 | 5576 List of font names to be used for CJK output from |:hardcopy|. |
5577 See |pmbfn-option|. | |
7 | 5578 |
5579 *'printoptions'* *'popt'* | |
5580 'printoptions' 'popt' string (default "") | |
5581 global | |
5582 {not in Vi} | |
5583 {only available when compiled with |+printer| feature} | |
15 | 5584 List of items that control the format of the output of |:hardcopy|. |
5585 See |popt-option|. | |
5586 | |
168 | 5587 *'prompt'* *'noprompt'* |
5588 'prompt' boolean (default on) | |
5589 global | |
5590 When on a ":" prompt is used in Ex mode. | |
5591 | |
766 | 5592 *'pumheight'* *'ph'* |
5593 'pumheight' 'ph' number (default 0) | |
5594 global | |
5595 {not available when compiled without the | |
5596 |+insert_expand| feature} | |
5597 {not in Vi} | |
853 | 5598 Determines the maximum number of items to show in the popup menu for |
5599 Insert mode completion. When zero as much space as available is used. | |
766 | 5600 |ins-completion-menu|. |
5601 | |
5602 | |
140 | 5603 *'quoteescape'* *'qe'* |
12 | 5604 'quoteescape' 'qe' string (default "\") |
5605 local to buffer | |
5606 {not in Vi} | |
5607 The characters that are used to escape quotes in a string. Used for | |
5608 objects like a', a" and a` |a'|. | |
5609 When one of the characters in this option is found inside a string, | |
5610 the following character will be skipped. The default value makes the | |
5611 text "foo\"bar\\" considered to be one string. | |
5612 | |
7 | 5613 *'readonly'* *'ro'* *'noreadonly'* *'noro'* |
5614 'readonly' 'ro' boolean (default off) | |
5615 local to buffer | |
5616 If on, writes fail unless you use a '!'. Protects you from | |
5617 accidentally overwriting a file. Default on when Vim is started | |
5618 in read-only mode ("vim -R") or when the executable is called "view". | |
164 | 5619 When using ":w!" the 'readonly' option is reset for the current |
5620 buffer, unless the 'Z' flag is in 'cpoptions'. | |
7 | 5621 {not in Vi:} When using the ":view" command the 'readonly' option is |
164 | 5622 set for the newly edited buffer. |
7 | 5623 |
1521 | 5624 *'redrawtime'* *'rdt'* |
5625 'redrawtime' 'rdt' number (default 2000) | |
5626 global | |
5627 {not in Vi} | |
5628 {only available when compiled with the |+reltime| | |
5629 feature} | |
5630 The time in milliseconds for redrawing the display. This applies to | |
5631 searching for patterns for 'hlsearch' and |:match| highlighting. | |
5632 When redrawing takes more than this many milliseconds no further | |
5633 matches will be highlighted. This is used to avoid that Vim hangs | |
5634 when using a very complicated pattern. | |
5635 | |
4681
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5636 *'regexpengine'* *'re'* |
4502
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
5637 'regexpengine' 're' number (default 0) |
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
5638 global |
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
5639 {not in Vi} |
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
5640 This selects the default regexp engine. |two-engines| |
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
5641 The possible values are: |
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
5642 0 automatic selection |
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
5643 1 old engine |
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
5644 2 NFA engine |
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
5645 Note that when using the NFA engine and the pattern contains something |
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
5646 that is not supported the pattern will not match. This is only useful |
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
5647 for debugging the regexp engine. |
6328 | 5648 Using automatic selection enables Vim to switch the engine, if the |
5649 default engine becomes too costly. E.g., when the NFA engine uses too | |
5650 many states. This should prevent Vim from hanging on a combination of | |
5651 a complex pattern with long text. | |
4502
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
5652 |
2178
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5653 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'* |
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5654 'relativenumber' 'rnu' boolean (default off) |
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5655 local to window |
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5656 {not in Vi} |
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5657 Show the line number relative to the line with the cursor in front of |
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2204
diff
changeset
|
5658 each line. Relative line numbers help you use the |count| you can |
2178
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5659 precede some vertical motion commands (e.g. j k + -) with, without |
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5660 having to calculate it yourself. Especially useful in combination with |
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5661 other commands (e.g. y d c < > gq gw =). |
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5662 When the 'n' option is excluded from 'cpoptions' a wrapped |
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5663 line will not use the column of line numbers (this is the default when |
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5664 'compatible' isn't set). |
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5665 The 'numberwidth' option can be used to set the room used for the line |
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5666 number. |
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5667 When a long, wrapped line doesn't start with the first character, '-' |
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5668 characters are put before the number. |
3445 | 5669 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for |
5670 the number. | |
4780 | 5671 |
5672 The number in front of the cursor line also depends on the value of | |
5673 'number', see |number_relativenumber| for all combinations of the two | |
5674 options. | |
2178
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5675 |
7 | 5676 *'remap'* *'noremap'* |
5677 'remap' boolean (default on) | |
5678 global | |
5679 Allows for mappings to work recursively. If you do not want this for | |
5680 a single entry, use the :noremap[!] command. | |
717 | 5681 NOTE: To avoid portability problems with Vim scripts, always keep |
5682 this option at the default "on". Only switch it off when working with | |
5683 old Vi scripts. | |
7 | 5684 |
6110 | 5685 *'renderoptions'* *'rop'* |
5686 'renderoptions' 'rop' string (default: empty) | |
5687 global | |
5688 {not in Vi} | |
5689 {only available when compiled with GUI and DIRECTX on | |
5690 MS-Windows} | |
5691 Select a text renderer and set its options. The options depend on the | |
5692 renderer. | |
5693 | |
5694 Syntax: > | |
5695 set rop=type:{renderer}(,{name}:{value})* | |
5696 < | |
5697 Currently, only one optional renderer is available. | |
5698 | |
5699 render behavior ~ | |
5700 directx Vim will draw text using DirectX (DirectWrite). It makes | |
5701 drawn glyphs more beautiful than default GDI. | |
5702 It requires 'encoding' is "utf-8", and only works on | |
5703 MS-Windows Vista or newer version. | |
5704 | |
5705 Options: | |
5706 name meaning type value ~ | |
5707 gamma gamma float 1.0 - 2.2 (maybe) | |
5708 contrast enhancedContrast float (unknown) | |
5709 level clearTypeLevel float (unknown) | |
5710 geom pixelGeometry int 0 - 2 (see below) | |
5711 renmode renderingMode int 0 - 6 (see below) | |
5712 taamode textAntialiasMode int 0 - 3 (see below) | |
5713 | |
5714 See this URL for detail: | |
5715 http://msdn.microsoft.com/en-us/library/dd368190.aspx | |
5716 | |
5717 For geom: structure of a device pixel. | |
5718 0 - DWRITE_PIXEL_GEOMETRY_FLAT | |
5719 1 - DWRITE_PIXEL_GEOMETRY_RGB | |
5720 2 - DWRITE_PIXEL_GEOMETRY_BGR | |
5721 | |
5722 See this URL for detail: | |
5723 http://msdn.microsoft.com/en-us/library/dd368114.aspx | |
5724 | |
5725 For renmode: method of rendering glyphs. | |
5726 0 - DWRITE_RENDERING_MODE_DEFAULT | |
5727 1 - DWRITE_RENDERING_MODE_ALIASED | |
5728 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC | |
5729 3 - DWRITE_RENDERING_MODE_GDI_NATURAL | |
5730 4 - DWRITE_RENDERING_MODE_NATURAL | |
5731 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC | |
5732 6 - DWRITE_RENDERING_MODE_OUTLINE | |
5733 | |
5734 See this URL for detail: | |
5735 http://msdn.microsoft.com/en-us/library/dd368118.aspx | |
5736 | |
5737 For taamode: antialiasing mode used for drawing text. | |
5738 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT | |
5739 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE | |
5740 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE | |
5741 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED | |
5742 | |
5743 See this URL for detail: | |
5744 http://msdn.microsoft.com/en-us/library/dd368170.aspx | |
5745 | |
5746 Example: > | |
5747 set encoding=utf-8 | |
5748 set gfn=Ricty_Diminished:h12:cSHIFTJIS | |
5749 set rop=type:directx | |
5750 < | |
5751 If select a raster font (Courier, Terminal or FixedSys) to | |
5752 'guifont', it fallbacks to be drawn by GDI automatically. | |
5753 | |
5754 Other render types are currently not supported. | |
5755 | |
7 | 5756 *'report'* |
5757 'report' number (default 2) | |
5758 global | |
5759 Threshold for reporting number of lines changed. When the number of | |
5760 changed lines is more than 'report' a message will be given for most | |
5761 ":" commands. If you want it always, set 'report' to 0. | |
5762 For the ":substitute" command the number of substitutions is used | |
5763 instead of the number of lines. | |
5764 | |
5765 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'* | |
5766 'restorescreen' 'rs' boolean (default on) | |
5767 global | |
5768 {not in Vi} {only in Windows 95/NT console version} | |
5769 When set, the screen contents is restored when exiting Vim. This also | |
5770 happens when executing external commands. | |
5771 | |
5772 For non-Windows Vim: You can set or reset the 't_ti' and 't_te' | |
5773 options in your .vimrc. To disable restoring: | |
5774 set t_ti= t_te= | |
5775 To enable restoring (for an xterm): | |
5776 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8 | |
5777 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it) | |
5778 | |
5779 *'revins'* *'ri'* *'norevins'* *'nori'* | |
5780 'revins' 'ri' boolean (default off) | |
5781 global | |
5782 {not in Vi} | |
5783 {only available when compiled with the |+rightleft| | |
5784 feature} | |
5785 Inserting characters in Insert mode will work backwards. See "typing | |
5786 backwards" |ins-reverse|. This option can be toggled with the CTRL-_ | |
5787 command in Insert mode, when 'allowrevins' is set. | |
5788 NOTE: This option is reset when 'compatible' or 'paste' is set. | |
5789 | |
5790 *'rightleft'* *'rl'* *'norightleft'* *'norl'* | |
5791 'rightleft' 'rl' boolean (default off) | |
5792 local to window | |
5793 {not in Vi} | |
5794 {only available when compiled with the |+rightleft| | |
5795 feature} | |
5796 When on, display orientation becomes right-to-left, i.e., characters | |
5797 that are stored in the file appear from the right to the left. | |
5798 Using this option, it is possible to edit files for languages that | |
5799 are written from the right to the left such as Hebrew and Arabic. | |
5800 This option is per window, so it is possible to edit mixed files | |
5801 simultaneously, or to view the same file in both ways (this is | |
5802 useful whenever you have a mixed text file with both right-to-left | |
5803 and left-to-right strings so that both sets are displayed properly | |
5804 in different windows). Also see |rileft.txt|. | |
5805 | |
2341 | 5806 *'rightleftcmd'* *'rlc'* |
7 | 5807 'rightleftcmd' 'rlc' string (default "search") |
5808 local to window | |
5809 {not in Vi} | |
5810 {only available when compiled with the |+rightleft| | |
5811 feature} | |
5812 Each word in this option enables the command line editing to work in | |
5813 right-to-left mode for a group of commands: | |
5814 | |
5815 search "/" and "?" commands | |
5816 | |
5817 This is useful for languages such as Hebrew, Arabic and Farsi. | |
5818 The 'rightleft' option must be set for 'rightleftcmd' to take effect. | |
5819 | |
5820 *'ruler'* *'ru'* *'noruler'* *'noru'* | |
5821 'ruler' 'ru' boolean (default off) | |
5822 global | |
5823 {not in Vi} | |
5824 {not available when compiled without the | |
5825 |+cmdline_info| feature} | |
5826 Show the line and column number of the cursor position, separated by a | |
10 | 5827 comma. When there is room, the relative position of the displayed |
7 | 5828 text in the file is shown on the far right: |
5829 Top first line is visible | |
5830 Bot last line is visible | |
5831 All first and last line are visible | |
5832 45% relative position in the file | |
5833 If 'rulerformat' is set, it will determine the contents of the ruler. | |
10 | 5834 Each window has its own ruler. If a window has a status line, the |
7 | 5835 ruler is shown there. Otherwise it is shown in the last line of the |
233 | 5836 screen. If the statusline is given by 'statusline' (i.e. not empty), |
7 | 5837 this option takes precedence over 'ruler' and 'rulerformat' |
5838 If the number of characters displayed is different from the number of | |
5839 bytes in the text (e.g., for a TAB or a multi-byte character), both | |
5840 the text column (byte number) and the screen column are shown, | |
5841 separated with a dash. | |
5842 For an empty line "0-1" is shown. | |
5843 For an empty buffer the line number will also be zero: "0,0-1". | |
5844 This option is reset when the 'paste' option is set. | |
5845 If you don't want to see the ruler all the time but want to know where | |
5846 you are, use "g CTRL-G" |g_CTRL-G|. | |
5847 NOTE: This option is reset when 'compatible' is set. | |
5848 | |
5849 *'rulerformat'* *'ruf'* | |
5850 'rulerformat' 'ruf' string (default empty) | |
5851 global | |
5852 {not in Vi} | |
5853 {not available when compiled without the |+statusline| | |
5854 feature} | |
5855 When this option is not empty, it determines the content of the ruler | |
5856 string, as displayed for the 'ruler' option. | |
692 | 5857 The format of this option is like that of 'statusline'. |
7 | 5858 The default ruler width is 17 characters. To make the ruler 15 |
5859 characters wide, put "%15(" at the start and "%)" at the end. | |
5860 Example: > | |
5861 :set rulerformat=%15(%c%V\ %p%%%) | |
5862 < | |
5863 *'runtimepath'* *'rtp'* *vimfiles* | |
5864 'runtimepath' 'rtp' string (default: | |
5865 Unix: "$HOME/.vim, | |
5866 $VIM/vimfiles, | |
5867 $VIMRUNTIME, | |
5868 $VIM/vimfiles/after, | |
5869 $HOME/.vim/after" | |
5870 Amiga: "home:vimfiles, | |
5871 $VIM/vimfiles, | |
5872 $VIMRUNTIME, | |
5873 $VIM/vimfiles/after, | |
5874 home:vimfiles/after" | |
5875 PC, OS/2: "$HOME/vimfiles, | |
5876 $VIM/vimfiles, | |
5877 $VIMRUNTIME, | |
5878 $VIM/vimfiles/after, | |
5879 $HOME/vimfiles/after" | |
5880 Macintosh: "$VIM:vimfiles, | |
5881 $VIMRUNTIME, | |
5882 $VIM:vimfiles:after" | |
5883 RISC-OS: "Choices:vimfiles, | |
5884 $VIMRUNTIME, | |
5885 Choices:vimfiles/after" | |
5886 VMS: "sys$login:vimfiles, | |
5887 $VIM/vimfiles, | |
5888 $VIMRUNTIME, | |
5889 $VIM/vimfiles/after, | |
233 | 5890 sys$login:vimfiles/after") |
7 | 5891 global |
5892 {not in Vi} | |
5893 This is a list of directories which will be searched for runtime | |
5894 files: | |
5895 filetype.vim filetypes by file name |new-filetype| | |
5896 scripts.vim filetypes by file contents |new-filetype-scripts| | |
164 | 5897 autoload/ automatically loaded scripts |autoload-functions| |
7 | 5898 colors/ color scheme files |:colorscheme| |
5899 compiler/ compiler files |:compiler| | |
5900 doc/ documentation |write-local-help| | |
5901 ftplugin/ filetype plugins |write-filetype-plugin| | |
5902 indent/ indent scripts |indent-expression| | |
5903 keymap/ key mapping files |mbyte-keymap| | |
5904 lang/ menu translations |:menutrans| | |
5905 menu.vim GUI menus |menu.vim| | |
5906 plugin/ plugin scripts |write-plugin| | |
5907 print/ files for printing |postscript-print-encoding| | |
650 | 5908 spell/ spell checking files |spell| |
7 | 5909 syntax/ syntax files |mysyntaxfile| |
5910 tutor/ files for vimtutor |tutor| | |
5911 | |
5912 And any other file searched for with the |:runtime| command. | |
5913 | |
5914 The defaults for most systems are setup to search five locations: | |
5915 1. In your home directory, for your personal preferences. | |
5916 2. In a system-wide Vim directory, for preferences from the system | |
5917 administrator. | |
5918 3. In $VIMRUNTIME, for files distributed with Vim. | |
5919 *after-directory* | |
5920 4. In the "after" directory in the system-wide Vim directory. This is | |
5921 for the system administrator to overrule or add to the distributed | |
5922 defaults (rarely needed) | |
5923 5. In the "after" directory in your home directory. This is for | |
5924 personal preferences to overrule or add to the distributed defaults | |
5925 or system-wide settings (rarely needed). | |
5926 | |
5927 Note that, unlike 'path', no wildcards like "**" are allowed. Normal | |
5928 wildcards are allowed, but can significantly slow down searching for | |
10 | 5929 runtime files. For speed, use as few items as possible and avoid |
7 | 5930 wildcards. |
5931 See |:runtime|. | |
5932 Example: > | |
5933 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME | |
5934 < This will use the directory "~/vimruntime" first (containing your | |
5935 personal Vim runtime files), then "/mygroup/vim" (shared between a | |
5936 group of people) and finally "$VIMRUNTIME" (the distributed runtime | |
5937 files). | |
5938 You probably should always include $VIMRUNTIME somewhere, to use the | |
5939 distributed runtime files. You can put a directory before $VIMRUNTIME | |
5940 to find files which replace a distributed runtime files. You can put | |
5941 a directory after $VIMRUNTIME to find files which add to distributed | |
5942 runtime files. | |
5943 This option cannot be set from a |modeline| or in the |sandbox|, for | |
5944 security reasons. | |
5945 | |
5946 *'scroll'* *'scr'* | |
5947 'scroll' 'scr' number (default: half the window height) | |
5948 local to window | |
5949 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be | |
5950 set to half the number of lines in the window when the window size | |
5951 changes. If you give a count to the CTRL-U or CTRL-D command it will | |
10 | 5952 be used as the new value for 'scroll'. Reset to half the window |
7 | 5953 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives |
5954 the number of screen lines instead of file lines, makes a difference | |
5955 when lines wrap} | |
5956 | |
5957 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'* | |
5958 'scrollbind' 'scb' boolean (default off) | |
5959 local to window | |
5960 {not in Vi} | |
5961 {not available when compiled without the |+scrollbind| | |
5962 feature} | |
5963 See also |scroll-binding|. When this option is set, the current | |
5964 window scrolls as other scrollbind windows (windows that also have | |
5965 this option set) scroll. This option is useful for viewing the | |
5966 differences between two versions of a file, see 'diff'. | |
5967 See |'scrollopt'| for options that determine how this option should be | |
5968 interpreted. | |
5969 This option is mostly reset when splitting a window to edit another | |
5970 file. This means that ":split | edit file" results in two windows | |
5971 with scroll-binding, but ":split file" does not. | |
5972 | |
5973 *'scrolljump'* *'sj'* | |
5974 'scrolljump' 'sj' number (default 1) | |
5975 global | |
5976 {not in Vi} | |
5977 Minimal number of lines to scroll when the cursor gets off the | |
5978 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E, | |
5979 CTRL-D). Useful if your terminal scrolls very slowly. | |
532 | 5980 When set to a negative number from -1 to -100 this is used as the |
5981 percentage of the window height. Thus -50 scrolls half the window | |
5982 height. | |
7 | 5983 NOTE: This option is set to 1 when 'compatible' is set. |
5984 | |
5985 *'scrolloff'* *'so'* | |
5986 'scrolloff' 'so' number (default 0) | |
5987 global | |
5988 {not in Vi} | |
5989 Minimal number of screen lines to keep above and below the cursor. | |
5990 This will make some context visible around where you are working. If | |
5991 you set it to a very large value (999) the cursor line will always be | |
5992 in the middle of the window (except at the start or end of the file or | |
5993 when long lines wrap). | |
5994 For scrolling horizontally see 'sidescrolloff'. | |
5995 NOTE: This option is set to 0 when 'compatible' is set. | |
5996 | |
5997 *'scrollopt'* *'sbo'* | |
5998 'scrollopt' 'sbo' string (default "ver,jump") | |
5999 global | |
6000 {not available when compiled without the |+scrollbind| | |
6001 feature} | |
6002 {not in Vi} | |
6003 This is a comma-separated list of words that specifies how | |
236 | 6004 'scrollbind' windows should behave. 'sbo' stands for ScrollBind |
6005 Options. | |
7 | 6006 The following words are available: |
6007 ver Bind vertical scrolling for 'scrollbind' windows | |
6008 hor Bind horizontal scrolling for 'scrollbind' windows | |
6009 jump Applies to the offset between two windows for vertical | |
6010 scrolling. This offset is the difference in the first | |
6011 displayed line of the bound windows. When moving | |
6012 around in a window, another 'scrollbind' window may | |
6013 reach a position before the start or after the end of | |
6014 the buffer. The offset is not changed though, when | |
6015 moving back the 'scrollbind' window will try to scroll | |
6016 to the desired position when possible. | |
6017 When now making that window the current one, two | |
6018 things can be done with the relative offset: | |
6019 1. When "jump" is not included, the relative offset is | |
6020 adjusted for the scroll position in the new current | |
6021 window. When going back to the other window, the | |
1152 | 6022 new relative offset will be used. |
7 | 6023 2. When "jump" is included, the other windows are |
6024 scrolled to keep the same relative offset. When | |
6025 going back to the other window, it still uses the | |
6026 same relative offset. | |
6027 Also see |scroll-binding|. | |
819 | 6028 When 'diff' mode is active there always is vertical scroll binding, |
6029 even when "ver" isn't there. | |
7 | 6030 |
6031 *'sections'* *'sect'* | |
6032 'sections' 'sect' string (default "SHNHH HUnhsh") | |
6033 global | |
6034 Specifies the nroff macros that separate sections. These are pairs of | |
6035 two letters (See |object-motions|). The default makes a section start | |
6036 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh". | |
6037 | |
6038 *'secure'* *'nosecure'* *E523* | |
6039 'secure' boolean (default off) | |
6040 global | |
6041 {not in Vi} | |
6042 When on, ":autocmd", shell and write commands are not allowed in | |
6043 ".vimrc" and ".exrc" in the current directory and map commands are | |
6044 displayed. Switch it off only if you know that you will not run into | |
6045 problems, or when the 'exrc' option is off. On Unix this option is | |
6046 only used if the ".vimrc" or ".exrc" is not owned by you. This can be | |
10 | 6047 dangerous if the systems allows users to do a "chown". You better set |
7 | 6048 'secure' at the end of your ~/.vimrc then. |
6049 This option cannot be set from a |modeline| or in the |sandbox|, for | |
6050 security reasons. | |
6051 | |
6052 *'selection'* *'sel'* | |
6053 'selection' 'sel' string (default "inclusive") | |
6054 global | |
6055 {not in Vi} | |
6056 This option defines the behavior of the selection. It is only used | |
6057 in Visual and Select mode. | |
6058 Possible values: | |
6059 value past line inclusive ~ | |
6060 old no yes | |
6061 inclusive yes yes | |
6062 exclusive yes no | |
6063 "past line" means that the cursor is allowed to be positioned one | |
6064 character past the line. | |
6065 "inclusive" means that the last character of the selection is included | |
6066 in an operation. For example, when "x" is used to delete the | |
6067 selection. | |
6068 Note that when "exclusive" is used and selecting from the end | |
6069 backwards, you cannot include the last character of a line, when | |
6070 starting in Normal mode and 'virtualedit' empty. | |
6071 | |
6072 The 'selection' option is set by the |:behave| command. | |
6073 | |
6074 *'selectmode'* *'slm'* | |
6075 'selectmode' 'slm' string (default "") | |
6076 global | |
6077 {not in Vi} | |
6078 This is a comma separated list of words, which specifies when to start | |
6079 Select mode instead of Visual mode, when a selection is started. | |
6080 Possible values: | |
6081 mouse when using the mouse | |
6082 key when using shifted special keys | |
6083 cmd when using "v", "V" or CTRL-V | |
6084 See |Select-mode|. | |
6085 The 'selectmode' option is set by the |:behave| command. | |
6086 | |
6087 *'sessionoptions'* *'ssop'* | |
6088 'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds, | |
827 | 6089 help,options,tabpages,winsize") |
7 | 6090 global |
6091 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
6092 {not available when compiled without the |+mksession| |
7 | 6093 feature} |
6094 Changes the effect of the |:mksession| command. It is a comma | |
6095 separated list of words. Each word enables saving and restoring | |
6096 something: | |
6097 word save and restore ~ | |
6098 blank empty windows | |
6099 buffers hidden and unloaded buffers, not just those in windows | |
6100 curdir the current directory | |
6101 folds manually created folds, opened/closed folds and local | |
6102 fold options | |
6103 globals global variables that start with an uppercase letter | |
75 | 6104 and contain at least one lowercase letter. Only |
6105 String and Number types are stored. | |
7 | 6106 help the help window |
6107 localoptions options and mappings local to a window or buffer (not | |
6108 global values for local options) | |
6109 options all options and mappings (also global values for local | |
6110 options) | |
6111 resize size of the Vim window: 'lines' and 'columns' | |
6112 sesdir the directory in which the session file is located | |
6113 will become the current directory (useful with | |
6114 projects accessed over a network from different | |
6115 systems) | |
6116 slash backslashes in file names replaced with forward | |
6117 slashes | |
827 | 6118 tabpages all tab pages; without this only the current tab page |
6119 is restored, so that you can make a session for each | |
6120 tab page separately | |
7 | 6121 unix with Unix end-of-line format (single <NL>), even when |
6122 on Windows or DOS | |
6123 winpos position of the whole Vim window | |
6124 winsize window sizes | |
6125 | |
6126 Don't include both "curdir" and "sesdir". | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6127 When neither "curdir" nor "sesdir" is included, file names are stored |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6128 with absolute paths. |
7 | 6129 "slash" and "unix" are useful on Windows when sharing session files |
6130 with Unix. The Unix version of Vim cannot source dos format scripts, | |
6131 but the Windows version of Vim can source unix format scripts. | |
6132 | |
6133 *'shell'* *'sh'* *E91* | |
6134 'shell' 'sh' string (default $SHELL or "sh", | |
6135 MS-DOS and Win32: "command.com" or | |
6136 "cmd.exe", OS/2: "cmd") | |
6137 global | |
6138 Name of the shell to use for ! and :! commands. When changing the | |
6139 value also check these options: 'shelltype', 'shellpipe', 'shellslash' | |
6140 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'. | |
10 | 6141 It is allowed to give an argument to the command, e.g. "csh -f". |
7 | 6142 See |option-backslash| about including spaces and backslashes. |
6143 Environment variables are expanded |:set_env|. | |
6144 If the name of the shell contains a space, you might need to enclose | |
6145 it in quotes. Example: > | |
6146 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f | |
6147 < Note the backslash before each quote (to avoid starting a comment) and | |
10 | 6148 each space (to avoid ending the option value). Also note that the |
7 | 6149 "-f" is not inside the quotes, because it is not part of the command |
6150 name. And Vim automagically recognizes the backslashes that are path | |
6151 separators. | |
6152 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment | |
6153 variable to change the way external commands are executed. See the | |
6154 libc.inf file of DJGPP. | |
6155 Under MS-Windows, when the executable ends in ".com" it must be | |
6156 included. Thus setting the shell to "command.com" or "4dos.com" | |
6157 works, but "command" and "4dos" do not work for all commands (e.g., | |
6158 filtering). | |
6159 For unknown reasons, when using "4dos.com" the current directory is | |
6160 changed to "C:\". To avoid this set 'shell' like this: > | |
6161 :set shell=command.com\ /c\ 4dos | |
6162 < This option cannot be set from a |modeline| or in the |sandbox|, for | |
6163 security reasons. | |
6164 | |
6165 *'shellcmdflag'* *'shcf'* | |
3356 | 6166 'shellcmdflag' 'shcf' string (default: "-c"; |
3371 | 6167 MS-DOS and Win32, when 'shell' does not |
6168 contain "sh" somewhere: "/c") | |
7 | 6169 global |
6170 {not in Vi} | |
6171 Flag passed to the shell to execute "!" and ":!" commands; e.g., | |
6172 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like | |
6173 systems, the default is set according to the value of 'shell', to | |
6174 reduce the need to set this option by the user. It's not used for | |
3082 | 6175 OS/2 (EMX figures this out itself). |
6176 On Unix it can have more than one flag. Each white space separated | |
6177 part is passed as an argument to the shell command. | |
6178 See |option-backslash| about including spaces and backslashes. | |
6179 Also see |dos-shell| for MS-DOS and MS-Windows. | |
7 | 6180 This option cannot be set from a |modeline| or in the |sandbox|, for |
6181 security reasons. | |
6182 | |
6183 *'shellpipe'* *'sp'* | |
6184 'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee") | |
6185 global | |
6186 {not in Vi} | |
6187 {not available when compiled without the |+quickfix| | |
6188 feature} | |
6189 String to be used to put the output of the ":make" command in the | |
10 | 6190 error file. See also |:make_makeprg|. See |option-backslash| about |
7 | 6191 including spaces and backslashes. |
6192 The name of the temporary file can be represented by "%s" if necessary | |
6193 (the file name is appended automatically if no %s appears in the value | |
6194 of this option). | |
6195 For the Amiga and MS-DOS the default is ">". The output is directly | |
6196 saved in a file and not echoed to the screen. | |
6197 For Unix the default it "| tee". The stdout of the compiler is saved | |
6198 in a file and echoed to the screen. If the 'shell' option is "csh" or | |
6199 "tcsh" after initializations, the default becomes "|& tee". If the | |
2788 | 6200 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the |
6201 default becomes "2>&1| tee". This means that stderr is also included. | |
6202 Before using the 'shell' option a path is removed, thus "/bin/sh" uses | |
6203 "sh". | |
7 | 6204 The initialization of this option is done after reading the ".vimrc" |
6205 and the other initializations, so that when the 'shell' option is set | |
6206 there, the 'shellpipe' option changes automatically, unless it was | |
6207 explicitly set before. | |
6208 When 'shellpipe' is set to an empty string, no redirection of the | |
6209 ":make" output will be done. This is useful if you use a 'makeprg' | |
6210 that writes to 'makeef' by itself. If you want no piping, but do | |
6211 want to include the 'makeef', set 'shellpipe' to a single space. | |
6212 Don't forget to precede the space with a backslash: ":set sp=\ ". | |
6213 In the future pipes may be used for filtering and this option will | |
6214 become obsolete (at least for Unix). | |
6215 This option cannot be set from a |modeline| or in the |sandbox|, for | |
6216 security reasons. | |
6217 | |
6218 *'shellquote'* *'shq'* | |
6219 'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell' | |
6220 contains "sh" somewhere: "\"") | |
6221 global | |
6222 {not in Vi} | |
6223 Quoting character(s), put around the command passed to the shell, for | |
6224 the "!" and ":!" commands. The redirection is kept outside of the | |
6225 quoting. See 'shellxquote' to include the redirection. It's | |
6226 probably not useful to set both options. | |
6227 This is an empty string by default. Only known to be useful for | |
6228 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell | |
6229 or bash, where it should be "\"". The default is adjusted according | |
6230 the value of 'shell', to reduce the need to set this option by the | |
6231 user. See |dos-shell|. | |
6232 This option cannot be set from a |modeline| or in the |sandbox|, for | |
6233 security reasons. | |
6234 | |
6235 *'shellredir'* *'srr'* | |
6236 'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1") | |
6237 global | |
6238 {not in Vi} | |
6239 String to be used to put the output of a filter command in a temporary | |
6240 file. See also |:!|. See |option-backslash| about including spaces | |
6241 and backslashes. | |
6242 The name of the temporary file can be represented by "%s" if necessary | |
6243 (the file name is appended automatically if no %s appears in the value | |
6244 of this option). | |
6245 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh" | |
6246 or "zsh" during initializations, the default becomes ">&". If the | |
6247 'shell' option is "sh", "ksh" or "bash" the default becomes | |
6248 ">%s 2>&1". This means that stderr is also included. | |
6249 For Win32, the Unix checks are done and additionally "cmd" is checked | |
6250 for, which makes the default ">%s 2>&1". Also, the same names with | |
6251 ".exe" appended are checked for. | |
6252 The initialization of this option is done after reading the ".vimrc" | |
6253 and the other initializations, so that when the 'shell' option is set | |
6254 there, the 'shellredir' option changes automatically unless it was | |
6255 explicitly set before. | |
6256 In the future pipes may be used for filtering and this option will | |
6257 become obsolete (at least for Unix). | |
6258 This option cannot be set from a |modeline| or in the |sandbox|, for | |
6259 security reasons. | |
6260 | |
6261 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'* | |
6262 'shellslash' 'ssl' boolean (default off) | |
6263 global | |
6264 {not in Vi} {only for MSDOS, MS-Windows and OS/2} | |
6265 When set, a forward slash is used when expanding file names. This is | |
6266 useful when a Unix-like shell is used instead of command.com or | |
6267 cmd.exe. Backward slashes can still be typed, but they are changed to | |
6268 forward slashes by Vim. | |
6269 Note that setting or resetting this option has no effect for some | |
6270 existing file names, thus this option needs to be set before opening | |
6271 any file for best results. This might change in the future. | |
6272 'shellslash' only works when a backslash can be used as a path | |
6273 separator. To test if this is so use: > | |
6274 if exists('+shellslash') | |
6275 < | |
168 | 6276 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'* |
6277 'shelltemp' 'stmp' boolean (Vi default off, Vim default on) | |
6278 global | |
6279 {not in Vi} | |
6280 When on, use temp files for shell commands. When off use a pipe. | |
6281 When using a pipe is not possible temp files are used anyway. | |
2965 | 6282 Currently a pipe is only supported on Unix and MS-Windows 2K and |
6283 later. You can check it with: > | |
168 | 6284 :if has("filterpipe") |
6285 < The advantage of using a pipe is that nobody can read the temp file | |
6286 and the 'shell' command does not need to support redirection. | |
6287 The advantage of using a temp file is that the file type and encoding | |
6288 can be detected. | |
6289 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|, | |
6290 |FilterWritePost| autocommands event are not triggered when | |
6291 'shelltemp' is off. | |
6292 | |
7 | 6293 *'shelltype'* *'st'* |
6294 'shelltype' 'st' number (default 0) | |
6295 global | |
6296 {not in Vi} {only for the Amiga} | |
6297 On the Amiga this option influences the way how the commands work | |
6298 which use a shell. | |
6299 0 and 1: always use the shell | |
6300 2 and 3: use the shell only to filter lines | |
6301 4 and 5: use shell only for ':sh' command | |
6302 When not using the shell, the command is executed directly. | |
6303 | |
6304 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands | |
6305 1 and 3: use "shell cmd" to start external commands | |
6306 | |
3371 | 6307 *'shellxescape'* *'sxe'* |
6308 'shellxescape' 'sxe' string (default: ""; | |
6309 for MS-DOS and MS-Windows: "\"&|<>()@^") | |
6310 global | |
6311 {not in Vi} | |
6312 When 'shellxquote' is set to "(" then the characters listed in this | |
6313 option will be escaped with a '^' character. This makes it possible | |
6314 to execute most external commands with cmd.exe. | |
6315 | |
7 | 6316 *'shellxquote'* *'sxq'* |
6317 'shellxquote' 'sxq' string (default: ""; | |
3359 | 6318 for Win32, when 'shell' is cmd.exe: "(" |
6319 for Win32, when 'shell' contains "sh" | |
6320 somewhere: "\"" | |
7 | 6321 for Unix, when using system(): "\"") |
6322 global | |
6323 {not in Vi} | |
6324 Quoting character(s), put around the command passed to the shell, for | |
6325 the "!" and ":!" commands. Includes the redirection. See | |
6326 'shellquote' to exclude the redirection. It's probably not useful | |
6327 to set both options. | |
3359 | 6328 When the value is '(' then ')' is appended. When the value is '"(' |
6329 then ')"' is appended. | |
6330 When the value is '(' then also see 'shellxescape'. | |
3352 | 6331 This is an empty string by default on most systems, but is known to be |
6332 useful for on Win32 version, either for cmd.exe which automatically | |
6333 strips off the first and last quote on a command, or 3rd-party shells | |
6334 such as the MKS Korn Shell or bash, where it should be "\"". The | |
6335 default is adjusted according the value of 'shell', to reduce the need | |
6336 to set this option by the user. See |dos-shell|. | |
7 | 6337 This option cannot be set from a |modeline| or in the |sandbox|, for |
6338 security reasons. | |
6339 | |
6340 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'* | |
6341 'shiftround' 'sr' boolean (default off) | |
6342 global | |
6343 {not in Vi} | |
6344 Round indent to multiple of 'shiftwidth'. Applies to > and < | |
6345 commands. CTRL-T and CTRL-D in Insert mode always round the indent to | |
6346 a multiple of 'shiftwidth' (this is Vi compatible). | |
6347 NOTE: This option is reset when 'compatible' is set. | |
6348 | |
6349 *'shiftwidth'* *'sw'* | |
6350 'shiftwidth' 'sw' number (default 8) | |
6351 local to buffer | |
10 | 6352 Number of spaces to use for each step of (auto)indent. Used for |
7 | 6353 |'cindent'|, |>>|, |<<|, etc. |
3893 | 6354 When zero the 'ts' value will be used. Use the |shiftwidth()| |
6355 function to get the effective shiftwidth value. | |
7 | 6356 |
6357 *'shortmess'* *'shm'* | |
168 | 6358 'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "", |
6359 POSIX default: "A") | |
7 | 6360 global |
6361 {not in Vi} | |
6362 This option helps to avoid all the |hit-enter| prompts caused by file | |
6363 messages, for example with CTRL-G, and to avoid some other messages. | |
6364 It is a list of flags: | |
6365 flag meaning when present ~ | |
6366 f use "(3 of 5)" instead of "(file 3 of 5)" | |
6367 i use "[noeol]" instead of "[Incomplete last line]" | |
6368 l use "999L, 888C" instead of "999 lines, 888 characters" | |
6369 m use "[+]" instead of "[Modified]" | |
6370 n use "[New]" instead of "[New File]" | |
6371 r use "[RO]" instead of "[readonly]" | |
6372 w use "[w]" instead of "written" for file write message | |
6373 and "[a]" instead of "appended" for ':w >> file' command | |
6374 x use "[dos]" instead of "[dos format]", "[unix]" instead of | |
6375 "[unix format]" and "[mac]" instead of "[mac format]". | |
6376 a all of the above abbreviations | |
6377 | |
6378 o overwrite message for writing a file with subsequent message | |
6379 for reading a file (useful for ":wn" or when 'autowrite' on) | |
6380 O message for reading a file overwrites any previous message. | |
6381 Also for quickfix message (e.g., ":cn"). | |
6382 s don't give "search hit BOTTOM, continuing at TOP" or "search | |
6383 hit TOP, continuing at BOTTOM" messages | |
6384 t truncate file message at the start if it is too long to fit | |
6385 on the command-line, "<" will appear in the left most column. | |
6386 Ignored in Ex mode. | |
6387 T truncate other messages in the middle if they are too long to | |
233 | 6388 fit on the command line. "..." will appear in the middle. |
7 | 6389 Ignored in Ex mode. |
6390 W don't give "written" or "[w]" when writing a file | |
6391 A don't give the "ATTENTION" message when an existing swap file | |
6392 is found. | |
6393 I don't give the intro message when starting Vim |:intro|. | |
5946 | 6394 c don't give |ins-completion-menu| messages. For example, |
6395 "-- XXX completion (YYY)", "match 1 of 2", "The only match", | |
6396 "Pattern not found", "Back at original", etc. | |
7 | 6397 |
6398 This gives you the opportunity to avoid that a change between buffers | |
6399 requires you to hit <Enter>, but still gives as useful a message as | |
6400 possible for the space available. To get the whole message that you | |
6401 would have got with 'shm' empty, use ":file!" | |
6402 Useful values: | |
6403 shm= No abbreviation of message. | |
6404 shm=a Abbreviation, but no loss of information. | |
6405 shm=at Abbreviation, and truncate message when necessary. | |
6406 | |
6407 NOTE: This option is set to the Vi default value when 'compatible' is | |
6408 set and to the Vim default value when 'compatible' is reset. | |
6409 | |
6410 *'shortname'* *'sn'* *'noshortname'* *'nosn'* | |
6411 'shortname' 'sn' boolean (default off) | |
6412 local to buffer | |
6413 {not in Vi, not in MS-DOS versions} | |
6414 Filenames are assumed to be 8 characters plus one extension of 3 | |
6415 characters. Multiple dots in file names are not allowed. When this | |
6416 option is on, dots in file names are replaced with underscores when | |
6417 adding an extension (".~" or ".swp"). This option is not available | |
6418 for MS-DOS, because then it would always be on. This option is useful | |
6419 when editing files on an MS-DOS compatible filesystem, e.g., messydos | |
6420 or crossdos. When running the Win32 GUI version under Win32s, this | |
6421 option is always on by default. | |
6422 | |
6423 *'showbreak'* *'sbr'* *E595* | |
6424 'showbreak' 'sbr' string (default "") | |
6425 global | |
6426 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
6427 {not available when compiled without the |+linebreak| |
7 | 6428 feature} |
6429 String to put at the start of lines that have been wrapped. Useful | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6430 values are "> " or "+++ ": > |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6431 :set showbreak=>\ |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6432 < Note the backslash to escape the trailing space. It's easier like |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6433 this: > |
2314
233eb4412f5d
Added 'colorcolumn' option. Partly by Gregor Uhlenheuer.
Bram Moolenaar <bram@vim.org>
parents:
2302
diff
changeset
|
6434 :let &showbreak = '+++ ' |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6435 < Only printable single-cell characters are allowed, excluding <Tab> and |
7 | 6436 comma (in a future version the comma might be used to separate the |
6437 part that is shown at the end and at the start of a line). | |
6438 The characters are highlighted according to the '@' flag in | |
6439 'highlight'. | |
6440 Note that tabs after the showbreak will be displayed differently. | |
6441 If you want the 'showbreak' to appear in between line numbers, add the | |
6442 "n" flag to 'cpoptions'. | |
6443 | |
6444 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'* | |
6445 'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default: | |
6446 off) | |
6447 global | |
6448 {not in Vi} | |
6449 {not available when compiled without the | |
6450 |+cmdline_info| feature} | |
1152 | 6451 Show (partial) command in the last line of the screen. Set this |
6452 option off if your terminal is slow. | |
7 | 6453 In Visual mode the size of the selected area is shown: |
6454 - When selecting characters within a line, the number of characters. | |
2324
0a258a67051d
In Visual mode with 'showcmd' display the number of bytes and characters.
Bram Moolenaar <bram@vim.org>
parents:
2317
diff
changeset
|
6455 If the number of bytes is different it is also displayed: "2-6" |
0a258a67051d
In Visual mode with 'showcmd' display the number of bytes and characters.
Bram Moolenaar <bram@vim.org>
parents:
2317
diff
changeset
|
6456 means two characters and six bytes. |
7 | 6457 - When selecting more than one line, the number of lines. |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6458 - When selecting a block, the size in screen characters: |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6459 {lines}x{columns}. |
7 | 6460 NOTE: This option is set to the Vi default value when 'compatible' is |
6461 set and to the Vim default value when 'compatible' is reset. | |
6462 | |
6463 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'* | |
6464 'showfulltag' 'sft' boolean (default off) | |
6465 global | |
6466 {not in Vi} | |
6467 When completing a word in insert mode (see |ins-completion|) from the | |
6468 tags file, show both the tag name and a tidied-up form of the search | |
10 | 6469 pattern (if there is one) as possible matches. Thus, if you have |
7 | 6470 matched a C function, you can see a template for what arguments are |
6471 required (coding style permitting). | |
1621 | 6472 Note that this doesn't work well together with having "longest" in |
6473 'completeopt', because the completion from the search pattern may not | |
6474 match the typed text. | |
7 | 6475 |
6476 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'* | |
6477 'showmatch' 'sm' boolean (default off) | |
6478 global | |
6479 When a bracket is inserted, briefly jump to the matching one. The | |
6480 jump is only done if the match can be seen on the screen. The time to | |
6481 show the match can be set with 'matchtime'. | |
6482 A Beep is given if there is no match (no matter if the match can be | |
6483 seen or not). This option is reset when the 'paste' option is set. | |
6484 When the 'm' flag is not included in 'cpoptions', typing a character | |
6485 will immediately move the cursor back to where it belongs. | |
6486 See the "sm" field in 'guicursor' for setting the cursor shape and | |
6487 blinking when showing the match. | |
6488 The 'matchpairs' option can be used to specify the characters to show | |
6489 matches for. 'rightleft' and 'revins' are used to look for opposite | |
6490 matches. | |
699 | 6491 Also see the matchparen plugin for highlighting the match when moving |
6492 around |pi_paren.txt|. | |
6493 Note: Use of the short form is rated PG. | |
7 | 6494 |
6495 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'* | |
6496 'showmode' 'smd' boolean (Vim default: on, Vi default: off) | |
6497 global | |
6498 If in Insert, Replace or Visual mode put a message on the last line. | |
6499 Use the 'M' flag in 'highlight' to set the type of highlighting for | |
6500 this message. | |
10 | 6501 When |XIM| may be used the message will include "XIM". But this |
7 | 6502 doesn't mean XIM is really active, especially when 'imactivatekey' is |
6503 not set. | |
6504 NOTE: This option is set to the Vi default value when 'compatible' is | |
6505 set and to the Vim default value when 'compatible' is reset. | |
6506 | |
677 | 6507 *'showtabline'* *'stal'* |
6508 'showtabline' 'stal' number (default 1) | |
6509 global | |
6510 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
6511 {not available when compiled without the |+windows| |
677 | 6512 feature} |
6513 The value of this option specifies when the line with tab page labels | |
6514 will be displayed: | |
6515 0: never | |
6516 1: only if there are at least two tab pages | |
6517 2: always | |
6518 This is both for the GUI and non-GUI implementation of the tab pages | |
6519 line. | |
6520 See |tab-page| for more information about tab pages. | |
6521 | |
7 | 6522 *'sidescroll'* *'ss'* |
6523 'sidescroll' 'ss' number (default 0) | |
6524 global | |
6525 {not in Vi} | |
6526 The minimal number of columns to scroll horizontally. Used only when | |
6527 the 'wrap' option is off and the cursor is moved off of the screen. | |
6528 When it is zero the cursor will be put in the middle of the screen. | |
6529 When using a slow terminal set it to a large number or 0. When using | |
6530 a fast terminal use a small number or 1. Not used for "zh" and "zl" | |
6531 commands. | |
6532 | |
6533 *'sidescrolloff'* *'siso'* | |
6534 'sidescrolloff' 'siso' number (default 0) | |
6535 global | |
6536 {not in Vi} | |
6537 The minimal number of screen columns to keep to the left and to the | |
534 | 6538 right of the cursor if 'nowrap' is set. Setting this option to a |
6539 value greater than 0 while having |'sidescroll'| also at a non-zero | |
6540 value makes some context visible in the line you are scrolling in | |
6541 horizontally (except at beginning of the line). Setting this option | |
6542 to a large value (like 999) has the effect of keeping the cursor | |
6543 horizontally centered in the window, as long as one does not come too | |
6544 close to the beginning of the line. | |
7 | 6545 NOTE: This option is set to 0 when 'compatible' is set. |
6546 | |
6547 Example: Try this together with 'sidescroll' and 'listchars' as | |
6548 in the following example to never allow the cursor to move | |
6549 onto the "extends" character: | |
6550 | |
6551 :set nowrap sidescroll=1 listchars=extends:>,precedes:< | |
6552 :set sidescrolloff=1 | |
6553 | |
6554 | |
6555 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'* | |
6556 'smartcase' 'scs' boolean (default off) | |
6557 global | |
6558 {not in Vi} | |
6559 Override the 'ignorecase' option if the search pattern contains upper | |
6560 case characters. Only used when the search pattern is typed and | |
6561 'ignorecase' option is on. Used for the commands "/", "?", "n", "N", | |
3557 | 6562 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After |
7 | 6563 "*" and "#" you can make 'smartcase' used by doing a "/" command, |
6564 recalling the search pattern from history and hitting <Enter>. | |
6565 NOTE: This option is reset when 'compatible' is set. | |
6566 | |
6567 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'* | |
6568 'smartindent' 'si' boolean (default off) | |
6569 local to buffer | |
6570 {not in Vi} | |
6571 {not available when compiled without the | |
6572 |+smartindent| feature} | |
6573 Do smart autoindenting when starting a new line. Works for C-like | |
6574 programs, but can also be used for other languages. 'cindent' does | |
6575 something like this, works better in most cases, but is more strict, | |
2662 | 6576 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set, |
2642 | 6577 setting 'si' has no effect. 'indentexpr' is a more advanced |
6578 alternative. | |
7 | 6579 Normally 'autoindent' should also be on when using 'smartindent'. |
6580 An indent is automatically inserted: | |
6581 - After a line ending in '{'. | |
6582 - After a line starting with a keyword from 'cinwords'. | |
6583 - Before a line starting with '}' (only with the "O" command). | |
6584 When typing '}' as the first character in a new line, that line is | |
6585 given the same indent as the matching '{'. | |
6586 When typing '#' as the first character in a new line, the indent for | |
6587 that line is removed, the '#' is put in the first column. The indent | |
10 | 6588 is restored for the next line. If you don't want this, use this |
7 | 6589 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H. |
6590 When using the ">>" command, lines starting with '#' are not shifted | |
6591 right. | |
10 | 6592 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste' |
7 | 6593 is set smart indenting is disabled. |
6594 | |
6595 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'* | |
6596 'smarttab' 'sta' boolean (default off) | |
6597 global | |
6598 {not in Vi} | |
6599 When on, a <Tab> in front of a line inserts blanks according to | |
648 | 6600 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A |
6601 <BS> will delete a 'shiftwidth' worth of space at the start of the | |
6602 line. | |
650 | 6603 When off, a <Tab> always inserts blanks according to 'tabstop' or |
648 | 6604 'softtabstop'. 'shiftwidth' is only used for shifting text left or |
6605 right |shift-left-right|. | |
1263 | 6606 What gets inserted (a <Tab> or spaces) depends on the 'expandtab' |
7 | 6607 option. Also see |ins-expandtab|. When 'expandtab' is not set, the |
11 | 6608 number of spaces is minimized by using <Tab>s. |
7 | 6609 NOTE: This option is reset when 'compatible' is set. |
6610 | |
6611 *'softtabstop'* *'sts'* | |
6612 'softtabstop' 'sts' number (default 0) | |
6613 local to buffer | |
6614 {not in Vi} | |
6615 Number of spaces that a <Tab> counts for while performing editing | |
6616 operations, like inserting a <Tab> or using <BS>. It "feels" like | |
6617 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is | |
6618 used. This is useful to keep the 'ts' setting at its standard value | |
6619 of 8, while being able to edit like it is set to 'sts'. However, | |
6620 commands like "x" still work on the actual characters. | |
6621 When 'sts' is zero, this feature is off. | |
3893 | 6622 When 'sts' is negative, the value of 'shiftwidth' is used. |
7 | 6623 'softtabstop' is set to 0 when the 'paste' option is set. |
6624 See also |ins-expandtab|. When 'expandtab' is not set, the number of | |
6625 spaces is minimized by using <Tab>s. | |
6626 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is | |
6627 set. | |
6628 NOTE: This option is set to 0 when 'compatible' is set. | |
6629 | |
221 | 6630 *'spell'* *'nospell'* |
6631 'spell' boolean (default off) | |
6632 local to window | |
6633 {not in Vi} | |
6634 {not available when compiled without the |+syntax| | |
6635 feature} | |
6636 When on spell checking will be done. See |spell|. | |
236 | 6637 The languages are specified with 'spelllang'. |
221 | 6638 |
386 | 6639 *'spellcapcheck'* *'spc'* |
389 | 6640 'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+") |
386 | 6641 local to buffer |
6642 {not in Vi} | |
6643 {not available when compiled without the |+syntax| | |
6644 feature} | |
6645 Pattern to locate the end of a sentence. The following word will be | |
6646 checked to start with a capital letter. If not then it is highlighted | |
484 | 6647 with SpellCap |hl-SpellCap| (unless the word is also badly spelled). |
386 | 6648 When this check is not wanted make this option empty. |
6649 Only used when 'spell' is set. | |
389 | 6650 Be careful with special characters, see |option-backslash| about |
6651 including spaces and backslashes. | |
480 | 6652 To set this option automatically depending on the language, see |
6653 |set-spc-auto|. | |
386 | 6654 |
314 | 6655 *'spellfile'* *'spf'* |
6656 'spellfile' 'spf' string (default empty) | |
6657 local to buffer | |
6658 {not in Vi} | |
6659 {not available when compiled without the |+syntax| | |
6660 feature} | |
6661 Name of the word list file where words are added for the |zg| and |zw| | |
401 | 6662 commands. It must end in ".{encoding}.add". You need to include the |
6663 path, otherwise the file is placed in the current directory. | |
386 | 6664 *E765* |
6665 It may also be a comma separated list of names. A count before the | |
6666 |zg| and |zw| commands can be used to access each. This allows using | |
6667 a personal word list file and a project word list file. | |
314 | 6668 When a word is added while this option is empty Vim will set it for |
819 | 6669 you: Using the first directory in 'runtimepath' that is writable. If |
6670 there is no "spell" directory yet it will be created. For the file | |
6671 name the first language name that appears in 'spelllang' is used, | |
353 | 6672 ignoring the region. |
6673 The resulting ".spl" file will be used for spell checking, it does not | |
6674 have to appear in 'spelllang'. | |
6675 Normally one file is used for all regions, but you can add the region | |
6676 name if you want to. However, it will then only be used when | |
6677 'spellfile' is set to it, for entries in 'spelllang' only files | |
6678 without region name will be found. | |
336 | 6679 This option cannot be set from a |modeline| or in the |sandbox|, for |
6680 security reasons. | |
314 | 6681 |
221 | 6682 *'spelllang'* *'spl'* |
314 | 6683 'spelllang' 'spl' string (default "en") |
221 | 6684 local to buffer |
6685 {not in Vi} | |
6686 {not available when compiled without the |+syntax| | |
6687 feature} | |
353 | 6688 A comma separated list of word list names. When the 'spell' option is |
6689 on spellchecking will be done for these languages. Example: > | |
6690 set spelllang=en_us,nl,medical | |
6691 < This means US English, Dutch and medical words are recognized. Words | |
6692 that are not recognized will be highlighted. | |
6693 The word list name must not include a comma or dot. Using a dash is | |
6694 recommended to separate the two letter language name from a | |
6695 specification. Thus "en-rare" is used for rare English words. | |
6696 A region name must come last and have the form "_xx", where "xx" is | |
6697 the two-letter, lower case region name. You can use more than one | |
6698 region by listing them: "en_us,en_ca" supports both US and Canadian | |
6699 English, but not words specific for Australia, New Zealand or Great | |
6700 Britain. | |
5477 | 6701 If the name "cjk" is included East Asian characters are excluded from |
6702 spell checking. This is useful when editing text that also has Asian | |
6703 words. | |
484 | 6704 *E757* |
419 | 6705 As a special case the name of a .spl file can be given as-is. The |
6706 first "_xx" in the name is removed and used as the region name | |
6707 (_xx is an underscore, two letters and followed by a non-letter). | |
6708 This is mainly for testing purposes. You must make sure the correct | |
6709 encoding is used, Vim doesn't check it. | |
236 | 6710 When 'encoding' is set the word lists are reloaded. Thus it's a good |
419 | 6711 idea to set 'spelllang' after setting 'encoding' to avoid loading the |
6712 files twice. | |
353 | 6713 How the related spell files are found is explained here: |spell-load|. |
221 | 6714 |
653 | 6715 If the |spellfile.vim| plugin is active and you use a language name |
6716 for which Vim cannot find the .spl file in 'runtimepath' the plugin | |
6717 will ask you if you want to download the file. | |
6718 | |
480 | 6719 After this option has been set successfully, Vim will source the files |
6720 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang' | |
650 | 6721 up to the first comma, dot or underscore. |
6722 Also see |set-spc-auto|. | |
480 | 6723 |
6724 | |
344 | 6725 *'spellsuggest'* *'sps'* |
6726 'spellsuggest' 'sps' string (default "best") | |
6727 global | |
6728 {not in Vi} | |
6729 {not available when compiled without the |+syntax| | |
6730 feature} | |
593 | 6731 Methods used for spelling suggestions. Both for the |z=| command and |
374 | 6732 the |spellsuggest()| function. This is a comma-separated list of |
6733 items: | |
6734 | |
6735 best Internal method that works best for English. Finds | |
6736 changes like "fast" and uses a bit of sound-a-like | |
6737 scoring to improve the ordering. | |
6738 | |
6739 double Internal method that uses two methods and mixes the | |
6740 results. The first method is "fast", the other method | |
344 | 6741 computes how much the suggestion sounds like the bad |
374 | 6742 word. That only works when the language specifies |
6743 sound folding. Can be slow and doesn't always give | |
6744 better results. | |
6745 | |
6746 fast Internal method that only checks for simple changes: | |
6747 character inserts/deletes/swaps. Works well for | |
6748 simple typing mistakes. | |
6749 | |
593 | 6750 {number} The maximum number of suggestions listed for |z=|. |
484 | 6751 Not used for |spellsuggest()|. The number of |
6752 suggestions is never more than the value of 'lines' | |
6753 minus two. | |
6754 | |
374 | 6755 file:{filename} Read file {filename}, which must have two columns, |
6756 separated by a slash. The first column contains the | |
6757 bad word, the second column the suggested good word. | |
6758 Example: | |
6759 theribal/terrible ~ | |
6760 Use this for common mistakes that do not appear at the | |
6761 top of the suggestion list with the internal methods. | |
6762 Lines without a slash are ignored, use this for | |
6763 comments. | |
5862 | 6764 The word in the second column must be correct, |
6765 otherwise it will not be used. Add the word to an | |
6766 ".add" file if it is currently flagged as a spelling | |
6767 mistake. | |
374 | 6768 The file is used for all languages. |
6769 | |
6770 expr:{expr} Evaluate expression {expr}. Use a function to avoid | |
6771 trouble with spaces. |v:val| holds the badly spelled | |
6772 word. The expression must evaluate to a List of | |
6773 Lists, each with a suggestion and a score. | |
6774 Example: | |
6775 [['the', 33], ['that', 44]] | |
593 | 6776 Set 'verbose' and use |z=| to see the scores that the |
374 | 6777 internal methods use. A lower score is better. |
6778 This may invoke |spellsuggest()| if you temporarily | |
6779 set 'spellsuggest' to exclude the "expr:" part. | |
6780 Errors are silently ignored, unless you set the | |
6781 'verbose' option to a non-zero value. | |
6782 | |
6783 Only one of "best", "double" or "fast" may be used. The others may | |
6784 appear several times in any order. Example: > | |
6785 :set sps=file:~/.vim/sugg,best,expr:MySuggest() | |
6786 < | |
6787 This option cannot be set from a |modeline| or in the |sandbox|, for | |
6788 security reasons. | |
344 | 6789 |
6790 | |
7 | 6791 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'* |
6792 'splitbelow' 'sb' boolean (default off) | |
6793 global | |
6794 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
6795 {not available when compiled without the |+windows| |
7 | 6796 feature} |
6797 When on, splitting a window will put the new window below the current | |
6798 one. |:split| | |
6799 | |
6800 *'splitright'* *'spr'* *'nosplitright'* *'nospr'* | |
6801 'splitright' 'spr' boolean (default off) | |
6802 global | |
6803 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
6804 {not available when compiled without the |+vertsplit| |
7 | 6805 feature} |
6806 When on, splitting a window will put the new window right of the | |
6807 current one. |:vsplit| | |
6808 | |
6809 *'startofline'* *'sol'* *'nostartofline'* *'nosol'* | |
6810 'startofline' 'sol' boolean (default on) | |
6811 global | |
6812 {not in Vi} | |
6813 When "on" the commands listed below move the cursor to the first | |
11 | 6814 non-blank of the line. When off the cursor is kept in the same column |
10 | 6815 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B, |
11 | 6816 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>" |
7 | 6817 with a linewise operator, with "%" with a count and to buffer changing |
6818 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that | |
6819 only has a line number, e.g., ":25" or ":+". | |
6820 In case of buffer changing commands the cursor is placed at the column | |
6821 where it was the last time the buffer was edited. | |
6822 NOTE: This option is set when 'compatible' is set. | |
6823 | |
2709 | 6824 *'statusline'* *'stl'* *E540* *E542* |
7 | 6825 'statusline' 'stl' string (default empty) |
40 | 6826 global or local to window |global-local| |
7 | 6827 {not in Vi} |
6828 {not available when compiled without the |+statusline| | |
6829 feature} | |
6830 When nonempty, this option determines the content of the status line. | |
6831 Also see |status-line|. | |
6832 | |
6833 The option consists of printf style '%' items interspersed with | |
6834 normal text. Each status line item is of the form: | |
6835 %-0{minwid}.{maxwid}{item} | |
6836 All fields except the {item} is optional. A single percent sign can | |
2709 | 6837 be given as "%%". Up to 80 items can be specified. *E541* |
7 | 6838 |
680 | 6839 When the option starts with "%!" then it is used as an expression, |
6840 evaluated and the result is used as the option value. Example: > | |
6841 :set statusline=%!MyStatusLine() | |
6842 < The result can contain %{} items that will be evaluated too. | |
3445 | 6843 Note that the "%!" expression is evaluated in the context of the |
6844 current window and buffer, while %{} items are evaluated in the | |
6845 context of the window that the statusline belongs to. | |
680 | 6846 |
6847 When there is error while evaluating the option then it will be made | |
6848 empty to avoid further errors. Otherwise screen updating would loop. | |
6849 | |
7 | 6850 Note that the only effect of 'ruler' when this option is set (and |
6851 'laststatus' is 2) is controlling the output of |CTRL-G|. | |
6852 | |
6853 field meaning ~ | |
233 | 6854 - Left justify the item. The default is right justified |
7 | 6855 when minwid is larger than the length of the item. |
233 | 6856 0 Leading zeroes in numeric items. Overridden by '-'. |
7 | 6857 minwid Minimum width of the item, padding as set by '-' & '0'. |
6858 Value must be 50 or less. | |
10 | 6859 maxwid Maximum width of the item. Truncation occurs with a '<' |
7 | 6860 on the left for text items. Numeric items will be |
6861 shifted down to maxwid-2 digits followed by '>'number | |
6862 where number is the amount of missing digits, much like | |
6863 an exponential notation. | |
6864 item A one letter code as described below. | |
6865 | |
6866 Following is a description of the possible statusline items. The | |
6867 second character in "item" is the type: | |
6868 N for number | |
6869 S for string | |
6870 F for flags as described below | |
6871 - not applicable | |
6872 | |
6873 item meaning ~ | |
1152 | 6874 f S Path to the file in the buffer, as typed or relative to current |
6875 directory. | |
7 | 6876 F S Full path to the file in the buffer. |
6877 t S File name (tail) of file in the buffer. | |
1698 | 6878 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off. |
7 | 6879 M F Modified flag, text is ",+" or ",-". |
1698 | 6880 r F Readonly flag, text is "[RO]". |
7 | 6881 R F Readonly flag, text is ",RO". |
1698 | 6882 h F Help buffer flag, text is "[help]". |
7 | 6883 H F Help buffer flag, text is ",HLP". |
1698 | 6884 w F Preview window flag, text is "[Preview]". |
7 | 6885 W F Preview window flag, text is ",PRV". |
1698 | 6886 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'. |
7 | 6887 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'. |
6888 {not available when compiled without |+autocmd| feature} | |
2411
68e394361ca3
Add "q" item for 'statusline'. Add w:quickfix_title. (Lech Lorens)
Bram Moolenaar <bram@vim.org>
parents:
2400
diff
changeset
|
6889 q S "[Quickfix List]", "[Location List]" or empty. |
7 | 6890 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are |
6891 being used: "<keymap>" | |
6892 n N Buffer number. | |
2709 | 6893 b N Value of character under cursor. |
7 | 6894 B N As above, in hexadecimal. |
6895 o N Byte number in file of byte under cursor, first byte is 1. | |
6896 Mnemonic: Offset from start of file (with one added) | |
6897 {not available when compiled without |+byte_offset| feature} | |
6898 O N As above, in hexadecimal. | |
233 | 6899 N N Printer page number. (Only works in the 'printheader' option.) |
7 | 6900 l N Line number. |
6901 L N Number of lines in buffer. | |
6902 c N Column number. | |
6903 v N Virtual column number. | |
10 | 6904 V N Virtual column number as -{num}. Not displayed if equal to 'c'. |
7 | 6905 p N Percentage through file in lines as in |CTRL-G|. |
6906 P S Percentage through file of displayed window. This is like the | |
5055 | 6907 percentage described for 'ruler'. Always 3 in length, unless |
6908 translated. | |
233 | 6909 a S Argument list status as in default title. ({current} of {max}) |
7 | 6910 Empty if the argument file count is zero or one. |
680 | 6911 { NF Evaluate expression between '%{' and '}' and substitute result. |
625 | 6912 Note that there is no '%' before the closing '}'. |
7 | 6913 ( - Start of item group. Can be used for setting the width and |
6914 alignment of a section. Must be followed by %) somewhere. | |
6915 ) - End of item group. No width fields allowed. | |
681 | 6916 T N For 'tabline': start of tab page N label. Use %T after the last |
6917 label. This information is used for mouse clicks. | |
6918 X N For 'tabline': start of close tab N label. Use %X after the | |
6919 label, e.g.: %3Xclose%X. Use %999X for a "close current tab" | |
6920 mark. This information is used for mouse clicks. | |
7 | 6921 < - Where to truncate line if too long. Default is at the start. |
6922 No width fields allowed. | |
6923 = - Separation point between left and right aligned items. | |
6924 No width fields allowed. | |
680 | 6925 # - Set highlight group. The name must follow and then a # again. |
6926 Thus use %#HLname# for highlight group HLname. The same | |
6927 highlighting is used, also for the statusline of non-current | |
6928 windows. | |
7 | 6929 * - Set highlight group to User{N}, where {N} is taken from the |
233 | 6930 minwid field, e.g. %1*. Restore normal highlight with %* or %0*. |
7 | 6931 The difference between User{N} and StatusLine will be applied |
6932 to StatusLineNC for the statusline of non-current windows. | |
6933 The number N must be between 1 and 9. See |hl-User1..9| | |
6934 | |
1698 | 6935 When displaying a flag, Vim removes the leading comma, if any, when |
6936 that flag comes right after plaintext. This will make a nice display | |
6937 when flags are used like in the examples below. | |
7 | 6938 |
233 | 6939 When all items in a group becomes an empty string (i.e. flags that are |
7 | 6940 not set) and a minwid is not set for the group, the whole group will |
6941 become empty. This will make a group like the following disappear | |
6942 completely from the statusline when none of the flags are set. > | |
6943 :set statusline=...%(\ [%M%R%H]%)... | |
6944 < | |
6945 Beware that an expression is evaluated each and every time the status | |
6946 line is displayed. The current buffer and current window will be set | |
6947 temporarily to that of the window (and buffer) whose statusline is | |
233 | 6948 currently being drawn. The expression will evaluate in this context. |
7 | 6949 The variable "actual_curbuf" is set to the 'bufnr()' number of the |
634 | 6950 real current buffer. |
6951 | |
3682 | 6952 The 'statusline' option will be evaluated in the |sandbox| if set from |
6953 a modeline, see |sandbox-option|. | |
634 | 6954 |
6955 It is not allowed to change text or jump to another window while | |
6956 evaluating 'statusline' |textlock|. | |
7 | 6957 |
6958 If the statusline is not updated when you want it (e.g., after setting | |
6959 a variable that's used in an expression), you can force an update by | |
6960 setting an option without changing its value. Example: > | |
6961 :let &ro = &ro | |
6962 | |
6963 < A result of all digits is regarded a number for display purposes. | |
6964 Otherwise the result is taken as flag text and applied to the rules | |
6965 described above. | |
6966 | |
199 | 6967 Watch out for errors in expressions. They may render Vim unusable! |
7 | 6968 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and |
6969 edit your .vimrc or whatever with "vim -u NONE" to get it right. | |
6970 | |
6971 Examples: | |
6972 Emulate standard status line with 'ruler' set > | |
6973 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P | |
6974 < Similar, but add ASCII value of char under the cursor (like "ga") > | |
6975 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P | |
6976 < Display byte count and byte value, modified flag in red. > | |
6977 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b' | |
6978 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red | |
6979 < Display a ,GZ flag if a compressed file is loaded > | |
6980 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h... | |
6981 < In the |:autocmd|'s: > | |
6982 :let b:gzflag = 1 | |
6983 < And: > | |
6984 :unlet b:gzflag | |
6985 < And define this function: > | |
6986 :function VarExists(var, val) | |
6987 : if exists(a:var) | return a:val | else | return '' | endif | |
6988 :endfunction | |
6989 < | |
6990 *'suffixes'* *'su'* | |
6991 'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj") | |
6992 global | |
6993 {not in Vi} | |
6994 Files with these suffixes get a lower priority when multiple files | |
6995 match a wildcard. See |suffixes|. Commas can be used to separate the | |
10 | 6996 suffixes. Spaces after the comma are ignored. A dot is also seen as |
6997 the start of a suffix. To avoid a dot or comma being recognized as a | |
7 | 6998 separator, precede it with a backslash (see |option-backslash| about |
6999 including spaces and backslashes). | |
7000 See 'wildignore' for completely ignoring files. | |
7001 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
7002 suffixes from the list. This avoids problems when a future version | |
7003 uses another default. | |
7004 | |
7005 *'suffixesadd'* *'sua'* | |
7006 'suffixesadd' 'sua' string (default "") | |
7007 local to buffer | |
7008 {not in Vi} | |
7009 {not available when compiled without the | |
7010 |+file_in_path| feature} | |
7011 Comma separated list of suffixes, which are used when searching for a | |
7012 file for the "gf", "[I", etc. commands. Example: > | |
7013 :set suffixesadd=.java | |
7014 < | |
7015 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'* | |
7016 'swapfile' 'swf' boolean (default on) | |
7017 local to buffer | |
7018 {not in Vi} | |
10 | 7019 Use a swapfile for the buffer. This option can be reset when a |
7 | 7020 swapfile is not wanted for a specific buffer. For example, with |
7021 confidential information that even root must not be able to access. | |
7022 Careful: All text will be in memory: | |
7023 - Don't use this for big files. | |
7024 - Recovery will be impossible! | |
7025 A swapfile will only be present when |'updatecount'| is non-zero and | |
7026 'swapfile' is set. | |
7027 When 'swapfile' is reset, the swap file for the current buffer is | |
7028 immediately deleted. When 'swapfile' is set, and 'updatecount' is | |
7029 non-zero, a swap file is immediately created. | |
7030 Also see |swap-file| and |'swapsync'|. | |
5763 | 7031 If you want to open a new buffer without creating a swap file for it, |
7032 use the |:noswapfile| modifier. | |
7 | 7033 |
7034 This option is used together with 'bufhidden' and 'buftype' to | |
7035 specify special kinds of buffers. See |special-buffers|. | |
7036 | |
7037 *'swapsync'* *'sws'* | |
7038 'swapsync' 'sws' string (default "fsync") | |
7039 global | |
7040 {not in Vi} | |
7041 When this option is not empty a swap file is synced to disk after | |
10 | 7042 writing to it. This takes some time, especially on busy unix systems. |
7 | 7043 When this option is empty parts of the swap file may be in memory and |
7044 not written to disk. When the system crashes you may lose more work. | |
7045 On Unix the system does a sync now and then without Vim asking for it, | |
7046 so the disadvantage of setting this option off is small. On some | |
7047 systems the swap file will not be written at all. For a unix system | |
7048 setting it to "sync" will use the sync() call instead of the default | |
7049 fsync(), which may work better on some systems. | |
36 | 7050 The 'fsync' option is used for the actual file. |
7 | 7051 |
7052 *'switchbuf'* *'swb'* | |
7053 'switchbuf' 'swb' string (default "") | |
7054 global | |
7055 {not in Vi} | |
7056 This option controls the behavior when switching between buffers. | |
7057 Possible values (comma separated list): | |
7058 useopen If included, jump to the first open window that | |
7059 contains the specified buffer (if there is one). | |
7060 Otherwise: Do not examine other windows. | |
7061 This setting is checked with |quickfix| commands, when | |
7062 jumping to errors (":cc", ":cn", "cp", etc.). It is | |
7063 also used in all buffer related split commands, for | |
7064 example ":sbuffer", ":sbnext", or ":sbrewind". | |
825 | 7065 usetab Like "useopen", but also consider windows in other tab |
856 | 7066 pages. |
7 | 7067 split If included, split the current window before loading |
3153 | 7068 a buffer for a |quickfix| command that display errors. |
7069 Otherwise: do not split, use current window. | |
6843 | 7070 vsplit Just like "split" but split vertically. |
1621 | 7071 newtab Like "split", but open a new tab page. Overrules |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
7072 "split" when both are present. |
7 | 7073 |
410 | 7074 *'synmaxcol'* *'smc'* |
7075 'synmaxcol' 'smc' number (default 3000) | |
7076 local to buffer | |
7077 {not in Vi} | |
7078 {not available when compiled without the |+syntax| | |
7079 feature} | |
419 | 7080 Maximum column in which to search for syntax items. In long lines the |
7081 text after this column is not highlighted and following lines may not | |
7082 be highlighted correctly, because the syntax state is cleared. | |
410 | 7083 This helps to avoid very slow redrawing for an XML file that is one |
7084 long line. | |
7085 Set to zero to remove the limit. | |
7086 | |
7 | 7087 *'syntax'* *'syn'* |
7088 'syntax' 'syn' string (default empty) | |
7089 local to buffer | |
7090 {not in Vi} | |
7091 {not available when compiled without the |+syntax| | |
7092 feature} | |
7093 When this option is set, the syntax with this name is loaded, unless | |
7094 syntax highlighting has been switched off with ":syntax off". | |
7095 Otherwise this option does not always reflect the current syntax (the | |
7096 b:current_syntax variable does). | |
7097 This option is most useful in a modeline, for a file which syntax is | |
782 | 7098 not automatically recognized. Example, in an IDL file: |
7099 /* vim: set syntax=idl : */ ~ | |
7100 When a dot appears in the value then this separates two filetype | |
7101 names. Example: | |
7102 /* vim: set syntax=c.doxygen : */ ~ | |
7103 This will use the "c" syntax first, then the "doxygen" syntax. | |
7104 Note that the second one must be prepared to be loaded as an addition, | |
7105 otherwise it will be skipped. More than one dot may appear. | |
7106 To switch off syntax highlighting for the current file, use: > | |
7 | 7107 :set syntax=OFF |
7108 < To switch syntax highlighting on according to the current value of the | |
7109 'filetype' option: > | |
7110 :set syntax=ON | |
7111 < What actually happens when setting the 'syntax' option is that the | |
7112 Syntax autocommand event is triggered with the value as argument. | |
7113 This option is not copied to another buffer, independent of the 's' or | |
7114 'S' flag in 'cpoptions'. | |
36 | 7115 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
7 | 7116 |
699 | 7117 *'tabline'* *'tal'* |
677 | 7118 'tabline' 'tal' string (default empty) |
674 | 7119 global |
7120 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
7121 {not available when compiled without the |+windows| |
674 | 7122 feature} |
677 | 7123 When nonempty, this option determines the content of the tab pages |
7124 line at the top of the Vim window. When empty Vim will use a default | |
681 | 7125 tab pages line. See |setting-tabline| for more info. |
677 | 7126 |
7127 The tab pages line only appears as specified with the 'showtabline' | |
688 | 7128 option and only when there is no GUI tab line. When 'e' is in |
7129 'guioptions' and the GUI supports a tab line 'guitablabel' is used | |
2572
ee53a39d5896
Last changes for the 7.3 release!
Bram Moolenaar <bram@vim.org>
parents:
2570
diff
changeset
|
7130 instead. Note that the two tab pages lines are very different. |
677 | 7131 |
7132 The value is evaluated like with 'statusline'. You can use | |
7133 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out | |
681 | 7134 the text to be displayed. Use "%1T" for the first label, "%2T" for |
7135 the second one, etc. Use "%X" items for closing labels. | |
677 | 7136 |
7137 Keep in mind that only one of the tab pages is the current one, others | |
7138 are invisible and you can't jump to their windows. | |
7139 | |
674 | 7140 |
699 | 7141 *'tabpagemax'* *'tpm'* |
7142 'tabpagemax' 'tpm' number (default 10) | |
7143 global | |
7144 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
7145 {not available when compiled without the |+windows| |
699 | 7146 feature} |
7147 Maximum number of tab pages to be opened by the |-p| command line | |
7148 argument or the ":tab all" command. |tabpage| | |
7149 | |
7150 | |
7151 *'tabstop'* *'ts'* | |
7 | 7152 'tabstop' 'ts' number (default 8) |
7153 local to buffer | |
7154 Number of spaces that a <Tab> in the file counts for. Also see | |
7155 |:retab| command, and 'softtabstop' option. | |
7156 | |
7157 Note: Setting 'tabstop' to any other value than 8 can make your file | |
7158 appear wrong in many places (e.g., when printing it). | |
7159 | |
7160 There are four main ways to use tabs in Vim: | |
7161 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4 | |
7162 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim | |
1263 | 7163 will use a mix of tabs and spaces, but typing <Tab> and <BS> will |
7 | 7164 behave like a tab appears every 4 (or 3) characters. |
7165 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use | |
7166 'expandtab'. This way you will always insert spaces. The | |
7167 formatting will never be messed up when 'tabstop' is changed. | |
7168 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a | |
10 | 7169 |modeline| to set these values when editing the file again. Only |
7 | 7170 works when using Vim to edit the file. |
7171 4. Always set 'tabstop' and 'shiftwidth' to the same value, and | |
7172 'noexpandtab'. This should then work (for initial indents only) | |
7173 for any tabstop setting that people use. It might be nice to have | |
7174 tabs after the first non-blank inserted as spaces if you do this | |
7175 though. Otherwise aligned comments will be wrong when 'tabstop' is | |
7176 changed. | |
7177 | |
7178 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'* | |
7179 'tagbsearch' 'tbs' boolean (default on) | |
7180 global | |
7181 {not in Vi} | |
7182 When searching for a tag (e.g., for the |:ta| command), Vim can either | |
10 | 7183 use a binary search or a linear search in a tags file. Binary |
7 | 7184 searching makes searching for a tag a LOT faster, but a linear search |
7185 will find more tags if the tags file wasn't properly sorted. | |
7186 Vim normally assumes that your tags files are sorted, or indicate that | |
7187 they are not sorted. Only when this is not the case does the | |
7188 'tagbsearch' option need to be switched off. | |
7189 | |
7190 When 'tagbsearch' is on, binary searching is first used in the tags | |
10 | 7191 files. In certain situations, Vim will do a linear search instead for |
7 | 7192 certain files, or retry all files with a linear search. When |
7193 'tagbsearch' is off, only a linear search is done. | |
7194 | |
7195 Linear searching is done anyway, for one file, when Vim finds a line | |
7196 at the start of the file indicating that it's not sorted: > | |
1621 | 7197 !_TAG_FILE_SORTED 0 /some comment/ |
7 | 7198 < [The whitespace before and after the '0' must be a single <Tab>] |
7199 | |
7200 When a binary search was done and no match was found in any of the | |
7201 files listed in 'tags', and 'ignorecase' is set or a pattern is used | |
7202 instead of a normal tag name, a retry is done with a linear search. | |
7203 Tags in unsorted tags files, and matches with different case will only | |
7204 be found in the retry. | |
7205 | |
22 | 7206 If a tag file indicates that it is case-fold sorted, the second, |
7 | 7207 linear search can be avoided for the 'ignorecase' case. Use a value |
7208 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be | |
7209 case-fold sorted with the -f switch to "sort" in most unices, as in | |
7210 the command: "sort -f -o tags tags". For "Exuberant ctags" version | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
7211 5.x or higher (at least 5.5) the --sort=foldcase switch can be used |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
7212 for this as well. Note that case must be folded to uppercase for this |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
7213 to work. |
7 | 7214 |
7215 When 'tagbsearch' is off, tags searching is slower when a full match | |
7216 exists, but faster when no full match exists. Tags in unsorted tags | |
7217 files may only be found with 'tagbsearch' off. | |
7218 When the tags file is not sorted, or sorted in a wrong way (not on | |
7219 ASCII byte value), 'tagbsearch' should be off, or the line given above | |
7220 must be included in the tags file. | |
7221 This option doesn't affect commands that find all matching tags (e.g., | |
7222 command-line completion and ":help"). | |
7223 {Vi: always uses binary search in some versions} | |
7224 | |
7225 *'taglength'* *'tl'* | |
7226 'taglength' 'tl' number (default 0) | |
7227 global | |
7228 If non-zero, tags are significant up to this number of characters. | |
7229 | |
7230 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'* | |
7231 'tagrelative' 'tr' boolean (Vim default: on, Vi default: off) | |
7232 global | |
7233 {not in Vi} | |
824 | 7234 If on and using a tags file in another directory, file names in that |
7235 tags file are relative to the directory where the tags file is. | |
7 | 7236 NOTE: This option is set to the Vi default value when 'compatible' is |
7237 set and to the Vim default value when 'compatible' is reset. | |
7238 | |
7239 *'tags'* *'tag'* *E433* | |
7240 'tags' 'tag' string (default "./tags,tags", when compiled with | |
7241 |+emacs_tags|: "./tags,./TAGS,tags,TAGS") | |
7242 global or local to buffer |global-local| | |
7243 Filenames for the tag command, separated by spaces or commas. To | |
7244 include a space or comma in a file name, precede it with a backslash | |
7245 (see |option-backslash| about including spaces and backslashes). | |
7246 When a file name starts with "./", the '.' is replaced with the path | |
7247 of the current file. But only when the 'd' flag is not included in | |
7248 'cpoptions'. Environment variables are expanded |:set_env|. Also see | |
7249 |tags-option|. | |
7250 "*", "**" and other wildcards can be used to search for tags files in | |
2522
d7ecfc8b784c
Update help about wildcards in 'tags' option.
Bram Moolenaar <bram@vim.org>
parents:
2492
diff
changeset
|
7251 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will |
d7ecfc8b784c
Update help about wildcards in 'tags' option.
Bram Moolenaar <bram@vim.org>
parents:
2492
diff
changeset
|
7252 find all files named "tags" below "/lib". The filename itself cannot |
d7ecfc8b784c
Update help about wildcards in 'tags' option.
Bram Moolenaar <bram@vim.org>
parents:
2492
diff
changeset
|
7253 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find |
d7ecfc8b784c
Update help about wildcards in 'tags' option.
Bram Moolenaar <bram@vim.org>
parents:
2492
diff
changeset
|
7254 files called "tags?". {not available when compiled without the |
d7ecfc8b784c
Update help about wildcards in 'tags' option.
Bram Moolenaar <bram@vim.org>
parents:
2492
diff
changeset
|
7255 |+path_extra| feature} |
515 | 7256 The |tagfiles()| function can be used to get a list of the file names |
7257 actually used. | |
7 | 7258 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag |
7259 files are also supported. They are automatically recognized. The | |
7260 default value becomes "./tags,./TAGS,tags,TAGS", unless case | |
7261 differences are ignored (MS-Windows). |emacs-tags| | |
7262 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
7263 file names from the list. This avoids problems when a future version | |
7264 uses another default. | |
7265 {Vi: default is "tags /usr/lib/tags"} | |
7266 | |
7267 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'* | |
7268 'tagstack' 'tgst' boolean (default on) | |
7269 global | |
7270 {not in all versions of Vi} | |
7271 When on, the |tagstack| is used normally. When off, a ":tag" or | |
7272 ":tselect" command with an argument will not push the tag onto the | |
7273 tagstack. A following ":tag" without an argument, a ":pop" command or | |
7274 any other command that uses the tagstack will use the unmodified | |
7275 tagstack, but does change the pointer to the active entry. | |
7276 Resetting this option is useful when using a ":tag" command in a | |
7277 mapping which should not change the tagstack. | |
7278 | |
7279 *'term'* *E529* *E530* *E531* | |
7280 'term' string (default is $TERM, if that fails: | |
7281 in the GUI: "builtin_gui" | |
7282 on Amiga: "amiga" | |
7283 on BeOS: "beos-ansi" | |
7284 on Mac: "mac-ansi" | |
7285 on MiNT: "vt52" | |
7286 on MS-DOS: "pcterm" | |
7287 on OS/2: "os2ansi" | |
7288 on Unix: "ansi" | |
7289 on VMS: "ansi" | |
7290 on Win 32: "win32") | |
7291 global | |
7292 Name of the terminal. Used for choosing the terminal control | |
7293 characters. Environment variables are expanded |:set_env|. | |
7294 For example: > | |
7295 :set term=$TERM | |
7296 < See |termcap|. | |
7297 | |
7298 *'termbidi'* *'tbidi'* | |
7299 *'notermbidi'* *'notbidi'* | |
7300 'termbidi' 'tbidi' boolean (default off, on for "mlterm") | |
7301 global | |
7302 {not in Vi} | |
7303 {only available when compiled with the |+arabic| | |
7304 feature} | |
7305 The terminal is in charge of Bi-directionality of text (as specified | |
7306 by Unicode). The terminal is also expected to do the required shaping | |
7307 that some languages (such as Arabic) require. | |
7308 Setting this option implies that 'rightleft' will not be set when | |
7309 'arabic' is set and the value of 'arabicshape' will be ignored. | |
7310 Note that setting 'termbidi' has the immediate effect that | |
7311 'arabicshape' is ignored, but 'rightleft' isn't changed automatically. | |
7312 This option is reset when the GUI is started. | |
7313 For further details see |arabic.txt|. | |
7314 | |
7315 *'termencoding'* *'tenc'* | |
7316 'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with | |
7317 Macintosh GUI: "macroman") | |
7318 global | |
7319 {only available when compiled with the |+multi_byte| | |
7320 feature} | |
7321 {not in Vi} | |
7322 Encoding used for the terminal. This specifies what character | |
7323 encoding the keyboard produces and the display will understand. For | |
4186 | 7324 the GUI it only applies to the keyboard ( 'encoding' is used for the |
1152 | 7325 display). Except for the Mac when 'macatsui' is off, then |
7326 'termencoding' should be "macroman". | |
7 | 7327 In the Win32 console version the default value is the console codepage |
7328 when it differs from the ANSI codepage. | |
7329 *E617* | |
7330 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been | |
7331 successfully initialized, 'termencoding' is forcibly set to "utf-8". | |
7332 Any attempts to set a different value will be rejected, and an error | |
7333 message is shown. | |
7334 For the Win32 GUI 'termencoding' is not used for typed characters, | |
7335 because the Win32 system always passes Unicode characters. | |
7336 When empty, the same encoding is used as for the 'encoding' option. | |
7337 This is the normal value. | |
7338 Not all combinations for 'termencoding' and 'encoding' are valid. See | |
7339 |encoding-table|. | |
7340 The value for this option must be supported by internal conversions or | |
7341 iconv(). When this is not possible no conversion will be done and you | |
7342 will probably experience problems with non-ASCII characters. | |
7343 Example: You are working with the locale set to euc-jp (Japanese) and | |
7344 want to edit a UTF-8 file: > | |
7345 :let &termencoding = &encoding | |
7346 :set encoding=utf-8 | |
7347 < You need to do this when your system has no locale support for UTF-8. | |
7348 | |
7349 *'terse'* *'noterse'* | |
7350 'terse' boolean (default off) | |
7351 global | |
7352 When set: Add 's' flag to 'shortmess' option (this makes the message | |
7353 for a search that hits the start or end of the file not being | |
7354 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi | |
7355 shortens a lot of messages} | |
7356 | |
7357 *'textauto'* *'ta'* *'notextauto'* *'nota'* | |
7358 'textauto' 'ta' boolean (Vim default: on, Vi default: off) | |
7359 global | |
7360 {not in Vi} | |
7361 This option is obsolete. Use 'fileformats'. | |
7362 For backwards compatibility, when 'textauto' is set, 'fileformats' is | |
7363 set to the default value for the current system. When 'textauto' is | |
7364 reset, 'fileformats' is made empty. | |
7365 NOTE: This option is set to the Vi default value when 'compatible' is | |
7366 set and to the Vim default value when 'compatible' is reset. | |
7367 | |
7368 *'textmode'* *'tx'* *'notextmode'* *'notx'* | |
7369 'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on, | |
7370 others: default off) | |
7371 local to buffer | |
7372 {not in Vi} | |
7373 This option is obsolete. Use 'fileformat'. | |
7374 For backwards compatibility, when 'textmode' is set, 'fileformat' is | |
7375 set to "dos". When 'textmode' is reset, 'fileformat' is set to | |
7376 "unix". | |
7377 | |
7378 *'textwidth'* *'tw'* | |
7379 'textwidth' 'tw' number (default 0) | |
7380 local to buffer | |
7381 {not in Vi} | |
7382 Maximum width of text that is being inserted. A longer line will be | |
7383 broken after white space to get this width. A zero value disables | |
10 | 7384 this. 'textwidth' is set to 0 when the 'paste' option is set. When |
7385 'textwidth' is zero, 'wrapmargin' may be used. See also | |
7 | 7386 'formatoptions' and |ins-textwidth|. |
838 | 7387 When 'formatexpr' is set it will be used to break the line. |
7 | 7388 NOTE: This option is set to 0 when 'compatible' is set. |
7389 | |
7390 *'thesaurus'* *'tsr'* | |
7391 'thesaurus' 'tsr' string (default "") | |
7392 global or local to buffer |global-local| | |
7393 {not in Vi} | |
7394 List of file names, separated by commas, that are used to lookup words | |
10 | 7395 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in |
7 | 7396 the file should contain words with similar meaning, separated by |
7397 non-keyword characters (white space is preferred). Maximum line | |
7398 length is 510 bytes. | |
3496
d1e4abe8342c
Fixed compatible mode in most runtime files.
Bram Moolenaar <bram@vim.org>
parents:
3493
diff
changeset
|
7399 To obtain a file to be used here, check out this ftp site: |
d1e4abe8342c
Fixed compatible mode in most runtime files.
Bram Moolenaar <bram@vim.org>
parents:
3493
diff
changeset
|
7400 ftp://ftp.ox.ac.uk/pub/wordlists/ First get the README file. |
10 | 7401 To include a comma in a file name precede it with a backslash. Spaces |
7 | 7402 after a comma are ignored, otherwise spaces are included in the file |
7403 name. See |option-backslash| about using backslashes. | |
7404 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
7405 directories from the list. This avoids problems when a future version | |
7406 uses another default. | |
7407 Backticks cannot be used in this option for security reasons. | |
7408 | |
7409 *'tildeop'* *'top'* *'notildeop'* *'notop'* | |
7410 'tildeop' 'top' boolean (default off) | |
7411 global | |
7412 {not in Vi} | |
7413 When on: The tilde command "~" behaves like an operator. | |
7414 NOTE: This option is reset when 'compatible' is set. | |
7415 | |
7416 *'timeout'* *'to'* *'notimeout'* *'noto'* | |
7417 'timeout' 'to' boolean (default on) | |
7418 global | |
7419 *'ttimeout'* *'nottimeout'* | |
7420 'ttimeout' boolean (default off) | |
7421 global | |
7422 {not in Vi} | |
7423 These two options together determine the behavior when part of a | |
7424 mapped key sequence or keyboard code has been received: | |
7425 | |
7426 'timeout' 'ttimeout' action ~ | |
7427 off off do not time out | |
7428 on on or off time out on :mappings and key codes | |
7429 off on time out on key codes | |
7430 | |
7431 If both options are off, Vim will wait until either the complete | |
7432 mapping or key sequence has been received, or it is clear that there | |
7433 is no mapping or key sequence for the received characters. For | |
7434 example: if you have mapped "vl" and Vim has received 'v', the next | |
7435 character is needed to see if the 'v' is followed by an 'l'. | |
7436 When one of the options is on, Vim will wait for about 1 second for | |
7437 the next character to arrive. After that the already received | |
7438 characters are interpreted as single characters. The waiting time can | |
7439 be changed with the 'timeoutlen' option. | |
7440 On slow terminals or very busy systems timing out may cause | |
7441 malfunctioning cursor keys. If both options are off, Vim waits | |
7442 forever after an entered <Esc> if there are key codes that start | |
7443 with <Esc>. You will have to type <Esc> twice. If you do not have | |
7444 problems with key codes, but would like to have :mapped key | |
7445 sequences not timing out in 1 second, set the 'ttimeout' option and | |
7446 reset the 'timeout' option. | |
7447 | |
7448 NOTE: 'ttimeout' is reset when 'compatible' is set. | |
7449 | |
7450 *'timeoutlen'* *'tm'* | |
7451 'timeoutlen' 'tm' number (default 1000) | |
7452 global | |
7453 {not in all versions of Vi} | |
7454 *'ttimeoutlen'* *'ttm'* | |
7455 'ttimeoutlen' 'ttm' number (default -1) | |
7456 global | |
7457 {not in Vi} | |
7458 The time in milliseconds that is waited for a key code or mapped key | |
7459 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G | |
7460 when part of a command has been typed. | |
7461 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a | |
7462 different timeout value for key codes is desired set 'ttimeoutlen' to | |
7463 a non-negative number. | |
7464 | |
7465 ttimeoutlen mapping delay key code delay ~ | |
7466 < 0 'timeoutlen' 'timeoutlen' | |
7467 >= 0 'timeoutlen' 'ttimeoutlen' | |
7468 | |
7469 The timeout only happens when the 'timeout' and 'ttimeout' options | |
7470 tell so. A useful setting would be > | |
7471 :set timeout timeoutlen=3000 ttimeoutlen=100 | |
7472 < (time out on mapping after three seconds, time out on key codes after | |
7473 a tenth of a second). | |
7474 | |
7475 *'title'* *'notitle'* | |
7476 'title' boolean (default off, on when title can be restored) | |
7477 global | |
7478 {not in Vi} | |
7479 {not available when compiled without the |+title| | |
7480 feature} | |
7481 When on, the title of the window will be set to the value of | |
7482 'titlestring' (if it is not empty), or to: | |
7483 filename [+=-] (path) - VIM | |
7484 Where: | |
7485 filename the name of the file being edited | |
7486 - indicates the file cannot be modified, 'ma' off | |
7487 + indicates the file was modified | |
7488 = indicates the file is read-only | |
7489 =+ indicates the file is read-only and modified | |
7490 (path) is the path of the file being edited | |
7491 - VIM the server name |v:servername| or "VIM" | |
7492 Only works if the terminal supports setting window titles | |
7493 (currently Amiga console, Win32 console, all GUI versions and | |
7494 terminals with a non- empty 't_ts' option - these are Unix xterm and | |
7495 iris-ansi by default, where 't_ts' is taken from the builtin termcap). | |
7496 *X11* | |
7497 When Vim was compiled with HAVE_X11 defined, the original title will | |
7498 be restored if possible. The output of ":version" will include "+X11" | |
7499 when HAVE_X11 was defined, otherwise it will be "-X11". This also | |
7500 works for the icon name |'icon'|. | |
7501 But: When Vim was started with the |-X| argument, restoring the title | |
7502 will not work (except in the GUI). | |
7503 If the title cannot be restored, it is set to the value of 'titleold'. | |
7504 You might want to restore the title outside of Vim then. | |
7505 When using an xterm from a remote machine you can use this command: | |
7506 rsh machine_name xterm -display $DISPLAY & | |
7507 then the WINDOWID environment variable should be inherited and the | |
7508 title of the window should change back to what it should be after | |
7509 exiting Vim. | |
7510 | |
7511 *'titlelen'* | |
7512 'titlelen' number (default 85) | |
7513 global | |
7514 {not in Vi} | |
7515 {not available when compiled without the |+title| | |
7516 feature} | |
7517 Gives the percentage of 'columns' to use for the length of the window | |
10 | 7518 title. When the title is longer, only the end of the path name is |
7519 shown. A '<' character before the path name is used to indicate this. | |
7 | 7520 Using a percentage makes this adapt to the width of the window. But |
7521 it won't work perfectly, because the actual number of characters | |
7522 available also depends on the font used and other things in the title | |
7523 bar. When 'titlelen' is zero the full path is used. Otherwise, | |
7524 values from 1 to 30000 percent can be used. | |
7525 'titlelen' is also used for the 'titlestring' option. | |
7526 | |
7527 *'titleold'* | |
7528 'titleold' string (default "Thanks for flying Vim") | |
7529 global | |
7530 {not in Vi} | |
7531 {only available when compiled with the |+title| | |
7532 feature} | |
7533 This option will be used for the window title when exiting Vim if the | |
7534 original title cannot be restored. Only happens if 'title' is on or | |
7535 'titlestring' is not empty. | |
36 | 7536 This option cannot be set from a |modeline| or in the |sandbox|, for |
7537 security reasons. | |
7 | 7538 *'titlestring'* |
7539 'titlestring' string (default "") | |
7540 global | |
7541 {not in Vi} | |
7542 {not available when compiled without the |+title| | |
7543 feature} | |
7544 When this option is not empty, it will be used for the title of the | |
7545 window. This happens only when the 'title' option is on. | |
7546 Only works if the terminal supports setting window titles (currently | |
7547 Amiga console, Win32 console, all GUI versions and terminals with a | |
7548 non-empty 't_ts' option). | |
7549 When Vim was compiled with HAVE_X11 defined, the original title will | |
7550 be restored if possible |X11|. | |
7551 When this option contains printf-style '%' items, they will be | |
7552 expanded according to the rules used for 'statusline'. | |
7553 Example: > | |
7554 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p") | |
7555 :set title titlestring=%<%F%=%l/%L-%P titlelen=70 | |
7556 < The value of 'titlelen' is used to align items in the middle or right | |
7557 of the available space. | |
7558 Some people prefer to have the file name first: > | |
7559 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%) | |
7560 < Note the use of "%{ }" and an expression to get the path of the file, | |
10 | 7561 without the file name. The "%( %)" constructs are used to add a |
7 | 7562 separating space only when needed. |
7563 NOTE: Use of special characters in 'titlestring' may cause the display | |
7564 to be garbled (e.g., when it contains a CR or NL character). | |
7565 {not available when compiled without the |+statusline| feature} | |
7566 | |
7567 *'toolbar'* *'tb'* | |
7568 'toolbar' 'tb' string (default "icons,tooltips") | |
7569 global | |
7570 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and | |
7571 |+GUI_Photon|} | |
10 | 7572 The contents of this option controls various toolbar settings. The |
7 | 7573 possible values are: |
7574 icons Toolbar buttons are shown with icons. | |
7575 text Toolbar buttons shown with text. | |
7576 horiz Icon and text of a toolbar button are | |
10 | 7577 horizontally arranged. {only in GTK+ 2 GUI} |
7 | 7578 tooltips Tooltips are active for toolbar buttons. |
7579 Tooltips refer to the popup help text which appears after the mouse | |
7580 cursor is placed over a toolbar button for a brief moment. | |
7581 | |
7582 If you want the toolbar to be shown with icons as well as text, do the | |
7583 following: > | |
7584 :set tb=icons,text | |
7585 < Motif and Athena cannot display icons and text at the same time. They | |
7586 will show icons if both are requested. | |
7587 | |
7588 If none of the strings specified in 'toolbar' are valid or if | |
7589 'toolbar' is empty, this option is ignored. If you want to disable | |
7590 the toolbar, you need to set the 'guioptions' option. For example: > | |
7591 :set guioptions-=T | |
7592 < Also see |gui-toolbar|. | |
7593 | |
7594 *'toolbariconsize'* *'tbis'* | |
7595 'toolbariconsize' 'tbis' string (default "small") | |
7596 global | |
7597 {not in Vi} | |
7598 {only in the GTK+ 2 GUI} | |
7599 Controls the size of toolbar icons. The possible values are: | |
7600 tiny Use tiny toolbar icons. | |
7601 small Use small toolbar icons (default). | |
7602 medium Use medium-sized toolbar icons. | |
7603 large Use large toolbar icons. | |
7604 The exact dimensions in pixels of the various icon sizes depend on | |
7605 the current theme. Common dimensions are large=32x32, medium=24x24, | |
7606 small=20x20 and tiny=16x16. | |
7607 | |
7608 If 'toolbariconsize' is empty, the global default size as determined | |
7609 by user preferences or the current theme is used. | |
7610 | |
7611 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'* | |
7612 'ttybuiltin' 'tbi' boolean (default on) | |
7613 global | |
7614 {not in Vi} | |
7615 When on, the builtin termcaps are searched before the external ones. | |
7616 When off the builtin termcaps are searched after the external ones. | |
7617 When this option is changed, you should set the 'term' option next for | |
7618 the change to take effect, for example: > | |
7619 :set notbi term=$TERM | |
7620 < See also |termcap|. | |
7621 Rationale: The default for this option is "on", because the builtin | |
7622 termcap entries are generally better (many systems contain faulty | |
7623 xterm entries...). | |
7624 | |
7625 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'* | |
7626 'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm, | |
7627 sun-cmd, screen, rxvt, dtterm or | |
7628 iris-ansi; also on when running Vim in | |
7629 a DOS console) | |
7630 global | |
7631 {not in Vi} | |
7632 Indicates a fast terminal connection. More characters will be sent to | |
7633 the screen for redrawing, instead of using insert/delete line | |
7634 commands. Improves smoothness of redrawing when there are multiple | |
7635 windows and the terminal does not support a scrolling region. | |
7636 Also enables the extra writing of characters at the end of each screen | |
7637 line for lines that wrap. This helps when using copy/paste with the | |
7638 mouse in an xterm and other terminals. | |
7639 | |
7640 *'ttymouse'* *'ttym'* | |
7641 'ttymouse' 'ttym' string (default depends on 'term') | |
7642 global | |
7643 {not in Vi} | |
7644 {only in Unix and VMS, doesn't work in the GUI; not | |
7645 available when compiled without |+mouse|} | |
7646 Name of the terminal type for which mouse codes are to be recognized. | |
1213 | 7647 Currently these strings are valid: |
7 | 7648 *xterm-mouse* |
7649 xterm xterm-like mouse handling. The mouse generates | |
7650 "<Esc>[Mscr", where "scr" is three bytes: | |
7651 "s" = button state | |
7652 "c" = column plus 33 | |
7653 "r" = row plus 33 | |
5908 | 7654 This only works up to 223 columns! See "dec", |
7655 "urxvt", and "sgr" for solutions. | |
7 | 7656 xterm2 Works like "xterm", but with the xterm reporting the |
7657 mouse position while the mouse is dragged. This works | |
7658 much faster and more precise. Your xterm must at | |
180 | 7659 least at patchlevel 88 / XFree 3.3.3 for this to |
7 | 7660 work. See below for how Vim detects this |
7661 automatically. | |
7662 *netterm-mouse* | |
7663 netterm NetTerm mouse handling. The mouse generates | |
7664 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers | |
7665 for the row and column. | |
7666 *dec-mouse* | |
7667 dec DEC terminal mouse handling. The mouse generates a | |
7668 rather complex sequence, starting with "<Esc>[". | |
189 | 7669 This is also available for an Xterm, if it was |
7670 configured with "--enable-dec-locator". | |
7 | 7671 *jsbterm-mouse* |
7672 jsbterm JSB term mouse handling. | |
7673 *pterm-mouse* | |
7674 pterm QNX pterm mouse handling. | |
3224 | 7675 *urxvt-mouse* |
7676 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal. | |
5908 | 7677 The mouse works only if the terminal supports this |
7678 encoding style, but it does not have 223 columns limit | |
7679 unlike "xterm" or "xterm2". | |
3750 | 7680 *sgr-mouse* |
7681 sgr Mouse handling for the terminal that emits SGR-styled | |
5908 | 7682 mouse reporting. The mouse works even in columns |
7683 beyond 223. This option is backward compatible with | |
7684 "xterm2" because it can also decode "xterm2" style | |
7685 mouse codes. | |
7 | 7686 |
7687 The mouse handling must be enabled at compile time |+mouse_xterm| | |
5908 | 7688 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt| |
7689 |+mouse_sgr|. | |
7 | 7690 Only "xterm"(2) is really recognized. NetTerm mouse codes are always |
7691 recognized, if enabled at compile time. DEC terminal mouse codes | |
7692 are recognized if enabled at compile time, and 'ttymouse' is not | |
5908 | 7693 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict |
7694 with them). | |
7 | 7695 This option is automatically set to "xterm", when the 'term' option is |
5908 | 7696 set to a name that starts with "xterm", "mlterm", or "screen", and |
7697 'ttymouse' is not set already. | |
7698 Additionally, if vim is compiled with the |+termresponse| feature and | |
7699 |t_RV| is set to the escape sequence to request the xterm version | |
7700 number, more intelligent detection process runs. | |
7 | 7701 The "xterm2" value will be set if the xterm version is reported to be |
5908 | 7702 from 95 to 276. The "sgr" value will be set if the xterm version is |
7703 277 or highter. | |
7704 If you do not want 'ttymouse' to be set to "xterm2" or "sgr" | |
7705 automatically, set t_RV to an empty string: > | |
7 | 7706 :set t_RV= |
7707 < | |
7708 *'ttyscroll'* *'tsl'* | |
7709 'ttyscroll' 'tsl' number (default 999) | |
7710 global | |
7711 Maximum number of lines to scroll the screen. If there are more lines | |
7712 to scroll the window is redrawn. For terminals where scrolling is | |
7713 very slow and redrawing is not slow this can be set to a small number, | |
7714 e.g., 3, to speed up displaying. | |
7715 | |
7716 *'ttytype'* *'tty'* | |
7717 'ttytype' 'tty' string (default from $TERM) | |
7718 global | |
7719 Alias for 'term', see above. | |
7720 | |
2214
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
7721 *'undodir'* *'udir'* |
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
7722 'undodir' 'udir' string (default ".") |
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
7723 global |
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
7724 {not in Vi} |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
7725 {only when compiled with the |+persistent_undo| feature} |
2214
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
7726 List of directory names for undo files, separated with commas. |
2220
b1c70c500de4
Found a way to make the MS-Windows installer wait for the uninstaller to
Bram Moolenaar <bram@vim.org>
parents:
2218
diff
changeset
|
7727 See |'backupdir'| for details of the format. |
2218
695ceebf17ca
Fix: :wundo didn't work in a buffer without a name.
Bram Moolenaar <bram@vim.org>
parents:
2214
diff
changeset
|
7728 "." means using the directory of the file. The undo file name for |
695ceebf17ca
Fix: :wundo didn't work in a buffer without a name.
Bram Moolenaar <bram@vim.org>
parents:
2214
diff
changeset
|
7729 "file.txt" is ".file.txt.un~". |
695ceebf17ca
Fix: :wundo didn't work in a buffer without a name.
Bram Moolenaar <bram@vim.org>
parents:
2214
diff
changeset
|
7730 For other directories the file name is the full path of the edited |
695ceebf17ca
Fix: :wundo didn't work in a buffer without a name.
Bram Moolenaar <bram@vim.org>
parents:
2214
diff
changeset
|
7731 file, with path separators replaced with "%". |
2214
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
7732 When writing: The first directory that exists is used. "." always |
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
7733 works, no directories after "." will be used for writing. |
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
7734 When reading all entries are tried to find an undo file. The first |
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
7735 undo file that exists is used. When it cannot be read an error is |
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
7736 given, no further entry is used. |
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
7737 See |undo-persistence|. |
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
7738 |
4681
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
7739 *'undofile'* *'noundofile'* *'udf'* *'noudf'* |
2214
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
7740 'undofile' 'udf' boolean (default off) |
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
7741 local to buffer |
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
7742 {not in Vi} |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
7743 {only when compiled with the |+persistent_undo| feature} |
2214
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
7744 When on, Vim automatically saves undo history to an undo file when |
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
7745 writing a buffer to a file, and restores undo history from the same |
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
7746 file on buffer read. |
2220
b1c70c500de4
Found a way to make the MS-Windows installer wait for the uninstaller to
Bram Moolenaar <bram@vim.org>
parents:
2218
diff
changeset
|
7747 The directory where the undo file is stored is specified by 'undodir'. |
b1c70c500de4
Found a way to make the MS-Windows installer wait for the uninstaller to
Bram Moolenaar <bram@vim.org>
parents:
2218
diff
changeset
|
7748 For more information about this feature see |undo-persistence|. |
2394
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
7749 The undo file is not read when 'undoreload' causes the buffer from |
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
7750 before a reload to be saved for undo. |
3920 | 7751 When 'undofile' is turned off the undo file is NOT deleted. |
2214
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
7752 |
7 | 7753 *'undolevels'* *'ul'* |
7754 'undolevels' 'ul' number (default 100, 1000 for Unix, VMS, | |
7755 Win32 and OS/2) | |
5446 | 7756 global or local to buffer |global-local| |
7 | 7757 {not in Vi} |
7758 Maximum number of changes that can be undone. Since undo information | |
7759 is kept in memory, higher numbers will cause more memory to be used | |
7760 (nevertheless, a single change can use an unlimited amount of memory). | |
7761 Set to 0 for Vi compatibility: One level of undo and "u" undoes | |
7762 itself: > | |
7763 set ul=0 | |
7764 < But you can also get Vi compatibility by including the 'u' flag in | |
7765 'cpoptions', and still be able to use CTRL-R to repeat undo. | |
2249
6d3d35ff2c2b
Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents:
2240
diff
changeset
|
7766 Also see |undo-two-ways|. |
5446 | 7767 Set to -1 for no undo at all. You might want to do this only for the |
7768 current buffer: > | |
7769 setlocal ul=-1 | |
7 | 7770 < This helps when you run out of memory for a single change. |
6336 | 7771 |
7772 The local value is set to -123456 when the global value is to be used. | |
7773 | |
2249
6d3d35ff2c2b
Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents:
2240
diff
changeset
|
7774 Also see |clear-undo|. |
7 | 7775 |
2394
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
7776 *'undoreload'* *'ur'* |
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
7777 'undoreload' 'ur' number (default 10000) |
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
7778 global |
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
7779 {not in Vi} |
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
7780 Save the whole buffer for undo when reloading it. This applies to the |
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
7781 ":e!" command and reloading for when the buffer changed outside of |
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
7782 Vim. |FileChangedShell| |
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
7783 The save only happens when this options is negative or when the number |
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
7784 of lines is smaller than the value of this option. |
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
7785 Set this option to zero to disable undo for a reload. |
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
7786 |
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
7787 When saving undo for a reload, any undo file is not read. |
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
7788 |
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
7789 Note that this causes the whole buffer to be stored in memory. Set |
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
7790 this option to a lower value if you run out of memory. |
7 | 7791 |
7792 *'updatecount'* *'uc'* | |
7793 'updatecount' 'uc' number (default: 200) | |
7794 global | |
7795 {not in Vi} | |
7796 After typing this many characters the swap file will be written to | |
7797 disk. When zero, no swap file will be created at all (see chapter on | |
7798 recovery |crash-recovery|). 'updatecount' is set to zero by starting | |
7799 Vim with the "-n" option, see |startup|. When editing in readonly | |
7800 mode this option will be initialized to 10000. | |
7801 The swapfile can be disabled per buffer with |'swapfile'|. | |
7802 When 'updatecount' is set from zero to non-zero, swap files are | |
7803 created for all buffers that have 'swapfile' set. When 'updatecount' | |
7804 is set to zero, existing swap files are not deleted. | |
7805 Also see |'swapsync'|. | |
7806 This option has no meaning in buffers where |'buftype'| is "nofile" | |
7807 or "nowrite". | |
7808 | |
7809 *'updatetime'* *'ut'* | |
7810 'updatetime' 'ut' number (default 4000) | |
7811 global | |
7812 {not in Vi} | |
7813 If this many milliseconds nothing is typed the swap file will be | |
7814 written to disk (see |crash-recovery|). Also used for the | |
7815 |CursorHold| autocommand event. | |
7816 | |
7817 *'verbose'* *'vbs'* | |
7818 'verbose' 'vbs' number (default 0) | |
7819 global | |
7820 {not in Vi, although some versions have a boolean | |
7821 verbose option} | |
7822 When bigger than zero, Vim will give messages about what it is doing. | |
7823 Currently, these messages are given: | |
7824 >= 1 When the viminfo file is read or written. | |
7825 >= 2 When a file is ":source"'ed. | |
712 | 7826 >= 5 Every searched tags file and include file. |
7 | 7827 >= 8 Files for which a group of autocommands is executed. |
7828 >= 9 Every executed autocommand. | |
7829 >= 12 Every executed function. | |
7830 >= 13 When an exception is thrown, caught, finished, or discarded. | |
7831 >= 14 Anything pending in a ":finally" clause. | |
7832 >= 15 Every executed Ex command (truncated at 200 characters). | |
7833 | |
7834 This option can also be set with the "-V" argument. See |-V|. | |
7835 This option is also set by the |:verbose| command. | |
7836 | |
293 | 7837 When the 'verbosefile' option is set then the verbose messages are not |
7838 displayed. | |
7839 | |
7840 *'verbosefile'* *'vfile'* | |
7841 'verbosefile' 'vfile' string (default empty) | |
7842 global | |
7843 {not in Vi} | |
7844 When not empty all messages are written in a file with this name. | |
7845 When the file exists messages are appended. | |
7846 Writing to the file ends when Vim exits or when 'verbosefile' is made | |
2265
b7cb69ab616d
Added salt to blowfish encryption.
Bram Moolenaar <bram@vim.org>
parents:
2250
diff
changeset
|
7847 empty. Writes are buffered, thus may not show up for some time. |
293 | 7848 Setting 'verbosefile' to a new value is like making it empty first. |
7849 The difference with |:redir| is that verbose messages are not | |
7850 displayed when 'verbosefile' is set. | |
7851 | |
7 | 7852 *'viewdir'* *'vdir'* |
7853 'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32: | |
7854 "$VIM/vimfiles/view", | |
7855 for Unix: "~/.vim/view", | |
7856 for Macintosh: "$VIM:vimfiles:view" | |
7857 for VMS: "sys$login:vimfiles/view" | |
7858 for RiscOS: "Choices:vimfiles/view") | |
7859 global | |
7860 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
7861 {not available when compiled without the |+mksession| |
7 | 7862 feature} |
7863 Name of the directory where to store files for |:mkview|. | |
7864 This option cannot be set from a |modeline| or in the |sandbox|, for | |
7865 security reasons. | |
7866 | |
7867 *'viewoptions'* *'vop'* | |
7868 'viewoptions' 'vop' string (default: "folds,options,cursor") | |
7869 global | |
7870 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
7871 {not available when compiled without the |+mksession| |
7 | 7872 feature} |
7873 Changes the effect of the |:mkview| command. It is a comma separated | |
10 | 7874 list of words. Each word enables saving and restoring something: |
7 | 7875 word save and restore ~ |
7876 cursor cursor position in file and in window | |
7877 folds manually created folds, opened/closed folds and local | |
7878 fold options | |
7879 options options and mappings local to a window or buffer (not | |
7880 global values for local options) | |
6213 | 7881 localoptions same as "options" |
7 | 7882 slash backslashes in file names replaced with forward |
7883 slashes | |
7884 unix with Unix end-of-line format (single <NL>), even when | |
7885 on Windows or DOS | |
7886 | |
7887 "slash" and "unix" are useful on Windows when sharing view files | |
7888 with Unix. The Unix version of Vim cannot source dos format scripts, | |
7889 but the Windows version of Vim can source unix format scripts. | |
7890 | |
7891 *'viminfo'* *'vi'* *E526* *E527* *E528* | |
7892 'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS, | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
7893 Windows and OS/2: '100,<50,s10,h,rA:,rB:, |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
7894 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2: |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
7895 for others: '100,<50,s10,h) |
7 | 7896 global |
7897 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
7898 {not available when compiled without the |+viminfo| |
7 | 7899 feature} |
7900 When non-empty, the viminfo file is read upon startup and written | |
10 | 7901 when exiting Vim (see |viminfo-file|). The string should be a comma |
7 | 7902 separated list of parameters, each consisting of a single character |
7903 identifying the particular parameter, followed by a number or string | |
7904 which specifies the value of that parameter. If a particular | |
7905 character is left out, then the default value is used for that | |
7906 parameter. The following is a list of the identifying characters and | |
7907 the effect of their value. | |
7908 CHAR VALUE ~ | |
3224 | 7909 *viminfo-!* |
7 | 7910 ! When included, save and restore global variables that start |
7911 with an uppercase letter, and don't contain a lowercase | |
7912 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis" | |
2607 | 7913 and "_K_L_M" are not. Nested List and Dict items may not be |
2642 | 7914 read back correctly, you end up with an empty item. |
3224 | 7915 *viminfo-quote* |
7 | 7916 " Maximum number of lines saved for each register. Old name of |
7917 the '<' item, with the disadvantage that you need to put a | |
7918 backslash before the ", otherwise it will be recognized as the | |
7919 start of a comment! | |
3224 | 7920 *viminfo-%* |
7 | 7921 % When included, save and restore the buffer list. If Vim is |
7922 started with a file name argument, the buffer list is not | |
7923 restored. If Vim is started without a file name argument, the | |
10 | 7924 buffer list is restored from the viminfo file. Buffers |
7 | 7925 without a file name and buffers for help files are not written |
7926 to the viminfo file. | |
23 | 7927 When followed by a number, the number specifies the maximum |
7928 number of buffers that are stored. Without a number all | |
7929 buffers are stored. | |
3224 | 7930 *viminfo-'* |
7 | 7931 ' Maximum number of previously edited files for which the marks |
7932 are remembered. This parameter must always be included when | |
7933 'viminfo' is non-empty. | |
7934 Including this item also means that the |jumplist| and the | |
7935 |changelist| are stored in the viminfo file. | |
3224 | 7936 *viminfo-/* |
7 | 7937 / Maximum number of items in the search pattern history to be |
10 | 7938 saved. If non-zero, then the previous search and substitute |
7 | 7939 patterns are also saved. When not included, the value of |
7940 'history' is used. | |
3224 | 7941 *viminfo-:* |
7 | 7942 : Maximum number of items in the command-line history to be |
10 | 7943 saved. When not included, the value of 'history' is used. |
3224 | 7944 *viminfo-<* |
7 | 7945 < Maximum number of lines saved for each register. If zero then |
7946 registers are not saved. When not included, all lines are | |
7947 saved. '"' is the old name for this item. | |
7948 Also see the 's' item below: limit specified in Kbyte. | |
3224 | 7949 *viminfo-@* |
7 | 7950 @ Maximum number of items in the input-line history to be |
10 | 7951 saved. When not included, the value of 'history' is used. |
3224 | 7952 *viminfo-c* |
7 | 7953 c When included, convert the text in the viminfo file from the |
7954 'encoding' used when writing the file to the current | |
233 | 7955 'encoding'. See |viminfo-encoding|. |
3224 | 7956 *viminfo-f* |
7 | 7957 f Whether file marks need to be stored. If zero, file marks ('0 |
7958 to '9, 'A to 'Z) are not stored. When not present or when | |
10 | 7959 non-zero, they are all stored. '0 is used for the current |
7 | 7960 cursor position (when exiting or when doing ":wviminfo"). |
3224 | 7961 *viminfo-h* |
7 | 7962 h Disable the effect of 'hlsearch' when loading the viminfo |
7963 file. When not included, it depends on whether ":nohlsearch" | |
7964 has been used since the last search command. | |
3224 | 7965 *viminfo-n* |
7 | 7966 n Name of the viminfo file. The name must immediately follow |
7967 the 'n'. Must be the last one! If the "-i" argument was | |
7968 given when starting Vim, that file name overrides the one | |
7969 given here with 'viminfo'. Environment variables are expanded | |
7970 when opening the file, not when setting the option. | |
3224 | 7971 *viminfo-r* |
7 | 7972 r Removable media. The argument is a string (up to the next |
7973 ','). This parameter can be given several times. Each | |
7974 specifies the start of a path for which no marks will be | |
7975 stored. This is to avoid removable media. For MS-DOS you | |
7976 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can | |
7977 also use it for temp files, e.g., for Unix: "r/tmp". Case is | |
7978 ignored. Maximum length of each 'r' argument is 50 | |
7979 characters. | |
3224 | 7980 *viminfo-s* |
7 | 7981 s Maximum size of an item in Kbyte. If zero then registers are |
7982 not saved. Currently only applies to registers. The default | |
7983 "s10" will exclude registers with more than 10 Kbyte of text. | |
7984 Also see the '<' item above: line count limit. | |
7985 | |
7986 Example: > | |
7987 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo | |
7988 < | |
7989 '50 Marks will be remembered for the last 50 files you | |
7990 edited. | |
7991 <1000 Contents of registers (up to 1000 lines each) will be | |
7992 remembered. | |
7993 s100 Registers with more than 100 Kbyte text are skipped. | |
7994 :0 Command-line history will not be saved. | |
7995 n~/vim/viminfo The name of the file to use is "~/vim/viminfo". | |
7996 no / Since '/' is not specified, the default will be used, | |
7997 that is, save all of the search history, and also the | |
7998 previous search and substitute patterns. | |
7999 no % The buffer list will not be saved nor read back. | |
8000 no h 'hlsearch' highlighting will be restored. | |
8001 | |
8002 When setting 'viminfo' from an empty value you can use |:rviminfo| to | |
8003 load the contents of the file, this is not done automatically. | |
8004 | |
8005 This option cannot be set from a |modeline| or in the |sandbox|, for | |
8006 security reasons. | |
8007 | |
8008 *'virtualedit'* *'ve'* | |
8009 'virtualedit' 've' string (default "") | |
8010 global | |
8011 {not in Vi} | |
8012 {not available when compiled without the | |
8013 |+virtualedit| feature} | |
8014 A comma separated list of these words: | |
8015 block Allow virtual editing in Visual block mode. | |
8016 insert Allow virtual editing in Insert mode. | |
8017 all Allow virtual editing in all modes. | |
772 | 8018 onemore Allow the cursor to move just past the end of the line |
782 | 8019 |
7 | 8020 Virtual editing means that the cursor can be positioned where there is |
1263 | 8021 no actual character. This can be halfway into a tab or beyond the end |
7 | 8022 of the line. Useful for selecting a rectangle in Visual mode and |
8023 editing a table. | |
772 | 8024 "onemore" is not the same, it will only allow moving the cursor just |
8025 after the last character of the line. This makes some commands more | |
8026 consistent. Previously the cursor was always past the end of the line | |
8027 if the line was empty. But it is far from Vi compatible. It may also | |
782 | 8028 break some plugins or Vim scripts. For example because |l| can move |
8029 the cursor after the last character. Use with care! | |
5220 | 8030 Using the `$` command will move to the last character in the line, not |
782 | 8031 past it. This may actually move the cursor to the left! |
5220 | 8032 The `g$` command will move to the end of the screen line. |
772 | 8033 It doesn't make sense to combine "all" with "onemore", but you will |
8034 not get a warning for it. | |
7 | 8035 |
8036 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep* | |
8037 'visualbell' 'vb' boolean (default off) | |
8038 global | |
8039 {not in Vi} | |
8040 Use visual bell instead of beeping. The terminal code to display the | |
8041 visual bell is given with 't_vb'. When no beep or flash is wanted, | |
8042 use ":set vb t_vb=". | |
8043 Note: When the GUI starts, 't_vb' is reset to its default value. You | |
8044 might want to set it again in your |gvimrc|. | |
8045 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display | |
8046 for 20 msec. If you want to use a different time, use "<Esc>|40f", | |
8047 where 40 is the time in msec. | |
8048 Does not work on the Amiga, you always get a screen flash. | |
8049 Also see 'errorbells'. | |
8050 | |
8051 *'warn'* *'nowarn'* | |
8052 'warn' boolean (default on) | |
8053 global | |
8054 Give a warning message when a shell command is used while the buffer | |
8055 has been changed. | |
8056 | |
8057 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'* | |
8058 'weirdinvert' 'wiv' boolean (default off) | |
8059 global | |
8060 {not in Vi} | |
667 | 8061 This option has the same effect as the 't_xs' terminal option. |
7 | 8062 It is provided for backwards compatibility with version 4.x. |
8063 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and | |
8064 vice versa. Has no effect when the GUI is running. | |
8065 | |
8066 *'whichwrap'* *'ww'* | |
8067 'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "") | |
8068 global | |
8069 {not in Vi} | |
8070 Allow specified keys that move the cursor left/right to move to the | |
8071 previous/next line when the cursor is on the first/last character in | |
8072 the line. Concatenate characters to allow this for these keys: | |
8073 char key mode ~ | |
8074 b <BS> Normal and Visual | |
8075 s <Space> Normal and Visual | |
712 | 8076 h "h" Normal and Visual (not recommended) |
8077 l "l" Normal and Visual (not recommended) | |
7 | 8078 < <Left> Normal and Visual |
8079 > <Right> Normal and Visual | |
8080 ~ "~" Normal | |
8081 [ <Left> Insert and Replace | |
8082 ] <Right> Insert and Replace | |
8083 For example: > | |
8084 :set ww=<,>,[,] | |
8085 < allows wrap only when cursor keys are used. | |
8086 When the movement keys are used in combination with a delete or change | |
8087 operator, the <EOL> also counts for a character. This makes "3h" | |
8088 different from "3dh" when the cursor crosses the end of a line. This | |
8089 is also true for "x" and "X", because they do the same as "dl" and | |
8090 "dh". If you use this, you may also want to use the mapping | |
8091 ":map <BS> X" to make backspace delete the character in front of the | |
8092 cursor. | |
714 | 8093 When 'l' is included and it is used after an operator at the end of a |
8094 line then it will not move to the next line. This makes "dl", "cl", | |
8095 "yl" etc. work normally. | |
7 | 8096 NOTE: This option is set to the Vi default value when 'compatible' is |
8097 set and to the Vim default value when 'compatible' is reset. | |
8098 | |
8099 *'wildchar'* *'wc'* | |
8100 'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E) | |
8101 global | |
8102 {not in Vi} | |
8103 Character you have to type to start wildcard expansion in the | |
8104 command-line, as specified with 'wildmode'. | |
1621 | 8105 More info here: |cmdline-completion|. |
7 | 8106 The character is not recognized when used inside a macro. See |
8107 'wildcharm' for that. | |
8108 Although 'wc' is a number option, you can set it to a special key: > | |
8109 :set wc=<Esc> | |
8110 < NOTE: This option is set to the Vi default value when 'compatible' is | |
8111 set and to the Vim default value when 'compatible' is reset. | |
8112 | |
8113 *'wildcharm'* *'wcm'* | |
8114 'wildcharm' 'wcm' number (default: none (0)) | |
8115 global | |
8116 {not in Vi} | |
8117 'wildcharm' works exactly like 'wildchar', except that it is | |
233 | 8118 recognized when used inside a macro. You can find "spare" command-line |
8119 keys suitable for this option by looking at |ex-edit-index|. Normally | |
7 | 8120 you'll never actually type 'wildcharm', just use it in mappings that |
8121 automatically invoke completion mode, e.g.: > | |
8122 :set wcm=<C-Z> | |
1621 | 8123 :cnoremap ss so $vim/sessions/*.vim<C-Z> |
7 | 8124 < Then after typing :ss you can use CTRL-P & CTRL-N. |
8125 | |
8126 *'wildignore'* *'wig'* | |
8127 'wildignore' 'wig' string (default "") | |
8128 global | |
8129 {not in Vi} | |
8130 {not available when compiled without the |+wildignore| | |
8131 feature} | |
8132 A list of file patterns. A file that matches with one of these | |
3682 | 8133 patterns is ignored when expanding |wildcards|, completing file or |
8134 directory names, and influences the result of |expand()|, |glob()| and | |
8135 |globpath()| unless a flag is passed to disable this. | |
7 | 8136 The pattern is used like with |:autocmd|, see |autocmd-patterns|. |
8137 Also see 'suffixes'. | |
8138 Example: > | |
8139 :set wildignore=*.o,*.obj | |
8140 < The use of |:set+=| and |:set-=| is preferred when adding or removing | |
8141 a pattern from the list. This avoids problems when a future version | |
8142 uses another default. | |
8143 | |
2652 | 8144 |
2662 | 8145 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'* |
2652 | 8146 'wildignorecase' 'wic' boolean (default off) |
8147 global | |
8148 {not in Vi} | |
8149 When set case is ignored when completing file names and directories. | |
4242 | 8150 Has no effect when 'fileignorecase' is set. |
2652 | 8151 Does not apply when the shell is used to expand wildcards, which |
8152 happens when there are special characters. | |
8153 | |
8154 | |
7 | 8155 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'* |
8156 'wildmenu' 'wmnu' boolean (default off) | |
8157 global | |
8158 {not in Vi} | |
8159 {not available if compiled without the |+wildmenu| | |
8160 feature} | |
8161 When 'wildmenu' is on, command-line completion operates in an enhanced | |
8162 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion, | |
8163 the possible matches are shown just above the command line, with the | |
8164 first match highlighted (overwriting the status line, if there is | |
8165 one). Keys that show the previous/next match, such as <Tab> or | |
8166 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match. | |
8167 When 'wildmode' is used, "wildmenu" mode is used where "full" is | |
8168 specified. "longest" and "list" do not start "wildmenu" mode. | |
4159 | 8169 You can check the current mode with |wildmenumode()|. |
7 | 8170 If there are more matches than can fit in the line, a ">" is shown on |
8171 the right and/or a "<" is shown on the left. The status line scrolls | |
8172 as needed. | |
8173 The "wildmenu" mode is abandoned when a key is hit that is not used | |
8174 for selecting a completion. | |
8175 While the "wildmenu" is active the following keys have special | |
8176 meanings: | |
8177 | |
8178 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N) | |
8179 <Down> - in filename/menu name completion: move into a | |
8180 subdirectory or submenu. | |
8181 <CR> - in menu completion, when the cursor is just after a | |
8182 dot: move into a submenu. | |
8183 <Up> - in filename/menu name completion: move up into | |
8184 parent directory or parent menu. | |
8185 | |
8186 This makes the menus accessible from the console |console-menus|. | |
8187 | |
8188 If you prefer the <Left> and <Right> keys to move the cursor instead | |
8189 of selecting a different match, use this: > | |
8190 :cnoremap <Left> <Space><BS><Left> | |
8191 :cnoremap <Right> <Space><BS><Right> | |
8192 < | |
8193 The "WildMenu" highlighting is used for displaying the current match | |
8194 |hl-WildMenu|. | |
8195 | |
8196 *'wildmode'* *'wim'* | |
8197 'wildmode' 'wim' string (Vim default: "full") | |
8198 global | |
8199 {not in Vi} | |
8200 Completion mode that is used for the character specified with | |
10 | 8201 'wildchar'. It is a comma separated list of up to four parts. Each |
1152 | 8202 part specifies what to do for each consecutive use of 'wildchar'. The |
7 | 8203 first part specifies the behavior for the first use of 'wildchar', |
8204 The second part for the second use, etc. | |
8205 These are the possible values for each part: | |
8206 "" Complete only the first match. | |
8207 "full" Complete the next full match. After the last match, | |
8208 the original string is used and then the first match | |
8209 again. | |
8210 "longest" Complete till longest common string. If this doesn't | |
8211 result in a longer string, use the next part. | |
8212 "longest:full" Like "longest", but also start 'wildmenu' if it is | |
8213 enabled. | |
8214 "list" When more than one match, list all matches. | |
8215 "list:full" When more than one match, list all matches and | |
8216 complete first match. | |
8217 "list:longest" When more than one match, list all matches and | |
8218 complete till longest common string. | |
8219 When there is only a single match, it is fully completed in all cases. | |
8220 | |
8221 Examples: > | |
8222 :set wildmode=full | |
233 | 8223 < Complete first full match, next match, etc. (the default) > |
7 | 8224 :set wildmode=longest,full |
8225 < Complete longest common string, then each full match > | |
8226 :set wildmode=list:full | |
8227 < List all matches and complete each full match > | |
8228 :set wildmode=list,full | |
8229 < List all matches without completing, then each full match > | |
8230 :set wildmode=longest,list | |
8231 < Complete longest common string, then list alternatives. | |
1621 | 8232 More info here: |cmdline-completion|. |
7 | 8233 |
40 | 8234 *'wildoptions'* *'wop'* |
8235 'wildoptions' 'wop' string (default "") | |
8236 global | |
8237 {not in Vi} | |
8238 {not available when compiled without the |+wildignore| | |
8239 feature} | |
8240 A list of words that change how command line completion is done. | |
8241 Currently only one word is allowed: | |
8242 tagfile When using CTRL-D to list matching tags, the kind of | |
856 | 8243 tag and the file of the tag is listed. Only one match |
40 | 8244 is displayed per line. Often used tag kinds are: |
8245 d #define | |
8246 f function | |
8247 Also see |cmdline-completion|. | |
8248 | |
7 | 8249 *'winaltkeys'* *'wak'* |
8250 'winaltkeys' 'wak' string (default "menu") | |
8251 global | |
8252 {not in Vi} | |
8253 {only used in Win32, Motif, GTK and Photon GUI} | |
8254 Some GUI versions allow the access to menu entries by using the ALT | |
8255 key in combination with a character that appears underlined in the | |
8256 menu. This conflicts with the use of the ALT key for mappings and | |
8257 entering special characters. This option tells what to do: | |
8258 no Don't use ALT keys for menus. ALT key combinations can be | |
8259 mapped, but there is no automatic handling. This can then be | |
8260 done with the |:simalt| command. | |
8261 yes ALT key handling is done by the windowing system. ALT key | |
8262 combinations cannot be mapped. | |
8263 menu Using ALT in combination with a character that is a menu | |
10 | 8264 shortcut key, will be handled by the windowing system. Other |
7 | 8265 keys can be mapped. |
8266 If the menu is disabled by excluding 'm' from 'guioptions', the ALT | |
8267 key is never used for the menu. | |
36 | 8268 This option is not used for <F10>; on Win32 and with GTK <F10> will |
8269 select the menu, unless it has been mapped. | |
7 | 8270 |
164 | 8271 *'window'* *'wi'* |
8272 'window' 'wi' number (default screen height - 1) | |
8273 global | |
8274 Window height. Do not confuse this with the height of the Vim window, | |
8275 use 'lines' for that. | |
179 | 8276 Used for |CTRL-F| and |CTRL-B| when there is only one window and the |
8277 value is smaller than 'lines' minus one. The screen will scroll | |
8278 'window' minus two lines, with a minimum of one. | |
164 | 8279 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll |
8280 in a much smarter way, taking care of wrapping lines. | |
8281 When resizing the Vim window, the value is smaller than 1 or more than | |
8282 or equal to 'lines' it will be set to 'lines' minus 1. | |
8283 {Vi also uses the option to specify the number of displayed lines} | |
8284 | |
7 | 8285 *'winheight'* *'wh'* *E591* |
8286 'winheight' 'wh' number (default 1) | |
8287 global | |
8288 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8289 {not available when compiled without the |+windows| |
7 | 8290 feature} |
8291 Minimal number of lines for the current window. This is not a hard | |
10 | 8292 minimum, Vim will use fewer lines if there is not enough room. If the |
1621 | 8293 focus goes to a window that is smaller, its size is increased, at the |
8294 cost of the height of other windows. | |
8295 Set 'winheight' to a small number for normal editing. | |
8296 Set it to 999 to make the current window fill most of the screen. | |
8297 Other windows will be only 'winminheight' high. This has the drawback | |
8298 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4" | |
8299 to create only two windows, set the option after startup is done, | |
8300 using the |VimEnter| event: > | |
8301 au VimEnter * set winheight=999 | |
8302 < Minimum value is 1. | |
8303 The height is not adjusted after one of the commands that change the | |
7 | 8304 height of the current window. |
8305 'winheight' applies to the current window. Use 'winminheight' to set | |
8306 the minimal height for other windows. | |
8307 | |
8308 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'* | |
8309 'winfixheight' 'wfh' boolean (default off) | |
8310 local to window | |
8311 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8312 {not available when compiled without the |+windows| |
7 | 8313 feature} |
8314 Keep the window height when windows are opened or closed and | |
1152 | 8315 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the |
8316 |preview-window| and |quickfix-window|. | |
7 | 8317 The height may be changed anyway when running out of room. |
8318 | |
782 | 8319 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'* |
8320 'winfixwidth' 'wfw' boolean (default off) | |
8321 local to window | |
8322 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8323 {not available when compiled without the |+windows| |
782 | 8324 feature} |
8325 Keep the window width when windows are opened or closed and | |
1152 | 8326 'equalalways' is set. Also for |CTRL-W_=|. |
782 | 8327 The width may be changed anyway when running out of room. |
8328 | |
7 | 8329 *'winminheight'* *'wmh'* |
8330 'winminheight' 'wmh' number (default 1) | |
8331 global | |
8332 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8333 {not available when compiled without the |+windows| |
7 | 8334 feature} |
8335 The minimal height of a window, when it's not the current window. | |
8336 This is a hard minimum, windows will never become smaller. | |
8337 When set to zero, windows may be "squashed" to zero lines (i.e. just a | |
8338 status bar) if necessary. They will return to at least one line when | |
8339 they become active (since the cursor has to have somewhere to go.) | |
8340 Use 'winheight' to set the minimal height of the current window. | |
8341 This option is only checked when making a window smaller. Don't use a | |
8342 large number, it will cause errors when opening more than a few | |
8343 windows. A value of 0 to 3 is reasonable. | |
8344 | |
8345 *'winminwidth'* *'wmw'* | |
8346 'winminwidth' 'wmw' number (default 1) | |
8347 global | |
8348 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8349 {not available when compiled without the |+vertsplit| |
7 | 8350 feature} |
8351 The minimal width of a window, when it's not the current window. | |
8352 This is a hard minimum, windows will never become smaller. | |
8353 When set to zero, windows may be "squashed" to zero columns (i.e. just | |
8354 a vertical separator) if necessary. They will return to at least one | |
8355 line when they become active (since the cursor has to have somewhere | |
8356 to go.) | |
8357 Use 'winwidth' to set the minimal width of the current window. | |
8358 This option is only checked when making a window smaller. Don't use a | |
8359 large number, it will cause errors when opening more than a few | |
8360 windows. A value of 0 to 12 is reasonable. | |
8361 | |
8362 *'winwidth'* *'wiw'* *E592* | |
8363 'winwidth' 'wiw' number (default 20) | |
8364 global | |
8365 {not in Vi} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8366 {not available when compiled without the |+vertsplit| |
7 | 8367 feature} |
8368 Minimal number of columns for the current window. This is not a hard | |
8369 minimum, Vim will use fewer columns if there is not enough room. If | |
8370 the current window is smaller, its size is increased, at the cost of | |
8371 the width of other windows. Set it to 999 to make the current window | |
8372 always fill the screen. Set it to a small number for normal editing. | |
8373 The width is not adjusted after one of the commands to change the | |
8374 width of the current window. | |
8375 'winwidth' applies to the current window. Use 'winminwidth' to set | |
8376 the minimal width for other windows. | |
8377 | |
8378 *'wrap'* *'nowrap'* | |
8379 'wrap' boolean (default on) | |
8380 local to window | |
8381 {not in Vi} | |
8382 This option changes how text is displayed. It doesn't change the text | |
8383 in the buffer, see 'textwidth' for that. | |
8384 When on, lines longer than the width of the window will wrap and | |
10 | 8385 displaying continues on the next line. When off lines will not wrap |
8386 and only part of long lines will be displayed. When the cursor is | |
7 | 8387 moved to a part that is not shown, the screen will scroll |
8388 horizontally. | |
8389 The line will be broken in the middle of a word if necessary. See | |
8390 'linebreak' to get the break at a word boundary. | |
8391 To make scrolling horizontally a bit more useful, try this: > | |
8392 :set sidescroll=5 | |
8393 :set listchars+=precedes:<,extends:> | |
8394 < See 'sidescroll', 'listchars' and |wrap-off|. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
8395 This option can't be set from a |modeline| when the 'diff' option is |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
8396 on. |
7 | 8397 |
8398 *'wrapmargin'* *'wm'* | |
8399 'wrapmargin' 'wm' number (default 0) | |
8400 local to buffer | |
8401 Number of characters from the right window border where wrapping | |
8402 starts. When typing text beyond this limit, an <EOL> will be inserted | |
8403 and inserting continues on the next line. | |
8404 Options that add a margin, such as 'number' and 'foldcolumn', cause | |
8405 the text width to be further reduced. This is Vi compatible. | |
8406 When 'textwidth' is non-zero, this option is not used. | |
8407 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently | |
8408 and less usefully} | |
8409 | |
8410 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'* | |
8411 'wrapscan' 'ws' boolean (default on) *E384* *E385* | |
8412 global | |
500 | 8413 Searches wrap around the end of the file. Also applies to |]s| and |
8414 |[s|, searching for spelling mistakes. | |
7 | 8415 |
8416 *'write'* *'nowrite'* | |
8417 'write' boolean (default on) | |
8418 global | |
8419 {not in Vi} | |
8420 Allows writing files. When not set, writing a file is not allowed. | |
8421 Can be used for a view-only mode, where modifications to the text are | |
10 | 8422 still allowed. Can be reset with the |-m| or |-M| command line |
7 | 8423 argument. Filtering text is still possible, even though this requires |
8424 writing a temporary file. | |
8425 | |
8426 *'writeany'* *'wa'* *'nowriteany'* *'nowa'* | |
8427 'writeany' 'wa' boolean (default off) | |
8428 global | |
8429 Allows writing to any file with no need for "!" override. | |
8430 | |
8431 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'* | |
8432 'writebackup' 'wb' boolean (default on with |+writebackup| feature, off | |
8433 otherwise) | |
8434 global | |
8435 {not in Vi} | |
8436 Make a backup before overwriting a file. The backup is removed after | |
8437 the file was successfully written, unless the 'backup' option is | |
3513 | 8438 also on. |
8439 WARNING: Switching this option off means that when Vim fails to write | |
8440 your buffer correctly and then, for whatever reason, Vim exits, you | |
8441 lose both the original file and what you were writing. Only reset | |
8442 this option if your file system is almost full and it makes the write | |
8443 fail (and make sure not to exit Vim until the write was successful). | |
8444 See |backup-table| for another explanation. | |
7 | 8445 When the 'backupskip' pattern matches, a backup is not made anyway. |
8446 NOTE: This option is set to the default value when 'compatible' is | |
8447 set. | |
8448 | |
8449 *'writedelay'* *'wd'* | |
8450 'writedelay' 'wd' number (default 0) | |
8451 global | |
8452 {not in Vi} | |
8453 The number of microseconds to wait for each character sent to the | |
8454 screen. When non-zero, characters are sent to the terminal one by | |
8455 one. For MS-DOS pcterm this does not work. For debugging purposes. | |
8456 | |
8457 vim:tw=78:ts=8:ft=help:norl: |