blob: cea358899bf213e770b84dd8430f1bf31d7349fc [file] [log] [blame]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00001*options.txt* For Vim version 7.0aa. Last change: 2005 Dec 12
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
13For an overview of options see help.txt |option-list|.
14
15Vim has a number of internal variables and switches which can be set to
16achieve 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==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
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
43:se[t] {option}! or
44:se[t] inv{option} Toggle option: Invert value. {not in Vi}
45
46 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
47:se[t] {option}& Reset option to its default value. May depend on the
48 current value of 'compatible'. {not in Vi}
49:se[t] {option}&vi Reset option to its Vi default value. {not in Vi}
50:se[t] {option}&vim Reset option to its Vim default value. {not in Vi}
51
52:se[t] all& Set all options, except terminal options, to their
Bram Moolenaarf4b8e572004-06-24 15:53:16 +000053 default value. The values of 'term', 'lines' and
Bram Moolenaar071d4272004-06-13 20:20:40 +000054 'columns' are not changed. {not in Vi}
55
56 *:set-args* *E487* *E521*
57:se[t] {option}={value} or
58:se[t] {option}:{value}
59 Set string or number option to {value}.
60 For numeric options the value can be given in decimal,
61 hex (preceded with 0x) or octal (preceded with '0')
62 (hex and octal are only available for machines which
63 have the strtol() function).
64 The old value can be inserted by typing 'wildchar' (by
65 default this is a <Tab> or CTRL-E if 'compatible' is
66 set). See |cmdline-completion|.
67 White space between {option} and '=' is allowed and
68 will be ignored. White space between '=' and {value}
69 is not allowed.
70 See |option-backslash| for using white space and
71 backslashes in {value}.
72
73:se[t] {option}+={value} *:set+=*
74 Add the {value} to a number option, or append the
75 {value} to a string option. When the option is a
76 comma separated list, a comma is added, unless the
77 value was empty.
78 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000079 are removed. When adding a flag that was already
80 present the option value doesn't change.
Bram Moolenaar071d4272004-06-13 20:20:40 +000081< Also see |:set-args| above.
82 {not in Vi}
83
84:se[t] {option}^={value} *:set^=*
85 Multiply the {value} to a number option, or prepend
86 the {value} to a string option. When the option is a
87 comma separated list, a comma is added, unless the
88 value was empty.
89 Also see |:set-args| above.
90 {not in Vi}
91
92:se[t] {option}-={value} *:set-=*
93 Subtract the {value} from a number option, or remove
94 the {value} from a string option, if it is there.
95 If the {value} is not found in a string option, there
96 is no error or warning. When the option is a comma
97 separated list, a comma is deleted, unless the option
98 becomes empty.
99 When the option is a list of flags, {value} must be
100 exactly as they appear in the option. Remove flags
101 one by one to avoid problems.
102 Also see |:set-args| above.
103 {not in Vi}
104
105The {option} arguments to ":set" may be repeated. For example: >
106 :set ai nosi sw=3 ts=3
107If you make an error in one of the arguments, an error message will be given
108and the following arguments will be ignored.
109
110 *:set-verbose*
111When 'verbose' is non-zero, displaying an option value will also tell where it
112was last set. Example: >
113 :verbose set shiftwidth cindent?
114 shiftwidth=4
115 Last set from modeline
116 cindent
117 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim
118This is only done when specific option values are requested, not for ":set
119all" or ":set" without an argument.
120When the option was set by hand there is no "Last set" message. There is only
121one value for all local options with the same name. Thus the message applies
122to the option name, not necessarily its value.
123When the option was set while executing a function, user command or
124autocommand, the script in which it was defined is reported.
125Note that an option may also have been set as a side effect of setting
126'compatible'.
127{not available when compiled without the +eval feature}
128
129 *:set-termcap* *E522*
130For {option} the form "t_xx" may be used to set a termcap option. This will
131override the value from the termcap. You can then use it in a mapping. If
132the "xx" part contains special characters, use the <t_xx> form: >
133 :set <t_#4>=^[Ot
134This can also be used to translate a special code for a normal key. For
135example, if Alt-b produces <Esc>b, use this: >
136 :set <M-b>=^[b
137(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
138The advantage over a mapping is that it works in all situations.
139
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000140The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
141security reasons.
142
Bram Moolenaar071d4272004-06-13 20:20:40 +0000143The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000144at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000145"set all" probably does not fit on the screen, causing Vim to give the
146|more-prompt|.
147
148 *option-backslash*
149To include white space in a string option value it has to be preceded with a
150backslash. To include a backslash you have to use two. Effectively this
151means that the number of backslashes in an option value is halved (rounded
152down).
153A few examples: >
154 :set tags=tags\ /usr/tags results in "tags /usr/tags"
155 :set tags=tags\\,file results in "tags\,file"
156 :set tags=tags\\\ file results in "tags\ file"
157
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000158The "|" character separates a ":set" command from a following command. To
159include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000160'titlestring' option to "hi|there": >
161 :set titlestring=hi\|there
162This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
163 :set titlestring=hi|set iconstring=there
164
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000165For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000166precise: For options that expect a file name (those where environment
167variables are expanded) a backslash before a normal file name character is not
168removed. But a backslash before a special character (space, backslash, comma,
169etc.) is used like explained above.
170There is one special situation, when the value starts with "\\": >
171 :set dir=\\machine\path results in "\\machine\path"
172 :set dir=\\\\machine\\path results in "\\machine\path"
173 :set dir=\\path\\file results in "\\path\file" (wrong!)
174For the first one the start is kept, but for the second one the backslashes
175are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000176halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000177result which is probably not what you want. Avoid it.
178
179 *add-option-flags* *remove-option-flags*
180 *E539* *E550* *E551* *E552*
181Some options are a list of flags. When you want to add a flag to such an
182option, without changing the existing ones, you can do it like this: >
183 :set guioptions+=a
184Remove a flag from an option like this: >
185 :set guioptions-=a
186This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000187Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000188the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
189doesn't appear.
190
191 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000192Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000193environment variable exists the '$' and the following environment variable
194name is replaced with its value. If it does not exist the '$' and the name
195are not modified. Any non-id character (not a letter, digit or '_') may
196follow the environment variable name. That character and what follows is
197appended to the value of the environment variable. Examples: >
198 :set term=$TERM.new
199 :set path=/usr/$INCLUDE,$HOME/include,.
200When adding or removing a string from an option with ":set opt-=val" or ":set
201opt+=val" the expansion is done before the adding or removing.
202
203
204Handling of local options *local-options*
205
206Some of the options only apply to a window or buffer. Each window or buffer
207has its own copy of this option, thus can each have their own value. This
208allows you to set 'list' in one window but not in another. And set
209'shiftwidth' to 3 in one buffer and 4 in another.
210
211The following explains what happens to these local options in specific
212situations. You don't really need to know all of this, since Vim mostly uses
213the option values you would expect. Unfortunately, doing what the user
214expects is a bit complicated...
215
216When splitting a window, the local options are copied to the new window. Thus
217right after the split the contents of the two windows look the same.
218
219When editing a new buffer, its local option values must be initialized. Since
220the local options of the current buffer might be specifically for that buffer,
221these are not used. Instead, for each buffer-local option there also is a
222global value, which is used for new buffers. With ":set" both the local and
223global value is changed. With "setlocal" only the local value is changed,
224thus this value is not used when editing a new buffer.
225
226When editing a buffer that has been edited before, the last used window
227options are used again. If this buffer has been edited in this window, the
228values from back then are used. Otherwise the values from the window where
229the buffer was edited last are used.
230
231It's possible to set a local window option specifically for a type of buffer.
232When you edit another buffer in the same window, you don't want to keep
233using these local window options. Therefore Vim keeps a global value of the
234local window options, which is used when editing another buffer. Each window
235has its own copy of these values. Thus these are local to the window, but
236global to all buffers in the window. With this you can do: >
237 :e one
238 :set list
239 :e two
240Now the 'list' option will also be set in "two", since with the ":set list"
241command you have also set the global value. >
242 :set nolist
243 :e one
244 :setlocal list
245 :e two
246Now the 'list' option is not set, because ":set nolist" resets the global
247value, ":setlocal list" only changes the local value and ":e two" gets the
248global value. Note that if you do this next: >
249 :e one
250You will not get back the 'list' value as it was the last time you edited
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000251"one". The options local to a window are not remembered for each buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000252
253 *:setl* *:setlocal*
254:setl[ocal] ... Like ":set" but set only the value local to the
255 current buffer or window. Not all options have a
256 local value. If the option does not have a local
257 value the global value is set.
258 With the "all" argument: display all local option's
259 local values.
260 Without argument: Display all local option's local
261 values which are different from the default.
262 When displaying a specific local option, show the
263 local value. For a global option the global value is
264 shown (but that might change in the future).
265 {not in Vi}
266
267:setl[ocal] {option}< Set the local value of {option} to its global value.
268 {not in Vi}
269
270 *:setg* *:setglobal*
271:setg[lobal] ... Like ":set" but set only the global value for a local
272 option without changing the local value.
273 When displaying an option, the global value is shown.
274 With the "all" argument: display all local option's
275 global values.
276 Without argument: display all local option's global
277 values which are different from the default.
278 {not in Vi}
279
280For buffer-local and window-local options:
281 Command global value local value ~
282 :set option=value set set
283 :setlocal option=value - set
284:setglobal option=value set -
285 :set option? - display
286 :setlocal option? - display
287:setglobal option? display -
288
289
290Global options with a local value *global-local*
291
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000292Options are global when you mostly use one value for all buffers and windows.
293For some global options it's useful to sometimes have a different local value.
294You can set the local value with ":setlocal". That buffer or window will then
295use the local value, while other buffers and windows continue using the global
296value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000297
298For example, you have two windows, both on C source code. They use the global
299'makeprg' option. If you do this in one of the two windows: >
300 :set makeprg=gmake
301then the other window will switch to the same value. There is no need to set
302the 'makeprg' option in the other C source window too.
303However, if you start editing a Perl file in a new window, you want to use
304another 'makeprog' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000305files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000306 :setlocal makeprg=perlmake
307You can switch back to using the global value by making the local value empty: >
308 :setlocal makeprg=
309This only works for a string option. For a boolean option you need to use the
310"<" flag, like this: >
311 :setlocal autoread<
312Note that for non-boolean options using "<" copies the global value to the
313local value, it doesn't switch back to using the global value (that matters
314when changing the global value later).
315Note: In the future more global options can be made global-local. Using
316":setlocal" on a global option might work differently then.
317
318
319Setting the filetype
320
321:setf[iletype] {filetype} *:setf* *:setfiletype*
322 Set the 'filetype' option to {filetype}, but only if
323 not done yet in a sequence of (nested) autocommands.
324 This is short for: >
325 :if !did_filetype()
326 : setlocal filetype={filetype}
327 :endif
328< This command is used in a filetype.vim file to avoid
329 setting the 'filetype' option twice, causing different
330 settings and syntax files to be loaded.
331 {not in Vi}
332
333:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
334:opt[ions] Open a window for viewing and setting all options.
335 Options are grouped by function.
336 Offers short help for each option. Hit <CR> on the
337 short help to open a help window with more help for
338 the option.
339 Modify the value of the option and hit <CR> on the
340 "set" line to set the new value. For window and
341 buffer specific options, the last accessed window is
342 used to set the option value in, unless this is a help
343 window, in which case the window below help window is
344 used (skipping the option-window).
345 {not available when compiled without the |+eval| or
346 |+autocmd| features}
347
348 *$HOME*
349Using "~" is like using "$HOME", but it is only recognized at the start of an
350option and after a space or comma.
351
352On Unix systems "~user" can be used too. It is replaced by the home directory
353of user "user". Example: >
354 :set path=~mool/include,/usr/include,.
355
356On Unix systems the form "${HOME}" can be used too. The name between {} can
357contain non-id characters then. Note that if you want to use this for the
358"gf" command, you need to add the '{' and '}' characters to 'isfname'.
359
360NOTE: expanding environment variables and "~/" is only done with the ":set"
361command, not when assigning a value to an option with ":let".
362
363
364Note the maximum length of an expanded option is limited. How much depends on
365the system, mostly it is something like 256 or 1024 characters.
366
367 *:fix* *:fixdel*
368:fix[del] Set the value of 't_kD':
369 't_kb' is 't_kD' becomes ~
370 CTRL-? CTRL-H
371 not CTRL-? CTRL-?
372
373 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
374
375 If your delete key terminal code is wrong, but the
376 code for backspace is alright, you can put this in
377 your .vimrc: >
378 :fixdel
379< This works no matter what the actual code for
380 backspace is.
381
382 If the backspace key terminal code is wrong you can
383 use this: >
384 :if &term == "termname"
385 : set t_kb=^V<BS>
386 : fixdel
387 :endif
388< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000389 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000390 with your terminal name.
391
392 If your <Delete> key sends a strange key sequence (not
393 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
394 :if &term == "termname"
395 : set t_kD=^V<Delete>
396 :endif
397< Where "^V" is CTRL-V and "<Delete>" is the delete key
398 (don't type eight characters!). Replace "termname"
399 with your terminal name.
400
401 *Linux-backspace*
402 Note about Linux: By default the backspace key
403 produces CTRL-?, which is wrong. You can fix it by
404 putting this line in your rc.local: >
405 echo "keycode 14 = BackSpace" | loadkeys
406<
407 *NetBSD-backspace*
408 Note about NetBSD: If your backspace doesn't produce
409 the right code, try this: >
410 xmodmap -e "keycode 22 = BackSpace"
411< If this works, add this in your .Xmodmap file: >
412 keysym 22 = BackSpace
413< You need to restart for this to take effect.
414
415==============================================================================
4162. Automatically setting options *auto-setting*
417
418Besides changing options with the ":set" command, there are three alternatives
419to set options automatically for one or more files:
420
4211. When starting Vim initializations are read from various places. See
422 |initialization|. Most of them are performed for all editing sessions,
423 and some of them depend on the directory where Vim is started.
424 You can create an initialization file with |:mkvimrc|, |:mkview| and
425 |:mksession|.
4262. If you start editing a new file, the automatic commands are executed.
427 This can be used to set options for files matching a particular pattern and
428 many other things. See |autocommand|.
4293. If you start editing a new file, and the 'modeline' option is on, a
430 number of lines at the beginning and end of the file are checked for
431 modelines. This is explained here.
432
433 *modeline* *vim:* *vi:* *ex:* *E520*
434There are two forms of modelines. The first form:
435 [text]{white}{vi:|vim:|ex:}[white]{options}
436
437[text] any text or empty
438{white} at least one blank character (<Space> or <Tab>)
439{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
440[white] optional white space
441{options} a list of option settings, separated with white space or ':',
442 where each part between ':' is the argument for a ":set"
443 command
444
445Example: >
446 vi:noai:sw=3 ts=6
447
448The second form (this is compatible with some versions of Vi):
449
450 [text]{white}{vi:|vim:|ex:}[white]se[t] {options}:[text]
451
452[text] any text or empty
453{white} at least one blank character (<Space> or <Tab>)
454{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
455[white] optional white space
456se[t] the string "set " or "se " (note the space)
457{options} a list of options, separated with white space, which is the
458 argument for a ":set" command
459: a colon
460[text] any text or empty
461
462Example: >
463 /* vim: set ai tw=75: */
464
465The white space before {vi:|vim:|ex:} is required. This minimizes the chance
466that a normal word like "lex:" is caught. There is one exception: "vi:" and
467"vim:" can also be at the start of the line (for compatibility with version
4683.0). Using "ex:" at the start of the line will be ignored (this could be
469short for "example:").
470
471 *modeline-local*
472The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000473buffer and window that contain the file. Although it's possible to set global
474options from a modeline, this is unusual. If you have two windows open and
475the files in it set the same global option to a different value, the result
476depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000477
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000478When editing a file that was already loaded, only the window-local options
479from the modeline are used. Thus if you manually changed a buffer-local
480option after opening the file, it won't be changed if you edit the same buffer
481in another window. But window-local options will be set.
482
Bram Moolenaar071d4272004-06-13 20:20:40 +0000483 *modeline-version*
484If the modeline is only to be used for some versions of Vim, the version
485number can be specified where "vim:" is used:
486 vim{vers}: version {vers} or later
487 vim<{vers}: version before {vers}
488 vim={vers}: version {vers}
489 vim>{vers}: version after {vers}
490{vers} is 600 for Vim 6.0 (hundred times the major version plus minor).
491For example, to use a modeline only for Vim 6.0 and later: >
492 /* vim600: set foldmethod=marker: */
493To use a modeline for Vim before version 5.7: >
494 /* vim<570: set sw=4: */
495There can be no blanks between "vim" and the ":".
496
497
498The number of lines that are checked can be set with the 'modelines' option.
499If 'modeline' is off or 'modelines' is 0 no lines are checked.
500
501Note that for the first form all of the rest of the line is used, thus a line
502like: >
503 /* vi:ts=4: */
504will give an error message for the trailing "*/". This line is OK: >
505 /* vi:set ts=4: */
506
507If an error is detected the rest of the line is skipped.
508
509If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000510backslash in front of the ':' will be removed. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000511 /* vi:set dir=c\:\tmp: */
512This sets the 'dir' option to "c:\tmp". Only a single backslash before the
513':' is removed. Thus to include "\:" you have to specify "\\:".
514
515No other commands than "set" are supported, for security reasons (somebody
516might create a Trojan horse text file with modelines).
517
518Hint: If you would like to do something else than setting an option, you could
519define an autocommand that checks the file for a specific string. For
520example: >
521 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
522And define a function SetVar() that does something with the line containing
523"VAR".
524
525==============================================================================
5263. Options summary *option-summary*
527
528In the list below all the options are mentioned with their full name and with
529an abbreviation if there is one. Both forms may be used.
530
531In this document when a boolean option is "set" that means that ":set option"
532is entered. When an option is "reset", ":set nooption" is used.
533
534For some options there are two default values: The "Vim default", which is
535used when 'compatible' is not set, and the "Vi default", which is used when
536'compatible' is set.
537
538Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000539are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000540different value in each window. For example the 'list' option can be set in
541one window and reset in another for the same text, giving both types of view
542at the same time. There are a few options that are specific to a certain
543file. These can have a different value for each file or buffer. For example
544the 'textwidth' option can be 78 for a normal text file and 0 for a C
545program.
546
547 global one option for all buffers and windows
548 local to window each window has its own copy of this option
549 local to buffer each buffer has its own copy of this option
550
551When creating a new window the option values from the currently active window
552are used as a default value for the window-specific options. For the
553buffer-specific options this depends on the 's' and 'S' flags in the
554'cpoptions' option. If 's' is included (which is the default) the values for
555buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000556first entered. If 'S' is present the options are copied each time the buffer
557is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000558present, the options are copied from the currently active buffer when the
559buffer is created.
560
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000561Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000562
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000563Not all options are supported in all versions. This depends on the supported
564features and sometimes on the system. A remark about this is in curly braces
565below. When an option is not supported it may still be set without getting an
566error, this is called a hidden option. You can't get the value of a hidden
567option though, it is not stored.
568
569To test if option "foo" can be used with ":set" use something like this: >
570 if exists('&foo')
571This also returns true for a hidden option. To test if option "foo" is really
572supported use something like this: >
573 if exists('+foo')
574<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000575 *E355*
576A jump table for the options with a short description can be found at |Q_op|.
577
578 *'aleph'* *'al'* *aleph* *Aleph*
579'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
580 global
581 {not in Vi}
582 {only available when compiled with the |+rightleft|
583 feature}
584 The ASCII code for the first letter of the Hebrew alphabet. The
585 routine that maps the keyboard in Hebrew mode, both in Insert mode
586 (when hkmap is set) and on the command-line (when hitting CTRL-_)
587 outputs the Hebrew characters in the range [aleph..aleph+26].
588 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
589 See |rileft.txt|.
590
591 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
592'allowrevins' 'ari' boolean (default off)
593 global
594 {not in Vi}
595 {only available when compiled with the |+rightleft|
596 feature}
597 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
598 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
599 into reverse Insert mode, and don't know how to get out. See
600 'revins'.
601 NOTE: This option is reset when 'compatible' is set.
602
603 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
604'altkeymap' 'akm' boolean (default off)
605 global
606 {not in Vi}
607 {only available when compiled with the |+farsi|
608 feature}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000609 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000610 the keyboard map between Farsi and English, when 'allowrevins' set.
611
Bram Moolenaar582fd852005-03-28 20:58:01 +0000612 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000613 is useful to start the Vim in native mode i.e. English (left-to-right
614 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000615 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000616
617 *'ambiwidth'* *'ambw'*
618'ambiwidth' 'ambw' string (default: "single")
619 global
620 {not in Vi}
621 {only available when compiled with the |+multi_byte|
622 feature}
623 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
624 Tells Vim what to do with characters with East Asian Width Class
625 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
626 letters, Cyrillic letters).
627
628 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000629 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000630 expected by most users.
631 "double": Use twice the width of ASCII characters.
632
633 There are a number of CJK fonts for which the width of glyphs for
634 those characters are solely based on how many octets they take in
635 legacy/traditional CJK encodings. In those encodings, Euro,
636 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000637 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000638 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000639 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000640 Vim is running inside a terminal (emulators) that uses a CJK font
641 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
642 this option should be set to "double" to match the width perceived
643 by Vim with the width of glyphs in the font. Perhaps it also has
644 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
645 when the system locale is set to one of CJK locales. See Unicode
646 Standard Annex #11 (http://www.unicode.org/reports/tr11).
647
648 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
649'antialias' 'anti' boolean (default: off)
650 global
651 {not in Vi}
652 {only available when compiled with GUI enabled
653 on Mac OS X}
654 This option only has an effect in the GUI version of Vim on Mac OS X
655 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
656 which can be easier to read at certain sizes on certain displays.
657 Setting this option can sometimes cause problems if 'guifont' is set
658 to its default (empty string).
659
660 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
661'autochdir' 'acd' boolean (default off)
662 global
663 {not in Vi}
664 {only available when compiled with the
665 |+netbeans_intg| or |+sun_workshop| feature}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000666 When on, Vim will change the current working directory whenever you
667 open a file, switch buffers, delete a buffer or open/close a window.
668 It will change to the directory containing the file which was opened
669 or selected.
670 This option is provided for backward compatibility with the Vim
671 released with Sun ONE Studio 4 Enterprise Edition.
672 Note: When this option is on some plugins may not work. The directory
673 browser sets if off.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000674
675 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
676'arabic' 'arab' boolean (default off)
677 local to window
678 {not in Vi}
679 {only available when compiled with the |+arabic|
680 feature}
681 This option can be set to start editing Arabic text.
682 Setting this option will:
683 - Set the 'rightleft' option, unless 'termbidi' is set.
684 - Set the 'arabicshape' option, unless 'termbidi' is set.
685 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
686 between typing English and Arabic key mapping.
687 - Set the 'delcombine' option
688 Note that 'encoding' must be "utf-8" for working with Arabic text.
689
690 Resetting this option will:
691 - Reset the 'rightleft' option.
692 - Disable the use of 'keymap' (without changing its value).
693 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
694 option.
695 Also see |arabic.txt|.
696
697 *'arabicshape'* *'arshape'*
698 *'noarabicshape'* *'noarshape'*
699'arabicshape' 'arshape' boolean (default on)
700 global
701 {not in Vi}
702 {only available when compiled with the |+arabic|
703 feature}
704 When on and 'termbidi' is off, the required visual character
705 corrections that need to take place for displaying the Arabic language
706 take affect. Shaping, in essence, gets enabled; the term is a broad
707 one which encompasses:
708 a) the changing/morphing of characters based on their location
709 within a word (initial, medial, final and stand-alone).
710 b) the enabling of the ability to compose characters
711 c) the enabling of the required combining of some characters
712 When disabled the character display reverts back to each character's
713 true stand-alone form.
714 Arabic is a complex language which requires other settings, for
715 further details see |arabic.txt|.
716
717 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
718'autoindent' 'ai' boolean (default off)
719 local to buffer
720 Copy indent from current line when starting a new line (typing <CR>
721 in Insert mode or when using the "o" or "O" command). If you do not
722 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000723 <Esc> or <CR>, the indent is deleted again. Moving the cursor to
724 another line has the same effect, unless the 'I' flag is included in
725 'cpoptions'.
726 When autoindent is on, formatting (with the "gq" command or when you
727 reach 'textwidth' in Insert mode) uses the indentation of the first
728 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000729 When 'smartindent' or 'cindent' is on the indent is changed in
730 a different way.
731 The 'autoindent' option is reset when the 'paste' option is set.
732 {small difference from Vi: After the indent is deleted when typing
733 <Esc> or <CR>, the cursor position when moving up or down is after the
734 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
735
736 *'autoread'* *'ar'* *'noautoread'* *'noar'*
737'autoread' 'ar' boolean (default off)
738 global or local to buffer |global-local|
739 {not in Vi}
740 When a file has been detected to have been changed outside of Vim and
741 it has not been changed inside of Vim, automatically read it again.
742 When the file has been deleted this is not done. |timestamp|
743 If this option has a local value, use this command to switch back to
744 using the global value: >
745 :set autoread<
746<
747 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
748'autowrite' 'aw' boolean (default off)
749 global
750 Write the contents of the file, if it has been modified, on each
751 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
752 :make, CTRL-] and CTRL-^ command; and when a CTRL-O, CTRL-I,
753 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
754 Note that for some commands the 'autowrite' option is not used, see
755 'autowriteall' for that.
756
757 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
758'autowriteall' 'awa' boolean (default off)
759 global
760 {not in Vi}
761 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
762 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
763 Setting this option also implies that Vim behaves like 'autowrite' has
764 been set.
765
766 *'background'* *'bg'*
767'background' 'bg' string (default "dark" or "light")
768 global
769 {not in Vi}
770 When set to "dark", Vim will try to use colors that look good on a
771 dark background. When set to "light", Vim will try to use colors that
772 look good on a light background. Any other value is illegal.
773 Vim tries to set the default value according to the terminal used.
774 This will not always be correct.
775 Setting this option does not change the background color, it tells Vim
776 what the background color looks like. For changing the background
777 color, see |:hi-normal|.
778
779 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000780 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000781 change.
782 When a color scheme is loaded (the "colors_name" variable is set)
783 setting 'background' will cause the color scheme to be reloaded. If
784 the color scheme adjusts to the value of 'background' this will work.
785 However, if the color scheme sets 'background' itself the effect may
786 be undone. First delete the "colors_name" variable when needed.
787
788 When setting 'background' to the default value with: >
789 :set background&
790< Vim will guess the value. In the GUI this should work correctly,
791 in other cases Vim might not be able to guess the right value.
792
793 When starting the GUI, the default value for 'background' will be
794 "light". When the value is not set in the .gvimrc, and Vim detects
795 that the background is actually quite dark, 'background' is set to
796 "dark". But this happens only AFTER the .gvimrc file has been read
797 (because the window needs to be opened to find the actual background
798 color). To get around this, force the GUI window to be opened by
799 putting a ":gui" command in the .gvimrc file, before where the value
800 of 'background' is used (e.g., before ":syntax on").
801 Normally this option would be set in the .vimrc file. Possibly
802 depending on the terminal name. Example: >
803 :if &term == "pcterm"
804 : set background=dark
805 :endif
806< When this option is set, the default settings for the highlight groups
807 will change. To use other settings, place ":highlight" commands AFTER
808 the setting of the 'background' option.
809 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
810 to select the colors for syntax highlighting. After changing this
811 option, you must load syntax.vim again to see the result. This can be
812 done with ":syntax on".
813
814 *'backspace'* *'bs'*
815'backspace' 'bs' string (default "")
816 global
817 {not in Vi}
818 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
819 mode. This is a list of items, separated by commas. Each item allows
820 a way to backspace over something:
821 value effect ~
822 indent allow backspacing over autoindent
823 eol allow backspacing over line breaks (join lines)
824 start allow backspacing over the start of insert; CTRL-W and CTRL-U
825 stop once at the start of insert.
826
827 When the value is empty, Vi compatible backspacing is used.
828
829 For backwards compatibility with version 5.4 and earlier:
830 value effect ~
831 0 same as ":set backspace=" (Vi compatible)
832 1 same as ":set backspace=indent,eol"
833 2 same as ":set backspace=indent,eol,start"
834
835 See |:fixdel| if your <BS> or <Del> key does not do what you want.
836 NOTE: This option is set to "" when 'compatible' is set.
837
838 *'backup'* *'bk'* *'nobackup'* *'nobk'*
839'backup' 'bk' boolean (default off)
840 global
841 {not in Vi}
842 Make a backup before overwriting a file. Leave it around after the
843 file has been successfully written. If you do not want to keep the
844 backup file, but you do want a backup while the file is being
845 written, reset this option and set the 'writebackup' option (this is
846 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000847 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000848 |backup-table| for more explanations.
849 When the 'backupskip' pattern matches, a backup is not made anyway.
850 When 'patchmode' is set, the backup may be renamed to become the
851 oldest version of a file.
852 NOTE: This option is reset when 'compatible' is set.
853
854 *'backupcopy'* *'bkc'*
855'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
856 global
857 {not in Vi}
858 When writing a file and a backup is made, this option tells how it's
859 done. This is a comma separated list of words.
860
861 The main values are:
862 "yes" make a copy of the file and overwrite the original one
863 "no" rename the file and write a new one
864 "auto" one of the previous, what works best
865
866 Extra values that can be combined with the ones above are:
867 "breaksymlink" always break symlinks when writing
868 "breakhardlink" always break hardlinks when writing
869
870 Making a copy and overwriting the original file:
871 - Takes extra time to copy the file.
872 + When the file has special attributes, is a (hard/symbolic) link or
873 has a resource fork, all this is preserved.
874 - When the file is a link the backup will have the name of the link,
875 not of the real file.
876
877 Renaming the file and writing a new one:
878 + It's fast.
879 - Sometimes not all attributes of the file can be copied to the new
880 file.
881 - When the file is a link the new file will not be a link.
882
883 The "auto" value is the middle way: When Vim sees that renaming file
884 is possible without side effects (the attributes can be passed on and
885 and the file is not a link) that is used. When problems are expected,
886 a copy will be made.
887
888 The "breaksymlink" and "breakhardlink" values can be used in
889 combination with any of "yes", "no" and "auto". When included, they
890 force Vim to always break either symbolic or hard links by doing
891 exactly what the "no" option does, renaming the original file to
892 become the backup and writing a new file in its place. This can be
893 useful for example in source trees where all the files are symbolic or
894 hard links and any changes should stay in the local source tree, not
895 be propagated back to the original source.
896 *crontab*
897 One situation where "no" and "auto" will cause problems: A program
898 that opens a file, invokes Vim to edit that file, and then tests if
899 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000900 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000901 example.
902
903 When a copy is made, the original file is truncated and then filled
904 with the new text. This means that protection bits, owner and
905 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000906 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000907 group of the backup is set to the group of the original file. If this
908 fails, the protection bits for the group are made the same as for
909 others.
910
911 When the file is renamed this is the other way around: The backup has
912 the same attributes of the original file, and the newly written file
913 is owned by the current user. When the file was a (hard/symbolic)
914 link, the new file will not! That's why the "auto" value doesn't
915 rename when the file is a link. The owner and group of the newly
916 written file will be set to the same ones as the original file, but
917 the system may refuse to do this. In that case the "auto" value will
918 again not rename the file.
919
920 *'backupdir'* *'bdir'*
921'backupdir' 'bdir' string (default for Amiga: ".,t:",
922 for MS-DOS and Win32: ".,c:/tmp,c:/temp"
923 for Unix: ".,~/tmp,~/")
924 global
925 {not in Vi}
926 List of directories for the backup file, separated with commas.
927 - The backup file will be created in the first directory in the list
928 where this is possible.
929 - Empty means that no backup file will be created ('patchmode' is
930 impossible!). Writing may fail because of this.
931 - A directory "." means to put the backup file in the same directory
932 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +0000933 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000934 put the backup file relative to where the edited file is. The
935 leading "." is replaced with the path name of the edited file.
936 ("." inside a directory name has no special meaning).
937 - Spaces after the comma are ignored, other spaces are considered part
938 of the directory name. To have a space at the start of a directory
939 name, precede it with a backslash.
940 - To include a comma in a directory name precede it with a backslash.
941 - A directory name may end in an '/'.
942 - Environment variables are expanded |:set_env|.
943 - Careful with '\' characters, type one before a space, type two to
944 get one in the option (see |option-backslash|), for example: >
945 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
946< - For backwards compatibility with Vim version 3.0 a '>' at the start
947 of the option is removed.
948 See also 'backup' and 'writebackup' options.
949 If you want to hide your backup files on Unix, consider this value: >
950 :set backupdir=./.backup,~/.backup,.,/tmp
951< You must create a ".backup" directory in each directory and in your
952 home directory for this to work properly.
953 The use of |:set+=| and |:set-=| is preferred when adding or removing
954 directories from the list. This avoids problems when a future version
955 uses another default.
956 This option cannot be set from a |modeline| or in the |sandbox|, for
957 security reasons.
958
959 *'backupext'* *'bex'* *E589*
960'backupext' 'bex' string (default "~", for VMS: "_")
961 global
962 {not in Vi}
963 String which is appended to a file name to make the name of the
964 backup file. The default is quite unusual, because this avoids
965 accidentally overwriting existing files with a backup file. You might
966 prefer using ".bak", but make sure that you don't have files with
967 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000968 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000969
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +0000970 If you like to keep a lot of backups, you could use a BufWritePre
971 autocommand to change 'backupext' just before writing the file to
972 include a timestamp. >
973 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
974< Use 'backupdir' to put the backup in a different directory.
975
Bram Moolenaar071d4272004-06-13 20:20:40 +0000976 *'backupskip'* *'bsk'*
977'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
978 global
979 {not in Vi}
980 {not available when compiled without the |+wildignore|
981 feature}
982 A list of file patterns. When one of the patterns matches with the
983 name of the file which is written, no backup file is created. Both
984 the specified file name and the full path name of the file are used.
985 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
986 Watch out for special characters, see |option-backslash|.
987 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +0000988 default value. "/tmp/*" is only used for Unix.
Bram Moolenaara5792f52005-11-23 21:25:05 +0000989 Note that the default also makes sure that "crontab -e" works (when a
990 backup would be made by renaming the original file crontab won't see
991 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000992
993 *'balloondelay'* *'bdlay'*
994'balloondelay' 'bdlay' number (default: 600)
995 global
996 {not in Vi}
997 {only available when compiled with the |+balloon_eval|
998 feature}
999 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1000
1001 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1002'ballooneval' 'beval' boolean (default off)
1003 global
1004 {not in Vi}
1005 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001006 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001007 Switch on the |balloon-eval| functionality.
1008
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001009 *'balloonexpr'* *'bexpr'*
1010'balloonexpr' 'bexpr' string (default "")
1011 global
1012 {not in Vi}
1013 {only available when compiled with the |+balloon_eval|
1014 feature}
1015 Expression to show in evaluation balloon. It is only used when
1016 'ballooneval' is on. These variables can be used:
1017
1018 v:beval_bufnr number of the buffer in which balloon is going to show
1019 v:beval_winnr number of the window
1020 v:beval_lnum line number
1021 v:beval_col column number (byte index)
1022 v:beval_text word under or after the mouse pointer
1023
1024 The evaluation of the expression must not have side effects!
1025 Example: >
1026 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001027 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001028 \', column ' . v:beval_col .
1029 \ ' of file ' . bufname(v:beval_bufnr) .
1030 \ ' on word "' . v:beval_text . '"'
1031 endfunction
1032 set bexpr=MyBalloonExpr()
1033 set ballooneval
1034<
1035 NOTE: The balloon is displayed only if the cursor is on a text
1036 character. If the result of evaluating 'balloonexpr' is not empty,
1037 Vim does not try to send a message to an external debugger (Netbeans
1038 or Sun Workshop).
1039
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001040 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001041 if has("balloon_multiline")
1042<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001043 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1044'binary' 'bin' boolean (default off)
1045 local to buffer
1046 {not in Vi}
1047 This option should be set before editing a binary file. You can also
1048 use the |-b| Vim argument. When this option is switched on a few
1049 options will be changed (also when it already was on):
1050 'textwidth' will be set to 0
1051 'wrapmargin' will be set to 0
1052 'modeline' will be off
1053 'expandtab' will be off
1054 Also, 'fileformat' and 'fileformats' options will not be used, the
1055 file is read and written like 'fileformat' was "unix" (a single <NL>
1056 separates lines).
1057 The 'fileencoding' and 'fileencodings' options will not be used, the
1058 file is read without conversion.
1059 NOTE: When you start editing a(nother) file while the 'bin' option is
1060 on, settings from autocommands may change the settings again (e.g.,
1061 'textwidth'), causing trouble when editing. You might want to set
1062 'bin' again when the file has been loaded.
1063 The previous values of these options are remembered and restored when
1064 'bin' is switched from on to off. Each buffer has its own set of
1065 saved option values.
1066 To edit a file with 'binary' set you can use the |++bin| argument.
1067 This avoids you have to do ":set bin", which would have effect for all
1068 files you edit.
1069 When writing a file the <EOL> for the last line is only written if
1070 there was one in the original file (normally Vim appends an <EOL> to
1071 the last line if there is none; this would make the file longer). See
1072 the 'endofline' option.
1073
1074 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1075'bioskey' 'biosk' boolean (default on)
1076 global
1077 {not in Vi} {only for MS-DOS}
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001078 When on the BIOS is called to obtain a keyboard character. This works
Bram Moolenaar071d4272004-06-13 20:20:40 +00001079 better to detect CTRL-C, but only works for the console. When using a
1080 terminal over a serial port reset this option.
1081 Also see |'conskey'|.
1082
1083 *'bomb'* *'nobomb'*
1084'bomb' boolean (default off)
1085 local to buffer
1086 {not in Vi}
1087 {only available when compiled with the |+multi_byte|
1088 feature}
1089 When writing a file and the following conditions are met, a BOM (Byte
1090 Order Mark) is prepended to the file:
1091 - this option is on
1092 - the 'binary' option is off
1093 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1094 endian variants.
1095 Some applications use the BOM to recognize the encoding of the file.
1096 Often used for UCS-2 files on MS-Windows. For other applications it
1097 causes trouble, for example: "cat file1 file2" makes the BOM of file2
1098 appear halfway the resulting file.
1099 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1100 check for the presence of the BOM is done and 'bomb' set accordingly.
1101 Unless 'binary' is set, it is removed from the first line, so that you
1102 don't see it when editing. When you don't change the options, the BOM
1103 will be restored when writing the file.
1104
1105 *'breakat'* *'brk'*
1106'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1107 global
1108 {not in Vi}
1109 {not available when compiled without the |+linebreak|
1110 feature}
1111 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001112 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1113 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001114
1115 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001116'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001117 global
1118 {not in Vi} {only for Motif and Win32 GUI}
1119 Which directory to use for the file browser:
1120 last Use same directory as with last file browser.
1121 buffer Use the directory of the related buffer.
1122 current Use the current directory.
1123 {path} Use the specified directory
1124
1125 *'bufhidden'* *'bh'*
1126'bufhidden' 'bh' string (default: "")
1127 local to buffer
1128 {not in Vi}
1129 {not available when compiled without the |+quickfix|
1130 feature}
1131 This option specifies what happens when a buffer is no longer
1132 displayed in a window:
1133 <empty> follow the global 'hidden' option
1134 hide hide the buffer (don't unload it), also when 'hidden'
1135 is not set
1136 unload unload the buffer, also when 'hidden' is set or using
1137 |:hide|
1138 delete delete the buffer from the buffer list, also when
1139 'hidden' is set or using |:hide|, like using
1140 |:bdelete|
1141 wipe wipe out the buffer from the buffer list, also when
1142 'hidden' is set or using |:hide|, like using
1143 |:bwipeout|
1144
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001145 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
1146 are lost without a warning.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001147 This option is used together with 'buftype' and 'swapfile' to specify
1148 special kinds of buffers. See |special-buffers|.
1149
1150 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1151'buflisted' 'bl' boolean (default: on)
1152 local to buffer
1153 {not in Vi}
1154 When this option is set, the buffer shows up in the buffer list. If
1155 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1156 This option is reset by Vim for buffers that are only used to remember
1157 a file name or marks. Vim sets it when starting to edit a buffer.
1158 But not when moving to a buffer with ":buffer".
1159
1160 *'buftype'* *'bt'* *E382*
1161'buftype' 'bt' string (default: "")
1162 local to buffer
1163 {not in Vi}
1164 {not available when compiled without the |+quickfix|
1165 feature}
1166 The value of this option specifies the type of a buffer:
1167 <empty> normal buffer
1168 nofile buffer which is not related to a file and will not be
1169 written
1170 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001171 acwrite buffer which will always be written with BufWriteCmd
1172 autocommands. {not available when compiled without the
1173 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001174 quickfix quickfix buffer, contains list of errors |:cwindow|
1175 help help buffer (you are not supposed to set this
1176 manually)
1177
1178 This option is used together with 'bufhidden' and 'swapfile' to
1179 specify special kinds of buffers. See |special-buffers|.
1180
1181 Be careful with changing this option, it can have many side effects!
1182
1183 A "quickfix" buffer is only used for the error list. This value is
1184 set by the |:cwindow| command and you are not supposed to change it.
1185
1186 "nofile" and "nowrite" buffers are similar:
1187 both: The buffer is not to be written to disk, ":w" doesn't
1188 work (":w filename" does work though).
1189 both: The buffer is never considered to be |'modified'|.
1190 There is no warning when the changes will be lost, for
1191 example when you quit Vim.
1192 both: A swap file is only created when using too much memory
1193 (when 'swapfile' has been reset there is never a swap
1194 file).
1195 nofile only: The buffer name is fixed, it is not handled like a
1196 file name. It is not modified in response to a |:cd|
1197 command.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001198 *E676*
1199 "acwrite" implies that the buffer name is not related to a file, like
1200 "nofile", but it will be written. Thus, in contrast to "nofile" and
1201 "nowrite", ":w" does work and a modified buffer can't be abandoned
1202 without saving. For writing there must be matching |BufWriteCmd|,
1203 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001204
1205 *'casemap'* *'cmp'*
1206'casemap' 'cmp' string (default: "internal,keepascii")
1207 global
1208 {not in Vi}
1209 Specifies details about changing the case of letters. It may contain
1210 these words, separated by a comma:
1211 internal Use internal case mapping functions, the current
1212 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001213 matters when 'encoding' is a Unicode encoding,
1214 "latin1" or "iso-8859-15". When "internal" is
1215 omitted, the towupper() and towlower() system library
1216 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001217 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1218 case mapping, the current locale is not effective.
1219 This probably only matters for Turkish.
1220
1221 *'cdpath'* *'cd'* *E344* *E346*
1222'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1223 global
1224 {not in Vi}
1225 {not available when compiled without the
1226 |+file_in_path| feature}
1227 This is a list of directories which will be searched when using the
1228 |:cd| and |:lcd| commands, provided that the directory being searched
1229 for has a relative path (not starting with "/", "./" or "../").
1230 The 'cdpath' option's value has the same form and semantics as
1231 |'path'|. Also see |file-searching|.
1232 The default value is taken from $CDPATH, with a "," prepended to look
1233 in the current directory first.
1234 If the default value taken from $CDPATH is not what you want, include
1235 a modified version of the following command in your vimrc file to
1236 override it: >
1237 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1238< This option cannot be set from a |modeline| or in the |sandbox|, for
1239 security reasons.
1240 (parts of 'cdpath' can be passed to the shell to expand file names).
1241
1242 *'cedit'*
1243'cedit' string (Vi default: "", Vim default: CTRL-F)
1244 global
1245 {not in Vi}
1246 {not available when compiled without the |+vertsplit|
1247 feature}
1248 The key used in Command-line Mode to open the command-line window.
1249 The default is CTRL-F when 'compatible' is off.
1250 Only non-printable keys are allowed.
1251 The key can be specified as a single character, but it is difficult to
1252 type. The preferred way is to use the <> notation. Examples: >
1253 :set cedit=<C-Y>
1254 :set cedit=<Esc>
1255< |Nvi| also has this option, but it only uses the first character.
1256 See |cmdwin|.
1257
1258 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1259'charconvert' 'ccv' string (default "")
1260 global
1261 {only available when compiled with the |+multi_byte|
1262 feature and the |+eval| feature}
1263 {not in Vi}
1264 An expression that is used for character encoding conversion. It is
1265 evaluated when a file that is to be read or has been written has a
1266 different encoding from what is desired.
1267 'charconvert' is not used when the internal iconv() function is
1268 supported and is able to do the conversion. Using iconv() is
1269 preferred, because it is much faster.
1270 'charconvert' is not used when reading stdin |--|, because there is no
1271 file to convert from. You will have to save the text in a file first.
1272 The expression must return zero or an empty string for success,
1273 non-zero for failure.
1274 The possible encoding names encountered are in 'encoding'.
1275 Additionally, names given in 'fileencodings' and 'fileencoding' are
1276 used.
1277 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1278 is done internally by Vim, 'charconvert' is not used for this.
1279 'charconvert' is also used to convert the viminfo file, if the 'c'
1280 flag is present in 'viminfo'. Also used for Unicode conversion.
1281 Example: >
1282 set charconvert=CharConvert()
1283 fun CharConvert()
1284 system("recode "
1285 \ . v:charconvert_from . ".." . v:charconvert_to
1286 \ . " <" . v:fname_in . " >" v:fname_out)
1287 return v:shell_error
1288 endfun
1289< The related Vim variables are:
1290 v:charconvert_from name of the current encoding
1291 v:charconvert_to name of the desired encoding
1292 v:fname_in name of the input file
1293 v:fname_out name of the output file
1294 Note that v:fname_in and v:fname_out will never be the same.
1295 Note that v:charconvert_from and v:charconvert_to may be different
1296 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1297 Encryption is not done by Vim when using 'charconvert'. If you want
1298 to encrypt the file after conversion, 'charconvert' should take care
1299 of this.
1300 This option cannot be set from a |modeline| or in the |sandbox|, for
1301 security reasons.
1302
1303 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1304'cindent' 'cin' boolean (default off)
1305 local to buffer
1306 {not in Vi}
1307 {not available when compiled without the |+cindent|
1308 feature}
1309 Enables automatic C program indenting See 'cinkeys' to set the keys
1310 that trigger reindenting in insert mode and 'cinoptions' to set your
1311 preferred indent style.
1312 If 'indentexpr' is not empty, it overrules 'cindent'.
1313 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1314 the "=" operator indents using this algorithm rather than calling an
1315 external program.
1316 See |C-indenting|.
1317 When you don't like the way 'cindent' works, try the 'smartindent'
1318 option or 'indentexpr'.
1319 This option is not used when 'paste' is set.
1320 NOTE: This option is reset when 'compatible' is set.
1321
1322 *'cinkeys'* *'cink'*
1323'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1324 local to buffer
1325 {not in Vi}
1326 {not available when compiled without the |+cindent|
1327 feature}
1328 A list of keys that, when typed in Insert mode, cause reindenting of
1329 the current line. Only used if 'cindent' is on and 'indentexpr' is
1330 empty.
1331 For the format of this option see |cinkeys-format|.
1332 See |C-indenting|.
1333
1334 *'cinoptions'* *'cino'*
1335'cinoptions' 'cino' string (default "")
1336 local to buffer
1337 {not in Vi}
1338 {not available when compiled without the |+cindent|
1339 feature}
1340 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1341 program. See |cinoptions-values| for the values of this option, and
1342 |C-indenting| for info on C indenting in general.
1343
1344
1345 *'cinwords'* *'cinw'*
1346'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1347 local to buffer
1348 {not in Vi}
1349 {not available when compiled without both the
1350 |+cindent| and the |+smartindent| features}
1351 These keywords start an extra indent in the next line when
1352 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1353 an appropriate place (inside {}).
1354 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1355 matter, include the keyword both the uppercase and lowercase:
1356 "if,If,IF".
1357
1358 *'clipboard'* *'cb'*
1359'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1360 for X-windows, "" otherwise)
1361 global
1362 {not in Vi}
1363 {only in GUI versions or when the |+xterm_clipboard|
1364 feature is included}
1365 This option is a list of comma separated names.
1366 These names are recognized:
1367
1368 unnamed When included, Vim will use the clipboard register '*'
1369 for all yank, delete, change and put operations which
1370 would normally go to the unnamed register. When a
1371 register is explicitly specified, it will always be
1372 used regardless of whether "unnamed" is in 'clipboard'
1373 or not. The clipboard register can always be
1374 explicitly accessed using the "* notation. Also see
1375 |gui-clipboard|.
1376
1377 autoselect Works like the 'a' flag in 'guioptions': If present,
1378 then whenever Visual mode is started, or the Visual
1379 area extended, Vim tries to become the owner of the
1380 windowing system's global selection or put the
1381 selected text on the clipboard used by the selection
1382 register "*. See |guioptions_a| and |quotestar| for
1383 details. When the GUI is active, the 'a' flag in
1384 'guioptions' is used, when the GUI is not active, this
1385 "autoselect" flag is used.
1386 Also applies to the modeless selection.
1387
1388 autoselectml Like "autoselect", but for the modeless selection
1389 only. Compare to the 'A' flag in 'guioptions'.
1390
1391 exclude:{pattern}
1392 Defines a pattern that is matched against the name of
1393 the terminal 'term'. If there is a match, no
1394 connection will be made to the X server. This is
1395 useful in this situation:
1396 - Running Vim in a console.
1397 - $DISPLAY is set to start applications on another
1398 display.
1399 - You do not want to connect to the X server in the
1400 console, but do want this in a terminal emulator.
1401 To never connect to the X server use: >
1402 exclude:.*
1403< This has the same effect as using the |-X| argument.
1404 Note that when there is no connection to the X server
1405 the window title won't be restored and the clipboard
1406 cannot be accessed.
1407 The value of 'magic' is ignored, {pattern} is
1408 interpreted as if 'magic' was on.
1409 The rest of the option value will be used for
1410 {pattern}, this must be the last entry.
1411
1412 *'cmdheight'* *'ch'*
1413'cmdheight' 'ch' number (default 1)
1414 global
1415 {not in Vi}
1416 Number of screen lines to use for the command-line. Helps avoiding
1417 |hit-enter| prompts.
1418
1419 *'cmdwinheight'* *'cwh'*
1420'cmdwinheight' 'cwh' number (default 7)
1421 global
1422 {not in Vi}
1423 {not available when compiled without the |+vertsplit|
1424 feature}
1425 Number of screen lines to use for the command-line window. |cmdwin|
1426
1427 *'columns'* *'co'* *E594*
1428'columns' 'co' number (default 80 or terminal width)
1429 global
1430 {not in Vi}
1431 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001432 initialization and does not have to be set by hand. Also see
1433 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001434 When Vim is running in the GUI or in a resizable window, setting this
1435 option will cause the window size to be changed. When you only want
1436 to use the size for the GUI, put the command in your |gvimrc| file.
1437 When you set this option and Vim is unable to change the physical
1438 number of columns of the display, the display may be messed up.
Bram Moolenaarf4d11452005-12-02 00:46:37 +00001439 Mimimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001440
1441 *'comments'* *'com'* *E524* *E525*
1442'comments' 'com' string (default
1443 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1444 local to buffer
1445 {not in Vi}
1446 {not available when compiled without the |+comments|
1447 feature}
1448 A comma separated list of strings that can start a comment line. See
1449 |format-comments|. See |option-backslash| about using backslashes to
1450 insert a space.
1451
1452 *'commentstring'* *'cms'* *E537*
1453'commentstring' 'cms' string (default "/*%s*/")
1454 local to buffer
1455 {not in Vi}
1456 {not available when compiled without the |+folding|
1457 feature}
1458 A template for a comment. The "%s" in the value is replaced with the
1459 comment text. Currently only used to add markers for folding, see
1460 |fold-marker|.
1461
1462 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaard042c562005-06-30 22:04:15 +00001463'compatible' 'cp' boolean (default on, off when a .vimrc or .gvimrc file
1464 is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001465 global
1466 {not in Vi}
1467 This option has the effect of making Vim either more Vi-compatible, or
1468 make Vim behave in a more useful way.
1469 This is a special kind of option, because when it's set or reset,
1470 other options are also changed as a side effect. CAREFUL: Setting or
1471 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001472 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001473 set this option in your vimrc file, you should probably put it at the
1474 very start.
1475 By default this option is on and the Vi defaults are used for the
1476 options. This default was chosen for those people who want to use Vim
1477 just like Vi, and don't even (want to) know about the 'compatible'
1478 option.
Bram Moolenaard042c562005-06-30 22:04:15 +00001479 When a ".vimrc" or ".gvimrc" file is found while Vim is starting up,
1480 this option is switched off, and all options that have not been
1481 modified will be set to the Vim defaults. Effectively, this means
1482 that when a ".vimrc" or ".gvimrc" file exists, Vim will use the Vim
1483 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
1484 happen for the system-wide vimrc or gvimrc file). Also see
1485 |compatible-default| and |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001486 You can also set this option with the "-C" argument, and reset it with
1487 "-N". See |-C| and |-N|.
1488 Switching this option off makes the Vim defaults be used for options
1489 that have a different Vi and Vim default value. See the options
1490 marked with a '+' below. Other options are not modified.
1491 At the moment this option is set, several other options will be set
1492 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001493 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001494 editing.
1495 See also 'cpoptions'.
1496
1497 option + set value effect ~
1498
1499 'allowrevins' off no CTRL-_ command
1500 'backupcopy' Unix: "yes" backup file is a copy
1501 others: "auto" copy or rename backup file
1502 'backspace' "" normal backspace
1503 'backup' off no backup file
1504 'cindent' off no C code indentation
1505 'cedit' + "" no key to open the |cmdwin|
1506 'cpoptions' + (all flags) Vi-compatible flags
1507 'cscopetag' off don't use cscope for ":tag"
1508 'cscopetagorder' 0 see |cscopetagorder|
1509 'cscopeverbose' off see |cscopeverbose|
1510 'digraph' off no digraphs
1511 'esckeys' + off no <Esc>-keys in Insert mode
1512 'expandtab' off tabs not expanded to spaces
1513 'fileformats' + "" no automatic file format detection,
1514 "dos,unix" except for DOS, Windows and OS/2
1515 'formatoptions' + "vt" Vi compatible formatting
1516 'gdefault' off no default 'g' flag for ":s"
1517 'history' + 0 no commandline history
1518 'hkmap' off no Hebrew keyboard mapping
1519 'hkmapp' off no phonetic Hebrew keyboard mapping
1520 'hlsearch' off no highlighting of search matches
1521 'incsearch' off no incremental searching
1522 'indentexpr' "" no indenting by expression
1523 'insertmode' off do not start in Insert mode
1524 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1525 characters and '_'
1526 'joinspaces' on insert 2 spaces after period
1527 'modeline' + off no modelines
1528 'more' + off no pauses in listings
1529 'revins' off no reverse insert
1530 'ruler' off no ruler
1531 'scrolljump' 1 no jump scroll
1532 'scrolloff' 0 no scroll offset
1533 'shiftround' off indent not rounded to shiftwidth
1534 'shortmess' + "" no shortening of messages
1535 'showcmd' + off command characters not shown
1536 'showmode' + off current mode not shown
1537 'smartcase' off no automatic ignore case switch
1538 'smartindent' off no smart indentation
1539 'smarttab' off no smart tab size
1540 'softtabstop' 0 tabs are always 'tabstop' positions
1541 'startofline' on goto startofline with some commands
1542 'tagrelative' + off tag file names are not relative
1543 'textauto' + off no automatic textmode detection
1544 'textwidth' 0 no automatic line wrap
1545 'tildeop' off tilde is not an operator
1546 'ttimeout' off no terminal timeout
1547 'whichwrap' + "" left-right movements don't wrap
1548 'wildchar' + CTRL-E only when the current value is <Tab>
1549 use CTRL-E for cmdline completion
1550 'writebackup' on or off depends on +writebackup feature
1551
1552 *'complete'* *'cpt'* *E535*
1553'complete' 'cpt' string (default: ".,w,b,u,t,i")
1554 local to buffer
1555 {not in Vi}
1556 This option specifies how keyword completion |ins-completion| works
1557 when CTRL-P or CTRL-N are used. It is also used for whole-line
1558 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1559 and the places to scan. It is a comma separated list of flags:
1560 . scan the current buffer ('wrapscan' is ignored)
1561 w scan buffers from other windows
1562 b scan other loaded buffers that are in the buffer list
1563 u scan the unloaded buffers that are in the buffer list
1564 U scan the buffers that are not in the buffer list
1565 k scan the files given with the 'dictionary' option
1566 k{dict} scan the file {dict}. Several "k" flags can be given,
1567 patterns are valid too. For example: >
1568 :set cpt=k/usr/dict/*,k~/spanish
1569< s scan the files given with the 'thesaurus' option
1570 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1571 are valid too.
1572 i scan current and included files
1573 d scan current and included files for defined name or macro
1574 |i_CTRL-X_CTRL-D|
1575 ] tag completion
1576 t same as "]"
1577
1578 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1579 not executed, this may lead to unexpected completions from some files
1580 (gzipped files for example). Unloaded buffers are not scanned for
1581 whole-line completion.
1582
1583 The default is ".,w,b,u,t,i", which means to scan:
1584 1. the current buffer
1585 2. buffers in other windows
1586 3. other loaded buffers
1587 4. unloaded buffers
1588 5. tags
1589 6. included files
1590
1591 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001592 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1593 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001594
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001595 *'completefunc'* *'cfu'*
1596'completefunc' 'cfu' string (default: empty)
1597 local to buffer
1598 {not in Vi}
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001599 {not available when compiled without the +eval
1600 or +insert_expand feature}
1601 This option specifies a function to be used for CTRL-X CTRL-U
1602 completion. |i_CTRL-X_CTRL-U|
1603
Bram Moolenaare344bea2005-09-01 20:46:49 +00001604 The function will be invoked with two arguments. First the function
1605 is called to find the start of the text to be completed. Secondly the
1606 function is called to actually find the matches.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001607
Bram Moolenaare344bea2005-09-01 20:46:49 +00001608 On the first invocation the arguments are:
1609 a:findstart 1
1610 a:base empty
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001611
Bram Moolenaare344bea2005-09-01 20:46:49 +00001612 The function must return the column of where the completion starts.
1613 It must be a number between zero and the cursor column "col('.')".
1614 This involves looking at the characters just before the cursor and
1615 including those characters that could be part of the completed item.
1616 The text between this column and the cursor column will be replaced
1617 with the matches. Return -1 if no completion can be done.
1618
1619 On the second invocation the arguments are:
1620 a:findstart 0
1621 a:base the text with which matches should match, what was
Bram Moolenaard5cdbeb2005-10-10 20:59:28 +00001622 located in the first call (can be empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00001623
1624 The function must return a List with the matching words. These
1625 matches usually include the "a:base" text. When there are no matches
1626 return an empty List.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001627
Bram Moolenaar572cb562005-08-05 21:35:02 +00001628 When searching for matches takes some time call |complete_add()| to
1629 add each match to the total list. These matches should then not
1630 appear in the returned list! Call |complete_check()| now and then to
1631 allow the user to press a key while still searching for matches. Stop
1632 searching when it returns non-zero.
1633
Bram Moolenaare344bea2005-09-01 20:46:49 +00001634 The function may move the cursor, it is restored afterwards.
Bram Moolenaar572cb562005-08-05 21:35:02 +00001635 This option cannot be set from a |modeline| or in the |sandbox|, for
1636 security reasons.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001637
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001638 An example that completes the names of the months: >
Bram Moolenaare344bea2005-09-01 20:46:49 +00001639 fun! CompleteMonths(findstart, base)
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001640 if a:findstart
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001641 " locate the start of the word
1642 let line = getline('.')
Bram Moolenaare344bea2005-09-01 20:46:49 +00001643 let start = col('.') - 1
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001644 while start > 0 && line[start - 1] =~ '\a'
1645 let start -= 1
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001646 endwhile
1647 return start
1648 else
1649 " find months matching with "a:base"
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001650 let res = []
1651 for m in split("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec")
1652 if m =~ '^' . a:base
1653 call add(res, m)
1654 endif
1655 endfor
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001656 return res
1657 endif
1658 endfun
1659 set completefunc=CompleteMonths
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001660<
Bram Moolenaar572cb562005-08-05 21:35:02 +00001661 The same, but now pretending searching for matches is slow: >
Bram Moolenaare344bea2005-09-01 20:46:49 +00001662 fun! CompleteMonths(findstart, base)
Bram Moolenaar572cb562005-08-05 21:35:02 +00001663 if a:findstart
1664 " locate the start of the word
1665 let line = getline('.')
Bram Moolenaare344bea2005-09-01 20:46:49 +00001666 let start = col('.') - 1
Bram Moolenaar572cb562005-08-05 21:35:02 +00001667 while start > 0 && line[start - 1] =~ '\a'
1668 let start -= 1
1669 endwhile
1670 return start
1671 else
1672 " find months matching with "a:base"
1673 for m in split("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec")
1674 if m =~ '^' . a:base
1675 call complete_add(m)
1676 endif
1677 sleep 300m " simulate searching for next match
1678 if complete_check()
1679 break
1680 endif
1681 endfor
1682 return []
1683 endif
1684 endfun
1685 set completefunc=CompleteMonths
1686<
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001687
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001688 *'completeopt'* *'cot'*
1689'completeopt' 'cot' string (default: "menu")
1690 global
1691 {not in Vi}
1692 Options for Insert mode completion |ins-completion|.
1693 Currently the only supported value is:
1694
1695 menu Use a popup menu to show the possible completions. The
1696 menu is only shown when there is more than one match and
1697 sufficient colors are available. |ins-completion-menu|
1698
1699
Bram Moolenaar071d4272004-06-13 20:20:40 +00001700 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1701'confirm' 'cf' boolean (default off)
1702 global
1703 {not in Vi}
1704 When 'confirm' is on, certain operations that would normally
1705 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1706 instead raise a |dialog| asking if you wish to save the current
1707 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1708 If 'confirm' is off you can still activate confirmation for one
1709 command only (this is most useful in mappings) with the |:confirm|
1710 command.
1711 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1712
1713 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1714'conskey' 'consk' boolean (default off)
1715 global
1716 {not in Vi} {only for MS-DOS}
1717 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001718 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001719 three methods of console input are available:
1720 'conskey' 'bioskey' action ~
1721 on on or off direct console input
1722 off on BIOS
1723 off off STDIN
1724
1725 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1726'copyindent' 'ci' boolean (default off)
1727 local to buffer
1728 {not in Vi}
1729 Copy the structure of the existing lines indent when autoindenting a
1730 new line. Normally the new indent is reconstructed by a series of
1731 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1732 in which case only spaces are used). Enabling this option makes the
1733 new line copy whatever characters were used for indenting on the
1734 existing line. If the new indent is greater than on the existing
1735 line, the remaining space is filled in the normal manner.
1736 NOTE: 'copyindent' is reset when 'compatible' is set.
1737 Also see 'preserveindent'.
1738
1739 *'cpoptions'* *'cpo'*
1740'cpoptions' 'cpo' string (Vim default: "aABceFs",
1741 Vi default: all flags)
1742 global
1743 {not in Vi}
1744 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001745 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001746 not being vi-compatible is mostly or sometimes preferred.
1747 'cpoptions' stands for "compatible-options".
1748 Commas can be added for readability.
1749 To avoid problems with flags that are added in the future, use the
1750 "+=" and "-=" feature of ":set" |add-option-flags|.
1751 NOTE: This option is set to the Vi default value when 'compatible' is
1752 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001753 NOTE: This option is set to the POSIX default value at startup when
1754 the Vi default value would be used and the $VIM_POSIX environment
1755 variable exists |posix|. This means tries to behave like the POSIX
1756 specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001757
1758 contains behavior ~
1759 *cpo-a*
1760 a When included, a ":read" command with a file name
1761 argument will set the alternate file name for the
1762 current window.
1763 *cpo-A*
1764 A When included, a ":write" command with a file name
1765 argument will set the alternate file name for the
1766 current window.
1767 *cpo-b*
1768 b "\|" in a ":map" command is recognized as the end of
1769 the map command. The '\' is included in the mapping,
1770 the text after the '|' is interpreted as the next
1771 command. Use a CTRL-V instead of a backslash to
1772 include the '|' in the mapping. Applies to all
1773 mapping, abbreviation, menu and autocmd commands.
1774 See also |map_bar|.
1775 *cpo-B*
1776 B A backslash has no special meaning in mappings,
1777 abbreviations and the "to" part of the menu commands.
1778 Remove this flag to be able to use a backslash like a
1779 CTRL-V. For example, the command ":map X \<Esc>"
1780 results in X being mapped to:
1781 'B' included: "\^[" (^[ is a real <Esc>)
1782 'B' excluded: "<Esc>" (5 characters)
1783 ('<' excluded in both cases)
1784 *cpo-c*
1785 c Searching continues at the end of any match at the
1786 cursor position, but not further than the start of the
1787 next line. When not present searching continues
1788 one character from the cursor position. With 'c'
1789 "abababababab" only gets three matches when repeating
1790 "/abab", without 'c' there are five matches.
1791 *cpo-C*
1792 C Do not concatenate sourced lines that start with a
1793 backslash. See |line-continuation|.
1794 *cpo-d*
1795 d Using "./" in the 'tags' option doesn't mean to use
1796 the tags file relative to the current file, but the
1797 tags file in the current directory.
1798 *cpo-D*
1799 D Can't use CTRL-K to enter a digraph after Normal mode
1800 commands with a character argument, like |r|, |f| and
1801 |t|.
1802 *cpo-e*
1803 e When executing a register with ":@r", always add a
1804 <CR> to the last line, also when the register is not
1805 linewise. If this flag is not present, the register
1806 is not linewise and the last line does not end in a
1807 <CR>, then the last line is put on the command-line
1808 and can be edited before hitting <CR>.
1809 *cpo-E*
1810 E It is an error when using "y", "d", "c", "g~", "gu" or
1811 "gU" on an Empty region. The operators only work when
1812 at least one character is to be operate on. Example:
1813 This makes "y0" fail in the first column.
1814 *cpo-f*
1815 f When included, a ":read" command with a file name
1816 argument will set the file name for the current buffer,
1817 if the current buffer doesn't have a file name yet.
1818 *cpo-F*
1819 F When included, a ":write" command with a file name
1820 argument will set the file name for the current
1821 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001822 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001823 *cpo-g*
1824 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001825 *cpo-H*
1826 H When using "I" on a line with only blanks, insert
1827 before the last blank. Without this flag insert after
1828 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001829 *cpo-i*
1830 i When included, interrupting the reading of a file will
1831 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001832 *cpo-I*
1833 I When moving the cursor up or down just after inserting
1834 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001835 *cpo-j*
1836 j When joining lines, only add two spaces after a '.',
1837 not after '!' or '?'. Also see 'joinspaces'.
1838 *cpo-J*
1839 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001840 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001841 white space.
1842 *cpo-k*
1843 k Disable the recognition of raw key codes in
1844 mappings, abbreviations, and the "to" part of menu
1845 commands. For example, if <Key> sends ^[OA (where ^[
1846 is <Esc>), the command ":map X ^[OA" results in X
1847 being mapped to:
1848 'k' included: "^[OA" (3 characters)
1849 'k' excluded: "<Key>" (one key code)
1850 Also see the '<' flag below.
1851 *cpo-K*
1852 K Don't wait for a key code to complete when it is
1853 halfway a mapping. This breaks mapping <F1><F1> when
1854 only part of the second <F1> has been read. It
1855 enables cancelling the mapping by typing <F1><Esc>.
1856 *cpo-l*
1857 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001858 literally, only "\]", "\^", "\-" and "\\" are special.
1859 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001860 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1861 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001862 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001863 *cpo-L*
1864 L When the 'list' option is set, 'wrapmargin',
1865 'textwidth', 'softtabstop' and Virtual Replace mode
1866 (see |gR|) count a <Tab> as two characters, instead of
1867 the normal behavior of a <Tab>.
1868 *cpo-m*
1869 m When included, a showmatch will always wait half a
1870 second. When not included, a showmatch will wait half
1871 a second or until a character is typed. |'showmatch'|
1872 *cpo-M*
1873 M When excluded, "%" matching will take backslashes into
1874 account. Thus in "( \( )" and "\( ( \)" the outer
1875 parenthesis match. When included "%" ignores
1876 backslashes, which is Vi compatible.
1877 *cpo-n*
1878 n When included, the column used for 'number' will also
1879 be used for text of wrapped lines.
1880 *cpo-o*
1881 o Line offset to search command is not remembered for
1882 next search.
1883 *cpo-O*
1884 O Don't complain if a file is being overwritten, even
1885 when it didn't exist when editing it. This is a
1886 protection against a file unexpectedly created by
1887 someone else. Vi didn't complain about this.
1888 *cpo-p*
1889 p Vi compatible Lisp indenting. When not present, a
1890 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00001891 *cpo-P*
1892 P When included, a ":write" command that appends to a
1893 file will set the file name for the current buffer, if
1894 the current buffer doesn't have a file name yet and
1895 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001896 *cpo-q*
1897 q When joining multiple lines leave the cursor at the
1898 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001899 *cpo-r*
1900 r Redo ("." command) uses "/" to repeat a search
1901 command, instead of the actually used search string.
1902 *cpo-R*
1903 R Remove marks from filtered lines. Without this flag
1904 marks are kept like |:keepmarks| was used.
1905 *cpo-s*
1906 s Set buffer options when entering the buffer for the
1907 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001908 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001909 set when the buffer is created.
1910 *cpo-S*
1911 S Set buffer options always when entering a buffer
1912 (except 'readonly', 'fileformat', 'filetype' and
1913 'syntax'). This is the (most) Vi compatible setting.
1914 The options are set to the values in the current
1915 buffer. When you change an option and go to another
1916 buffer, the value is copied. Effectively makes the
1917 buffer options global to all buffers.
1918
1919 's' 'S' copy buffer options
1920 no no when buffer created
1921 yes no when buffer first entered (default)
1922 X yes each time when buffer entered (vi comp.)
1923 *cpo-t*
1924 t Search pattern for the tag command is remembered for
1925 "n" command. Otherwise Vim only puts the pattern in
1926 the history for search pattern, but doesn't change the
1927 last used search pattern.
1928 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001929 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001930 *cpo-v*
1931 v Backspaced characters remain visible on the screen in
1932 Insert mode. Without this flag the characters are
1933 erased from the screen right away. With this flag the
1934 screen newly typed text overwrites backspaced
1935 characters.
1936 *cpo-w*
1937 w When using "cw" on a blank character, only change one
1938 character and not all blanks until the start of the
1939 next word.
1940 *cpo-W*
1941 W Don't overwrite a readonly file. When omitted, ":w!"
1942 overwrites a readonly file, if possible.
1943 *cpo-x*
1944 x <Esc> on the command-line executes the command-line.
1945 The default in Vim is to abandon the command-line,
1946 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001947 *cpo-X*
1948 X When using a count with "R" the replaced text is
1949 deleted only once. Also when repeating "R" with "."
1950 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001951 *cpo-y*
1952 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001953 *cpo-Z*
1954 Z When using "w!" while the 'readonly' option is set,
1955 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001956 *cpo-!*
1957 ! When redoing a filter command, use the last used
1958 external command, whatever it was. Otherwise the last
1959 used -filter- command is used.
1960 *cpo-$*
1961 $ When making a change to one line, don't redisplay the
1962 line, but put a '$' at the end of the changed text.
1963 The changed text will be overwritten when you type the
1964 new text. The line is redisplayed if you type any
1965 command that moves the cursor from the insertion
1966 point.
1967 *cpo-%*
1968 % Vi-compatible matching is done for the "%" command.
1969 Does not recognize "#if", "#endif", etc.
1970 Does not recognize "/*" and "*/".
1971 Parens inside single and double quotes are also
1972 counted, causing a string that contains a paren to
1973 disturb the matching. For example, in a line like
1974 "if (strcmp("foo(", s))" the first paren does not
1975 match the last one. When this flag is not included,
1976 parens inside single and double quotes are treated
1977 specially. When matching a paren outside of quotes,
1978 everything inside quotes is ignored. When matching a
1979 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001980 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001981 This flag is also used for other features, such as
1982 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001983 *cpo--*
1984 - When included, a vertical movement command fails when
1985 it would above the first line or below the last line.
1986 Without it the cursor moves to the first or last line,
1987 unless it already was in that line.
1988 Applies to the commands "-", "k", CTRL-P, "+", "j",
1989 CTRL-N and CTRL-J.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001990 *cpo-+*
1991 + When included, a ":write file" command will reset the
1992 'modified' flag of the buffer, even though the buffer
1993 itself may still be different from its file.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001994 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001995 * Use ":*" in the same way as ":@". When not included,
1996 ":*" is an alias for ":'<,'>", select the Visual area.
1997 *cpo-<*
1998 < Disable the recognition of special key codes in |<>|
1999 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002000 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002001 ":map X <Tab>" results in X being mapped to:
2002 '<' included: "<Tab>" (5 characters)
2003 '<' excluded: "^I" (^I is a real <Tab>)
2004 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002005 *cpo->*
2006 > When appending to a register, put a line break before
2007 the appended text.
2008
2009 POSIX flags. These are not included in the Vi default value, except
2010 when $VIM_POSIX was set on startup. |posix|
2011
2012 contains behavior ~
2013 *cpo-#*
2014 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002015 *cpo-&*
2016 & When ":preserve" was used keep the swap file when
2017 exiting normally while this buffer is still loaded.
2018 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002019 *cpo-\*
2020 \ Backslash in a [] range in a search pattern is taken
2021 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002022 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2023 '\' excluded: "/[ \-]" finds <Space> and '-'
2024 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002025 *cpo-/*
2026 / When "%" is used as the replacement string in a |:s|
2027 command, use the previous replacement string. |:s%|
2028 *cpo-{*
2029 { The |{| and |}| commands also stop at a "{" character
2030 at the start of a line.
2031 *cpo-.*
2032 . The ":chdir" and ":cd" commands fail if the current
2033 buffer is modified, unless ! is used. Vim doesn't
2034 need this, since it remembers the full path of an
2035 opened file.
2036 *cpo-bar*
2037 | The value of the $LINES and $COLUMNS environment
2038 variables overrule the terminal size values obtained
2039 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002040
Bram Moolenaar071d4272004-06-13 20:20:40 +00002041
2042 *'cscopepathcomp'* *'cspc'*
2043'cscopepathcomp' 'cspc' number (default 0)
2044 global
2045 {not available when compiled without the |+cscope|
2046 feature}
2047 {not in Vi}
2048 Determines how many components of the path to show in a list of tags.
2049 See |cscopepathcomp|.
2050
2051 *'cscopeprg'* *'csprg'*
2052'cscopeprg' 'csprg' string (default "cscope")
2053 global
2054 {not available when compiled without the |+cscope|
2055 feature}
2056 {not in Vi}
2057 Specifies the command to execute cscope. See |cscopeprg|.
2058 This option cannot be set from a |modeline| or in the |sandbox|, for
2059 security reasons.
2060
2061 *'cscopequickfix'* *'csqf'*
2062'cscopequickfix' 'csqf' string (default "")
2063 global
2064 {not available when compiled without the |+cscope|
2065 or |+quickfix| features}
2066 {not in Vi}
2067 Specifies whether to use quickfix window to show cscope results.
2068 See |cscopequickfix|.
2069
2070 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2071'cscopetag' 'cst' boolean (default off)
2072 global
2073 {not available when compiled without the |+cscope|
2074 feature}
2075 {not in Vi}
2076 Use cscope for tag commands. See |cscope-options|.
2077 NOTE: This option is reset when 'compatible' is set.
2078
2079 *'cscopetagorder'* *'csto'*
2080'cscopetagorder' 'csto' number (default 0)
2081 global
2082 {not available when compiled without the |+cscope|
2083 feature}
2084 {not in Vi}
2085 Determines the order in which ":cstag" performs a search. See
2086 |cscopetagorder|.
2087 NOTE: This option is set to 0 when 'compatible' is set.
2088
2089 *'cscopeverbose'* *'csverb'*
2090 *'nocscopeverbose'* *'nocsverb'*
2091'cscopeverbose' 'csverb' boolean (default off)
2092 global
2093 {not available when compiled without the |+cscope|
2094 feature}
2095 {not in Vi}
2096 Give messages when adding a cscope database. See |cscopeverbose|.
2097 NOTE: This option is reset when 'compatible' is set.
2098
2099 *'debug'*
2100'debug' string (default "")
2101 global
2102 {not in Vi}
2103 When set to "msg", error messages that would otherwise be omitted will
2104 be given anyway. This is useful when debugging 'foldexpr' or
2105 'indentexpr'.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002106 When set to "beep", a message will be given when otherwise only a beep
2107 would be produced.
2108 The values can be combined, separated by a comma.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002109
2110 *'define'* *'def'*
2111'define' 'def' string (default "^\s*#\s*define")
2112 global or local to buffer |global-local|
2113 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002114 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002115 pattern, just like for the "/" command. This option is used for the
2116 commands like "[i" and "[d" |include-search|. The 'isident' option is
2117 used to recognize the defined name after the match:
2118 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2119 See |option-backslash| about inserting backslashes to include a space
2120 or backslash.
2121 The default value is for C programs. For C++ this value would be
2122 useful, to include const type declarations: >
2123 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2124< When using the ":set" command, you need to double the backslashes!
2125
2126 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2127'delcombine' 'deco' boolean (default off)
2128 global
2129 {not in Vi}
2130 {only available when compiled with the |+multi_byte|
2131 feature}
2132 If editing Unicode and this option is set, backspace and Normal mode
2133 "x" delete each combining character on its own. When it is off (the
2134 default) the character along with its combining characters are
2135 deleted.
2136 Note: When 'delcombine' is set "xx" may work different from "2x"!
2137
2138 This is useful for Arabic, Hebrew and many other languages where one
2139 may have combining characters overtop of base characters, and want
2140 to remove only the combining ones.
2141
2142 *'dictionary'* *'dict'*
2143'dictionary' 'dict' string (default "")
2144 global or local to buffer |global-local|
2145 {not in Vi}
2146 List of file names, separated by commas, that are used to lookup words
2147 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2148 contain a list of words. This can be one word per line, or several
2149 words per line, separated by non-keyword characters (white space is
2150 preferred). Maximum line length is 510 bytes.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002151 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002152 after a comma are ignored, otherwise spaces are included in the file
2153 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002154 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002155 Where to find a list of words?
2156 - On FreeBSD, there is the file "/usr/share/dict/words".
2157 - In the Simtel archive, look in the "msdos/linguist" directory.
2158 - In "miscfiles" of the GNU collection.
2159 The use of |:set+=| and |:set-=| is preferred when adding or removing
2160 directories from the list. This avoids problems when a future version
2161 uses another default.
2162 Backticks cannot be used in this option for security reasons.
2163
2164 *'diff'* *'nodiff'*
2165'diff' boolean (default off)
2166 local to window
2167 {not in Vi}
2168 {not available when compiled without the |+diff|
2169 feature}
2170 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002171 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002172
2173 *'dex'* *'diffexpr'*
2174'diffexpr' 'dex' string (default "")
2175 global
2176 {not in Vi}
2177 {not available when compiled without the |+diff|
2178 feature}
2179 Expression which is evaluated to obtain an ed-style diff file from two
2180 versions of a file. See |diff-diffexpr|.
2181 This option cannot be set from a |modeline| or in the |sandbox|, for
2182 security reasons.
2183
2184 *'dip'* *'diffopt'*
2185'diffopt' 'dip' string (default "filler")
2186 global
2187 {not in Vi}
2188 {not available when compiled without the |+diff|
2189 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002190 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002191 All are optional. Items must be separated by a comma.
2192
2193 filler Show filler lines, to keep the text
2194 synchronized with a window that has inserted
2195 lines at the same position. Mostly useful
2196 when windows are side-by-side and 'scrollbind'
2197 is set.
2198
2199 context:{n} Use a context of {n} lines between a change
2200 and a fold that contains unchanged lines.
2201 When omitted a context of six lines is used.
2202 See |fold-diff|.
2203
2204 icase Ignore changes in case of text. "a" and "A"
2205 are considered the same. Adds the "-i" flag
2206 to the "diff" command if 'diffexpr' is empty.
2207
2208 iwhite Ignore changes in amount of white space. Adds
2209 the "-b" flag to the "diff" command if
2210 'diffexpr' is empty. Check the documentation
2211 of the "diff" command for what this does
2212 exactly. It should ignore adding trailing
2213 white space, but not leading white space.
2214
2215 Examples: >
2216
2217 :set diffopt=filler,context:4
2218 :set diffopt=
2219 :set diffopt=filler
2220<
2221 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2222'digraph' 'dg' boolean (default off)
2223 global
2224 {not in Vi}
2225 {not available when compiled without the |+digraphs|
2226 feature}
2227 Enable the entering of digraphs in Insert mode with {char1} <BS>
2228 {char2}. See |digraphs|.
2229 NOTE: This option is reset when 'compatible' is set.
2230
2231 *'directory'* *'dir'*
2232'directory' 'dir' string (default for Amiga: ".,t:",
2233 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2234 for Unix: ".,~/tmp,/var/tmp,/tmp")
2235 global
2236 List of directory names for the swap file, separated with commas.
2237 - The swap file will be created in the first directory where this is
2238 possible.
2239 - Empty means that no swap file will be used (recovery is
2240 impossible!).
2241 - A directory "." means to put the swap file in the same directory as
2242 the edited file. On Unix, a dot is prepended to the file name, so
2243 it doesn't show in a directory listing. On MS-Windows the "hidden"
2244 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002245 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002246 put the swap file relative to where the edited file is. The leading
2247 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002248 - For Unix and Win32, if a directory ends in two path separators "//"
2249 or "\\", the swap file name will be built from the complete path to
2250 the file with all path separators substituted to percent '%' signs.
2251 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002252 - Spaces after the comma are ignored, other spaces are considered part
2253 of the directory name. To have a space at the start of a directory
2254 name, precede it with a backslash.
2255 - To include a comma in a directory name precede it with a backslash.
2256 - A directory name may end in an ':' or '/'.
2257 - Environment variables are expanded |:set_env|.
2258 - Careful with '\' characters, type one before a space, type two to
2259 get one in the option (see |option-backslash|), for example: >
2260 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2261< - For backwards compatibility with Vim version 3.0 a '>' at the start
2262 of the option is removed.
2263 Using "." first in the list is recommended. This means that editing
2264 the same file twice will result in a warning. Using "/tmp" on Unix is
2265 discouraged: When the system crashes you lose the swap file.
2266 "/var/tmp" is often not cleared when rebooting, thus is a better
2267 choice than "/tmp". But it can contain a lot of files, your swap
2268 files get lost in the crowd. That is why a "tmp" directory in your
2269 home directory is tried first.
2270 The use of |:set+=| and |:set-=| is preferred when adding or removing
2271 directories from the list. This avoids problems when a future version
2272 uses another default.
2273 This option cannot be set from a |modeline| or in the |sandbox|, for
2274 security reasons.
2275 {Vi: directory to put temp file in, defaults to "/tmp"}
2276
2277 *'display'* *'dy'*
2278'display' 'dy' string (default "")
2279 global
2280 {not in Vi}
2281 Change the way text is displayed. This is comma separated list of
2282 flags:
2283 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002284 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002285 last line that doesn't fit is replaced with "@" lines.
2286 uhex Show unprintable characters hexadecimal as <xx>
2287 instead of using ^C and ~C.
2288
2289 *'eadirection'* *'ead'*
2290'eadirection' 'ead' string (default "both")
2291 global
2292 {not in Vi}
2293 {not available when compiled without the +vertsplit
2294 feature}
2295 Tells when the 'equalalways' option applies:
2296 ver vertically, width of windows is not affected
2297 hor horizontally, height of windows is not affected
2298 both width and height of windows is affected
2299
2300 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2301'edcompatible' 'ed' boolean (default off)
2302 global
2303 Makes the 'g' and 'c' flags of the ":substitute" command to be
2304 toggled each time the flag is given. See |complex-change|. See
2305 also 'gdefault' option.
2306 Switching this option on is discouraged!
2307
2308 *'encoding'* *'enc'* *E543*
2309'encoding' 'enc' string (default: "latin1" or value from $LANG)
2310 global
2311 {only available when compiled with the |+multi_byte|
2312 feature}
2313 {not in Vi}
2314 Sets the character encoding used inside Vim. It applies to text in
2315 the buffers, registers, Strings in expressions, text stored in the
2316 viminfo file, etc. It sets the kind of characters which Vim can work
2317 with. See |encoding-names| for the possible values.
2318
2319 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002320 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002321 It should normally be kept at its default value, or set when Vim
2322 starts up. See |multibyte|.
2323
2324 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2325 "utf-8". Although care has been taken to allow different values of
2326 'encoding', "utf-8" is the natural choice for the environment and
2327 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002328 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002329 versions, and to avoid changing the encoding of newly created files
2330 without your knowledge (in case 'fileencodings' is empty).
2331
2332 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002333 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002334 iconv() or as specified with 'charconvert'.
2335
2336 Normally 'encoding' will be equal to your current locale. This will
2337 be the default if Vim recognizes your environment settings. If
2338 'encoding' is not set to the current locale, 'termencoding' must be
2339 set to convert typed and displayed text. See |encoding-table|.
2340
2341 When you set this option, it fires the |EncodingChanged| autocommand
2342 event so that you can set up fonts if necessary.
2343
2344 When the option is set, the value is converted to lowercase. Thus
2345 you can set it with uppercase values too. Underscores are translated
2346 to '-' signs.
2347 When the encoding is recognized, it is changed to the standard name.
2348 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2349 "iso-8859-2" and "utf8" becomes "utf-8".
2350
2351 Note: "latin1" is also used when the encoding could not be detected.
2352 This only works when editing files in the same encoding! When the
2353 actual character set is not latin1, make sure 'fileencoding' and
2354 'fileencodings' are empty. When conversion is needed, switch to using
2355 utf-8.
2356
2357 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2358 You don't notice this while editing, but it does matter for the
2359 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2360 setting 'encoding' to one of these values instead of utf-8 only has
2361 effect for encoding used for files when 'fileencoding' is empty.
2362
Bram Moolenaar661b1822005-07-28 22:36:45 +00002363 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2364 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002365
2366 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2367'endofline' 'eol' boolean (default on)
2368 local to buffer
2369 {not in Vi}
2370 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002371 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002372 option is automatically set when starting to edit a new file, unless
2373 the file does not have an <EOL> for the last line in the file, in
2374 which case it is reset. Normally you don't have to set or reset this
2375 option. When 'binary' is off the value is not used when writing the
2376 file. When 'binary' is on it is used to remember the presence of a
2377 <EOL> for the last line in the file, so that when you write the file
2378 the situation from the original file can be kept. But you can change
2379 it if you want to.
2380
2381 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2382'equalalways' 'ea' boolean (default on)
2383 global
2384 {not in Vi}
2385 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002386 splitting or closing a window. This also happens the moment the
2387 option is switched on. When off, splitting a window will reduce the
2388 size of the current window and leave the other windows the same. When
2389 closing a window the extra lines are given to the window next to it
2390 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002391 When mixing vertically and horizontally split windows, a minimal size
2392 is computed and some windows may be larger if there is room. The
2393 'eadirection' option tells in which direction the size is affected.
2394 Changing the height of a window can be avoided by setting
2395 'winfixheight'.
2396
2397 *'equalprg'* *'ep'*
2398'equalprg' 'ep' string (default "")
2399 global or local to buffer |global-local|
2400 {not in Vi}
2401 External program to use for "=" command. When this option is empty
2402 the internal formatting functions are used ('lisp', 'cindent' or
2403 'indentexpr').
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002404 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002405 about including spaces and backslashes.
2406 This option cannot be set from a |modeline| or in the |sandbox|, for
2407 security reasons.
2408
2409 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2410'errorbells' 'eb' boolean (default off)
2411 global
2412 Ring the bell (beep or screen flash) for error messages. This only
2413 makes a difference for error messages, the bell will be used always
2414 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002415 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002416 screen flash or do nothing.
2417
2418 *'errorfile'* *'ef'*
2419'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2420 others: "errors.err")
2421 global
2422 {not in Vi}
2423 {not available when compiled without the |+quickfix|
2424 feature}
2425 Name of the errorfile for the QuickFix mode (see |:cf|).
2426 When the "-q" command-line argument is used, 'errorfile' is set to the
2427 following argument. See |-q|.
2428 NOT used for the ":make" command. See 'makeef' for that.
2429 Environment variables are expanded |:set_env|.
2430 See |option-backslash| about including spaces and backslashes.
2431 This option cannot be set from a |modeline| or in the |sandbox|, for
2432 security reasons.
2433
2434 *'errorformat'* *'efm'*
2435'errorformat' 'efm' string (default is very long)
2436 global or local to buffer |global-local|
2437 {not in Vi}
2438 {not available when compiled without the |+quickfix|
2439 feature}
2440 Scanf-like description of the format for the lines in the error file
2441 (see |errorformat|).
2442
2443 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2444'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2445 global
2446 {not in Vi}
2447 Function keys that start with an <Esc> are recognized in Insert
2448 mode. When this option is off, the cursor and function keys cannot be
2449 used in Insert mode if they start with an <Esc>. The advantage of
2450 this is that the single <Esc> is recognized immediately, instead of
2451 after one second. Instead of resetting this option, you might want to
2452 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2453 when 'esckeys' is off, you can still map anything, but the cursor keys
2454 won't work by default.
2455 NOTE: This option is set to the Vi default value when 'compatible' is
2456 set and to the Vim default value when 'compatible' is reset.
2457
2458 *'eventignore'* *'ei'*
2459'eventignore' 'ei' string (default "")
2460 global
2461 {not in Vi}
2462 {not available when compiled without the |+autocmd|
2463 feature}
2464 A list of autocommand event names, which are to be ignored.
2465 When set to "all", all autocommand events are ignored, autocommands
2466 will not be executed.
2467 Otherwise this is a comma separated list of event names. Example: >
2468 :set ei=WinEnter,WinLeave
2469<
2470 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2471'expandtab' 'et' boolean (default off)
2472 local to buffer
2473 {not in Vi}
2474 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002475 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002476 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2477 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2478 NOTE: This option is reset when 'compatible' is set.
2479
2480 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2481'exrc' 'ex' boolean (default off)
2482 global
2483 {not in Vi}
2484 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2485 directory. If you switch this option on you should also consider
2486 setting the 'secure' option (see |initialization|). Using a local
2487 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2488 also see |.vimrc| and |gui-init|.
2489 This option cannot be set from a |modeline| or in the |sandbox|, for
2490 security reasons.
2491
2492 *'fileencoding'* *'fenc'* *E213*
2493'fileencoding' 'fenc' string (default: "")
2494 local to buffer
2495 {only available when compiled with the |+multi_byte|
2496 feature}
2497 {not in Vi}
2498 Sets the character encoding for the file of this buffer.
2499 When 'fileencoding' is different from 'encoding', conversion will be
2500 done when reading and writing the file.
2501 When 'fileencoding' is empty, the same value as 'encoding' will be
2502 used (no conversion when reading or writing a file).
2503 WARNING: Conversion can cause loss of information! When
2504 'encoding' is "utf-8" conversion is most likely done in a way
2505 that the reverse conversion results in the same text. When
2506 'encoding' is not "utf-8" some characters may be lost!
2507 See 'encoding' for the possible values. Additionally, values may be
2508 specified that can be handled by the converter, see
2509 |mbyte-conversion|.
2510 When reading a file 'fileencoding' will be set from 'fileencodings'.
2511 To read a file in a certain encoding it won't work by setting
2512 'fileencoding', use the |++enc| argument.
2513 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2514 When the option is set, the value is converted to lowercase. Thus
2515 you can set it with uppercase values too. '_' characters are
2516 replaced with '-'. If a name is recognized from the list for
2517 'encoding', it is replaced by the standard name. For example
2518 "ISO8859-2" becomes "iso-8859-2".
2519 When this option is set, after starting to edit a file, the 'modified'
2520 option is set, because the file would be different when written.
2521 If you do this in a modeline, you might want to set 'nomodified' to
2522 avoid this.
2523 This option can not be changed when 'modifiable' is off.
2524
2525 *'fe'*
2526 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002527 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002528 old short name was 'fe', which is no longer used.
2529
2530 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002531'fileencodings' 'fencs' string (default: "ucs-bom",
2532 "ucs-bom,utf-8,default,latin1" when
2533 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002534 global
2535 {only available when compiled with the |+multi_byte|
2536 feature}
2537 {not in Vi}
2538 This is a list of character encodings considered when starting to edit
2539 an existing file. When a file is read, Vim tries to use the first
2540 mentioned character encoding. If an error is detected, the next one
2541 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002542 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002543 an empty string, which means the value of 'encoding' is used.
2544 WARNING: Conversion can cause loss of information! When
2545 'encoding' is "utf-8" (or one of the other Unicode variants)
2546 conversion is most likely done in a way that the reverse
2547 conversion results in the same text. When 'encoding' is not
2548 "utf-8" special characters may be lost!
2549 For an empty file or a file with only ASCII characters most encodings
2550 will work and the first entry of 'fileencodings' will be used (except
2551 "ucs-bom", which requires the BOM to be present). If you prefer
2552 another encoding use an BufReadPost autocommand event to test if your
2553 preferred encoding is to be used. Example: >
2554 au BufReadPost * if search('\S', 'w') == 0 |
2555 \ set fenc=iso-2022-jp | endif
2556< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2557 non-blank characters.
2558 Note that 'fileencodings' is not used for an new file, 'fileencoding'
2559 is always empty then. This means that a non-existing file may get a
2560 different encoding than an empty file.
2561 The special value "ucs-bom" can be used to check for a Unicode BOM
2562 (Byte Order Mark) at the start of the file. It must not be preceded
2563 by "utf-8" or another Unicode encoding for this to work properly.
2564 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2565 because Vim cannot detect an error, thus the encoding is always
2566 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002567 The special value "default" can be used for the encoding from the
2568 environment. This is the default value for 'encoding'. It is useful
2569 when 'encoding' is set to "utf-8" and your environment uses a
2570 non-latin1 encoding, such as Russian.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002571 WRONG VALUES: WHAT'S WRONG:
2572 latin1,utf-8 "latin1" will always be used
2573 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2574 file
2575 cp1250,latin1 "cp1250" will always be used
2576 If 'fileencodings' is empty, 'fileencoding' is not modified.
2577 See 'fileencoding' for the possible values.
2578 Setting this option does not have an effect until the next time a file
2579 is read.
2580
2581 *'fileformat'* *'ff'*
2582'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2583 Unix default: "unix",
2584 Macintosh default: "mac")
2585 local to buffer
2586 {not in Vi}
2587 This gives the <EOL> of the current buffer, which is used for
2588 reading/writing the buffer from/to a file:
2589 dos <CR> <NL>
2590 unix <NL>
2591 mac <CR>
2592 When "dos" is used, CTRL-Z at the end of a file is ignored.
2593 See |file-formats| and |file-read|.
2594 For the character encoding of the file see 'fileencoding'.
2595 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2596 works like it was set to "unix'.
2597 This option is set automatically when starting to edit a file and
2598 'fileformats' is not empty and 'binary' is off.
2599 When this option is set, after starting to edit a file, the 'modified'
2600 option is set, because the file would be different when written.
2601 This option can not be changed when 'modifiable' is off.
2602 For backwards compatibility: When this option is set to "dos",
2603 'textmode' is set, otherwise 'textmode' is reset.
2604
2605 *'fileformats'* *'ffs'*
2606'fileformats' 'ffs' string (default:
2607 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2608 Vim Unix: "unix,dos",
2609 Vim Mac: "mac,unix,dos",
2610 Vi Cygwin: "unix,dos",
2611 Vi others: "")
2612 global
2613 {not in Vi}
2614 This gives the end-of-line (<EOL>) formats that will be tried when
2615 starting to edit a new buffer and when reading a file into an existing
2616 buffer:
2617 - When empty, the format defined with 'fileformat' will be used
2618 always. It is not set automatically.
2619 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002620 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002621 'fileformats' name will be used when a file is read into an existing
2622 buffer, no matter what 'fileformat' for that buffer is set to.
2623 - When more than one name is present, separated by commas, automatic
2624 <EOL> detection will be done when reading a file. When starting to
2625 edit a file, a check is done for the <EOL>:
2626 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2627 'fileformat' is set to "dos".
2628 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002629 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002630 preceding <CR>, "unix" is preferred over "dos".
2631 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2632 This means that "mac" is only chosen when "unix" is not present,
2633 or when no <NL> is found in the file, and when "dos" is not
2634 present, or no <CR><NL> is present in the file.
2635 Also if "unix" was first chosen, but the first <CR> is before
2636 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2637 the file, then 'fileformat' is set to "mac".
2638 4. If 'fileformat' is still not set, the first name from
2639 'fileformats' is used.
2640 When reading a file into an existing buffer, the same is done, but
2641 this happens like 'fileformat' has been set appropriately for that
2642 file only, the option is not changed.
2643 When 'binary' is set, the value of 'fileformats' is not used.
2644
2645 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2646 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2647 done:
2648 - When 'fileformats' is empty, there is no automatic detection. Dos
2649 format will be used.
2650 - When 'fileformats' is set to one or more names, automatic detection
2651 is done. This is based on the first <NL> in the file: If there is a
2652 <CR> in front of it, Dos format is used, otherwise Unix format is
2653 used.
2654 Also see |file-formats|.
2655 For backwards compatibility: When this option is set to an empty
2656 string or one format (no comma is included), 'textauto' is reset,
2657 otherwise 'textauto' is set.
2658 NOTE: This option is set to the Vi default value when 'compatible' is
2659 set and to the Vim default value when 'compatible' is reset.
2660
2661 *'filetype'* *'ft'*
2662'filetype' 'ft' string (default: "")
2663 local to buffer
2664 {not in Vi}
2665 {not available when compiled without the |+autocmd|
2666 feature}
2667 When this option is set, the FileType autocommand event is triggered.
2668 All autocommands that match with the value of this option will be
2669 executed. Thus the value of 'filetype' is used in place of the file
2670 name.
2671 Otherwise this option does not always reflect the current file type.
2672 This option is normally set when the file type is detected. To enable
2673 this use the ":filetype on" command. |:filetype|
2674 Setting this option to a different value is most useful in a modeline,
2675 for a file for which the file type is not automatically recognized.
2676 Example, for in an IDL file: >
2677 /* vim: set filetype=idl : */
2678< |FileType| |filetypes|
2679 Do not confuse this option with 'osfiletype', which is for the file
2680 type that is actually stored with the file.
2681 This option is not copied to another buffer, independent of the 's' or
2682 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002683 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002684
2685 *'fillchars'* *'fcs'*
2686'fillchars' 'fcs' string (default "vert:|,fold:-")
2687 global
2688 {not in Vi}
2689 {not available when compiled without the |+windows|
2690 and |+folding| features}
2691 Characters to fill the statuslines and vertical separators.
2692 It is a comma separated list of items:
2693
2694 item default Used for ~
2695 stl:c ' ' or '^' statusline of the current window
2696 stlnc:c ' ' or '-' statusline of the non-current windows
2697 vert:c '|' vertical separators |:vsplit|
2698 fold:c '-' filling 'foldtext'
2699 diff:c '-' deleted lines of the 'diff' option
2700
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002701 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002702 "stlnc" the space will be used when there is highlighting, '^' or '-'
2703 otherwise.
2704
2705 Example: >
2706 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2707< This is similar to the default, except that these characters will also
2708 be used when there is highlighting.
2709
2710 The highlighting used for these items:
2711 item highlight group ~
2712 stl:c StatusLine |hl-StatusLine|
2713 stlnc:c StatusLineNC |hl-StatusLineNC|
2714 vert:c VertSplit |hl-VertSplit|
2715 fold:c Folded |hl-Folded|
2716 diff:c DiffDelete |hl-DiffDelete|
2717
2718 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2719'fkmap' 'fk' boolean (default off) *E198*
2720 global
2721 {not in Vi}
2722 {only available when compiled with the |+rightleft|
2723 feature}
2724 When on, the keyboard is mapped for the Farsi character set.
2725 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002726 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002727
2728 *'foldclose'* *'fcl'*
2729'foldclose' 'fcl' string (default "")
2730 global
2731 {not in Vi}
2732 {not available when compiled without the |+folding|
2733 feature}
2734 When set to "all", a fold is closed when the cursor isn't in it and
2735 its level is higher than 'foldlevel'. Useful if you want folds to
2736 automatically close when moving out of them.
2737
2738 *'foldcolumn'* *'fdc'*
2739'foldcolumn' 'fdc' number (default 0)
2740 local to window
2741 {not in Vi}
2742 {not available when compiled without the |+folding|
2743 feature}
2744 When non-zero, a column with the specified width is shown at the side
2745 of the window which indicates open and closed folds. The maximum
2746 value is 12.
2747 See |folding|.
2748
2749 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2750'foldenable' 'fen' boolean (default on)
2751 local to window
2752 {not in Vi}
2753 {not available when compiled without the |+folding|
2754 feature}
2755 When off, all folds are open. This option can be used to quickly
2756 switch between showing all text unfolded and viewing the text with
2757 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002758 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002759 'foldenable' is off.
2760 This option is set by commands that create a new fold or close a fold.
2761 See |folding|.
2762
2763 *'foldexpr'* *'fde'*
2764'foldexpr' 'fde' string (default: "0")
2765 local to window
2766 {not in Vi}
2767 {not available when compiled without the |+folding|
2768 or |+eval| feature}
2769 The expression used for when 'foldmethod' is "expr". It is evaluated
2770 for each line to obtain its fold level. See |fold-expr|. Also see
2771 |eval-sandbox|.
2772
2773 *'foldignore'* *'fdi'*
2774'foldignore' 'fdi' string (default: "#")
2775 local to window
2776 {not in Vi}
2777 {not available when compiled without the |+folding|
2778 feature}
2779 Used only when 'foldmethod' is "indent". Lines starting with
2780 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002781 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002782 The default "#" works well for C programs. See |fold-indent|.
2783
2784 *'foldlevel'* *'fdl'*
2785'foldlevel' 'fdl' number (default: 0)
2786 local to window
2787 {not in Vi}
2788 {not available when compiled without the |+folding|
2789 feature}
2790 Sets the fold level: Folds with a higher level will be closed.
2791 Setting this option to zero will close all folds. Higher numbers will
2792 close fewer folds.
2793 This option is set by commands like |zm|, |zM| and |zR|.
2794 See |fold-foldlevel|.
2795
2796 *'foldlevelstart'* *'fdls'*
2797'foldlevelstart' 'fdls' number (default: -1)
2798 global
2799 {not in Vi}
2800 {not available when compiled without the |+folding|
2801 feature}
2802 Sets 'foldlevel' when starting to edit another buffer in a window.
2803 Useful to always start editing with all folds closed (value zero),
2804 some folds closed (one) or no folds closed (99).
2805 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002806 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002807 ignores this option and closes all folds.
2808 It is also done before BufReadPre autocommands, to allow an autocmd to
2809 overrule the 'foldlevel' value for specific files.
2810 When the value is negative, it is not used.
2811
2812 *'foldmarker'* *'fmr'* *E536*
2813'foldmarker' 'fmr' string (default: "{{{,}}}")
2814 local to window
2815 {not in Vi}
2816 {not available when compiled without the |+folding|
2817 feature}
2818 The start and end marker used when 'foldmethod' is "marker". There
2819 must be one comma, which separates the start and end marker. The
2820 marker is a literal string (a regular expression would be too slow).
2821 See |fold-marker|.
2822
2823 *'foldmethod'* *'fdm'*
2824'foldmethod' 'fdm' string (default: "manual")
2825 local to window
2826 {not in Vi}
2827 {not available when compiled without the |+folding|
2828 feature}
2829 The kind of folding used for the current window. Possible values:
2830 |fold-manual| manual Folds are created manually.
2831 |fold-indent| indent Lines with equal indent form a fold.
2832 |fold-expr| expr 'foldexpr' gives the fold level of a line.
2833 |fold-marker| marker Markers are used to specify folds.
2834 |fold-syntax| syntax Syntax highlighting items specify folds.
2835 |fold-diff| diff Fold text that is not changed.
2836
2837 *'foldminlines'* *'fml'*
2838'foldminlines' 'fml' number (default: 1)
2839 local to window
2840 {not in Vi}
2841 {not available when compiled without the |+folding|
2842 feature}
2843 Sets the minimum number of screen lines for a fold to be displayed
2844 closed. Also for manually closed folds.
2845 Note that this only has an effect of what is displayed. After using
2846 "zc" to close a fold, which is displayed open because it's smaller
2847 than 'foldminlines', a following "zc" may close a containing fold.
2848
2849 *'foldnestmax'* *'fdn'*
2850'foldnestmax' 'fdn' number (default: 20)
2851 local to window
2852 {not in Vi}
2853 {not available when compiled without the |+folding|
2854 feature}
2855 Sets the maximum nesting of folds for the "indent" and "syntax"
2856 methods. This avoids that too many folds will be created. Using more
2857 than 20 doesn't work, because the internal limit is 20.
2858
2859 *'foldopen'* *'fdo'*
2860'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
2861 search,tag,undo")
2862 global
2863 {not in Vi}
2864 {not available when compiled without the |+folding|
2865 feature}
2866 Specifies for which type of commands folds will be opened, if the
2867 command moves the cursor into a closed fold. It is a comma separated
2868 list of items.
2869 item commands ~
2870 all any
2871 block "(", "{", "[[", "[{", etc.
2872 hor horizontal movements: "l", "w", "fx", etc.
2873 insert any command in Insert mode
2874 jump far jumps: "G", "gg", etc.
2875 mark jumping to a mark: "'m", CTRL-O, etc.
2876 percent "%"
2877 quickfix ":cn", ":crew", ":make", etc.
2878 search search for a pattern: "/", "n", "*", "gd", etc.
2879 (not for a search pattern in a ":" command)
2880 tag jumping to a tag: ":ta", CTRL-T, etc.
2881 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002882 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00002883 the |zv| command to the mapping to get the same effect.
2884 When a movement command is used for an operator (e.g., "dl" or "y%")
2885 this option is not used. This means the operator will include the
2886 whole closed fold.
2887 Note that vertical movements are not here, because it would make it
2888 very difficult to move onto a closed fold.
2889 In insert mode the folds containing the cursor will always be open
2890 when text is inserted.
2891 To close folds you can re-apply 'foldlevel' with the |zx| command or
2892 set the 'foldclose' option to "all".
2893
2894 *'foldtext'* *'fdt'*
2895'foldtext' 'fdt' string (default: "foldtext()")
2896 local to window
2897 {not in Vi}
2898 {not available when compiled without the |+folding|
2899 feature}
2900 An expression which is used to specify the text displayed for a closed
2901 fold. See |fold-foldtext|.
2902
2903 *'formatoptions'* *'fo'*
2904'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
2905 local to buffer
2906 {not in Vi}
2907 This is a sequence of letters which describes how automatic
2908 formatting is to be done. See |fo-table|. When the 'paste' option is
2909 on, no formatting is done (like 'formatoptions' is empty). Commas can
2910 be inserted for readability.
2911 To avoid problems with flags that are added in the future, use the
2912 "+=" and "-=" feature of ":set" |add-option-flags|.
2913 NOTE: This option is set to the Vi default value when 'compatible' is
2914 set and to the Vim default value when 'compatible' is reset.
2915
Bram Moolenaar86b68352004-12-27 21:59:20 +00002916 *'formatlistpat'* *'flp'*
2917'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
2918 local to buffer
2919 {not in Vi}
2920 A pattern that is used to recognize a list header. This is used for
2921 the "n" flag in 'formatoptions'.
2922 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00002923 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00002924 while still checking more characters. There must be a character
2925 following the pattern, when it matches the whole line it is handled
2926 like there is no match.
2927 The default recognizes a number, followed by an optional punctuation
2928 character and white space.
2929
Bram Moolenaar071d4272004-06-13 20:20:40 +00002930 *'formatprg'* *'fp'*
2931'formatprg' 'fp' string (default "")
2932 global
2933 {not in Vi}
2934 The name of an external program that will be used to format the lines
2935 selected with the "gq" command. The program must take the input on
2936 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00002937 such a program.
2938 If this option is an empty string, the internal format function will
2939 be used |C-indenting|.
2940 Environment variables are expanded |:set_env|. See |option-backslash|
2941 about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002942 This option cannot be set from a |modeline| or in the |sandbox|, for
2943 security reasons.
2944
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002945 *'fsync'* *'fs'*
2946'fsync' 'fs' boolean (default on)
2947 global
2948 {not in Vi}
2949 When on, the library function fsync() will be called after writing a
2950 file. This will flush a file to disk, ensuring that it is safely
2951 written even on filesystems which do metadata-only journaling. This
2952 will force the harddrive to spin up on Linux systems running in laptop
2953 mode, so it may be undesirable in some situations. Be warned that
2954 turning this off increases the chances of data loss after a crash. On
2955 systems without an fsync() implementation, this variable is always
2956 off.
2957 Also see 'swapsync' for controlling fsync() on swap files.
2958
Bram Moolenaar071d4272004-06-13 20:20:40 +00002959 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
2960'gdefault' 'gd' boolean (default off)
2961 global
2962 {not in Vi}
2963 When on, the ":substitute" flag 'g' is default on. This means that
2964 all matches in a line are substituted instead of one. When a 'g' flag
2965 is given to a ":substitute" command, this will toggle the substitution
2966 of all or one match. See |complex-change|.
2967
2968 command 'gdefault' on 'gdefault' off ~
2969 :s/// subst. all subst. one
2970 :s///g subst. one subst. all
2971 :s///gg subst. all subst. one
2972
2973 NOTE: This option is reset when 'compatible' is set.
2974
2975 *'grepformat'* *'gfm'*
2976'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
2977 global
2978 {not in Vi}
2979 Format to recognize for the ":grep" command output.
2980 This is a scanf-like string that uses the same format as the
2981 'errorformat' option: see |errorformat|.
2982
2983 *'grepprg'* *'gp'*
2984'grepprg' 'gp' string (default "grep -n ",
2985 Unix: "grep -n $* /dev/null",
2986 Win32: "findstr /n" or "grep -n",
2987 VMS: "SEARCH/NUMBERS ")
2988 global or local to buffer |global-local|
2989 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00002990 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002991 and '#' characters, which are expanded like when used in a command-
2992 line. The placeholder "$*" is allowed to specify where the arguments
2993 will be included. Environment variables are expanded |:set_env|. See
2994 |option-backslash| about including spaces and backslashes.
2995 When your "grep" accepts the "-H" argument, use this to make ":grep"
2996 also work well with a single file: >
2997 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00002998< Special value: When 'grepprg' is set to "internal" the |:grep| command
2999 works like |:vimgrep| and |:grepadd| like |:vimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003000 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003001 apply equally to 'grepprg'.
3002 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3003 otherwise it's "grep -n".
3004 This option cannot be set from a |modeline| or in the |sandbox|, for
3005 security reasons.
3006
3007 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3008'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3009 ve:ver35-Cursor,
3010 o:hor50-Cursor,
3011 i-ci:ver25-Cursor/lCursor,
3012 r-cr:hor20-Cursor/lCursor,
3013 sm:block-Cursor
3014 -blinkwait175-blinkoff150-blinkon175",
3015 for MS-DOS and Win32 console:
3016 "n-v-c:block,o:hor50,i-ci:hor15,
3017 r-cr:hor30,sm:block")
3018 global
3019 {not in Vi}
3020 {only available when compiled with GUI enabled, and
3021 for MS-DOS and Win32 console}
3022 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003023 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003024 the height of the cursor can be changed. This can be done by
3025 specifying a block cursor, or a percentage for a vertical or
3026 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003027 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003028
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003029 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003030 mode-list and an argument-list:
3031 mode-list:argument-list,mode-list:argument-list,..
3032 The mode-list is a dash separated list of these modes:
3033 n Normal mode
3034 v Visual mode
3035 ve Visual mode with 'selection' "exclusive" (same as 'v',
3036 if not specified)
3037 o Operator-pending mode
3038 i Insert mode
3039 r Replace mode
3040 c Command-line Normal (append) mode
3041 ci Command-line Insert mode
3042 cr Command-line Replace mode
3043 sm showmatch in Insert mode
3044 a all modes
3045 The argument-list is a dash separated list of these arguments:
3046 hor{N} horizontal bar, {N} percent of the character height
3047 ver{N} vertical bar, {N} percent of the character width
3048 block block cursor, fills the whole character
3049 [only one of the above three should be present]
3050 blinkwait{N} *cursor-blinking*
3051 blinkon{N}
3052 blinkoff{N}
3053 blink times for cursor: blinkwait is the delay before
3054 the cursor starts blinking, blinkon is the time that
3055 the cursor is shown and blinkoff is the time that the
3056 cursor is not shown. The times are in msec. When one
3057 of the numbers is zero, there is no blinking. The
3058 default is: "blinkwait700-blinkon400-blinkoff250".
3059 These numbers are used for a missing entry. This
3060 means that blinking is enabled by default. To switch
3061 blinking off you can use "blinkon0". The cursor only
3062 blinks when Vim is waiting for input, not while
3063 executing a command.
3064 To make the cursor blink in an xterm, see
3065 |xterm-blink|.
3066 {group-name}
3067 a highlight group name, that sets the color and font
3068 for the cursor
3069 {group-name}/{group-name}
3070 Two highlight group names, the first is used when
3071 no language mappings are used, the other when they
3072 are. |language-mapping|
3073
3074 Examples of parts:
3075 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3076 block cursor with colors from the "nCursor"
3077 highlight group
3078 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3079 In Insert and Command-line Insert mode, use a
3080 30% vertical bar cursor with colors from the
3081 "iCursor" highlight group. Blink a bit
3082 faster.
3083
3084 The 'a' mode is different. It will set the given argument-list for
3085 all modes. It does not reset anything to defaults. This can be used
3086 to do a common setting for all modes. For example, to switch off
3087 blinking: "a:blinkon0"
3088
3089 Examples of cursor highlighting: >
3090 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3091 :highlight Cursor gui=NONE guifg=bg guibg=fg
3092<
3093 *'guifont'* *'gfn'*
3094 *E235* *E596* *E610* *E611*
3095'guifont' 'gfn' string (default "")
3096 global
3097 {not in Vi}
3098 {only available when compiled with GUI enabled}
3099 This is a list of fonts which will be used for the GUI version of Vim.
3100 In its simplest form the value is just one font name. When
3101 the font cannot be found you will get an error message. To try other
3102 font names a list can be specified, font names separated with commas.
3103 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003104
Bram Moolenaar05159a02005-02-26 23:04:13 +00003105 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3106 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003107
Bram Moolenaar071d4272004-06-13 20:20:40 +00003108 Spaces after a comma are ignored. To include a comma in a font name
3109 precede it with a backslash. Setting an option requires an extra
3110 backslash before a space and a backslash. See also
3111 |option-backslash|. For example: >
3112 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003113< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003114 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003115
3116 If none of the fonts can be loaded, Vim will keep the current setting.
3117 If an empty font list is given, Vim will try using other resource
3118 settings (for X, it will use the Vim.font resource), and finally it
3119 will try some builtin default which should always be there ("7x13" in
3120 the case of X). The font names given should be "normal" fonts. Vim
3121 will try to find the related bold and italic fonts.
3122
Bram Moolenaar05159a02005-02-26 23:04:13 +00003123 For Win32, GTK, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003124 :set guifont=*
3125< will bring up a font requester, where you can pick the font you want.
3126
3127 The font name depends on the GUI used. See |setting-guifont| for a
3128 way to set 'guifont' for various systems.
3129
Bram Moolenaar071d4272004-06-13 20:20:40 +00003130 For the GTK+ 2 GUI the font name looks like this: >
3131 :set guifont=Andale\ Mono\ 11
3132< That's all. XLFDs are no longer accepted.
Bram Moolenaar05159a02005-02-26 23:04:13 +00003133
3134 For Mac OSX you can use something like this: >
3135 :set guifont=Monaco:h10
3136< *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003137 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003138 width). An exception is GTK 2: all fonts are accepted, but
3139 mono-spaced fonts look best.
3140
Bram Moolenaar071d4272004-06-13 20:20:40 +00003141 To preview a font on X11, you might be able to use the "xfontsel"
3142 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003143
Bram Moolenaar071d4272004-06-13 20:20:40 +00003144 For the Win32 GUI *E244* *E245*
3145 - takes these options in the font name:
3146 hXX - height is XX (points, can be floating-point)
3147 wXX - width is XX (points, can be floating-point)
3148 b - bold
3149 i - italic
3150 u - underline
3151 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003152 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003153 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3154 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3155 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003156 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003157
3158 Use a ':' to separate the options.
3159 - A '_' can be used in the place of a space, so you don't need to use
3160 backslashes to escape the spaces.
3161 - Examples: >
3162 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3163 :set guifont=Andale_Mono:h7.5:w4.5
3164< See also |font-sizes|.
3165
3166 *'guifontset'* *'gfs'*
3167 *E250* *E252* *E234* *E597* *E598*
3168'guifontset' 'gfs' string (default "")
3169 global
3170 {not in Vi}
3171 {only available when compiled with GUI enabled and
3172 with the |+xfontset| feature}
3173 {not available in the GTK+ 2 GUI}
3174 When not empty, specifies two (or more) fonts to be used. The first
3175 one for normal English, the second one for your special language. See
3176 |xfontset|.
3177 Setting this option also means that all font names will be handled as
3178 a fontset name. Also the ones used for the "font" argument of the
3179 |:highlight| command.
3180 The fonts must match with the current locale. If fonts for the
3181 character sets that the current locale uses are not included, setting
3182 'guifontset' will fail.
3183 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3184 the comma-separated names are alternative names, one of which will be
3185 used. In 'guifontset' the whole string is one fontset name,
3186 including the commas. It is not possible to specify alternative
3187 fontset names.
3188 This example works on many X11 systems: >
3189 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3190<
3191 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3192'guifontwide' 'gfw' string (default "")
3193 global
3194 {not in Vi}
3195 {only available when compiled with GUI enabled}
3196 When not empty, specifies a comma-separated list of fonts to be used
3197 for double-width characters. The first font that can be loaded is
3198 used.
3199 Note: The size of these fonts must be exactly twice as wide as the one
3200 specified with 'guifont' and the same height.
3201
3202 All GUI versions but GTK+ 2:
3203
3204 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3205 'guifontset' is empty or invalid.
3206 When 'guifont' is set and a valid font is found in it and
3207 'guifontwide' is empty Vim will attempt to find a matching
3208 double-width font and set 'guifontwide' to it.
3209
3210 GTK+ 2 GUI only: *guifontwide_gtk2*
3211
3212 If set and valid, 'guifontwide' is always used for double width
3213 characters, even if 'encoding' is not set to "utf-8".
3214 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003215 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003216 font for characters not available in 'guifont'. Thus you do not need
3217 to set 'guifontwide' at all unless you want to override the choice
3218 made by Pango/Xft.
3219
3220 *'guiheadroom'* *'ghr'*
3221'guiheadroom' 'ghr' number (default 50)
3222 global
3223 {not in Vi} {only for GTK and X11 GUI}
3224 The number of pixels subtracted from the screen height when fitting
3225 the GUI window on the screen. Set this before the GUI is started,
3226 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003227 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003228 lines will be left for window decorations and other items on the
3229 screen. Set it to a negative value to allow windows taller than the
3230 screen.
3231
3232 *'guioptions'* *'go'*
3233'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003234 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003235 global
3236 {not in Vi}
3237 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003238 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003239 sequence of letters which describes what components and options of the
3240 GUI should be used.
3241 To avoid problems with flags that are added in the future, use the
3242 "+=" and "-=" feature of ":set" |add-option-flags|.
3243
3244 Valid letters are as follows:
3245 *guioptions_a*
3246 'a' Autoselect: If present, then whenever VISUAL mode is started,
3247 or the Visual area extended, Vim tries to become the owner of
3248 the windowing system's global selection. This means that the
3249 Visually highlighted text is available for pasting into other
3250 applications as well as into Vim itself. When the Visual mode
3251 ends, possibly due to an operation on the text, or when an
3252 application wants to paste the selection, the highlighted text
3253 is automatically yanked into the "* selection register.
3254 Thus the selection is still available for pasting into other
3255 applications after the VISUAL mode has ended.
3256 If not present, then Vim won't become the owner of the
3257 windowing system's global selection unless explicitly told to
3258 by a yank or delete operation for the "* register.
3259 The same applies to the modeless selection.
3260
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003261 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003262 applies to the modeless selection.
3263
3264 'guioptions' autoselect Visual autoselect modeless ~
3265 "" - -
3266 "a" yes yes
3267 "A" - yes
3268 "aA" yes yes
3269
3270 'c' Use console dialogs instead of popup dialogs for simple
3271 choices.
3272
3273 'f' Foreground: Don't use fork() to detach the GUI from the shell
3274 where it was started. Use this for programs that wait for the
3275 editor to finish (e.g., an e-mail program). Alternatively you
3276 can use "gvim -f" or ":gui -f" to start the GUI in the
3277 foreground. |gui-fork|
3278 Note: Set this option in the vimrc file. The forking may have
3279 happened already when the gvimrc file is read.
3280
3281 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3282 corner of the window. It's black&white on non-GTK, because of
3283 limitations of X11. For a color icon, see |X11-icon|.
3284
3285 'm' Menu bar is present.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003286 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003287 that this flag must be added in the .vimrc file, before
3288 switching on syntax or filetype recognition (when the .gvimrc
3289 file is sourced the system menu has already been loaded; the
3290 ":syntax on" and ":filetype on" commands load the menu too).
3291 'g' Grey menu items: Make menu items that are not active grey. If
3292 'g' is not included inactive menu items are not shown at all.
3293 Exception: Athena will always use grey menu items.
3294
3295 't' Include tearoff menu items. Currently only works for Win32,
3296 GTK+, and Motif 1.2 GUI.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003297 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
3298 and Athena GUIs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003299
3300 'r' Right-hand scrollbar is always present.
3301 'R' Right-hand scrollbar is present when there is a vertically
3302 split window.
3303 'l' Left-hand scrollbar is always present.
3304 'L' Left-hand scrollbar is present when there is a vertically
3305 split window.
3306 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3307 the longest visible line, or on the cursor line if the 'h'
3308 flag is included. |gui-horiz-scroll|
3309 'h' Limit horizontal scrollbar size to the length of the cursor
3310 line. Reduces computations. |gui-horiz-scroll|
3311
3312 And yes, you may even have scrollbars on the left AND the right if
3313 you really want to :-). See |gui-scrollbars| for more information.
3314
3315 'v' Use a vertical button layout for dialogs. When not included,
3316 a horizontal layout is preferred, but when it doesn't fit a
3317 vertical layout is used anyway.
3318 'p' Use Pointer callbacks for X11 GUI. This is required for some
3319 window managers. If the cursor is not blinking or hollow at
3320 the right moment, try adding this flag. This must be done
3321 before starting the GUI. Set it in your gvimrc. Adding or
3322 removing it after the GUI has started has no effect.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003323 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003324
3325 *'guipty'* *'noguipty'*
3326'guipty' boolean (default on)
3327 global
3328 {not in Vi}
3329 {only available when compiled with GUI enabled}
3330 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3331 I/O to/from shell commands. See |gui-pty|.
3332
3333 *'helpfile'* *'hf'*
3334'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3335 (others) "$VIMRUNTIME/doc/help.txt")
3336 global
3337 {not in Vi}
3338 Name of the main help file. All distributed help files should be
3339 placed together in one directory. Additionally, all "doc" directories
3340 in 'runtimepath' will be used.
3341 Environment variables are expanded |:set_env|. For example:
3342 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003343 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003344 spaces and backslashes.
3345 This option cannot be set from a |modeline| or in the |sandbox|, for
3346 security reasons.
3347
3348 *'helpheight'* *'hh'*
3349'helpheight' 'hh' number (default 20)
3350 global
3351 {not in Vi}
3352 {not available when compiled without the +windows
3353 feature}
3354 Minimal initial height of the help window when it is opened with the
3355 ":help" command. The initial height of the help window is half of the
3356 current window, or (when the 'ea' option is on) the same as other
3357 windows. When the height is less than 'helpheight', the height is
3358 set to 'helpheight'. Set to zero to disable.
3359
3360 *'helplang'* *'hlg'*
3361'helplang' 'hlg' string (default: messages language or empty)
3362 global
3363 {only available when compiled with the |+multi_lang|
3364 feature}
3365 {not in Vi}
3366 Comma separated list of languages. Vim will use the first language
3367 for which the desired help can be found. The English help will always
3368 be used as a last resort. You can add "en" to prefer English over
3369 another language, but that will only find tags that exist in that
3370 language and not in the English help.
3371 Example: >
3372 :set helplang=de,it
3373< This will first search German, then Italian and finally English help
3374 files.
3375 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3376 try to find the tag in the current language before using this option.
3377 See |help-translated|.
3378
3379 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3380'hidden' 'hid' boolean (default off)
3381 global
3382 {not in Vi}
3383 When off a buffer is unloaded when it is |abandon|ed. When on a
3384 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3385 displayed in another window, it does not become hidden, of course.
3386 The commands that move through the buffer list sometimes make a buffer
3387 hidden although the 'hidden' option is off: When the buffer is
3388 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003389 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003390 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003391 This option is set for one command with ":hide {command}" |:hide|.
3392 WARNING: It's easy to forget that you have changes in hidden buffers.
3393 Think twice when using ":q!" or ":qa!".
3394
3395 *'highlight'* *'hl'*
3396'highlight' 'hl' string (default (as a single string):
3397 "8:SpecialKey,@:NonText,d:Directory,
3398 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3399 M:ModeMsg,n:LineNr,r:Question,
3400 s:StatusLine,S:StatusLineNC,c:VertSplit
3401 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3402 f:Folded,F:FoldColumn,A:DiffAdd,
3403 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003404 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003405 R:SpellRare,L:SpellLocal,
3406 +:Pmenu,=:PmenuSel,
3407 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003408 global
3409 {not in Vi}
3410 This option can be used to set highlighting mode for various
3411 occasions. It is a comma separated list of character pairs. The
3412 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003413 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003414 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3415 |hl-NonText| @ '~' and '@' at the end of the window and
3416 characters from 'showbreak'
3417 |hl-Directory| d directories in CTRL-D listing and other special
3418 things in listings
3419 |hl-ErrorMsg| e error messages
3420 h (obsolete, ignored)
3421 |hl-IncSearch| i 'incsearch' highlighting
3422 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3423 |hl-MoreMsg| m |more-prompt|
3424 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
3425 |hl-LineNr| n line number for ":number" and ":#" commands
3426 |hl-Question| r |hit-enter| prompt and yes/no questions
3427 |hl-StatusLine| s status line of current window |status-line|
3428 |hl-StatusLineNC| S status lines of not-current windows
3429 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3430 |hl-VertSplit| c column used to separate vertically split windows
3431 |hl-Visual| v Visual mode
3432 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3433 Selection" Only X11 Gui's |gui-x11| and
3434 |xterm-clipboard|.
3435 |hl-WarningMsg| w warning messages
3436 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3437 |hl-Folded| f line used for closed folds
3438 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003439 |hl-DiffAdd| A added line in diff mode
3440 |hl-DiffChange| C changed line in diff mode
3441 |hl-DiffDelete| D deleted line in diff mode
3442 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003443 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003444 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003445 |hl-SpellCap| P word that should start with capital|spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003446 |hl-SpellRare| R rare word |spell|
3447 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003448 |hl-Pmenu| + popup menu normal line
3449 |hl-PmenuSel| = popup menu normal line
3450 |hl-PmenuSbar| x popup menu scrollbar
3451 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003452
3453 The display modes are:
3454 r reverse (termcap entry "mr" and "me")
3455 i italic (termcap entry "ZH" and "ZR")
3456 b bold (termcap entry "md" and "me")
3457 s standout (termcap entry "so" and "se")
3458 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003459 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003460 n no highlighting
3461 - no highlighting
3462 : use a highlight group
3463 The default is used for occasions that are not included.
3464 If you want to change what the display modes do, see |dos-colors|
3465 for an example.
3466 When using the ':' display mode, this must be followed by the name of
3467 a highlight group. A highlight group can be used to define any type
3468 of highlighting, including using color. See |:highlight| on how to
3469 define one. The default uses a different group for each occasion.
3470 See |highlight-default| for the default highlight groups.
3471
3472 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3473'hlsearch' 'hls' boolean (default off)
3474 global
3475 {not in Vi}
3476 {not available when compiled without the
3477 |+extra_search| feature}
3478 When there is a previous search pattern, highlight all its matches.
3479 The type of highlighting used can be set with the 'l' occasion in the
3480 'highlight' option. This uses the "Search" highlight group by
3481 default. Note that only the matching text is highlighted, any offsets
3482 are not applied.
3483 See also: 'incsearch' and |:match|.
3484 When you get bored looking at the highlighted matches, you can turn it
3485 off with |:nohlsearch|. As soon as you use a search command, the
3486 highlighting comes back.
3487 When the search pattern can match an end-of-line, Vim will try to
3488 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003489 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003490 line below a closed fold. A match in a previous line which is not
3491 drawn may not continue in an newly drawn line.
3492 NOTE: This option is reset when 'compatible' is set.
3493
3494 *'history'* *'hi'*
3495'history' 'hi' number (Vim default: 20, Vi default: 0)
3496 global
3497 {not in Vi}
3498 A history of ":" commands, and a history of previous search patterns
3499 are remembered. This option decides how many entries may be stored in
3500 each of these histories (see |cmdline-editing|).
3501 NOTE: This option is set to the Vi default value when 'compatible' is
3502 set and to the Vim default value when 'compatible' is reset.
3503
3504 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3505'hkmap' 'hk' boolean (default off)
3506 global
3507 {not in Vi}
3508 {only available when compiled with the |+rightleft|
3509 feature}
3510 When on, the keyboard is mapped for the Hebrew character set.
3511 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3512 toggle this option. See |rileft.txt|.
3513 NOTE: This option is reset when 'compatible' is set.
3514
3515 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3516'hkmapp' 'hkp' boolean (default off)
3517 global
3518 {not in Vi}
3519 {only available when compiled with the |+rightleft|
3520 feature}
3521 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3522 This is useful if you have a non-Hebrew keyboard.
3523 See |rileft.txt|.
3524 NOTE: This option is reset when 'compatible' is set.
3525
3526 *'icon'* *'noicon'*
3527'icon' boolean (default off, on when title can be restored)
3528 global
3529 {not in Vi}
3530 {not available when compiled without the |+title|
3531 feature}
3532 When on, the icon text of the window will be set to the value of
3533 'iconstring' (if it is not empty), or to the name of the file
3534 currently being edited. Only the last part of the name is used.
3535 Overridden by the 'iconstring' option.
3536 Only works if the terminal supports setting window icons (currently
3537 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3538 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3539 builtin termcap).
3540 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003541 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003542 X11.
3543
3544 *'iconstring'*
3545'iconstring' string (default "")
3546 global
3547 {not in Vi}
3548 {not available when compiled without the |+title|
3549 feature}
3550 When this option is not empty, it will be used for the icon text of
3551 the window. This happens only when the 'icon' option is on.
3552 Only works if the terminal supports setting window icon text
3553 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3554 Does not work for MS Windows.
3555 When Vim was compiled with HAVE_X11 defined, the original icon will be
3556 restored if possible |X11|.
3557 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003558 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003559 'titlestring' for example settings.
3560 {not available when compiled without the |+statusline| feature}
3561
3562 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3563'ignorecase' 'ic' boolean (default off)
3564 global
3565 Ignore case in search patterns. Also used when searching in the tags
3566 file.
3567 Also see 'smartcase'.
3568 Can be overruled by using "\c" or "\C" in the pattern, see
3569 |/ignorecase|.
3570
3571 *'imactivatekey'* *'imak'*
3572'imactivatekey' 'imak' string (default "")
3573 global
3574 {not in Vi}
3575 {only available when compiled with |+xim| and
3576 |+GUI_GTK|}
3577 Specifies the key that your Input Method in X-Windows uses for
3578 activation. When this is specified correctly, vim can fully control
3579 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3580 You can't use this option to change the activation key, the option
3581 tells Vim what the key is.
3582 Format:
3583 [MODIFIER_FLAG-]KEY_STRING
3584
3585 These characters can be used for MODIFIER_FLAG (case is ignored):
3586 S Shift key
3587 L Lock key
3588 C Control key
3589 1 Mod1 key
3590 2 Mod2 key
3591 3 Mod3 key
3592 4 Mod4 key
3593 5 Mod5 key
3594 Combinations are allowed, for example "S-C-space" or "SC-space" are
3595 both shift+ctrl+space.
3596 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3597
3598 Example: >
3599 :set imactivatekey=S-space
3600< "S-space" means shift+space. This is the activation key for kinput2 +
3601 canna (Japanese), and ami (Korean).
3602
3603 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3604'imcmdline' 'imc' boolean (default off)
3605 global
3606 {not in Vi}
3607 {only available when compiled with the |+xim|
3608 |+multi_byte_ime| or |global-ime| feature}
3609 When set the Input Method is always on when starting to edit a command
3610 line, unless entering a search pattern (see 'imsearch' for that).
3611 Setting this option is useful when your input method allows entering
3612 English characters directly, e.g., when it's used to type accented
3613 characters with dead keys.
3614
3615 *'imdisable'* *'imd'* *'nodisable'* *'noimd'*
3616'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3617 global
3618 {not in Vi}
3619 {only available when compiled with the |+xim|
3620 |+multi_byte_ime| or |global-ime| feature}
3621 When set the Input Method is never used. This is useful to disable
3622 the IM when it doesn't work properly.
3623 Currently this option is on by default for SGI/IRIX machines. This
3624 may change in later releases.
3625
3626 *'iminsert'* *'imi'*
3627'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3628 local to buffer
3629 {not in Vi}
3630 Specifies whether :lmap or an Input Method (IM) is to be used in
3631 Insert mode. Valid values:
3632 0 :lmap is off and IM is off
3633 1 :lmap is ON and IM is off
3634 2 :lmap is off and IM is ON
3635 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3636 or |global-ime|.
3637 To always reset the option to zero when leaving Insert mode with <Esc>
3638 this can be used: >
3639 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3640< This makes :lmap and IM turn off automatically when leaving Insert
3641 mode.
3642 Note that this option changes when using CTRL-^ in Insert mode
3643 |i_CTRL-^|.
3644 The value is set to 1 when setting 'keymap' to a valid keymap name.
3645 It is also used for the argument of commands like "r" and "f".
3646 The value 0 may not work correctly with Athena and Motif with some XIM
3647 methods. Use 'imdisable' to disable XIM then.
3648
3649 *'imsearch'* *'ims'*
3650'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3651 local to buffer
3652 {not in Vi}
3653 Specifies whether :lmap or an Input Method (IM) is to be used when
3654 entering a search pattern. Valid values:
3655 -1 the value of 'iminsert' is used, makes it look like
3656 'iminsert' is also used when typing a search pattern
3657 0 :lmap is off and IM is off
3658 1 :lmap is ON and IM is off
3659 2 :lmap is off and IM is ON
3660 Note that this option changes when using CTRL-^ in Command-line mode
3661 |c_CTRL-^|.
3662 The value is set to 1 when it is not -1 and setting the 'keymap'
3663 option to a valid keymap name.
3664 The value 0 may not work correctly with Athena and Motif with some XIM
3665 methods. Use 'imdisable' to disable XIM then.
3666
3667 *'include'* *'inc'*
3668'include' 'inc' string (default "^\s*#\s*include")
3669 global or local to buffer |global-local|
3670 {not in Vi}
3671 {not available when compiled without the
3672 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003673 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003674 pattern, just like for the "/" command (See |pattern|). The default
3675 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00003676 "]I", "[d", etc.
3677 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003678 comes after the matched pattern. But if "\zs" appears in the pattern
3679 then the text matched from "\zs" to the end, or until "\ze" if it
3680 appears, is used as the file name. Use this to include characters
3681 that are not in 'isfname', such as a space. You can then use
3682 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003683 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003684
3685 *'includeexpr'* *'inex'*
3686'includeexpr' 'inex' string (default "")
3687 local to buffer
3688 {not in Vi}
3689 {not available when compiled without the
3690 |+find_in_path| or |+eval| feature}
3691 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003692 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003693 :set includeexpr=substitute(v:fname,'\\.','/','g')
3694< The "v:fname" variable will be set to the file name that was detected.
3695 Evaluated in the |sandbox|.
3696 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003697 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003698 Also used for |<cfile>|.
3699
3700 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3701'incsearch' 'is' boolean (default off)
3702 global
3703 {not in Vi}
3704 {not available when compiled without the
3705 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003706 While typing a search command, show where the pattern, as it was typed
3707 so far, matches. The matched string is highlighted. If the pattern
3708 is invalid or not found, nothing is shown. The screen will be updated
3709 often, this is only useful on fast terminals.
3710 Note that the match will be shown, but the cursor will return to its
3711 original position when no match is found and when pressing <Esc>. You
3712 still need to finish the search command with <Enter> to move the
3713 cursor to the match.
3714 The highlighting can be set with the 'i' flag in 'highlight'.
3715 See also: 'hlsearch'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003716 NOTE: This option is reset when 'compatible' is set.
3717
3718 *'indentexpr'* *'inde'*
3719'indentexpr' 'inde' string (default "")
3720 local to buffer
3721 {not in Vi}
3722 {not available when compiled without the |+cindent|
3723 or |+eval| features}
3724 Expression which is evaluated to obtain the proper indent for a line.
3725 It is used when a new line is created, for the |=| operator and
3726 in Insert mode as specified with the 'indentkeys' option.
3727 When this option is not empty, it overrules the 'cindent' and
3728 'smartindent' indenting.
3729 When 'paste' is set this option is not used for indenting.
3730 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003731 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00003732 when the expression is evaluated (but it may be moved around).
3733 The expression must return the number of spaces worth of indent. It
3734 can return "-1" to keep the current indent (this means 'autoindent' is
3735 used for the indent).
3736 Functions useful for computing the indent are |indent()|, |cindent()|
3737 and |lispindent()|.
3738 The evaluation of the expression must not have side effects! It must
3739 not change the text, jump to another window, etc. Afterwards the
3740 cursor position is always restored, thus the cursor may be moved.
3741 Normally this option would be set to call a function: >
3742 :set indentexpr=GetMyIndent()
3743< Error messages will be suppressed, unless the 'debug' option contains
3744 "msg".
3745 See |indent-expression|. Also see |eval-sandbox|.
3746 NOTE: This option is made empty when 'compatible' is set.
3747
3748 *'indentkeys'* *'indk'*
3749'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
3750 local to buffer
3751 {not in Vi}
3752 {not available when compiled without the |+cindent|
3753 feature}
3754 A list of keys that, when typed in Insert mode, cause reindenting of
3755 the current line. Only happens if 'indentexpr' isn't empty.
3756 The format is identical to 'cinkeys', see |indentkeys-format|.
3757 See |C-indenting| and |indent-expression|.
3758
3759 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
3760'infercase' 'inf' boolean (default off)
3761 local to buffer
3762 {not in Vi}
3763 When doing keyword completion in insert mode |ins-completion|, and
3764 'ignorecase' is also on, the case of the match is adjusted. If the
3765 typed text contains a lowercase letter where the match has an upper
3766 case letter, the completed part is made lowercase. If the typed text
3767 has no lowercase letters and the match has a lowercase letter where
3768 the typed text has an uppercase letter, and there is a letter before
3769 it, the completed part is made uppercase.
3770
3771 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
3772'insertmode' 'im' boolean (default off)
3773 global
3774 {not in Vi}
3775 Makes Vim work in a way that Insert mode is the default mode. Useful
3776 if you want to use Vim as a modeless editor. Used for |evim|.
3777 These Insert mode commands will be useful:
3778 - Use the cursor keys to move around.
3779 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
3780 this is a mapping, it is executed as if 'insertmode' was off.
3781 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003782 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00003783 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
3784 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003785
3786 These items change when 'insertmode' is set:
3787 - when starting to edit of a file, Vim goes to Insert mode.
3788 - <Esc> in Insert mode is a no-op and beeps.
3789 - <Esc> in Normal mode makes Vim go to Insert mode.
3790 - CTRL-L in Insert mode is a command, it is not inserted.
3791 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
3792 However, when <Esc> is used inside a mapping, it behaves like
3793 'insertmode' was not set. This was done to be able to use the same
3794 mappings with 'insertmode' set or not set.
3795 When executing commands with |:normal| 'insertmode' is not used.
3796
3797 NOTE: This option is reset when 'compatible' is set.
3798
3799 *'isfname'* *'isf'*
3800'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
3801 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
3802 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
3803 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
3804 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
3805 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
3806 global
3807 {not in Vi}
3808 The characters specified by this option are included in file names and
3809 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003810 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003811 Multi-byte characters 256 and above are always included, only the
3812 characters up to 255 are specified with this option.
3813 For UTF-8 the characters 0xa0 to 0xff are included as well.
3814
3815 Note that on systems using a backslash as path separator, Vim tries to
3816 do its best to make it work as you would expect. That is a bit
3817 tricky, since Vi originally used the backslash to escape special
3818 characters. Vim will not remove a backslash in front of a normal file
3819 name character on these systems, but it will on Unix and alikes. The
3820 '&' and '^' are not included by default, because these are special for
3821 cmd.exe.
3822
3823 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003824 Each part can be a single character number or a range. A range is two
3825 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003826 decimal number between 0 and 255 or the ASCII character itself (does
3827 not work for digits). Example:
3828 "_,-,128-140,#-43" (include '_' and '-' and the range
3829 128 to 140 and '#' to 43)
3830 If a part starts with '^', the following character number or range
3831 will be excluded from the option. The option is interpreted from left
3832 to right. Put the excluded character after the range where it is
3833 included. To include '^' itself use it as the last character of the
3834 option or the end of a range. Example:
3835 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
3836 If the character is '@', all characters where isalpha() returns TRUE
3837 are included. Normally these are the characters a to z and A to Z,
3838 plus accented characters. To include '@' itself use "@-@". Examples:
3839 "@,^a-z" All alphabetic characters, excluding lower
3840 case letters.
3841 "a-z,A-Z,@-@" All letters plus the '@' character.
3842 A comma can be included by using it where a character number is
3843 expected. Example:
3844 "48-57,,,_" Digits, comma and underscore.
3845 A comma can be excluded by prepending a '^'. Example:
3846 " -~,^,,9" All characters from space to '~', excluding
3847 comma, plus <Tab>.
3848 See |option-backslash| about including spaces and backslashes.
3849
3850 *'isident'* *'isi'*
3851'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
3852 "@,48-57,_,128-167,224-235"
3853 otherwise: "@,48-57,_,192-255")
3854 global
3855 {not in Vi}
3856 The characters given by this option are included in identifiers.
3857 Identifiers are used in recognizing environment variables and after a
3858 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00003859 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00003860 option.
3861 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003862 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003863 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
3864
3865 *'iskeyword'* *'isk'*
3866'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
3867 "@,48-57,_,128-167,224-235"
3868 otherwise: "@,48-57,_,192-255"
3869 Vi default: "@,48-57,_")
3870 local to buffer
3871 {not in Vi}
3872 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003873 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003874 'isfname' for a description of the format of this option. For C
3875 programs you could use "a-z,A-Z,48-57,_,.,-,>".
3876 For a help file it is set to all non-blank printable characters except
3877 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
3878 command).
3879 When the 'lisp' option is on the '-' character is always included.
3880 NOTE: This option is set to the Vi default value when 'compatible' is
3881 set and to the Vim default value when 'compatible' is reset.
3882
3883 *'isprint'* *'isp'*
3884'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
3885 "@,~-255"; otherwise: "@,161-255")
3886 global
3887 {not in Vi}
3888 The characters given by this option are displayed directly on the
3889 screen. It is also used for "\p" in a |pattern|. The characters from
3890 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
3891 even when they are not included in 'isprint' or excluded. See
3892 'isfname' for a description of the format of this option.
3893
3894 Non-printable characters are displayed with two characters:
3895 0 - 31 "^@" - "^_"
3896 32 - 126 always single characters
3897 127 "^?"
3898 128 - 159 "~@" - "~_"
3899 160 - 254 "| " - "|~"
3900 255 "~?"
3901 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
3902 displayed as <xx>, with the hexadecimal value of the byte.
3903 When 'display' contains "uhex" all unprintable characters are
3904 displayed as <xx>.
3905 The NonText highlighting will be used for unprintable characters.
3906 |hl-NonText|
3907
3908 Multi-byte characters 256 and above are always included, only the
3909 characters up to 255 are specified with this option. When a character
3910 is printable but it is not available in the current font, a
3911 replacement character will be shown.
3912 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
3913 There is no option to specify these characters.
3914
3915 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
3916'joinspaces' 'js' boolean (default on)
3917 global
3918 {not in Vi}
3919 Insert two spaces after a '.', '?' and '!' with a join command.
3920 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
3921 Otherwise only one space is inserted.
3922 NOTE: This option is set when 'compatible' is set.
3923
3924 *'key'*
3925'key' string (default "")
3926 local to buffer
3927 {not in Vi}
3928 The key that is used for encrypting and decrypting the current buffer.
3929 See |encryption|.
3930 Careful: Do not set the key value by hand, someone might see the typed
3931 key. Use the |:X| command. But you can make 'key' empty: >
3932 :set key=
3933< It is not possible to get the value of this option with ":set key" or
3934 "echo &key". This is to avoid showing it to someone who shouldn't
3935 know. It also means you cannot see it yourself once you have set it,
3936 be careful not to make a typing error!
3937
3938 *'keymap'* *'kmp'* *E544*
3939'keymap' 'kmp' string (default "")
3940 local to buffer
3941 {not in Vi}
3942 {only available when compiled with the |+keymap|
3943 feature}
3944 Name of a keyboard mapping. See |mbyte-keymap|.
3945 Setting this option to a valid keymap name has the side effect of
3946 setting 'iminsert' to one, so that the keymap becomes effective.
3947 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003948 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003949
3950 *'keymodel'* *'km'*
3951'keymodel' 'km' string (default "")
3952 global
3953 {not in Vi}
3954 List of comma separated words, which enable special things that keys
3955 can do. These values can be used:
3956 startsel Using a shifted special key starts selection (either
3957 Select mode or Visual mode, depending on "key" being
3958 present in 'selectmode').
3959 stopsel Using a not-shifted special key stops selection.
3960 Special keys in this context are the cursor keys, <End>, <Home>,
3961 <PageUp> and <PageDown>.
3962 The 'keymodel' option is set by the |:behave| command.
3963
3964 *'keywordprg'* *'kp'*
3965'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
3966 OS/2: "view /", VMS: "help")
3967 global or local to buffer |global-local|
3968 {not in Vi}
3969 Program to use for the |K| command. Environment variables are
3970 expanded |:set_env|. ":help" may be used to access the Vim internal
3971 help. (Note that previously setting the global option to the empty
3972 value did this, which is now deprecated.)
3973 When "man" is used, Vim will automatically translate a count for the
3974 "K" command to a section number. Also for "man -s", in which case the
3975 "-s" is removed when there is no count.
3976 See |option-backslash| about including spaces and backslashes.
3977 Example: >
3978 :set keywordprg=man\ -s
3979< This option cannot be set from a |modeline| or in the |sandbox|, for
3980 security reasons.
3981
3982 *'langmap'* *'lmap'* *E357* *E358*
3983'langmap' 'lmap' string (default "")
3984 global
3985 {not in Vi}
3986 {only available when compiled with the |+langmap|
3987 feature}
3988 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003989 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00003990 inserted directly. When in command mode the 'langmap' option takes
3991 care of translating these special characters to the original meaning
3992 of the key. This means you don't have to change the keyboard mode to
3993 be able to execute Normal mode commands.
3994 This is the opposite of the 'keymap' option, where characters are
3995 mapped in Insert mode.
3996 This only works for 8-bit characters. The value of 'langmap' may be
3997 specified with multi-byte characters (e.g., UTF-8), but only the lower
3998 8 bits of each character will be used.
3999
4000 Example (for Greek): *greek* >
4001 :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
4002< Example (exchanges meaning of z and y for commands): >
4003 :set langmap=zy,yz,ZY,YZ
4004<
4005 The 'langmap' option is a list of parts, separated with commas. Each
4006 part can be in one of two forms:
4007 1. A list of pairs. Each pair is a "from" character immediately
4008 followed by the "to" character. Examples: "aA", "aAbBcC".
4009 2. A list of "from" characters, a semi-colon and a list of "to"
4010 characters. Example: "abc;ABC"
4011 Example: "aA,fgh;FGH,cCdDeE"
4012 Special characters need to be preceded with a backslash. These are
4013 ";", ',' and backslash itself.
4014
4015 This will allow you to activate vim actions without having to switch
4016 back and forth between the languages. Your language characters will
4017 be understood as normal vim English characters (according to the
4018 langmap mappings) in the following cases:
4019 o Normal/Visual mode (commands, buffer/register names, user mappings)
4020 o Insert/Replace Mode: Register names after CTRL-R
4021 o Insert/Replace Mode: Mappings
4022 Characters entered in Command-line mode will NOT be affected by
4023 this option. Note that this option can be changed at any time
4024 allowing to switch between mappings for different languages/encodings.
4025 Use a mapping to avoid having to type it each time!
4026
4027 *'langmenu'* *'lm'*
4028'langmenu' 'lm' string (default "")
4029 global
4030 {not in Vi}
4031 {only available when compiled with the |+menu| and
4032 |+multi_lang| features}
4033 Language to use for menu translation. Tells which file is loaded
4034 from the "lang" directory in 'runtimepath': >
4035 "lang/menu_" . &langmenu . ".vim"
4036< (without the spaces). For example, to always use the Dutch menus, no
4037 matter what $LANG is set to: >
4038 :set langmenu=nl_NL.ISO_8859-1
4039< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004040 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004041 If your $LANG is set to a non-English language but you do want to use
4042 the English menus: >
4043 :set langmenu=none
4044< This option must be set before loading menus, switching on filetype
4045 detection or syntax highlighting. Once the menus are defined setting
4046 this option has no effect. But you could do this: >
4047 :source $VIMRUNTIME/delmenu.vim
4048 :set langmenu=de_DE.ISO_8859-1
4049 :source $VIMRUNTIME/menu.vim
4050< Warning: This deletes all menus that you defined yourself!
4051
4052 *'laststatus'* *'ls'*
4053'laststatus' 'ls' number (default 1)
4054 global
4055 {not in Vi}
4056 The value of this option influences when the last window will have a
4057 status line:
4058 0: never
4059 1: only if there are at least two windows
4060 2: always
4061 The screen looks nicer with a status line if you have several
4062 windows, but it takes another screen line. |status-line|
4063
4064 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4065'lazyredraw' 'lz' boolean (default off)
4066 global
4067 {not in Vi}
4068 When this option is set, the screen will not be redrawn while
4069 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004070 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004071 update use |:redraw|.
4072
4073 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4074'linebreak' 'lbr' boolean (default off)
4075 local to window
4076 {not in Vi}
4077 {not available when compiled without the |+linebreak|
4078 feature}
4079 If on Vim will wrap long lines at a character in 'breakat' rather
4080 than at the last character that fits on the screen. Unlike
4081 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4082 it only affects the way the file is displayed, not its contents. The
4083 value of 'showbreak' is used to put in front of wrapped lines.
4084 This option is not used when the 'wrap' option is off or 'list' is on.
4085 Note that <Tab> characters after an <EOL> are mostly not displayed
4086 with the right amount of white space.
4087
4088 *'lines'* *E593*
4089'lines' number (default 24 or terminal height)
4090 global
4091 Number of lines of the Vim window.
4092 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004093 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004094 When Vim is running in the GUI or in a resizable window, setting this
4095 option will cause the window size to be changed. When you only want
4096 to use the size for the GUI, put the command in your |gvimrc| file.
4097 Vim limits the number of lines to what fits on the screen. You can
4098 use this command to get the tallest window possible: >
4099 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004100< Minimum value is 2, maximum value is 1000.
4101 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004102 When you set this option and Vim is unable to change the physical
4103 number of lines of the display, the display may be messed up.
4104
4105 *'linespace'* *'lsp'*
4106'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4107 global
4108 {not in Vi}
4109 {only in the GUI}
4110 Number of pixel lines inserted between characters. Useful if the font
4111 uses the full character cell height, making lines touch each other.
4112 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004113 With some fonts there can be too much room between lines (to have
4114 space for ascents and descents). Then it makes sense to set
4115 'linespace' to a negative value. This may cause display problems
4116 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004117
4118 *'lisp'* *'nolisp'*
4119'lisp' boolean (default off)
4120 local to buffer
4121 {not available when compiled without the |+lispindent|
4122 feature}
4123 Lisp mode: When <Enter> is typed in insert mode set the indent for
4124 the next line to Lisp standards (well, sort of). Also happens with
4125 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4126 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4127 better. Also see 'lispwords'.
4128 The '-' character is included in keyword characters. Redefines the
4129 "=" operator to use this same indentation algorithm rather than
4130 calling an external program if 'equalprg' is empty.
4131 This option is not used when 'paste' is set.
4132 {Vi: Does it a little bit differently}
4133
4134 *'lispwords'* *'lw'*
4135'lispwords' 'lw' string (default is very long)
4136 global
4137 {not in Vi}
4138 {not available when compiled without the |+lispindent|
4139 feature}
4140 Comma separated list of words that influence the Lisp indenting.
4141 |'lisp'|
4142
4143 *'list'* *'nolist'*
4144'list' boolean (default off)
4145 local to window
4146 List mode: Show tabs as CTRL-I, show end of line with $. Useful to
4147 see the difference between tabs and spaces and for trailing blanks.
4148 Note that this will also affect formatting (set with 'textwidth' or
4149 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
4150 changing the way tabs are displayed.
4151
4152 *'listchars'* *'lcs'*
4153'listchars' 'lcs' string (default "eol:$")
4154 global
4155 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004156 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004157 settings.
4158 eol:c Character to show at the end of each line. When
4159 omitted, there is no extra character at the end of the
4160 line.
4161 tab:xy Two characters to be used to show a Tab. The first
4162 char is used once. The second char is repeated to
4163 fill the space that the Tab normally occupies.
4164 "tab:>-" will show a Tab that takes four spaces as
4165 ">---". When omitted, a Tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004166 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004167 trailing spaces are blank.
4168 extends:c Character to show in the last column, when 'wrap' is
4169 off and the line continues beyond the right of the
4170 screen.
4171 precedes:c Character to show in the first column, when 'wrap'
4172 is off and there is text preceding the character
4173 visible in the first column.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004174 nbsp:c Character to show for a non-breakable space (character
4175 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004176
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004177 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004178 be used when 'encoding' is "utf-8", otherwise only printable
4179 characters are allowed.
4180
4181 Examples: >
4182 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004183 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004184 :set lcs=extends:>,precedes:<
4185< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004186 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004187
4188 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4189'loadplugins' 'lpl' boolean (default on)
4190 global
4191 {not in Vi}
4192 When on the plugin scripts are loaded when starting up |load-plugins|.
4193 This option can be reset in your |vimrc| file to disable the loading
4194 of plugins.
4195 Note that using the "-u NONE" and "--noplugin" command line arguments
4196 reset this option. |-u| |--noplugin|
4197
4198 *'magic'* *'nomagic'*
4199'magic' boolean (default on)
4200 global
4201 Changes the special characters that can be used in search patterns.
4202 See |pattern|.
4203 NOTE: To avoid portability problems with using patterns, always keep
4204 this option at the default "on". Only switch it off when working with
4205 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004206 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004207
4208 *'makeef'* *'mef'*
4209'makeef' 'mef' string (default: "")
4210 global
4211 {not in Vi}
4212 {not available when compiled without the |+quickfix|
4213 feature}
4214 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4215 and the |:grep| command.
4216 When it is empty, an internally generated temp file will be used.
4217 When "##" is included, it is replaced by a number to make the name
4218 unique. This makes sure that the ":make" command doesn't overwrite an
4219 existing file.
4220 NOT used for the ":cf" command. See 'errorfile' for that.
4221 Environment variables are expanded |:set_env|.
4222 See |option-backslash| about including spaces and backslashes.
4223 This option cannot be set from a |modeline| or in the |sandbox|, for
4224 security reasons.
4225
4226 *'makeprg'* *'mp'*
4227'makeprg' 'mp' string (default "make", VMS: "MMS")
4228 global or local to buffer |global-local|
4229 {not in Vi}
4230 Program to use for the ":make" command. See |:make_makeprg|. This
4231 option may contain '%' and '#' characters, which are expanded like
4232 when used in a command-line. Environment variables are expanded
4233 |:set_env|. See |option-backslash| about including spaces and
4234 backslashes. Note that a '|' must be escaped twice: once for ":set"
4235 and once for the interpretation of a command. When you use a filter
4236 called "myfilter" do it like this: >
4237 :set makeprg=gmake\ \\\|\ myfilter
4238< The placeholder "$*" can be given (even multiple times) to specify
4239 where the arguments will be included, for example: >
4240 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4241< This option cannot be set from a |modeline| or in the |sandbox|, for
4242 security reasons.
4243
4244 *'matchpairs'* *'mps'*
4245'matchpairs' 'mps' string (default "(:),{:},[:]")
4246 local to buffer
4247 {not in Vi}
4248 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004249 other. Currently only single character pairs are allowed, and they
Bram Moolenaar071d4272004-06-13 20:20:40 +00004250 must be different. The characters must be separated by a colon. The
4251 pairs must be separated by a comma. Example for including '<' and '>'
4252 (HTML): >
4253 :set mps+=<:>
4254
4255< A more exotic example, to jump between the '=' and ';' in an
4256 assignment, useful for languages like C and Java: >
4257 :au FileType c,cpp,java set mps+==:;
4258
4259< For a more advanced way of using "%", see the matchit.vim plugin in
4260 the $VIMRUNTIME/macros directory. |add-local-help|
4261
4262 *'matchtime'* *'mat'*
4263'matchtime' 'mat' number (default 5)
4264 global
4265 {not in Vi}{in Nvi}
4266 Tenths of a second to show the matching paren, when 'showmatch' is
4267 set. Note that this is not in milliseconds, like other options that
4268 set a time. This is to be compatible with Nvi.
4269
4270 *'maxfuncdepth'* *'mfd'*
4271'maxfuncdepth' 'mfd' number (default 100)
4272 global
4273 {not in Vi}
4274 Maximum depth of function calls for user functions. This normally
4275 catches endless recursion. When using a recursive function with
4276 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4277 more memory, there is the danger of failing when memory is exhausted.
4278 See also |:function|.
4279
4280 *'maxmapdepth'* *'mmd'* *E223*
4281'maxmapdepth' 'mmd' number (default 1000)
4282 global
4283 {not in Vi}
4284 Maximum number of times a mapping is done without resulting in a
4285 character to be used. This normally catches endless mappings, like
4286 ":map x y" with ":map y x". It still does not catch ":map g wg",
4287 because the 'w' is used before the next mapping is done. See also
4288 |key-mapping|.
4289
4290 *'maxmem'* *'mm'*
4291'maxmem' 'mm' number (default between 256 to 5120 (system
4292 dependent) or half the amount of memory
4293 available)
4294 global
4295 {not in Vi}
4296 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4297 limit is reached allocating extra memory for a buffer will cause
4298 other memory to be freed. Maximum value 2000000. Use this to work
4299 without a limit. Also see 'maxmemtot'.
4300
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004301 *'maxmempattern'* *'mmp'*
4302'maxmempattern' 'mmp' number (default 1000)
4303 global
4304 {not in Vi}
4305 Maximum amount of memory (in Kbyte) to use for pattern matching.
4306 Maximum value 2000000. Use this to work without a limit.
4307 *E363*
4308 When Vim runs into the limit it gives an error message mostly behaves
4309 like CTRL-C was typed.
4310 Running into the limit often means that the pattern is very
4311 inefficient or too complex. This may already happen with the pattern
4312 "\(.\)*" on a very long line. ".*" works much better.
4313 Vim may run out of memory before hitting the 'maxmempattern' limit.
4314
Bram Moolenaar071d4272004-06-13 20:20:40 +00004315 *'maxmemtot'* *'mmt'*
4316'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4317 dependent) or half the amount of memory
4318 available)
4319 global
4320 {not in Vi}
4321 Maximum amount of memory (in Kbyte) to use for all buffers together.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004322 Maximum value 2000000. Use this to work without a limit. Also see
Bram Moolenaar071d4272004-06-13 20:20:40 +00004323 'maxmem'.
4324
4325 *'menuitems'* *'mis'*
4326'menuitems' 'mis' number (default 25)
4327 global
4328 {not in Vi}
4329 {not available when compiled without the |+menu|
4330 feature}
4331 Maximum number of items to use in a menu. Used for menus that are
4332 generated from a list of items, e.g., the Buffers menu. Changing this
4333 option has no direct effect, the menu must be refreshed first.
4334
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004335 *'mkspellmem'* *'msm'*
4336'mkspellmem' 'msm' string (default "460000,2000,500")
4337 global
4338 {not in Vi}
4339 {not available when compiled without the |+syntax|
4340 feature}
4341 Parameters for |:mkspell|. This tunes when to start compressing the
4342 word tree. Compression can be slow when there are many words, but
4343 it's needed to avoid running out of memory. The amount of memory used
4344 per word depends very much on how similar the words are, that's why
4345 this tuning is complicated.
4346
4347 There are three numbers, separated by commas:
4348 {start},{inc},{added}
4349
4350 For most languages the uncompressed word tree fits in memory. {start}
4351 gives the amount of memory in Kbyte that can be used before any
4352 compression is done. It should be a bit smaller than the amount of
4353 memory that is available to Vim.
4354
4355 When going over the {start} limit the {inc} number specifies the
4356 amount of memory in Kbyte that can be allocated before another
4357 compression is done. A low number means compression is done after
4358 less words are added, which is slow. A high number means more memory
4359 will be allocated.
4360
4361 After doing compression, {added} times 1024 words can be added before
4362 the {inc} limit is ignored and compression is done when any extra
4363 amount of memory is needed. A low number means there is a smaller
4364 chance of hitting the {inc} limit, less memory is used but it's
4365 slower.
4366
4367 The languages for which these numbers are important are Italian and
4368 Hungarian. The default works for when you have about 512 Mbyte. If
4369 you have 1 Gbyte you could use: >
4370 :set mkspellmem=900000,3000,800
4371< If you have less than 512 Mbyte |:mkspell| may fail for some
4372 languages, no matter what you set 'mkspellmem' to.
4373
Bram Moolenaar071d4272004-06-13 20:20:40 +00004374 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
4375'modeline' 'ml' boolean (Vim default: on, Vi default: off)
4376 local to buffer
4377 *'modelines'* *'mls'*
4378'modelines' 'mls' number (default 5)
4379 global
4380 {not in Vi}
4381 If 'modeline' is on 'modelines' gives the number of lines that is
4382 checked for set commands. If 'modeline' is off or 'modelines' is zero
4383 no lines are checked. See |modeline|.
4384 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4385 set and to the Vim default value when 'compatible' is reset.
4386
4387 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4388'modifiable' 'ma' boolean (default on)
4389 local to buffer
4390 {not in Vi} *E21*
4391 When off the buffer contents cannot be changed. The 'fileformat' and
4392 'fileencoding' options also can't be changed.
4393 Can be reset with the |-M| command line argument.
4394
4395 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4396'modified' 'mod' boolean (default off)
4397 local to buffer
4398 {not in Vi}
4399 When on, the buffer is considered to be modified. This option is set
4400 when:
4401 1. A change was made to the text since it was last written. Using the
4402 |undo| command to go back to the original text will reset the
4403 option. But undoing changes that were made before writing the
4404 buffer will set the option again, since the text is different from
4405 when it was written.
4406 2. 'fileformat' or 'fileencoding' is different from its original
4407 value. The original value is set when the buffer is read or
4408 written. A ":set nomodified" command also resets the original
4409 values to the current values and the 'modified' option will be
4410 reset.
4411 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4412 will be ignored.
4413
4414 *'more'* *'nomore'*
4415'more' boolean (Vim default: on, Vi default: off)
4416 global
4417 {not in Vi}
4418 When on, listings pause when the whole screen is filled. You will get
4419 the |more-prompt|. When this option is off there are no pauses, the
4420 listing continues until finished.
4421 NOTE: This option is set to the Vi default value when 'compatible' is
4422 set and to the Vim default value when 'compatible' is reset.
4423
4424 *'mouse'* *E538*
4425'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4426 global
4427 {not in Vi}
4428 Enable the use of the mouse. Only works for certain terminals
4429 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, and Linux console
4430 with gpm). For using the mouse in the GUI, see |gui-mouse|.
4431 The mouse can be enabled for different modes:
4432 n Normal mode
4433 v Visual mode
4434 i Insert mode
4435 c Command-line mode
4436 h all previous modes when editing a help file
4437 a all previous modes
4438 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004439 Normally you would enable the mouse in all four modes with: >
4440 :set mouse=a
4441< When the mouse is not enabled, the GUI will still use the mouse for
4442 modeless selection. This doesn't move the text cursor.
4443
4444 See |mouse-using|. Also see |'clipboard'|.
4445
4446 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004447 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004448 the mouse buttons can still be used by keeping the shift key pressed.
4449 Also see the 'clipboard' option.
4450
4451 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4452'mousefocus' 'mousef' boolean (default off)
4453 global
4454 {not in Vi}
4455 {only works in the GUI}
4456 The window that the mouse pointer is on is automatically activated.
4457 When changing the window layout or window focus in another way, the
4458 mouse pointer is moved to the window with keyboard focus. Off is the
4459 default because it makes using the pull down menus a little goofy, as
4460 a pointer transit may activate a window unintentionally.
4461
4462 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4463'mousehide' 'mh' boolean (default on)
4464 global
4465 {not in Vi}
4466 {only works in the GUI}
4467 When on, the mouse pointer is hidden when characters are typed.
4468 The mouse pointer is restored when the mouse is moved.
4469
4470 *'mousemodel'* *'mousem'*
4471'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4472 global
4473 {not in Vi}
4474 Sets the model to use for the mouse. The name mostly specifies what
4475 the right mouse button is used for:
4476 extend Right mouse button extends a selection. This works
4477 like in an xterm.
4478 popup Right mouse button pops up a menu. The shifted left
4479 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004480 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004481 popup_setpos Like "popup", but the cursor will be moved to the
4482 position where the mouse was clicked, and thus the
4483 selected operation will act upon the clicked object.
4484 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004485 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004486 course, that right clicking outside a selection will
4487 end Visual mode.
4488 Overview of what button does what for each model:
4489 mouse extend popup(_setpos) ~
4490 left click place cursor place cursor
4491 left drag start selection start selection
4492 shift-left search word extend selection
4493 right click extend selection popup menu (place cursor)
4494 right drag extend selection -
4495 middle click paste paste
4496
4497 In the "popup" model the right mouse button produces a pop-up menu.
4498 You need to define this first, see |popup-menu|.
4499
4500 Note that you can further refine the meaning of buttons with mappings.
4501 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4502 selection (because that's handled in the GUI code directly).
4503
4504 The 'mousemodel' option is set by the |:behave| command.
4505
4506 *'mouseshape'* *'mouses'* *E547*
4507'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004508 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004509 global
4510 {not in Vi}
4511 {only available when compiled with the |+mouseshape|
4512 feature}
4513 This option tells Vim what the mouse pointer should look like in
4514 different modes. The option is a comma separated list of parts, much
4515 like used for 'guicursor'. Each part consist of a mode/location-list
4516 and an argument-list:
4517 mode-list:shape,mode-list:shape,..
4518 The mode-list is a dash separated list of these modes/locations:
4519 In a normal window: ~
4520 n Normal mode
4521 v Visual mode
4522 ve Visual mode with 'selection' "exclusive" (same as 'v',
4523 if not specified)
4524 o Operator-pending mode
4525 i Insert mode
4526 r Replace mode
4527
4528 Others: ~
4529 c appending to the command-line
4530 ci inserting in the command-line
4531 cr replacing in the command-line
4532 m at the 'Hit ENTER' or 'More' prompts
4533 ml idem, but cursor in the last line
4534 e any mode, pointer below last window
4535 s any mode, pointer on a status line
4536 sd any mode, while dragging a status line
4537 vs any mode, pointer on a vertical separator line
4538 vd any mode, while dragging a vertical separator line
4539 a everywhere
4540
4541 The shape is one of the following:
4542 avail name looks like ~
4543 w x arrow Normal mouse pointer
4544 w x blank no pointer at all (use with care!)
4545 w x beam I-beam
4546 w x updown up-down sizing arrows
4547 w x leftright left-right sizing arrows
4548 w x busy The system's usual busy pointer
4549 w x no The system's usual 'no input' pointer
4550 x udsizing indicates up-down resizing
4551 x lrsizing indicates left-right resizing
4552 x crosshair like a big thin +
4553 x hand1 black hand
4554 x hand2 white hand
4555 x pencil what you write with
4556 x question big ?
4557 x rightup-arrow arrow pointing right-up
4558 w x up-arrow arrow pointing up
4559 x <number> any X11 pointer number (see X11/cursorfont.h)
4560
4561 The "avail" column contains a 'w' if the shape is available for Win32,
4562 x for X11.
4563 Any modes not specified or shapes not available use the normal mouse
4564 pointer.
4565
4566 Example: >
4567 :set mouseshape=s:udsizing,m:no
4568< will make the mouse turn to a sizing arrow over the status lines and
4569 indicate no input when the hit-enter prompt is displayed (since
4570 clicking the mouse has no effect in this state.)
4571
4572 *'mousetime'* *'mouset'*
4573'mousetime' 'mouset' number (default 500)
4574 global
4575 {not in Vi}
4576 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4577 time in msec between two mouse clicks for the second click to be
4578 recognized as a multi click.
4579
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004580 *'mzquantum'* *'mzq'*
4581'mzquantum' 'mzq' number (default 100)
4582 global
4583 {not in Vi}
4584 {not available when compiled without the |+mzscheme|
4585 feature}
4586 The number of milliseconds between polls for MzScheme threads.
4587 Negative or zero value means no thread scheduling.
4588
Bram Moolenaar071d4272004-06-13 20:20:40 +00004589 *'nrformats'* *'nf'*
4590'nrformats' 'nf' string (default "octal,hex")
4591 local to buffer
4592 {not in Vi}
4593 This defines what bases Vim will consider for numbers when using the
4594 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4595 respectively; see |CTRL-A| for more info on these commands.
4596 alpha if included, single alphabetical characters will be
4597 incremented or decremented. This is useful for a list with a
4598 letter index a), b), etc.
4599 octal if included, numbers that start with a zero will be considered
4600 to be octal. Example: Using CTRL-A on "007" results in "010".
4601 hex if included, numbers starting with "0x" or "0X" will be
4602 considered to be hexadecimal. Example: Using CTRL-X on
4603 "0x100" results in "0x0ff".
4604 Numbers which simply begin with a digit in the range 1-9 are always
4605 considered decimal. This also happens for numbers that are not
4606 recognized as octal or hex.
4607
4608 *'number'* *'nu'* *'nonumber'* *'nonu'*
4609'number' 'nu' boolean (default off)
4610 local to window
4611 Print the line number in front of each line. When the 'n' option is
4612 excluded from 'cpoptions' a wrapped line will not use the column of
4613 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004614 The 'numberwidth' option can be used to set the room used for the line
4615 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004616 When a long, wrapped line doesn't start with the first character, '-'
4617 characters are put before the number.
4618 See |hl-LineNr| for the highlighting used for the number.
4619
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004620 *'numberwidth'* *'nuw'*
4621'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4622 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004623 {not in Vi}
4624 {only available when compiled with the |+linebreak|
4625 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004626 Minimal number of columns to use for the line number. Only relevant
4627 when the 'number' option is set.
4628 Since one space is always between the number and the text, there is
4629 one less character for the number itself.
4630 The value is the minimum width. A bigger width is used when needed to
4631 fit the highest line number in the buffer. Thus with the Vim default
4632 of 4 there is room for a line number up to 999. When the buffer has
4633 1000 lines five columns will be used.
4634 The minimum value is 1, the maximum value is 10.
4635 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
4636
Bram Moolenaarf75a9632005-09-13 21:20:47 +00004637 *'omnifunc'* *'ofu'*
4638'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00004639 local to buffer
4640 {not in Vi}
4641 {not available when compiled without the +eval
4642 or +insert_expand feature}
4643 This option specifies a function to be used for CTRL-X CTRL-O
4644 completion. |i_CTRL-X_CTRL-O|
4645
4646 For the use of the function see 'completefunc'.
4647
4648
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00004649 *'operatorfunc'* *'opfunc'*
4650'operatorfunc' 'opfunc' string (default: empty)
4651 global
4652 {not in Vi}
4653 This option specifies a function to be called by the |g@| operator.
4654 See |:map-operator| for more info and an example.
4655
4656 This option cannot be set from a |modeline| or in the |sandbox|, for
4657 security reasons.
4658
4659
Bram Moolenaar071d4272004-06-13 20:20:40 +00004660 *'osfiletype'* *'oft'* *E366*
4661'osfiletype' 'oft' string (RISC-OS default: "Text",
4662 others default: "")
4663 local to buffer
4664 {not in Vi}
4665 {only available when compiled with the |+osfiletype|
4666 feature}
4667 Some operating systems store extra information about files besides
4668 name, datestamp and permissions. This option contains the extra
4669 information, the nature of which will vary between systems.
4670 The value of this option is usually set when the file is loaded, and
4671 use to set the file type when file is written.
4672 It can affect the pattern matching of the automatic commands.
4673 |autocmd-osfiletypes|
4674
4675 *'paragraphs'* *'para'*
4676'paragraphs' 'para' string (default "IPLPPPQPP LIpplpipbp")
4677 global
4678 Specifies the nroff macros that separate paragraphs. These are pairs
4679 of two letters (see |object-motions|).
4680
4681 *'paste'* *'nopaste'*
4682'paste' boolean (default off)
4683 global
4684 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004685 Put Vim in Paste mode. This is useful if you want to cut or copy
4686 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004687 unexpected effects.
4688 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004689 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00004690 knows about pasting and will mostly do the right thing without 'paste'
4691 being set. The same is true for a terminal where Vim handles the
4692 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00004693 This option is reset when starting the GUI. Thus if you set it in
4694 your .vimrc it will work in a terminal, but not in the GUI. Setting
4695 'paste' in the GUI has side effects: e.g., the Paste toolbar button
4696 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004697 When the 'paste' option is switched on (also when it was already on):
4698 - mapping in Insert mode and Command-line mode is disabled
4699 - abbreviations are disabled
4700 - 'textwidth' is set to 0
4701 - 'wrapmargin' is set to 0
4702 - 'autoindent' is reset
4703 - 'smartindent' is reset
4704 - 'softtabstop' is set to 0
4705 - 'revins' is reset
4706 - 'ruler' is reset
4707 - 'showmatch' is reset
4708 - 'formatoptions' is used like it is empty
4709 These options keep their value, but their effect is disabled:
4710 - 'lisp'
4711 - 'indentexpr'
4712 - 'cindent'
4713 NOTE: When you start editing another file while the 'paste' option is
4714 on, settings from the modelines or autocommands may change the
4715 settings again, causing trouble when pasting text. You might want to
4716 set the 'paste' option again.
4717 When the 'paste' option is reset the mentioned options are restored to
4718 the value before the moment 'paste' was switched from off to on.
4719 Resetting 'paste' before ever setting it does not have any effect.
4720 Since mapping doesn't work while 'paste' is active, you need to use
4721 the 'pastetoggle' option to toggle the 'paste' option with some key.
4722
4723 *'pastetoggle'* *'pt'*
4724'pastetoggle' 'pt' string (default "")
4725 global
4726 {not in Vi}
4727 When non-empty, specifies the key sequence that toggles the 'paste'
4728 option. This is like specifying a mapping: >
4729 :map {keys} :set invpaste<CR>
4730< Where {keys} is the value of 'pastetoggle'.
4731 The difference is that it will work even when 'paste' is set.
4732 'pastetoggle' works in Insert mode and Normal mode, but not in
4733 Command-line mode.
4734 Mappings are checked first, thus overrule 'pastetoggle'. However,
4735 when 'paste' is on mappings are ignored in Insert mode, thus you can do
4736 this: >
4737 :map <F10> :set paste<CR>
4738 :map <F11> :set nopaste<CR>
4739 :imap <F10> <C-O>:set paste<CR>
4740 :imap <F11> <nop>
4741 :set pastetoggle=<F11>
4742< This will make <F10> start paste mode and <F11> stop paste mode.
4743 Note that typing <F10> in paste mode inserts "<F10>", since in paste
4744 mode everything is inserted literally, except the 'pastetoggle' key
4745 sequence.
4746
4747 *'pex'* *'patchexpr'*
4748'patchexpr' 'pex' string (default "")
4749 global
4750 {not in Vi}
4751 {not available when compiled without the |+diff|
4752 feature}
4753 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004754 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004755
4756 *'patchmode'* *'pm'* *E206*
4757'patchmode' 'pm' string (default "")
4758 global
4759 {not in Vi}
4760 When non-empty the oldest version of a file is kept. This can be used
4761 to keep the original version of a file if you are changing files in a
4762 source distribution. Only the first time that a file is written a
4763 copy of the original file will be kept. The name of the copy is the
4764 name of the original file with the string in the 'patchmode' option
4765 appended. This option should start with a dot. Use a string like
4766 ".org". 'backupdir' must not be empty for this to work (Detail: The
4767 backup file is renamed to the patchmode file after the new file has
4768 been successfully written, that's why it must be possible to write a
4769 backup file). If there was no file to be backed up, an empty file is
4770 created.
4771 When the 'backupskip' pattern matches, a patchmode file is not made.
4772 Using 'patchmode' for compressed files appends the extension at the
4773 end (e.g., "file.gz.orig"), thus the resulting name isn't always
4774 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004775 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004776
4777 *'path'* *'pa'* *E343* *E345* *E347*
4778'path' 'pa' string (default on Unix: ".,/usr/include,,"
4779 on OS/2: ".,/emx/include,,"
4780 other systems: ".,,")
4781 global or local to buffer |global-local|
4782 {not in Vi}
4783 This is a list of directories which will be searched when using the
4784 |gf|, [f, ]f, ^Wf, |:find| and other commands, provided that the file
4785 being searched for has a relative path (not starting with '/'). The
4786 directories in the 'path' option may be relative or absolute.
4787 - Use commas to separate directory names: >
4788 :set path=.,/usr/local/include,/usr/include
4789< - Spaces can also be used to separate directory names (for backwards
4790 compatibility with version 3.0). To have a space in a directory
4791 name, precede it with an extra backslash, and escape the space: >
4792 :set path=.,/dir/with\\\ space
4793< - To include a comma in a directory name precede it with an extra
4794 backslash: >
4795 :set path=.,/dir/with\\,comma
4796< - To search relative to the directory of the current file, use: >
4797 :set path=.
4798< - To search in the current directory use an empty string between two
4799 commas: >
4800 :set path=,,
4801< - A directory name may end in a ':' or '/'.
4802 - Environment variables are expanded |:set_env|.
4803 - When using |netrw.vim| URLs can be used. For example, adding
4804 "http://www.vim.org" will make ":find index.html" work.
4805 - Search upwards and downwards in a directory tree:
4806 1) "*" matches a sequence of characters, e.g.: >
4807 :set path=/usr/include/*
4808< means all subdirectories in /usr/include (but not /usr/include
4809 itself). >
4810 :set path=/usr/*c
4811< matches /usr/doc and /usr/src.
4812 2) "**" matches a subtree, up to 100 directories deep. Example: >
4813 :set path=/home/user_x/src/**
4814< means search in the whole subtree under "/home/usr_x/src".
4815 3) If the path ends with a ';', this path is the startpoint
4816 for upward search.
4817 See |file-searching| for more info and exact syntax.
4818 {not available when compiled without the |+path_extra| feature}
4819 - Careful with '\' characters, type two to get one in the option: >
4820 :set path=.,c:\\include
4821< Or just use '/' instead: >
4822 :set path=.,c:/include
4823< Don't forget "." or files won't even be found in the same directory as
4824 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004825 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00004826 it is something like 256 or 1024 characters.
4827 You can check if all the include files are found, using the value of
4828 'path', see |:checkpath|.
4829 The use of |:set+=| and |:set-=| is preferred when adding or removing
4830 directories from the list. This avoids problems when a future version
4831 uses another default. To remove the current directory use: >
4832 :set path-=
4833< To add the current directory use: >
4834 :set path+=
4835< To use an environment variable, you probably need to replace the
4836 separator. Here is an example to append $INCL, in which directory
4837 names are separated with a semi-colon: >
4838 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
4839< Replace the ';' with a ':' or whatever separator is used. Note that
4840 this doesn't work when $INCL contains a comma or white space.
4841
4842 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
4843'preserveindent' 'pi' boolean (default off)
4844 local to buffer
4845 {not in Vi}
4846 When changing the indent of the current line, preserve as much of the
4847 indent structure as possible. Normally the indent is replaced by a
4848 series of tabs followed by spaces as required (unless |'expandtab'| is
4849 enabled, in which case only spaces are used). Enabling this option
4850 means the indent will preserve as many existing characters as possible
4851 for indenting, and only add additional tabs or spaces as required.
4852 NOTE: When using ">>" multiple times the resulting indent is a mix of
4853 tabs and spaces. You might not like this.
4854 NOTE: 'preserveindent' is reset when 'compatible' is set.
4855 Also see 'copyindent'.
4856 Use |:retab| to clean up white space.
4857
4858 *'previewheight'* *'pvh'*
4859'previewheight' 'pvh' number (default 12)
4860 global
4861 {not in Vi}
4862 {not available when compiled without the |+windows| or
4863 |+quickfix| feature}
4864 Default height for a preview window. Used for |:ptag| and associated
4865 commands. Used for |CTRL-W_}| when no count is given.
4866
4867 *'previewwindow'* *'nopreviewwindow'*
4868 *'pvw'* *'nopvw'* *E590*
4869'previewwindow' 'pvw' boolean (default off)
4870 local to window
4871 {not in Vi}
4872 {not available when compiled without the |+windows| or
4873 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004874 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00004875 set. It's normally not set directly, but by using one of the commands
4876 |:ptag|, |:pedit|, etc.
4877
4878 *'printdevice'* *'pdev'*
4879'printdevice' 'pdev' string (default empty)
4880 global
4881 {not in Vi}
4882 {only available when compiled with the |+printer|
4883 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004884 The name of the printer to be used for |:hardcopy|.
4885 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004886 This option cannot be set from a |modeline| or in the |sandbox|, for
4887 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004888
Bram Moolenaar8299df92004-07-10 09:47:34 +00004889 *'printencoding'* *'penc'*
4890'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004891 global
4892 {not in Vi}
4893 {only available when compiled with the |+printer|
4894 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004895 Sets the character encoding used when printing.
4896 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004897
4898 *'printexpr'* *'pexpr'*
4899'printexpr' 'pexpr' String (default: see below)
4900 global
4901 {not in Vi}
4902 {only available when compiled with the |+printer|
4903 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004904 Expression used to print the PostScript produced with |:hardcopy|.
4905 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004906
Bram Moolenaar8299df92004-07-10 09:47:34 +00004907 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004908'printfont' 'pfn' string (default "courier")
4909 global
4910 {not in Vi}
4911 {only available when compiled with the |+printer|
4912 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004913 The name of the font that will be used for |:hardcopy|.
4914 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004915
4916 *'printheader'* *'pheader'*
4917'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
4918 global
4919 {not in Vi}
4920 {only available when compiled with the |+printer|
4921 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004922 The format of the header produced in |:hardcopy| output.
4923 See |pheader-option|.
4924
4925 *'printmbcharset'* *'pmbcs'*
4926'printmbcharset' 'pmbcs' string (default "")
4927 global
4928 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004929 {only available when compiled with the |+printer|,
4930 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004931 The CJK character set to be used for CJK output from |:hardcopy|.
4932 See |pmbcs-option|.
4933
4934 *'printmbfont'* *'pmbfn'*
4935'printmbfont' 'pmbfn' string (default "")
4936 global
4937 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004938 {only available when compiled with the |+printer|,
4939 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004940 List of font names to be used for CJK output from |:hardcopy|.
4941 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004942
4943 *'printoptions'* *'popt'*
4944'printoptions' 'popt' string (default "")
4945 global
4946 {not in Vi}
4947 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004948 List of items that control the format of the output of |:hardcopy|.
4949 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004950
Bram Moolenaar26a60b42005-02-22 08:49:11 +00004951 *'prompt'* *'noprompt'*
4952'prompt' boolean (default on)
4953 global
4954 When on a ":" prompt is used in Ex mode.
4955
Bram Moolenaar677ee682005-01-27 14:41:15 +00004956 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004957'quoteescape' 'qe' string (default "\")
4958 local to buffer
4959 {not in Vi}
4960 The characters that are used to escape quotes in a string. Used for
4961 objects like a', a" and a` |a'|.
4962 When one of the characters in this option is found inside a string,
4963 the following character will be skipped. The default value makes the
4964 text "foo\"bar\\" considered to be one string.
4965
Bram Moolenaar071d4272004-06-13 20:20:40 +00004966 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
4967'readonly' 'ro' boolean (default off)
4968 local to buffer
4969 If on, writes fail unless you use a '!'. Protects you from
4970 accidentally overwriting a file. Default on when Vim is started
4971 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004972 When using ":w!" the 'readonly' option is reset for the current
4973 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004974 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004975 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004976
4977 *'remap'* *'noremap'*
4978'remap' boolean (default on)
4979 global
4980 Allows for mappings to work recursively. If you do not want this for
4981 a single entry, use the :noremap[!] command.
4982
4983 *'report'*
4984'report' number (default 2)
4985 global
4986 Threshold for reporting number of lines changed. When the number of
4987 changed lines is more than 'report' a message will be given for most
4988 ":" commands. If you want it always, set 'report' to 0.
4989 For the ":substitute" command the number of substitutions is used
4990 instead of the number of lines.
4991
4992 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
4993'restorescreen' 'rs' boolean (default on)
4994 global
4995 {not in Vi} {only in Windows 95/NT console version}
4996 When set, the screen contents is restored when exiting Vim. This also
4997 happens when executing external commands.
4998
4999 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5000 options in your .vimrc. To disable restoring:
5001 set t_ti= t_te=
5002 To enable restoring (for an xterm):
5003 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5004 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5005
5006 *'revins'* *'ri'* *'norevins'* *'nori'*
5007'revins' 'ri' boolean (default off)
5008 global
5009 {not in Vi}
5010 {only available when compiled with the |+rightleft|
5011 feature}
5012 Inserting characters in Insert mode will work backwards. See "typing
5013 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5014 command in Insert mode, when 'allowrevins' is set.
5015 NOTE: This option is reset when 'compatible' or 'paste' is set.
5016
5017 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5018'rightleft' 'rl' boolean (default off)
5019 local to window
5020 {not in Vi}
5021 {only available when compiled with the |+rightleft|
5022 feature}
5023 When on, display orientation becomes right-to-left, i.e., characters
5024 that are stored in the file appear from the right to the left.
5025 Using this option, it is possible to edit files for languages that
5026 are written from the right to the left such as Hebrew and Arabic.
5027 This option is per window, so it is possible to edit mixed files
5028 simultaneously, or to view the same file in both ways (this is
5029 useful whenever you have a mixed text file with both right-to-left
5030 and left-to-right strings so that both sets are displayed properly
5031 in different windows). Also see |rileft.txt|.
5032
5033 *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'*
5034'rightleftcmd' 'rlc' string (default "search")
5035 local to window
5036 {not in Vi}
5037 {only available when compiled with the |+rightleft|
5038 feature}
5039 Each word in this option enables the command line editing to work in
5040 right-to-left mode for a group of commands:
5041
5042 search "/" and "?" commands
5043
5044 This is useful for languages such as Hebrew, Arabic and Farsi.
5045 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5046
5047 *'ruler'* *'ru'* *'noruler'* *'noru'*
5048'ruler' 'ru' boolean (default off)
5049 global
5050 {not in Vi}
5051 {not available when compiled without the
5052 |+cmdline_info| feature}
5053 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005054 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005055 text in the file is shown on the far right:
5056 Top first line is visible
5057 Bot last line is visible
5058 All first and last line are visible
5059 45% relative position in the file
5060 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005061 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005062 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005063 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005064 this option takes precedence over 'ruler' and 'rulerformat'
5065 If the number of characters displayed is different from the number of
5066 bytes in the text (e.g., for a TAB or a multi-byte character), both
5067 the text column (byte number) and the screen column are shown,
5068 separated with a dash.
5069 For an empty line "0-1" is shown.
5070 For an empty buffer the line number will also be zero: "0,0-1".
5071 This option is reset when the 'paste' option is set.
5072 If you don't want to see the ruler all the time but want to know where
5073 you are, use "g CTRL-G" |g_CTRL-G|.
5074 NOTE: This option is reset when 'compatible' is set.
5075
5076 *'rulerformat'* *'ruf'*
5077'rulerformat' 'ruf' string (default empty)
5078 global
5079 {not in Vi}
5080 {not available when compiled without the |+statusline|
5081 feature}
5082 When this option is not empty, it determines the content of the ruler
5083 string, as displayed for the 'ruler' option.
5084 The format of this option, is like that of 'statusline'.
5085 The default ruler width is 17 characters. To make the ruler 15
5086 characters wide, put "%15(" at the start and "%)" at the end.
5087 Example: >
5088 :set rulerformat=%15(%c%V\ %p%%%)
5089<
5090 *'runtimepath'* *'rtp'* *vimfiles*
5091'runtimepath' 'rtp' string (default:
5092 Unix: "$HOME/.vim,
5093 $VIM/vimfiles,
5094 $VIMRUNTIME,
5095 $VIM/vimfiles/after,
5096 $HOME/.vim/after"
5097 Amiga: "home:vimfiles,
5098 $VIM/vimfiles,
5099 $VIMRUNTIME,
5100 $VIM/vimfiles/after,
5101 home:vimfiles/after"
5102 PC, OS/2: "$HOME/vimfiles,
5103 $VIM/vimfiles,
5104 $VIMRUNTIME,
5105 $VIM/vimfiles/after,
5106 $HOME/vimfiles/after"
5107 Macintosh: "$VIM:vimfiles,
5108 $VIMRUNTIME,
5109 $VIM:vimfiles:after"
5110 RISC-OS: "Choices:vimfiles,
5111 $VIMRUNTIME,
5112 Choices:vimfiles/after"
5113 VMS: "sys$login:vimfiles,
5114 $VIM/vimfiles,
5115 $VIMRUNTIME,
5116 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005117 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005118 global
5119 {not in Vi}
5120 This is a list of directories which will be searched for runtime
5121 files:
5122 filetype.vim filetypes by file name |new-filetype|
5123 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005124 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005125 colors/ color scheme files |:colorscheme|
5126 compiler/ compiler files |:compiler|
5127 doc/ documentation |write-local-help|
5128 ftplugin/ filetype plugins |write-filetype-plugin|
5129 indent/ indent scripts |indent-expression|
5130 keymap/ key mapping files |mbyte-keymap|
5131 lang/ menu translations |:menutrans|
5132 menu.vim GUI menus |menu.vim|
5133 plugin/ plugin scripts |write-plugin|
5134 print/ files for printing |postscript-print-encoding|
5135 syntax/ syntax files |mysyntaxfile|
5136 tutor/ files for vimtutor |tutor|
5137
5138 And any other file searched for with the |:runtime| command.
5139
5140 The defaults for most systems are setup to search five locations:
5141 1. In your home directory, for your personal preferences.
5142 2. In a system-wide Vim directory, for preferences from the system
5143 administrator.
5144 3. In $VIMRUNTIME, for files distributed with Vim.
5145 *after-directory*
5146 4. In the "after" directory in the system-wide Vim directory. This is
5147 for the system administrator to overrule or add to the distributed
5148 defaults (rarely needed)
5149 5. In the "after" directory in your home directory. This is for
5150 personal preferences to overrule or add to the distributed defaults
5151 or system-wide settings (rarely needed).
5152
5153 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5154 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005155 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005156 wildcards.
5157 See |:runtime|.
5158 Example: >
5159 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5160< This will use the directory "~/vimruntime" first (containing your
5161 personal Vim runtime files), then "/mygroup/vim" (shared between a
5162 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5163 files).
5164 You probably should always include $VIMRUNTIME somewhere, to use the
5165 distributed runtime files. You can put a directory before $VIMRUNTIME
5166 to find files which replace a distributed runtime files. You can put
5167 a directory after $VIMRUNTIME to find files which add to distributed
5168 runtime files.
5169 This option cannot be set from a |modeline| or in the |sandbox|, for
5170 security reasons.
5171
5172 *'scroll'* *'scr'*
5173'scroll' 'scr' number (default: half the window height)
5174 local to window
5175 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5176 set to half the number of lines in the window when the window size
5177 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005178 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005179 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5180 the number of screen lines instead of file lines, makes a difference
5181 when lines wrap}
5182
5183 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5184'scrollbind' 'scb' boolean (default off)
5185 local to window
5186 {not in Vi}
5187 {not available when compiled without the |+scrollbind|
5188 feature}
5189 See also |scroll-binding|. When this option is set, the current
5190 window scrolls as other scrollbind windows (windows that also have
5191 this option set) scroll. This option is useful for viewing the
5192 differences between two versions of a file, see 'diff'.
5193 See |'scrollopt'| for options that determine how this option should be
5194 interpreted.
5195 This option is mostly reset when splitting a window to edit another
5196 file. This means that ":split | edit file" results in two windows
5197 with scroll-binding, but ":split file" does not.
5198
5199 *'scrolljump'* *'sj'*
5200'scrolljump' 'sj' number (default 1)
5201 global
5202 {not in Vi}
5203 Minimal number of lines to scroll when the cursor gets off the
5204 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5205 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005206 When set to a negative number from -1 to -100 this is used as the
5207 percentage of the window height. Thus -50 scrolls half the window
5208 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005209 NOTE: This option is set to 1 when 'compatible' is set.
5210
5211 *'scrolloff'* *'so'*
5212'scrolloff' 'so' number (default 0)
5213 global
5214 {not in Vi}
5215 Minimal number of screen lines to keep above and below the cursor.
5216 This will make some context visible around where you are working. If
5217 you set it to a very large value (999) the cursor line will always be
5218 in the middle of the window (except at the start or end of the file or
5219 when long lines wrap).
5220 For scrolling horizontally see 'sidescrolloff'.
5221 NOTE: This option is set to 0 when 'compatible' is set.
5222
5223 *'scrollopt'* *'sbo'*
5224'scrollopt' 'sbo' string (default "ver,jump")
5225 global
5226 {not available when compiled without the |+scrollbind|
5227 feature}
5228 {not in Vi}
5229 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005230 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5231 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005232 The following words are available:
5233 ver Bind vertical scrolling for 'scrollbind' windows
5234 hor Bind horizontal scrolling for 'scrollbind' windows
5235 jump Applies to the offset between two windows for vertical
5236 scrolling. This offset is the difference in the first
5237 displayed line of the bound windows. When moving
5238 around in a window, another 'scrollbind' window may
5239 reach a position before the start or after the end of
5240 the buffer. The offset is not changed though, when
5241 moving back the 'scrollbind' window will try to scroll
5242 to the desired position when possible.
5243 When now making that window the current one, two
5244 things can be done with the relative offset:
5245 1. When "jump" is not included, the relative offset is
5246 adjusted for the scroll position in the new current
5247 window. When going back to the other window, the
5248 the new relative offset will be used.
5249 2. When "jump" is included, the other windows are
5250 scrolled to keep the same relative offset. When
5251 going back to the other window, it still uses the
5252 same relative offset.
5253 Also see |scroll-binding|.
5254
5255 *'sections'* *'sect'*
5256'sections' 'sect' string (default "SHNHH HUnhsh")
5257 global
5258 Specifies the nroff macros that separate sections. These are pairs of
5259 two letters (See |object-motions|). The default makes a section start
5260 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5261
5262 *'secure'* *'nosecure'* *E523*
5263'secure' boolean (default off)
5264 global
5265 {not in Vi}
5266 When on, ":autocmd", shell and write commands are not allowed in
5267 ".vimrc" and ".exrc" in the current directory and map commands are
5268 displayed. Switch it off only if you know that you will not run into
5269 problems, or when the 'exrc' option is off. On Unix this option is
5270 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005271 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005272 'secure' at the end of your ~/.vimrc then.
5273 This option cannot be set from a |modeline| or in the |sandbox|, for
5274 security reasons.
5275
5276 *'selection'* *'sel'*
5277'selection' 'sel' string (default "inclusive")
5278 global
5279 {not in Vi}
5280 This option defines the behavior of the selection. It is only used
5281 in Visual and Select mode.
5282 Possible values:
5283 value past line inclusive ~
5284 old no yes
5285 inclusive yes yes
5286 exclusive yes no
5287 "past line" means that the cursor is allowed to be positioned one
5288 character past the line.
5289 "inclusive" means that the last character of the selection is included
5290 in an operation. For example, when "x" is used to delete the
5291 selection.
5292 Note that when "exclusive" is used and selecting from the end
5293 backwards, you cannot include the last character of a line, when
5294 starting in Normal mode and 'virtualedit' empty.
5295
5296 The 'selection' option is set by the |:behave| command.
5297
5298 *'selectmode'* *'slm'*
5299'selectmode' 'slm' string (default "")
5300 global
5301 {not in Vi}
5302 This is a comma separated list of words, which specifies when to start
5303 Select mode instead of Visual mode, when a selection is started.
5304 Possible values:
5305 mouse when using the mouse
5306 key when using shifted special keys
5307 cmd when using "v", "V" or CTRL-V
5308 See |Select-mode|.
5309 The 'selectmode' option is set by the |:behave| command.
5310
5311 *'sessionoptions'* *'ssop'*
5312'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
5313 help,options,winsize")
5314 global
5315 {not in Vi}
5316 {not available when compiled without the +mksession
5317 feature}
5318 Changes the effect of the |:mksession| command. It is a comma
5319 separated list of words. Each word enables saving and restoring
5320 something:
5321 word save and restore ~
5322 blank empty windows
5323 buffers hidden and unloaded buffers, not just those in windows
5324 curdir the current directory
5325 folds manually created folds, opened/closed folds and local
5326 fold options
5327 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005328 and contain at least one lowercase letter. Only
5329 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005330 help the help window
5331 localoptions options and mappings local to a window or buffer (not
5332 global values for local options)
5333 options all options and mappings (also global values for local
5334 options)
5335 resize size of the Vim window: 'lines' and 'columns'
5336 sesdir the directory in which the session file is located
5337 will become the current directory (useful with
5338 projects accessed over a network from different
5339 systems)
5340 slash backslashes in file names replaced with forward
5341 slashes
5342 unix with Unix end-of-line format (single <NL>), even when
5343 on Windows or DOS
5344 winpos position of the whole Vim window
5345 winsize window sizes
5346
5347 Don't include both "curdir" and "sesdir".
5348 When "curdir" nor "sesdir" is included, file names are stored with
5349 absolute paths.
5350 "slash" and "unix" are useful on Windows when sharing session files
5351 with Unix. The Unix version of Vim cannot source dos format scripts,
5352 but the Windows version of Vim can source unix format scripts.
5353
5354 *'shell'* *'sh'* *E91*
5355'shell' 'sh' string (default $SHELL or "sh",
5356 MS-DOS and Win32: "command.com" or
5357 "cmd.exe", OS/2: "cmd")
5358 global
5359 Name of the shell to use for ! and :! commands. When changing the
5360 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5361 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005362 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005363 See |option-backslash| about including spaces and backslashes.
5364 Environment variables are expanded |:set_env|.
5365 If the name of the shell contains a space, you might need to enclose
5366 it in quotes. Example: >
5367 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5368< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005369 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005370 "-f" is not inside the quotes, because it is not part of the command
5371 name. And Vim automagically recognizes the backslashes that are path
5372 separators.
5373 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5374 variable to change the way external commands are executed. See the
5375 libc.inf file of DJGPP.
5376 Under MS-Windows, when the executable ends in ".com" it must be
5377 included. Thus setting the shell to "command.com" or "4dos.com"
5378 works, but "command" and "4dos" do not work for all commands (e.g.,
5379 filtering).
5380 For unknown reasons, when using "4dos.com" the current directory is
5381 changed to "C:\". To avoid this set 'shell' like this: >
5382 :set shell=command.com\ /c\ 4dos
5383< This option cannot be set from a |modeline| or in the |sandbox|, for
5384 security reasons.
5385
5386 *'shellcmdflag'* *'shcf'*
5387'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5388 does not contain "sh" somewhere: "/c")
5389 global
5390 {not in Vi}
5391 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5392 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5393 systems, the default is set according to the value of 'shell', to
5394 reduce the need to set this option by the user. It's not used for
5395 OS/2 (EMX figures this out itself). See |option-backslash| about
5396 including spaces and backslashes. See |dos-shell|.
5397 This option cannot be set from a |modeline| or in the |sandbox|, for
5398 security reasons.
5399
5400 *'shellpipe'* *'sp'*
5401'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5402 global
5403 {not in Vi}
5404 {not available when compiled without the |+quickfix|
5405 feature}
5406 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005407 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005408 including spaces and backslashes.
5409 The name of the temporary file can be represented by "%s" if necessary
5410 (the file name is appended automatically if no %s appears in the value
5411 of this option).
5412 For the Amiga and MS-DOS the default is ">". The output is directly
5413 saved in a file and not echoed to the screen.
5414 For Unix the default it "| tee". The stdout of the compiler is saved
5415 in a file and echoed to the screen. If the 'shell' option is "csh" or
5416 "tcsh" after initializations, the default becomes "|& tee". If the
5417 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
5418 "2>&1| tee". This means that stderr is also included.
5419 The initialization of this option is done after reading the ".vimrc"
5420 and the other initializations, so that when the 'shell' option is set
5421 there, the 'shellpipe' option changes automatically, unless it was
5422 explicitly set before.
5423 When 'shellpipe' is set to an empty string, no redirection of the
5424 ":make" output will be done. This is useful if you use a 'makeprg'
5425 that writes to 'makeef' by itself. If you want no piping, but do
5426 want to include the 'makeef', set 'shellpipe' to a single space.
5427 Don't forget to precede the space with a backslash: ":set sp=\ ".
5428 In the future pipes may be used for filtering and this option will
5429 become obsolete (at least for Unix).
5430 This option cannot be set from a |modeline| or in the |sandbox|, for
5431 security reasons.
5432
5433 *'shellquote'* *'shq'*
5434'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5435 contains "sh" somewhere: "\"")
5436 global
5437 {not in Vi}
5438 Quoting character(s), put around the command passed to the shell, for
5439 the "!" and ":!" commands. The redirection is kept outside of the
5440 quoting. See 'shellxquote' to include the redirection. It's
5441 probably not useful to set both options.
5442 This is an empty string by default. Only known to be useful for
5443 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5444 or bash, where it should be "\"". The default is adjusted according
5445 the value of 'shell', to reduce the need to set this option by the
5446 user. See |dos-shell|.
5447 This option cannot be set from a |modeline| or in the |sandbox|, for
5448 security reasons.
5449
5450 *'shellredir'* *'srr'*
5451'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5452 global
5453 {not in Vi}
5454 String to be used to put the output of a filter command in a temporary
5455 file. See also |:!|. See |option-backslash| about including spaces
5456 and backslashes.
5457 The name of the temporary file can be represented by "%s" if necessary
5458 (the file name is appended automatically if no %s appears in the value
5459 of this option).
5460 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5461 or "zsh" during initializations, the default becomes ">&". If the
5462 'shell' option is "sh", "ksh" or "bash" the default becomes
5463 ">%s 2>&1". This means that stderr is also included.
5464 For Win32, the Unix checks are done and additionally "cmd" is checked
5465 for, which makes the default ">%s 2>&1". Also, the same names with
5466 ".exe" appended are checked for.
5467 The initialization of this option is done after reading the ".vimrc"
5468 and the other initializations, so that when the 'shell' option is set
5469 there, the 'shellredir' option changes automatically unless it was
5470 explicitly set before.
5471 In the future pipes may be used for filtering and this option will
5472 become obsolete (at least for Unix).
5473 This option cannot be set from a |modeline| or in the |sandbox|, for
5474 security reasons.
5475
5476 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5477'shellslash' 'ssl' boolean (default off)
5478 global
5479 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5480 When set, a forward slash is used when expanding file names. This is
5481 useful when a Unix-like shell is used instead of command.com or
5482 cmd.exe. Backward slashes can still be typed, but they are changed to
5483 forward slashes by Vim.
5484 Note that setting or resetting this option has no effect for some
5485 existing file names, thus this option needs to be set before opening
5486 any file for best results. This might change in the future.
5487 'shellslash' only works when a backslash can be used as a path
5488 separator. To test if this is so use: >
5489 if exists('+shellslash')
5490<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005491 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5492'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5493 global
5494 {not in Vi}
5495 When on, use temp files for shell commands. When off use a pipe.
5496 When using a pipe is not possible temp files are used anyway.
5497 Currently a pipe is only supported on Unix. You can check it with: >
5498 :if has("filterpipe")
5499< The advantage of using a pipe is that nobody can read the temp file
5500 and the 'shell' command does not need to support redirection.
5501 The advantage of using a temp file is that the file type and encoding
5502 can be detected.
5503 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5504 |FilterWritePost| autocommands event are not triggered when
5505 'shelltemp' is off.
5506
Bram Moolenaar071d4272004-06-13 20:20:40 +00005507 *'shelltype'* *'st'*
5508'shelltype' 'st' number (default 0)
5509 global
5510 {not in Vi} {only for the Amiga}
5511 On the Amiga this option influences the way how the commands work
5512 which use a shell.
5513 0 and 1: always use the shell
5514 2 and 3: use the shell only to filter lines
5515 4 and 5: use shell only for ':sh' command
5516 When not using the shell, the command is executed directly.
5517
5518 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5519 1 and 3: use "shell cmd" to start external commands
5520
5521 *'shellxquote'* *'sxq'*
5522'shellxquote' 'sxq' string (default: "";
5523 for Win32, when 'shell' contains "sh"
5524 somewhere: "\""
5525 for Unix, when using system(): "\"")
5526 global
5527 {not in Vi}
5528 Quoting character(s), put around the command passed to the shell, for
5529 the "!" and ":!" commands. Includes the redirection. See
5530 'shellquote' to exclude the redirection. It's probably not useful
5531 to set both options.
5532 This is an empty string by default. Known to be useful for
5533 third-party shells when using the Win32 version, such as the MKS Korn
5534 Shell or bash, where it should be "\"". The default is adjusted
5535 according the value of 'shell', to reduce the need to set this option
5536 by the user. See |dos-shell|.
5537 This option cannot be set from a |modeline| or in the |sandbox|, for
5538 security reasons.
5539
5540 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5541'shiftround' 'sr' boolean (default off)
5542 global
5543 {not in Vi}
5544 Round indent to multiple of 'shiftwidth'. Applies to > and <
5545 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5546 a multiple of 'shiftwidth' (this is Vi compatible).
5547 NOTE: This option is reset when 'compatible' is set.
5548
5549 *'shiftwidth'* *'sw'*
5550'shiftwidth' 'sw' number (default 8)
5551 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005552 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005553 |'cindent'|, |>>|, |<<|, etc.
5554
5555 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005556'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
5557 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005558 global
5559 {not in Vi}
5560 This option helps to avoid all the |hit-enter| prompts caused by file
5561 messages, for example with CTRL-G, and to avoid some other messages.
5562 It is a list of flags:
5563 flag meaning when present ~
5564 f use "(3 of 5)" instead of "(file 3 of 5)"
5565 i use "[noeol]" instead of "[Incomplete last line]"
5566 l use "999L, 888C" instead of "999 lines, 888 characters"
5567 m use "[+]" instead of "[Modified]"
5568 n use "[New]" instead of "[New File]"
5569 r use "[RO]" instead of "[readonly]"
5570 w use "[w]" instead of "written" for file write message
5571 and "[a]" instead of "appended" for ':w >> file' command
5572 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5573 "[unix format]" and "[mac]" instead of "[mac format]".
5574 a all of the above abbreviations
5575
5576 o overwrite message for writing a file with subsequent message
5577 for reading a file (useful for ":wn" or when 'autowrite' on)
5578 O message for reading a file overwrites any previous message.
5579 Also for quickfix message (e.g., ":cn").
5580 s don't give "search hit BOTTOM, continuing at TOP" or "search
5581 hit TOP, continuing at BOTTOM" messages
5582 t truncate file message at the start if it is too long to fit
5583 on the command-line, "<" will appear in the left most column.
5584 Ignored in Ex mode.
5585 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00005586 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005587 Ignored in Ex mode.
5588 W don't give "written" or "[w]" when writing a file
5589 A don't give the "ATTENTION" message when an existing swap file
5590 is found.
5591 I don't give the intro message when starting Vim |:intro|.
5592
5593 This gives you the opportunity to avoid that a change between buffers
5594 requires you to hit <Enter>, but still gives as useful a message as
5595 possible for the space available. To get the whole message that you
5596 would have got with 'shm' empty, use ":file!"
5597 Useful values:
5598 shm= No abbreviation of message.
5599 shm=a Abbreviation, but no loss of information.
5600 shm=at Abbreviation, and truncate message when necessary.
5601
5602 NOTE: This option is set to the Vi default value when 'compatible' is
5603 set and to the Vim default value when 'compatible' is reset.
5604
5605 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
5606'shortname' 'sn' boolean (default off)
5607 local to buffer
5608 {not in Vi, not in MS-DOS versions}
5609 Filenames are assumed to be 8 characters plus one extension of 3
5610 characters. Multiple dots in file names are not allowed. When this
5611 option is on, dots in file names are replaced with underscores when
5612 adding an extension (".~" or ".swp"). This option is not available
5613 for MS-DOS, because then it would always be on. This option is useful
5614 when editing files on an MS-DOS compatible filesystem, e.g., messydos
5615 or crossdos. When running the Win32 GUI version under Win32s, this
5616 option is always on by default.
5617
5618 *'showbreak'* *'sbr'* *E595*
5619'showbreak' 'sbr' string (default "")
5620 global
5621 {not in Vi}
5622 {not available when compiled without the |+linebreak|
5623 feature}
5624 String to put at the start of lines that have been wrapped. Useful
5625 values are "> " or "+++ ".
5626 Only printable single-cell characters are allowed, excluding <Tab> and
5627 comma (in a future version the comma might be used to separate the
5628 part that is shown at the end and at the start of a line).
5629 The characters are highlighted according to the '@' flag in
5630 'highlight'.
5631 Note that tabs after the showbreak will be displayed differently.
5632 If you want the 'showbreak' to appear in between line numbers, add the
5633 "n" flag to 'cpoptions'.
5634
5635 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
5636'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
5637 off)
5638 global
5639 {not in Vi}
5640 {not available when compiled without the
5641 |+cmdline_info| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005642 Show (partial) command in status line. Set this option off if your
Bram Moolenaar071d4272004-06-13 20:20:40 +00005643 terminal is slow.
5644 In Visual mode the size of the selected area is shown:
5645 - When selecting characters within a line, the number of characters.
5646 - When selecting more than one line, the number of lines.
5647 - When selecting a block, the size in screen characters: linesxcolumns.
5648 NOTE: This option is set to the Vi default value when 'compatible' is
5649 set and to the Vim default value when 'compatible' is reset.
5650
5651 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
5652'showfulltag' 'sft' boolean (default off)
5653 global
5654 {not in Vi}
5655 When completing a word in insert mode (see |ins-completion|) from the
5656 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005657 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00005658 matched a C function, you can see a template for what arguments are
5659 required (coding style permitting).
5660
5661 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
5662'showmatch' 'sm' boolean (default off)
5663 global
5664 When a bracket is inserted, briefly jump to the matching one. The
5665 jump is only done if the match can be seen on the screen. The time to
5666 show the match can be set with 'matchtime'.
5667 A Beep is given if there is no match (no matter if the match can be
5668 seen or not). This option is reset when the 'paste' option is set.
5669 When the 'm' flag is not included in 'cpoptions', typing a character
5670 will immediately move the cursor back to where it belongs.
5671 See the "sm" field in 'guicursor' for setting the cursor shape and
5672 blinking when showing the match.
5673 The 'matchpairs' option can be used to specify the characters to show
5674 matches for. 'rightleft' and 'revins' are used to look for opposite
5675 matches.
5676 Note: For the use of the short form parental guidance is advised.
5677
5678 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
5679'showmode' 'smd' boolean (Vim default: on, Vi default: off)
5680 global
5681 If in Insert, Replace or Visual mode put a message on the last line.
5682 Use the 'M' flag in 'highlight' to set the type of highlighting for
5683 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005684 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005685 doesn't mean XIM is really active, especially when 'imactivatekey' is
5686 not set.
5687 NOTE: This option is set to the Vi default value when 'compatible' is
5688 set and to the Vim default value when 'compatible' is reset.
5689
5690 *'sidescroll'* *'ss'*
5691'sidescroll' 'ss' number (default 0)
5692 global
5693 {not in Vi}
5694 The minimal number of columns to scroll horizontally. Used only when
5695 the 'wrap' option is off and the cursor is moved off of the screen.
5696 When it is zero the cursor will be put in the middle of the screen.
5697 When using a slow terminal set it to a large number or 0. When using
5698 a fast terminal use a small number or 1. Not used for "zh" and "zl"
5699 commands.
5700
5701 *'sidescrolloff'* *'siso'*
5702'sidescrolloff' 'siso' number (default 0)
5703 global
5704 {not in Vi}
5705 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00005706 right of the cursor if 'nowrap' is set. Setting this option to a
5707 value greater than 0 while having |'sidescroll'| also at a non-zero
5708 value makes some context visible in the line you are scrolling in
5709 horizontally (except at beginning of the line). Setting this option
5710 to a large value (like 999) has the effect of keeping the cursor
5711 horizontally centered in the window, as long as one does not come too
5712 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005713 NOTE: This option is set to 0 when 'compatible' is set.
5714
5715 Example: Try this together with 'sidescroll' and 'listchars' as
5716 in the following example to never allow the cursor to move
5717 onto the "extends" character:
5718
5719 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
5720 :set sidescrolloff=1
5721
5722
5723 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
5724'smartcase' 'scs' boolean (default off)
5725 global
5726 {not in Vi}
5727 Override the 'ignorecase' option if the search pattern contains upper
5728 case characters. Only used when the search pattern is typed and
5729 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005730 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00005731 "*" and "#" you can make 'smartcase' used by doing a "/" command,
5732 recalling the search pattern from history and hitting <Enter>.
5733 NOTE: This option is reset when 'compatible' is set.
5734
5735 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
5736'smartindent' 'si' boolean (default off)
5737 local to buffer
5738 {not in Vi}
5739 {not available when compiled without the
5740 |+smartindent| feature}
5741 Do smart autoindenting when starting a new line. Works for C-like
5742 programs, but can also be used for other languages. 'cindent' does
5743 something like this, works better in most cases, but is more strict,
5744 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
5745 'indentexpr' is a more advanced alternative.
5746 Normally 'autoindent' should also be on when using 'smartindent'.
5747 An indent is automatically inserted:
5748 - After a line ending in '{'.
5749 - After a line starting with a keyword from 'cinwords'.
5750 - Before a line starting with '}' (only with the "O" command).
5751 When typing '}' as the first character in a new line, that line is
5752 given the same indent as the matching '{'.
5753 When typing '#' as the first character in a new line, the indent for
5754 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005755 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005756 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
5757 When using the ">>" command, lines starting with '#' are not shifted
5758 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005759 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005760 is set smart indenting is disabled.
5761
5762 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
5763'smarttab' 'sta' boolean (default off)
5764 global
5765 {not in Vi}
5766 When on, a <Tab> in front of a line inserts blanks according to
5767 'shiftwidth'. 'tabstop' is used in other places. A <BS> will delete
5768 a 'shiftwidth' worth of space at the start of the line.
5769 When off a <Tab> always inserts blanks according to 'tabstop'.
5770 'shiftwidth' is only used for shifting text left or right
5771 |shift-left-right|.
5772 What gets inserted (a Tab or spaces) depends on the 'expandtab'
5773 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00005774 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005775 NOTE: This option is reset when 'compatible' is set.
5776
5777 *'softtabstop'* *'sts'*
5778'softtabstop' 'sts' number (default 0)
5779 local to buffer
5780 {not in Vi}
5781 Number of spaces that a <Tab> counts for while performing editing
5782 operations, like inserting a <Tab> or using <BS>. It "feels" like
5783 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
5784 used. This is useful to keep the 'ts' setting at its standard value
5785 of 8, while being able to edit like it is set to 'sts'. However,
5786 commands like "x" still work on the actual characters.
5787 When 'sts' is zero, this feature is off.
5788 'softtabstop' is set to 0 when the 'paste' option is set.
5789 See also |ins-expandtab|. When 'expandtab' is not set, the number of
5790 spaces is minimized by using <Tab>s.
5791 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
5792 set.
5793 NOTE: This option is set to 0 when 'compatible' is set.
5794
Bram Moolenaar217ad922005-03-20 22:37:15 +00005795 *'spell'* *'nospell'*
5796'spell' boolean (default off)
5797 local to window
5798 {not in Vi}
5799 {not available when compiled without the |+syntax|
5800 feature}
5801 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005802 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005803
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005804 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005805'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005806 local to buffer
5807 {not in Vi}
5808 {not available when compiled without the |+syntax|
5809 feature}
5810 Pattern to locate the end of a sentence. The following word will be
5811 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005812 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005813 When this check is not wanted make this option empty.
5814 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005815 Be careful with special characters, see |option-backslash| about
5816 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005817 To set this option automatically depending on the language, see
5818 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005819
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005820 *'spellfile'* *'spf'*
5821'spellfile' 'spf' string (default empty)
5822 local to buffer
5823 {not in Vi}
5824 {not available when compiled without the |+syntax|
5825 feature}
5826 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00005827 commands. It must end in ".{encoding}.add". You need to include the
5828 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005829 *E765*
5830 It may also be a comma separated list of names. A count before the
5831 |zg| and |zw| commands can be used to access each. This allows using
5832 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005833 When a word is added while this option is empty Vim will set it for
5834 you: Using the first "spell" directory in 'runtimepath' that is
Bram Moolenaar3b506942005-06-23 22:36:45 +00005835 writable and the first language name that appears in 'spelllang',
5836 ignoring the region.
5837 The resulting ".spl" file will be used for spell checking, it does not
5838 have to appear in 'spelllang'.
5839 Normally one file is used for all regions, but you can add the region
5840 name if you want to. However, it will then only be used when
5841 'spellfile' is set to it, for entries in 'spelllang' only files
5842 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00005843 This option cannot be set from a |modeline| or in the |sandbox|, for
5844 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005845
Bram Moolenaar217ad922005-03-20 22:37:15 +00005846 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005847'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00005848 local to buffer
5849 {not in Vi}
5850 {not available when compiled without the |+syntax|
5851 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00005852 A comma separated list of word list names. When the 'spell' option is
5853 on spellchecking will be done for these languages. Example: >
5854 set spelllang=en_us,nl,medical
5855< This means US English, Dutch and medical words are recognized. Words
5856 that are not recognized will be highlighted.
5857 The word list name must not include a comma or dot. Using a dash is
5858 recommended to separate the two letter language name from a
5859 specification. Thus "en-rare" is used for rare English words.
5860 A region name must come last and have the form "_xx", where "xx" is
5861 the two-letter, lower case region name. You can use more than one
5862 region by listing them: "en_us,en_ca" supports both US and Canadian
5863 English, but not words specific for Australia, New Zealand or Great
5864 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005865 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00005866 As a special case the name of a .spl file can be given as-is. The
5867 first "_xx" in the name is removed and used as the region name
5868 (_xx is an underscore, two letters and followed by a non-letter).
5869 This is mainly for testing purposes. You must make sure the correct
5870 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005871 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00005872 idea to set 'spelllang' after setting 'encoding' to avoid loading the
5873 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00005874 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005875
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005876 After this option has been set successfully, Vim will source the files
5877 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
5878 up to the first comma, dot or underscore. See |set-spc-auto|.
5879
5880
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005881 *'spellsuggest'* *'sps'*
5882'spellsuggest' 'sps' string (default "best")
5883 global
5884 {not in Vi}
5885 {not available when compiled without the |+syntax|
5886 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005887 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005888 the |spellsuggest()| function. This is a comma-separated list of
5889 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005890
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005891 best Internal method that works best for English. Finds
5892 changes like "fast" and uses a bit of sound-a-like
5893 scoring to improve the ordering.
5894
5895 double Internal method that uses two methods and mixes the
5896 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005897 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005898 word. That only works when the language specifies
5899 sound folding. Can be slow and doesn't always give
5900 better results.
5901
5902 fast Internal method that only checks for simple changes:
5903 character inserts/deletes/swaps. Works well for
5904 simple typing mistakes.
5905
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005906 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005907 Not used for |spellsuggest()|. The number of
5908 suggestions is never more than the value of 'lines'
5909 minus two.
5910
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005911 file:{filename} Read file {filename}, which must have two columns,
5912 separated by a slash. The first column contains the
5913 bad word, the second column the suggested good word.
5914 Example:
5915 theribal/terrible ~
5916 Use this for common mistakes that do not appear at the
5917 top of the suggestion list with the internal methods.
5918 Lines without a slash are ignored, use this for
5919 comments.
5920 The file is used for all languages.
5921
5922 expr:{expr} Evaluate expression {expr}. Use a function to avoid
5923 trouble with spaces. |v:val| holds the badly spelled
5924 word. The expression must evaluate to a List of
5925 Lists, each with a suggestion and a score.
5926 Example:
5927 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005928 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005929 internal methods use. A lower score is better.
5930 This may invoke |spellsuggest()| if you temporarily
5931 set 'spellsuggest' to exclude the "expr:" part.
5932 Errors are silently ignored, unless you set the
5933 'verbose' option to a non-zero value.
5934
5935 Only one of "best", "double" or "fast" may be used. The others may
5936 appear several times in any order. Example: >
5937 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
5938<
5939 This option cannot be set from a |modeline| or in the |sandbox|, for
5940 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005941
5942
Bram Moolenaar071d4272004-06-13 20:20:40 +00005943 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
5944'splitbelow' 'sb' boolean (default off)
5945 global
5946 {not in Vi}
5947 {not available when compiled without the +windows
5948 feature}
5949 When on, splitting a window will put the new window below the current
5950 one. |:split|
5951
5952 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
5953'splitright' 'spr' boolean (default off)
5954 global
5955 {not in Vi}
5956 {not available when compiled without the +vertsplit
5957 feature}
5958 When on, splitting a window will put the new window right of the
5959 current one. |:vsplit|
5960
5961 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
5962'startofline' 'sol' boolean (default on)
5963 global
5964 {not in Vi}
5965 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00005966 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005967 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00005968 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005969 with a linewise operator, with "%" with a count and to buffer changing
5970 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
5971 only has a line number, e.g., ":25" or ":+".
5972 In case of buffer changing commands the cursor is placed at the column
5973 where it was the last time the buffer was edited.
5974 NOTE: This option is set when 'compatible' is set.
5975
5976 *'statusline'* *'stl'* *E540* *E541* *E542*
5977'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00005978 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005979 {not in Vi}
5980 {not available when compiled without the |+statusline|
5981 feature}
5982 When nonempty, this option determines the content of the status line.
5983 Also see |status-line|.
5984
5985 The option consists of printf style '%' items interspersed with
5986 normal text. Each status line item is of the form:
5987 %-0{minwid}.{maxwid}{item}
5988 All fields except the {item} is optional. A single percent sign can
5989 be given as "%%". Up to 80 items can be specified.
5990
5991 Note that the only effect of 'ruler' when this option is set (and
5992 'laststatus' is 2) is controlling the output of |CTRL-G|.
5993
5994 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00005995 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00005996 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00005997 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005998 minwid Minimum width of the item, padding as set by '-' & '0'.
5999 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006000 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006001 on the left for text items. Numeric items will be
6002 shifted down to maxwid-2 digits followed by '>'number
6003 where number is the amount of missing digits, much like
6004 an exponential notation.
6005 item A one letter code as described below.
6006
6007 Following is a description of the possible statusline items. The
6008 second character in "item" is the type:
6009 N for number
6010 S for string
6011 F for flags as described below
6012 - not applicable
6013
6014 item meaning ~
6015 f S Path to the file in the buffer, relative to current directory.
6016 F S Full path to the file in the buffer.
6017 t S File name (tail) of file in the buffer.
6018 m F Modified flag, text is " [+]"; " [-]" if 'modifiable' is off.
6019 M F Modified flag, text is ",+" or ",-".
6020 r F Readonly flag, text is " [RO]".
6021 R F Readonly flag, text is ",RO".
6022 h F Help buffer flag, text is " [help]".
6023 H F Help buffer flag, text is ",HLP".
6024 w F Preview window flag, text is " [Preview]".
6025 W F Preview window flag, text is ",PRV".
6026 y F Type of file in the buffer, e.g., " [vim]". See 'filetype'.
6027 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6028 {not available when compiled without |+autocmd| feature}
6029 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6030 being used: "<keymap>"
6031 n N Buffer number.
6032 b N Value of byte under cursor.
6033 B N As above, in hexadecimal.
6034 o N Byte number in file of byte under cursor, first byte is 1.
6035 Mnemonic: Offset from start of file (with one added)
6036 {not available when compiled without |+byte_offset| feature}
6037 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006038 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006039 l N Line number.
6040 L N Number of lines in buffer.
6041 c N Column number.
6042 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006043 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006044 p N Percentage through file in lines as in |CTRL-G|.
6045 P S Percentage through file of displayed window. This is like the
6046 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006047 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006048 Empty if the argument file count is zero or one.
6049 { NF Evaluate expression between '{' and '}' and substitute result.
6050 ( - Start of item group. Can be used for setting the width and
6051 alignment of a section. Must be followed by %) somewhere.
6052 ) - End of item group. No width fields allowed.
6053 < - Where to truncate line if too long. Default is at the start.
6054 No width fields allowed.
6055 = - Separation point between left and right aligned items.
6056 No width fields allowed.
6057 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006058 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006059 The difference between User{N} and StatusLine will be applied
6060 to StatusLineNC for the statusline of non-current windows.
6061 The number N must be between 1 and 9. See |hl-User1..9|
6062
6063 Display of flags are controlled by the following heuristic:
6064 If a flag text starts with comma it is assumed that it wants to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006065 separate itself from anything but preceding plaintext. If it starts
Bram Moolenaar071d4272004-06-13 20:20:40 +00006066 with a space it is assumed that it wants to separate itself from
6067 anything but other flags. That is: A leading comma is removed if the
6068 preceding character stems from plaintext. A leading space is removed
Bram Moolenaar582fd852005-03-28 20:58:01 +00006069 if the preceding character stems from another active flag. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006070 make a nice display when flags are used like in the examples below.
6071
Bram Moolenaar582fd852005-03-28 20:58:01 +00006072 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006073 not set) and a minwid is not set for the group, the whole group will
6074 become empty. This will make a group like the following disappear
6075 completely from the statusline when none of the flags are set. >
6076 :set statusline=...%(\ [%M%R%H]%)...
6077<
6078 Beware that an expression is evaluated each and every time the status
6079 line is displayed. The current buffer and current window will be set
6080 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006081 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006082 The variable "actual_curbuf" is set to the 'bufnr()' number of the
6083 real current buffer. The expression is evaluated in the |sandbox|.
6084
6085 If the statusline is not updated when you want it (e.g., after setting
6086 a variable that's used in an expression), you can force an update by
6087 setting an option without changing its value. Example: >
6088 :let &ro = &ro
6089
6090< A result of all digits is regarded a number for display purposes.
6091 Otherwise the result is taken as flag text and applied to the rules
6092 described above.
6093
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006094 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006095 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6096 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6097
6098 Examples:
6099 Emulate standard status line with 'ruler' set >
6100 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6101< Similar, but add ASCII value of char under the cursor (like "ga") >
6102 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6103< Display byte count and byte value, modified flag in red. >
6104 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6105 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6106< Display a ,GZ flag if a compressed file is loaded >
6107 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6108< In the |:autocmd|'s: >
6109 :let b:gzflag = 1
6110< And: >
6111 :unlet b:gzflag
6112< And define this function: >
6113 :function VarExists(var, val)
6114 : if exists(a:var) | return a:val | else | return '' | endif
6115 :endfunction
6116<
6117 *'suffixes'* *'su'*
6118'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6119 global
6120 {not in Vi}
6121 Files with these suffixes get a lower priority when multiple files
6122 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006123 suffixes. Spaces after the comma are ignored. A dot is also seen as
6124 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006125 separator, precede it with a backslash (see |option-backslash| about
6126 including spaces and backslashes).
6127 See 'wildignore' for completely ignoring files.
6128 The use of |:set+=| and |:set-=| is preferred when adding or removing
6129 suffixes from the list. This avoids problems when a future version
6130 uses another default.
6131
6132 *'suffixesadd'* *'sua'*
6133'suffixesadd' 'sua' string (default "")
6134 local to buffer
6135 {not in Vi}
6136 {not available when compiled without the
6137 |+file_in_path| feature}
6138 Comma separated list of suffixes, which are used when searching for a
6139 file for the "gf", "[I", etc. commands. Example: >
6140 :set suffixesadd=.java
6141<
6142 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6143'swapfile' 'swf' boolean (default on)
6144 local to buffer
6145 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006146 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006147 swapfile is not wanted for a specific buffer. For example, with
6148 confidential information that even root must not be able to access.
6149 Careful: All text will be in memory:
6150 - Don't use this for big files.
6151 - Recovery will be impossible!
6152 A swapfile will only be present when |'updatecount'| is non-zero and
6153 'swapfile' is set.
6154 When 'swapfile' is reset, the swap file for the current buffer is
6155 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6156 non-zero, a swap file is immediately created.
6157 Also see |swap-file| and |'swapsync'|.
6158
6159 This option is used together with 'bufhidden' and 'buftype' to
6160 specify special kinds of buffers. See |special-buffers|.
6161
6162 *'swapsync'* *'sws'*
6163'swapsync' 'sws' string (default "fsync")
6164 global
6165 {not in Vi}
6166 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006167 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006168 When this option is empty parts of the swap file may be in memory and
6169 not written to disk. When the system crashes you may lose more work.
6170 On Unix the system does a sync now and then without Vim asking for it,
6171 so the disadvantage of setting this option off is small. On some
6172 systems the swap file will not be written at all. For a unix system
6173 setting it to "sync" will use the sync() call instead of the default
6174 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006175 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006176
6177 *'switchbuf'* *'swb'*
6178'switchbuf' 'swb' string (default "")
6179 global
6180 {not in Vi}
6181 This option controls the behavior when switching between buffers.
6182 Possible values (comma separated list):
6183 useopen If included, jump to the first open window that
6184 contains the specified buffer (if there is one).
6185 Otherwise: Do not examine other windows.
6186 This setting is checked with |quickfix| commands, when
6187 jumping to errors (":cc", ":cn", "cp", etc.). It is
6188 also used in all buffer related split commands, for
6189 example ":sbuffer", ":sbnext", or ":sbrewind".
6190 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006191 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006192 Supported in |quickfix| commands that display errors.
6193
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006194 *'synmaxcol'* *'smc'*
6195'synmaxcol' 'smc' number (default 3000)
6196 local to buffer
6197 {not in Vi}
6198 {not available when compiled without the |+syntax|
6199 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006200 Maximum column in which to search for syntax items. In long lines the
6201 text after this column is not highlighted and following lines may not
6202 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006203 This helps to avoid very slow redrawing for an XML file that is one
6204 long line.
6205 Set to zero to remove the limit.
6206
Bram Moolenaar071d4272004-06-13 20:20:40 +00006207 *'syntax'* *'syn'*
6208'syntax' 'syn' string (default empty)
6209 local to buffer
6210 {not in Vi}
6211 {not available when compiled without the |+syntax|
6212 feature}
6213 When this option is set, the syntax with this name is loaded, unless
6214 syntax highlighting has been switched off with ":syntax off".
6215 Otherwise this option does not always reflect the current syntax (the
6216 b:current_syntax variable does).
6217 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006218 not automatically recognized. Example, in an IDL file: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006219 /* vim: set syntax=idl : */
6220< To switch off syntax highlighting for the current file, use: >
6221 :set syntax=OFF
6222< To switch syntax highlighting on according to the current value of the
6223 'filetype' option: >
6224 :set syntax=ON
6225< What actually happens when setting the 'syntax' option is that the
6226 Syntax autocommand event is triggered with the value as argument.
6227 This option is not copied to another buffer, independent of the 's' or
6228 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006229 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006230
6231 *'tabstop'* *'ts'*
6232'tabstop' 'ts' number (default 8)
6233 local to buffer
6234 Number of spaces that a <Tab> in the file counts for. Also see
6235 |:retab| command, and 'softtabstop' option.
6236
6237 Note: Setting 'tabstop' to any other value than 8 can make your file
6238 appear wrong in many places (e.g., when printing it).
6239
6240 There are four main ways to use tabs in Vim:
6241 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6242 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
6243 will use a mix of tabs and spaces, but typing Tab and BS will
6244 behave like a tab appears every 4 (or 3) characters.
6245 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6246 'expandtab'. This way you will always insert spaces. The
6247 formatting will never be messed up when 'tabstop' is changed.
6248 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006249 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006250 works when using Vim to edit the file.
6251 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6252 'noexpandtab'. This should then work (for initial indents only)
6253 for any tabstop setting that people use. It might be nice to have
6254 tabs after the first non-blank inserted as spaces if you do this
6255 though. Otherwise aligned comments will be wrong when 'tabstop' is
6256 changed.
6257
6258 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6259'tagbsearch' 'tbs' boolean (default on)
6260 global
6261 {not in Vi}
6262 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006263 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006264 searching makes searching for a tag a LOT faster, but a linear search
6265 will find more tags if the tags file wasn't properly sorted.
6266 Vim normally assumes that your tags files are sorted, or indicate that
6267 they are not sorted. Only when this is not the case does the
6268 'tagbsearch' option need to be switched off.
6269
6270 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006271 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006272 certain files, or retry all files with a linear search. When
6273 'tagbsearch' is off, only a linear search is done.
6274
6275 Linear searching is done anyway, for one file, when Vim finds a line
6276 at the start of the file indicating that it's not sorted: >
6277 !_TAG_FILE_SORTED 0 /some command/
6278< [The whitespace before and after the '0' must be a single <Tab>]
6279
6280 When a binary search was done and no match was found in any of the
6281 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6282 instead of a normal tag name, a retry is done with a linear search.
6283 Tags in unsorted tags files, and matches with different case will only
6284 be found in the retry.
6285
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006286 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006287 linear search can be avoided for the 'ignorecase' case. Use a value
6288 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6289 case-fold sorted with the -f switch to "sort" in most unices, as in
6290 the command: "sort -f -o tags tags". For "Exuberant ctags" version
6291 5.3 or higher the -f or --fold-case-sort switch can be used for this
6292 as well. Note that case must be folded to uppercase for this to work.
6293
6294 When 'tagbsearch' is off, tags searching is slower when a full match
6295 exists, but faster when no full match exists. Tags in unsorted tags
6296 files may only be found with 'tagbsearch' off.
6297 When the tags file is not sorted, or sorted in a wrong way (not on
6298 ASCII byte value), 'tagbsearch' should be off, or the line given above
6299 must be included in the tags file.
6300 This option doesn't affect commands that find all matching tags (e.g.,
6301 command-line completion and ":help").
6302 {Vi: always uses binary search in some versions}
6303
6304 *'taglength'* *'tl'*
6305'taglength' 'tl' number (default 0)
6306 global
6307 If non-zero, tags are significant up to this number of characters.
6308
6309 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6310'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6311 global
6312 {not in Vi}
6313 If on and using a tag file in another directory, file names in that
6314 tag file are relative to the directory where the tag file is.
6315 NOTE: This option is set to the Vi default value when 'compatible' is
6316 set and to the Vim default value when 'compatible' is reset.
6317
6318 *'tags'* *'tag'* *E433*
6319'tags' 'tag' string (default "./tags,tags", when compiled with
6320 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6321 global or local to buffer |global-local|
6322 Filenames for the tag command, separated by spaces or commas. To
6323 include a space or comma in a file name, precede it with a backslash
6324 (see |option-backslash| about including spaces and backslashes).
6325 When a file name starts with "./", the '.' is replaced with the path
6326 of the current file. But only when the 'd' flag is not included in
6327 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6328 |tags-option|.
6329 "*", "**" and other wildcards can be used to search for tags files in
6330 a directory tree. See |file-searching|. {not available when compiled
6331 without the |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006332 The |tagfiles()| function can be used to get a list of the file names
6333 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006334 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6335 files are also supported. They are automatically recognized. The
6336 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6337 differences are ignored (MS-Windows). |emacs-tags|
6338 The use of |:set+=| and |:set-=| is preferred when adding or removing
6339 file names from the list. This avoids problems when a future version
6340 uses another default.
6341 {Vi: default is "tags /usr/lib/tags"}
6342
6343 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6344'tagstack' 'tgst' boolean (default on)
6345 global
6346 {not in all versions of Vi}
6347 When on, the |tagstack| is used normally. When off, a ":tag" or
6348 ":tselect" command with an argument will not push the tag onto the
6349 tagstack. A following ":tag" without an argument, a ":pop" command or
6350 any other command that uses the tagstack will use the unmodified
6351 tagstack, but does change the pointer to the active entry.
6352 Resetting this option is useful when using a ":tag" command in a
6353 mapping which should not change the tagstack.
6354
6355 *'term'* *E529* *E530* *E531*
6356'term' string (default is $TERM, if that fails:
6357 in the GUI: "builtin_gui"
6358 on Amiga: "amiga"
6359 on BeOS: "beos-ansi"
6360 on Mac: "mac-ansi"
6361 on MiNT: "vt52"
6362 on MS-DOS: "pcterm"
6363 on OS/2: "os2ansi"
6364 on Unix: "ansi"
6365 on VMS: "ansi"
6366 on Win 32: "win32")
6367 global
6368 Name of the terminal. Used for choosing the terminal control
6369 characters. Environment variables are expanded |:set_env|.
6370 For example: >
6371 :set term=$TERM
6372< See |termcap|.
6373
6374 *'termbidi'* *'tbidi'*
6375 *'notermbidi'* *'notbidi'*
6376'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6377 global
6378 {not in Vi}
6379 {only available when compiled with the |+arabic|
6380 feature}
6381 The terminal is in charge of Bi-directionality of text (as specified
6382 by Unicode). The terminal is also expected to do the required shaping
6383 that some languages (such as Arabic) require.
6384 Setting this option implies that 'rightleft' will not be set when
6385 'arabic' is set and the value of 'arabicshape' will be ignored.
6386 Note that setting 'termbidi' has the immediate effect that
6387 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6388 This option is reset when the GUI is started.
6389 For further details see |arabic.txt|.
6390
6391 *'termencoding'* *'tenc'*
6392'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6393 Macintosh GUI: "macroman")
6394 global
6395 {only available when compiled with the |+multi_byte|
6396 feature}
6397 {not in Vi}
6398 Encoding used for the terminal. This specifies what character
6399 encoding the keyboard produces and the display will understand. For
6400 the GUI it only applies to the keyboard ('encoding' is used for the
6401 display).
6402 In the Win32 console version the default value is the console codepage
6403 when it differs from the ANSI codepage.
6404 *E617*
6405 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6406 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6407 Any attempts to set a different value will be rejected, and an error
6408 message is shown.
6409 For the Win32 GUI 'termencoding' is not used for typed characters,
6410 because the Win32 system always passes Unicode characters.
6411 When empty, the same encoding is used as for the 'encoding' option.
6412 This is the normal value.
6413 Not all combinations for 'termencoding' and 'encoding' are valid. See
6414 |encoding-table|.
6415 The value for this option must be supported by internal conversions or
6416 iconv(). When this is not possible no conversion will be done and you
6417 will probably experience problems with non-ASCII characters.
6418 Example: You are working with the locale set to euc-jp (Japanese) and
6419 want to edit a UTF-8 file: >
6420 :let &termencoding = &encoding
6421 :set encoding=utf-8
6422< You need to do this when your system has no locale support for UTF-8.
6423
6424 *'terse'* *'noterse'*
6425'terse' boolean (default off)
6426 global
6427 When set: Add 's' flag to 'shortmess' option (this makes the message
6428 for a search that hits the start or end of the file not being
6429 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6430 shortens a lot of messages}
6431
6432 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6433'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6434 global
6435 {not in Vi}
6436 This option is obsolete. Use 'fileformats'.
6437 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6438 set to the default value for the current system. When 'textauto' is
6439 reset, 'fileformats' is made empty.
6440 NOTE: This option is set to the Vi default value when 'compatible' is
6441 set and to the Vim default value when 'compatible' is reset.
6442
6443 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6444'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
6445 others: default off)
6446 local to buffer
6447 {not in Vi}
6448 This option is obsolete. Use 'fileformat'.
6449 For backwards compatibility, when 'textmode' is set, 'fileformat' is
6450 set to "dos". When 'textmode' is reset, 'fileformat' is set to
6451 "unix".
6452
6453 *'textwidth'* *'tw'*
6454'textwidth' 'tw' number (default 0)
6455 local to buffer
6456 {not in Vi}
6457 Maximum width of text that is being inserted. A longer line will be
6458 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006459 this. 'textwidth' is set to 0 when the 'paste' option is set. When
6460 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00006461 'formatoptions' and |ins-textwidth|.
6462 NOTE: This option is set to 0 when 'compatible' is set.
6463
6464 *'thesaurus'* *'tsr'*
6465'thesaurus' 'tsr' string (default "")
6466 global or local to buffer |global-local|
6467 {not in Vi}
6468 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006469 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00006470 the file should contain words with similar meaning, separated by
6471 non-keyword characters (white space is preferred). Maximum line
6472 length is 510 bytes.
6473 To obtain a file to be used here, check out the wordlist FAQ at
6474 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006475 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00006476 after a comma are ignored, otherwise spaces are included in the file
6477 name. See |option-backslash| about using backslashes.
6478 The use of |:set+=| and |:set-=| is preferred when adding or removing
6479 directories from the list. This avoids problems when a future version
6480 uses another default.
6481 Backticks cannot be used in this option for security reasons.
6482
6483 *'tildeop'* *'top'* *'notildeop'* *'notop'*
6484'tildeop' 'top' boolean (default off)
6485 global
6486 {not in Vi}
6487 When on: The tilde command "~" behaves like an operator.
6488 NOTE: This option is reset when 'compatible' is set.
6489
6490 *'timeout'* *'to'* *'notimeout'* *'noto'*
6491'timeout' 'to' boolean (default on)
6492 global
6493 *'ttimeout'* *'nottimeout'*
6494'ttimeout' boolean (default off)
6495 global
6496 {not in Vi}
6497 These two options together determine the behavior when part of a
6498 mapped key sequence or keyboard code has been received:
6499
6500 'timeout' 'ttimeout' action ~
6501 off off do not time out
6502 on on or off time out on :mappings and key codes
6503 off on time out on key codes
6504
6505 If both options are off, Vim will wait until either the complete
6506 mapping or key sequence has been received, or it is clear that there
6507 is no mapping or key sequence for the received characters. For
6508 example: if you have mapped "vl" and Vim has received 'v', the next
6509 character is needed to see if the 'v' is followed by an 'l'.
6510 When one of the options is on, Vim will wait for about 1 second for
6511 the next character to arrive. After that the already received
6512 characters are interpreted as single characters. The waiting time can
6513 be changed with the 'timeoutlen' option.
6514 On slow terminals or very busy systems timing out may cause
6515 malfunctioning cursor keys. If both options are off, Vim waits
6516 forever after an entered <Esc> if there are key codes that start
6517 with <Esc>. You will have to type <Esc> twice. If you do not have
6518 problems with key codes, but would like to have :mapped key
6519 sequences not timing out in 1 second, set the 'ttimeout' option and
6520 reset the 'timeout' option.
6521
6522 NOTE: 'ttimeout' is reset when 'compatible' is set.
6523
6524 *'timeoutlen'* *'tm'*
6525'timeoutlen' 'tm' number (default 1000)
6526 global
6527 {not in all versions of Vi}
6528 *'ttimeoutlen'* *'ttm'*
6529'ttimeoutlen' 'ttm' number (default -1)
6530 global
6531 {not in Vi}
6532 The time in milliseconds that is waited for a key code or mapped key
6533 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
6534 when part of a command has been typed.
6535 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
6536 different timeout value for key codes is desired set 'ttimeoutlen' to
6537 a non-negative number.
6538
6539 ttimeoutlen mapping delay key code delay ~
6540 < 0 'timeoutlen' 'timeoutlen'
6541 >= 0 'timeoutlen' 'ttimeoutlen'
6542
6543 The timeout only happens when the 'timeout' and 'ttimeout' options
6544 tell so. A useful setting would be >
6545 :set timeout timeoutlen=3000 ttimeoutlen=100
6546< (time out on mapping after three seconds, time out on key codes after
6547 a tenth of a second).
6548
6549 *'title'* *'notitle'*
6550'title' boolean (default off, on when title can be restored)
6551 global
6552 {not in Vi}
6553 {not available when compiled without the |+title|
6554 feature}
6555 When on, the title of the window will be set to the value of
6556 'titlestring' (if it is not empty), or to:
6557 filename [+=-] (path) - VIM
6558 Where:
6559 filename the name of the file being edited
6560 - indicates the file cannot be modified, 'ma' off
6561 + indicates the file was modified
6562 = indicates the file is read-only
6563 =+ indicates the file is read-only and modified
6564 (path) is the path of the file being edited
6565 - VIM the server name |v:servername| or "VIM"
6566 Only works if the terminal supports setting window titles
6567 (currently Amiga console, Win32 console, all GUI versions and
6568 terminals with a non- empty 't_ts' option - these are Unix xterm and
6569 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
6570 *X11*
6571 When Vim was compiled with HAVE_X11 defined, the original title will
6572 be restored if possible. The output of ":version" will include "+X11"
6573 when HAVE_X11 was defined, otherwise it will be "-X11". This also
6574 works for the icon name |'icon'|.
6575 But: When Vim was started with the |-X| argument, restoring the title
6576 will not work (except in the GUI).
6577 If the title cannot be restored, it is set to the value of 'titleold'.
6578 You might want to restore the title outside of Vim then.
6579 When using an xterm from a remote machine you can use this command:
6580 rsh machine_name xterm -display $DISPLAY &
6581 then the WINDOWID environment variable should be inherited and the
6582 title of the window should change back to what it should be after
6583 exiting Vim.
6584
6585 *'titlelen'*
6586'titlelen' number (default 85)
6587 global
6588 {not in Vi}
6589 {not available when compiled without the |+title|
6590 feature}
6591 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006592 title. When the title is longer, only the end of the path name is
6593 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006594 Using a percentage makes this adapt to the width of the window. But
6595 it won't work perfectly, because the actual number of characters
6596 available also depends on the font used and other things in the title
6597 bar. When 'titlelen' is zero the full path is used. Otherwise,
6598 values from 1 to 30000 percent can be used.
6599 'titlelen' is also used for the 'titlestring' option.
6600
6601 *'titleold'*
6602'titleold' string (default "Thanks for flying Vim")
6603 global
6604 {not in Vi}
6605 {only available when compiled with the |+title|
6606 feature}
6607 This option will be used for the window title when exiting Vim if the
6608 original title cannot be restored. Only happens if 'title' is on or
6609 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006610 This option cannot be set from a |modeline| or in the |sandbox|, for
6611 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006612 *'titlestring'*
6613'titlestring' string (default "")
6614 global
6615 {not in Vi}
6616 {not available when compiled without the |+title|
6617 feature}
6618 When this option is not empty, it will be used for the title of the
6619 window. This happens only when the 'title' option is on.
6620 Only works if the terminal supports setting window titles (currently
6621 Amiga console, Win32 console, all GUI versions and terminals with a
6622 non-empty 't_ts' option).
6623 When Vim was compiled with HAVE_X11 defined, the original title will
6624 be restored if possible |X11|.
6625 When this option contains printf-style '%' items, they will be
6626 expanded according to the rules used for 'statusline'.
6627 Example: >
6628 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
6629 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
6630< The value of 'titlelen' is used to align items in the middle or right
6631 of the available space.
6632 Some people prefer to have the file name first: >
6633 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
6634< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006635 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006636 separating space only when needed.
6637 NOTE: Use of special characters in 'titlestring' may cause the display
6638 to be garbled (e.g., when it contains a CR or NL character).
6639 {not available when compiled without the |+statusline| feature}
6640
6641 *'toolbar'* *'tb'*
6642'toolbar' 'tb' string (default "icons,tooltips")
6643 global
6644 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
6645 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006646 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00006647 possible values are:
6648 icons Toolbar buttons are shown with icons.
6649 text Toolbar buttons shown with text.
6650 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006651 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006652 tooltips Tooltips are active for toolbar buttons.
6653 Tooltips refer to the popup help text which appears after the mouse
6654 cursor is placed over a toolbar button for a brief moment.
6655
6656 If you want the toolbar to be shown with icons as well as text, do the
6657 following: >
6658 :set tb=icons,text
6659< Motif and Athena cannot display icons and text at the same time. They
6660 will show icons if both are requested.
6661
6662 If none of the strings specified in 'toolbar' are valid or if
6663 'toolbar' is empty, this option is ignored. If you want to disable
6664 the toolbar, you need to set the 'guioptions' option. For example: >
6665 :set guioptions-=T
6666< Also see |gui-toolbar|.
6667
6668 *'toolbariconsize'* *'tbis'*
6669'toolbariconsize' 'tbis' string (default "small")
6670 global
6671 {not in Vi}
6672 {only in the GTK+ 2 GUI}
6673 Controls the size of toolbar icons. The possible values are:
6674 tiny Use tiny toolbar icons.
6675 small Use small toolbar icons (default).
6676 medium Use medium-sized toolbar icons.
6677 large Use large toolbar icons.
6678 The exact dimensions in pixels of the various icon sizes depend on
6679 the current theme. Common dimensions are large=32x32, medium=24x24,
6680 small=20x20 and tiny=16x16.
6681
6682 If 'toolbariconsize' is empty, the global default size as determined
6683 by user preferences or the current theme is used.
6684
6685 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
6686'ttybuiltin' 'tbi' boolean (default on)
6687 global
6688 {not in Vi}
6689 When on, the builtin termcaps are searched before the external ones.
6690 When off the builtin termcaps are searched after the external ones.
6691 When this option is changed, you should set the 'term' option next for
6692 the change to take effect, for example: >
6693 :set notbi term=$TERM
6694< See also |termcap|.
6695 Rationale: The default for this option is "on", because the builtin
6696 termcap entries are generally better (many systems contain faulty
6697 xterm entries...).
6698
6699 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
6700'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
6701 sun-cmd, screen, rxvt, dtterm or
6702 iris-ansi; also on when running Vim in
6703 a DOS console)
6704 global
6705 {not in Vi}
6706 Indicates a fast terminal connection. More characters will be sent to
6707 the screen for redrawing, instead of using insert/delete line
6708 commands. Improves smoothness of redrawing when there are multiple
6709 windows and the terminal does not support a scrolling region.
6710 Also enables the extra writing of characters at the end of each screen
6711 line for lines that wrap. This helps when using copy/paste with the
6712 mouse in an xterm and other terminals.
6713
6714 *'ttymouse'* *'ttym'*
6715'ttymouse' 'ttym' string (default depends on 'term')
6716 global
6717 {not in Vi}
6718 {only in Unix and VMS, doesn't work in the GUI; not
6719 available when compiled without |+mouse|}
6720 Name of the terminal type for which mouse codes are to be recognized.
6721 Currently these three strings are valid:
6722 *xterm-mouse*
6723 xterm xterm-like mouse handling. The mouse generates
6724 "<Esc>[Mscr", where "scr" is three bytes:
6725 "s" = button state
6726 "c" = column plus 33
6727 "r" = row plus 33
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006728 This only works up to 223 columns! See "dec" for a
6729 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006730 xterm2 Works like "xterm", but with the xterm reporting the
6731 mouse position while the mouse is dragged. This works
6732 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00006733 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00006734 work. See below for how Vim detects this
6735 automatically.
6736 *netterm-mouse*
6737 netterm NetTerm mouse handling. The mouse generates
6738 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
6739 for the row and column.
6740 *dec-mouse*
6741 dec DEC terminal mouse handling. The mouse generates a
6742 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006743 This is also available for an Xterm, if it was
6744 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006745 *jsbterm-mouse*
6746 jsbterm JSB term mouse handling.
6747 *pterm-mouse*
6748 pterm QNX pterm mouse handling.
6749
6750 The mouse handling must be enabled at compile time |+mouse_xterm|
6751 |+mouse_dec| |+mouse_netterm|.
6752 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
6753 recognized, if enabled at compile time. DEC terminal mouse codes
6754 are recognized if enabled at compile time, and 'ttymouse' is not
6755 "xterm" (because the xterm and dec mouse codes conflict).
6756 This option is automatically set to "xterm", when the 'term' option is
6757 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
6758 or "xterm2" already. The main use of this option is to set it to
6759 "xterm", when the terminal name doesn't start with "xterm", but it can
6760 handle xterm mouse codes.
6761 The "xterm2" value will be set if the xterm version is reported to be
6762 95 of higher. This only works when compiled with the |+termresponse|
6763 feature and if |t_RV| is set to the escape sequence to request the
6764 xterm version number. Otherwise "xterm2" must be set explicitly.
6765 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
6766 t_RV to an empty string: >
6767 :set t_RV=
6768<
6769 *'ttyscroll'* *'tsl'*
6770'ttyscroll' 'tsl' number (default 999)
6771 global
6772 Maximum number of lines to scroll the screen. If there are more lines
6773 to scroll the window is redrawn. For terminals where scrolling is
6774 very slow and redrawing is not slow this can be set to a small number,
6775 e.g., 3, to speed up displaying.
6776
6777 *'ttytype'* *'tty'*
6778'ttytype' 'tty' string (default from $TERM)
6779 global
6780 Alias for 'term', see above.
6781
6782 *'undolevels'* *'ul'*
6783'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
6784 Win32 and OS/2)
6785 global
6786 {not in Vi}
6787 Maximum number of changes that can be undone. Since undo information
6788 is kept in memory, higher numbers will cause more memory to be used
6789 (nevertheless, a single change can use an unlimited amount of memory).
6790 Set to 0 for Vi compatibility: One level of undo and "u" undoes
6791 itself: >
6792 set ul=0
6793< But you can also get Vi compatibility by including the 'u' flag in
6794 'cpoptions', and still be able to use CTRL-R to repeat undo.
6795 Set to a negative number for no undo at all: >
6796 set ul=-1
6797< This helps when you run out of memory for a single change.
6798 Also see |undo-two-ways|.
6799
6800 *'updatecount'* *'uc'*
6801'updatecount' 'uc' number (default: 200)
6802 global
6803 {not in Vi}
6804 After typing this many characters the swap file will be written to
6805 disk. When zero, no swap file will be created at all (see chapter on
6806 recovery |crash-recovery|). 'updatecount' is set to zero by starting
6807 Vim with the "-n" option, see |startup|. When editing in readonly
6808 mode this option will be initialized to 10000.
6809 The swapfile can be disabled per buffer with |'swapfile'|.
6810 When 'updatecount' is set from zero to non-zero, swap files are
6811 created for all buffers that have 'swapfile' set. When 'updatecount'
6812 is set to zero, existing swap files are not deleted.
6813 Also see |'swapsync'|.
6814 This option has no meaning in buffers where |'buftype'| is "nofile"
6815 or "nowrite".
6816
6817 *'updatetime'* *'ut'*
6818'updatetime' 'ut' number (default 4000)
6819 global
6820 {not in Vi}
6821 If this many milliseconds nothing is typed the swap file will be
6822 written to disk (see |crash-recovery|). Also used for the
6823 |CursorHold| autocommand event.
6824
6825 *'verbose'* *'vbs'*
6826'verbose' 'vbs' number (default 0)
6827 global
6828 {not in Vi, although some versions have a boolean
6829 verbose option}
6830 When bigger than zero, Vim will give messages about what it is doing.
6831 Currently, these messages are given:
6832 >= 1 When the viminfo file is read or written.
6833 >= 2 When a file is ":source"'ed.
6834 >= 5 Every searched tags file.
6835 >= 8 Files for which a group of autocommands is executed.
6836 >= 9 Every executed autocommand.
6837 >= 12 Every executed function.
6838 >= 13 When an exception is thrown, caught, finished, or discarded.
6839 >= 14 Anything pending in a ":finally" clause.
6840 >= 15 Every executed Ex command (truncated at 200 characters).
6841
6842 This option can also be set with the "-V" argument. See |-V|.
6843 This option is also set by the |:verbose| command.
6844
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00006845 When the 'verbosefile' option is set then the verbose messages are not
6846 displayed.
6847
6848 *'verbosefile'* *'vfile'*
6849'verbosefile' 'vfile' string (default empty)
6850 global
6851 {not in Vi}
6852 When not empty all messages are written in a file with this name.
6853 When the file exists messages are appended.
6854 Writing to the file ends when Vim exits or when 'verbosefile' is made
6855 empty.
6856 Setting 'verbosefile' to a new value is like making it empty first.
6857 The difference with |:redir| is that verbose messages are not
6858 displayed when 'verbosefile' is set.
6859
Bram Moolenaar071d4272004-06-13 20:20:40 +00006860 *'viewdir'* *'vdir'*
6861'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
6862 "$VIM/vimfiles/view",
6863 for Unix: "~/.vim/view",
6864 for Macintosh: "$VIM:vimfiles:view"
6865 for VMS: "sys$login:vimfiles/view"
6866 for RiscOS: "Choices:vimfiles/view")
6867 global
6868 {not in Vi}
6869 {not available when compiled without the +mksession
6870 feature}
6871 Name of the directory where to store files for |:mkview|.
6872 This option cannot be set from a |modeline| or in the |sandbox|, for
6873 security reasons.
6874
6875 *'viewoptions'* *'vop'*
6876'viewoptions' 'vop' string (default: "folds,options,cursor")
6877 global
6878 {not in Vi}
6879 {not available when compiled without the +mksession
6880 feature}
6881 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006882 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006883 word save and restore ~
6884 cursor cursor position in file and in window
6885 folds manually created folds, opened/closed folds and local
6886 fold options
6887 options options and mappings local to a window or buffer (not
6888 global values for local options)
6889 slash backslashes in file names replaced with forward
6890 slashes
6891 unix with Unix end-of-line format (single <NL>), even when
6892 on Windows or DOS
6893
6894 "slash" and "unix" are useful on Windows when sharing view files
6895 with Unix. The Unix version of Vim cannot source dos format scripts,
6896 but the Windows version of Vim can source unix format scripts.
6897
6898 *'viminfo'* *'vi'* *E526* *E527* *E528*
6899'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
6900 Windows and OS/2: '20,<50,s10,h,rA:,rB:,
6901 for Amiga: '20,<50,s10,h,rdf0:,rdf1:,rdf2:
6902 for others: '20,<50,s10,h)
6903 global
6904 {not in Vi}
6905 {not available when compiled without the |+viminfo|
6906 feature}
6907 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006908 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00006909 separated list of parameters, each consisting of a single character
6910 identifying the particular parameter, followed by a number or string
6911 which specifies the value of that parameter. If a particular
6912 character is left out, then the default value is used for that
6913 parameter. The following is a list of the identifying characters and
6914 the effect of their value.
6915 CHAR VALUE ~
6916 ! When included, save and restore global variables that start
6917 with an uppercase letter, and don't contain a lowercase
6918 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00006919 and "_K_L_M" are not. Only String and Number types are
6920 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006921 " Maximum number of lines saved for each register. Old name of
6922 the '<' item, with the disadvantage that you need to put a
6923 backslash before the ", otherwise it will be recognized as the
6924 start of a comment!
6925 % When included, save and restore the buffer list. If Vim is
6926 started with a file name argument, the buffer list is not
6927 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006928 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00006929 without a file name and buffers for help files are not written
6930 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00006931 When followed by a number, the number specifies the maximum
6932 number of buffers that are stored. Without a number all
6933 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006934 ' Maximum number of previously edited files for which the marks
6935 are remembered. This parameter must always be included when
6936 'viminfo' is non-empty.
6937 Including this item also means that the |jumplist| and the
6938 |changelist| are stored in the viminfo file.
6939 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006940 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00006941 patterns are also saved. When not included, the value of
6942 'history' is used.
6943 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006944 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006945 < Maximum number of lines saved for each register. If zero then
6946 registers are not saved. When not included, all lines are
6947 saved. '"' is the old name for this item.
6948 Also see the 's' item below: limit specified in Kbyte.
6949 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006950 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006951 c When included, convert the text in the viminfo file from the
6952 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00006953 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006954 f Whether file marks need to be stored. If zero, file marks ('0
6955 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006956 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00006957 cursor position (when exiting or when doing ":wviminfo").
6958 h Disable the effect of 'hlsearch' when loading the viminfo
6959 file. When not included, it depends on whether ":nohlsearch"
6960 has been used since the last search command.
6961 n Name of the viminfo file. The name must immediately follow
6962 the 'n'. Must be the last one! If the "-i" argument was
6963 given when starting Vim, that file name overrides the one
6964 given here with 'viminfo'. Environment variables are expanded
6965 when opening the file, not when setting the option.
6966 r Removable media. The argument is a string (up to the next
6967 ','). This parameter can be given several times. Each
6968 specifies the start of a path for which no marks will be
6969 stored. This is to avoid removable media. For MS-DOS you
6970 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
6971 also use it for temp files, e.g., for Unix: "r/tmp". Case is
6972 ignored. Maximum length of each 'r' argument is 50
6973 characters.
6974 s Maximum size of an item in Kbyte. If zero then registers are
6975 not saved. Currently only applies to registers. The default
6976 "s10" will exclude registers with more than 10 Kbyte of text.
6977 Also see the '<' item above: line count limit.
6978
6979 Example: >
6980 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
6981<
6982 '50 Marks will be remembered for the last 50 files you
6983 edited.
6984 <1000 Contents of registers (up to 1000 lines each) will be
6985 remembered.
6986 s100 Registers with more than 100 Kbyte text are skipped.
6987 :0 Command-line history will not be saved.
6988 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
6989 no / Since '/' is not specified, the default will be used,
6990 that is, save all of the search history, and also the
6991 previous search and substitute patterns.
6992 no % The buffer list will not be saved nor read back.
6993 no h 'hlsearch' highlighting will be restored.
6994
6995 When setting 'viminfo' from an empty value you can use |:rviminfo| to
6996 load the contents of the file, this is not done automatically.
6997
6998 This option cannot be set from a |modeline| or in the |sandbox|, for
6999 security reasons.
7000
7001 *'virtualedit'* *'ve'*
7002'virtualedit' 've' string (default "")
7003 global
7004 {not in Vi}
7005 {not available when compiled without the
7006 |+virtualedit| feature}
7007 A comma separated list of these words:
7008 block Allow virtual editing in Visual block mode.
7009 insert Allow virtual editing in Insert mode.
7010 all Allow virtual editing in all modes.
7011 Virtual editing means that the cursor can be positioned where there is
7012 no actual character. This can be halfway into a Tab or beyond the end
7013 of the line. Useful for selecting a rectangle in Visual mode and
7014 editing a table.
7015
7016 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7017'visualbell' 'vb' boolean (default off)
7018 global
7019 {not in Vi}
7020 Use visual bell instead of beeping. The terminal code to display the
7021 visual bell is given with 't_vb'. When no beep or flash is wanted,
7022 use ":set vb t_vb=".
7023 Note: When the GUI starts, 't_vb' is reset to its default value. You
7024 might want to set it again in your |gvimrc|.
7025 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7026 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7027 where 40 is the time in msec.
7028 Does not work on the Amiga, you always get a screen flash.
7029 Also see 'errorbells'.
7030
7031 *'warn'* *'nowarn'*
7032'warn' boolean (default on)
7033 global
7034 Give a warning message when a shell command is used while the buffer
7035 has been changed.
7036
7037 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7038'weirdinvert' 'wiv' boolean (default off)
7039 global
7040 {not in Vi}
7041 This option has the same effect as the 't_xs' termcap option.
7042 It is provided for backwards compatibility with version 4.x.
7043 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7044 vice versa. Has no effect when the GUI is running.
7045
7046 *'whichwrap'* *'ww'*
7047'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7048 global
7049 {not in Vi}
7050 Allow specified keys that move the cursor left/right to move to the
7051 previous/next line when the cursor is on the first/last character in
7052 the line. Concatenate characters to allow this for these keys:
7053 char key mode ~
7054 b <BS> Normal and Visual
7055 s <Space> Normal and Visual
7056 h "h" Normal and Visual
7057 l "l" Normal and Visual
7058 < <Left> Normal and Visual
7059 > <Right> Normal and Visual
7060 ~ "~" Normal
7061 [ <Left> Insert and Replace
7062 ] <Right> Insert and Replace
7063 For example: >
7064 :set ww=<,>,[,]
7065< allows wrap only when cursor keys are used.
7066 When the movement keys are used in combination with a delete or change
7067 operator, the <EOL> also counts for a character. This makes "3h"
7068 different from "3dh" when the cursor crosses the end of a line. This
7069 is also true for "x" and "X", because they do the same as "dl" and
7070 "dh". If you use this, you may also want to use the mapping
7071 ":map <BS> X" to make backspace delete the character in front of the
7072 cursor.
7073 When 'l' is included, you get a side effect: "yl" on an empty line
7074 will include the <EOL>, so that "p" will insert a new line.
7075 NOTE: This option is set to the Vi default value when 'compatible' is
7076 set and to the Vim default value when 'compatible' is reset.
7077
7078 *'wildchar'* *'wc'*
7079'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7080 global
7081 {not in Vi}
7082 Character you have to type to start wildcard expansion in the
7083 command-line, as specified with 'wildmode'.
7084 The character is not recognized when used inside a macro. See
7085 'wildcharm' for that.
7086 Although 'wc' is a number option, you can set it to a special key: >
7087 :set wc=<Esc>
7088< NOTE: This option is set to the Vi default value when 'compatible' is
7089 set and to the Vim default value when 'compatible' is reset.
7090
7091 *'wildcharm'* *'wcm'*
7092'wildcharm' 'wcm' number (default: none (0))
7093 global
7094 {not in Vi}
7095 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007096 recognized when used inside a macro. You can find "spare" command-line
7097 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007098 you'll never actually type 'wildcharm', just use it in mappings that
7099 automatically invoke completion mode, e.g.: >
7100 :set wcm=<C-Z>
7101 :cmap ss so $vim/sessions/*.vim<C-Z>
7102< Then after typing :ss you can use CTRL-P & CTRL-N.
7103
7104 *'wildignore'* *'wig'*
7105'wildignore' 'wig' string (default "")
7106 global
7107 {not in Vi}
7108 {not available when compiled without the |+wildignore|
7109 feature}
7110 A list of file patterns. A file that matches with one of these
7111 patterns is ignored when completing file or directory names.
7112 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7113 Also see 'suffixes'.
7114 Example: >
7115 :set wildignore=*.o,*.obj
7116< The use of |:set+=| and |:set-=| is preferred when adding or removing
7117 a pattern from the list. This avoids problems when a future version
7118 uses another default.
7119
7120 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7121'wildmenu' 'wmnu' boolean (default off)
7122 global
7123 {not in Vi}
7124 {not available if compiled without the |+wildmenu|
7125 feature}
7126 When 'wildmenu' is on, command-line completion operates in an enhanced
7127 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7128 the possible matches are shown just above the command line, with the
7129 first match highlighted (overwriting the status line, if there is
7130 one). Keys that show the previous/next match, such as <Tab> or
7131 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7132 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7133 specified. "longest" and "list" do not start "wildmenu" mode.
7134 If there are more matches than can fit in the line, a ">" is shown on
7135 the right and/or a "<" is shown on the left. The status line scrolls
7136 as needed.
7137 The "wildmenu" mode is abandoned when a key is hit that is not used
7138 for selecting a completion.
7139 While the "wildmenu" is active the following keys have special
7140 meanings:
7141
7142 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7143 <Down> - in filename/menu name completion: move into a
7144 subdirectory or submenu.
7145 <CR> - in menu completion, when the cursor is just after a
7146 dot: move into a submenu.
7147 <Up> - in filename/menu name completion: move up into
7148 parent directory or parent menu.
7149
7150 This makes the menus accessible from the console |console-menus|.
7151
7152 If you prefer the <Left> and <Right> keys to move the cursor instead
7153 of selecting a different match, use this: >
7154 :cnoremap <Left> <Space><BS><Left>
7155 :cnoremap <Right> <Space><BS><Right>
7156<
7157 The "WildMenu" highlighting is used for displaying the current match
7158 |hl-WildMenu|.
7159
7160 *'wildmode'* *'wim'*
7161'wildmode' 'wim' string (Vim default: "full")
7162 global
7163 {not in Vi}
7164 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007165 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar071d4272004-06-13 20:20:40 +00007166 part specifies what to do for each consecutive use of 'wildchar. The
7167 first part specifies the behavior for the first use of 'wildchar',
7168 The second part for the second use, etc.
7169 These are the possible values for each part:
7170 "" Complete only the first match.
7171 "full" Complete the next full match. After the last match,
7172 the original string is used and then the first match
7173 again.
7174 "longest" Complete till longest common string. If this doesn't
7175 result in a longer string, use the next part.
7176 "longest:full" Like "longest", but also start 'wildmenu' if it is
7177 enabled.
7178 "list" When more than one match, list all matches.
7179 "list:full" When more than one match, list all matches and
7180 complete first match.
7181 "list:longest" When more than one match, list all matches and
7182 complete till longest common string.
7183 When there is only a single match, it is fully completed in all cases.
7184
7185 Examples: >
7186 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007187< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007188 :set wildmode=longest,full
7189< Complete longest common string, then each full match >
7190 :set wildmode=list:full
7191< List all matches and complete each full match >
7192 :set wildmode=list,full
7193< List all matches without completing, then each full match >
7194 :set wildmode=longest,list
7195< Complete longest common string, then list alternatives.
7196
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007197 *'wildoptions'* *'wop'*
7198'wildoptions' 'wop' string (default "")
7199 global
7200 {not in Vi}
7201 {not available when compiled without the |+wildignore|
7202 feature}
7203 A list of words that change how command line completion is done.
7204 Currently only one word is allowed:
7205 tagfile When using CTRL-D to list matching tags, the kind of
7206 tag and the file of the tag is listed. Only one match
7207 is displayed per line. Often used tag kinds are:
7208 d #define
7209 f function
7210 Also see |cmdline-completion|.
7211
Bram Moolenaar071d4272004-06-13 20:20:40 +00007212 *'winaltkeys'* *'wak'*
7213'winaltkeys' 'wak' string (default "menu")
7214 global
7215 {not in Vi}
7216 {only used in Win32, Motif, GTK and Photon GUI}
7217 Some GUI versions allow the access to menu entries by using the ALT
7218 key in combination with a character that appears underlined in the
7219 menu. This conflicts with the use of the ALT key for mappings and
7220 entering special characters. This option tells what to do:
7221 no Don't use ALT keys for menus. ALT key combinations can be
7222 mapped, but there is no automatic handling. This can then be
7223 done with the |:simalt| command.
7224 yes ALT key handling is done by the windowing system. ALT key
7225 combinations cannot be mapped.
7226 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007227 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007228 keys can be mapped.
7229 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7230 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007231 This option is not used for <F10>; on Win32 and with GTK <F10> will
7232 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007233
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007234 *'window'* *'wi'*
7235'window' 'wi' number (default screen height - 1)
7236 global
7237 Window height. Do not confuse this with the height of the Vim window,
7238 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007239 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7240 value is smaller than 'lines' minus one. The screen will scroll
7241 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007242 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7243 in a much smarter way, taking care of wrapping lines.
7244 When resizing the Vim window, the value is smaller than 1 or more than
7245 or equal to 'lines' it will be set to 'lines' minus 1.
7246 {Vi also uses the option to specify the number of displayed lines}
7247
Bram Moolenaar071d4272004-06-13 20:20:40 +00007248 *'winheight'* *'wh'* *E591*
7249'winheight' 'wh' number (default 1)
7250 global
7251 {not in Vi}
7252 {not available when compiled without the +windows
7253 feature}
7254 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007255 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007256 current window is smaller, its size is increased, at the cost of the
7257 height of other windows. Set it to 999 to make the current window
7258 always fill the screen (although this has the drawback that ":all"
7259 will create only two windows). Set it to a small number for normal
7260 editing.
7261 Minimum value is 1.
7262 The height is not adjusted after one of the commands to change the
7263 height of the current window.
7264 'winheight' applies to the current window. Use 'winminheight' to set
7265 the minimal height for other windows.
7266
7267 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7268'winfixheight' 'wfh' boolean (default off)
7269 local to window
7270 {not in Vi}
7271 {not available when compiled without the +windows
7272 feature}
7273 Keep the window height when windows are opened or closed and
7274 'equalalways' is set. Set by default for the |preview-window| and
7275 |quickfix-window|.
7276 The height may be changed anyway when running out of room.
7277
7278 *'winminheight'* *'wmh'*
7279'winminheight' 'wmh' number (default 1)
7280 global
7281 {not in Vi}
7282 {not available when compiled without the +windows
7283 feature}
7284 The minimal height of a window, when it's not the current window.
7285 This is a hard minimum, windows will never become smaller.
7286 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7287 status bar) if necessary. They will return to at least one line when
7288 they become active (since the cursor has to have somewhere to go.)
7289 Use 'winheight' to set the minimal height of the current window.
7290 This option is only checked when making a window smaller. Don't use a
7291 large number, it will cause errors when opening more than a few
7292 windows. A value of 0 to 3 is reasonable.
7293
7294 *'winminwidth'* *'wmw'*
7295'winminwidth' 'wmw' number (default 1)
7296 global
7297 {not in Vi}
7298 {not available when compiled without the +vertsplit
7299 feature}
7300 The minimal width of a window, when it's not the current window.
7301 This is a hard minimum, windows will never become smaller.
7302 When set to zero, windows may be "squashed" to zero columns (i.e. just
7303 a vertical separator) if necessary. They will return to at least one
7304 line when they become active (since the cursor has to have somewhere
7305 to go.)
7306 Use 'winwidth' to set the minimal width of the current window.
7307 This option is only checked when making a window smaller. Don't use a
7308 large number, it will cause errors when opening more than a few
7309 windows. A value of 0 to 12 is reasonable.
7310
7311 *'winwidth'* *'wiw'* *E592*
7312'winwidth' 'wiw' number (default 20)
7313 global
7314 {not in Vi}
7315 {not available when compiled without the +vertsplit
7316 feature}
7317 Minimal number of columns for the current window. This is not a hard
7318 minimum, Vim will use fewer columns if there is not enough room. If
7319 the current window is smaller, its size is increased, at the cost of
7320 the width of other windows. Set it to 999 to make the current window
7321 always fill the screen. Set it to a small number for normal editing.
7322 The width is not adjusted after one of the commands to change the
7323 width of the current window.
7324 'winwidth' applies to the current window. Use 'winminwidth' to set
7325 the minimal width for other windows.
7326
7327 *'wrap'* *'nowrap'*
7328'wrap' boolean (default on)
7329 local to window
7330 {not in Vi}
7331 This option changes how text is displayed. It doesn't change the text
7332 in the buffer, see 'textwidth' for that.
7333 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007334 displaying continues on the next line. When off lines will not wrap
7335 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007336 moved to a part that is not shown, the screen will scroll
7337 horizontally.
7338 The line will be broken in the middle of a word if necessary. See
7339 'linebreak' to get the break at a word boundary.
7340 To make scrolling horizontally a bit more useful, try this: >
7341 :set sidescroll=5
7342 :set listchars+=precedes:<,extends:>
7343< See 'sidescroll', 'listchars' and |wrap-off|.
7344
7345 *'wrapmargin'* *'wm'*
7346'wrapmargin' 'wm' number (default 0)
7347 local to buffer
7348 Number of characters from the right window border where wrapping
7349 starts. When typing text beyond this limit, an <EOL> will be inserted
7350 and inserting continues on the next line.
7351 Options that add a margin, such as 'number' and 'foldcolumn', cause
7352 the text width to be further reduced. This is Vi compatible.
7353 When 'textwidth' is non-zero, this option is not used.
7354 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7355 and less usefully}
7356
7357 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7358'wrapscan' 'ws' boolean (default on) *E384* *E385*
7359 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00007360 Searches wrap around the end of the file. Also applies to |]s| and
7361 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007362
7363 *'write'* *'nowrite'*
7364'write' boolean (default on)
7365 global
7366 {not in Vi}
7367 Allows writing files. When not set, writing a file is not allowed.
7368 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007369 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007370 argument. Filtering text is still possible, even though this requires
7371 writing a temporary file.
7372
7373 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
7374'writeany' 'wa' boolean (default off)
7375 global
7376 Allows writing to any file with no need for "!" override.
7377
7378 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
7379'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
7380 otherwise)
7381 global
7382 {not in Vi}
7383 Make a backup before overwriting a file. The backup is removed after
7384 the file was successfully written, unless the 'backup' option is
7385 also on. Reset this option if your file system is almost full. See
7386 |backup-table| for another explanation.
7387 When the 'backupskip' pattern matches, a backup is not made anyway.
7388 NOTE: This option is set to the default value when 'compatible' is
7389 set.
7390
7391 *'writedelay'* *'wd'*
7392'writedelay' 'wd' number (default 0)
7393 global
7394 {not in Vi}
7395 The number of microseconds to wait for each character sent to the
7396 screen. When non-zero, characters are sent to the terminal one by
7397 one. For MS-DOS pcterm this does not work. For debugging purposes.
7398
7399 vim:tw=78:ts=8:ft=help:norl: