blob: c7ff8f5e418f625ea5f8f45717d8f8019843f441 [file] [log] [blame]
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001*options.txt* For Vim version 7.0aa. Last change: 2006 Mar 06
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*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000130For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000131override 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 Moolenaar7df351e2006-01-23 22:30:28 +0000165Similarly, the double quote character starts a comment. To include the '"' in
166the option value, use '\"' instead. This example sets the 'titlestring'
167option to 'hi "there"': >
168 :set titlestring=hi\ \"there\"
169
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000170For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000171precise: For options that expect a file name (those where environment
172variables are expanded) a backslash before a normal file name character is not
173removed. But a backslash before a special character (space, backslash, comma,
174etc.) is used like explained above.
175There is one special situation, when the value starts with "\\": >
176 :set dir=\\machine\path results in "\\machine\path"
177 :set dir=\\\\machine\\path results in "\\machine\path"
178 :set dir=\\path\\file results in "\\path\file" (wrong!)
179For the first one the start is kept, but for the second one the backslashes
180are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000181halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000182result which is probably not what you want. Avoid it.
183
184 *add-option-flags* *remove-option-flags*
185 *E539* *E550* *E551* *E552*
186Some options are a list of flags. When you want to add a flag to such an
187option, without changing the existing ones, you can do it like this: >
188 :set guioptions+=a
189Remove a flag from an option like this: >
190 :set guioptions-=a
191This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000192Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000193the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
194doesn't appear.
195
196 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000197Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000198environment variable exists the '$' and the following environment variable
199name is replaced with its value. If it does not exist the '$' and the name
200are not modified. Any non-id character (not a letter, digit or '_') may
201follow the environment variable name. That character and what follows is
202appended to the value of the environment variable. Examples: >
203 :set term=$TERM.new
204 :set path=/usr/$INCLUDE,$HOME/include,.
205When adding or removing a string from an option with ":set opt-=val" or ":set
206opt+=val" the expansion is done before the adding or removing.
207
208
209Handling of local options *local-options*
210
211Some of the options only apply to a window or buffer. Each window or buffer
212has its own copy of this option, thus can each have their own value. This
213allows you to set 'list' in one window but not in another. And set
214'shiftwidth' to 3 in one buffer and 4 in another.
215
216The following explains what happens to these local options in specific
217situations. You don't really need to know all of this, since Vim mostly uses
218the option values you would expect. Unfortunately, doing what the user
219expects is a bit complicated...
220
221When splitting a window, the local options are copied to the new window. Thus
222right after the split the contents of the two windows look the same.
223
224When editing a new buffer, its local option values must be initialized. Since
225the local options of the current buffer might be specifically for that buffer,
226these are not used. Instead, for each buffer-local option there also is a
227global value, which is used for new buffers. With ":set" both the local and
228global value is changed. With "setlocal" only the local value is changed,
229thus this value is not used when editing a new buffer.
230
231When editing a buffer that has been edited before, the last used window
232options are used again. If this buffer has been edited in this window, the
233values from back then are used. Otherwise the values from the window where
234the buffer was edited last are used.
235
236It's possible to set a local window option specifically for a type of buffer.
237When you edit another buffer in the same window, you don't want to keep
238using these local window options. Therefore Vim keeps a global value of the
239local window options, which is used when editing another buffer. Each window
240has its own copy of these values. Thus these are local to the window, but
241global to all buffers in the window. With this you can do: >
242 :e one
243 :set list
244 :e two
245Now the 'list' option will also be set in "two", since with the ":set list"
246command you have also set the global value. >
247 :set nolist
248 :e one
249 :setlocal list
250 :e two
251Now the 'list' option is not set, because ":set nolist" resets the global
252value, ":setlocal list" only changes the local value and ":e two" gets the
253global value. Note that if you do this next: >
254 :e one
255You will not get back the 'list' value as it was the last time you edited
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000256"one". The options local to a window are not remembered for each buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000257
258 *:setl* *:setlocal*
259:setl[ocal] ... Like ":set" but set only the value local to the
260 current buffer or window. Not all options have a
261 local value. If the option does not have a local
262 value the global value is set.
263 With the "all" argument: display all local option's
264 local values.
265 Without argument: Display all local option's local
266 values which are different from the default.
267 When displaying a specific local option, show the
268 local value. For a global option the global value is
269 shown (but that might change in the future).
270 {not in Vi}
271
272:setl[ocal] {option}< Set the local value of {option} to its global value.
273 {not in Vi}
274
275 *:setg* *:setglobal*
276:setg[lobal] ... Like ":set" but set only the global value for a local
277 option without changing the local value.
278 When displaying an option, the global value is shown.
279 With the "all" argument: display all local option's
280 global values.
281 Without argument: display all local option's global
282 values which are different from the default.
283 {not in Vi}
284
285For buffer-local and window-local options:
286 Command global value local value ~
287 :set option=value set set
288 :setlocal option=value - set
289:setglobal option=value set -
290 :set option? - display
291 :setlocal option? - display
292:setglobal option? display -
293
294
295Global options with a local value *global-local*
296
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000297Options are global when you mostly use one value for all buffers and windows.
298For some global options it's useful to sometimes have a different local value.
299You can set the local value with ":setlocal". That buffer or window will then
300use the local value, while other buffers and windows continue using the global
301value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000302
303For example, you have two windows, both on C source code. They use the global
304'makeprg' option. If you do this in one of the two windows: >
305 :set makeprg=gmake
306then the other window will switch to the same value. There is no need to set
307the 'makeprg' option in the other C source window too.
308However, if you start editing a Perl file in a new window, you want to use
309another 'makeprog' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000310files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000311 :setlocal makeprg=perlmake
312You can switch back to using the global value by making the local value empty: >
313 :setlocal makeprg=
314This only works for a string option. For a boolean option you need to use the
315"<" flag, like this: >
316 :setlocal autoread<
317Note that for non-boolean options using "<" copies the global value to the
318local value, it doesn't switch back to using the global value (that matters
319when changing the global value later).
320Note: In the future more global options can be made global-local. Using
321":setlocal" on a global option might work differently then.
322
323
324Setting the filetype
325
326:setf[iletype] {filetype} *:setf* *:setfiletype*
327 Set the 'filetype' option to {filetype}, but only if
328 not done yet in a sequence of (nested) autocommands.
329 This is short for: >
330 :if !did_filetype()
331 : setlocal filetype={filetype}
332 :endif
333< This command is used in a filetype.vim file to avoid
334 setting the 'filetype' option twice, causing different
335 settings and syntax files to be loaded.
336 {not in Vi}
337
338:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
339:opt[ions] Open a window for viewing and setting all options.
340 Options are grouped by function.
341 Offers short help for each option. Hit <CR> on the
342 short help to open a help window with more help for
343 the option.
344 Modify the value of the option and hit <CR> on the
345 "set" line to set the new value. For window and
346 buffer specific options, the last accessed window is
347 used to set the option value in, unless this is a help
348 window, in which case the window below help window is
349 used (skipping the option-window).
350 {not available when compiled without the |+eval| or
351 |+autocmd| features}
352
353 *$HOME*
354Using "~" is like using "$HOME", but it is only recognized at the start of an
355option and after a space or comma.
356
357On Unix systems "~user" can be used too. It is replaced by the home directory
358of user "user". Example: >
359 :set path=~mool/include,/usr/include,.
360
361On Unix systems the form "${HOME}" can be used too. The name between {} can
362contain non-id characters then. Note that if you want to use this for the
363"gf" command, you need to add the '{' and '}' characters to 'isfname'.
364
365NOTE: expanding environment variables and "~/" is only done with the ":set"
366command, not when assigning a value to an option with ":let".
367
368
369Note the maximum length of an expanded option is limited. How much depends on
370the system, mostly it is something like 256 or 1024 characters.
371
372 *:fix* *:fixdel*
373:fix[del] Set the value of 't_kD':
374 't_kb' is 't_kD' becomes ~
375 CTRL-? CTRL-H
376 not CTRL-? CTRL-?
377
378 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
379
380 If your delete key terminal code is wrong, but the
381 code for backspace is alright, you can put this in
382 your .vimrc: >
383 :fixdel
384< This works no matter what the actual code for
385 backspace is.
386
387 If the backspace key terminal code is wrong you can
388 use this: >
389 :if &term == "termname"
390 : set t_kb=^V<BS>
391 : fixdel
392 :endif
393< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000394 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000395 with your terminal name.
396
397 If your <Delete> key sends a strange key sequence (not
398 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
399 :if &term == "termname"
400 : set t_kD=^V<Delete>
401 :endif
402< Where "^V" is CTRL-V and "<Delete>" is the delete key
403 (don't type eight characters!). Replace "termname"
404 with your terminal name.
405
406 *Linux-backspace*
407 Note about Linux: By default the backspace key
408 produces CTRL-?, which is wrong. You can fix it by
409 putting this line in your rc.local: >
410 echo "keycode 14 = BackSpace" | loadkeys
411<
412 *NetBSD-backspace*
413 Note about NetBSD: If your backspace doesn't produce
414 the right code, try this: >
415 xmodmap -e "keycode 22 = BackSpace"
416< If this works, add this in your .Xmodmap file: >
417 keysym 22 = BackSpace
418< You need to restart for this to take effect.
419
420==============================================================================
4212. Automatically setting options *auto-setting*
422
423Besides changing options with the ":set" command, there are three alternatives
424to set options automatically for one or more files:
425
4261. When starting Vim initializations are read from various places. See
427 |initialization|. Most of them are performed for all editing sessions,
428 and some of them depend on the directory where Vim is started.
429 You can create an initialization file with |:mkvimrc|, |:mkview| and
430 |:mksession|.
4312. If you start editing a new file, the automatic commands are executed.
432 This can be used to set options for files matching a particular pattern and
433 many other things. See |autocommand|.
4343. If you start editing a new file, and the 'modeline' option is on, a
435 number of lines at the beginning and end of the file are checked for
436 modelines. This is explained here.
437
438 *modeline* *vim:* *vi:* *ex:* *E520*
439There are two forms of modelines. The first form:
440 [text]{white}{vi:|vim:|ex:}[white]{options}
441
442[text] any text or empty
443{white} at least one blank character (<Space> or <Tab>)
444{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
445[white] optional white space
446{options} a list of option settings, separated with white space or ':',
447 where each part between ':' is the argument for a ":set"
448 command
449
450Example: >
451 vi:noai:sw=3 ts=6
452
453The second form (this is compatible with some versions of Vi):
454
455 [text]{white}{vi:|vim:|ex:}[white]se[t] {options}:[text]
456
457[text] any text or empty
458{white} at least one blank character (<Space> or <Tab>)
459{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
460[white] optional white space
461se[t] the string "set " or "se " (note the space)
462{options} a list of options, separated with white space, which is the
463 argument for a ":set" command
464: a colon
465[text] any text or empty
466
467Example: >
468 /* vim: set ai tw=75: */
469
470The white space before {vi:|vim:|ex:} is required. This minimizes the chance
471that a normal word like "lex:" is caught. There is one exception: "vi:" and
472"vim:" can also be at the start of the line (for compatibility with version
4733.0). Using "ex:" at the start of the line will be ignored (this could be
474short for "example:").
475
476 *modeline-local*
477The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000478buffer and window that contain the file. Although it's possible to set global
479options from a modeline, this is unusual. If you have two windows open and
480the files in it set the same global option to a different value, the result
481depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000482
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000483When editing a file that was already loaded, only the window-local options
484from the modeline are used. Thus if you manually changed a buffer-local
485option after opening the file, it won't be changed if you edit the same buffer
486in another window. But window-local options will be set.
487
Bram Moolenaar071d4272004-06-13 20:20:40 +0000488 *modeline-version*
489If the modeline is only to be used for some versions of Vim, the version
490number can be specified where "vim:" is used:
491 vim{vers}: version {vers} or later
492 vim<{vers}: version before {vers}
493 vim={vers}: version {vers}
494 vim>{vers}: version after {vers}
495{vers} is 600 for Vim 6.0 (hundred times the major version plus minor).
496For example, to use a modeline only for Vim 6.0 and later: >
497 /* vim600: set foldmethod=marker: */
498To use a modeline for Vim before version 5.7: >
499 /* vim<570: set sw=4: */
500There can be no blanks between "vim" and the ":".
501
502
503The number of lines that are checked can be set with the 'modelines' option.
504If 'modeline' is off or 'modelines' is 0 no lines are checked.
505
506Note that for the first form all of the rest of the line is used, thus a line
507like: >
508 /* vi:ts=4: */
509will give an error message for the trailing "*/". This line is OK: >
510 /* vi:set ts=4: */
511
512If an error is detected the rest of the line is skipped.
513
514If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000515backslash in front of the ':' will be removed. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000516 /* vi:set dir=c\:\tmp: */
517This sets the 'dir' option to "c:\tmp". Only a single backslash before the
518':' is removed. Thus to include "\:" you have to specify "\\:".
519
520No other commands than "set" are supported, for security reasons (somebody
521might create a Trojan horse text file with modelines).
522
523Hint: If you would like to do something else than setting an option, you could
524define an autocommand that checks the file for a specific string. For
525example: >
526 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
527And define a function SetVar() that does something with the line containing
528"VAR".
529
530==============================================================================
5313. Options summary *option-summary*
532
533In the list below all the options are mentioned with their full name and with
534an abbreviation if there is one. Both forms may be used.
535
536In this document when a boolean option is "set" that means that ":set option"
537is entered. When an option is "reset", ":set nooption" is used.
538
539For some options there are two default values: The "Vim default", which is
540used when 'compatible' is not set, and the "Vi default", which is used when
541'compatible' is set.
542
543Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000544are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000545different value in each window. For example the 'list' option can be set in
546one window and reset in another for the same text, giving both types of view
547at the same time. There are a few options that are specific to a certain
548file. These can have a different value for each file or buffer. For example
549the 'textwidth' option can be 78 for a normal text file and 0 for a C
550program.
551
552 global one option for all buffers and windows
553 local to window each window has its own copy of this option
554 local to buffer each buffer has its own copy of this option
555
556When creating a new window the option values from the currently active window
557are used as a default value for the window-specific options. For the
558buffer-specific options this depends on the 's' and 'S' flags in the
559'cpoptions' option. If 's' is included (which is the default) the values for
560buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000561first entered. If 'S' is present the options are copied each time the buffer
562is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000563present, the options are copied from the currently active buffer when the
564buffer is created.
565
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000566Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000567
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000568Not all options are supported in all versions. This depends on the supported
569features and sometimes on the system. A remark about this is in curly braces
570below. When an option is not supported it may still be set without getting an
571error, this is called a hidden option. You can't get the value of a hidden
572option though, it is not stored.
573
574To test if option "foo" can be used with ":set" use something like this: >
575 if exists('&foo')
576This also returns true for a hidden option. To test if option "foo" is really
577supported use something like this: >
578 if exists('+foo')
579<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000580 *E355*
581A jump table for the options with a short description can be found at |Q_op|.
582
583 *'aleph'* *'al'* *aleph* *Aleph*
584'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
585 global
586 {not in Vi}
587 {only available when compiled with the |+rightleft|
588 feature}
589 The ASCII code for the first letter of the Hebrew alphabet. The
590 routine that maps the keyboard in Hebrew mode, both in Insert mode
591 (when hkmap is set) and on the command-line (when hitting CTRL-_)
592 outputs the Hebrew characters in the range [aleph..aleph+26].
593 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
594 See |rileft.txt|.
595
596 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
597'allowrevins' 'ari' boolean (default off)
598 global
599 {not in Vi}
600 {only available when compiled with the |+rightleft|
601 feature}
602 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
603 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
604 into reverse Insert mode, and don't know how to get out. See
605 'revins'.
606 NOTE: This option is reset when 'compatible' is set.
607
608 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
609'altkeymap' 'akm' boolean (default off)
610 global
611 {not in Vi}
612 {only available when compiled with the |+farsi|
613 feature}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000614 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000615 the keyboard map between Farsi and English, when 'allowrevins' set.
616
Bram Moolenaar582fd852005-03-28 20:58:01 +0000617 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000618 is useful to start the Vim in native mode i.e. English (left-to-right
619 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000620 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000621
622 *'ambiwidth'* *'ambw'*
623'ambiwidth' 'ambw' string (default: "single")
624 global
625 {not in Vi}
626 {only available when compiled with the |+multi_byte|
627 feature}
628 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
629 Tells Vim what to do with characters with East Asian Width Class
630 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
631 letters, Cyrillic letters).
632
633 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000634 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000635 expected by most users.
636 "double": Use twice the width of ASCII characters.
637
638 There are a number of CJK fonts for which the width of glyphs for
639 those characters are solely based on how many octets they take in
640 legacy/traditional CJK encodings. In those encodings, Euro,
641 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000642 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000643 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000644 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000645 Vim is running inside a terminal (emulators) that uses a CJK font
646 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
647 this option should be set to "double" to match the width perceived
648 by Vim with the width of glyphs in the font. Perhaps it also has
649 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
650 when the system locale is set to one of CJK locales. See Unicode
651 Standard Annex #11 (http://www.unicode.org/reports/tr11).
652
653 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
654'antialias' 'anti' boolean (default: off)
655 global
656 {not in Vi}
657 {only available when compiled with GUI enabled
658 on Mac OS X}
659 This option only has an effect in the GUI version of Vim on Mac OS X
660 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
661 which can be easier to read at certain sizes on certain displays.
662 Setting this option can sometimes cause problems if 'guifont' is set
663 to its default (empty string).
664
665 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
666'autochdir' 'acd' boolean (default off)
667 global
668 {not in Vi}
669 {only available when compiled with the
670 |+netbeans_intg| or |+sun_workshop| feature}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000671 When on, Vim will change the current working directory whenever you
672 open a file, switch buffers, delete a buffer or open/close a window.
673 It will change to the directory containing the file which was opened
674 or selected.
675 This option is provided for backward compatibility with the Vim
676 released with Sun ONE Studio 4 Enterprise Edition.
677 Note: When this option is on some plugins may not work. The directory
678 browser sets if off.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000679
680 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
681'arabic' 'arab' boolean (default off)
682 local to window
683 {not in Vi}
684 {only available when compiled with the |+arabic|
685 feature}
686 This option can be set to start editing Arabic text.
687 Setting this option will:
688 - Set the 'rightleft' option, unless 'termbidi' is set.
689 - Set the 'arabicshape' option, unless 'termbidi' is set.
690 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
691 between typing English and Arabic key mapping.
692 - Set the 'delcombine' option
693 Note that 'encoding' must be "utf-8" for working with Arabic text.
694
695 Resetting this option will:
696 - Reset the 'rightleft' option.
697 - Disable the use of 'keymap' (without changing its value).
698 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
699 option.
700 Also see |arabic.txt|.
701
702 *'arabicshape'* *'arshape'*
703 *'noarabicshape'* *'noarshape'*
704'arabicshape' 'arshape' boolean (default on)
705 global
706 {not in Vi}
707 {only available when compiled with the |+arabic|
708 feature}
709 When on and 'termbidi' is off, the required visual character
710 corrections that need to take place for displaying the Arabic language
711 take affect. Shaping, in essence, gets enabled; the term is a broad
712 one which encompasses:
713 a) the changing/morphing of characters based on their location
714 within a word (initial, medial, final and stand-alone).
715 b) the enabling of the ability to compose characters
716 c) the enabling of the required combining of some characters
717 When disabled the character display reverts back to each character's
718 true stand-alone form.
719 Arabic is a complex language which requires other settings, for
720 further details see |arabic.txt|.
721
722 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
723'autoindent' 'ai' boolean (default off)
724 local to buffer
725 Copy indent from current line when starting a new line (typing <CR>
726 in Insert mode or when using the "o" or "O" command). If you do not
727 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000728 <Esc> or <CR>, the indent is deleted again. Moving the cursor to
729 another line has the same effect, unless the 'I' flag is included in
730 'cpoptions'.
731 When autoindent is on, formatting (with the "gq" command or when you
732 reach 'textwidth' in Insert mode) uses the indentation of the first
733 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000734 When 'smartindent' or 'cindent' is on the indent is changed in
735 a different way.
736 The 'autoindent' option is reset when the 'paste' option is set.
737 {small difference from Vi: After the indent is deleted when typing
738 <Esc> or <CR>, the cursor position when moving up or down is after the
739 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
740
741 *'autoread'* *'ar'* *'noautoread'* *'noar'*
742'autoread' 'ar' boolean (default off)
743 global or local to buffer |global-local|
744 {not in Vi}
745 When a file has been detected to have been changed outside of Vim and
746 it has not been changed inside of Vim, automatically read it again.
747 When the file has been deleted this is not done. |timestamp|
748 If this option has a local value, use this command to switch back to
749 using the global value: >
750 :set autoread<
751<
752 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
753'autowrite' 'aw' boolean (default off)
754 global
755 Write the contents of the file, if it has been modified, on each
756 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
757 :make, CTRL-] and CTRL-^ command; and when a CTRL-O, CTRL-I,
758 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
759 Note that for some commands the 'autowrite' option is not used, see
760 'autowriteall' for that.
761
762 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
763'autowriteall' 'awa' boolean (default off)
764 global
765 {not in Vi}
766 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
767 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
768 Setting this option also implies that Vim behaves like 'autowrite' has
769 been set.
770
771 *'background'* *'bg'*
772'background' 'bg' string (default "dark" or "light")
773 global
774 {not in Vi}
775 When set to "dark", Vim will try to use colors that look good on a
776 dark background. When set to "light", Vim will try to use colors that
777 look good on a light background. Any other value is illegal.
778 Vim tries to set the default value according to the terminal used.
779 This will not always be correct.
780 Setting this option does not change the background color, it tells Vim
781 what the background color looks like. For changing the background
782 color, see |:hi-normal|.
783
784 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000785 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000786 change.
787 When a color scheme is loaded (the "colors_name" variable is set)
788 setting 'background' will cause the color scheme to be reloaded. If
789 the color scheme adjusts to the value of 'background' this will work.
790 However, if the color scheme sets 'background' itself the effect may
791 be undone. First delete the "colors_name" variable when needed.
792
793 When setting 'background' to the default value with: >
794 :set background&
795< Vim will guess the value. In the GUI this should work correctly,
796 in other cases Vim might not be able to guess the right value.
797
798 When starting the GUI, the default value for 'background' will be
799 "light". When the value is not set in the .gvimrc, and Vim detects
800 that the background is actually quite dark, 'background' is set to
801 "dark". But this happens only AFTER the .gvimrc file has been read
802 (because the window needs to be opened to find the actual background
803 color). To get around this, force the GUI window to be opened by
804 putting a ":gui" command in the .gvimrc file, before where the value
805 of 'background' is used (e.g., before ":syntax on").
806 Normally this option would be set in the .vimrc file. Possibly
807 depending on the terminal name. Example: >
808 :if &term == "pcterm"
809 : set background=dark
810 :endif
811< When this option is set, the default settings for the highlight groups
812 will change. To use other settings, place ":highlight" commands AFTER
813 the setting of the 'background' option.
814 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
815 to select the colors for syntax highlighting. After changing this
816 option, you must load syntax.vim again to see the result. This can be
817 done with ":syntax on".
818
819 *'backspace'* *'bs'*
820'backspace' 'bs' string (default "")
821 global
822 {not in Vi}
823 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
824 mode. This is a list of items, separated by commas. Each item allows
825 a way to backspace over something:
826 value effect ~
827 indent allow backspacing over autoindent
828 eol allow backspacing over line breaks (join lines)
829 start allow backspacing over the start of insert; CTRL-W and CTRL-U
830 stop once at the start of insert.
831
832 When the value is empty, Vi compatible backspacing is used.
833
834 For backwards compatibility with version 5.4 and earlier:
835 value effect ~
836 0 same as ":set backspace=" (Vi compatible)
837 1 same as ":set backspace=indent,eol"
838 2 same as ":set backspace=indent,eol,start"
839
840 See |:fixdel| if your <BS> or <Del> key does not do what you want.
841 NOTE: This option is set to "" when 'compatible' is set.
842
843 *'backup'* *'bk'* *'nobackup'* *'nobk'*
844'backup' 'bk' boolean (default off)
845 global
846 {not in Vi}
847 Make a backup before overwriting a file. Leave it around after the
848 file has been successfully written. If you do not want to keep the
849 backup file, but you do want a backup while the file is being
850 written, reset this option and set the 'writebackup' option (this is
851 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000852 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000853 |backup-table| for more explanations.
854 When the 'backupskip' pattern matches, a backup is not made anyway.
855 When 'patchmode' is set, the backup may be renamed to become the
856 oldest version of a file.
857 NOTE: This option is reset when 'compatible' is set.
858
859 *'backupcopy'* *'bkc'*
860'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
861 global
862 {not in Vi}
863 When writing a file and a backup is made, this option tells how it's
864 done. This is a comma separated list of words.
865
866 The main values are:
867 "yes" make a copy of the file and overwrite the original one
868 "no" rename the file and write a new one
869 "auto" one of the previous, what works best
870
871 Extra values that can be combined with the ones above are:
872 "breaksymlink" always break symlinks when writing
873 "breakhardlink" always break hardlinks when writing
874
875 Making a copy and overwriting the original file:
876 - Takes extra time to copy the file.
877 + When the file has special attributes, is a (hard/symbolic) link or
878 has a resource fork, all this is preserved.
879 - When the file is a link the backup will have the name of the link,
880 not of the real file.
881
882 Renaming the file and writing a new one:
883 + It's fast.
884 - Sometimes not all attributes of the file can be copied to the new
885 file.
886 - When the file is a link the new file will not be a link.
887
888 The "auto" value is the middle way: When Vim sees that renaming file
889 is possible without side effects (the attributes can be passed on and
890 and the file is not a link) that is used. When problems are expected,
891 a copy will be made.
892
893 The "breaksymlink" and "breakhardlink" values can be used in
894 combination with any of "yes", "no" and "auto". When included, they
895 force Vim to always break either symbolic or hard links by doing
896 exactly what the "no" option does, renaming the original file to
897 become the backup and writing a new file in its place. This can be
898 useful for example in source trees where all the files are symbolic or
899 hard links and any changes should stay in the local source tree, not
900 be propagated back to the original source.
901 *crontab*
902 One situation where "no" and "auto" will cause problems: A program
903 that opens a file, invokes Vim to edit that file, and then tests if
904 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000905 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000906 example.
907
908 When a copy is made, the original file is truncated and then filled
909 with the new text. This means that protection bits, owner and
910 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000911 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000912 group of the backup is set to the group of the original file. If this
913 fails, the protection bits for the group are made the same as for
914 others.
915
916 When the file is renamed this is the other way around: The backup has
917 the same attributes of the original file, and the newly written file
918 is owned by the current user. When the file was a (hard/symbolic)
919 link, the new file will not! That's why the "auto" value doesn't
920 rename when the file is a link. The owner and group of the newly
921 written file will be set to the same ones as the original file, but
922 the system may refuse to do this. In that case the "auto" value will
923 again not rename the file.
924
925 *'backupdir'* *'bdir'*
926'backupdir' 'bdir' string (default for Amiga: ".,t:",
927 for MS-DOS and Win32: ".,c:/tmp,c:/temp"
928 for Unix: ".,~/tmp,~/")
929 global
930 {not in Vi}
931 List of directories for the backup file, separated with commas.
932 - The backup file will be created in the first directory in the list
933 where this is possible.
934 - Empty means that no backup file will be created ('patchmode' is
935 impossible!). Writing may fail because of this.
936 - A directory "." means to put the backup file in the same directory
937 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +0000938 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000939 put the backup file relative to where the edited file is. The
940 leading "." is replaced with the path name of the edited file.
941 ("." inside a directory name has no special meaning).
942 - Spaces after the comma are ignored, other spaces are considered part
943 of the directory name. To have a space at the start of a directory
944 name, precede it with a backslash.
945 - To include a comma in a directory name precede it with a backslash.
946 - A directory name may end in an '/'.
947 - Environment variables are expanded |:set_env|.
948 - Careful with '\' characters, type one before a space, type two to
949 get one in the option (see |option-backslash|), for example: >
950 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
951< - For backwards compatibility with Vim version 3.0 a '>' at the start
952 of the option is removed.
953 See also 'backup' and 'writebackup' options.
954 If you want to hide your backup files on Unix, consider this value: >
955 :set backupdir=./.backup,~/.backup,.,/tmp
956< You must create a ".backup" directory in each directory and in your
957 home directory for this to work properly.
958 The use of |:set+=| and |:set-=| is preferred when adding or removing
959 directories from the list. This avoids problems when a future version
960 uses another default.
961 This option cannot be set from a |modeline| or in the |sandbox|, for
962 security reasons.
963
964 *'backupext'* *'bex'* *E589*
965'backupext' 'bex' string (default "~", for VMS: "_")
966 global
967 {not in Vi}
968 String which is appended to a file name to make the name of the
969 backup file. The default is quite unusual, because this avoids
970 accidentally overwriting existing files with a backup file. You might
971 prefer using ".bak", but make sure that you don't have files with
972 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000973 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000974
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +0000975 If you like to keep a lot of backups, you could use a BufWritePre
976 autocommand to change 'backupext' just before writing the file to
977 include a timestamp. >
978 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
979< Use 'backupdir' to put the backup in a different directory.
980
Bram Moolenaar071d4272004-06-13 20:20:40 +0000981 *'backupskip'* *'bsk'*
982'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
983 global
984 {not in Vi}
985 {not available when compiled without the |+wildignore|
986 feature}
987 A list of file patterns. When one of the patterns matches with the
988 name of the file which is written, no backup file is created. Both
989 the specified file name and the full path name of the file are used.
990 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
991 Watch out for special characters, see |option-backslash|.
992 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +0000993 default value. "/tmp/*" is only used for Unix.
Bram Moolenaara5792f52005-11-23 21:25:05 +0000994 Note that the default also makes sure that "crontab -e" works (when a
995 backup would be made by renaming the original file crontab won't see
996 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000997
998 *'balloondelay'* *'bdlay'*
999'balloondelay' 'bdlay' number (default: 600)
1000 global
1001 {not in Vi}
1002 {only available when compiled with the |+balloon_eval|
1003 feature}
1004 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1005
1006 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1007'ballooneval' 'beval' boolean (default off)
1008 global
1009 {not in Vi}
1010 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001011 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001012 Switch on the |balloon-eval| functionality.
1013
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001014 *'balloonexpr'* *'bexpr'*
1015'balloonexpr' 'bexpr' string (default "")
1016 global
1017 {not in Vi}
1018 {only available when compiled with the |+balloon_eval|
1019 feature}
1020 Expression to show in evaluation balloon. It is only used when
1021 'ballooneval' is on. These variables can be used:
1022
1023 v:beval_bufnr number of the buffer in which balloon is going to show
1024 v:beval_winnr number of the window
1025 v:beval_lnum line number
1026 v:beval_col column number (byte index)
1027 v:beval_text word under or after the mouse pointer
1028
1029 The evaluation of the expression must not have side effects!
1030 Example: >
1031 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001032 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001033 \', column ' . v:beval_col .
1034 \ ' of file ' . bufname(v:beval_bufnr) .
1035 \ ' on word "' . v:beval_text . '"'
1036 endfunction
1037 set bexpr=MyBalloonExpr()
1038 set ballooneval
1039<
1040 NOTE: The balloon is displayed only if the cursor is on a text
1041 character. If the result of evaluating 'balloonexpr' is not empty,
1042 Vim does not try to send a message to an external debugger (Netbeans
1043 or Sun Workshop).
1044
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001045 The expression may be evaluated in the |sandbox|, see
1046 |sandbox-option|.
1047
1048 It is not allowed to change text or jump to another window while
1049 evaluating 'balloonexpr' |textlock|.
1050
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001051 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001052 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001053< When they are supported "\n" characters will start a new line. If the
1054 expression evaluates to a |List| this is equal to using each List item
1055 as a string and putting "\n" in between them.
1056
Bram Moolenaar071d4272004-06-13 20:20:40 +00001057 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1058'binary' 'bin' boolean (default off)
1059 local to buffer
1060 {not in Vi}
1061 This option should be set before editing a binary file. You can also
1062 use the |-b| Vim argument. When this option is switched on a few
1063 options will be changed (also when it already was on):
1064 'textwidth' will be set to 0
1065 'wrapmargin' will be set to 0
1066 'modeline' will be off
1067 'expandtab' will be off
1068 Also, 'fileformat' and 'fileformats' options will not be used, the
1069 file is read and written like 'fileformat' was "unix" (a single <NL>
1070 separates lines).
1071 The 'fileencoding' and 'fileencodings' options will not be used, the
1072 file is read without conversion.
1073 NOTE: When you start editing a(nother) file while the 'bin' option is
1074 on, settings from autocommands may change the settings again (e.g.,
1075 'textwidth'), causing trouble when editing. You might want to set
1076 'bin' again when the file has been loaded.
1077 The previous values of these options are remembered and restored when
1078 'bin' is switched from on to off. Each buffer has its own set of
1079 saved option values.
1080 To edit a file with 'binary' set you can use the |++bin| argument.
1081 This avoids you have to do ":set bin", which would have effect for all
1082 files you edit.
1083 When writing a file the <EOL> for the last line is only written if
1084 there was one in the original file (normally Vim appends an <EOL> to
1085 the last line if there is none; this would make the file longer). See
1086 the 'endofline' option.
1087
1088 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1089'bioskey' 'biosk' boolean (default on)
1090 global
1091 {not in Vi} {only for MS-DOS}
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001092 When on the BIOS is called to obtain a keyboard character. This works
Bram Moolenaar071d4272004-06-13 20:20:40 +00001093 better to detect CTRL-C, but only works for the console. When using a
1094 terminal over a serial port reset this option.
1095 Also see |'conskey'|.
1096
1097 *'bomb'* *'nobomb'*
1098'bomb' boolean (default off)
1099 local to buffer
1100 {not in Vi}
1101 {only available when compiled with the |+multi_byte|
1102 feature}
1103 When writing a file and the following conditions are met, a BOM (Byte
1104 Order Mark) is prepended to the file:
1105 - this option is on
1106 - the 'binary' option is off
1107 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1108 endian variants.
1109 Some applications use the BOM to recognize the encoding of the file.
1110 Often used for UCS-2 files on MS-Windows. For other applications it
1111 causes trouble, for example: "cat file1 file2" makes the BOM of file2
1112 appear halfway the resulting file.
1113 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1114 check for the presence of the BOM is done and 'bomb' set accordingly.
1115 Unless 'binary' is set, it is removed from the first line, so that you
1116 don't see it when editing. When you don't change the options, the BOM
1117 will be restored when writing the file.
1118
1119 *'breakat'* *'brk'*
1120'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1121 global
1122 {not in Vi}
1123 {not available when compiled without the |+linebreak|
1124 feature}
1125 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001126 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1127 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001128
1129 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001130'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001131 global
1132 {not in Vi} {only for Motif and Win32 GUI}
1133 Which directory to use for the file browser:
1134 last Use same directory as with last file browser.
1135 buffer Use the directory of the related buffer.
1136 current Use the current directory.
1137 {path} Use the specified directory
1138
1139 *'bufhidden'* *'bh'*
1140'bufhidden' 'bh' string (default: "")
1141 local to buffer
1142 {not in Vi}
1143 {not available when compiled without the |+quickfix|
1144 feature}
1145 This option specifies what happens when a buffer is no longer
1146 displayed in a window:
1147 <empty> follow the global 'hidden' option
1148 hide hide the buffer (don't unload it), also when 'hidden'
1149 is not set
1150 unload unload the buffer, also when 'hidden' is set or using
1151 |:hide|
1152 delete delete the buffer from the buffer list, also when
1153 'hidden' is set or using |:hide|, like using
1154 |:bdelete|
1155 wipe wipe out the buffer from the buffer list, also when
1156 'hidden' is set or using |:hide|, like using
1157 |:bwipeout|
1158
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001159 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
1160 are lost without a warning.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001161 This option is used together with 'buftype' and 'swapfile' to specify
1162 special kinds of buffers. See |special-buffers|.
1163
1164 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1165'buflisted' 'bl' boolean (default: on)
1166 local to buffer
1167 {not in Vi}
1168 When this option is set, the buffer shows up in the buffer list. If
1169 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1170 This option is reset by Vim for buffers that are only used to remember
1171 a file name or marks. Vim sets it when starting to edit a buffer.
1172 But not when moving to a buffer with ":buffer".
1173
1174 *'buftype'* *'bt'* *E382*
1175'buftype' 'bt' string (default: "")
1176 local to buffer
1177 {not in Vi}
1178 {not available when compiled without the |+quickfix|
1179 feature}
1180 The value of this option specifies the type of a buffer:
1181 <empty> normal buffer
1182 nofile buffer which is not related to a file and will not be
1183 written
1184 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001185 acwrite buffer which will always be written with BufWriteCmd
1186 autocommands. {not available when compiled without the
1187 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001188 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001189 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001190 help help buffer (you are not supposed to set this
1191 manually)
1192
1193 This option is used together with 'bufhidden' and 'swapfile' to
1194 specify special kinds of buffers. See |special-buffers|.
1195
1196 Be careful with changing this option, it can have many side effects!
1197
Bram Moolenaar280f1262006-01-30 00:14:18 +00001198 A "quickfix" buffer is only used for the error list and the location
1199 list. This value is set by the |:cwindow| and |:lwindow| commands and
1200 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001201
1202 "nofile" and "nowrite" buffers are similar:
1203 both: The buffer is not to be written to disk, ":w" doesn't
1204 work (":w filename" does work though).
1205 both: The buffer is never considered to be |'modified'|.
1206 There is no warning when the changes will be lost, for
1207 example when you quit Vim.
1208 both: A swap file is only created when using too much memory
1209 (when 'swapfile' has been reset there is never a swap
1210 file).
1211 nofile only: The buffer name is fixed, it is not handled like a
1212 file name. It is not modified in response to a |:cd|
1213 command.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001214 *E676*
1215 "acwrite" implies that the buffer name is not related to a file, like
1216 "nofile", but it will be written. Thus, in contrast to "nofile" and
1217 "nowrite", ":w" does work and a modified buffer can't be abandoned
1218 without saving. For writing there must be matching |BufWriteCmd|,
1219 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001220
1221 *'casemap'* *'cmp'*
1222'casemap' 'cmp' string (default: "internal,keepascii")
1223 global
1224 {not in Vi}
1225 Specifies details about changing the case of letters. It may contain
1226 these words, separated by a comma:
1227 internal Use internal case mapping functions, the current
1228 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001229 matters when 'encoding' is a Unicode encoding,
1230 "latin1" or "iso-8859-15". When "internal" is
1231 omitted, the towupper() and towlower() system library
1232 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001233 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1234 case mapping, the current locale is not effective.
1235 This probably only matters for Turkish.
1236
1237 *'cdpath'* *'cd'* *E344* *E346*
1238'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1239 global
1240 {not in Vi}
1241 {not available when compiled without the
1242 |+file_in_path| feature}
1243 This is a list of directories which will be searched when using the
1244 |:cd| and |:lcd| commands, provided that the directory being searched
1245 for has a relative path (not starting with "/", "./" or "../").
1246 The 'cdpath' option's value has the same form and semantics as
1247 |'path'|. Also see |file-searching|.
1248 The default value is taken from $CDPATH, with a "," prepended to look
1249 in the current directory first.
1250 If the default value taken from $CDPATH is not what you want, include
1251 a modified version of the following command in your vimrc file to
1252 override it: >
1253 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1254< This option cannot be set from a |modeline| or in the |sandbox|, for
1255 security reasons.
1256 (parts of 'cdpath' can be passed to the shell to expand file names).
1257
1258 *'cedit'*
1259'cedit' string (Vi default: "", Vim default: CTRL-F)
1260 global
1261 {not in Vi}
1262 {not available when compiled without the |+vertsplit|
1263 feature}
1264 The key used in Command-line Mode to open the command-line window.
1265 The default is CTRL-F when 'compatible' is off.
1266 Only non-printable keys are allowed.
1267 The key can be specified as a single character, but it is difficult to
1268 type. The preferred way is to use the <> notation. Examples: >
1269 :set cedit=<C-Y>
1270 :set cedit=<Esc>
1271< |Nvi| also has this option, but it only uses the first character.
1272 See |cmdwin|.
1273
1274 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1275'charconvert' 'ccv' string (default "")
1276 global
1277 {only available when compiled with the |+multi_byte|
1278 feature and the |+eval| feature}
1279 {not in Vi}
1280 An expression that is used for character encoding conversion. It is
1281 evaluated when a file that is to be read or has been written has a
1282 different encoding from what is desired.
1283 'charconvert' is not used when the internal iconv() function is
1284 supported and is able to do the conversion. Using iconv() is
1285 preferred, because it is much faster.
1286 'charconvert' is not used when reading stdin |--|, because there is no
1287 file to convert from. You will have to save the text in a file first.
1288 The expression must return zero or an empty string for success,
1289 non-zero for failure.
1290 The possible encoding names encountered are in 'encoding'.
1291 Additionally, names given in 'fileencodings' and 'fileencoding' are
1292 used.
1293 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1294 is done internally by Vim, 'charconvert' is not used for this.
1295 'charconvert' is also used to convert the viminfo file, if the 'c'
1296 flag is present in 'viminfo'. Also used for Unicode conversion.
1297 Example: >
1298 set charconvert=CharConvert()
1299 fun CharConvert()
1300 system("recode "
1301 \ . v:charconvert_from . ".." . v:charconvert_to
1302 \ . " <" . v:fname_in . " >" v:fname_out)
1303 return v:shell_error
1304 endfun
1305< The related Vim variables are:
1306 v:charconvert_from name of the current encoding
1307 v:charconvert_to name of the desired encoding
1308 v:fname_in name of the input file
1309 v:fname_out name of the output file
1310 Note that v:fname_in and v:fname_out will never be the same.
1311 Note that v:charconvert_from and v:charconvert_to may be different
1312 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1313 Encryption is not done by Vim when using 'charconvert'. If you want
1314 to encrypt the file after conversion, 'charconvert' should take care
1315 of this.
1316 This option cannot be set from a |modeline| or in the |sandbox|, for
1317 security reasons.
1318
1319 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1320'cindent' 'cin' boolean (default off)
1321 local to buffer
1322 {not in Vi}
1323 {not available when compiled without the |+cindent|
1324 feature}
1325 Enables automatic C program indenting See 'cinkeys' to set the keys
1326 that trigger reindenting in insert mode and 'cinoptions' to set your
1327 preferred indent style.
1328 If 'indentexpr' is not empty, it overrules 'cindent'.
1329 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1330 the "=" operator indents using this algorithm rather than calling an
1331 external program.
1332 See |C-indenting|.
1333 When you don't like the way 'cindent' works, try the 'smartindent'
1334 option or 'indentexpr'.
1335 This option is not used when 'paste' is set.
1336 NOTE: This option is reset when 'compatible' is set.
1337
1338 *'cinkeys'* *'cink'*
1339'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1340 local to buffer
1341 {not in Vi}
1342 {not available when compiled without the |+cindent|
1343 feature}
1344 A list of keys that, when typed in Insert mode, cause reindenting of
1345 the current line. Only used if 'cindent' is on and 'indentexpr' is
1346 empty.
1347 For the format of this option see |cinkeys-format|.
1348 See |C-indenting|.
1349
1350 *'cinoptions'* *'cino'*
1351'cinoptions' 'cino' string (default "")
1352 local to buffer
1353 {not in Vi}
1354 {not available when compiled without the |+cindent|
1355 feature}
1356 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1357 program. See |cinoptions-values| for the values of this option, and
1358 |C-indenting| for info on C indenting in general.
1359
1360
1361 *'cinwords'* *'cinw'*
1362'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1363 local to buffer
1364 {not in Vi}
1365 {not available when compiled without both the
1366 |+cindent| and the |+smartindent| features}
1367 These keywords start an extra indent in the next line when
1368 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1369 an appropriate place (inside {}).
1370 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1371 matter, include the keyword both the uppercase and lowercase:
1372 "if,If,IF".
1373
1374 *'clipboard'* *'cb'*
1375'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1376 for X-windows, "" otherwise)
1377 global
1378 {not in Vi}
1379 {only in GUI versions or when the |+xterm_clipboard|
1380 feature is included}
1381 This option is a list of comma separated names.
1382 These names are recognized:
1383
1384 unnamed When included, Vim will use the clipboard register '*'
1385 for all yank, delete, change and put operations which
1386 would normally go to the unnamed register. When a
1387 register is explicitly specified, it will always be
1388 used regardless of whether "unnamed" is in 'clipboard'
1389 or not. The clipboard register can always be
1390 explicitly accessed using the "* notation. Also see
1391 |gui-clipboard|.
1392
1393 autoselect Works like the 'a' flag in 'guioptions': If present,
1394 then whenever Visual mode is started, or the Visual
1395 area extended, Vim tries to become the owner of the
1396 windowing system's global selection or put the
1397 selected text on the clipboard used by the selection
1398 register "*. See |guioptions_a| and |quotestar| for
1399 details. When the GUI is active, the 'a' flag in
1400 'guioptions' is used, when the GUI is not active, this
1401 "autoselect" flag is used.
1402 Also applies to the modeless selection.
1403
1404 autoselectml Like "autoselect", but for the modeless selection
1405 only. Compare to the 'A' flag in 'guioptions'.
1406
1407 exclude:{pattern}
1408 Defines a pattern that is matched against the name of
1409 the terminal 'term'. If there is a match, no
1410 connection will be made to the X server. This is
1411 useful in this situation:
1412 - Running Vim in a console.
1413 - $DISPLAY is set to start applications on another
1414 display.
1415 - You do not want to connect to the X server in the
1416 console, but do want this in a terminal emulator.
1417 To never connect to the X server use: >
1418 exclude:.*
1419< This has the same effect as using the |-X| argument.
1420 Note that when there is no connection to the X server
1421 the window title won't be restored and the clipboard
1422 cannot be accessed.
1423 The value of 'magic' is ignored, {pattern} is
1424 interpreted as if 'magic' was on.
1425 The rest of the option value will be used for
1426 {pattern}, this must be the last entry.
1427
1428 *'cmdheight'* *'ch'*
1429'cmdheight' 'ch' number (default 1)
1430 global
1431 {not in Vi}
1432 Number of screen lines to use for the command-line. Helps avoiding
1433 |hit-enter| prompts.
1434
1435 *'cmdwinheight'* *'cwh'*
1436'cmdwinheight' 'cwh' number (default 7)
1437 global
1438 {not in Vi}
1439 {not available when compiled without the |+vertsplit|
1440 feature}
1441 Number of screen lines to use for the command-line window. |cmdwin|
1442
1443 *'columns'* *'co'* *E594*
1444'columns' 'co' number (default 80 or terminal width)
1445 global
1446 {not in Vi}
1447 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001448 initialization and does not have to be set by hand. Also see
1449 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001450 When Vim is running in the GUI or in a resizable window, setting this
1451 option will cause the window size to be changed. When you only want
1452 to use the size for the GUI, put the command in your |gvimrc| file.
1453 When you set this option and Vim is unable to change the physical
1454 number of columns of the display, the display may be messed up.
Bram Moolenaarf4d11452005-12-02 00:46:37 +00001455 Mimimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001456
1457 *'comments'* *'com'* *E524* *E525*
1458'comments' 'com' string (default
1459 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1460 local to buffer
1461 {not in Vi}
1462 {not available when compiled without the |+comments|
1463 feature}
1464 A comma separated list of strings that can start a comment line. See
1465 |format-comments|. See |option-backslash| about using backslashes to
1466 insert a space.
1467
1468 *'commentstring'* *'cms'* *E537*
1469'commentstring' 'cms' string (default "/*%s*/")
1470 local to buffer
1471 {not in Vi}
1472 {not available when compiled without the |+folding|
1473 feature}
1474 A template for a comment. The "%s" in the value is replaced with the
1475 comment text. Currently only used to add markers for folding, see
1476 |fold-marker|.
1477
1478 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaard042c562005-06-30 22:04:15 +00001479'compatible' 'cp' boolean (default on, off when a .vimrc or .gvimrc file
1480 is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001481 global
1482 {not in Vi}
1483 This option has the effect of making Vim either more Vi-compatible, or
1484 make Vim behave in a more useful way.
1485 This is a special kind of option, because when it's set or reset,
1486 other options are also changed as a side effect. CAREFUL: Setting or
1487 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001488 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001489 set this option in your vimrc file, you should probably put it at the
1490 very start.
1491 By default this option is on and the Vi defaults are used for the
1492 options. This default was chosen for those people who want to use Vim
1493 just like Vi, and don't even (want to) know about the 'compatible'
1494 option.
Bram Moolenaard042c562005-06-30 22:04:15 +00001495 When a ".vimrc" or ".gvimrc" file is found while Vim is starting up,
1496 this option is switched off, and all options that have not been
1497 modified will be set to the Vim defaults. Effectively, this means
1498 that when a ".vimrc" or ".gvimrc" file exists, Vim will use the Vim
1499 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
1500 happen for the system-wide vimrc or gvimrc file). Also see
1501 |compatible-default| and |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001502 You can also set this option with the "-C" argument, and reset it with
1503 "-N". See |-C| and |-N|.
1504 Switching this option off makes the Vim defaults be used for options
1505 that have a different Vi and Vim default value. See the options
1506 marked with a '+' below. Other options are not modified.
1507 At the moment this option is set, several other options will be set
1508 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001509 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001510 editing.
1511 See also 'cpoptions'.
1512
1513 option + set value effect ~
1514
1515 'allowrevins' off no CTRL-_ command
1516 'backupcopy' Unix: "yes" backup file is a copy
1517 others: "auto" copy or rename backup file
1518 'backspace' "" normal backspace
1519 'backup' off no backup file
1520 'cindent' off no C code indentation
1521 'cedit' + "" no key to open the |cmdwin|
1522 'cpoptions' + (all flags) Vi-compatible flags
1523 'cscopetag' off don't use cscope for ":tag"
1524 'cscopetagorder' 0 see |cscopetagorder|
1525 'cscopeverbose' off see |cscopeverbose|
1526 'digraph' off no digraphs
1527 'esckeys' + off no <Esc>-keys in Insert mode
1528 'expandtab' off tabs not expanded to spaces
1529 'fileformats' + "" no automatic file format detection,
1530 "dos,unix" except for DOS, Windows and OS/2
1531 'formatoptions' + "vt" Vi compatible formatting
1532 'gdefault' off no default 'g' flag for ":s"
1533 'history' + 0 no commandline history
1534 'hkmap' off no Hebrew keyboard mapping
1535 'hkmapp' off no phonetic Hebrew keyboard mapping
1536 'hlsearch' off no highlighting of search matches
1537 'incsearch' off no incremental searching
1538 'indentexpr' "" no indenting by expression
1539 'insertmode' off do not start in Insert mode
1540 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1541 characters and '_'
1542 'joinspaces' on insert 2 spaces after period
1543 'modeline' + off no modelines
1544 'more' + off no pauses in listings
1545 'revins' off no reverse insert
1546 'ruler' off no ruler
1547 'scrolljump' 1 no jump scroll
1548 'scrolloff' 0 no scroll offset
1549 'shiftround' off indent not rounded to shiftwidth
1550 'shortmess' + "" no shortening of messages
1551 'showcmd' + off command characters not shown
1552 'showmode' + off current mode not shown
1553 'smartcase' off no automatic ignore case switch
1554 'smartindent' off no smart indentation
1555 'smarttab' off no smart tab size
1556 'softtabstop' 0 tabs are always 'tabstop' positions
1557 'startofline' on goto startofline with some commands
1558 'tagrelative' + off tag file names are not relative
1559 'textauto' + off no automatic textmode detection
1560 'textwidth' 0 no automatic line wrap
1561 'tildeop' off tilde is not an operator
1562 'ttimeout' off no terminal timeout
1563 'whichwrap' + "" left-right movements don't wrap
1564 'wildchar' + CTRL-E only when the current value is <Tab>
1565 use CTRL-E for cmdline completion
1566 'writebackup' on or off depends on +writebackup feature
1567
1568 *'complete'* *'cpt'* *E535*
1569'complete' 'cpt' string (default: ".,w,b,u,t,i")
1570 local to buffer
1571 {not in Vi}
1572 This option specifies how keyword completion |ins-completion| works
1573 when CTRL-P or CTRL-N are used. It is also used for whole-line
1574 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1575 and the places to scan. It is a comma separated list of flags:
1576 . scan the current buffer ('wrapscan' is ignored)
1577 w scan buffers from other windows
1578 b scan other loaded buffers that are in the buffer list
1579 u scan the unloaded buffers that are in the buffer list
1580 U scan the buffers that are not in the buffer list
1581 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001582 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001583 k{dict} scan the file {dict}. Several "k" flags can be given,
1584 patterns are valid too. For example: >
1585 :set cpt=k/usr/dict/*,k~/spanish
1586< s scan the files given with the 'thesaurus' option
1587 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1588 are valid too.
1589 i scan current and included files
1590 d scan current and included files for defined name or macro
1591 |i_CTRL-X_CTRL-D|
1592 ] tag completion
1593 t same as "]"
1594
1595 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1596 not executed, this may lead to unexpected completions from some files
1597 (gzipped files for example). Unloaded buffers are not scanned for
1598 whole-line completion.
1599
1600 The default is ".,w,b,u,t,i", which means to scan:
1601 1. the current buffer
1602 2. buffers in other windows
1603 3. other loaded buffers
1604 4. unloaded buffers
1605 5. tags
1606 6. included files
1607
1608 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001609 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1610 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001611
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001612 *'completefunc'* *'cfu'*
1613'completefunc' 'cfu' string (default: empty)
1614 local to buffer
1615 {not in Vi}
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001616 {not available when compiled without the +eval
1617 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001618 This option specifies a function to be used for Insert mode completion
1619 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001620 See |complete-functions| for an explanation of how the function is
1621 invoked and what it should return.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001622
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001623
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001624 *'completeopt'* *'cot'*
1625'completeopt' 'cot' string (default: "menu")
1626 global
1627 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001628 A comma separated list of options for Insert mode completion
1629 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001630
1631 menu Use a popup menu to show the possible completions. The
1632 menu is only shown when there is more than one match and
1633 sufficient colors are available. |ins-completion-menu|
1634
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001635 menuone Use the popup menu also when there is only one match.
1636 Useful when there is additional information about the
1637 match, e.g., what file it comes from.
1638
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001639 longest Only insert the longest common text of the matches. Use
Bram Moolenaard1f56e62006-02-22 21:25:37 +00001640 CTRL-L to add more characters. Whether case is ignored
1641 depends on the kind of completion. For buffer text the
1642 'ignorecase' option is used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001643
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001644
Bram Moolenaar071d4272004-06-13 20:20:40 +00001645 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1646'confirm' 'cf' boolean (default off)
1647 global
1648 {not in Vi}
1649 When 'confirm' is on, certain operations that would normally
1650 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1651 instead raise a |dialog| asking if you wish to save the current
1652 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1653 If 'confirm' is off you can still activate confirmation for one
1654 command only (this is most useful in mappings) with the |:confirm|
1655 command.
1656 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1657
1658 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1659'conskey' 'consk' boolean (default off)
1660 global
1661 {not in Vi} {only for MS-DOS}
1662 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001663 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001664 three methods of console input are available:
1665 'conskey' 'bioskey' action ~
1666 on on or off direct console input
1667 off on BIOS
1668 off off STDIN
1669
1670 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1671'copyindent' 'ci' boolean (default off)
1672 local to buffer
1673 {not in Vi}
1674 Copy the structure of the existing lines indent when autoindenting a
1675 new line. Normally the new indent is reconstructed by a series of
1676 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1677 in which case only spaces are used). Enabling this option makes the
1678 new line copy whatever characters were used for indenting on the
1679 existing line. If the new indent is greater than on the existing
1680 line, the remaining space is filled in the normal manner.
1681 NOTE: 'copyindent' is reset when 'compatible' is set.
1682 Also see 'preserveindent'.
1683
1684 *'cpoptions'* *'cpo'*
1685'cpoptions' 'cpo' string (Vim default: "aABceFs",
1686 Vi default: all flags)
1687 global
1688 {not in Vi}
1689 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001690 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001691 not being vi-compatible is mostly or sometimes preferred.
1692 'cpoptions' stands for "compatible-options".
1693 Commas can be added for readability.
1694 To avoid problems with flags that are added in the future, use the
1695 "+=" and "-=" feature of ":set" |add-option-flags|.
1696 NOTE: This option is set to the Vi default value when 'compatible' is
1697 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001698 NOTE: This option is set to the POSIX default value at startup when
1699 the Vi default value would be used and the $VIM_POSIX environment
1700 variable exists |posix|. This means tries to behave like the POSIX
1701 specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001702
1703 contains behavior ~
1704 *cpo-a*
1705 a When included, a ":read" command with a file name
1706 argument will set the alternate file name for the
1707 current window.
1708 *cpo-A*
1709 A When included, a ":write" command with a file name
1710 argument will set the alternate file name for the
1711 current window.
1712 *cpo-b*
1713 b "\|" in a ":map" command is recognized as the end of
1714 the map command. The '\' is included in the mapping,
1715 the text after the '|' is interpreted as the next
1716 command. Use a CTRL-V instead of a backslash to
1717 include the '|' in the mapping. Applies to all
1718 mapping, abbreviation, menu and autocmd commands.
1719 See also |map_bar|.
1720 *cpo-B*
1721 B A backslash has no special meaning in mappings,
1722 abbreviations and the "to" part of the menu commands.
1723 Remove this flag to be able to use a backslash like a
1724 CTRL-V. For example, the command ":map X \<Esc>"
1725 results in X being mapped to:
1726 'B' included: "\^[" (^[ is a real <Esc>)
1727 'B' excluded: "<Esc>" (5 characters)
1728 ('<' excluded in both cases)
1729 *cpo-c*
1730 c Searching continues at the end of any match at the
1731 cursor position, but not further than the start of the
1732 next line. When not present searching continues
1733 one character from the cursor position. With 'c'
1734 "abababababab" only gets three matches when repeating
1735 "/abab", without 'c' there are five matches.
1736 *cpo-C*
1737 C Do not concatenate sourced lines that start with a
1738 backslash. See |line-continuation|.
1739 *cpo-d*
1740 d Using "./" in the 'tags' option doesn't mean to use
1741 the tags file relative to the current file, but the
1742 tags file in the current directory.
1743 *cpo-D*
1744 D Can't use CTRL-K to enter a digraph after Normal mode
1745 commands with a character argument, like |r|, |f| and
1746 |t|.
1747 *cpo-e*
1748 e When executing a register with ":@r", always add a
1749 <CR> to the last line, also when the register is not
1750 linewise. If this flag is not present, the register
1751 is not linewise and the last line does not end in a
1752 <CR>, then the last line is put on the command-line
1753 and can be edited before hitting <CR>.
1754 *cpo-E*
1755 E It is an error when using "y", "d", "c", "g~", "gu" or
1756 "gU" on an Empty region. The operators only work when
1757 at least one character is to be operate on. Example:
1758 This makes "y0" fail in the first column.
1759 *cpo-f*
1760 f When included, a ":read" command with a file name
1761 argument will set the file name for the current buffer,
1762 if the current buffer doesn't have a file name yet.
1763 *cpo-F*
1764 F When included, a ":write" command with a file name
1765 argument will set the file name for the current
1766 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001767 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001768 *cpo-g*
1769 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001770 *cpo-H*
1771 H When using "I" on a line with only blanks, insert
1772 before the last blank. Without this flag insert after
1773 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001774 *cpo-i*
1775 i When included, interrupting the reading of a file will
1776 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001777 *cpo-I*
1778 I When moving the cursor up or down just after inserting
1779 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001780 *cpo-j*
1781 j When joining lines, only add two spaces after a '.',
1782 not after '!' or '?'. Also see 'joinspaces'.
1783 *cpo-J*
1784 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001785 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001786 white space.
1787 *cpo-k*
1788 k Disable the recognition of raw key codes in
1789 mappings, abbreviations, and the "to" part of menu
1790 commands. For example, if <Key> sends ^[OA (where ^[
1791 is <Esc>), the command ":map X ^[OA" results in X
1792 being mapped to:
1793 'k' included: "^[OA" (3 characters)
1794 'k' excluded: "<Key>" (one key code)
1795 Also see the '<' flag below.
1796 *cpo-K*
1797 K Don't wait for a key code to complete when it is
1798 halfway a mapping. This breaks mapping <F1><F1> when
1799 only part of the second <F1> has been read. It
1800 enables cancelling the mapping by typing <F1><Esc>.
1801 *cpo-l*
1802 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001803 literally, only "\]", "\^", "\-" and "\\" are special.
1804 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001805 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1806 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001807 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001808 *cpo-L*
1809 L When the 'list' option is set, 'wrapmargin',
1810 'textwidth', 'softtabstop' and Virtual Replace mode
1811 (see |gR|) count a <Tab> as two characters, instead of
1812 the normal behavior of a <Tab>.
1813 *cpo-m*
1814 m When included, a showmatch will always wait half a
1815 second. When not included, a showmatch will wait half
1816 a second or until a character is typed. |'showmatch'|
1817 *cpo-M*
1818 M When excluded, "%" matching will take backslashes into
1819 account. Thus in "( \( )" and "\( ( \)" the outer
1820 parenthesis match. When included "%" ignores
1821 backslashes, which is Vi compatible.
1822 *cpo-n*
1823 n When included, the column used for 'number' will also
1824 be used for text of wrapped lines.
1825 *cpo-o*
1826 o Line offset to search command is not remembered for
1827 next search.
1828 *cpo-O*
1829 O Don't complain if a file is being overwritten, even
1830 when it didn't exist when editing it. This is a
1831 protection against a file unexpectedly created by
1832 someone else. Vi didn't complain about this.
1833 *cpo-p*
1834 p Vi compatible Lisp indenting. When not present, a
1835 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00001836 *cpo-P*
1837 P When included, a ":write" command that appends to a
1838 file will set the file name for the current buffer, if
1839 the current buffer doesn't have a file name yet and
1840 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001841 *cpo-q*
1842 q When joining multiple lines leave the cursor at the
1843 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001844 *cpo-r*
1845 r Redo ("." command) uses "/" to repeat a search
1846 command, instead of the actually used search string.
1847 *cpo-R*
1848 R Remove marks from filtered lines. Without this flag
1849 marks are kept like |:keepmarks| was used.
1850 *cpo-s*
1851 s Set buffer options when entering the buffer for the
1852 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001853 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001854 set when the buffer is created.
1855 *cpo-S*
1856 S Set buffer options always when entering a buffer
1857 (except 'readonly', 'fileformat', 'filetype' and
1858 'syntax'). This is the (most) Vi compatible setting.
1859 The options are set to the values in the current
1860 buffer. When you change an option and go to another
1861 buffer, the value is copied. Effectively makes the
1862 buffer options global to all buffers.
1863
1864 's' 'S' copy buffer options
1865 no no when buffer created
1866 yes no when buffer first entered (default)
1867 X yes each time when buffer entered (vi comp.)
1868 *cpo-t*
1869 t Search pattern for the tag command is remembered for
1870 "n" command. Otherwise Vim only puts the pattern in
1871 the history for search pattern, but doesn't change the
1872 last used search pattern.
1873 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001874 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001875 *cpo-v*
1876 v Backspaced characters remain visible on the screen in
1877 Insert mode. Without this flag the characters are
1878 erased from the screen right away. With this flag the
1879 screen newly typed text overwrites backspaced
1880 characters.
1881 *cpo-w*
1882 w When using "cw" on a blank character, only change one
1883 character and not all blanks until the start of the
1884 next word.
1885 *cpo-W*
1886 W Don't overwrite a readonly file. When omitted, ":w!"
1887 overwrites a readonly file, if possible.
1888 *cpo-x*
1889 x <Esc> on the command-line executes the command-line.
1890 The default in Vim is to abandon the command-line,
1891 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001892 *cpo-X*
1893 X When using a count with "R" the replaced text is
1894 deleted only once. Also when repeating "R" with "."
1895 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001896 *cpo-y*
1897 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001898 *cpo-Z*
1899 Z When using "w!" while the 'readonly' option is set,
1900 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001901 *cpo-!*
1902 ! When redoing a filter command, use the last used
1903 external command, whatever it was. Otherwise the last
1904 used -filter- command is used.
1905 *cpo-$*
1906 $ When making a change to one line, don't redisplay the
1907 line, but put a '$' at the end of the changed text.
1908 The changed text will be overwritten when you type the
1909 new text. The line is redisplayed if you type any
1910 command that moves the cursor from the insertion
1911 point.
1912 *cpo-%*
1913 % Vi-compatible matching is done for the "%" command.
1914 Does not recognize "#if", "#endif", etc.
1915 Does not recognize "/*" and "*/".
1916 Parens inside single and double quotes are also
1917 counted, causing a string that contains a paren to
1918 disturb the matching. For example, in a line like
1919 "if (strcmp("foo(", s))" the first paren does not
1920 match the last one. When this flag is not included,
1921 parens inside single and double quotes are treated
1922 specially. When matching a paren outside of quotes,
1923 everything inside quotes is ignored. When matching a
1924 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001925 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001926 This flag is also used for other features, such as
1927 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001928 *cpo--*
1929 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001930 it would go above the first line or below the last
1931 line. Without it the cursor moves to the first or
1932 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001933 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001934 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001935 *cpo-+*
1936 + When included, a ":write file" command will reset the
1937 'modified' flag of the buffer, even though the buffer
1938 itself may still be different from its file.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001939 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001940 * Use ":*" in the same way as ":@". When not included,
1941 ":*" is an alias for ":'<,'>", select the Visual area.
1942 *cpo-<*
1943 < Disable the recognition of special key codes in |<>|
1944 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001945 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00001946 ":map X <Tab>" results in X being mapped to:
1947 '<' included: "<Tab>" (5 characters)
1948 '<' excluded: "^I" (^I is a real <Tab>)
1949 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001950 *cpo->*
1951 > When appending to a register, put a line break before
1952 the appended text.
1953
1954 POSIX flags. These are not included in the Vi default value, except
1955 when $VIM_POSIX was set on startup. |posix|
1956
1957 contains behavior ~
1958 *cpo-#*
1959 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001960 *cpo-&*
1961 & When ":preserve" was used keep the swap file when
1962 exiting normally while this buffer is still loaded.
1963 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001964 *cpo-\*
1965 \ Backslash in a [] range in a search pattern is taken
1966 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00001967 '\' included: "/[ \-]" finds <Space>, '\' and '-'
1968 '\' excluded: "/[ \-]" finds <Space> and '-'
1969 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001970 *cpo-/*
1971 / When "%" is used as the replacement string in a |:s|
1972 command, use the previous replacement string. |:s%|
1973 *cpo-{*
1974 { The |{| and |}| commands also stop at a "{" character
1975 at the start of a line.
1976 *cpo-.*
1977 . The ":chdir" and ":cd" commands fail if the current
1978 buffer is modified, unless ! is used. Vim doesn't
1979 need this, since it remembers the full path of an
1980 opened file.
1981 *cpo-bar*
1982 | The value of the $LINES and $COLUMNS environment
1983 variables overrule the terminal size values obtained
1984 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001985
Bram Moolenaar071d4272004-06-13 20:20:40 +00001986
1987 *'cscopepathcomp'* *'cspc'*
1988'cscopepathcomp' 'cspc' number (default 0)
1989 global
1990 {not available when compiled without the |+cscope|
1991 feature}
1992 {not in Vi}
1993 Determines how many components of the path to show in a list of tags.
1994 See |cscopepathcomp|.
1995
1996 *'cscopeprg'* *'csprg'*
1997'cscopeprg' 'csprg' string (default "cscope")
1998 global
1999 {not available when compiled without the |+cscope|
2000 feature}
2001 {not in Vi}
2002 Specifies the command to execute cscope. See |cscopeprg|.
2003 This option cannot be set from a |modeline| or in the |sandbox|, for
2004 security reasons.
2005
2006 *'cscopequickfix'* *'csqf'*
2007'cscopequickfix' 'csqf' string (default "")
2008 global
2009 {not available when compiled without the |+cscope|
2010 or |+quickfix| features}
2011 {not in Vi}
2012 Specifies whether to use quickfix window to show cscope results.
2013 See |cscopequickfix|.
2014
2015 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2016'cscopetag' 'cst' boolean (default off)
2017 global
2018 {not available when compiled without the |+cscope|
2019 feature}
2020 {not in Vi}
2021 Use cscope for tag commands. See |cscope-options|.
2022 NOTE: This option is reset when 'compatible' is set.
2023
2024 *'cscopetagorder'* *'csto'*
2025'cscopetagorder' 'csto' number (default 0)
2026 global
2027 {not available when compiled without the |+cscope|
2028 feature}
2029 {not in Vi}
2030 Determines the order in which ":cstag" performs a search. See
2031 |cscopetagorder|.
2032 NOTE: This option is set to 0 when 'compatible' is set.
2033
2034 *'cscopeverbose'* *'csverb'*
2035 *'nocscopeverbose'* *'nocsverb'*
2036'cscopeverbose' 'csverb' boolean (default off)
2037 global
2038 {not available when compiled without the |+cscope|
2039 feature}
2040 {not in Vi}
2041 Give messages when adding a cscope database. See |cscopeverbose|.
2042 NOTE: This option is reset when 'compatible' is set.
2043
2044 *'debug'*
2045'debug' string (default "")
2046 global
2047 {not in Vi}
2048 When set to "msg", error messages that would otherwise be omitted will
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002049 be given anyway. This is useful when debugging 'foldexpr',
2050 'formatexpr' or 'indentexpr'.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002051 When set to "beep", a message will be given when otherwise only a beep
2052 would be produced.
2053 The values can be combined, separated by a comma.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002054
2055 *'define'* *'def'*
2056'define' 'def' string (default "^\s*#\s*define")
2057 global or local to buffer |global-local|
2058 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002059 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002060 pattern, just like for the "/" command. This option is used for the
2061 commands like "[i" and "[d" |include-search|. The 'isident' option is
2062 used to recognize the defined name after the match:
2063 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2064 See |option-backslash| about inserting backslashes to include a space
2065 or backslash.
2066 The default value is for C programs. For C++ this value would be
2067 useful, to include const type declarations: >
2068 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2069< When using the ":set" command, you need to double the backslashes!
2070
2071 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2072'delcombine' 'deco' boolean (default off)
2073 global
2074 {not in Vi}
2075 {only available when compiled with the |+multi_byte|
2076 feature}
2077 If editing Unicode and this option is set, backspace and Normal mode
2078 "x" delete each combining character on its own. When it is off (the
2079 default) the character along with its combining characters are
2080 deleted.
2081 Note: When 'delcombine' is set "xx" may work different from "2x"!
2082
2083 This is useful for Arabic, Hebrew and many other languages where one
2084 may have combining characters overtop of base characters, and want
2085 to remove only the combining ones.
2086
2087 *'dictionary'* *'dict'*
2088'dictionary' 'dict' string (default "")
2089 global or local to buffer |global-local|
2090 {not in Vi}
2091 List of file names, separated by commas, that are used to lookup words
2092 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2093 contain a list of words. This can be one word per line, or several
2094 words per line, separated by non-keyword characters (white space is
2095 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002096 When this option is empty, or an entry "spell" is present, spell
2097 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002098 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002099 after a comma are ignored, otherwise spaces are included in the file
2100 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002101 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002102 Where to find a list of words?
2103 - On FreeBSD, there is the file "/usr/share/dict/words".
2104 - In the Simtel archive, look in the "msdos/linguist" directory.
2105 - In "miscfiles" of the GNU collection.
2106 The use of |:set+=| and |:set-=| is preferred when adding or removing
2107 directories from the list. This avoids problems when a future version
2108 uses another default.
2109 Backticks cannot be used in this option for security reasons.
2110
2111 *'diff'* *'nodiff'*
2112'diff' boolean (default off)
2113 local to window
2114 {not in Vi}
2115 {not available when compiled without the |+diff|
2116 feature}
2117 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002118 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002119
2120 *'dex'* *'diffexpr'*
2121'diffexpr' 'dex' string (default "")
2122 global
2123 {not in Vi}
2124 {not available when compiled without the |+diff|
2125 feature}
2126 Expression which is evaluated to obtain an ed-style diff file from two
2127 versions of a file. See |diff-diffexpr|.
2128 This option cannot be set from a |modeline| or in the |sandbox|, for
2129 security reasons.
2130
2131 *'dip'* *'diffopt'*
2132'diffopt' 'dip' string (default "filler")
2133 global
2134 {not in Vi}
2135 {not available when compiled without the |+diff|
2136 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002137 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002138 All are optional. Items must be separated by a comma.
2139
2140 filler Show filler lines, to keep the text
2141 synchronized with a window that has inserted
2142 lines at the same position. Mostly useful
2143 when windows are side-by-side and 'scrollbind'
2144 is set.
2145
2146 context:{n} Use a context of {n} lines between a change
2147 and a fold that contains unchanged lines.
2148 When omitted a context of six lines is used.
2149 See |fold-diff|.
2150
2151 icase Ignore changes in case of text. "a" and "A"
2152 are considered the same. Adds the "-i" flag
2153 to the "diff" command if 'diffexpr' is empty.
2154
2155 iwhite Ignore changes in amount of white space. Adds
2156 the "-b" flag to the "diff" command if
2157 'diffexpr' is empty. Check the documentation
2158 of the "diff" command for what this does
2159 exactly. It should ignore adding trailing
2160 white space, but not leading white space.
2161
2162 Examples: >
2163
2164 :set diffopt=filler,context:4
2165 :set diffopt=
2166 :set diffopt=filler
2167<
2168 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2169'digraph' 'dg' boolean (default off)
2170 global
2171 {not in Vi}
2172 {not available when compiled without the |+digraphs|
2173 feature}
2174 Enable the entering of digraphs in Insert mode with {char1} <BS>
2175 {char2}. See |digraphs|.
2176 NOTE: This option is reset when 'compatible' is set.
2177
2178 *'directory'* *'dir'*
2179'directory' 'dir' string (default for Amiga: ".,t:",
2180 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2181 for Unix: ".,~/tmp,/var/tmp,/tmp")
2182 global
2183 List of directory names for the swap file, separated with commas.
2184 - The swap file will be created in the first directory where this is
2185 possible.
2186 - Empty means that no swap file will be used (recovery is
2187 impossible!).
2188 - A directory "." means to put the swap file in the same directory as
2189 the edited file. On Unix, a dot is prepended to the file name, so
2190 it doesn't show in a directory listing. On MS-Windows the "hidden"
2191 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002192 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002193 put the swap file relative to where the edited file is. The leading
2194 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002195 - For Unix and Win32, if a directory ends in two path separators "//"
2196 or "\\", the swap file name will be built from the complete path to
2197 the file with all path separators substituted to percent '%' signs.
2198 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002199 - Spaces after the comma are ignored, other spaces are considered part
2200 of the directory name. To have a space at the start of a directory
2201 name, precede it with a backslash.
2202 - To include a comma in a directory name precede it with a backslash.
2203 - A directory name may end in an ':' or '/'.
2204 - Environment variables are expanded |:set_env|.
2205 - Careful with '\' characters, type one before a space, type two to
2206 get one in the option (see |option-backslash|), for example: >
2207 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2208< - For backwards compatibility with Vim version 3.0 a '>' at the start
2209 of the option is removed.
2210 Using "." first in the list is recommended. This means that editing
2211 the same file twice will result in a warning. Using "/tmp" on Unix is
2212 discouraged: When the system crashes you lose the swap file.
2213 "/var/tmp" is often not cleared when rebooting, thus is a better
2214 choice than "/tmp". But it can contain a lot of files, your swap
2215 files get lost in the crowd. That is why a "tmp" directory in your
2216 home directory is tried first.
2217 The use of |:set+=| and |:set-=| is preferred when adding or removing
2218 directories from the list. This avoids problems when a future version
2219 uses another default.
2220 This option cannot be set from a |modeline| or in the |sandbox|, for
2221 security reasons.
2222 {Vi: directory to put temp file in, defaults to "/tmp"}
2223
2224 *'display'* *'dy'*
2225'display' 'dy' string (default "")
2226 global
2227 {not in Vi}
2228 Change the way text is displayed. This is comma separated list of
2229 flags:
2230 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002231 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002232 last line that doesn't fit is replaced with "@" lines.
2233 uhex Show unprintable characters hexadecimal as <xx>
2234 instead of using ^C and ~C.
2235
2236 *'eadirection'* *'ead'*
2237'eadirection' 'ead' string (default "both")
2238 global
2239 {not in Vi}
2240 {not available when compiled without the +vertsplit
2241 feature}
2242 Tells when the 'equalalways' option applies:
2243 ver vertically, width of windows is not affected
2244 hor horizontally, height of windows is not affected
2245 both width and height of windows is affected
2246
2247 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2248'edcompatible' 'ed' boolean (default off)
2249 global
2250 Makes the 'g' and 'c' flags of the ":substitute" command to be
2251 toggled each time the flag is given. See |complex-change|. See
2252 also 'gdefault' option.
2253 Switching this option on is discouraged!
2254
2255 *'encoding'* *'enc'* *E543*
2256'encoding' 'enc' string (default: "latin1" or value from $LANG)
2257 global
2258 {only available when compiled with the |+multi_byte|
2259 feature}
2260 {not in Vi}
2261 Sets the character encoding used inside Vim. It applies to text in
2262 the buffers, registers, Strings in expressions, text stored in the
2263 viminfo file, etc. It sets the kind of characters which Vim can work
2264 with. See |encoding-names| for the possible values.
2265
2266 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002267 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002268 It should normally be kept at its default value, or set when Vim
2269 starts up. See |multibyte|.
2270
2271 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2272 "utf-8". Although care has been taken to allow different values of
2273 'encoding', "utf-8" is the natural choice for the environment and
2274 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002275 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002276 versions, and to avoid changing the encoding of newly created files
2277 without your knowledge (in case 'fileencodings' is empty).
2278
2279 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002280 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002281 iconv() or as specified with 'charconvert'.
2282
2283 Normally 'encoding' will be equal to your current locale. This will
2284 be the default if Vim recognizes your environment settings. If
2285 'encoding' is not set to the current locale, 'termencoding' must be
2286 set to convert typed and displayed text. See |encoding-table|.
2287
2288 When you set this option, it fires the |EncodingChanged| autocommand
2289 event so that you can set up fonts if necessary.
2290
2291 When the option is set, the value is converted to lowercase. Thus
2292 you can set it with uppercase values too. Underscores are translated
2293 to '-' signs.
2294 When the encoding is recognized, it is changed to the standard name.
2295 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2296 "iso-8859-2" and "utf8" becomes "utf-8".
2297
2298 Note: "latin1" is also used when the encoding could not be detected.
2299 This only works when editing files in the same encoding! When the
2300 actual character set is not latin1, make sure 'fileencoding' and
2301 'fileencodings' are empty. When conversion is needed, switch to using
2302 utf-8.
2303
2304 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2305 You don't notice this while editing, but it does matter for the
2306 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2307 setting 'encoding' to one of these values instead of utf-8 only has
2308 effect for encoding used for files when 'fileencoding' is empty.
2309
Bram Moolenaar661b1822005-07-28 22:36:45 +00002310 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2311 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002312
2313 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2314'endofline' 'eol' boolean (default on)
2315 local to buffer
2316 {not in Vi}
2317 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002318 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002319 option is automatically set when starting to edit a new file, unless
2320 the file does not have an <EOL> for the last line in the file, in
2321 which case it is reset. Normally you don't have to set or reset this
2322 option. When 'binary' is off the value is not used when writing the
2323 file. When 'binary' is on it is used to remember the presence of a
2324 <EOL> for the last line in the file, so that when you write the file
2325 the situation from the original file can be kept. But you can change
2326 it if you want to.
2327
2328 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2329'equalalways' 'ea' boolean (default on)
2330 global
2331 {not in Vi}
2332 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002333 splitting or closing a window. This also happens the moment the
2334 option is switched on. When off, splitting a window will reduce the
2335 size of the current window and leave the other windows the same. When
2336 closing a window the extra lines are given to the window next to it
2337 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002338 When mixing vertically and horizontally split windows, a minimal size
2339 is computed and some windows may be larger if there is room. The
2340 'eadirection' option tells in which direction the size is affected.
2341 Changing the height of a window can be avoided by setting
2342 'winfixheight'.
2343
2344 *'equalprg'* *'ep'*
2345'equalprg' 'ep' string (default "")
2346 global or local to buffer |global-local|
2347 {not in Vi}
2348 External program to use for "=" command. When this option is empty
2349 the internal formatting functions are used ('lisp', 'cindent' or
2350 'indentexpr').
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002351 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002352 about including spaces and backslashes.
2353 This option cannot be set from a |modeline| or in the |sandbox|, for
2354 security reasons.
2355
2356 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2357'errorbells' 'eb' boolean (default off)
2358 global
2359 Ring the bell (beep or screen flash) for error messages. This only
2360 makes a difference for error messages, the bell will be used always
2361 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002362 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002363 screen flash or do nothing.
2364
2365 *'errorfile'* *'ef'*
2366'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2367 others: "errors.err")
2368 global
2369 {not in Vi}
2370 {not available when compiled without the |+quickfix|
2371 feature}
2372 Name of the errorfile for the QuickFix mode (see |:cf|).
2373 When the "-q" command-line argument is used, 'errorfile' is set to the
2374 following argument. See |-q|.
2375 NOT used for the ":make" command. See 'makeef' for that.
2376 Environment variables are expanded |:set_env|.
2377 See |option-backslash| about including spaces and backslashes.
2378 This option cannot be set from a |modeline| or in the |sandbox|, for
2379 security reasons.
2380
2381 *'errorformat'* *'efm'*
2382'errorformat' 'efm' string (default is very long)
2383 global or local to buffer |global-local|
2384 {not in Vi}
2385 {not available when compiled without the |+quickfix|
2386 feature}
2387 Scanf-like description of the format for the lines in the error file
2388 (see |errorformat|).
2389
2390 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2391'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2392 global
2393 {not in Vi}
2394 Function keys that start with an <Esc> are recognized in Insert
2395 mode. When this option is off, the cursor and function keys cannot be
2396 used in Insert mode if they start with an <Esc>. The advantage of
2397 this is that the single <Esc> is recognized immediately, instead of
2398 after one second. Instead of resetting this option, you might want to
2399 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2400 when 'esckeys' is off, you can still map anything, but the cursor keys
2401 won't work by default.
2402 NOTE: This option is set to the Vi default value when 'compatible' is
2403 set and to the Vim default value when 'compatible' is reset.
2404
2405 *'eventignore'* *'ei'*
2406'eventignore' 'ei' string (default "")
2407 global
2408 {not in Vi}
2409 {not available when compiled without the |+autocmd|
2410 feature}
2411 A list of autocommand event names, which are to be ignored.
2412 When set to "all", all autocommand events are ignored, autocommands
2413 will not be executed.
2414 Otherwise this is a comma separated list of event names. Example: >
2415 :set ei=WinEnter,WinLeave
2416<
2417 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2418'expandtab' 'et' boolean (default off)
2419 local to buffer
2420 {not in Vi}
2421 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002422 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002423 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2424 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2425 NOTE: This option is reset when 'compatible' is set.
2426
2427 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2428'exrc' 'ex' boolean (default off)
2429 global
2430 {not in Vi}
2431 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2432 directory. If you switch this option on you should also consider
2433 setting the 'secure' option (see |initialization|). Using a local
2434 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2435 also see |.vimrc| and |gui-init|.
2436 This option cannot be set from a |modeline| or in the |sandbox|, for
2437 security reasons.
2438
2439 *'fileencoding'* *'fenc'* *E213*
2440'fileencoding' 'fenc' string (default: "")
2441 local to buffer
2442 {only available when compiled with the |+multi_byte|
2443 feature}
2444 {not in Vi}
2445 Sets the character encoding for the file of this buffer.
2446 When 'fileencoding' is different from 'encoding', conversion will be
2447 done when reading and writing the file.
2448 When 'fileencoding' is empty, the same value as 'encoding' will be
2449 used (no conversion when reading or writing a file).
2450 WARNING: Conversion can cause loss of information! When
2451 'encoding' is "utf-8" conversion is most likely done in a way
2452 that the reverse conversion results in the same text. When
2453 'encoding' is not "utf-8" some characters may be lost!
2454 See 'encoding' for the possible values. Additionally, values may be
2455 specified that can be handled by the converter, see
2456 |mbyte-conversion|.
2457 When reading a file 'fileencoding' will be set from 'fileencodings'.
2458 To read a file in a certain encoding it won't work by setting
2459 'fileencoding', use the |++enc| argument.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002460 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002461 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2462 When the option is set, the value is converted to lowercase. Thus
2463 you can set it with uppercase values too. '_' characters are
2464 replaced with '-'. If a name is recognized from the list for
2465 'encoding', it is replaced by the standard name. For example
2466 "ISO8859-2" becomes "iso-8859-2".
2467 When this option is set, after starting to edit a file, the 'modified'
2468 option is set, because the file would be different when written.
2469 If you do this in a modeline, you might want to set 'nomodified' to
2470 avoid this.
2471 This option can not be changed when 'modifiable' is off.
2472
2473 *'fe'*
2474 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002475 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002476 old short name was 'fe', which is no longer used.
2477
2478 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002479'fileencodings' 'fencs' string (default: "ucs-bom",
2480 "ucs-bom,utf-8,default,latin1" when
2481 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002482 global
2483 {only available when compiled with the |+multi_byte|
2484 feature}
2485 {not in Vi}
2486 This is a list of character encodings considered when starting to edit
2487 an existing file. When a file is read, Vim tries to use the first
2488 mentioned character encoding. If an error is detected, the next one
2489 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002490 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002491 an empty string, which means the value of 'encoding' is used.
2492 WARNING: Conversion can cause loss of information! When
2493 'encoding' is "utf-8" (or one of the other Unicode variants)
2494 conversion is most likely done in a way that the reverse
2495 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002496 "utf-8" some non-ASCII characters may be lost! You can use
2497 the |++bad| argument to specify what is done with characters
2498 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002499 For an empty file or a file with only ASCII characters most encodings
2500 will work and the first entry of 'fileencodings' will be used (except
2501 "ucs-bom", which requires the BOM to be present). If you prefer
2502 another encoding use an BufReadPost autocommand event to test if your
2503 preferred encoding is to be used. Example: >
2504 au BufReadPost * if search('\S', 'w') == 0 |
2505 \ set fenc=iso-2022-jp | endif
2506< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2507 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002508 When the |++enc| argument is used then the value of 'fileencodings' is
2509 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002510 Note that 'fileencodings' is not used for a new file, the global value
2511 of 'fileencoding' is used instead. You can set it with: >
2512 :setglobal fenc=iso-8859-2
2513< This means that a non-existing file may get a different encoding than
2514 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002515 The special value "ucs-bom" can be used to check for a Unicode BOM
2516 (Byte Order Mark) at the start of the file. It must not be preceded
2517 by "utf-8" or another Unicode encoding for this to work properly.
2518 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2519 because Vim cannot detect an error, thus the encoding is always
2520 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002521 The special value "default" can be used for the encoding from the
2522 environment. This is the default value for 'encoding'. It is useful
2523 when 'encoding' is set to "utf-8" and your environment uses a
2524 non-latin1 encoding, such as Russian.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002525 WRONG VALUES: WHAT'S WRONG:
2526 latin1,utf-8 "latin1" will always be used
2527 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2528 file
2529 cp1250,latin1 "cp1250" will always be used
2530 If 'fileencodings' is empty, 'fileencoding' is not modified.
2531 See 'fileencoding' for the possible values.
2532 Setting this option does not have an effect until the next time a file
2533 is read.
2534
2535 *'fileformat'* *'ff'*
2536'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2537 Unix default: "unix",
2538 Macintosh default: "mac")
2539 local to buffer
2540 {not in Vi}
2541 This gives the <EOL> of the current buffer, which is used for
2542 reading/writing the buffer from/to a file:
2543 dos <CR> <NL>
2544 unix <NL>
2545 mac <CR>
2546 When "dos" is used, CTRL-Z at the end of a file is ignored.
2547 See |file-formats| and |file-read|.
2548 For the character encoding of the file see 'fileencoding'.
2549 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2550 works like it was set to "unix'.
2551 This option is set automatically when starting to edit a file and
2552 'fileformats' is not empty and 'binary' is off.
2553 When this option is set, after starting to edit a file, the 'modified'
2554 option is set, because the file would be different when written.
2555 This option can not be changed when 'modifiable' is off.
2556 For backwards compatibility: When this option is set to "dos",
2557 'textmode' is set, otherwise 'textmode' is reset.
2558
2559 *'fileformats'* *'ffs'*
2560'fileformats' 'ffs' string (default:
2561 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2562 Vim Unix: "unix,dos",
2563 Vim Mac: "mac,unix,dos",
2564 Vi Cygwin: "unix,dos",
2565 Vi others: "")
2566 global
2567 {not in Vi}
2568 This gives the end-of-line (<EOL>) formats that will be tried when
2569 starting to edit a new buffer and when reading a file into an existing
2570 buffer:
2571 - When empty, the format defined with 'fileformat' will be used
2572 always. It is not set automatically.
2573 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002574 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002575 'fileformats' name will be used when a file is read into an existing
2576 buffer, no matter what 'fileformat' for that buffer is set to.
2577 - When more than one name is present, separated by commas, automatic
2578 <EOL> detection will be done when reading a file. When starting to
2579 edit a file, a check is done for the <EOL>:
2580 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2581 'fileformat' is set to "dos".
2582 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002583 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002584 preceding <CR>, "unix" is preferred over "dos".
2585 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2586 This means that "mac" is only chosen when "unix" is not present,
2587 or when no <NL> is found in the file, and when "dos" is not
2588 present, or no <CR><NL> is present in the file.
2589 Also if "unix" was first chosen, but the first <CR> is before
2590 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2591 the file, then 'fileformat' is set to "mac".
2592 4. If 'fileformat' is still not set, the first name from
2593 'fileformats' is used.
2594 When reading a file into an existing buffer, the same is done, but
2595 this happens like 'fileformat' has been set appropriately for that
2596 file only, the option is not changed.
2597 When 'binary' is set, the value of 'fileformats' is not used.
2598
2599 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2600 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2601 done:
2602 - When 'fileformats' is empty, there is no automatic detection. Dos
2603 format will be used.
2604 - When 'fileformats' is set to one or more names, automatic detection
2605 is done. This is based on the first <NL> in the file: If there is a
2606 <CR> in front of it, Dos format is used, otherwise Unix format is
2607 used.
2608 Also see |file-formats|.
2609 For backwards compatibility: When this option is set to an empty
2610 string or one format (no comma is included), 'textauto' is reset,
2611 otherwise 'textauto' is set.
2612 NOTE: This option is set to the Vi default value when 'compatible' is
2613 set and to the Vim default value when 'compatible' is reset.
2614
2615 *'filetype'* *'ft'*
2616'filetype' 'ft' string (default: "")
2617 local to buffer
2618 {not in Vi}
2619 {not available when compiled without the |+autocmd|
2620 feature}
2621 When this option is set, the FileType autocommand event is triggered.
2622 All autocommands that match with the value of this option will be
2623 executed. Thus the value of 'filetype' is used in place of the file
2624 name.
2625 Otherwise this option does not always reflect the current file type.
2626 This option is normally set when the file type is detected. To enable
2627 this use the ":filetype on" command. |:filetype|
2628 Setting this option to a different value is most useful in a modeline,
2629 for a file for which the file type is not automatically recognized.
2630 Example, for in an IDL file: >
2631 /* vim: set filetype=idl : */
2632< |FileType| |filetypes|
2633 Do not confuse this option with 'osfiletype', which is for the file
2634 type that is actually stored with the file.
2635 This option is not copied to another buffer, independent of the 's' or
2636 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002637 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002638
2639 *'fillchars'* *'fcs'*
2640'fillchars' 'fcs' string (default "vert:|,fold:-")
2641 global
2642 {not in Vi}
2643 {not available when compiled without the |+windows|
2644 and |+folding| features}
2645 Characters to fill the statuslines and vertical separators.
2646 It is a comma separated list of items:
2647
2648 item default Used for ~
2649 stl:c ' ' or '^' statusline of the current window
2650 stlnc:c ' ' or '-' statusline of the non-current windows
2651 vert:c '|' vertical separators |:vsplit|
2652 fold:c '-' filling 'foldtext'
2653 diff:c '-' deleted lines of the 'diff' option
2654
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002655 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002656 "stlnc" the space will be used when there is highlighting, '^' or '-'
2657 otherwise.
2658
2659 Example: >
2660 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2661< This is similar to the default, except that these characters will also
2662 be used when there is highlighting.
2663
2664 The highlighting used for these items:
2665 item highlight group ~
2666 stl:c StatusLine |hl-StatusLine|
2667 stlnc:c StatusLineNC |hl-StatusLineNC|
2668 vert:c VertSplit |hl-VertSplit|
2669 fold:c Folded |hl-Folded|
2670 diff:c DiffDelete |hl-DiffDelete|
2671
2672 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2673'fkmap' 'fk' boolean (default off) *E198*
2674 global
2675 {not in Vi}
2676 {only available when compiled with the |+rightleft|
2677 feature}
2678 When on, the keyboard is mapped for the Farsi character set.
2679 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002680 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002681
2682 *'foldclose'* *'fcl'*
2683'foldclose' 'fcl' string (default "")
2684 global
2685 {not in Vi}
2686 {not available when compiled without the |+folding|
2687 feature}
2688 When set to "all", a fold is closed when the cursor isn't in it and
2689 its level is higher than 'foldlevel'. Useful if you want folds to
2690 automatically close when moving out of them.
2691
2692 *'foldcolumn'* *'fdc'*
2693'foldcolumn' 'fdc' number (default 0)
2694 local to window
2695 {not in Vi}
2696 {not available when compiled without the |+folding|
2697 feature}
2698 When non-zero, a column with the specified width is shown at the side
2699 of the window which indicates open and closed folds. The maximum
2700 value is 12.
2701 See |folding|.
2702
2703 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2704'foldenable' 'fen' boolean (default on)
2705 local to window
2706 {not in Vi}
2707 {not available when compiled without the |+folding|
2708 feature}
2709 When off, all folds are open. This option can be used to quickly
2710 switch between showing all text unfolded and viewing the text with
2711 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002712 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002713 'foldenable' is off.
2714 This option is set by commands that create a new fold or close a fold.
2715 See |folding|.
2716
2717 *'foldexpr'* *'fde'*
2718'foldexpr' 'fde' string (default: "0")
2719 local to window
2720 {not in Vi}
2721 {not available when compiled without the |+folding|
2722 or |+eval| feature}
2723 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002724 for each line to obtain its fold level. See |fold-expr|.
2725
2726 The expression may be evaluated in the |sandbox|, see
2727 |sandbox-option|.
2728
2729 It is not allowed to change text or jump to another window while
2730 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002731
2732 *'foldignore'* *'fdi'*
2733'foldignore' 'fdi' string (default: "#")
2734 local to window
2735 {not in Vi}
2736 {not available when compiled without the |+folding|
2737 feature}
2738 Used only when 'foldmethod' is "indent". Lines starting with
2739 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002740 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002741 The default "#" works well for C programs. See |fold-indent|.
2742
2743 *'foldlevel'* *'fdl'*
2744'foldlevel' 'fdl' number (default: 0)
2745 local to window
2746 {not in Vi}
2747 {not available when compiled without the |+folding|
2748 feature}
2749 Sets the fold level: Folds with a higher level will be closed.
2750 Setting this option to zero will close all folds. Higher numbers will
2751 close fewer folds.
2752 This option is set by commands like |zm|, |zM| and |zR|.
2753 See |fold-foldlevel|.
2754
2755 *'foldlevelstart'* *'fdls'*
2756'foldlevelstart' 'fdls' number (default: -1)
2757 global
2758 {not in Vi}
2759 {not available when compiled without the |+folding|
2760 feature}
2761 Sets 'foldlevel' when starting to edit another buffer in a window.
2762 Useful to always start editing with all folds closed (value zero),
2763 some folds closed (one) or no folds closed (99).
2764 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002765 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002766 ignores this option and closes all folds.
2767 It is also done before BufReadPre autocommands, to allow an autocmd to
2768 overrule the 'foldlevel' value for specific files.
2769 When the value is negative, it is not used.
2770
2771 *'foldmarker'* *'fmr'* *E536*
2772'foldmarker' 'fmr' string (default: "{{{,}}}")
2773 local to window
2774 {not in Vi}
2775 {not available when compiled without the |+folding|
2776 feature}
2777 The start and end marker used when 'foldmethod' is "marker". There
2778 must be one comma, which separates the start and end marker. The
2779 marker is a literal string (a regular expression would be too slow).
2780 See |fold-marker|.
2781
2782 *'foldmethod'* *'fdm'*
2783'foldmethod' 'fdm' string (default: "manual")
2784 local to window
2785 {not in Vi}
2786 {not available when compiled without the |+folding|
2787 feature}
2788 The kind of folding used for the current window. Possible values:
2789 |fold-manual| manual Folds are created manually.
2790 |fold-indent| indent Lines with equal indent form a fold.
2791 |fold-expr| expr 'foldexpr' gives the fold level of a line.
2792 |fold-marker| marker Markers are used to specify folds.
2793 |fold-syntax| syntax Syntax highlighting items specify folds.
2794 |fold-diff| diff Fold text that is not changed.
2795
2796 *'foldminlines'* *'fml'*
2797'foldminlines' 'fml' number (default: 1)
2798 local to window
2799 {not in Vi}
2800 {not available when compiled without the |+folding|
2801 feature}
2802 Sets the minimum number of screen lines for a fold to be displayed
2803 closed. Also for manually closed folds.
2804 Note that this only has an effect of what is displayed. After using
2805 "zc" to close a fold, which is displayed open because it's smaller
2806 than 'foldminlines', a following "zc" may close a containing fold.
2807
2808 *'foldnestmax'* *'fdn'*
2809'foldnestmax' 'fdn' number (default: 20)
2810 local to window
2811 {not in Vi}
2812 {not available when compiled without the |+folding|
2813 feature}
2814 Sets the maximum nesting of folds for the "indent" and "syntax"
2815 methods. This avoids that too many folds will be created. Using more
2816 than 20 doesn't work, because the internal limit is 20.
2817
2818 *'foldopen'* *'fdo'*
2819'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
2820 search,tag,undo")
2821 global
2822 {not in Vi}
2823 {not available when compiled without the |+folding|
2824 feature}
2825 Specifies for which type of commands folds will be opened, if the
2826 command moves the cursor into a closed fold. It is a comma separated
2827 list of items.
2828 item commands ~
2829 all any
2830 block "(", "{", "[[", "[{", etc.
2831 hor horizontal movements: "l", "w", "fx", etc.
2832 insert any command in Insert mode
2833 jump far jumps: "G", "gg", etc.
2834 mark jumping to a mark: "'m", CTRL-O, etc.
2835 percent "%"
2836 quickfix ":cn", ":crew", ":make", etc.
2837 search search for a pattern: "/", "n", "*", "gd", etc.
2838 (not for a search pattern in a ":" command)
2839 tag jumping to a tag: ":ta", CTRL-T, etc.
2840 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002841 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00002842 the |zv| command to the mapping to get the same effect.
2843 When a movement command is used for an operator (e.g., "dl" or "y%")
2844 this option is not used. This means the operator will include the
2845 whole closed fold.
2846 Note that vertical movements are not here, because it would make it
2847 very difficult to move onto a closed fold.
2848 In insert mode the folds containing the cursor will always be open
2849 when text is inserted.
2850 To close folds you can re-apply 'foldlevel' with the |zx| command or
2851 set the 'foldclose' option to "all".
2852
2853 *'foldtext'* *'fdt'*
2854'foldtext' 'fdt' string (default: "foldtext()")
2855 local to window
2856 {not in Vi}
2857 {not available when compiled without the |+folding|
2858 feature}
2859 An expression which is used to specify the text displayed for a closed
2860 fold. See |fold-foldtext|.
2861
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002862 The expression may be evaluated in the |sandbox|, see
2863 |sandbox-option|.
2864
2865 It is not allowed to change text or jump to another window while
2866 evaluating 'foldtext' |textlock|.
2867
Bram Moolenaar071d4272004-06-13 20:20:40 +00002868 *'formatoptions'* *'fo'*
2869'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
2870 local to buffer
2871 {not in Vi}
2872 This is a sequence of letters which describes how automatic
2873 formatting is to be done. See |fo-table|. When the 'paste' option is
2874 on, no formatting is done (like 'formatoptions' is empty). Commas can
2875 be inserted for readability.
2876 To avoid problems with flags that are added in the future, use the
2877 "+=" and "-=" feature of ":set" |add-option-flags|.
2878 NOTE: This option is set to the Vi default value when 'compatible' is
2879 set and to the Vim default value when 'compatible' is reset.
2880
Bram Moolenaar86b68352004-12-27 21:59:20 +00002881 *'formatlistpat'* *'flp'*
2882'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
2883 local to buffer
2884 {not in Vi}
2885 A pattern that is used to recognize a list header. This is used for
2886 the "n" flag in 'formatoptions'.
2887 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00002888 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00002889 while still checking more characters. There must be a character
2890 following the pattern, when it matches the whole line it is handled
2891 like there is no match.
2892 The default recognizes a number, followed by an optional punctuation
2893 character and white space.
2894
Bram Moolenaar071d4272004-06-13 20:20:40 +00002895 *'formatprg'* *'fp'*
2896'formatprg' 'fp' string (default "")
2897 global
2898 {not in Vi}
2899 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002900 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00002901 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00002902 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002903 If the 'formatexpr' option is not empty it will be used instead.
2904 Otherwise, if 'formatprg' option is an empty string, the internal
2905 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00002906 Environment variables are expanded |:set_env|. See |option-backslash|
2907 about including spaces and backslashes.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002908 The expression may be evaluated in the |sandbox|, see
2909 |sandbox-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002910
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002911 *'formatexpr'* *'fex'*
2912'formatexpr' 'fex' string (default "")
2913 local to buffer
2914 {not in Vi}
2915 {not available when compiled without the |+eval|
2916 feature}
2917 Expression which is evaluated to format a range of lines for the |gq|
2918 operator. The |v:lnum| variable holds the first line to be formatted,
2919 |v:count| the number of lines to be formatted.
2920 When this option is empty 'formatprg' is used.
2921 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00002922 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002923< This will invoke the mylang#Format() function in the
2924 autoload/mylang.vim file in 'runtimepath'. |autoload|
2925
2926 The expression is also evaluated when 'textwidth' is set and adding
2927 text beyond that limit. This happens under the same conditions as
2928 when internal formatting is used. Make sure the cursor is kept in the
2929 same spot relative to the text then! The |mode()| function will
2930 return "i" or "R" in this situation. When the function returns
2931 non-zero Vim will fall back to using the internal format mechanism.
2932
2933 The expression may be evaluated in the |sandbox|, see
2934 |sandbox-option|.
2935
2936 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002937'fsync' 'fs' boolean (default on)
2938 global
2939 {not in Vi}
2940 When on, the library function fsync() will be called after writing a
2941 file. This will flush a file to disk, ensuring that it is safely
2942 written even on filesystems which do metadata-only journaling. This
2943 will force the harddrive to spin up on Linux systems running in laptop
2944 mode, so it may be undesirable in some situations. Be warned that
2945 turning this off increases the chances of data loss after a crash. On
2946 systems without an fsync() implementation, this variable is always
2947 off.
2948 Also see 'swapsync' for controlling fsync() on swap files.
2949
Bram Moolenaar071d4272004-06-13 20:20:40 +00002950 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
2951'gdefault' 'gd' boolean (default off)
2952 global
2953 {not in Vi}
2954 When on, the ":substitute" flag 'g' is default on. This means that
2955 all matches in a line are substituted instead of one. When a 'g' flag
2956 is given to a ":substitute" command, this will toggle the substitution
2957 of all or one match. See |complex-change|.
2958
2959 command 'gdefault' on 'gdefault' off ~
2960 :s/// subst. all subst. one
2961 :s///g subst. one subst. all
2962 :s///gg subst. all subst. one
2963
2964 NOTE: This option is reset when 'compatible' is set.
2965
2966 *'grepformat'* *'gfm'*
2967'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
2968 global
2969 {not in Vi}
2970 Format to recognize for the ":grep" command output.
2971 This is a scanf-like string that uses the same format as the
2972 'errorformat' option: see |errorformat|.
2973
2974 *'grepprg'* *'gp'*
2975'grepprg' 'gp' string (default "grep -n ",
2976 Unix: "grep -n $* /dev/null",
2977 Win32: "findstr /n" or "grep -n",
2978 VMS: "SEARCH/NUMBERS ")
2979 global or local to buffer |global-local|
2980 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00002981 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002982 and '#' characters, which are expanded like when used in a command-
2983 line. The placeholder "$*" is allowed to specify where the arguments
2984 will be included. Environment variables are expanded |:set_env|. See
2985 |option-backslash| about including spaces and backslashes.
2986 When your "grep" accepts the "-H" argument, use this to make ":grep"
2987 also work well with a single file: >
2988 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00002989< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00002990 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
2991 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00002992 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00002993 apply equally to 'grepprg'.
2994 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
2995 otherwise it's "grep -n".
2996 This option cannot be set from a |modeline| or in the |sandbox|, for
2997 security reasons.
2998
2999 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3000'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3001 ve:ver35-Cursor,
3002 o:hor50-Cursor,
3003 i-ci:ver25-Cursor/lCursor,
3004 r-cr:hor20-Cursor/lCursor,
3005 sm:block-Cursor
3006 -blinkwait175-blinkoff150-blinkon175",
3007 for MS-DOS and Win32 console:
3008 "n-v-c:block,o:hor50,i-ci:hor15,
3009 r-cr:hor30,sm:block")
3010 global
3011 {not in Vi}
3012 {only available when compiled with GUI enabled, and
3013 for MS-DOS and Win32 console}
3014 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003015 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003016 the height of the cursor can be changed. This can be done by
3017 specifying a block cursor, or a percentage for a vertical or
3018 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003019 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003020
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003021 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003022 mode-list and an argument-list:
3023 mode-list:argument-list,mode-list:argument-list,..
3024 The mode-list is a dash separated list of these modes:
3025 n Normal mode
3026 v Visual mode
3027 ve Visual mode with 'selection' "exclusive" (same as 'v',
3028 if not specified)
3029 o Operator-pending mode
3030 i Insert mode
3031 r Replace mode
3032 c Command-line Normal (append) mode
3033 ci Command-line Insert mode
3034 cr Command-line Replace mode
3035 sm showmatch in Insert mode
3036 a all modes
3037 The argument-list is a dash separated list of these arguments:
3038 hor{N} horizontal bar, {N} percent of the character height
3039 ver{N} vertical bar, {N} percent of the character width
3040 block block cursor, fills the whole character
3041 [only one of the above three should be present]
3042 blinkwait{N} *cursor-blinking*
3043 blinkon{N}
3044 blinkoff{N}
3045 blink times for cursor: blinkwait is the delay before
3046 the cursor starts blinking, blinkon is the time that
3047 the cursor is shown and blinkoff is the time that the
3048 cursor is not shown. The times are in msec. When one
3049 of the numbers is zero, there is no blinking. The
3050 default is: "blinkwait700-blinkon400-blinkoff250".
3051 These numbers are used for a missing entry. This
3052 means that blinking is enabled by default. To switch
3053 blinking off you can use "blinkon0". The cursor only
3054 blinks when Vim is waiting for input, not while
3055 executing a command.
3056 To make the cursor blink in an xterm, see
3057 |xterm-blink|.
3058 {group-name}
3059 a highlight group name, that sets the color and font
3060 for the cursor
3061 {group-name}/{group-name}
3062 Two highlight group names, the first is used when
3063 no language mappings are used, the other when they
3064 are. |language-mapping|
3065
3066 Examples of parts:
3067 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3068 block cursor with colors from the "nCursor"
3069 highlight group
3070 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3071 In Insert and Command-line Insert mode, use a
3072 30% vertical bar cursor with colors from the
3073 "iCursor" highlight group. Blink a bit
3074 faster.
3075
3076 The 'a' mode is different. It will set the given argument-list for
3077 all modes. It does not reset anything to defaults. This can be used
3078 to do a common setting for all modes. For example, to switch off
3079 blinking: "a:blinkon0"
3080
3081 Examples of cursor highlighting: >
3082 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3083 :highlight Cursor gui=NONE guifg=bg guibg=fg
3084<
3085 *'guifont'* *'gfn'*
3086 *E235* *E596* *E610* *E611*
3087'guifont' 'gfn' string (default "")
3088 global
3089 {not in Vi}
3090 {only available when compiled with GUI enabled}
3091 This is a list of fonts which will be used for the GUI version of Vim.
3092 In its simplest form the value is just one font name. When
3093 the font cannot be found you will get an error message. To try other
3094 font names a list can be specified, font names separated with commas.
3095 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003096
Bram Moolenaar05159a02005-02-26 23:04:13 +00003097 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3098 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003099
Bram Moolenaar071d4272004-06-13 20:20:40 +00003100 Spaces after a comma are ignored. To include a comma in a font name
3101 precede it with a backslash. Setting an option requires an extra
3102 backslash before a space and a backslash. See also
3103 |option-backslash|. For example: >
3104 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003105< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003106 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003107
3108 If none of the fonts can be loaded, Vim will keep the current setting.
3109 If an empty font list is given, Vim will try using other resource
3110 settings (for X, it will use the Vim.font resource), and finally it
3111 will try some builtin default which should always be there ("7x13" in
3112 the case of X). The font names given should be "normal" fonts. Vim
3113 will try to find the related bold and italic fonts.
3114
Bram Moolenaar05159a02005-02-26 23:04:13 +00003115 For Win32, GTK, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003116 :set guifont=*
3117< will bring up a font requester, where you can pick the font you want.
3118
3119 The font name depends on the GUI used. See |setting-guifont| for a
3120 way to set 'guifont' for various systems.
3121
Bram Moolenaar071d4272004-06-13 20:20:40 +00003122 For the GTK+ 2 GUI the font name looks like this: >
3123 :set guifont=Andale\ Mono\ 11
3124< That's all. XLFDs are no longer accepted.
Bram Moolenaar05159a02005-02-26 23:04:13 +00003125
3126 For Mac OSX you can use something like this: >
3127 :set guifont=Monaco:h10
3128< *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003129 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003130 width). An exception is GTK 2: all fonts are accepted, but
3131 mono-spaced fonts look best.
3132
Bram Moolenaar071d4272004-06-13 20:20:40 +00003133 To preview a font on X11, you might be able to use the "xfontsel"
3134 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003135
Bram Moolenaar071d4272004-06-13 20:20:40 +00003136 For the Win32 GUI *E244* *E245*
3137 - takes these options in the font name:
3138 hXX - height is XX (points, can be floating-point)
3139 wXX - width is XX (points, can be floating-point)
3140 b - bold
3141 i - italic
3142 u - underline
3143 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003144 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003145 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3146 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3147 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003148 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003149
3150 Use a ':' to separate the options.
3151 - A '_' can be used in the place of a space, so you don't need to use
3152 backslashes to escape the spaces.
3153 - Examples: >
3154 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3155 :set guifont=Andale_Mono:h7.5:w4.5
3156< See also |font-sizes|.
3157
3158 *'guifontset'* *'gfs'*
3159 *E250* *E252* *E234* *E597* *E598*
3160'guifontset' 'gfs' string (default "")
3161 global
3162 {not in Vi}
3163 {only available when compiled with GUI enabled and
3164 with the |+xfontset| feature}
3165 {not available in the GTK+ 2 GUI}
3166 When not empty, specifies two (or more) fonts to be used. The first
3167 one for normal English, the second one for your special language. See
3168 |xfontset|.
3169 Setting this option also means that all font names will be handled as
3170 a fontset name. Also the ones used for the "font" argument of the
3171 |:highlight| command.
3172 The fonts must match with the current locale. If fonts for the
3173 character sets that the current locale uses are not included, setting
3174 'guifontset' will fail.
3175 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3176 the comma-separated names are alternative names, one of which will be
3177 used. In 'guifontset' the whole string is one fontset name,
3178 including the commas. It is not possible to specify alternative
3179 fontset names.
3180 This example works on many X11 systems: >
3181 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3182<
3183 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3184'guifontwide' 'gfw' string (default "")
3185 global
3186 {not in Vi}
3187 {only available when compiled with GUI enabled}
3188 When not empty, specifies a comma-separated list of fonts to be used
3189 for double-width characters. The first font that can be loaded is
3190 used.
3191 Note: The size of these fonts must be exactly twice as wide as the one
3192 specified with 'guifont' and the same height.
3193
3194 All GUI versions but GTK+ 2:
3195
3196 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3197 'guifontset' is empty or invalid.
3198 When 'guifont' is set and a valid font is found in it and
3199 'guifontwide' is empty Vim will attempt to find a matching
3200 double-width font and set 'guifontwide' to it.
3201
3202 GTK+ 2 GUI only: *guifontwide_gtk2*
3203
3204 If set and valid, 'guifontwide' is always used for double width
3205 characters, even if 'encoding' is not set to "utf-8".
3206 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003207 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003208 font for characters not available in 'guifont'. Thus you do not need
3209 to set 'guifontwide' at all unless you want to override the choice
3210 made by Pango/Xft.
3211
3212 *'guiheadroom'* *'ghr'*
3213'guiheadroom' 'ghr' number (default 50)
3214 global
3215 {not in Vi} {only for GTK and X11 GUI}
3216 The number of pixels subtracted from the screen height when fitting
3217 the GUI window on the screen. Set this before the GUI is started,
3218 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003219 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003220 lines will be left for window decorations and other items on the
3221 screen. Set it to a negative value to allow windows taller than the
3222 screen.
3223
3224 *'guioptions'* *'go'*
3225'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003226 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003227 global
3228 {not in Vi}
3229 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003230 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003231 sequence of letters which describes what components and options of the
3232 GUI should be used.
3233 To avoid problems with flags that are added in the future, use the
3234 "+=" and "-=" feature of ":set" |add-option-flags|.
3235
3236 Valid letters are as follows:
3237 *guioptions_a*
3238 'a' Autoselect: If present, then whenever VISUAL mode is started,
3239 or the Visual area extended, Vim tries to become the owner of
3240 the windowing system's global selection. This means that the
3241 Visually highlighted text is available for pasting into other
3242 applications as well as into Vim itself. When the Visual mode
3243 ends, possibly due to an operation on the text, or when an
3244 application wants to paste the selection, the highlighted text
3245 is automatically yanked into the "* selection register.
3246 Thus the selection is still available for pasting into other
3247 applications after the VISUAL mode has ended.
3248 If not present, then Vim won't become the owner of the
3249 windowing system's global selection unless explicitly told to
3250 by a yank or delete operation for the "* register.
3251 The same applies to the modeless selection.
3252
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003253 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003254 applies to the modeless selection.
3255
3256 'guioptions' autoselect Visual autoselect modeless ~
3257 "" - -
3258 "a" yes yes
3259 "A" - yes
3260 "aA" yes yes
3261
3262 'c' Use console dialogs instead of popup dialogs for simple
3263 choices.
3264
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003265 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003266 'guitablabel' can be used to change the text in the labels.
3267 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00003268 The GUI tabs are only supported on some systens, currently
3269 only for GTK.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003270
Bram Moolenaar071d4272004-06-13 20:20:40 +00003271 'f' Foreground: Don't use fork() to detach the GUI from the shell
3272 where it was started. Use this for programs that wait for the
3273 editor to finish (e.g., an e-mail program). Alternatively you
3274 can use "gvim -f" or ":gui -f" to start the GUI in the
3275 foreground. |gui-fork|
3276 Note: Set this option in the vimrc file. The forking may have
3277 happened already when the gvimrc file is read.
3278
3279 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3280 corner of the window. It's black&white on non-GTK, because of
3281 limitations of X11. For a color icon, see |X11-icon|.
3282
3283 'm' Menu bar is present.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003284 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003285 that this flag must be added in the .vimrc file, before
3286 switching on syntax or filetype recognition (when the .gvimrc
3287 file is sourced the system menu has already been loaded; the
3288 ":syntax on" and ":filetype on" commands load the menu too).
3289 'g' Grey menu items: Make menu items that are not active grey. If
3290 'g' is not included inactive menu items are not shown at all.
3291 Exception: Athena will always use grey menu items.
3292
3293 't' Include tearoff menu items. Currently only works for Win32,
3294 GTK+, and Motif 1.2 GUI.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003295 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
3296 and Athena GUIs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003297
3298 'r' Right-hand scrollbar is always present.
3299 'R' Right-hand scrollbar is present when there is a vertically
3300 split window.
3301 'l' Left-hand scrollbar is always present.
3302 'L' Left-hand scrollbar is present when there is a vertically
3303 split window.
3304 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3305 the longest visible line, or on the cursor line if the 'h'
3306 flag is included. |gui-horiz-scroll|
3307 'h' Limit horizontal scrollbar size to the length of the cursor
3308 line. Reduces computations. |gui-horiz-scroll|
3309
3310 And yes, you may even have scrollbars on the left AND the right if
3311 you really want to :-). See |gui-scrollbars| for more information.
3312
3313 'v' Use a vertical button layout for dialogs. When not included,
3314 a horizontal layout is preferred, but when it doesn't fit a
3315 vertical layout is used anyway.
3316 'p' Use Pointer callbacks for X11 GUI. This is required for some
3317 window managers. If the cursor is not blinking or hollow at
3318 the right moment, try adding this flag. This must be done
3319 before starting the GUI. Set it in your gvimrc. Adding or
3320 removing it after the GUI has started has no effect.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003321 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003322
3323 *'guipty'* *'noguipty'*
3324'guipty' boolean (default on)
3325 global
3326 {not in Vi}
3327 {only available when compiled with GUI enabled}
3328 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3329 I/O to/from shell commands. See |gui-pty|.
3330
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003331 *'guitablabel'* *'gtl'*
3332'guitablabel' 'gtl' string (default empty)
3333 global
3334 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003335 {only available when compiled with GUI enabled and
3336 with the +windows feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003337 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003338 pages line. When empty Vim will use a default label. See
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003339 |setting-guitablabel| for more info.
3340
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003341 The format of this option is like that of 'statusline'.
3342
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003343 Only used when the GUI tab pages line is displayed. 'e' must be
3344 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3345 used.
3346
Bram Moolenaar071d4272004-06-13 20:20:40 +00003347 *'helpfile'* *'hf'*
3348'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3349 (others) "$VIMRUNTIME/doc/help.txt")
3350 global
3351 {not in Vi}
3352 Name of the main help file. All distributed help files should be
3353 placed together in one directory. Additionally, all "doc" directories
3354 in 'runtimepath' will be used.
3355 Environment variables are expanded |:set_env|. For example:
3356 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003357 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003358 spaces and backslashes.
3359 This option cannot be set from a |modeline| or in the |sandbox|, for
3360 security reasons.
3361
3362 *'helpheight'* *'hh'*
3363'helpheight' 'hh' number (default 20)
3364 global
3365 {not in Vi}
3366 {not available when compiled without the +windows
3367 feature}
3368 Minimal initial height of the help window when it is opened with the
3369 ":help" command. The initial height of the help window is half of the
3370 current window, or (when the 'ea' option is on) the same as other
3371 windows. When the height is less than 'helpheight', the height is
3372 set to 'helpheight'. Set to zero to disable.
3373
3374 *'helplang'* *'hlg'*
3375'helplang' 'hlg' string (default: messages language or empty)
3376 global
3377 {only available when compiled with the |+multi_lang|
3378 feature}
3379 {not in Vi}
3380 Comma separated list of languages. Vim will use the first language
3381 for which the desired help can be found. The English help will always
3382 be used as a last resort. You can add "en" to prefer English over
3383 another language, but that will only find tags that exist in that
3384 language and not in the English help.
3385 Example: >
3386 :set helplang=de,it
3387< This will first search German, then Italian and finally English help
3388 files.
3389 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3390 try to find the tag in the current language before using this option.
3391 See |help-translated|.
3392
3393 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3394'hidden' 'hid' boolean (default off)
3395 global
3396 {not in Vi}
3397 When off a buffer is unloaded when it is |abandon|ed. When on a
3398 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3399 displayed in another window, it does not become hidden, of course.
3400 The commands that move through the buffer list sometimes make a buffer
3401 hidden although the 'hidden' option is off: When the buffer is
3402 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003403 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003404 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003405 This option is set for one command with ":hide {command}" |:hide|.
3406 WARNING: It's easy to forget that you have changes in hidden buffers.
3407 Think twice when using ":q!" or ":qa!".
3408
3409 *'highlight'* *'hl'*
3410'highlight' 'hl' string (default (as a single string):
3411 "8:SpecialKey,@:NonText,d:Directory,
3412 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3413 M:ModeMsg,n:LineNr,r:Question,
3414 s:StatusLine,S:StatusLineNC,c:VertSplit
3415 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3416 f:Folded,F:FoldColumn,A:DiffAdd,
3417 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003418 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003419 R:SpellRare,L:SpellLocal,
3420 +:Pmenu,=:PmenuSel,
3421 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003422 global
3423 {not in Vi}
3424 This option can be used to set highlighting mode for various
3425 occasions. It is a comma separated list of character pairs. The
3426 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003427 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003428 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3429 |hl-NonText| @ '~' and '@' at the end of the window and
3430 characters from 'showbreak'
3431 |hl-Directory| d directories in CTRL-D listing and other special
3432 things in listings
3433 |hl-ErrorMsg| e error messages
3434 h (obsolete, ignored)
3435 |hl-IncSearch| i 'incsearch' highlighting
3436 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3437 |hl-MoreMsg| m |more-prompt|
3438 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
3439 |hl-LineNr| n line number for ":number" and ":#" commands
3440 |hl-Question| r |hit-enter| prompt and yes/no questions
3441 |hl-StatusLine| s status line of current window |status-line|
3442 |hl-StatusLineNC| S status lines of not-current windows
3443 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3444 |hl-VertSplit| c column used to separate vertically split windows
3445 |hl-Visual| v Visual mode
3446 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3447 Selection" Only X11 Gui's |gui-x11| and
3448 |xterm-clipboard|.
3449 |hl-WarningMsg| w warning messages
3450 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3451 |hl-Folded| f line used for closed folds
3452 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003453 |hl-DiffAdd| A added line in diff mode
3454 |hl-DiffChange| C changed line in diff mode
3455 |hl-DiffDelete| D deleted line in diff mode
3456 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003457 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003458 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003459 |hl-SpellCap| P word that should start with capital|spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003460 |hl-SpellRare| R rare word |spell|
3461 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003462 |hl-Pmenu| + popup menu normal line
3463 |hl-PmenuSel| = popup menu normal line
3464 |hl-PmenuSbar| x popup menu scrollbar
3465 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003466
3467 The display modes are:
3468 r reverse (termcap entry "mr" and "me")
3469 i italic (termcap entry "ZH" and "ZR")
3470 b bold (termcap entry "md" and "me")
3471 s standout (termcap entry "so" and "se")
3472 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003473 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003474 n no highlighting
3475 - no highlighting
3476 : use a highlight group
3477 The default is used for occasions that are not included.
3478 If you want to change what the display modes do, see |dos-colors|
3479 for an example.
3480 When using the ':' display mode, this must be followed by the name of
3481 a highlight group. A highlight group can be used to define any type
3482 of highlighting, including using color. See |:highlight| on how to
3483 define one. The default uses a different group for each occasion.
3484 See |highlight-default| for the default highlight groups.
3485
3486 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3487'hlsearch' 'hls' boolean (default off)
3488 global
3489 {not in Vi}
3490 {not available when compiled without the
3491 |+extra_search| feature}
3492 When there is a previous search pattern, highlight all its matches.
3493 The type of highlighting used can be set with the 'l' occasion in the
3494 'highlight' option. This uses the "Search" highlight group by
3495 default. Note that only the matching text is highlighted, any offsets
3496 are not applied.
3497 See also: 'incsearch' and |:match|.
3498 When you get bored looking at the highlighted matches, you can turn it
3499 off with |:nohlsearch|. As soon as you use a search command, the
3500 highlighting comes back.
3501 When the search pattern can match an end-of-line, Vim will try to
3502 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003503 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003504 line below a closed fold. A match in a previous line which is not
3505 drawn may not continue in an newly drawn line.
3506 NOTE: This option is reset when 'compatible' is set.
3507
3508 *'history'* *'hi'*
3509'history' 'hi' number (Vim default: 20, Vi default: 0)
3510 global
3511 {not in Vi}
3512 A history of ":" commands, and a history of previous search patterns
3513 are remembered. This option decides how many entries may be stored in
3514 each of these histories (see |cmdline-editing|).
3515 NOTE: This option is set to the Vi default value when 'compatible' is
3516 set and to the Vim default value when 'compatible' is reset.
3517
3518 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3519'hkmap' 'hk' boolean (default off)
3520 global
3521 {not in Vi}
3522 {only available when compiled with the |+rightleft|
3523 feature}
3524 When on, the keyboard is mapped for the Hebrew character set.
3525 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3526 toggle this option. See |rileft.txt|.
3527 NOTE: This option is reset when 'compatible' is set.
3528
3529 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3530'hkmapp' 'hkp' boolean (default off)
3531 global
3532 {not in Vi}
3533 {only available when compiled with the |+rightleft|
3534 feature}
3535 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3536 This is useful if you have a non-Hebrew keyboard.
3537 See |rileft.txt|.
3538 NOTE: This option is reset when 'compatible' is set.
3539
3540 *'icon'* *'noicon'*
3541'icon' boolean (default off, on when title can be restored)
3542 global
3543 {not in Vi}
3544 {not available when compiled without the |+title|
3545 feature}
3546 When on, the icon text of the window will be set to the value of
3547 'iconstring' (if it is not empty), or to the name of the file
3548 currently being edited. Only the last part of the name is used.
3549 Overridden by the 'iconstring' option.
3550 Only works if the terminal supports setting window icons (currently
3551 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3552 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3553 builtin termcap).
3554 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003555 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003556 X11.
3557
3558 *'iconstring'*
3559'iconstring' string (default "")
3560 global
3561 {not in Vi}
3562 {not available when compiled without the |+title|
3563 feature}
3564 When this option is not empty, it will be used for the icon text of
3565 the window. This happens only when the 'icon' option is on.
3566 Only works if the terminal supports setting window icon text
3567 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3568 Does not work for MS Windows.
3569 When Vim was compiled with HAVE_X11 defined, the original icon will be
3570 restored if possible |X11|.
3571 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003572 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003573 'titlestring' for example settings.
3574 {not available when compiled without the |+statusline| feature}
3575
3576 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3577'ignorecase' 'ic' boolean (default off)
3578 global
3579 Ignore case in search patterns. Also used when searching in the tags
3580 file.
3581 Also see 'smartcase'.
3582 Can be overruled by using "\c" or "\C" in the pattern, see
3583 |/ignorecase|.
3584
3585 *'imactivatekey'* *'imak'*
3586'imactivatekey' 'imak' string (default "")
3587 global
3588 {not in Vi}
3589 {only available when compiled with |+xim| and
3590 |+GUI_GTK|}
3591 Specifies the key that your Input Method in X-Windows uses for
3592 activation. When this is specified correctly, vim can fully control
3593 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3594 You can't use this option to change the activation key, the option
3595 tells Vim what the key is.
3596 Format:
3597 [MODIFIER_FLAG-]KEY_STRING
3598
3599 These characters can be used for MODIFIER_FLAG (case is ignored):
3600 S Shift key
3601 L Lock key
3602 C Control key
3603 1 Mod1 key
3604 2 Mod2 key
3605 3 Mod3 key
3606 4 Mod4 key
3607 5 Mod5 key
3608 Combinations are allowed, for example "S-C-space" or "SC-space" are
3609 both shift+ctrl+space.
3610 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3611
3612 Example: >
3613 :set imactivatekey=S-space
3614< "S-space" means shift+space. This is the activation key for kinput2 +
3615 canna (Japanese), and ami (Korean).
3616
3617 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3618'imcmdline' 'imc' boolean (default off)
3619 global
3620 {not in Vi}
3621 {only available when compiled with the |+xim|
3622 |+multi_byte_ime| or |global-ime| feature}
3623 When set the Input Method is always on when starting to edit a command
3624 line, unless entering a search pattern (see 'imsearch' for that).
3625 Setting this option is useful when your input method allows entering
3626 English characters directly, e.g., when it's used to type accented
3627 characters with dead keys.
3628
3629 *'imdisable'* *'imd'* *'nodisable'* *'noimd'*
3630'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3631 global
3632 {not in Vi}
3633 {only available when compiled with the |+xim|
3634 |+multi_byte_ime| or |global-ime| feature}
3635 When set the Input Method is never used. This is useful to disable
3636 the IM when it doesn't work properly.
3637 Currently this option is on by default for SGI/IRIX machines. This
3638 may change in later releases.
3639
3640 *'iminsert'* *'imi'*
3641'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3642 local to buffer
3643 {not in Vi}
3644 Specifies whether :lmap or an Input Method (IM) is to be used in
3645 Insert mode. Valid values:
3646 0 :lmap is off and IM is off
3647 1 :lmap is ON and IM is off
3648 2 :lmap is off and IM is ON
3649 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3650 or |global-ime|.
3651 To always reset the option to zero when leaving Insert mode with <Esc>
3652 this can be used: >
3653 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3654< This makes :lmap and IM turn off automatically when leaving Insert
3655 mode.
3656 Note that this option changes when using CTRL-^ in Insert mode
3657 |i_CTRL-^|.
3658 The value is set to 1 when setting 'keymap' to a valid keymap name.
3659 It is also used for the argument of commands like "r" and "f".
3660 The value 0 may not work correctly with Athena and Motif with some XIM
3661 methods. Use 'imdisable' to disable XIM then.
3662
3663 *'imsearch'* *'ims'*
3664'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3665 local to buffer
3666 {not in Vi}
3667 Specifies whether :lmap or an Input Method (IM) is to be used when
3668 entering a search pattern. Valid values:
3669 -1 the value of 'iminsert' is used, makes it look like
3670 'iminsert' is also used when typing a search pattern
3671 0 :lmap is off and IM is off
3672 1 :lmap is ON and IM is off
3673 2 :lmap is off and IM is ON
3674 Note that this option changes when using CTRL-^ in Command-line mode
3675 |c_CTRL-^|.
3676 The value is set to 1 when it is not -1 and setting the 'keymap'
3677 option to a valid keymap name.
3678 The value 0 may not work correctly with Athena and Motif with some XIM
3679 methods. Use 'imdisable' to disable XIM then.
3680
3681 *'include'* *'inc'*
3682'include' 'inc' string (default "^\s*#\s*include")
3683 global or local to buffer |global-local|
3684 {not in Vi}
3685 {not available when compiled without the
3686 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003687 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003688 pattern, just like for the "/" command (See |pattern|). The default
3689 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00003690 "]I", "[d", etc.
3691 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003692 comes after the matched pattern. But if "\zs" appears in the pattern
3693 then the text matched from "\zs" to the end, or until "\ze" if it
3694 appears, is used as the file name. Use this to include characters
3695 that are not in 'isfname', such as a space. You can then use
3696 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003697 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003698
3699 *'includeexpr'* *'inex'*
3700'includeexpr' 'inex' string (default "")
3701 local to buffer
3702 {not in Vi}
3703 {not available when compiled without the
3704 |+find_in_path| or |+eval| feature}
3705 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003706 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003707 :set includeexpr=substitute(v:fname,'\\.','/','g')
3708< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003709
Bram Moolenaar071d4272004-06-13 20:20:40 +00003710 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003711 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003712 Also used for |<cfile>|.
3713
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003714 The expression may be evaluated in the |sandbox|, see
3715 |sandbox-option|.
3716
3717 It is not allowed to change text or jump to another window while
3718 evaluating 'includeexpr' |textlock|.
3719
Bram Moolenaar071d4272004-06-13 20:20:40 +00003720 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3721'incsearch' 'is' boolean (default off)
3722 global
3723 {not in Vi}
3724 {not available when compiled without the
3725 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003726 While typing a search command, show where the pattern, as it was typed
3727 so far, matches. The matched string is highlighted. If the pattern
3728 is invalid or not found, nothing is shown. The screen will be updated
3729 often, this is only useful on fast terminals.
3730 Note that the match will be shown, but the cursor will return to its
3731 original position when no match is found and when pressing <Esc>. You
3732 still need to finish the search command with <Enter> to move the
3733 cursor to the match.
3734 The highlighting can be set with the 'i' flag in 'highlight'.
3735 See also: 'hlsearch'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003736 NOTE: This option is reset when 'compatible' is set.
3737
3738 *'indentexpr'* *'inde'*
3739'indentexpr' 'inde' string (default "")
3740 local to buffer
3741 {not in Vi}
3742 {not available when compiled without the |+cindent|
3743 or |+eval| features}
3744 Expression which is evaluated to obtain the proper indent for a line.
3745 It is used when a new line is created, for the |=| operator and
3746 in Insert mode as specified with the 'indentkeys' option.
3747 When this option is not empty, it overrules the 'cindent' and
3748 'smartindent' indenting.
3749 When 'paste' is set this option is not used for indenting.
3750 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003751 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00003752 when the expression is evaluated (but it may be moved around).
3753 The expression must return the number of spaces worth of indent. It
3754 can return "-1" to keep the current indent (this means 'autoindent' is
3755 used for the indent).
3756 Functions useful for computing the indent are |indent()|, |cindent()|
3757 and |lispindent()|.
3758 The evaluation of the expression must not have side effects! It must
3759 not change the text, jump to another window, etc. Afterwards the
3760 cursor position is always restored, thus the cursor may be moved.
3761 Normally this option would be set to call a function: >
3762 :set indentexpr=GetMyIndent()
3763< Error messages will be suppressed, unless the 'debug' option contains
3764 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003765 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003766 NOTE: This option is made empty when 'compatible' is set.
3767
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003768 The expression may be evaluated in the |sandbox|, see
3769 |sandbox-option|.
3770
3771 It is not allowed to change text or jump to another window while
3772 evaluating 'indentexpr' |textlock|.
3773
3774
Bram Moolenaar071d4272004-06-13 20:20:40 +00003775 *'indentkeys'* *'indk'*
3776'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
3777 local to buffer
3778 {not in Vi}
3779 {not available when compiled without the |+cindent|
3780 feature}
3781 A list of keys that, when typed in Insert mode, cause reindenting of
3782 the current line. Only happens if 'indentexpr' isn't empty.
3783 The format is identical to 'cinkeys', see |indentkeys-format|.
3784 See |C-indenting| and |indent-expression|.
3785
3786 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
3787'infercase' 'inf' boolean (default off)
3788 local to buffer
3789 {not in Vi}
3790 When doing keyword completion in insert mode |ins-completion|, and
3791 'ignorecase' is also on, the case of the match is adjusted. If the
3792 typed text contains a lowercase letter where the match has an upper
3793 case letter, the completed part is made lowercase. If the typed text
3794 has no lowercase letters and the match has a lowercase letter where
3795 the typed text has an uppercase letter, and there is a letter before
3796 it, the completed part is made uppercase.
3797
3798 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
3799'insertmode' 'im' boolean (default off)
3800 global
3801 {not in Vi}
3802 Makes Vim work in a way that Insert mode is the default mode. Useful
3803 if you want to use Vim as a modeless editor. Used for |evim|.
3804 These Insert mode commands will be useful:
3805 - Use the cursor keys to move around.
3806 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
3807 this is a mapping, it is executed as if 'insertmode' was off.
3808 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003809 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00003810 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
3811 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003812
3813 These items change when 'insertmode' is set:
3814 - when starting to edit of a file, Vim goes to Insert mode.
3815 - <Esc> in Insert mode is a no-op and beeps.
3816 - <Esc> in Normal mode makes Vim go to Insert mode.
3817 - CTRL-L in Insert mode is a command, it is not inserted.
3818 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
3819 However, when <Esc> is used inside a mapping, it behaves like
3820 'insertmode' was not set. This was done to be able to use the same
3821 mappings with 'insertmode' set or not set.
3822 When executing commands with |:normal| 'insertmode' is not used.
3823
3824 NOTE: This option is reset when 'compatible' is set.
3825
3826 *'isfname'* *'isf'*
3827'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
3828 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
3829 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
3830 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
3831 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
3832 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
3833 global
3834 {not in Vi}
3835 The characters specified by this option are included in file names and
3836 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003837 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003838 Multi-byte characters 256 and above are always included, only the
3839 characters up to 255 are specified with this option.
3840 For UTF-8 the characters 0xa0 to 0xff are included as well.
3841
3842 Note that on systems using a backslash as path separator, Vim tries to
3843 do its best to make it work as you would expect. That is a bit
3844 tricky, since Vi originally used the backslash to escape special
3845 characters. Vim will not remove a backslash in front of a normal file
3846 name character on these systems, but it will on Unix and alikes. The
3847 '&' and '^' are not included by default, because these are special for
3848 cmd.exe.
3849
3850 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003851 Each part can be a single character number or a range. A range is two
3852 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003853 decimal number between 0 and 255 or the ASCII character itself (does
3854 not work for digits). Example:
3855 "_,-,128-140,#-43" (include '_' and '-' and the range
3856 128 to 140 and '#' to 43)
3857 If a part starts with '^', the following character number or range
3858 will be excluded from the option. The option is interpreted from left
3859 to right. Put the excluded character after the range where it is
3860 included. To include '^' itself use it as the last character of the
3861 option or the end of a range. Example:
3862 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
3863 If the character is '@', all characters where isalpha() returns TRUE
3864 are included. Normally these are the characters a to z and A to Z,
3865 plus accented characters. To include '@' itself use "@-@". Examples:
3866 "@,^a-z" All alphabetic characters, excluding lower
3867 case letters.
3868 "a-z,A-Z,@-@" All letters plus the '@' character.
3869 A comma can be included by using it where a character number is
3870 expected. Example:
3871 "48-57,,,_" Digits, comma and underscore.
3872 A comma can be excluded by prepending a '^'. Example:
3873 " -~,^,,9" All characters from space to '~', excluding
3874 comma, plus <Tab>.
3875 See |option-backslash| about including spaces and backslashes.
3876
3877 *'isident'* *'isi'*
3878'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
3879 "@,48-57,_,128-167,224-235"
3880 otherwise: "@,48-57,_,192-255")
3881 global
3882 {not in Vi}
3883 The characters given by this option are included in identifiers.
3884 Identifiers are used in recognizing environment variables and after a
3885 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00003886 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00003887 option.
3888 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003889 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003890 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
3891
3892 *'iskeyword'* *'isk'*
3893'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
3894 "@,48-57,_,128-167,224-235"
3895 otherwise: "@,48-57,_,192-255"
3896 Vi default: "@,48-57,_")
3897 local to buffer
3898 {not in Vi}
3899 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003900 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003901 'isfname' for a description of the format of this option. For C
3902 programs you could use "a-z,A-Z,48-57,_,.,-,>".
3903 For a help file it is set to all non-blank printable characters except
3904 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
3905 command).
3906 When the 'lisp' option is on the '-' character is always included.
3907 NOTE: This option is set to the Vi default value when 'compatible' is
3908 set and to the Vim default value when 'compatible' is reset.
3909
3910 *'isprint'* *'isp'*
3911'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
3912 "@,~-255"; otherwise: "@,161-255")
3913 global
3914 {not in Vi}
3915 The characters given by this option are displayed directly on the
3916 screen. It is also used for "\p" in a |pattern|. The characters from
3917 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
3918 even when they are not included in 'isprint' or excluded. See
3919 'isfname' for a description of the format of this option.
3920
3921 Non-printable characters are displayed with two characters:
3922 0 - 31 "^@" - "^_"
3923 32 - 126 always single characters
3924 127 "^?"
3925 128 - 159 "~@" - "~_"
3926 160 - 254 "| " - "|~"
3927 255 "~?"
3928 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
3929 displayed as <xx>, with the hexadecimal value of the byte.
3930 When 'display' contains "uhex" all unprintable characters are
3931 displayed as <xx>.
3932 The NonText highlighting will be used for unprintable characters.
3933 |hl-NonText|
3934
3935 Multi-byte characters 256 and above are always included, only the
3936 characters up to 255 are specified with this option. When a character
3937 is printable but it is not available in the current font, a
3938 replacement character will be shown.
3939 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
3940 There is no option to specify these characters.
3941
3942 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
3943'joinspaces' 'js' boolean (default on)
3944 global
3945 {not in Vi}
3946 Insert two spaces after a '.', '?' and '!' with a join command.
3947 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
3948 Otherwise only one space is inserted.
3949 NOTE: This option is set when 'compatible' is set.
3950
3951 *'key'*
3952'key' string (default "")
3953 local to buffer
3954 {not in Vi}
3955 The key that is used for encrypting and decrypting the current buffer.
3956 See |encryption|.
3957 Careful: Do not set the key value by hand, someone might see the typed
3958 key. Use the |:X| command. But you can make 'key' empty: >
3959 :set key=
3960< It is not possible to get the value of this option with ":set key" or
3961 "echo &key". This is to avoid showing it to someone who shouldn't
3962 know. It also means you cannot see it yourself once you have set it,
3963 be careful not to make a typing error!
3964
3965 *'keymap'* *'kmp'* *E544*
3966'keymap' 'kmp' string (default "")
3967 local to buffer
3968 {not in Vi}
3969 {only available when compiled with the |+keymap|
3970 feature}
3971 Name of a keyboard mapping. See |mbyte-keymap|.
3972 Setting this option to a valid keymap name has the side effect of
3973 setting 'iminsert' to one, so that the keymap becomes effective.
3974 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003975 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003976
3977 *'keymodel'* *'km'*
3978'keymodel' 'km' string (default "")
3979 global
3980 {not in Vi}
3981 List of comma separated words, which enable special things that keys
3982 can do. These values can be used:
3983 startsel Using a shifted special key starts selection (either
3984 Select mode or Visual mode, depending on "key" being
3985 present in 'selectmode').
3986 stopsel Using a not-shifted special key stops selection.
3987 Special keys in this context are the cursor keys, <End>, <Home>,
3988 <PageUp> and <PageDown>.
3989 The 'keymodel' option is set by the |:behave| command.
3990
3991 *'keywordprg'* *'kp'*
3992'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
3993 OS/2: "view /", VMS: "help")
3994 global or local to buffer |global-local|
3995 {not in Vi}
3996 Program to use for the |K| command. Environment variables are
3997 expanded |:set_env|. ":help" may be used to access the Vim internal
3998 help. (Note that previously setting the global option to the empty
3999 value did this, which is now deprecated.)
4000 When "man" is used, Vim will automatically translate a count for the
4001 "K" command to a section number. Also for "man -s", in which case the
4002 "-s" is removed when there is no count.
4003 See |option-backslash| about including spaces and backslashes.
4004 Example: >
4005 :set keywordprg=man\ -s
4006< This option cannot be set from a |modeline| or in the |sandbox|, for
4007 security reasons.
4008
4009 *'langmap'* *'lmap'* *E357* *E358*
4010'langmap' 'lmap' string (default "")
4011 global
4012 {not in Vi}
4013 {only available when compiled with the |+langmap|
4014 feature}
4015 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004016 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004017 inserted directly. When in command mode the 'langmap' option takes
4018 care of translating these special characters to the original meaning
4019 of the key. This means you don't have to change the keyboard mode to
4020 be able to execute Normal mode commands.
4021 This is the opposite of the 'keymap' option, where characters are
4022 mapped in Insert mode.
4023 This only works for 8-bit characters. The value of 'langmap' may be
4024 specified with multi-byte characters (e.g., UTF-8), but only the lower
4025 8 bits of each character will be used.
4026
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004027 Example (for Greek, in UTF-8): *greek* >
4028 :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
Bram Moolenaar071d4272004-06-13 20:20:40 +00004029< Example (exchanges meaning of z and y for commands): >
4030 :set langmap=zy,yz,ZY,YZ
4031<
4032 The 'langmap' option is a list of parts, separated with commas. Each
4033 part can be in one of two forms:
4034 1. A list of pairs. Each pair is a "from" character immediately
4035 followed by the "to" character. Examples: "aA", "aAbBcC".
4036 2. A list of "from" characters, a semi-colon and a list of "to"
4037 characters. Example: "abc;ABC"
4038 Example: "aA,fgh;FGH,cCdDeE"
4039 Special characters need to be preceded with a backslash. These are
4040 ";", ',' and backslash itself.
4041
4042 This will allow you to activate vim actions without having to switch
4043 back and forth between the languages. Your language characters will
4044 be understood as normal vim English characters (according to the
4045 langmap mappings) in the following cases:
4046 o Normal/Visual mode (commands, buffer/register names, user mappings)
4047 o Insert/Replace Mode: Register names after CTRL-R
4048 o Insert/Replace Mode: Mappings
4049 Characters entered in Command-line mode will NOT be affected by
4050 this option. Note that this option can be changed at any time
4051 allowing to switch between mappings for different languages/encodings.
4052 Use a mapping to avoid having to type it each time!
4053
4054 *'langmenu'* *'lm'*
4055'langmenu' 'lm' string (default "")
4056 global
4057 {not in Vi}
4058 {only available when compiled with the |+menu| and
4059 |+multi_lang| features}
4060 Language to use for menu translation. Tells which file is loaded
4061 from the "lang" directory in 'runtimepath': >
4062 "lang/menu_" . &langmenu . ".vim"
4063< (without the spaces). For example, to always use the Dutch menus, no
4064 matter what $LANG is set to: >
4065 :set langmenu=nl_NL.ISO_8859-1
4066< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004067 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004068 If your $LANG is set to a non-English language but you do want to use
4069 the English menus: >
4070 :set langmenu=none
4071< This option must be set before loading menus, switching on filetype
4072 detection or syntax highlighting. Once the menus are defined setting
4073 this option has no effect. But you could do this: >
4074 :source $VIMRUNTIME/delmenu.vim
4075 :set langmenu=de_DE.ISO_8859-1
4076 :source $VIMRUNTIME/menu.vim
4077< Warning: This deletes all menus that you defined yourself!
4078
4079 *'laststatus'* *'ls'*
4080'laststatus' 'ls' number (default 1)
4081 global
4082 {not in Vi}
4083 The value of this option influences when the last window will have a
4084 status line:
4085 0: never
4086 1: only if there are at least two windows
4087 2: always
4088 The screen looks nicer with a status line if you have several
4089 windows, but it takes another screen line. |status-line|
4090
4091 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4092'lazyredraw' 'lz' boolean (default off)
4093 global
4094 {not in Vi}
4095 When this option is set, the screen will not be redrawn while
4096 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004097 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004098 update use |:redraw|.
4099
4100 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4101'linebreak' 'lbr' boolean (default off)
4102 local to window
4103 {not in Vi}
4104 {not available when compiled without the |+linebreak|
4105 feature}
4106 If on Vim will wrap long lines at a character in 'breakat' rather
4107 than at the last character that fits on the screen. Unlike
4108 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4109 it only affects the way the file is displayed, not its contents. The
4110 value of 'showbreak' is used to put in front of wrapped lines.
4111 This option is not used when the 'wrap' option is off or 'list' is on.
4112 Note that <Tab> characters after an <EOL> are mostly not displayed
4113 with the right amount of white space.
4114
4115 *'lines'* *E593*
4116'lines' number (default 24 or terminal height)
4117 global
4118 Number of lines of the Vim window.
4119 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004120 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004121 When Vim is running in the GUI or in a resizable window, setting this
4122 option will cause the window size to be changed. When you only want
4123 to use the size for the GUI, put the command in your |gvimrc| file.
4124 Vim limits the number of lines to what fits on the screen. You can
4125 use this command to get the tallest window possible: >
4126 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004127< Minimum value is 2, maximum value is 1000.
4128 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004129 When you set this option and Vim is unable to change the physical
4130 number of lines of the display, the display may be messed up.
4131
4132 *'linespace'* *'lsp'*
4133'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4134 global
4135 {not in Vi}
4136 {only in the GUI}
4137 Number of pixel lines inserted between characters. Useful if the font
4138 uses the full character cell height, making lines touch each other.
4139 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004140 With some fonts there can be too much room between lines (to have
4141 space for ascents and descents). Then it makes sense to set
4142 'linespace' to a negative value. This may cause display problems
4143 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004144
4145 *'lisp'* *'nolisp'*
4146'lisp' boolean (default off)
4147 local to buffer
4148 {not available when compiled without the |+lispindent|
4149 feature}
4150 Lisp mode: When <Enter> is typed in insert mode set the indent for
4151 the next line to Lisp standards (well, sort of). Also happens with
4152 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4153 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4154 better. Also see 'lispwords'.
4155 The '-' character is included in keyword characters. Redefines the
4156 "=" operator to use this same indentation algorithm rather than
4157 calling an external program if 'equalprg' is empty.
4158 This option is not used when 'paste' is set.
4159 {Vi: Does it a little bit differently}
4160
4161 *'lispwords'* *'lw'*
4162'lispwords' 'lw' string (default is very long)
4163 global
4164 {not in Vi}
4165 {not available when compiled without the |+lispindent|
4166 feature}
4167 Comma separated list of words that influence the Lisp indenting.
4168 |'lisp'|
4169
4170 *'list'* *'nolist'*
4171'list' boolean (default off)
4172 local to window
4173 List mode: Show tabs as CTRL-I, show end of line with $. Useful to
4174 see the difference between tabs and spaces and for trailing blanks.
4175 Note that this will also affect formatting (set with 'textwidth' or
4176 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
4177 changing the way tabs are displayed.
4178
4179 *'listchars'* *'lcs'*
4180'listchars' 'lcs' string (default "eol:$")
4181 global
4182 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004183 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004184 settings.
4185 eol:c Character to show at the end of each line. When
4186 omitted, there is no extra character at the end of the
4187 line.
4188 tab:xy Two characters to be used to show a Tab. The first
4189 char is used once. The second char is repeated to
4190 fill the space that the Tab normally occupies.
4191 "tab:>-" will show a Tab that takes four spaces as
4192 ">---". When omitted, a Tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004193 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004194 trailing spaces are blank.
4195 extends:c Character to show in the last column, when 'wrap' is
4196 off and the line continues beyond the right of the
4197 screen.
4198 precedes:c Character to show in the first column, when 'wrap'
4199 is off and there is text preceding the character
4200 visible in the first column.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004201 nbsp:c Character to show for a non-breakable space (character
4202 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004203
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004204 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004205 be used when 'encoding' is "utf-8", otherwise only printable
4206 characters are allowed.
4207
4208 Examples: >
4209 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004210 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004211 :set lcs=extends:>,precedes:<
4212< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004213 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004214
4215 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4216'loadplugins' 'lpl' boolean (default on)
4217 global
4218 {not in Vi}
4219 When on the plugin scripts are loaded when starting up |load-plugins|.
4220 This option can be reset in your |vimrc| file to disable the loading
4221 of plugins.
4222 Note that using the "-u NONE" and "--noplugin" command line arguments
4223 reset this option. |-u| |--noplugin|
4224
4225 *'magic'* *'nomagic'*
4226'magic' boolean (default on)
4227 global
4228 Changes the special characters that can be used in search patterns.
4229 See |pattern|.
4230 NOTE: To avoid portability problems with using patterns, always keep
4231 this option at the default "on". Only switch it off when working with
4232 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004233 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004234
4235 *'makeef'* *'mef'*
4236'makeef' 'mef' string (default: "")
4237 global
4238 {not in Vi}
4239 {not available when compiled without the |+quickfix|
4240 feature}
4241 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4242 and the |:grep| command.
4243 When it is empty, an internally generated temp file will be used.
4244 When "##" is included, it is replaced by a number to make the name
4245 unique. This makes sure that the ":make" command doesn't overwrite an
4246 existing file.
4247 NOT used for the ":cf" command. See 'errorfile' for that.
4248 Environment variables are expanded |:set_env|.
4249 See |option-backslash| about including spaces and backslashes.
4250 This option cannot be set from a |modeline| or in the |sandbox|, for
4251 security reasons.
4252
4253 *'makeprg'* *'mp'*
4254'makeprg' 'mp' string (default "make", VMS: "MMS")
4255 global or local to buffer |global-local|
4256 {not in Vi}
4257 Program to use for the ":make" command. See |:make_makeprg|. This
4258 option may contain '%' and '#' characters, which are expanded like
4259 when used in a command-line. Environment variables are expanded
4260 |:set_env|. See |option-backslash| about including spaces and
4261 backslashes. Note that a '|' must be escaped twice: once for ":set"
4262 and once for the interpretation of a command. When you use a filter
4263 called "myfilter" do it like this: >
4264 :set makeprg=gmake\ \\\|\ myfilter
4265< The placeholder "$*" can be given (even multiple times) to specify
4266 where the arguments will be included, for example: >
4267 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4268< This option cannot be set from a |modeline| or in the |sandbox|, for
4269 security reasons.
4270
4271 *'matchpairs'* *'mps'*
4272'matchpairs' 'mps' string (default "(:),{:},[:]")
4273 local to buffer
4274 {not in Vi}
4275 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004276 other. Currently only single character pairs are allowed, and they
Bram Moolenaar071d4272004-06-13 20:20:40 +00004277 must be different. The characters must be separated by a colon. The
4278 pairs must be separated by a comma. Example for including '<' and '>'
4279 (HTML): >
4280 :set mps+=<:>
4281
4282< A more exotic example, to jump between the '=' and ';' in an
4283 assignment, useful for languages like C and Java: >
4284 :au FileType c,cpp,java set mps+==:;
4285
4286< For a more advanced way of using "%", see the matchit.vim plugin in
4287 the $VIMRUNTIME/macros directory. |add-local-help|
4288
4289 *'matchtime'* *'mat'*
4290'matchtime' 'mat' number (default 5)
4291 global
4292 {not in Vi}{in Nvi}
4293 Tenths of a second to show the matching paren, when 'showmatch' is
4294 set. Note that this is not in milliseconds, like other options that
4295 set a time. This is to be compatible with Nvi.
4296
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004297 *'maxcombine'* *'mco'*
4298'maxcombine' 'mco' number (default 2)
4299 global
4300 {not in Vi}
4301 {only available when compiled with the |+multi_byte|
4302 feature}
4303 The maximum number of combining characters supported for displaying.
4304 Only used when 'encoding' is "utf-8".
4305 The default is OK for most languages. Hebrew may require 4.
4306 Maximum value is 6.
4307 Even when this option is set to 2 you can still edit text with more
4308 combining characters, you just can't see them. Use |g8| or |ga|.
4309 See |mbyte-combining|.
4310
Bram Moolenaar071d4272004-06-13 20:20:40 +00004311 *'maxfuncdepth'* *'mfd'*
4312'maxfuncdepth' 'mfd' number (default 100)
4313 global
4314 {not in Vi}
4315 Maximum depth of function calls for user functions. This normally
4316 catches endless recursion. When using a recursive function with
4317 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4318 more memory, there is the danger of failing when memory is exhausted.
4319 See also |:function|.
4320
4321 *'maxmapdepth'* *'mmd'* *E223*
4322'maxmapdepth' 'mmd' number (default 1000)
4323 global
4324 {not in Vi}
4325 Maximum number of times a mapping is done without resulting in a
4326 character to be used. This normally catches endless mappings, like
4327 ":map x y" with ":map y x". It still does not catch ":map g wg",
4328 because the 'w' is used before the next mapping is done. See also
4329 |key-mapping|.
4330
4331 *'maxmem'* *'mm'*
4332'maxmem' 'mm' number (default between 256 to 5120 (system
4333 dependent) or half the amount of memory
4334 available)
4335 global
4336 {not in Vi}
4337 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4338 limit is reached allocating extra memory for a buffer will cause
4339 other memory to be freed. Maximum value 2000000. Use this to work
4340 without a limit. Also see 'maxmemtot'.
4341
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004342 *'maxmempattern'* *'mmp'*
4343'maxmempattern' 'mmp' number (default 1000)
4344 global
4345 {not in Vi}
4346 Maximum amount of memory (in Kbyte) to use for pattern matching.
4347 Maximum value 2000000. Use this to work without a limit.
4348 *E363*
4349 When Vim runs into the limit it gives an error message mostly behaves
4350 like CTRL-C was typed.
4351 Running into the limit often means that the pattern is very
4352 inefficient or too complex. This may already happen with the pattern
4353 "\(.\)*" on a very long line. ".*" works much better.
4354 Vim may run out of memory before hitting the 'maxmempattern' limit.
4355
Bram Moolenaar071d4272004-06-13 20:20:40 +00004356 *'maxmemtot'* *'mmt'*
4357'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4358 dependent) or half the amount of memory
4359 available)
4360 global
4361 {not in Vi}
4362 Maximum amount of memory (in Kbyte) to use for all buffers together.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004363 Maximum value 2000000. Use this to work without a limit. Also see
Bram Moolenaar071d4272004-06-13 20:20:40 +00004364 'maxmem'.
4365
4366 *'menuitems'* *'mis'*
4367'menuitems' 'mis' number (default 25)
4368 global
4369 {not in Vi}
4370 {not available when compiled without the |+menu|
4371 feature}
4372 Maximum number of items to use in a menu. Used for menus that are
4373 generated from a list of items, e.g., the Buffers menu. Changing this
4374 option has no direct effect, the menu must be refreshed first.
4375
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004376 *'mkspellmem'* *'msm'*
4377'mkspellmem' 'msm' string (default "460000,2000,500")
4378 global
4379 {not in Vi}
4380 {not available when compiled without the |+syntax|
4381 feature}
4382 Parameters for |:mkspell|. This tunes when to start compressing the
4383 word tree. Compression can be slow when there are many words, but
4384 it's needed to avoid running out of memory. The amount of memory used
4385 per word depends very much on how similar the words are, that's why
4386 this tuning is complicated.
4387
4388 There are three numbers, separated by commas:
4389 {start},{inc},{added}
4390
4391 For most languages the uncompressed word tree fits in memory. {start}
4392 gives the amount of memory in Kbyte that can be used before any
4393 compression is done. It should be a bit smaller than the amount of
4394 memory that is available to Vim.
4395
4396 When going over the {start} limit the {inc} number specifies the
4397 amount of memory in Kbyte that can be allocated before another
4398 compression is done. A low number means compression is done after
4399 less words are added, which is slow. A high number means more memory
4400 will be allocated.
4401
4402 After doing compression, {added} times 1024 words can be added before
4403 the {inc} limit is ignored and compression is done when any extra
4404 amount of memory is needed. A low number means there is a smaller
4405 chance of hitting the {inc} limit, less memory is used but it's
4406 slower.
4407
4408 The languages for which these numbers are important are Italian and
4409 Hungarian. The default works for when you have about 512 Mbyte. If
4410 you have 1 Gbyte you could use: >
4411 :set mkspellmem=900000,3000,800
4412< If you have less than 512 Mbyte |:mkspell| may fail for some
4413 languages, no matter what you set 'mkspellmem' to.
4414
Bram Moolenaar071d4272004-06-13 20:20:40 +00004415 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
4416'modeline' 'ml' boolean (Vim default: on, Vi default: off)
4417 local to buffer
4418 *'modelines'* *'mls'*
4419'modelines' 'mls' number (default 5)
4420 global
4421 {not in Vi}
4422 If 'modeline' is on 'modelines' gives the number of lines that is
4423 checked for set commands. If 'modeline' is off or 'modelines' is zero
4424 no lines are checked. See |modeline|.
4425 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4426 set and to the Vim default value when 'compatible' is reset.
4427
4428 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4429'modifiable' 'ma' boolean (default on)
4430 local to buffer
4431 {not in Vi} *E21*
4432 When off the buffer contents cannot be changed. The 'fileformat' and
4433 'fileencoding' options also can't be changed.
4434 Can be reset with the |-M| command line argument.
4435
4436 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4437'modified' 'mod' boolean (default off)
4438 local to buffer
4439 {not in Vi}
4440 When on, the buffer is considered to be modified. This option is set
4441 when:
4442 1. A change was made to the text since it was last written. Using the
4443 |undo| command to go back to the original text will reset the
4444 option. But undoing changes that were made before writing the
4445 buffer will set the option again, since the text is different from
4446 when it was written.
4447 2. 'fileformat' or 'fileencoding' is different from its original
4448 value. The original value is set when the buffer is read or
4449 written. A ":set nomodified" command also resets the original
4450 values to the current values and the 'modified' option will be
4451 reset.
4452 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4453 will be ignored.
4454
4455 *'more'* *'nomore'*
4456'more' boolean (Vim default: on, Vi default: off)
4457 global
4458 {not in Vi}
4459 When on, listings pause when the whole screen is filled. You will get
4460 the |more-prompt|. When this option is off there are no pauses, the
4461 listing continues until finished.
4462 NOTE: This option is set to the Vi default value when 'compatible' is
4463 set and to the Vim default value when 'compatible' is reset.
4464
4465 *'mouse'* *E538*
4466'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4467 global
4468 {not in Vi}
4469 Enable the use of the mouse. Only works for certain terminals
4470 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, and Linux console
4471 with gpm). For using the mouse in the GUI, see |gui-mouse|.
4472 The mouse can be enabled for different modes:
4473 n Normal mode
4474 v Visual mode
4475 i Insert mode
4476 c Command-line mode
4477 h all previous modes when editing a help file
4478 a all previous modes
4479 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004480 Normally you would enable the mouse in all four modes with: >
4481 :set mouse=a
4482< When the mouse is not enabled, the GUI will still use the mouse for
4483 modeless selection. This doesn't move the text cursor.
4484
4485 See |mouse-using|. Also see |'clipboard'|.
4486
4487 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004488 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004489 the mouse buttons can still be used by keeping the shift key pressed.
4490 Also see the 'clipboard' option.
4491
4492 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4493'mousefocus' 'mousef' boolean (default off)
4494 global
4495 {not in Vi}
4496 {only works in the GUI}
4497 The window that the mouse pointer is on is automatically activated.
4498 When changing the window layout or window focus in another way, the
4499 mouse pointer is moved to the window with keyboard focus. Off is the
4500 default because it makes using the pull down menus a little goofy, as
4501 a pointer transit may activate a window unintentionally.
4502
4503 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4504'mousehide' 'mh' boolean (default on)
4505 global
4506 {not in Vi}
4507 {only works in the GUI}
4508 When on, the mouse pointer is hidden when characters are typed.
4509 The mouse pointer is restored when the mouse is moved.
4510
4511 *'mousemodel'* *'mousem'*
4512'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4513 global
4514 {not in Vi}
4515 Sets the model to use for the mouse. The name mostly specifies what
4516 the right mouse button is used for:
4517 extend Right mouse button extends a selection. This works
4518 like in an xterm.
4519 popup Right mouse button pops up a menu. The shifted left
4520 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004521 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004522 popup_setpos Like "popup", but the cursor will be moved to the
4523 position where the mouse was clicked, and thus the
4524 selected operation will act upon the clicked object.
4525 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004526 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004527 course, that right clicking outside a selection will
4528 end Visual mode.
4529 Overview of what button does what for each model:
4530 mouse extend popup(_setpos) ~
4531 left click place cursor place cursor
4532 left drag start selection start selection
4533 shift-left search word extend selection
4534 right click extend selection popup menu (place cursor)
4535 right drag extend selection -
4536 middle click paste paste
4537
4538 In the "popup" model the right mouse button produces a pop-up menu.
4539 You need to define this first, see |popup-menu|.
4540
4541 Note that you can further refine the meaning of buttons with mappings.
4542 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4543 selection (because that's handled in the GUI code directly).
4544
4545 The 'mousemodel' option is set by the |:behave| command.
4546
4547 *'mouseshape'* *'mouses'* *E547*
4548'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004549 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004550 global
4551 {not in Vi}
4552 {only available when compiled with the |+mouseshape|
4553 feature}
4554 This option tells Vim what the mouse pointer should look like in
4555 different modes. The option is a comma separated list of parts, much
4556 like used for 'guicursor'. Each part consist of a mode/location-list
4557 and an argument-list:
4558 mode-list:shape,mode-list:shape,..
4559 The mode-list is a dash separated list of these modes/locations:
4560 In a normal window: ~
4561 n Normal mode
4562 v Visual mode
4563 ve Visual mode with 'selection' "exclusive" (same as 'v',
4564 if not specified)
4565 o Operator-pending mode
4566 i Insert mode
4567 r Replace mode
4568
4569 Others: ~
4570 c appending to the command-line
4571 ci inserting in the command-line
4572 cr replacing in the command-line
4573 m at the 'Hit ENTER' or 'More' prompts
4574 ml idem, but cursor in the last line
4575 e any mode, pointer below last window
4576 s any mode, pointer on a status line
4577 sd any mode, while dragging a status line
4578 vs any mode, pointer on a vertical separator line
4579 vd any mode, while dragging a vertical separator line
4580 a everywhere
4581
4582 The shape is one of the following:
4583 avail name looks like ~
4584 w x arrow Normal mouse pointer
4585 w x blank no pointer at all (use with care!)
4586 w x beam I-beam
4587 w x updown up-down sizing arrows
4588 w x leftright left-right sizing arrows
4589 w x busy The system's usual busy pointer
4590 w x no The system's usual 'no input' pointer
4591 x udsizing indicates up-down resizing
4592 x lrsizing indicates left-right resizing
4593 x crosshair like a big thin +
4594 x hand1 black hand
4595 x hand2 white hand
4596 x pencil what you write with
4597 x question big ?
4598 x rightup-arrow arrow pointing right-up
4599 w x up-arrow arrow pointing up
4600 x <number> any X11 pointer number (see X11/cursorfont.h)
4601
4602 The "avail" column contains a 'w' if the shape is available for Win32,
4603 x for X11.
4604 Any modes not specified or shapes not available use the normal mouse
4605 pointer.
4606
4607 Example: >
4608 :set mouseshape=s:udsizing,m:no
4609< will make the mouse turn to a sizing arrow over the status lines and
4610 indicate no input when the hit-enter prompt is displayed (since
4611 clicking the mouse has no effect in this state.)
4612
4613 *'mousetime'* *'mouset'*
4614'mousetime' 'mouset' number (default 500)
4615 global
4616 {not in Vi}
4617 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4618 time in msec between two mouse clicks for the second click to be
4619 recognized as a multi click.
4620
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004621 *'mzquantum'* *'mzq'*
4622'mzquantum' 'mzq' number (default 100)
4623 global
4624 {not in Vi}
4625 {not available when compiled without the |+mzscheme|
4626 feature}
4627 The number of milliseconds between polls for MzScheme threads.
4628 Negative or zero value means no thread scheduling.
4629
Bram Moolenaar071d4272004-06-13 20:20:40 +00004630 *'nrformats'* *'nf'*
4631'nrformats' 'nf' string (default "octal,hex")
4632 local to buffer
4633 {not in Vi}
4634 This defines what bases Vim will consider for numbers when using the
4635 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4636 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004637 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004638 incremented or decremented. This is useful for a list with a
4639 letter index a), b), etc.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004640 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00004641 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00004642 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004643 considered to be hexadecimal. Example: Using CTRL-X on
4644 "0x100" results in "0x0ff".
4645 Numbers which simply begin with a digit in the range 1-9 are always
4646 considered decimal. This also happens for numbers that are not
4647 recognized as octal or hex.
4648
4649 *'number'* *'nu'* *'nonumber'* *'nonu'*
4650'number' 'nu' boolean (default off)
4651 local to window
4652 Print the line number in front of each line. When the 'n' option is
4653 excluded from 'cpoptions' a wrapped line will not use the column of
4654 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004655 The 'numberwidth' option can be used to set the room used for the line
4656 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004657 When a long, wrapped line doesn't start with the first character, '-'
4658 characters are put before the number.
4659 See |hl-LineNr| for the highlighting used for the number.
4660
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004661 *'numberwidth'* *'nuw'*
4662'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4663 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004664 {not in Vi}
4665 {only available when compiled with the |+linebreak|
4666 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004667 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00004668 when the 'number' option is set or printing lines with a line number.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004669 Since one space is always between the number and the text, there is
4670 one less character for the number itself.
4671 The value is the minimum width. A bigger width is used when needed to
4672 fit the highest line number in the buffer. Thus with the Vim default
4673 of 4 there is room for a line number up to 999. When the buffer has
4674 1000 lines five columns will be used.
4675 The minimum value is 1, the maximum value is 10.
4676 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
4677
Bram Moolenaarf75a9632005-09-13 21:20:47 +00004678 *'omnifunc'* *'ofu'*
4679'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00004680 local to buffer
4681 {not in Vi}
4682 {not available when compiled without the +eval
4683 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00004684 This option specifies a function to be used for Insert mode omni
4685 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00004686 See |complete-functions| for an explanation of how the function is
4687 invoked and what it should return.
Bram Moolenaare344bea2005-09-01 20:46:49 +00004688
4689
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00004690 *'operatorfunc'* *'opfunc'*
4691'operatorfunc' 'opfunc' string (default: empty)
4692 global
4693 {not in Vi}
4694 This option specifies a function to be called by the |g@| operator.
4695 See |:map-operator| for more info and an example.
4696
4697 This option cannot be set from a |modeline| or in the |sandbox|, for
4698 security reasons.
4699
4700
Bram Moolenaar071d4272004-06-13 20:20:40 +00004701 *'osfiletype'* *'oft'* *E366*
4702'osfiletype' 'oft' string (RISC-OS default: "Text",
4703 others default: "")
4704 local to buffer
4705 {not in Vi}
4706 {only available when compiled with the |+osfiletype|
4707 feature}
4708 Some operating systems store extra information about files besides
4709 name, datestamp and permissions. This option contains the extra
4710 information, the nature of which will vary between systems.
4711 The value of this option is usually set when the file is loaded, and
4712 use to set the file type when file is written.
4713 It can affect the pattern matching of the automatic commands.
4714 |autocmd-osfiletypes|
4715
4716 *'paragraphs'* *'para'*
4717'paragraphs' 'para' string (default "IPLPPPQPP LIpplpipbp")
4718 global
4719 Specifies the nroff macros that separate paragraphs. These are pairs
4720 of two letters (see |object-motions|).
4721
4722 *'paste'* *'nopaste'*
4723'paste' boolean (default off)
4724 global
4725 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004726 Put Vim in Paste mode. This is useful if you want to cut or copy
4727 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004728 unexpected effects.
4729 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004730 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00004731 knows about pasting and will mostly do the right thing without 'paste'
4732 being set. The same is true for a terminal where Vim handles the
4733 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00004734 This option is reset when starting the GUI. Thus if you set it in
4735 your .vimrc it will work in a terminal, but not in the GUI. Setting
4736 'paste' in the GUI has side effects: e.g., the Paste toolbar button
4737 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004738 When the 'paste' option is switched on (also when it was already on):
4739 - mapping in Insert mode and Command-line mode is disabled
4740 - abbreviations are disabled
4741 - 'textwidth' is set to 0
4742 - 'wrapmargin' is set to 0
4743 - 'autoindent' is reset
4744 - 'smartindent' is reset
4745 - 'softtabstop' is set to 0
4746 - 'revins' is reset
4747 - 'ruler' is reset
4748 - 'showmatch' is reset
4749 - 'formatoptions' is used like it is empty
4750 These options keep their value, but their effect is disabled:
4751 - 'lisp'
4752 - 'indentexpr'
4753 - 'cindent'
4754 NOTE: When you start editing another file while the 'paste' option is
4755 on, settings from the modelines or autocommands may change the
4756 settings again, causing trouble when pasting text. You might want to
4757 set the 'paste' option again.
4758 When the 'paste' option is reset the mentioned options are restored to
4759 the value before the moment 'paste' was switched from off to on.
4760 Resetting 'paste' before ever setting it does not have any effect.
4761 Since mapping doesn't work while 'paste' is active, you need to use
4762 the 'pastetoggle' option to toggle the 'paste' option with some key.
4763
4764 *'pastetoggle'* *'pt'*
4765'pastetoggle' 'pt' string (default "")
4766 global
4767 {not in Vi}
4768 When non-empty, specifies the key sequence that toggles the 'paste'
4769 option. This is like specifying a mapping: >
4770 :map {keys} :set invpaste<CR>
4771< Where {keys} is the value of 'pastetoggle'.
4772 The difference is that it will work even when 'paste' is set.
4773 'pastetoggle' works in Insert mode and Normal mode, but not in
4774 Command-line mode.
4775 Mappings are checked first, thus overrule 'pastetoggle'. However,
4776 when 'paste' is on mappings are ignored in Insert mode, thus you can do
4777 this: >
4778 :map <F10> :set paste<CR>
4779 :map <F11> :set nopaste<CR>
4780 :imap <F10> <C-O>:set paste<CR>
4781 :imap <F11> <nop>
4782 :set pastetoggle=<F11>
4783< This will make <F10> start paste mode and <F11> stop paste mode.
4784 Note that typing <F10> in paste mode inserts "<F10>", since in paste
4785 mode everything is inserted literally, except the 'pastetoggle' key
4786 sequence.
4787
4788 *'pex'* *'patchexpr'*
4789'patchexpr' 'pex' string (default "")
4790 global
4791 {not in Vi}
4792 {not available when compiled without the |+diff|
4793 feature}
4794 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004795 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004796
4797 *'patchmode'* *'pm'* *E206*
4798'patchmode' 'pm' string (default "")
4799 global
4800 {not in Vi}
4801 When non-empty the oldest version of a file is kept. This can be used
4802 to keep the original version of a file if you are changing files in a
4803 source distribution. Only the first time that a file is written a
4804 copy of the original file will be kept. The name of the copy is the
4805 name of the original file with the string in the 'patchmode' option
4806 appended. This option should start with a dot. Use a string like
4807 ".org". 'backupdir' must not be empty for this to work (Detail: The
4808 backup file is renamed to the patchmode file after the new file has
4809 been successfully written, that's why it must be possible to write a
4810 backup file). If there was no file to be backed up, an empty file is
4811 created.
4812 When the 'backupskip' pattern matches, a patchmode file is not made.
4813 Using 'patchmode' for compressed files appends the extension at the
4814 end (e.g., "file.gz.orig"), thus the resulting name isn't always
4815 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004816 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004817
4818 *'path'* *'pa'* *E343* *E345* *E347*
4819'path' 'pa' string (default on Unix: ".,/usr/include,,"
4820 on OS/2: ".,/emx/include,,"
4821 other systems: ".,,")
4822 global or local to buffer |global-local|
4823 {not in Vi}
4824 This is a list of directories which will be searched when using the
4825 |gf|, [f, ]f, ^Wf, |:find| and other commands, provided that the file
4826 being searched for has a relative path (not starting with '/'). The
4827 directories in the 'path' option may be relative or absolute.
4828 - Use commas to separate directory names: >
4829 :set path=.,/usr/local/include,/usr/include
4830< - Spaces can also be used to separate directory names (for backwards
4831 compatibility with version 3.0). To have a space in a directory
4832 name, precede it with an extra backslash, and escape the space: >
4833 :set path=.,/dir/with\\\ space
4834< - To include a comma in a directory name precede it with an extra
4835 backslash: >
4836 :set path=.,/dir/with\\,comma
4837< - To search relative to the directory of the current file, use: >
4838 :set path=.
4839< - To search in the current directory use an empty string between two
4840 commas: >
4841 :set path=,,
4842< - A directory name may end in a ':' or '/'.
4843 - Environment variables are expanded |:set_env|.
4844 - When using |netrw.vim| URLs can be used. For example, adding
4845 "http://www.vim.org" will make ":find index.html" work.
4846 - Search upwards and downwards in a directory tree:
4847 1) "*" matches a sequence of characters, e.g.: >
4848 :set path=/usr/include/*
4849< means all subdirectories in /usr/include (but not /usr/include
4850 itself). >
4851 :set path=/usr/*c
4852< matches /usr/doc and /usr/src.
4853 2) "**" matches a subtree, up to 100 directories deep. Example: >
4854 :set path=/home/user_x/src/**
4855< means search in the whole subtree under "/home/usr_x/src".
4856 3) If the path ends with a ';', this path is the startpoint
4857 for upward search.
4858 See |file-searching| for more info and exact syntax.
4859 {not available when compiled without the |+path_extra| feature}
4860 - Careful with '\' characters, type two to get one in the option: >
4861 :set path=.,c:\\include
4862< Or just use '/' instead: >
4863 :set path=.,c:/include
4864< Don't forget "." or files won't even be found in the same directory as
4865 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004866 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00004867 it is something like 256 or 1024 characters.
4868 You can check if all the include files are found, using the value of
4869 'path', see |:checkpath|.
4870 The use of |:set+=| and |:set-=| is preferred when adding or removing
4871 directories from the list. This avoids problems when a future version
4872 uses another default. To remove the current directory use: >
4873 :set path-=
4874< To add the current directory use: >
4875 :set path+=
4876< To use an environment variable, you probably need to replace the
4877 separator. Here is an example to append $INCL, in which directory
4878 names are separated with a semi-colon: >
4879 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
4880< Replace the ';' with a ':' or whatever separator is used. Note that
4881 this doesn't work when $INCL contains a comma or white space.
4882
4883 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
4884'preserveindent' 'pi' boolean (default off)
4885 local to buffer
4886 {not in Vi}
4887 When changing the indent of the current line, preserve as much of the
4888 indent structure as possible. Normally the indent is replaced by a
4889 series of tabs followed by spaces as required (unless |'expandtab'| is
4890 enabled, in which case only spaces are used). Enabling this option
4891 means the indent will preserve as many existing characters as possible
4892 for indenting, and only add additional tabs or spaces as required.
4893 NOTE: When using ">>" multiple times the resulting indent is a mix of
4894 tabs and spaces. You might not like this.
4895 NOTE: 'preserveindent' is reset when 'compatible' is set.
4896 Also see 'copyindent'.
4897 Use |:retab| to clean up white space.
4898
4899 *'previewheight'* *'pvh'*
4900'previewheight' 'pvh' number (default 12)
4901 global
4902 {not in Vi}
4903 {not available when compiled without the |+windows| or
4904 |+quickfix| feature}
4905 Default height for a preview window. Used for |:ptag| and associated
4906 commands. Used for |CTRL-W_}| when no count is given.
4907
4908 *'previewwindow'* *'nopreviewwindow'*
4909 *'pvw'* *'nopvw'* *E590*
4910'previewwindow' 'pvw' boolean (default off)
4911 local to window
4912 {not in Vi}
4913 {not available when compiled without the |+windows| or
4914 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004915 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00004916 set. It's normally not set directly, but by using one of the commands
4917 |:ptag|, |:pedit|, etc.
4918
4919 *'printdevice'* *'pdev'*
4920'printdevice' 'pdev' string (default empty)
4921 global
4922 {not in Vi}
4923 {only available when compiled with the |+printer|
4924 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004925 The name of the printer to be used for |:hardcopy|.
4926 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004927 This option cannot be set from a |modeline| or in the |sandbox|, for
4928 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004929
Bram Moolenaar8299df92004-07-10 09:47:34 +00004930 *'printencoding'* *'penc'*
4931'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004932 global
4933 {not in Vi}
4934 {only available when compiled with the |+printer|
4935 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004936 Sets the character encoding used when printing.
4937 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004938
4939 *'printexpr'* *'pexpr'*
4940'printexpr' 'pexpr' String (default: see below)
4941 global
4942 {not in Vi}
4943 {only available when compiled with the |+printer|
4944 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004945 Expression used to print the PostScript produced with |:hardcopy|.
4946 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004947
Bram Moolenaar8299df92004-07-10 09:47:34 +00004948 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004949'printfont' 'pfn' string (default "courier")
4950 global
4951 {not in Vi}
4952 {only available when compiled with the |+printer|
4953 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004954 The name of the font that will be used for |:hardcopy|.
4955 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004956
4957 *'printheader'* *'pheader'*
4958'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
4959 global
4960 {not in Vi}
4961 {only available when compiled with the |+printer|
4962 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004963 The format of the header produced in |:hardcopy| output.
4964 See |pheader-option|.
4965
4966 *'printmbcharset'* *'pmbcs'*
4967'printmbcharset' 'pmbcs' string (default "")
4968 global
4969 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004970 {only available when compiled with the |+printer|,
4971 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004972 The CJK character set to be used for CJK output from |:hardcopy|.
4973 See |pmbcs-option|.
4974
4975 *'printmbfont'* *'pmbfn'*
4976'printmbfont' 'pmbfn' string (default "")
4977 global
4978 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004979 {only available when compiled with the |+printer|,
4980 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004981 List of font names to be used for CJK output from |:hardcopy|.
4982 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004983
4984 *'printoptions'* *'popt'*
4985'printoptions' 'popt' string (default "")
4986 global
4987 {not in Vi}
4988 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004989 List of items that control the format of the output of |:hardcopy|.
4990 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004991
Bram Moolenaar26a60b42005-02-22 08:49:11 +00004992 *'prompt'* *'noprompt'*
4993'prompt' boolean (default on)
4994 global
4995 When on a ":" prompt is used in Ex mode.
4996
Bram Moolenaar677ee682005-01-27 14:41:15 +00004997 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004998'quoteescape' 'qe' string (default "\")
4999 local to buffer
5000 {not in Vi}
5001 The characters that are used to escape quotes in a string. Used for
5002 objects like a', a" and a` |a'|.
5003 When one of the characters in this option is found inside a string,
5004 the following character will be skipped. The default value makes the
5005 text "foo\"bar\\" considered to be one string.
5006
Bram Moolenaar071d4272004-06-13 20:20:40 +00005007 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5008'readonly' 'ro' boolean (default off)
5009 local to buffer
5010 If on, writes fail unless you use a '!'. Protects you from
5011 accidentally overwriting a file. Default on when Vim is started
5012 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005013 When using ":w!" the 'readonly' option is reset for the current
5014 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005015 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005016 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005017
5018 *'remap'* *'noremap'*
5019'remap' boolean (default on)
5020 global
5021 Allows for mappings to work recursively. If you do not want this for
5022 a single entry, use the :noremap[!] command.
5023
5024 *'report'*
5025'report' number (default 2)
5026 global
5027 Threshold for reporting number of lines changed. When the number of
5028 changed lines is more than 'report' a message will be given for most
5029 ":" commands. If you want it always, set 'report' to 0.
5030 For the ":substitute" command the number of substitutions is used
5031 instead of the number of lines.
5032
5033 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5034'restorescreen' 'rs' boolean (default on)
5035 global
5036 {not in Vi} {only in Windows 95/NT console version}
5037 When set, the screen contents is restored when exiting Vim. This also
5038 happens when executing external commands.
5039
5040 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5041 options in your .vimrc. To disable restoring:
5042 set t_ti= t_te=
5043 To enable restoring (for an xterm):
5044 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5045 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5046
5047 *'revins'* *'ri'* *'norevins'* *'nori'*
5048'revins' 'ri' boolean (default off)
5049 global
5050 {not in Vi}
5051 {only available when compiled with the |+rightleft|
5052 feature}
5053 Inserting characters in Insert mode will work backwards. See "typing
5054 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5055 command in Insert mode, when 'allowrevins' is set.
5056 NOTE: This option is reset when 'compatible' or 'paste' is set.
5057
5058 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5059'rightleft' 'rl' boolean (default off)
5060 local to window
5061 {not in Vi}
5062 {only available when compiled with the |+rightleft|
5063 feature}
5064 When on, display orientation becomes right-to-left, i.e., characters
5065 that are stored in the file appear from the right to the left.
5066 Using this option, it is possible to edit files for languages that
5067 are written from the right to the left such as Hebrew and Arabic.
5068 This option is per window, so it is possible to edit mixed files
5069 simultaneously, or to view the same file in both ways (this is
5070 useful whenever you have a mixed text file with both right-to-left
5071 and left-to-right strings so that both sets are displayed properly
5072 in different windows). Also see |rileft.txt|.
5073
5074 *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'*
5075'rightleftcmd' 'rlc' string (default "search")
5076 local to window
5077 {not in Vi}
5078 {only available when compiled with the |+rightleft|
5079 feature}
5080 Each word in this option enables the command line editing to work in
5081 right-to-left mode for a group of commands:
5082
5083 search "/" and "?" commands
5084
5085 This is useful for languages such as Hebrew, Arabic and Farsi.
5086 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5087
5088 *'ruler'* *'ru'* *'noruler'* *'noru'*
5089'ruler' 'ru' boolean (default off)
5090 global
5091 {not in Vi}
5092 {not available when compiled without the
5093 |+cmdline_info| feature}
5094 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005095 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005096 text in the file is shown on the far right:
5097 Top first line is visible
5098 Bot last line is visible
5099 All first and last line are visible
5100 45% relative position in the file
5101 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005102 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005103 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005104 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005105 this option takes precedence over 'ruler' and 'rulerformat'
5106 If the number of characters displayed is different from the number of
5107 bytes in the text (e.g., for a TAB or a multi-byte character), both
5108 the text column (byte number) and the screen column are shown,
5109 separated with a dash.
5110 For an empty line "0-1" is shown.
5111 For an empty buffer the line number will also be zero: "0,0-1".
5112 This option is reset when the 'paste' option is set.
5113 If you don't want to see the ruler all the time but want to know where
5114 you are, use "g CTRL-G" |g_CTRL-G|.
5115 NOTE: This option is reset when 'compatible' is set.
5116
5117 *'rulerformat'* *'ruf'*
5118'rulerformat' 'ruf' string (default empty)
5119 global
5120 {not in Vi}
5121 {not available when compiled without the |+statusline|
5122 feature}
5123 When this option is not empty, it determines the content of the ruler
5124 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005125 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005126 The default ruler width is 17 characters. To make the ruler 15
5127 characters wide, put "%15(" at the start and "%)" at the end.
5128 Example: >
5129 :set rulerformat=%15(%c%V\ %p%%%)
5130<
5131 *'runtimepath'* *'rtp'* *vimfiles*
5132'runtimepath' 'rtp' string (default:
5133 Unix: "$HOME/.vim,
5134 $VIM/vimfiles,
5135 $VIMRUNTIME,
5136 $VIM/vimfiles/after,
5137 $HOME/.vim/after"
5138 Amiga: "home:vimfiles,
5139 $VIM/vimfiles,
5140 $VIMRUNTIME,
5141 $VIM/vimfiles/after,
5142 home:vimfiles/after"
5143 PC, OS/2: "$HOME/vimfiles,
5144 $VIM/vimfiles,
5145 $VIMRUNTIME,
5146 $VIM/vimfiles/after,
5147 $HOME/vimfiles/after"
5148 Macintosh: "$VIM:vimfiles,
5149 $VIMRUNTIME,
5150 $VIM:vimfiles:after"
5151 RISC-OS: "Choices:vimfiles,
5152 $VIMRUNTIME,
5153 Choices:vimfiles/after"
5154 VMS: "sys$login:vimfiles,
5155 $VIM/vimfiles,
5156 $VIMRUNTIME,
5157 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005158 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005159 global
5160 {not in Vi}
5161 This is a list of directories which will be searched for runtime
5162 files:
5163 filetype.vim filetypes by file name |new-filetype|
5164 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005165 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005166 colors/ color scheme files |:colorscheme|
5167 compiler/ compiler files |:compiler|
5168 doc/ documentation |write-local-help|
5169 ftplugin/ filetype plugins |write-filetype-plugin|
5170 indent/ indent scripts |indent-expression|
5171 keymap/ key mapping files |mbyte-keymap|
5172 lang/ menu translations |:menutrans|
5173 menu.vim GUI menus |menu.vim|
5174 plugin/ plugin scripts |write-plugin|
5175 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005176 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005177 syntax/ syntax files |mysyntaxfile|
5178 tutor/ files for vimtutor |tutor|
5179
5180 And any other file searched for with the |:runtime| command.
5181
5182 The defaults for most systems are setup to search five locations:
5183 1. In your home directory, for your personal preferences.
5184 2. In a system-wide Vim directory, for preferences from the system
5185 administrator.
5186 3. In $VIMRUNTIME, for files distributed with Vim.
5187 *after-directory*
5188 4. In the "after" directory in the system-wide Vim directory. This is
5189 for the system administrator to overrule or add to the distributed
5190 defaults (rarely needed)
5191 5. In the "after" directory in your home directory. This is for
5192 personal preferences to overrule or add to the distributed defaults
5193 or system-wide settings (rarely needed).
5194
5195 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5196 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005197 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005198 wildcards.
5199 See |:runtime|.
5200 Example: >
5201 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5202< This will use the directory "~/vimruntime" first (containing your
5203 personal Vim runtime files), then "/mygroup/vim" (shared between a
5204 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5205 files).
5206 You probably should always include $VIMRUNTIME somewhere, to use the
5207 distributed runtime files. You can put a directory before $VIMRUNTIME
5208 to find files which replace a distributed runtime files. You can put
5209 a directory after $VIMRUNTIME to find files which add to distributed
5210 runtime files.
5211 This option cannot be set from a |modeline| or in the |sandbox|, for
5212 security reasons.
5213
5214 *'scroll'* *'scr'*
5215'scroll' 'scr' number (default: half the window height)
5216 local to window
5217 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5218 set to half the number of lines in the window when the window size
5219 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005220 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005221 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5222 the number of screen lines instead of file lines, makes a difference
5223 when lines wrap}
5224
5225 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5226'scrollbind' 'scb' boolean (default off)
5227 local to window
5228 {not in Vi}
5229 {not available when compiled without the |+scrollbind|
5230 feature}
5231 See also |scroll-binding|. When this option is set, the current
5232 window scrolls as other scrollbind windows (windows that also have
5233 this option set) scroll. This option is useful for viewing the
5234 differences between two versions of a file, see 'diff'.
5235 See |'scrollopt'| for options that determine how this option should be
5236 interpreted.
5237 This option is mostly reset when splitting a window to edit another
5238 file. This means that ":split | edit file" results in two windows
5239 with scroll-binding, but ":split file" does not.
5240
5241 *'scrolljump'* *'sj'*
5242'scrolljump' 'sj' number (default 1)
5243 global
5244 {not in Vi}
5245 Minimal number of lines to scroll when the cursor gets off the
5246 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5247 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005248 When set to a negative number from -1 to -100 this is used as the
5249 percentage of the window height. Thus -50 scrolls half the window
5250 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005251 NOTE: This option is set to 1 when 'compatible' is set.
5252
5253 *'scrolloff'* *'so'*
5254'scrolloff' 'so' number (default 0)
5255 global
5256 {not in Vi}
5257 Minimal number of screen lines to keep above and below the cursor.
5258 This will make some context visible around where you are working. If
5259 you set it to a very large value (999) the cursor line will always be
5260 in the middle of the window (except at the start or end of the file or
5261 when long lines wrap).
5262 For scrolling horizontally see 'sidescrolloff'.
5263 NOTE: This option is set to 0 when 'compatible' is set.
5264
5265 *'scrollopt'* *'sbo'*
5266'scrollopt' 'sbo' string (default "ver,jump")
5267 global
5268 {not available when compiled without the |+scrollbind|
5269 feature}
5270 {not in Vi}
5271 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005272 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5273 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005274 The following words are available:
5275 ver Bind vertical scrolling for 'scrollbind' windows
5276 hor Bind horizontal scrolling for 'scrollbind' windows
5277 jump Applies to the offset between two windows for vertical
5278 scrolling. This offset is the difference in the first
5279 displayed line of the bound windows. When moving
5280 around in a window, another 'scrollbind' window may
5281 reach a position before the start or after the end of
5282 the buffer. The offset is not changed though, when
5283 moving back the 'scrollbind' window will try to scroll
5284 to the desired position when possible.
5285 When now making that window the current one, two
5286 things can be done with the relative offset:
5287 1. When "jump" is not included, the relative offset is
5288 adjusted for the scroll position in the new current
5289 window. When going back to the other window, the
5290 the new relative offset will be used.
5291 2. When "jump" is included, the other windows are
5292 scrolled to keep the same relative offset. When
5293 going back to the other window, it still uses the
5294 same relative offset.
5295 Also see |scroll-binding|.
5296
5297 *'sections'* *'sect'*
5298'sections' 'sect' string (default "SHNHH HUnhsh")
5299 global
5300 Specifies the nroff macros that separate sections. These are pairs of
5301 two letters (See |object-motions|). The default makes a section start
5302 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5303
5304 *'secure'* *'nosecure'* *E523*
5305'secure' boolean (default off)
5306 global
5307 {not in Vi}
5308 When on, ":autocmd", shell and write commands are not allowed in
5309 ".vimrc" and ".exrc" in the current directory and map commands are
5310 displayed. Switch it off only if you know that you will not run into
5311 problems, or when the 'exrc' option is off. On Unix this option is
5312 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005313 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005314 'secure' at the end of your ~/.vimrc then.
5315 This option cannot be set from a |modeline| or in the |sandbox|, for
5316 security reasons.
5317
5318 *'selection'* *'sel'*
5319'selection' 'sel' string (default "inclusive")
5320 global
5321 {not in Vi}
5322 This option defines the behavior of the selection. It is only used
5323 in Visual and Select mode.
5324 Possible values:
5325 value past line inclusive ~
5326 old no yes
5327 inclusive yes yes
5328 exclusive yes no
5329 "past line" means that the cursor is allowed to be positioned one
5330 character past the line.
5331 "inclusive" means that the last character of the selection is included
5332 in an operation. For example, when "x" is used to delete the
5333 selection.
5334 Note that when "exclusive" is used and selecting from the end
5335 backwards, you cannot include the last character of a line, when
5336 starting in Normal mode and 'virtualedit' empty.
5337
5338 The 'selection' option is set by the |:behave| command.
5339
5340 *'selectmode'* *'slm'*
5341'selectmode' 'slm' string (default "")
5342 global
5343 {not in Vi}
5344 This is a comma separated list of words, which specifies when to start
5345 Select mode instead of Visual mode, when a selection is started.
5346 Possible values:
5347 mouse when using the mouse
5348 key when using shifted special keys
5349 cmd when using "v", "V" or CTRL-V
5350 See |Select-mode|.
5351 The 'selectmode' option is set by the |:behave| command.
5352
5353 *'sessionoptions'* *'ssop'*
5354'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
5355 help,options,winsize")
5356 global
5357 {not in Vi}
5358 {not available when compiled without the +mksession
5359 feature}
5360 Changes the effect of the |:mksession| command. It is a comma
5361 separated list of words. Each word enables saving and restoring
5362 something:
5363 word save and restore ~
5364 blank empty windows
5365 buffers hidden and unloaded buffers, not just those in windows
5366 curdir the current directory
5367 folds manually created folds, opened/closed folds and local
5368 fold options
5369 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005370 and contain at least one lowercase letter. Only
5371 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005372 help the help window
5373 localoptions options and mappings local to a window or buffer (not
5374 global values for local options)
5375 options all options and mappings (also global values for local
5376 options)
5377 resize size of the Vim window: 'lines' and 'columns'
5378 sesdir the directory in which the session file is located
5379 will become the current directory (useful with
5380 projects accessed over a network from different
5381 systems)
5382 slash backslashes in file names replaced with forward
5383 slashes
5384 unix with Unix end-of-line format (single <NL>), even when
5385 on Windows or DOS
5386 winpos position of the whole Vim window
5387 winsize window sizes
5388
5389 Don't include both "curdir" and "sesdir".
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00005390 There is no option to include tab pages yet, only the current tab page
5391 is stored in the session. |tab-page|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005392 When "curdir" nor "sesdir" is included, file names are stored with
5393 absolute paths.
5394 "slash" and "unix" are useful on Windows when sharing session files
5395 with Unix. The Unix version of Vim cannot source dos format scripts,
5396 but the Windows version of Vim can source unix format scripts.
5397
5398 *'shell'* *'sh'* *E91*
5399'shell' 'sh' string (default $SHELL or "sh",
5400 MS-DOS and Win32: "command.com" or
5401 "cmd.exe", OS/2: "cmd")
5402 global
5403 Name of the shell to use for ! and :! commands. When changing the
5404 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5405 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005406 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005407 See |option-backslash| about including spaces and backslashes.
5408 Environment variables are expanded |:set_env|.
5409 If the name of the shell contains a space, you might need to enclose
5410 it in quotes. Example: >
5411 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5412< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005413 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005414 "-f" is not inside the quotes, because it is not part of the command
5415 name. And Vim automagically recognizes the backslashes that are path
5416 separators.
5417 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5418 variable to change the way external commands are executed. See the
5419 libc.inf file of DJGPP.
5420 Under MS-Windows, when the executable ends in ".com" it must be
5421 included. Thus setting the shell to "command.com" or "4dos.com"
5422 works, but "command" and "4dos" do not work for all commands (e.g.,
5423 filtering).
5424 For unknown reasons, when using "4dos.com" the current directory is
5425 changed to "C:\". To avoid this set 'shell' like this: >
5426 :set shell=command.com\ /c\ 4dos
5427< This option cannot be set from a |modeline| or in the |sandbox|, for
5428 security reasons.
5429
5430 *'shellcmdflag'* *'shcf'*
5431'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5432 does not contain "sh" somewhere: "/c")
5433 global
5434 {not in Vi}
5435 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5436 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5437 systems, the default is set according to the value of 'shell', to
5438 reduce the need to set this option by the user. It's not used for
5439 OS/2 (EMX figures this out itself). See |option-backslash| about
5440 including spaces and backslashes. See |dos-shell|.
5441 This option cannot be set from a |modeline| or in the |sandbox|, for
5442 security reasons.
5443
5444 *'shellpipe'* *'sp'*
5445'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5446 global
5447 {not in Vi}
5448 {not available when compiled without the |+quickfix|
5449 feature}
5450 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005451 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005452 including spaces and backslashes.
5453 The name of the temporary file can be represented by "%s" if necessary
5454 (the file name is appended automatically if no %s appears in the value
5455 of this option).
5456 For the Amiga and MS-DOS the default is ">". The output is directly
5457 saved in a file and not echoed to the screen.
5458 For Unix the default it "| tee". The stdout of the compiler is saved
5459 in a file and echoed to the screen. If the 'shell' option is "csh" or
5460 "tcsh" after initializations, the default becomes "|& tee". If the
5461 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
5462 "2>&1| tee". This means that stderr is also included.
5463 The initialization of this option is done after reading the ".vimrc"
5464 and the other initializations, so that when the 'shell' option is set
5465 there, the 'shellpipe' option changes automatically, unless it was
5466 explicitly set before.
5467 When 'shellpipe' is set to an empty string, no redirection of the
5468 ":make" output will be done. This is useful if you use a 'makeprg'
5469 that writes to 'makeef' by itself. If you want no piping, but do
5470 want to include the 'makeef', set 'shellpipe' to a single space.
5471 Don't forget to precede the space with a backslash: ":set sp=\ ".
5472 In the future pipes may be used for filtering and this option will
5473 become obsolete (at least for Unix).
5474 This option cannot be set from a |modeline| or in the |sandbox|, for
5475 security reasons.
5476
5477 *'shellquote'* *'shq'*
5478'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5479 contains "sh" somewhere: "\"")
5480 global
5481 {not in Vi}
5482 Quoting character(s), put around the command passed to the shell, for
5483 the "!" and ":!" commands. The redirection is kept outside of the
5484 quoting. See 'shellxquote' to include the redirection. It's
5485 probably not useful to set both options.
5486 This is an empty string by default. Only known to be useful for
5487 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5488 or bash, where it should be "\"". The default is adjusted according
5489 the value of 'shell', to reduce the need to set this option by the
5490 user. See |dos-shell|.
5491 This option cannot be set from a |modeline| or in the |sandbox|, for
5492 security reasons.
5493
5494 *'shellredir'* *'srr'*
5495'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5496 global
5497 {not in Vi}
5498 String to be used to put the output of a filter command in a temporary
5499 file. See also |:!|. See |option-backslash| about including spaces
5500 and backslashes.
5501 The name of the temporary file can be represented by "%s" if necessary
5502 (the file name is appended automatically if no %s appears in the value
5503 of this option).
5504 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5505 or "zsh" during initializations, the default becomes ">&". If the
5506 'shell' option is "sh", "ksh" or "bash" the default becomes
5507 ">%s 2>&1". This means that stderr is also included.
5508 For Win32, the Unix checks are done and additionally "cmd" is checked
5509 for, which makes the default ">%s 2>&1". Also, the same names with
5510 ".exe" appended are checked for.
5511 The initialization of this option is done after reading the ".vimrc"
5512 and the other initializations, so that when the 'shell' option is set
5513 there, the 'shellredir' option changes automatically unless it was
5514 explicitly set before.
5515 In the future pipes may be used for filtering and this option will
5516 become obsolete (at least for Unix).
5517 This option cannot be set from a |modeline| or in the |sandbox|, for
5518 security reasons.
5519
5520 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5521'shellslash' 'ssl' boolean (default off)
5522 global
5523 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5524 When set, a forward slash is used when expanding file names. This is
5525 useful when a Unix-like shell is used instead of command.com or
5526 cmd.exe. Backward slashes can still be typed, but they are changed to
5527 forward slashes by Vim.
5528 Note that setting or resetting this option has no effect for some
5529 existing file names, thus this option needs to be set before opening
5530 any file for best results. This might change in the future.
5531 'shellslash' only works when a backslash can be used as a path
5532 separator. To test if this is so use: >
5533 if exists('+shellslash')
5534<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005535 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5536'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5537 global
5538 {not in Vi}
5539 When on, use temp files for shell commands. When off use a pipe.
5540 When using a pipe is not possible temp files are used anyway.
5541 Currently a pipe is only supported on Unix. You can check it with: >
5542 :if has("filterpipe")
5543< The advantage of using a pipe is that nobody can read the temp file
5544 and the 'shell' command does not need to support redirection.
5545 The advantage of using a temp file is that the file type and encoding
5546 can be detected.
5547 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5548 |FilterWritePost| autocommands event are not triggered when
5549 'shelltemp' is off.
5550
Bram Moolenaar071d4272004-06-13 20:20:40 +00005551 *'shelltype'* *'st'*
5552'shelltype' 'st' number (default 0)
5553 global
5554 {not in Vi} {only for the Amiga}
5555 On the Amiga this option influences the way how the commands work
5556 which use a shell.
5557 0 and 1: always use the shell
5558 2 and 3: use the shell only to filter lines
5559 4 and 5: use shell only for ':sh' command
5560 When not using the shell, the command is executed directly.
5561
5562 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5563 1 and 3: use "shell cmd" to start external commands
5564
5565 *'shellxquote'* *'sxq'*
5566'shellxquote' 'sxq' string (default: "";
5567 for Win32, when 'shell' contains "sh"
5568 somewhere: "\""
5569 for Unix, when using system(): "\"")
5570 global
5571 {not in Vi}
5572 Quoting character(s), put around the command passed to the shell, for
5573 the "!" and ":!" commands. Includes the redirection. See
5574 'shellquote' to exclude the redirection. It's probably not useful
5575 to set both options.
5576 This is an empty string by default. Known to be useful for
5577 third-party shells when using the Win32 version, such as the MKS Korn
5578 Shell or bash, where it should be "\"". The default is adjusted
5579 according the value of 'shell', to reduce the need to set this option
5580 by the user. See |dos-shell|.
5581 This option cannot be set from a |modeline| or in the |sandbox|, for
5582 security reasons.
5583
5584 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5585'shiftround' 'sr' boolean (default off)
5586 global
5587 {not in Vi}
5588 Round indent to multiple of 'shiftwidth'. Applies to > and <
5589 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5590 a multiple of 'shiftwidth' (this is Vi compatible).
5591 NOTE: This option is reset when 'compatible' is set.
5592
5593 *'shiftwidth'* *'sw'*
5594'shiftwidth' 'sw' number (default 8)
5595 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005596 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005597 |'cindent'|, |>>|, |<<|, etc.
5598
5599 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005600'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
5601 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005602 global
5603 {not in Vi}
5604 This option helps to avoid all the |hit-enter| prompts caused by file
5605 messages, for example with CTRL-G, and to avoid some other messages.
5606 It is a list of flags:
5607 flag meaning when present ~
5608 f use "(3 of 5)" instead of "(file 3 of 5)"
5609 i use "[noeol]" instead of "[Incomplete last line]"
5610 l use "999L, 888C" instead of "999 lines, 888 characters"
5611 m use "[+]" instead of "[Modified]"
5612 n use "[New]" instead of "[New File]"
5613 r use "[RO]" instead of "[readonly]"
5614 w use "[w]" instead of "written" for file write message
5615 and "[a]" instead of "appended" for ':w >> file' command
5616 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5617 "[unix format]" and "[mac]" instead of "[mac format]".
5618 a all of the above abbreviations
5619
5620 o overwrite message for writing a file with subsequent message
5621 for reading a file (useful for ":wn" or when 'autowrite' on)
5622 O message for reading a file overwrites any previous message.
5623 Also for quickfix message (e.g., ":cn").
5624 s don't give "search hit BOTTOM, continuing at TOP" or "search
5625 hit TOP, continuing at BOTTOM" messages
5626 t truncate file message at the start if it is too long to fit
5627 on the command-line, "<" will appear in the left most column.
5628 Ignored in Ex mode.
5629 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00005630 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005631 Ignored in Ex mode.
5632 W don't give "written" or "[w]" when writing a file
5633 A don't give the "ATTENTION" message when an existing swap file
5634 is found.
5635 I don't give the intro message when starting Vim |:intro|.
5636
5637 This gives you the opportunity to avoid that a change between buffers
5638 requires you to hit <Enter>, but still gives as useful a message as
5639 possible for the space available. To get the whole message that you
5640 would have got with 'shm' empty, use ":file!"
5641 Useful values:
5642 shm= No abbreviation of message.
5643 shm=a Abbreviation, but no loss of information.
5644 shm=at Abbreviation, and truncate message when necessary.
5645
5646 NOTE: This option is set to the Vi default value when 'compatible' is
5647 set and to the Vim default value when 'compatible' is reset.
5648
5649 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
5650'shortname' 'sn' boolean (default off)
5651 local to buffer
5652 {not in Vi, not in MS-DOS versions}
5653 Filenames are assumed to be 8 characters plus one extension of 3
5654 characters. Multiple dots in file names are not allowed. When this
5655 option is on, dots in file names are replaced with underscores when
5656 adding an extension (".~" or ".swp"). This option is not available
5657 for MS-DOS, because then it would always be on. This option is useful
5658 when editing files on an MS-DOS compatible filesystem, e.g., messydos
5659 or crossdos. When running the Win32 GUI version under Win32s, this
5660 option is always on by default.
5661
5662 *'showbreak'* *'sbr'* *E595*
5663'showbreak' 'sbr' string (default "")
5664 global
5665 {not in Vi}
5666 {not available when compiled without the |+linebreak|
5667 feature}
5668 String to put at the start of lines that have been wrapped. Useful
5669 values are "> " or "+++ ".
5670 Only printable single-cell characters are allowed, excluding <Tab> and
5671 comma (in a future version the comma might be used to separate the
5672 part that is shown at the end and at the start of a line).
5673 The characters are highlighted according to the '@' flag in
5674 'highlight'.
5675 Note that tabs after the showbreak will be displayed differently.
5676 If you want the 'showbreak' to appear in between line numbers, add the
5677 "n" flag to 'cpoptions'.
5678
5679 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
5680'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
5681 off)
5682 global
5683 {not in Vi}
5684 {not available when compiled without the
5685 |+cmdline_info| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005686 Show (partial) command in status line. Set this option off if your
Bram Moolenaar071d4272004-06-13 20:20:40 +00005687 terminal is slow.
5688 In Visual mode the size of the selected area is shown:
5689 - When selecting characters within a line, the number of characters.
5690 - When selecting more than one line, the number of lines.
5691 - When selecting a block, the size in screen characters: linesxcolumns.
5692 NOTE: This option is set to the Vi default value when 'compatible' is
5693 set and to the Vim default value when 'compatible' is reset.
5694
5695 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
5696'showfulltag' 'sft' boolean (default off)
5697 global
5698 {not in Vi}
5699 When completing a word in insert mode (see |ins-completion|) from the
5700 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005701 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00005702 matched a C function, you can see a template for what arguments are
5703 required (coding style permitting).
5704
5705 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
5706'showmatch' 'sm' boolean (default off)
5707 global
5708 When a bracket is inserted, briefly jump to the matching one. The
5709 jump is only done if the match can be seen on the screen. The time to
5710 show the match can be set with 'matchtime'.
5711 A Beep is given if there is no match (no matter if the match can be
5712 seen or not). This option is reset when the 'paste' option is set.
5713 When the 'm' flag is not included in 'cpoptions', typing a character
5714 will immediately move the cursor back to where it belongs.
5715 See the "sm" field in 'guicursor' for setting the cursor shape and
5716 blinking when showing the match.
5717 The 'matchpairs' option can be used to specify the characters to show
5718 matches for. 'rightleft' and 'revins' are used to look for opposite
5719 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005720 Also see the matchparen plugin for highlighting the match when moving
5721 around |pi_paren.txt|.
5722 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005723
5724 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
5725'showmode' 'smd' boolean (Vim default: on, Vi default: off)
5726 global
5727 If in Insert, Replace or Visual mode put a message on the last line.
5728 Use the 'M' flag in 'highlight' to set the type of highlighting for
5729 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005730 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005731 doesn't mean XIM is really active, especially when 'imactivatekey' is
5732 not set.
5733 NOTE: This option is set to the Vi default value when 'compatible' is
5734 set and to the Vim default value when 'compatible' is reset.
5735
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00005736 *'showtabline'* *'stal'*
5737'showtabline' 'stal' number (default 1)
5738 global
5739 {not in Vi}
5740 {not available when compiled without the +windows
5741 feature}
5742 The value of this option specifies when the line with tab page labels
5743 will be displayed:
5744 0: never
5745 1: only if there are at least two tab pages
5746 2: always
5747 This is both for the GUI and non-GUI implementation of the tab pages
5748 line.
5749 See |tab-page| for more information about tab pages.
5750
Bram Moolenaar071d4272004-06-13 20:20:40 +00005751 *'sidescroll'* *'ss'*
5752'sidescroll' 'ss' number (default 0)
5753 global
5754 {not in Vi}
5755 The minimal number of columns to scroll horizontally. Used only when
5756 the 'wrap' option is off and the cursor is moved off of the screen.
5757 When it is zero the cursor will be put in the middle of the screen.
5758 When using a slow terminal set it to a large number or 0. When using
5759 a fast terminal use a small number or 1. Not used for "zh" and "zl"
5760 commands.
5761
5762 *'sidescrolloff'* *'siso'*
5763'sidescrolloff' 'siso' number (default 0)
5764 global
5765 {not in Vi}
5766 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00005767 right of the cursor if 'nowrap' is set. Setting this option to a
5768 value greater than 0 while having |'sidescroll'| also at a non-zero
5769 value makes some context visible in the line you are scrolling in
5770 horizontally (except at beginning of the line). Setting this option
5771 to a large value (like 999) has the effect of keeping the cursor
5772 horizontally centered in the window, as long as one does not come too
5773 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005774 NOTE: This option is set to 0 when 'compatible' is set.
5775
5776 Example: Try this together with 'sidescroll' and 'listchars' as
5777 in the following example to never allow the cursor to move
5778 onto the "extends" character:
5779
5780 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
5781 :set sidescrolloff=1
5782
5783
5784 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
5785'smartcase' 'scs' boolean (default off)
5786 global
5787 {not in Vi}
5788 Override the 'ignorecase' option if the search pattern contains upper
5789 case characters. Only used when the search pattern is typed and
5790 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005791 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00005792 "*" and "#" you can make 'smartcase' used by doing a "/" command,
5793 recalling the search pattern from history and hitting <Enter>.
5794 NOTE: This option is reset when 'compatible' is set.
5795
5796 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
5797'smartindent' 'si' boolean (default off)
5798 local to buffer
5799 {not in Vi}
5800 {not available when compiled without the
5801 |+smartindent| feature}
5802 Do smart autoindenting when starting a new line. Works for C-like
5803 programs, but can also be used for other languages. 'cindent' does
5804 something like this, works better in most cases, but is more strict,
5805 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
5806 'indentexpr' is a more advanced alternative.
5807 Normally 'autoindent' should also be on when using 'smartindent'.
5808 An indent is automatically inserted:
5809 - After a line ending in '{'.
5810 - After a line starting with a keyword from 'cinwords'.
5811 - Before a line starting with '}' (only with the "O" command).
5812 When typing '}' as the first character in a new line, that line is
5813 given the same indent as the matching '{'.
5814 When typing '#' as the first character in a new line, the indent for
5815 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005816 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005817 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
5818 When using the ">>" command, lines starting with '#' are not shifted
5819 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005820 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005821 is set smart indenting is disabled.
5822
5823 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
5824'smarttab' 'sta' boolean (default off)
5825 global
5826 {not in Vi}
5827 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00005828 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
5829 <BS> will delete a 'shiftwidth' worth of space at the start of the
5830 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005831 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00005832 'softtabstop'. 'shiftwidth' is only used for shifting text left or
5833 right |shift-left-right|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005834 What gets inserted (a Tab or spaces) depends on the 'expandtab'
5835 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00005836 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005837 NOTE: This option is reset when 'compatible' is set.
5838
5839 *'softtabstop'* *'sts'*
5840'softtabstop' 'sts' number (default 0)
5841 local to buffer
5842 {not in Vi}
5843 Number of spaces that a <Tab> counts for while performing editing
5844 operations, like inserting a <Tab> or using <BS>. It "feels" like
5845 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
5846 used. This is useful to keep the 'ts' setting at its standard value
5847 of 8, while being able to edit like it is set to 'sts'. However,
5848 commands like "x" still work on the actual characters.
5849 When 'sts' is zero, this feature is off.
5850 'softtabstop' is set to 0 when the 'paste' option is set.
5851 See also |ins-expandtab|. When 'expandtab' is not set, the number of
5852 spaces is minimized by using <Tab>s.
5853 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
5854 set.
5855 NOTE: This option is set to 0 when 'compatible' is set.
5856
Bram Moolenaar217ad922005-03-20 22:37:15 +00005857 *'spell'* *'nospell'*
5858'spell' boolean (default off)
5859 local to window
5860 {not in Vi}
5861 {not available when compiled without the |+syntax|
5862 feature}
5863 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005864 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005865
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005866 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005867'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005868 local to buffer
5869 {not in Vi}
5870 {not available when compiled without the |+syntax|
5871 feature}
5872 Pattern to locate the end of a sentence. The following word will be
5873 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005874 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005875 When this check is not wanted make this option empty.
5876 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005877 Be careful with special characters, see |option-backslash| about
5878 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005879 To set this option automatically depending on the language, see
5880 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005881
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005882 *'spellfile'* *'spf'*
5883'spellfile' 'spf' string (default empty)
5884 local to buffer
5885 {not in Vi}
5886 {not available when compiled without the |+syntax|
5887 feature}
5888 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00005889 commands. It must end in ".{encoding}.add". You need to include the
5890 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005891 *E765*
5892 It may also be a comma separated list of names. A count before the
5893 |zg| and |zw| commands can be used to access each. This allows using
5894 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005895 When a word is added while this option is empty Vim will set it for
5896 you: Using the first "spell" directory in 'runtimepath' that is
Bram Moolenaar3b506942005-06-23 22:36:45 +00005897 writable and the first language name that appears in 'spelllang',
5898 ignoring the region.
5899 The resulting ".spl" file will be used for spell checking, it does not
5900 have to appear in 'spelllang'.
5901 Normally one file is used for all regions, but you can add the region
5902 name if you want to. However, it will then only be used when
5903 'spellfile' is set to it, for entries in 'spelllang' only files
5904 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00005905 This option cannot be set from a |modeline| or in the |sandbox|, for
5906 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005907
Bram Moolenaar217ad922005-03-20 22:37:15 +00005908 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005909'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00005910 local to buffer
5911 {not in Vi}
5912 {not available when compiled without the |+syntax|
5913 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00005914 A comma separated list of word list names. When the 'spell' option is
5915 on spellchecking will be done for these languages. Example: >
5916 set spelllang=en_us,nl,medical
5917< This means US English, Dutch and medical words are recognized. Words
5918 that are not recognized will be highlighted.
5919 The word list name must not include a comma or dot. Using a dash is
5920 recommended to separate the two letter language name from a
5921 specification. Thus "en-rare" is used for rare English words.
5922 A region name must come last and have the form "_xx", where "xx" is
5923 the two-letter, lower case region name. You can use more than one
5924 region by listing them: "en_us,en_ca" supports both US and Canadian
5925 English, but not words specific for Australia, New Zealand or Great
5926 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005927 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00005928 As a special case the name of a .spl file can be given as-is. The
5929 first "_xx" in the name is removed and used as the region name
5930 (_xx is an underscore, two letters and followed by a non-letter).
5931 This is mainly for testing purposes. You must make sure the correct
5932 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005933 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00005934 idea to set 'spelllang' after setting 'encoding' to avoid loading the
5935 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00005936 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005937
Bram Moolenaar98692072006-02-04 00:57:42 +00005938 If the |spellfile.vim| plugin is active and you use a language name
5939 for which Vim cannot find the .spl file in 'runtimepath' the plugin
5940 will ask you if you want to download the file.
5941
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005942 After this option has been set successfully, Vim will source the files
5943 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005944 up to the first comma, dot or underscore.
5945 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005946
5947
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005948 *'spellsuggest'* *'sps'*
5949'spellsuggest' 'sps' string (default "best")
5950 global
5951 {not in Vi}
5952 {not available when compiled without the |+syntax|
5953 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005954 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005955 the |spellsuggest()| function. This is a comma-separated list of
5956 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005957
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005958 best Internal method that works best for English. Finds
5959 changes like "fast" and uses a bit of sound-a-like
5960 scoring to improve the ordering.
5961
5962 double Internal method that uses two methods and mixes the
5963 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005964 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005965 word. That only works when the language specifies
5966 sound folding. Can be slow and doesn't always give
5967 better results.
5968
5969 fast Internal method that only checks for simple changes:
5970 character inserts/deletes/swaps. Works well for
5971 simple typing mistakes.
5972
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005973 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005974 Not used for |spellsuggest()|. The number of
5975 suggestions is never more than the value of 'lines'
5976 minus two.
5977
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005978 file:{filename} Read file {filename}, which must have two columns,
5979 separated by a slash. The first column contains the
5980 bad word, the second column the suggested good word.
5981 Example:
5982 theribal/terrible ~
5983 Use this for common mistakes that do not appear at the
5984 top of the suggestion list with the internal methods.
5985 Lines without a slash are ignored, use this for
5986 comments.
5987 The file is used for all languages.
5988
5989 expr:{expr} Evaluate expression {expr}. Use a function to avoid
5990 trouble with spaces. |v:val| holds the badly spelled
5991 word. The expression must evaluate to a List of
5992 Lists, each with a suggestion and a score.
5993 Example:
5994 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005995 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005996 internal methods use. A lower score is better.
5997 This may invoke |spellsuggest()| if you temporarily
5998 set 'spellsuggest' to exclude the "expr:" part.
5999 Errors are silently ignored, unless you set the
6000 'verbose' option to a non-zero value.
6001
6002 Only one of "best", "double" or "fast" may be used. The others may
6003 appear several times in any order. Example: >
6004 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6005<
6006 This option cannot be set from a |modeline| or in the |sandbox|, for
6007 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006008
6009
Bram Moolenaar071d4272004-06-13 20:20:40 +00006010 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6011'splitbelow' 'sb' boolean (default off)
6012 global
6013 {not in Vi}
6014 {not available when compiled without the +windows
6015 feature}
6016 When on, splitting a window will put the new window below the current
6017 one. |:split|
6018
6019 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6020'splitright' 'spr' boolean (default off)
6021 global
6022 {not in Vi}
6023 {not available when compiled without the +vertsplit
6024 feature}
6025 When on, splitting a window will put the new window right of the
6026 current one. |:vsplit|
6027
6028 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6029'startofline' 'sol' boolean (default on)
6030 global
6031 {not in Vi}
6032 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006033 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006034 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006035 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006036 with a linewise operator, with "%" with a count and to buffer changing
6037 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6038 only has a line number, e.g., ":25" or ":+".
6039 In case of buffer changing commands the cursor is placed at the column
6040 where it was the last time the buffer was edited.
6041 NOTE: This option is set when 'compatible' is set.
6042
6043 *'statusline'* *'stl'* *E540* *E541* *E542*
6044'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006045 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006046 {not in Vi}
6047 {not available when compiled without the |+statusline|
6048 feature}
6049 When nonempty, this option determines the content of the status line.
6050 Also see |status-line|.
6051
6052 The option consists of printf style '%' items interspersed with
6053 normal text. Each status line item is of the form:
6054 %-0{minwid}.{maxwid}{item}
6055 All fields except the {item} is optional. A single percent sign can
6056 be given as "%%". Up to 80 items can be specified.
6057
Bram Moolenaar238a5642006-02-21 22:12:05 +00006058 When the option starts with "%!" then it is used as an expression,
6059 evaluated and the result is used as the option value. Example: >
6060 :set statusline=%!MyStatusLine()
6061< The result can contain %{} items that will be evaluated too.
6062
6063 When there is error while evaluating the option then it will be made
6064 empty to avoid further errors. Otherwise screen updating would loop.
6065
Bram Moolenaar071d4272004-06-13 20:20:40 +00006066 Note that the only effect of 'ruler' when this option is set (and
6067 'laststatus' is 2) is controlling the output of |CTRL-G|.
6068
6069 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006070 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006071 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006072 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006073 minwid Minimum width of the item, padding as set by '-' & '0'.
6074 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006075 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006076 on the left for text items. Numeric items will be
6077 shifted down to maxwid-2 digits followed by '>'number
6078 where number is the amount of missing digits, much like
6079 an exponential notation.
6080 item A one letter code as described below.
6081
6082 Following is a description of the possible statusline items. The
6083 second character in "item" is the type:
6084 N for number
6085 S for string
6086 F for flags as described below
6087 - not applicable
6088
6089 item meaning ~
6090 f S Path to the file in the buffer, relative to current directory.
6091 F S Full path to the file in the buffer.
6092 t S File name (tail) of file in the buffer.
6093 m F Modified flag, text is " [+]"; " [-]" if 'modifiable' is off.
6094 M F Modified flag, text is ",+" or ",-".
6095 r F Readonly flag, text is " [RO]".
6096 R F Readonly flag, text is ",RO".
6097 h F Help buffer flag, text is " [help]".
6098 H F Help buffer flag, text is ",HLP".
6099 w F Preview window flag, text is " [Preview]".
6100 W F Preview window flag, text is ",PRV".
6101 y F Type of file in the buffer, e.g., " [vim]". See 'filetype'.
6102 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6103 {not available when compiled without |+autocmd| feature}
6104 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6105 being used: "<keymap>"
6106 n N Buffer number.
6107 b N Value of byte under cursor.
6108 B N As above, in hexadecimal.
6109 o N Byte number in file of byte under cursor, first byte is 1.
6110 Mnemonic: Offset from start of file (with one added)
6111 {not available when compiled without |+byte_offset| feature}
6112 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006113 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006114 l N Line number.
6115 L N Number of lines in buffer.
6116 c N Column number.
6117 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006118 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006119 p N Percentage through file in lines as in |CTRL-G|.
6120 P S Percentage through file of displayed window. This is like the
6121 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006122 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006123 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006124 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006125 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006126 ( - Start of item group. Can be used for setting the width and
6127 alignment of a section. Must be followed by %) somewhere.
6128 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006129 T N For 'tabline': start of tab page N label. Use %T after the last
6130 label. This information is used for mouse clicks.
6131 X N For 'tabline': start of close tab N label. Use %X after the
6132 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6133 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006134 < - Where to truncate line if too long. Default is at the start.
6135 No width fields allowed.
6136 = - Separation point between left and right aligned items.
6137 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006138 # - Set highlight group. The name must follow and then a # again.
6139 Thus use %#HLname# for highlight group HLname. The same
6140 highlighting is used, also for the statusline of non-current
6141 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006142 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006143 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006144 The difference between User{N} and StatusLine will be applied
6145 to StatusLineNC for the statusline of non-current windows.
6146 The number N must be between 1 and 9. See |hl-User1..9|
6147
6148 Display of flags are controlled by the following heuristic:
6149 If a flag text starts with comma it is assumed that it wants to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006150 separate itself from anything but preceding plaintext. If it starts
Bram Moolenaar071d4272004-06-13 20:20:40 +00006151 with a space it is assumed that it wants to separate itself from
6152 anything but other flags. That is: A leading comma is removed if the
6153 preceding character stems from plaintext. A leading space is removed
Bram Moolenaar582fd852005-03-28 20:58:01 +00006154 if the preceding character stems from another active flag. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006155 make a nice display when flags are used like in the examples below.
6156
Bram Moolenaar582fd852005-03-28 20:58:01 +00006157 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006158 not set) and a minwid is not set for the group, the whole group will
6159 become empty. This will make a group like the following disappear
6160 completely from the statusline when none of the flags are set. >
6161 :set statusline=...%(\ [%M%R%H]%)...
6162<
6163 Beware that an expression is evaluated each and every time the status
6164 line is displayed. The current buffer and current window will be set
6165 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006166 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006167 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006168 real current buffer.
6169
6170 The 'statusline' option may be evaluated in the |sandbox|, see
6171 |sandbox-option|.
6172
6173 It is not allowed to change text or jump to another window while
6174 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006175
6176 If the statusline is not updated when you want it (e.g., after setting
6177 a variable that's used in an expression), you can force an update by
6178 setting an option without changing its value. Example: >
6179 :let &ro = &ro
6180
6181< A result of all digits is regarded a number for display purposes.
6182 Otherwise the result is taken as flag text and applied to the rules
6183 described above.
6184
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006185 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006186 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6187 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6188
6189 Examples:
6190 Emulate standard status line with 'ruler' set >
6191 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6192< Similar, but add ASCII value of char under the cursor (like "ga") >
6193 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6194< Display byte count and byte value, modified flag in red. >
6195 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6196 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6197< Display a ,GZ flag if a compressed file is loaded >
6198 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6199< In the |:autocmd|'s: >
6200 :let b:gzflag = 1
6201< And: >
6202 :unlet b:gzflag
6203< And define this function: >
6204 :function VarExists(var, val)
6205 : if exists(a:var) | return a:val | else | return '' | endif
6206 :endfunction
6207<
6208 *'suffixes'* *'su'*
6209'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6210 global
6211 {not in Vi}
6212 Files with these suffixes get a lower priority when multiple files
6213 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006214 suffixes. Spaces after the comma are ignored. A dot is also seen as
6215 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006216 separator, precede it with a backslash (see |option-backslash| about
6217 including spaces and backslashes).
6218 See 'wildignore' for completely ignoring files.
6219 The use of |:set+=| and |:set-=| is preferred when adding or removing
6220 suffixes from the list. This avoids problems when a future version
6221 uses another default.
6222
6223 *'suffixesadd'* *'sua'*
6224'suffixesadd' 'sua' string (default "")
6225 local to buffer
6226 {not in Vi}
6227 {not available when compiled without the
6228 |+file_in_path| feature}
6229 Comma separated list of suffixes, which are used when searching for a
6230 file for the "gf", "[I", etc. commands. Example: >
6231 :set suffixesadd=.java
6232<
6233 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6234'swapfile' 'swf' boolean (default on)
6235 local to buffer
6236 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006237 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006238 swapfile is not wanted for a specific buffer. For example, with
6239 confidential information that even root must not be able to access.
6240 Careful: All text will be in memory:
6241 - Don't use this for big files.
6242 - Recovery will be impossible!
6243 A swapfile will only be present when |'updatecount'| is non-zero and
6244 'swapfile' is set.
6245 When 'swapfile' is reset, the swap file for the current buffer is
6246 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6247 non-zero, a swap file is immediately created.
6248 Also see |swap-file| and |'swapsync'|.
6249
6250 This option is used together with 'bufhidden' and 'buftype' to
6251 specify special kinds of buffers. See |special-buffers|.
6252
6253 *'swapsync'* *'sws'*
6254'swapsync' 'sws' string (default "fsync")
6255 global
6256 {not in Vi}
6257 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006258 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006259 When this option is empty parts of the swap file may be in memory and
6260 not written to disk. When the system crashes you may lose more work.
6261 On Unix the system does a sync now and then without Vim asking for it,
6262 so the disadvantage of setting this option off is small. On some
6263 systems the swap file will not be written at all. For a unix system
6264 setting it to "sync" will use the sync() call instead of the default
6265 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006266 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006267
6268 *'switchbuf'* *'swb'*
6269'switchbuf' 'swb' string (default "")
6270 global
6271 {not in Vi}
6272 This option controls the behavior when switching between buffers.
6273 Possible values (comma separated list):
6274 useopen If included, jump to the first open window that
6275 contains the specified buffer (if there is one).
6276 Otherwise: Do not examine other windows.
6277 This setting is checked with |quickfix| commands, when
6278 jumping to errors (":cc", ":cn", "cp", etc.). It is
6279 also used in all buffer related split commands, for
6280 example ":sbuffer", ":sbnext", or ":sbrewind".
6281 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006282 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006283 Supported in |quickfix| commands that display errors.
6284
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006285 *'synmaxcol'* *'smc'*
6286'synmaxcol' 'smc' number (default 3000)
6287 local to buffer
6288 {not in Vi}
6289 {not available when compiled without the |+syntax|
6290 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006291 Maximum column in which to search for syntax items. In long lines the
6292 text after this column is not highlighted and following lines may not
6293 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006294 This helps to avoid very slow redrawing for an XML file that is one
6295 long line.
6296 Set to zero to remove the limit.
6297
Bram Moolenaar071d4272004-06-13 20:20:40 +00006298 *'syntax'* *'syn'*
6299'syntax' 'syn' string (default empty)
6300 local to buffer
6301 {not in Vi}
6302 {not available when compiled without the |+syntax|
6303 feature}
6304 When this option is set, the syntax with this name is loaded, unless
6305 syntax highlighting has been switched off with ":syntax off".
6306 Otherwise this option does not always reflect the current syntax (the
6307 b:current_syntax variable does).
6308 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006309 not automatically recognized. Example, in an IDL file: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006310 /* vim: set syntax=idl : */
6311< To switch off syntax highlighting for the current file, use: >
6312 :set syntax=OFF
6313< To switch syntax highlighting on according to the current value of the
6314 'filetype' option: >
6315 :set syntax=ON
6316< What actually happens when setting the 'syntax' option is that the
6317 Syntax autocommand event is triggered with the value as argument.
6318 This option is not copied to another buffer, independent of the 's' or
6319 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006320 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006321
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006322 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006323'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006324 global
6325 {not in Vi}
6326 {not available when compiled without the +windows
6327 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006328 When nonempty, this option determines the content of the tab pages
6329 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006330 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006331
6332 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006333 option and only when there is no GUI tab line. When 'e' is in
6334 'guioptions' and the GUI supports a tab line 'guitablabel' is used
6335 instead.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006336
6337 The value is evaluated like with 'statusline'. You can use
6338 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006339 the text to be displayed. Use "%1T" for the first label, "%2T" for
6340 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006341
6342 Keep in mind that only one of the tab pages is the current one, others
6343 are invisible and you can't jump to their windows.
6344
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006345
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006346 *'tabpagemax'* *'tpm'*
6347'tabpagemax' 'tpm' number (default 10)
6348 global
6349 {not in Vi}
6350 {not available when compiled without the +windows
6351 feature}
6352 Maximum number of tab pages to be opened by the |-p| command line
6353 argument or the ":tab all" command. |tabpage|
6354
6355
6356 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006357'tabstop' 'ts' number (default 8)
6358 local to buffer
6359 Number of spaces that a <Tab> in the file counts for. Also see
6360 |:retab| command, and 'softtabstop' option.
6361
6362 Note: Setting 'tabstop' to any other value than 8 can make your file
6363 appear wrong in many places (e.g., when printing it).
6364
6365 There are four main ways to use tabs in Vim:
6366 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6367 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
6368 will use a mix of tabs and spaces, but typing Tab and BS will
6369 behave like a tab appears every 4 (or 3) characters.
6370 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6371 'expandtab'. This way you will always insert spaces. The
6372 formatting will never be messed up when 'tabstop' is changed.
6373 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006374 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006375 works when using Vim to edit the file.
6376 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6377 'noexpandtab'. This should then work (for initial indents only)
6378 for any tabstop setting that people use. It might be nice to have
6379 tabs after the first non-blank inserted as spaces if you do this
6380 though. Otherwise aligned comments will be wrong when 'tabstop' is
6381 changed.
6382
6383 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6384'tagbsearch' 'tbs' boolean (default on)
6385 global
6386 {not in Vi}
6387 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006388 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006389 searching makes searching for a tag a LOT faster, but a linear search
6390 will find more tags if the tags file wasn't properly sorted.
6391 Vim normally assumes that your tags files are sorted, or indicate that
6392 they are not sorted. Only when this is not the case does the
6393 'tagbsearch' option need to be switched off.
6394
6395 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006396 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006397 certain files, or retry all files with a linear search. When
6398 'tagbsearch' is off, only a linear search is done.
6399
6400 Linear searching is done anyway, for one file, when Vim finds a line
6401 at the start of the file indicating that it's not sorted: >
6402 !_TAG_FILE_SORTED 0 /some command/
6403< [The whitespace before and after the '0' must be a single <Tab>]
6404
6405 When a binary search was done and no match was found in any of the
6406 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6407 instead of a normal tag name, a retry is done with a linear search.
6408 Tags in unsorted tags files, and matches with different case will only
6409 be found in the retry.
6410
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006411 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006412 linear search can be avoided for the 'ignorecase' case. Use a value
6413 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6414 case-fold sorted with the -f switch to "sort" in most unices, as in
6415 the command: "sort -f -o tags tags". For "Exuberant ctags" version
6416 5.3 or higher the -f or --fold-case-sort switch can be used for this
6417 as well. Note that case must be folded to uppercase for this to work.
6418
6419 When 'tagbsearch' is off, tags searching is slower when a full match
6420 exists, but faster when no full match exists. Tags in unsorted tags
6421 files may only be found with 'tagbsearch' off.
6422 When the tags file is not sorted, or sorted in a wrong way (not on
6423 ASCII byte value), 'tagbsearch' should be off, or the line given above
6424 must be included in the tags file.
6425 This option doesn't affect commands that find all matching tags (e.g.,
6426 command-line completion and ":help").
6427 {Vi: always uses binary search in some versions}
6428
6429 *'taglength'* *'tl'*
6430'taglength' 'tl' number (default 0)
6431 global
6432 If non-zero, tags are significant up to this number of characters.
6433
6434 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6435'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6436 global
6437 {not in Vi}
6438 If on and using a tag file in another directory, file names in that
6439 tag file are relative to the directory where the tag file is.
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 *'tags'* *'tag'* *E433*
6444'tags' 'tag' string (default "./tags,tags", when compiled with
6445 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6446 global or local to buffer |global-local|
6447 Filenames for the tag command, separated by spaces or commas. To
6448 include a space or comma in a file name, precede it with a backslash
6449 (see |option-backslash| about including spaces and backslashes).
6450 When a file name starts with "./", the '.' is replaced with the path
6451 of the current file. But only when the 'd' flag is not included in
6452 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6453 |tags-option|.
6454 "*", "**" and other wildcards can be used to search for tags files in
6455 a directory tree. See |file-searching|. {not available when compiled
6456 without the |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006457 The |tagfiles()| function can be used to get a list of the file names
6458 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006459 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6460 files are also supported. They are automatically recognized. The
6461 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6462 differences are ignored (MS-Windows). |emacs-tags|
6463 The use of |:set+=| and |:set-=| is preferred when adding or removing
6464 file names from the list. This avoids problems when a future version
6465 uses another default.
6466 {Vi: default is "tags /usr/lib/tags"}
6467
6468 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6469'tagstack' 'tgst' boolean (default on)
6470 global
6471 {not in all versions of Vi}
6472 When on, the |tagstack| is used normally. When off, a ":tag" or
6473 ":tselect" command with an argument will not push the tag onto the
6474 tagstack. A following ":tag" without an argument, a ":pop" command or
6475 any other command that uses the tagstack will use the unmodified
6476 tagstack, but does change the pointer to the active entry.
6477 Resetting this option is useful when using a ":tag" command in a
6478 mapping which should not change the tagstack.
6479
6480 *'term'* *E529* *E530* *E531*
6481'term' string (default is $TERM, if that fails:
6482 in the GUI: "builtin_gui"
6483 on Amiga: "amiga"
6484 on BeOS: "beos-ansi"
6485 on Mac: "mac-ansi"
6486 on MiNT: "vt52"
6487 on MS-DOS: "pcterm"
6488 on OS/2: "os2ansi"
6489 on Unix: "ansi"
6490 on VMS: "ansi"
6491 on Win 32: "win32")
6492 global
6493 Name of the terminal. Used for choosing the terminal control
6494 characters. Environment variables are expanded |:set_env|.
6495 For example: >
6496 :set term=$TERM
6497< See |termcap|.
6498
6499 *'termbidi'* *'tbidi'*
6500 *'notermbidi'* *'notbidi'*
6501'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6502 global
6503 {not in Vi}
6504 {only available when compiled with the |+arabic|
6505 feature}
6506 The terminal is in charge of Bi-directionality of text (as specified
6507 by Unicode). The terminal is also expected to do the required shaping
6508 that some languages (such as Arabic) require.
6509 Setting this option implies that 'rightleft' will not be set when
6510 'arabic' is set and the value of 'arabicshape' will be ignored.
6511 Note that setting 'termbidi' has the immediate effect that
6512 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6513 This option is reset when the GUI is started.
6514 For further details see |arabic.txt|.
6515
6516 *'termencoding'* *'tenc'*
6517'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6518 Macintosh GUI: "macroman")
6519 global
6520 {only available when compiled with the |+multi_byte|
6521 feature}
6522 {not in Vi}
6523 Encoding used for the terminal. This specifies what character
6524 encoding the keyboard produces and the display will understand. For
6525 the GUI it only applies to the keyboard ('encoding' is used for the
6526 display).
6527 In the Win32 console version the default value is the console codepage
6528 when it differs from the ANSI codepage.
6529 *E617*
6530 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6531 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6532 Any attempts to set a different value will be rejected, and an error
6533 message is shown.
6534 For the Win32 GUI 'termencoding' is not used for typed characters,
6535 because the Win32 system always passes Unicode characters.
6536 When empty, the same encoding is used as for the 'encoding' option.
6537 This is the normal value.
6538 Not all combinations for 'termencoding' and 'encoding' are valid. See
6539 |encoding-table|.
6540 The value for this option must be supported by internal conversions or
6541 iconv(). When this is not possible no conversion will be done and you
6542 will probably experience problems with non-ASCII characters.
6543 Example: You are working with the locale set to euc-jp (Japanese) and
6544 want to edit a UTF-8 file: >
6545 :let &termencoding = &encoding
6546 :set encoding=utf-8
6547< You need to do this when your system has no locale support for UTF-8.
6548
6549 *'terse'* *'noterse'*
6550'terse' boolean (default off)
6551 global
6552 When set: Add 's' flag to 'shortmess' option (this makes the message
6553 for a search that hits the start or end of the file not being
6554 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6555 shortens a lot of messages}
6556
6557 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6558'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6559 global
6560 {not in Vi}
6561 This option is obsolete. Use 'fileformats'.
6562 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6563 set to the default value for the current system. When 'textauto' is
6564 reset, 'fileformats' is made empty.
6565 NOTE: This option is set to the Vi default value when 'compatible' is
6566 set and to the Vim default value when 'compatible' is reset.
6567
6568 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6569'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
6570 others: default off)
6571 local to buffer
6572 {not in Vi}
6573 This option is obsolete. Use 'fileformat'.
6574 For backwards compatibility, when 'textmode' is set, 'fileformat' is
6575 set to "dos". When 'textmode' is reset, 'fileformat' is set to
6576 "unix".
6577
6578 *'textwidth'* *'tw'*
6579'textwidth' 'tw' number (default 0)
6580 local to buffer
6581 {not in Vi}
6582 Maximum width of text that is being inserted. A longer line will be
6583 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006584 this. 'textwidth' is set to 0 when the 'paste' option is set. When
6585 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00006586 'formatoptions' and |ins-textwidth|.
6587 NOTE: This option is set to 0 when 'compatible' is set.
6588
6589 *'thesaurus'* *'tsr'*
6590'thesaurus' 'tsr' string (default "")
6591 global or local to buffer |global-local|
6592 {not in Vi}
6593 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006594 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00006595 the file should contain words with similar meaning, separated by
6596 non-keyword characters (white space is preferred). Maximum line
6597 length is 510 bytes.
6598 To obtain a file to be used here, check out the wordlist FAQ at
6599 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006600 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00006601 after a comma are ignored, otherwise spaces are included in the file
6602 name. See |option-backslash| about using backslashes.
6603 The use of |:set+=| and |:set-=| is preferred when adding or removing
6604 directories from the list. This avoids problems when a future version
6605 uses another default.
6606 Backticks cannot be used in this option for security reasons.
6607
6608 *'tildeop'* *'top'* *'notildeop'* *'notop'*
6609'tildeop' 'top' boolean (default off)
6610 global
6611 {not in Vi}
6612 When on: The tilde command "~" behaves like an operator.
6613 NOTE: This option is reset when 'compatible' is set.
6614
6615 *'timeout'* *'to'* *'notimeout'* *'noto'*
6616'timeout' 'to' boolean (default on)
6617 global
6618 *'ttimeout'* *'nottimeout'*
6619'ttimeout' boolean (default off)
6620 global
6621 {not in Vi}
6622 These two options together determine the behavior when part of a
6623 mapped key sequence or keyboard code has been received:
6624
6625 'timeout' 'ttimeout' action ~
6626 off off do not time out
6627 on on or off time out on :mappings and key codes
6628 off on time out on key codes
6629
6630 If both options are off, Vim will wait until either the complete
6631 mapping or key sequence has been received, or it is clear that there
6632 is no mapping or key sequence for the received characters. For
6633 example: if you have mapped "vl" and Vim has received 'v', the next
6634 character is needed to see if the 'v' is followed by an 'l'.
6635 When one of the options is on, Vim will wait for about 1 second for
6636 the next character to arrive. After that the already received
6637 characters are interpreted as single characters. The waiting time can
6638 be changed with the 'timeoutlen' option.
6639 On slow terminals or very busy systems timing out may cause
6640 malfunctioning cursor keys. If both options are off, Vim waits
6641 forever after an entered <Esc> if there are key codes that start
6642 with <Esc>. You will have to type <Esc> twice. If you do not have
6643 problems with key codes, but would like to have :mapped key
6644 sequences not timing out in 1 second, set the 'ttimeout' option and
6645 reset the 'timeout' option.
6646
6647 NOTE: 'ttimeout' is reset when 'compatible' is set.
6648
6649 *'timeoutlen'* *'tm'*
6650'timeoutlen' 'tm' number (default 1000)
6651 global
6652 {not in all versions of Vi}
6653 *'ttimeoutlen'* *'ttm'*
6654'ttimeoutlen' 'ttm' number (default -1)
6655 global
6656 {not in Vi}
6657 The time in milliseconds that is waited for a key code or mapped key
6658 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
6659 when part of a command has been typed.
6660 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
6661 different timeout value for key codes is desired set 'ttimeoutlen' to
6662 a non-negative number.
6663
6664 ttimeoutlen mapping delay key code delay ~
6665 < 0 'timeoutlen' 'timeoutlen'
6666 >= 0 'timeoutlen' 'ttimeoutlen'
6667
6668 The timeout only happens when the 'timeout' and 'ttimeout' options
6669 tell so. A useful setting would be >
6670 :set timeout timeoutlen=3000 ttimeoutlen=100
6671< (time out on mapping after three seconds, time out on key codes after
6672 a tenth of a second).
6673
6674 *'title'* *'notitle'*
6675'title' boolean (default off, on when title can be restored)
6676 global
6677 {not in Vi}
6678 {not available when compiled without the |+title|
6679 feature}
6680 When on, the title of the window will be set to the value of
6681 'titlestring' (if it is not empty), or to:
6682 filename [+=-] (path) - VIM
6683 Where:
6684 filename the name of the file being edited
6685 - indicates the file cannot be modified, 'ma' off
6686 + indicates the file was modified
6687 = indicates the file is read-only
6688 =+ indicates the file is read-only and modified
6689 (path) is the path of the file being edited
6690 - VIM the server name |v:servername| or "VIM"
6691 Only works if the terminal supports setting window titles
6692 (currently Amiga console, Win32 console, all GUI versions and
6693 terminals with a non- empty 't_ts' option - these are Unix xterm and
6694 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
6695 *X11*
6696 When Vim was compiled with HAVE_X11 defined, the original title will
6697 be restored if possible. The output of ":version" will include "+X11"
6698 when HAVE_X11 was defined, otherwise it will be "-X11". This also
6699 works for the icon name |'icon'|.
6700 But: When Vim was started with the |-X| argument, restoring the title
6701 will not work (except in the GUI).
6702 If the title cannot be restored, it is set to the value of 'titleold'.
6703 You might want to restore the title outside of Vim then.
6704 When using an xterm from a remote machine you can use this command:
6705 rsh machine_name xterm -display $DISPLAY &
6706 then the WINDOWID environment variable should be inherited and the
6707 title of the window should change back to what it should be after
6708 exiting Vim.
6709
6710 *'titlelen'*
6711'titlelen' number (default 85)
6712 global
6713 {not in Vi}
6714 {not available when compiled without the |+title|
6715 feature}
6716 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006717 title. When the title is longer, only the end of the path name is
6718 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006719 Using a percentage makes this adapt to the width of the window. But
6720 it won't work perfectly, because the actual number of characters
6721 available also depends on the font used and other things in the title
6722 bar. When 'titlelen' is zero the full path is used. Otherwise,
6723 values from 1 to 30000 percent can be used.
6724 'titlelen' is also used for the 'titlestring' option.
6725
6726 *'titleold'*
6727'titleold' string (default "Thanks for flying Vim")
6728 global
6729 {not in Vi}
6730 {only available when compiled with the |+title|
6731 feature}
6732 This option will be used for the window title when exiting Vim if the
6733 original title cannot be restored. Only happens if 'title' is on or
6734 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006735 This option cannot be set from a |modeline| or in the |sandbox|, for
6736 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006737 *'titlestring'*
6738'titlestring' string (default "")
6739 global
6740 {not in Vi}
6741 {not available when compiled without the |+title|
6742 feature}
6743 When this option is not empty, it will be used for the title of the
6744 window. This happens only when the 'title' option is on.
6745 Only works if the terminal supports setting window titles (currently
6746 Amiga console, Win32 console, all GUI versions and terminals with a
6747 non-empty 't_ts' option).
6748 When Vim was compiled with HAVE_X11 defined, the original title will
6749 be restored if possible |X11|.
6750 When this option contains printf-style '%' items, they will be
6751 expanded according to the rules used for 'statusline'.
6752 Example: >
6753 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
6754 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
6755< The value of 'titlelen' is used to align items in the middle or right
6756 of the available space.
6757 Some people prefer to have the file name first: >
6758 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
6759< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006760 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006761 separating space only when needed.
6762 NOTE: Use of special characters in 'titlestring' may cause the display
6763 to be garbled (e.g., when it contains a CR or NL character).
6764 {not available when compiled without the |+statusline| feature}
6765
6766 *'toolbar'* *'tb'*
6767'toolbar' 'tb' string (default "icons,tooltips")
6768 global
6769 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
6770 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006771 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00006772 possible values are:
6773 icons Toolbar buttons are shown with icons.
6774 text Toolbar buttons shown with text.
6775 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006776 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006777 tooltips Tooltips are active for toolbar buttons.
6778 Tooltips refer to the popup help text which appears after the mouse
6779 cursor is placed over a toolbar button for a brief moment.
6780
6781 If you want the toolbar to be shown with icons as well as text, do the
6782 following: >
6783 :set tb=icons,text
6784< Motif and Athena cannot display icons and text at the same time. They
6785 will show icons if both are requested.
6786
6787 If none of the strings specified in 'toolbar' are valid or if
6788 'toolbar' is empty, this option is ignored. If you want to disable
6789 the toolbar, you need to set the 'guioptions' option. For example: >
6790 :set guioptions-=T
6791< Also see |gui-toolbar|.
6792
6793 *'toolbariconsize'* *'tbis'*
6794'toolbariconsize' 'tbis' string (default "small")
6795 global
6796 {not in Vi}
6797 {only in the GTK+ 2 GUI}
6798 Controls the size of toolbar icons. The possible values are:
6799 tiny Use tiny toolbar icons.
6800 small Use small toolbar icons (default).
6801 medium Use medium-sized toolbar icons.
6802 large Use large toolbar icons.
6803 The exact dimensions in pixels of the various icon sizes depend on
6804 the current theme. Common dimensions are large=32x32, medium=24x24,
6805 small=20x20 and tiny=16x16.
6806
6807 If 'toolbariconsize' is empty, the global default size as determined
6808 by user preferences or the current theme is used.
6809
6810 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
6811'ttybuiltin' 'tbi' boolean (default on)
6812 global
6813 {not in Vi}
6814 When on, the builtin termcaps are searched before the external ones.
6815 When off the builtin termcaps are searched after the external ones.
6816 When this option is changed, you should set the 'term' option next for
6817 the change to take effect, for example: >
6818 :set notbi term=$TERM
6819< See also |termcap|.
6820 Rationale: The default for this option is "on", because the builtin
6821 termcap entries are generally better (many systems contain faulty
6822 xterm entries...).
6823
6824 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
6825'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
6826 sun-cmd, screen, rxvt, dtterm or
6827 iris-ansi; also on when running Vim in
6828 a DOS console)
6829 global
6830 {not in Vi}
6831 Indicates a fast terminal connection. More characters will be sent to
6832 the screen for redrawing, instead of using insert/delete line
6833 commands. Improves smoothness of redrawing when there are multiple
6834 windows and the terminal does not support a scrolling region.
6835 Also enables the extra writing of characters at the end of each screen
6836 line for lines that wrap. This helps when using copy/paste with the
6837 mouse in an xterm and other terminals.
6838
6839 *'ttymouse'* *'ttym'*
6840'ttymouse' 'ttym' string (default depends on 'term')
6841 global
6842 {not in Vi}
6843 {only in Unix and VMS, doesn't work in the GUI; not
6844 available when compiled without |+mouse|}
6845 Name of the terminal type for which mouse codes are to be recognized.
6846 Currently these three strings are valid:
6847 *xterm-mouse*
6848 xterm xterm-like mouse handling. The mouse generates
6849 "<Esc>[Mscr", where "scr" is three bytes:
6850 "s" = button state
6851 "c" = column plus 33
6852 "r" = row plus 33
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006853 This only works up to 223 columns! See "dec" for a
6854 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006855 xterm2 Works like "xterm", but with the xterm reporting the
6856 mouse position while the mouse is dragged. This works
6857 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00006858 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00006859 work. See below for how Vim detects this
6860 automatically.
6861 *netterm-mouse*
6862 netterm NetTerm mouse handling. The mouse generates
6863 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
6864 for the row and column.
6865 *dec-mouse*
6866 dec DEC terminal mouse handling. The mouse generates a
6867 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006868 This is also available for an Xterm, if it was
6869 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006870 *jsbterm-mouse*
6871 jsbterm JSB term mouse handling.
6872 *pterm-mouse*
6873 pterm QNX pterm mouse handling.
6874
6875 The mouse handling must be enabled at compile time |+mouse_xterm|
6876 |+mouse_dec| |+mouse_netterm|.
6877 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
6878 recognized, if enabled at compile time. DEC terminal mouse codes
6879 are recognized if enabled at compile time, and 'ttymouse' is not
6880 "xterm" (because the xterm and dec mouse codes conflict).
6881 This option is automatically set to "xterm", when the 'term' option is
6882 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
6883 or "xterm2" already. The main use of this option is to set it to
6884 "xterm", when the terminal name doesn't start with "xterm", but it can
6885 handle xterm mouse codes.
6886 The "xterm2" value will be set if the xterm version is reported to be
6887 95 of higher. This only works when compiled with the |+termresponse|
6888 feature and if |t_RV| is set to the escape sequence to request the
6889 xterm version number. Otherwise "xterm2" must be set explicitly.
6890 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
6891 t_RV to an empty string: >
6892 :set t_RV=
6893<
6894 *'ttyscroll'* *'tsl'*
6895'ttyscroll' 'tsl' number (default 999)
6896 global
6897 Maximum number of lines to scroll the screen. If there are more lines
6898 to scroll the window is redrawn. For terminals where scrolling is
6899 very slow and redrawing is not slow this can be set to a small number,
6900 e.g., 3, to speed up displaying.
6901
6902 *'ttytype'* *'tty'*
6903'ttytype' 'tty' string (default from $TERM)
6904 global
6905 Alias for 'term', see above.
6906
6907 *'undolevels'* *'ul'*
6908'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
6909 Win32 and OS/2)
6910 global
6911 {not in Vi}
6912 Maximum number of changes that can be undone. Since undo information
6913 is kept in memory, higher numbers will cause more memory to be used
6914 (nevertheless, a single change can use an unlimited amount of memory).
6915 Set to 0 for Vi compatibility: One level of undo and "u" undoes
6916 itself: >
6917 set ul=0
6918< But you can also get Vi compatibility by including the 'u' flag in
6919 'cpoptions', and still be able to use CTRL-R to repeat undo.
6920 Set to a negative number for no undo at all: >
6921 set ul=-1
6922< This helps when you run out of memory for a single change.
6923 Also see |undo-two-ways|.
6924
6925 *'updatecount'* *'uc'*
6926'updatecount' 'uc' number (default: 200)
6927 global
6928 {not in Vi}
6929 After typing this many characters the swap file will be written to
6930 disk. When zero, no swap file will be created at all (see chapter on
6931 recovery |crash-recovery|). 'updatecount' is set to zero by starting
6932 Vim with the "-n" option, see |startup|. When editing in readonly
6933 mode this option will be initialized to 10000.
6934 The swapfile can be disabled per buffer with |'swapfile'|.
6935 When 'updatecount' is set from zero to non-zero, swap files are
6936 created for all buffers that have 'swapfile' set. When 'updatecount'
6937 is set to zero, existing swap files are not deleted.
6938 Also see |'swapsync'|.
6939 This option has no meaning in buffers where |'buftype'| is "nofile"
6940 or "nowrite".
6941
6942 *'updatetime'* *'ut'*
6943'updatetime' 'ut' number (default 4000)
6944 global
6945 {not in Vi}
6946 If this many milliseconds nothing is typed the swap file will be
6947 written to disk (see |crash-recovery|). Also used for the
6948 |CursorHold| autocommand event.
6949
6950 *'verbose'* *'vbs'*
6951'verbose' 'vbs' number (default 0)
6952 global
6953 {not in Vi, although some versions have a boolean
6954 verbose option}
6955 When bigger than zero, Vim will give messages about what it is doing.
6956 Currently, these messages are given:
6957 >= 1 When the viminfo file is read or written.
6958 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00006959 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006960 >= 8 Files for which a group of autocommands is executed.
6961 >= 9 Every executed autocommand.
6962 >= 12 Every executed function.
6963 >= 13 When an exception is thrown, caught, finished, or discarded.
6964 >= 14 Anything pending in a ":finally" clause.
6965 >= 15 Every executed Ex command (truncated at 200 characters).
6966
6967 This option can also be set with the "-V" argument. See |-V|.
6968 This option is also set by the |:verbose| command.
6969
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00006970 When the 'verbosefile' option is set then the verbose messages are not
6971 displayed.
6972
6973 *'verbosefile'* *'vfile'*
6974'verbosefile' 'vfile' string (default empty)
6975 global
6976 {not in Vi}
6977 When not empty all messages are written in a file with this name.
6978 When the file exists messages are appended.
6979 Writing to the file ends when Vim exits or when 'verbosefile' is made
6980 empty.
6981 Setting 'verbosefile' to a new value is like making it empty first.
6982 The difference with |:redir| is that verbose messages are not
6983 displayed when 'verbosefile' is set.
6984
Bram Moolenaar071d4272004-06-13 20:20:40 +00006985 *'viewdir'* *'vdir'*
6986'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
6987 "$VIM/vimfiles/view",
6988 for Unix: "~/.vim/view",
6989 for Macintosh: "$VIM:vimfiles:view"
6990 for VMS: "sys$login:vimfiles/view"
6991 for RiscOS: "Choices:vimfiles/view")
6992 global
6993 {not in Vi}
6994 {not available when compiled without the +mksession
6995 feature}
6996 Name of the directory where to store files for |:mkview|.
6997 This option cannot be set from a |modeline| or in the |sandbox|, for
6998 security reasons.
6999
7000 *'viewoptions'* *'vop'*
7001'viewoptions' 'vop' string (default: "folds,options,cursor")
7002 global
7003 {not in Vi}
7004 {not available when compiled without the +mksession
7005 feature}
7006 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007007 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007008 word save and restore ~
7009 cursor cursor position in file and in window
7010 folds manually created folds, opened/closed folds and local
7011 fold options
7012 options options and mappings local to a window or buffer (not
7013 global values for local options)
7014 slash backslashes in file names replaced with forward
7015 slashes
7016 unix with Unix end-of-line format (single <NL>), even when
7017 on Windows or DOS
7018
7019 "slash" and "unix" are useful on Windows when sharing view files
7020 with Unix. The Unix version of Vim cannot source dos format scripts,
7021 but the Windows version of Vim can source unix format scripts.
7022
7023 *'viminfo'* *'vi'* *E526* *E527* *E528*
7024'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
7025 Windows and OS/2: '20,<50,s10,h,rA:,rB:,
7026 for Amiga: '20,<50,s10,h,rdf0:,rdf1:,rdf2:
7027 for others: '20,<50,s10,h)
7028 global
7029 {not in Vi}
7030 {not available when compiled without the |+viminfo|
7031 feature}
7032 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007033 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007034 separated list of parameters, each consisting of a single character
7035 identifying the particular parameter, followed by a number or string
7036 which specifies the value of that parameter. If a particular
7037 character is left out, then the default value is used for that
7038 parameter. The following is a list of the identifying characters and
7039 the effect of their value.
7040 CHAR VALUE ~
7041 ! When included, save and restore global variables that start
7042 with an uppercase letter, and don't contain a lowercase
7043 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00007044 and "_K_L_M" are not. Only String and Number types are
7045 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007046 " Maximum number of lines saved for each register. Old name of
7047 the '<' item, with the disadvantage that you need to put a
7048 backslash before the ", otherwise it will be recognized as the
7049 start of a comment!
7050 % When included, save and restore the buffer list. If Vim is
7051 started with a file name argument, the buffer list is not
7052 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007053 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007054 without a file name and buffers for help files are not written
7055 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007056 When followed by a number, the number specifies the maximum
7057 number of buffers that are stored. Without a number all
7058 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007059 ' Maximum number of previously edited files for which the marks
7060 are remembered. This parameter must always be included when
7061 'viminfo' is non-empty.
7062 Including this item also means that the |jumplist| and the
7063 |changelist| are stored in the viminfo file.
7064 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007065 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007066 patterns are also saved. When not included, the value of
7067 'history' is used.
7068 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007069 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007070 < Maximum number of lines saved for each register. If zero then
7071 registers are not saved. When not included, all lines are
7072 saved. '"' is the old name for this item.
7073 Also see the 's' item below: limit specified in Kbyte.
7074 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007075 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007076 c When included, convert the text in the viminfo file from the
7077 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007078 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007079 f Whether file marks need to be stored. If zero, file marks ('0
7080 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007081 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007082 cursor position (when exiting or when doing ":wviminfo").
7083 h Disable the effect of 'hlsearch' when loading the viminfo
7084 file. When not included, it depends on whether ":nohlsearch"
7085 has been used since the last search command.
7086 n Name of the viminfo file. The name must immediately follow
7087 the 'n'. Must be the last one! If the "-i" argument was
7088 given when starting Vim, that file name overrides the one
7089 given here with 'viminfo'. Environment variables are expanded
7090 when opening the file, not when setting the option.
7091 r Removable media. The argument is a string (up to the next
7092 ','). This parameter can be given several times. Each
7093 specifies the start of a path for which no marks will be
7094 stored. This is to avoid removable media. For MS-DOS you
7095 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7096 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7097 ignored. Maximum length of each 'r' argument is 50
7098 characters.
7099 s Maximum size of an item in Kbyte. If zero then registers are
7100 not saved. Currently only applies to registers. The default
7101 "s10" will exclude registers with more than 10 Kbyte of text.
7102 Also see the '<' item above: line count limit.
7103
7104 Example: >
7105 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7106<
7107 '50 Marks will be remembered for the last 50 files you
7108 edited.
7109 <1000 Contents of registers (up to 1000 lines each) will be
7110 remembered.
7111 s100 Registers with more than 100 Kbyte text are skipped.
7112 :0 Command-line history will not be saved.
7113 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7114 no / Since '/' is not specified, the default will be used,
7115 that is, save all of the search history, and also the
7116 previous search and substitute patterns.
7117 no % The buffer list will not be saved nor read back.
7118 no h 'hlsearch' highlighting will be restored.
7119
7120 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7121 load the contents of the file, this is not done automatically.
7122
7123 This option cannot be set from a |modeline| or in the |sandbox|, for
7124 security reasons.
7125
7126 *'virtualedit'* *'ve'*
7127'virtualedit' 've' string (default "")
7128 global
7129 {not in Vi}
7130 {not available when compiled without the
7131 |+virtualedit| feature}
7132 A comma separated list of these words:
7133 block Allow virtual editing in Visual block mode.
7134 insert Allow virtual editing in Insert mode.
7135 all Allow virtual editing in all modes.
7136 Virtual editing means that the cursor can be positioned where there is
7137 no actual character. This can be halfway into a Tab or beyond the end
7138 of the line. Useful for selecting a rectangle in Visual mode and
7139 editing a table.
7140
7141 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7142'visualbell' 'vb' boolean (default off)
7143 global
7144 {not in Vi}
7145 Use visual bell instead of beeping. The terminal code to display the
7146 visual bell is given with 't_vb'. When no beep or flash is wanted,
7147 use ":set vb t_vb=".
7148 Note: When the GUI starts, 't_vb' is reset to its default value. You
7149 might want to set it again in your |gvimrc|.
7150 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7151 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7152 where 40 is the time in msec.
7153 Does not work on the Amiga, you always get a screen flash.
7154 Also see 'errorbells'.
7155
7156 *'warn'* *'nowarn'*
7157'warn' boolean (default on)
7158 global
7159 Give a warning message when a shell command is used while the buffer
7160 has been changed.
7161
7162 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7163'weirdinvert' 'wiv' boolean (default off)
7164 global
7165 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007166 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007167 It is provided for backwards compatibility with version 4.x.
7168 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7169 vice versa. Has no effect when the GUI is running.
7170
7171 *'whichwrap'* *'ww'*
7172'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7173 global
7174 {not in Vi}
7175 Allow specified keys that move the cursor left/right to move to the
7176 previous/next line when the cursor is on the first/last character in
7177 the line. Concatenate characters to allow this for these keys:
7178 char key mode ~
7179 b <BS> Normal and Visual
7180 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007181 h "h" Normal and Visual (not recommended)
7182 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007183 < <Left> Normal and Visual
7184 > <Right> Normal and Visual
7185 ~ "~" Normal
7186 [ <Left> Insert and Replace
7187 ] <Right> Insert and Replace
7188 For example: >
7189 :set ww=<,>,[,]
7190< allows wrap only when cursor keys are used.
7191 When the movement keys are used in combination with a delete or change
7192 operator, the <EOL> also counts for a character. This makes "3h"
7193 different from "3dh" when the cursor crosses the end of a line. This
7194 is also true for "x" and "X", because they do the same as "dl" and
7195 "dh". If you use this, you may also want to use the mapping
7196 ":map <BS> X" to make backspace delete the character in front of the
7197 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007198 When 'l' is included and it is used after an operator at the end of a
7199 line then it will not move to the next line. This makes "dl", "cl",
7200 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007201 NOTE: This option is set to the Vi default value when 'compatible' is
7202 set and to the Vim default value when 'compatible' is reset.
7203
7204 *'wildchar'* *'wc'*
7205'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7206 global
7207 {not in Vi}
7208 Character you have to type to start wildcard expansion in the
7209 command-line, as specified with 'wildmode'.
7210 The character is not recognized when used inside a macro. See
7211 'wildcharm' for that.
7212 Although 'wc' is a number option, you can set it to a special key: >
7213 :set wc=<Esc>
7214< NOTE: This option is set to the Vi default value when 'compatible' is
7215 set and to the Vim default value when 'compatible' is reset.
7216
7217 *'wildcharm'* *'wcm'*
7218'wildcharm' 'wcm' number (default: none (0))
7219 global
7220 {not in Vi}
7221 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007222 recognized when used inside a macro. You can find "spare" command-line
7223 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007224 you'll never actually type 'wildcharm', just use it in mappings that
7225 automatically invoke completion mode, e.g.: >
7226 :set wcm=<C-Z>
7227 :cmap ss so $vim/sessions/*.vim<C-Z>
7228< Then after typing :ss you can use CTRL-P & CTRL-N.
7229
7230 *'wildignore'* *'wig'*
7231'wildignore' 'wig' string (default "")
7232 global
7233 {not in Vi}
7234 {not available when compiled without the |+wildignore|
7235 feature}
7236 A list of file patterns. A file that matches with one of these
7237 patterns is ignored when completing file or directory names.
7238 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7239 Also see 'suffixes'.
7240 Example: >
7241 :set wildignore=*.o,*.obj
7242< The use of |:set+=| and |:set-=| is preferred when adding or removing
7243 a pattern from the list. This avoids problems when a future version
7244 uses another default.
7245
7246 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7247'wildmenu' 'wmnu' boolean (default off)
7248 global
7249 {not in Vi}
7250 {not available if compiled without the |+wildmenu|
7251 feature}
7252 When 'wildmenu' is on, command-line completion operates in an enhanced
7253 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7254 the possible matches are shown just above the command line, with the
7255 first match highlighted (overwriting the status line, if there is
7256 one). Keys that show the previous/next match, such as <Tab> or
7257 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7258 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7259 specified. "longest" and "list" do not start "wildmenu" mode.
7260 If there are more matches than can fit in the line, a ">" is shown on
7261 the right and/or a "<" is shown on the left. The status line scrolls
7262 as needed.
7263 The "wildmenu" mode is abandoned when a key is hit that is not used
7264 for selecting a completion.
7265 While the "wildmenu" is active the following keys have special
7266 meanings:
7267
7268 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7269 <Down> - in filename/menu name completion: move into a
7270 subdirectory or submenu.
7271 <CR> - in menu completion, when the cursor is just after a
7272 dot: move into a submenu.
7273 <Up> - in filename/menu name completion: move up into
7274 parent directory or parent menu.
7275
7276 This makes the menus accessible from the console |console-menus|.
7277
7278 If you prefer the <Left> and <Right> keys to move the cursor instead
7279 of selecting a different match, use this: >
7280 :cnoremap <Left> <Space><BS><Left>
7281 :cnoremap <Right> <Space><BS><Right>
7282<
7283 The "WildMenu" highlighting is used for displaying the current match
7284 |hl-WildMenu|.
7285
7286 *'wildmode'* *'wim'*
7287'wildmode' 'wim' string (Vim default: "full")
7288 global
7289 {not in Vi}
7290 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007291 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar071d4272004-06-13 20:20:40 +00007292 part specifies what to do for each consecutive use of 'wildchar. The
7293 first part specifies the behavior for the first use of 'wildchar',
7294 The second part for the second use, etc.
7295 These are the possible values for each part:
7296 "" Complete only the first match.
7297 "full" Complete the next full match. After the last match,
7298 the original string is used and then the first match
7299 again.
7300 "longest" Complete till longest common string. If this doesn't
7301 result in a longer string, use the next part.
7302 "longest:full" Like "longest", but also start 'wildmenu' if it is
7303 enabled.
7304 "list" When more than one match, list all matches.
7305 "list:full" When more than one match, list all matches and
7306 complete first match.
7307 "list:longest" When more than one match, list all matches and
7308 complete till longest common string.
7309 When there is only a single match, it is fully completed in all cases.
7310
7311 Examples: >
7312 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007313< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007314 :set wildmode=longest,full
7315< Complete longest common string, then each full match >
7316 :set wildmode=list:full
7317< List all matches and complete each full match >
7318 :set wildmode=list,full
7319< List all matches without completing, then each full match >
7320 :set wildmode=longest,list
7321< Complete longest common string, then list alternatives.
7322
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007323 *'wildoptions'* *'wop'*
7324'wildoptions' 'wop' string (default "")
7325 global
7326 {not in Vi}
7327 {not available when compiled without the |+wildignore|
7328 feature}
7329 A list of words that change how command line completion is done.
7330 Currently only one word is allowed:
7331 tagfile When using CTRL-D to list matching tags, the kind of
7332 tag and the file of the tag is listed. Only one match
7333 is displayed per line. Often used tag kinds are:
7334 d #define
7335 f function
7336 Also see |cmdline-completion|.
7337
Bram Moolenaar071d4272004-06-13 20:20:40 +00007338 *'winaltkeys'* *'wak'*
7339'winaltkeys' 'wak' string (default "menu")
7340 global
7341 {not in Vi}
7342 {only used in Win32, Motif, GTK and Photon GUI}
7343 Some GUI versions allow the access to menu entries by using the ALT
7344 key in combination with a character that appears underlined in the
7345 menu. This conflicts with the use of the ALT key for mappings and
7346 entering special characters. This option tells what to do:
7347 no Don't use ALT keys for menus. ALT key combinations can be
7348 mapped, but there is no automatic handling. This can then be
7349 done with the |:simalt| command.
7350 yes ALT key handling is done by the windowing system. ALT key
7351 combinations cannot be mapped.
7352 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007353 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007354 keys can be mapped.
7355 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7356 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007357 This option is not used for <F10>; on Win32 and with GTK <F10> will
7358 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007359
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007360 *'window'* *'wi'*
7361'window' 'wi' number (default screen height - 1)
7362 global
7363 Window height. Do not confuse this with the height of the Vim window,
7364 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007365 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7366 value is smaller than 'lines' minus one. The screen will scroll
7367 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007368 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7369 in a much smarter way, taking care of wrapping lines.
7370 When resizing the Vim window, the value is smaller than 1 or more than
7371 or equal to 'lines' it will be set to 'lines' minus 1.
7372 {Vi also uses the option to specify the number of displayed lines}
7373
Bram Moolenaar071d4272004-06-13 20:20:40 +00007374 *'winheight'* *'wh'* *E591*
7375'winheight' 'wh' number (default 1)
7376 global
7377 {not in Vi}
7378 {not available when compiled without the +windows
7379 feature}
7380 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007381 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007382 current window is smaller, its size is increased, at the cost of the
7383 height of other windows. Set it to 999 to make the current window
7384 always fill the screen (although this has the drawback that ":all"
7385 will create only two windows). Set it to a small number for normal
7386 editing.
7387 Minimum value is 1.
7388 The height is not adjusted after one of the commands to change the
7389 height of the current window.
7390 'winheight' applies to the current window. Use 'winminheight' to set
7391 the minimal height for other windows.
7392
7393 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7394'winfixheight' 'wfh' boolean (default off)
7395 local to window
7396 {not in Vi}
7397 {not available when compiled without the +windows
7398 feature}
7399 Keep the window height when windows are opened or closed and
7400 'equalalways' is set. Set by default for the |preview-window| and
7401 |quickfix-window|.
7402 The height may be changed anyway when running out of room.
7403
7404 *'winminheight'* *'wmh'*
7405'winminheight' 'wmh' number (default 1)
7406 global
7407 {not in Vi}
7408 {not available when compiled without the +windows
7409 feature}
7410 The minimal height of a window, when it's not the current window.
7411 This is a hard minimum, windows will never become smaller.
7412 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7413 status bar) if necessary. They will return to at least one line when
7414 they become active (since the cursor has to have somewhere to go.)
7415 Use 'winheight' to set the minimal height of the current window.
7416 This option is only checked when making a window smaller. Don't use a
7417 large number, it will cause errors when opening more than a few
7418 windows. A value of 0 to 3 is reasonable.
7419
7420 *'winminwidth'* *'wmw'*
7421'winminwidth' 'wmw' number (default 1)
7422 global
7423 {not in Vi}
7424 {not available when compiled without the +vertsplit
7425 feature}
7426 The minimal width of a window, when it's not the current window.
7427 This is a hard minimum, windows will never become smaller.
7428 When set to zero, windows may be "squashed" to zero columns (i.e. just
7429 a vertical separator) if necessary. They will return to at least one
7430 line when they become active (since the cursor has to have somewhere
7431 to go.)
7432 Use 'winwidth' to set the minimal width of the current window.
7433 This option is only checked when making a window smaller. Don't use a
7434 large number, it will cause errors when opening more than a few
7435 windows. A value of 0 to 12 is reasonable.
7436
7437 *'winwidth'* *'wiw'* *E592*
7438'winwidth' 'wiw' number (default 20)
7439 global
7440 {not in Vi}
7441 {not available when compiled without the +vertsplit
7442 feature}
7443 Minimal number of columns for the current window. This is not a hard
7444 minimum, Vim will use fewer columns if there is not enough room. If
7445 the current window is smaller, its size is increased, at the cost of
7446 the width of other windows. Set it to 999 to make the current window
7447 always fill the screen. Set it to a small number for normal editing.
7448 The width is not adjusted after one of the commands to change the
7449 width of the current window.
7450 'winwidth' applies to the current window. Use 'winminwidth' to set
7451 the minimal width for other windows.
7452
7453 *'wrap'* *'nowrap'*
7454'wrap' boolean (default on)
7455 local to window
7456 {not in Vi}
7457 This option changes how text is displayed. It doesn't change the text
7458 in the buffer, see 'textwidth' for that.
7459 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007460 displaying continues on the next line. When off lines will not wrap
7461 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007462 moved to a part that is not shown, the screen will scroll
7463 horizontally.
7464 The line will be broken in the middle of a word if necessary. See
7465 'linebreak' to get the break at a word boundary.
7466 To make scrolling horizontally a bit more useful, try this: >
7467 :set sidescroll=5
7468 :set listchars+=precedes:<,extends:>
7469< See 'sidescroll', 'listchars' and |wrap-off|.
7470
7471 *'wrapmargin'* *'wm'*
7472'wrapmargin' 'wm' number (default 0)
7473 local to buffer
7474 Number of characters from the right window border where wrapping
7475 starts. When typing text beyond this limit, an <EOL> will be inserted
7476 and inserting continues on the next line.
7477 Options that add a margin, such as 'number' and 'foldcolumn', cause
7478 the text width to be further reduced. This is Vi compatible.
7479 When 'textwidth' is non-zero, this option is not used.
7480 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7481 and less usefully}
7482
7483 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7484'wrapscan' 'ws' boolean (default on) *E384* *E385*
7485 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00007486 Searches wrap around the end of the file. Also applies to |]s| and
7487 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007488
7489 *'write'* *'nowrite'*
7490'write' boolean (default on)
7491 global
7492 {not in Vi}
7493 Allows writing files. When not set, writing a file is not allowed.
7494 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007495 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007496 argument. Filtering text is still possible, even though this requires
7497 writing a temporary file.
7498
7499 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
7500'writeany' 'wa' boolean (default off)
7501 global
7502 Allows writing to any file with no need for "!" override.
7503
7504 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
7505'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
7506 otherwise)
7507 global
7508 {not in Vi}
7509 Make a backup before overwriting a file. The backup is removed after
7510 the file was successfully written, unless the 'backup' option is
7511 also on. Reset this option if your file system is almost full. See
7512 |backup-table| for another explanation.
7513 When the 'backupskip' pattern matches, a backup is not made anyway.
7514 NOTE: This option is set to the default value when 'compatible' is
7515 set.
7516
7517 *'writedelay'* *'wd'*
7518'writedelay' 'wd' number (default 0)
7519 global
7520 {not in Vi}
7521 The number of microseconds to wait for each character sent to the
7522 screen. When non-zero, characters are sent to the terminal one by
7523 one. For MS-DOS pcterm this does not work. For debugging purposes.
7524
7525 vim:tw=78:ts=8:ft=help:norl: