blob: 53411ad49ccd7a6cdb2b367b21f7246f65bf8694 [file] [log] [blame]
Bram Moolenaar238a5642006-02-21 22:12:05 +00001*options.txt* For Vim version 7.0aa. Last change: 2006 Feb 21
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")
1053<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001054 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1055'binary' 'bin' boolean (default off)
1056 local to buffer
1057 {not in Vi}
1058 This option should be set before editing a binary file. You can also
1059 use the |-b| Vim argument. When this option is switched on a few
1060 options will be changed (also when it already was on):
1061 'textwidth' will be set to 0
1062 'wrapmargin' will be set to 0
1063 'modeline' will be off
1064 'expandtab' will be off
1065 Also, 'fileformat' and 'fileformats' options will not be used, the
1066 file is read and written like 'fileformat' was "unix" (a single <NL>
1067 separates lines).
1068 The 'fileencoding' and 'fileencodings' options will not be used, the
1069 file is read without conversion.
1070 NOTE: When you start editing a(nother) file while the 'bin' option is
1071 on, settings from autocommands may change the settings again (e.g.,
1072 'textwidth'), causing trouble when editing. You might want to set
1073 'bin' again when the file has been loaded.
1074 The previous values of these options are remembered and restored when
1075 'bin' is switched from on to off. Each buffer has its own set of
1076 saved option values.
1077 To edit a file with 'binary' set you can use the |++bin| argument.
1078 This avoids you have to do ":set bin", which would have effect for all
1079 files you edit.
1080 When writing a file the <EOL> for the last line is only written if
1081 there was one in the original file (normally Vim appends an <EOL> to
1082 the last line if there is none; this would make the file longer). See
1083 the 'endofline' option.
1084
1085 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1086'bioskey' 'biosk' boolean (default on)
1087 global
1088 {not in Vi} {only for MS-DOS}
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001089 When on the BIOS is called to obtain a keyboard character. This works
Bram Moolenaar071d4272004-06-13 20:20:40 +00001090 better to detect CTRL-C, but only works for the console. When using a
1091 terminal over a serial port reset this option.
1092 Also see |'conskey'|.
1093
1094 *'bomb'* *'nobomb'*
1095'bomb' boolean (default off)
1096 local to buffer
1097 {not in Vi}
1098 {only available when compiled with the |+multi_byte|
1099 feature}
1100 When writing a file and the following conditions are met, a BOM (Byte
1101 Order Mark) is prepended to the file:
1102 - this option is on
1103 - the 'binary' option is off
1104 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1105 endian variants.
1106 Some applications use the BOM to recognize the encoding of the file.
1107 Often used for UCS-2 files on MS-Windows. For other applications it
1108 causes trouble, for example: "cat file1 file2" makes the BOM of file2
1109 appear halfway the resulting file.
1110 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1111 check for the presence of the BOM is done and 'bomb' set accordingly.
1112 Unless 'binary' is set, it is removed from the first line, so that you
1113 don't see it when editing. When you don't change the options, the BOM
1114 will be restored when writing the file.
1115
1116 *'breakat'* *'brk'*
1117'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1118 global
1119 {not in Vi}
1120 {not available when compiled without the |+linebreak|
1121 feature}
1122 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001123 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1124 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001125
1126 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001127'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001128 global
1129 {not in Vi} {only for Motif and Win32 GUI}
1130 Which directory to use for the file browser:
1131 last Use same directory as with last file browser.
1132 buffer Use the directory of the related buffer.
1133 current Use the current directory.
1134 {path} Use the specified directory
1135
1136 *'bufhidden'* *'bh'*
1137'bufhidden' 'bh' string (default: "")
1138 local to buffer
1139 {not in Vi}
1140 {not available when compiled without the |+quickfix|
1141 feature}
1142 This option specifies what happens when a buffer is no longer
1143 displayed in a window:
1144 <empty> follow the global 'hidden' option
1145 hide hide the buffer (don't unload it), also when 'hidden'
1146 is not set
1147 unload unload the buffer, also when 'hidden' is set or using
1148 |:hide|
1149 delete delete the buffer from the buffer list, also when
1150 'hidden' is set or using |:hide|, like using
1151 |:bdelete|
1152 wipe wipe out the buffer from the buffer list, also when
1153 'hidden' is set or using |:hide|, like using
1154 |:bwipeout|
1155
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001156 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
1157 are lost without a warning.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001158 This option is used together with 'buftype' and 'swapfile' to specify
1159 special kinds of buffers. See |special-buffers|.
1160
1161 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1162'buflisted' 'bl' boolean (default: on)
1163 local to buffer
1164 {not in Vi}
1165 When this option is set, the buffer shows up in the buffer list. If
1166 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1167 This option is reset by Vim for buffers that are only used to remember
1168 a file name or marks. Vim sets it when starting to edit a buffer.
1169 But not when moving to a buffer with ":buffer".
1170
1171 *'buftype'* *'bt'* *E382*
1172'buftype' 'bt' string (default: "")
1173 local to buffer
1174 {not in Vi}
1175 {not available when compiled without the |+quickfix|
1176 feature}
1177 The value of this option specifies the type of a buffer:
1178 <empty> normal buffer
1179 nofile buffer which is not related to a file and will not be
1180 written
1181 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001182 acwrite buffer which will always be written with BufWriteCmd
1183 autocommands. {not available when compiled without the
1184 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001185 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001186 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001187 help help buffer (you are not supposed to set this
1188 manually)
1189
1190 This option is used together with 'bufhidden' and 'swapfile' to
1191 specify special kinds of buffers. See |special-buffers|.
1192
1193 Be careful with changing this option, it can have many side effects!
1194
Bram Moolenaar280f1262006-01-30 00:14:18 +00001195 A "quickfix" buffer is only used for the error list and the location
1196 list. This value is set by the |:cwindow| and |:lwindow| commands and
1197 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001198
1199 "nofile" and "nowrite" buffers are similar:
1200 both: The buffer is not to be written to disk, ":w" doesn't
1201 work (":w filename" does work though).
1202 both: The buffer is never considered to be |'modified'|.
1203 There is no warning when the changes will be lost, for
1204 example when you quit Vim.
1205 both: A swap file is only created when using too much memory
1206 (when 'swapfile' has been reset there is never a swap
1207 file).
1208 nofile only: The buffer name is fixed, it is not handled like a
1209 file name. It is not modified in response to a |:cd|
1210 command.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001211 *E676*
1212 "acwrite" implies that the buffer name is not related to a file, like
1213 "nofile", but it will be written. Thus, in contrast to "nofile" and
1214 "nowrite", ":w" does work and a modified buffer can't be abandoned
1215 without saving. For writing there must be matching |BufWriteCmd|,
1216 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001217
1218 *'casemap'* *'cmp'*
1219'casemap' 'cmp' string (default: "internal,keepascii")
1220 global
1221 {not in Vi}
1222 Specifies details about changing the case of letters. It may contain
1223 these words, separated by a comma:
1224 internal Use internal case mapping functions, the current
1225 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001226 matters when 'encoding' is a Unicode encoding,
1227 "latin1" or "iso-8859-15". When "internal" is
1228 omitted, the towupper() and towlower() system library
1229 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001230 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1231 case mapping, the current locale is not effective.
1232 This probably only matters for Turkish.
1233
1234 *'cdpath'* *'cd'* *E344* *E346*
1235'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1236 global
1237 {not in Vi}
1238 {not available when compiled without the
1239 |+file_in_path| feature}
1240 This is a list of directories which will be searched when using the
1241 |:cd| and |:lcd| commands, provided that the directory being searched
1242 for has a relative path (not starting with "/", "./" or "../").
1243 The 'cdpath' option's value has the same form and semantics as
1244 |'path'|. Also see |file-searching|.
1245 The default value is taken from $CDPATH, with a "," prepended to look
1246 in the current directory first.
1247 If the default value taken from $CDPATH is not what you want, include
1248 a modified version of the following command in your vimrc file to
1249 override it: >
1250 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1251< This option cannot be set from a |modeline| or in the |sandbox|, for
1252 security reasons.
1253 (parts of 'cdpath' can be passed to the shell to expand file names).
1254
1255 *'cedit'*
1256'cedit' string (Vi default: "", Vim default: CTRL-F)
1257 global
1258 {not in Vi}
1259 {not available when compiled without the |+vertsplit|
1260 feature}
1261 The key used in Command-line Mode to open the command-line window.
1262 The default is CTRL-F when 'compatible' is off.
1263 Only non-printable keys are allowed.
1264 The key can be specified as a single character, but it is difficult to
1265 type. The preferred way is to use the <> notation. Examples: >
1266 :set cedit=<C-Y>
1267 :set cedit=<Esc>
1268< |Nvi| also has this option, but it only uses the first character.
1269 See |cmdwin|.
1270
1271 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1272'charconvert' 'ccv' string (default "")
1273 global
1274 {only available when compiled with the |+multi_byte|
1275 feature and the |+eval| feature}
1276 {not in Vi}
1277 An expression that is used for character encoding conversion. It is
1278 evaluated when a file that is to be read or has been written has a
1279 different encoding from what is desired.
1280 'charconvert' is not used when the internal iconv() function is
1281 supported and is able to do the conversion. Using iconv() is
1282 preferred, because it is much faster.
1283 'charconvert' is not used when reading stdin |--|, because there is no
1284 file to convert from. You will have to save the text in a file first.
1285 The expression must return zero or an empty string for success,
1286 non-zero for failure.
1287 The possible encoding names encountered are in 'encoding'.
1288 Additionally, names given in 'fileencodings' and 'fileencoding' are
1289 used.
1290 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1291 is done internally by Vim, 'charconvert' is not used for this.
1292 'charconvert' is also used to convert the viminfo file, if the 'c'
1293 flag is present in 'viminfo'. Also used for Unicode conversion.
1294 Example: >
1295 set charconvert=CharConvert()
1296 fun CharConvert()
1297 system("recode "
1298 \ . v:charconvert_from . ".." . v:charconvert_to
1299 \ . " <" . v:fname_in . " >" v:fname_out)
1300 return v:shell_error
1301 endfun
1302< The related Vim variables are:
1303 v:charconvert_from name of the current encoding
1304 v:charconvert_to name of the desired encoding
1305 v:fname_in name of the input file
1306 v:fname_out name of the output file
1307 Note that v:fname_in and v:fname_out will never be the same.
1308 Note that v:charconvert_from and v:charconvert_to may be different
1309 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1310 Encryption is not done by Vim when using 'charconvert'. If you want
1311 to encrypt the file after conversion, 'charconvert' should take care
1312 of this.
1313 This option cannot be set from a |modeline| or in the |sandbox|, for
1314 security reasons.
1315
1316 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1317'cindent' 'cin' boolean (default off)
1318 local to buffer
1319 {not in Vi}
1320 {not available when compiled without the |+cindent|
1321 feature}
1322 Enables automatic C program indenting See 'cinkeys' to set the keys
1323 that trigger reindenting in insert mode and 'cinoptions' to set your
1324 preferred indent style.
1325 If 'indentexpr' is not empty, it overrules 'cindent'.
1326 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1327 the "=" operator indents using this algorithm rather than calling an
1328 external program.
1329 See |C-indenting|.
1330 When you don't like the way 'cindent' works, try the 'smartindent'
1331 option or 'indentexpr'.
1332 This option is not used when 'paste' is set.
1333 NOTE: This option is reset when 'compatible' is set.
1334
1335 *'cinkeys'* *'cink'*
1336'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1337 local to buffer
1338 {not in Vi}
1339 {not available when compiled without the |+cindent|
1340 feature}
1341 A list of keys that, when typed in Insert mode, cause reindenting of
1342 the current line. Only used if 'cindent' is on and 'indentexpr' is
1343 empty.
1344 For the format of this option see |cinkeys-format|.
1345 See |C-indenting|.
1346
1347 *'cinoptions'* *'cino'*
1348'cinoptions' 'cino' string (default "")
1349 local to buffer
1350 {not in Vi}
1351 {not available when compiled without the |+cindent|
1352 feature}
1353 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1354 program. See |cinoptions-values| for the values of this option, and
1355 |C-indenting| for info on C indenting in general.
1356
1357
1358 *'cinwords'* *'cinw'*
1359'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1360 local to buffer
1361 {not in Vi}
1362 {not available when compiled without both the
1363 |+cindent| and the |+smartindent| features}
1364 These keywords start an extra indent in the next line when
1365 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1366 an appropriate place (inside {}).
1367 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1368 matter, include the keyword both the uppercase and lowercase:
1369 "if,If,IF".
1370
1371 *'clipboard'* *'cb'*
1372'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1373 for X-windows, "" otherwise)
1374 global
1375 {not in Vi}
1376 {only in GUI versions or when the |+xterm_clipboard|
1377 feature is included}
1378 This option is a list of comma separated names.
1379 These names are recognized:
1380
1381 unnamed When included, Vim will use the clipboard register '*'
1382 for all yank, delete, change and put operations which
1383 would normally go to the unnamed register. When a
1384 register is explicitly specified, it will always be
1385 used regardless of whether "unnamed" is in 'clipboard'
1386 or not. The clipboard register can always be
1387 explicitly accessed using the "* notation. Also see
1388 |gui-clipboard|.
1389
1390 autoselect Works like the 'a' flag in 'guioptions': If present,
1391 then whenever Visual mode is started, or the Visual
1392 area extended, Vim tries to become the owner of the
1393 windowing system's global selection or put the
1394 selected text on the clipboard used by the selection
1395 register "*. See |guioptions_a| and |quotestar| for
1396 details. When the GUI is active, the 'a' flag in
1397 'guioptions' is used, when the GUI is not active, this
1398 "autoselect" flag is used.
1399 Also applies to the modeless selection.
1400
1401 autoselectml Like "autoselect", but for the modeless selection
1402 only. Compare to the 'A' flag in 'guioptions'.
1403
1404 exclude:{pattern}
1405 Defines a pattern that is matched against the name of
1406 the terminal 'term'. If there is a match, no
1407 connection will be made to the X server. This is
1408 useful in this situation:
1409 - Running Vim in a console.
1410 - $DISPLAY is set to start applications on another
1411 display.
1412 - You do not want to connect to the X server in the
1413 console, but do want this in a terminal emulator.
1414 To never connect to the X server use: >
1415 exclude:.*
1416< This has the same effect as using the |-X| argument.
1417 Note that when there is no connection to the X server
1418 the window title won't be restored and the clipboard
1419 cannot be accessed.
1420 The value of 'magic' is ignored, {pattern} is
1421 interpreted as if 'magic' was on.
1422 The rest of the option value will be used for
1423 {pattern}, this must be the last entry.
1424
1425 *'cmdheight'* *'ch'*
1426'cmdheight' 'ch' number (default 1)
1427 global
1428 {not in Vi}
1429 Number of screen lines to use for the command-line. Helps avoiding
1430 |hit-enter| prompts.
1431
1432 *'cmdwinheight'* *'cwh'*
1433'cmdwinheight' 'cwh' number (default 7)
1434 global
1435 {not in Vi}
1436 {not available when compiled without the |+vertsplit|
1437 feature}
1438 Number of screen lines to use for the command-line window. |cmdwin|
1439
1440 *'columns'* *'co'* *E594*
1441'columns' 'co' number (default 80 or terminal width)
1442 global
1443 {not in Vi}
1444 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001445 initialization and does not have to be set by hand. Also see
1446 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001447 When Vim is running in the GUI or in a resizable window, setting this
1448 option will cause the window size to be changed. When you only want
1449 to use the size for the GUI, put the command in your |gvimrc| file.
1450 When you set this option and Vim is unable to change the physical
1451 number of columns of the display, the display may be messed up.
Bram Moolenaarf4d11452005-12-02 00:46:37 +00001452 Mimimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001453
1454 *'comments'* *'com'* *E524* *E525*
1455'comments' 'com' string (default
1456 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1457 local to buffer
1458 {not in Vi}
1459 {not available when compiled without the |+comments|
1460 feature}
1461 A comma separated list of strings that can start a comment line. See
1462 |format-comments|. See |option-backslash| about using backslashes to
1463 insert a space.
1464
1465 *'commentstring'* *'cms'* *E537*
1466'commentstring' 'cms' string (default "/*%s*/")
1467 local to buffer
1468 {not in Vi}
1469 {not available when compiled without the |+folding|
1470 feature}
1471 A template for a comment. The "%s" in the value is replaced with the
1472 comment text. Currently only used to add markers for folding, see
1473 |fold-marker|.
1474
1475 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaard042c562005-06-30 22:04:15 +00001476'compatible' 'cp' boolean (default on, off when a .vimrc or .gvimrc file
1477 is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001478 global
1479 {not in Vi}
1480 This option has the effect of making Vim either more Vi-compatible, or
1481 make Vim behave in a more useful way.
1482 This is a special kind of option, because when it's set or reset,
1483 other options are also changed as a side effect. CAREFUL: Setting or
1484 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001485 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001486 set this option in your vimrc file, you should probably put it at the
1487 very start.
1488 By default this option is on and the Vi defaults are used for the
1489 options. This default was chosen for those people who want to use Vim
1490 just like Vi, and don't even (want to) know about the 'compatible'
1491 option.
Bram Moolenaard042c562005-06-30 22:04:15 +00001492 When a ".vimrc" or ".gvimrc" file is found while Vim is starting up,
1493 this option is switched off, and all options that have not been
1494 modified will be set to the Vim defaults. Effectively, this means
1495 that when a ".vimrc" or ".gvimrc" file exists, Vim will use the Vim
1496 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
1497 happen for the system-wide vimrc or gvimrc file). Also see
1498 |compatible-default| and |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001499 You can also set this option with the "-C" argument, and reset it with
1500 "-N". See |-C| and |-N|.
1501 Switching this option off makes the Vim defaults be used for options
1502 that have a different Vi and Vim default value. See the options
1503 marked with a '+' below. Other options are not modified.
1504 At the moment this option is set, several other options will be set
1505 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001506 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001507 editing.
1508 See also 'cpoptions'.
1509
1510 option + set value effect ~
1511
1512 'allowrevins' off no CTRL-_ command
1513 'backupcopy' Unix: "yes" backup file is a copy
1514 others: "auto" copy or rename backup file
1515 'backspace' "" normal backspace
1516 'backup' off no backup file
1517 'cindent' off no C code indentation
1518 'cedit' + "" no key to open the |cmdwin|
1519 'cpoptions' + (all flags) Vi-compatible flags
1520 'cscopetag' off don't use cscope for ":tag"
1521 'cscopetagorder' 0 see |cscopetagorder|
1522 'cscopeverbose' off see |cscopeverbose|
1523 'digraph' off no digraphs
1524 'esckeys' + off no <Esc>-keys in Insert mode
1525 'expandtab' off tabs not expanded to spaces
1526 'fileformats' + "" no automatic file format detection,
1527 "dos,unix" except for DOS, Windows and OS/2
1528 'formatoptions' + "vt" Vi compatible formatting
1529 'gdefault' off no default 'g' flag for ":s"
1530 'history' + 0 no commandline history
1531 'hkmap' off no Hebrew keyboard mapping
1532 'hkmapp' off no phonetic Hebrew keyboard mapping
1533 'hlsearch' off no highlighting of search matches
1534 'incsearch' off no incremental searching
1535 'indentexpr' "" no indenting by expression
1536 'insertmode' off do not start in Insert mode
1537 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1538 characters and '_'
1539 'joinspaces' on insert 2 spaces after period
1540 'modeline' + off no modelines
1541 'more' + off no pauses in listings
1542 'revins' off no reverse insert
1543 'ruler' off no ruler
1544 'scrolljump' 1 no jump scroll
1545 'scrolloff' 0 no scroll offset
1546 'shiftround' off indent not rounded to shiftwidth
1547 'shortmess' + "" no shortening of messages
1548 'showcmd' + off command characters not shown
1549 'showmode' + off current mode not shown
1550 'smartcase' off no automatic ignore case switch
1551 'smartindent' off no smart indentation
1552 'smarttab' off no smart tab size
1553 'softtabstop' 0 tabs are always 'tabstop' positions
1554 'startofline' on goto startofline with some commands
1555 'tagrelative' + off tag file names are not relative
1556 'textauto' + off no automatic textmode detection
1557 'textwidth' 0 no automatic line wrap
1558 'tildeop' off tilde is not an operator
1559 'ttimeout' off no terminal timeout
1560 'whichwrap' + "" left-right movements don't wrap
1561 'wildchar' + CTRL-E only when the current value is <Tab>
1562 use CTRL-E for cmdline completion
1563 'writebackup' on or off depends on +writebackup feature
1564
1565 *'complete'* *'cpt'* *E535*
1566'complete' 'cpt' string (default: ".,w,b,u,t,i")
1567 local to buffer
1568 {not in Vi}
1569 This option specifies how keyword completion |ins-completion| works
1570 when CTRL-P or CTRL-N are used. It is also used for whole-line
1571 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1572 and the places to scan. It is a comma separated list of flags:
1573 . scan the current buffer ('wrapscan' is ignored)
1574 w scan buffers from other windows
1575 b scan other loaded buffers that are in the buffer list
1576 u scan the unloaded buffers that are in the buffer list
1577 U scan the buffers that are not in the buffer list
1578 k scan the files given with the 'dictionary' option
1579 k{dict} scan the file {dict}. Several "k" flags can be given,
1580 patterns are valid too. For example: >
1581 :set cpt=k/usr/dict/*,k~/spanish
1582< s scan the files given with the 'thesaurus' option
1583 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1584 are valid too.
1585 i scan current and included files
1586 d scan current and included files for defined name or macro
1587 |i_CTRL-X_CTRL-D|
1588 ] tag completion
1589 t same as "]"
1590
1591 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1592 not executed, this may lead to unexpected completions from some files
1593 (gzipped files for example). Unloaded buffers are not scanned for
1594 whole-line completion.
1595
1596 The default is ".,w,b,u,t,i", which means to scan:
1597 1. the current buffer
1598 2. buffers in other windows
1599 3. other loaded buffers
1600 4. unloaded buffers
1601 5. tags
1602 6. included files
1603
1604 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001605 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1606 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001607
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001608 *'completefunc'* *'cfu'*
1609'completefunc' 'cfu' string (default: empty)
1610 local to buffer
1611 {not in Vi}
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001612 {not available when compiled without the +eval
1613 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001614 This option specifies a function to be used for Insert mode completion
1615 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001616 See |complete-functions| for an explanation of how the function is
1617 invoked and what it should return.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001618
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001619
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001620 *'completeopt'* *'cot'*
1621'completeopt' 'cot' string (default: "menu")
1622 global
1623 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001624 A comma separated list of options for Insert mode completion
1625 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001626
1627 menu Use a popup menu to show the possible completions. The
1628 menu is only shown when there is more than one match and
1629 sufficient colors are available. |ins-completion-menu|
1630
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001631 longest Only insert the longest common text of the matches. Use
1632 CTRL-L to add more characters.
1633
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001634
Bram Moolenaar071d4272004-06-13 20:20:40 +00001635 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1636'confirm' 'cf' boolean (default off)
1637 global
1638 {not in Vi}
1639 When 'confirm' is on, certain operations that would normally
1640 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1641 instead raise a |dialog| asking if you wish to save the current
1642 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1643 If 'confirm' is off you can still activate confirmation for one
1644 command only (this is most useful in mappings) with the |:confirm|
1645 command.
1646 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1647
1648 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1649'conskey' 'consk' boolean (default off)
1650 global
1651 {not in Vi} {only for MS-DOS}
1652 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001653 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001654 three methods of console input are available:
1655 'conskey' 'bioskey' action ~
1656 on on or off direct console input
1657 off on BIOS
1658 off off STDIN
1659
1660 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1661'copyindent' 'ci' boolean (default off)
1662 local to buffer
1663 {not in Vi}
1664 Copy the structure of the existing lines indent when autoindenting a
1665 new line. Normally the new indent is reconstructed by a series of
1666 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1667 in which case only spaces are used). Enabling this option makes the
1668 new line copy whatever characters were used for indenting on the
1669 existing line. If the new indent is greater than on the existing
1670 line, the remaining space is filled in the normal manner.
1671 NOTE: 'copyindent' is reset when 'compatible' is set.
1672 Also see 'preserveindent'.
1673
1674 *'cpoptions'* *'cpo'*
1675'cpoptions' 'cpo' string (Vim default: "aABceFs",
1676 Vi default: all flags)
1677 global
1678 {not in Vi}
1679 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001680 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001681 not being vi-compatible is mostly or sometimes preferred.
1682 'cpoptions' stands for "compatible-options".
1683 Commas can be added for readability.
1684 To avoid problems with flags that are added in the future, use the
1685 "+=" and "-=" feature of ":set" |add-option-flags|.
1686 NOTE: This option is set to the Vi default value when 'compatible' is
1687 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001688 NOTE: This option is set to the POSIX default value at startup when
1689 the Vi default value would be used and the $VIM_POSIX environment
1690 variable exists |posix|. This means tries to behave like the POSIX
1691 specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001692
1693 contains behavior ~
1694 *cpo-a*
1695 a When included, a ":read" command with a file name
1696 argument will set the alternate file name for the
1697 current window.
1698 *cpo-A*
1699 A When included, a ":write" command with a file name
1700 argument will set the alternate file name for the
1701 current window.
1702 *cpo-b*
1703 b "\|" in a ":map" command is recognized as the end of
1704 the map command. The '\' is included in the mapping,
1705 the text after the '|' is interpreted as the next
1706 command. Use a CTRL-V instead of a backslash to
1707 include the '|' in the mapping. Applies to all
1708 mapping, abbreviation, menu and autocmd commands.
1709 See also |map_bar|.
1710 *cpo-B*
1711 B A backslash has no special meaning in mappings,
1712 abbreviations and the "to" part of the menu commands.
1713 Remove this flag to be able to use a backslash like a
1714 CTRL-V. For example, the command ":map X \<Esc>"
1715 results in X being mapped to:
1716 'B' included: "\^[" (^[ is a real <Esc>)
1717 'B' excluded: "<Esc>" (5 characters)
1718 ('<' excluded in both cases)
1719 *cpo-c*
1720 c Searching continues at the end of any match at the
1721 cursor position, but not further than the start of the
1722 next line. When not present searching continues
1723 one character from the cursor position. With 'c'
1724 "abababababab" only gets three matches when repeating
1725 "/abab", without 'c' there are five matches.
1726 *cpo-C*
1727 C Do not concatenate sourced lines that start with a
1728 backslash. See |line-continuation|.
1729 *cpo-d*
1730 d Using "./" in the 'tags' option doesn't mean to use
1731 the tags file relative to the current file, but the
1732 tags file in the current directory.
1733 *cpo-D*
1734 D Can't use CTRL-K to enter a digraph after Normal mode
1735 commands with a character argument, like |r|, |f| and
1736 |t|.
1737 *cpo-e*
1738 e When executing a register with ":@r", always add a
1739 <CR> to the last line, also when the register is not
1740 linewise. If this flag is not present, the register
1741 is not linewise and the last line does not end in a
1742 <CR>, then the last line is put on the command-line
1743 and can be edited before hitting <CR>.
1744 *cpo-E*
1745 E It is an error when using "y", "d", "c", "g~", "gu" or
1746 "gU" on an Empty region. The operators only work when
1747 at least one character is to be operate on. Example:
1748 This makes "y0" fail in the first column.
1749 *cpo-f*
1750 f When included, a ":read" command with a file name
1751 argument will set the file name for the current buffer,
1752 if the current buffer doesn't have a file name yet.
1753 *cpo-F*
1754 F When included, a ":write" command with a file name
1755 argument will set the file name for the current
1756 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001757 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001758 *cpo-g*
1759 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001760 *cpo-H*
1761 H When using "I" on a line with only blanks, insert
1762 before the last blank. Without this flag insert after
1763 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001764 *cpo-i*
1765 i When included, interrupting the reading of a file will
1766 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001767 *cpo-I*
1768 I When moving the cursor up or down just after inserting
1769 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001770 *cpo-j*
1771 j When joining lines, only add two spaces after a '.',
1772 not after '!' or '?'. Also see 'joinspaces'.
1773 *cpo-J*
1774 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001775 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001776 white space.
1777 *cpo-k*
1778 k Disable the recognition of raw key codes in
1779 mappings, abbreviations, and the "to" part of menu
1780 commands. For example, if <Key> sends ^[OA (where ^[
1781 is <Esc>), the command ":map X ^[OA" results in X
1782 being mapped to:
1783 'k' included: "^[OA" (3 characters)
1784 'k' excluded: "<Key>" (one key code)
1785 Also see the '<' flag below.
1786 *cpo-K*
1787 K Don't wait for a key code to complete when it is
1788 halfway a mapping. This breaks mapping <F1><F1> when
1789 only part of the second <F1> has been read. It
1790 enables cancelling the mapping by typing <F1><Esc>.
1791 *cpo-l*
1792 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001793 literally, only "\]", "\^", "\-" and "\\" are special.
1794 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001795 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1796 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001797 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001798 *cpo-L*
1799 L When the 'list' option is set, 'wrapmargin',
1800 'textwidth', 'softtabstop' and Virtual Replace mode
1801 (see |gR|) count a <Tab> as two characters, instead of
1802 the normal behavior of a <Tab>.
1803 *cpo-m*
1804 m When included, a showmatch will always wait half a
1805 second. When not included, a showmatch will wait half
1806 a second or until a character is typed. |'showmatch'|
1807 *cpo-M*
1808 M When excluded, "%" matching will take backslashes into
1809 account. Thus in "( \( )" and "\( ( \)" the outer
1810 parenthesis match. When included "%" ignores
1811 backslashes, which is Vi compatible.
1812 *cpo-n*
1813 n When included, the column used for 'number' will also
1814 be used for text of wrapped lines.
1815 *cpo-o*
1816 o Line offset to search command is not remembered for
1817 next search.
1818 *cpo-O*
1819 O Don't complain if a file is being overwritten, even
1820 when it didn't exist when editing it. This is a
1821 protection against a file unexpectedly created by
1822 someone else. Vi didn't complain about this.
1823 *cpo-p*
1824 p Vi compatible Lisp indenting. When not present, a
1825 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00001826 *cpo-P*
1827 P When included, a ":write" command that appends to a
1828 file will set the file name for the current buffer, if
1829 the current buffer doesn't have a file name yet and
1830 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001831 *cpo-q*
1832 q When joining multiple lines leave the cursor at the
1833 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001834 *cpo-r*
1835 r Redo ("." command) uses "/" to repeat a search
1836 command, instead of the actually used search string.
1837 *cpo-R*
1838 R Remove marks from filtered lines. Without this flag
1839 marks are kept like |:keepmarks| was used.
1840 *cpo-s*
1841 s Set buffer options when entering the buffer for the
1842 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001843 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001844 set when the buffer is created.
1845 *cpo-S*
1846 S Set buffer options always when entering a buffer
1847 (except 'readonly', 'fileformat', 'filetype' and
1848 'syntax'). This is the (most) Vi compatible setting.
1849 The options are set to the values in the current
1850 buffer. When you change an option and go to another
1851 buffer, the value is copied. Effectively makes the
1852 buffer options global to all buffers.
1853
1854 's' 'S' copy buffer options
1855 no no when buffer created
1856 yes no when buffer first entered (default)
1857 X yes each time when buffer entered (vi comp.)
1858 *cpo-t*
1859 t Search pattern for the tag command is remembered for
1860 "n" command. Otherwise Vim only puts the pattern in
1861 the history for search pattern, but doesn't change the
1862 last used search pattern.
1863 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001864 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001865 *cpo-v*
1866 v Backspaced characters remain visible on the screen in
1867 Insert mode. Without this flag the characters are
1868 erased from the screen right away. With this flag the
1869 screen newly typed text overwrites backspaced
1870 characters.
1871 *cpo-w*
1872 w When using "cw" on a blank character, only change one
1873 character and not all blanks until the start of the
1874 next word.
1875 *cpo-W*
1876 W Don't overwrite a readonly file. When omitted, ":w!"
1877 overwrites a readonly file, if possible.
1878 *cpo-x*
1879 x <Esc> on the command-line executes the command-line.
1880 The default in Vim is to abandon the command-line,
1881 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001882 *cpo-X*
1883 X When using a count with "R" the replaced text is
1884 deleted only once. Also when repeating "R" with "."
1885 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001886 *cpo-y*
1887 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001888 *cpo-Z*
1889 Z When using "w!" while the 'readonly' option is set,
1890 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001891 *cpo-!*
1892 ! When redoing a filter command, use the last used
1893 external command, whatever it was. Otherwise the last
1894 used -filter- command is used.
1895 *cpo-$*
1896 $ When making a change to one line, don't redisplay the
1897 line, but put a '$' at the end of the changed text.
1898 The changed text will be overwritten when you type the
1899 new text. The line is redisplayed if you type any
1900 command that moves the cursor from the insertion
1901 point.
1902 *cpo-%*
1903 % Vi-compatible matching is done for the "%" command.
1904 Does not recognize "#if", "#endif", etc.
1905 Does not recognize "/*" and "*/".
1906 Parens inside single and double quotes are also
1907 counted, causing a string that contains a paren to
1908 disturb the matching. For example, in a line like
1909 "if (strcmp("foo(", s))" the first paren does not
1910 match the last one. When this flag is not included,
1911 parens inside single and double quotes are treated
1912 specially. When matching a paren outside of quotes,
1913 everything inside quotes is ignored. When matching a
1914 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001915 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001916 This flag is also used for other features, such as
1917 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001918 *cpo--*
1919 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001920 it would go above the first line or below the last
1921 line. Without it the cursor moves to the first or
1922 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001923 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001924 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001925 *cpo-+*
1926 + When included, a ":write file" command will reset the
1927 'modified' flag of the buffer, even though the buffer
1928 itself may still be different from its file.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001929 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001930 * Use ":*" in the same way as ":@". When not included,
1931 ":*" is an alias for ":'<,'>", select the Visual area.
1932 *cpo-<*
1933 < Disable the recognition of special key codes in |<>|
1934 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001935 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00001936 ":map X <Tab>" results in X being mapped to:
1937 '<' included: "<Tab>" (5 characters)
1938 '<' excluded: "^I" (^I is a real <Tab>)
1939 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001940 *cpo->*
1941 > When appending to a register, put a line break before
1942 the appended text.
1943
1944 POSIX flags. These are not included in the Vi default value, except
1945 when $VIM_POSIX was set on startup. |posix|
1946
1947 contains behavior ~
1948 *cpo-#*
1949 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001950 *cpo-&*
1951 & When ":preserve" was used keep the swap file when
1952 exiting normally while this buffer is still loaded.
1953 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001954 *cpo-\*
1955 \ Backslash in a [] range in a search pattern is taken
1956 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00001957 '\' included: "/[ \-]" finds <Space>, '\' and '-'
1958 '\' excluded: "/[ \-]" finds <Space> and '-'
1959 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001960 *cpo-/*
1961 / When "%" is used as the replacement string in a |:s|
1962 command, use the previous replacement string. |:s%|
1963 *cpo-{*
1964 { The |{| and |}| commands also stop at a "{" character
1965 at the start of a line.
1966 *cpo-.*
1967 . The ":chdir" and ":cd" commands fail if the current
1968 buffer is modified, unless ! is used. Vim doesn't
1969 need this, since it remembers the full path of an
1970 opened file.
1971 *cpo-bar*
1972 | The value of the $LINES and $COLUMNS environment
1973 variables overrule the terminal size values obtained
1974 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001975
Bram Moolenaar071d4272004-06-13 20:20:40 +00001976
1977 *'cscopepathcomp'* *'cspc'*
1978'cscopepathcomp' 'cspc' number (default 0)
1979 global
1980 {not available when compiled without the |+cscope|
1981 feature}
1982 {not in Vi}
1983 Determines how many components of the path to show in a list of tags.
1984 See |cscopepathcomp|.
1985
1986 *'cscopeprg'* *'csprg'*
1987'cscopeprg' 'csprg' string (default "cscope")
1988 global
1989 {not available when compiled without the |+cscope|
1990 feature}
1991 {not in Vi}
1992 Specifies the command to execute cscope. See |cscopeprg|.
1993 This option cannot be set from a |modeline| or in the |sandbox|, for
1994 security reasons.
1995
1996 *'cscopequickfix'* *'csqf'*
1997'cscopequickfix' 'csqf' string (default "")
1998 global
1999 {not available when compiled without the |+cscope|
2000 or |+quickfix| features}
2001 {not in Vi}
2002 Specifies whether to use quickfix window to show cscope results.
2003 See |cscopequickfix|.
2004
2005 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2006'cscopetag' 'cst' boolean (default off)
2007 global
2008 {not available when compiled without the |+cscope|
2009 feature}
2010 {not in Vi}
2011 Use cscope for tag commands. See |cscope-options|.
2012 NOTE: This option is reset when 'compatible' is set.
2013
2014 *'cscopetagorder'* *'csto'*
2015'cscopetagorder' 'csto' number (default 0)
2016 global
2017 {not available when compiled without the |+cscope|
2018 feature}
2019 {not in Vi}
2020 Determines the order in which ":cstag" performs a search. See
2021 |cscopetagorder|.
2022 NOTE: This option is set to 0 when 'compatible' is set.
2023
2024 *'cscopeverbose'* *'csverb'*
2025 *'nocscopeverbose'* *'nocsverb'*
2026'cscopeverbose' 'csverb' boolean (default off)
2027 global
2028 {not available when compiled without the |+cscope|
2029 feature}
2030 {not in Vi}
2031 Give messages when adding a cscope database. See |cscopeverbose|.
2032 NOTE: This option is reset when 'compatible' is set.
2033
2034 *'debug'*
2035'debug' string (default "")
2036 global
2037 {not in Vi}
2038 When set to "msg", error messages that would otherwise be omitted will
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002039 be given anyway. This is useful when debugging 'foldexpr',
2040 'formatexpr' or 'indentexpr'.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002041 When set to "beep", a message will be given when otherwise only a beep
2042 would be produced.
2043 The values can be combined, separated by a comma.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002044
2045 *'define'* *'def'*
2046'define' 'def' string (default "^\s*#\s*define")
2047 global or local to buffer |global-local|
2048 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002049 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002050 pattern, just like for the "/" command. This option is used for the
2051 commands like "[i" and "[d" |include-search|. The 'isident' option is
2052 used to recognize the defined name after the match:
2053 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2054 See |option-backslash| about inserting backslashes to include a space
2055 or backslash.
2056 The default value is for C programs. For C++ this value would be
2057 useful, to include const type declarations: >
2058 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2059< When using the ":set" command, you need to double the backslashes!
2060
2061 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2062'delcombine' 'deco' boolean (default off)
2063 global
2064 {not in Vi}
2065 {only available when compiled with the |+multi_byte|
2066 feature}
2067 If editing Unicode and this option is set, backspace and Normal mode
2068 "x" delete each combining character on its own. When it is off (the
2069 default) the character along with its combining characters are
2070 deleted.
2071 Note: When 'delcombine' is set "xx" may work different from "2x"!
2072
2073 This is useful for Arabic, Hebrew and many other languages where one
2074 may have combining characters overtop of base characters, and want
2075 to remove only the combining ones.
2076
2077 *'dictionary'* *'dict'*
2078'dictionary' 'dict' string (default "")
2079 global or local to buffer |global-local|
2080 {not in Vi}
2081 List of file names, separated by commas, that are used to lookup words
2082 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2083 contain a list of words. This can be one word per line, or several
2084 words per line, separated by non-keyword characters (white space is
2085 preferred). Maximum line length is 510 bytes.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002086 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002087 after a comma are ignored, otherwise spaces are included in the file
2088 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002089 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002090 Where to find a list of words?
2091 - On FreeBSD, there is the file "/usr/share/dict/words".
2092 - In the Simtel archive, look in the "msdos/linguist" directory.
2093 - In "miscfiles" of the GNU collection.
2094 The use of |:set+=| and |:set-=| is preferred when adding or removing
2095 directories from the list. This avoids problems when a future version
2096 uses another default.
2097 Backticks cannot be used in this option for security reasons.
2098
2099 *'diff'* *'nodiff'*
2100'diff' boolean (default off)
2101 local to window
2102 {not in Vi}
2103 {not available when compiled without the |+diff|
2104 feature}
2105 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002106 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002107
2108 *'dex'* *'diffexpr'*
2109'diffexpr' 'dex' string (default "")
2110 global
2111 {not in Vi}
2112 {not available when compiled without the |+diff|
2113 feature}
2114 Expression which is evaluated to obtain an ed-style diff file from two
2115 versions of a file. See |diff-diffexpr|.
2116 This option cannot be set from a |modeline| or in the |sandbox|, for
2117 security reasons.
2118
2119 *'dip'* *'diffopt'*
2120'diffopt' 'dip' string (default "filler")
2121 global
2122 {not in Vi}
2123 {not available when compiled without the |+diff|
2124 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002125 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002126 All are optional. Items must be separated by a comma.
2127
2128 filler Show filler lines, to keep the text
2129 synchronized with a window that has inserted
2130 lines at the same position. Mostly useful
2131 when windows are side-by-side and 'scrollbind'
2132 is set.
2133
2134 context:{n} Use a context of {n} lines between a change
2135 and a fold that contains unchanged lines.
2136 When omitted a context of six lines is used.
2137 See |fold-diff|.
2138
2139 icase Ignore changes in case of text. "a" and "A"
2140 are considered the same. Adds the "-i" flag
2141 to the "diff" command if 'diffexpr' is empty.
2142
2143 iwhite Ignore changes in amount of white space. Adds
2144 the "-b" flag to the "diff" command if
2145 'diffexpr' is empty. Check the documentation
2146 of the "diff" command for what this does
2147 exactly. It should ignore adding trailing
2148 white space, but not leading white space.
2149
2150 Examples: >
2151
2152 :set diffopt=filler,context:4
2153 :set diffopt=
2154 :set diffopt=filler
2155<
2156 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2157'digraph' 'dg' boolean (default off)
2158 global
2159 {not in Vi}
2160 {not available when compiled without the |+digraphs|
2161 feature}
2162 Enable the entering of digraphs in Insert mode with {char1} <BS>
2163 {char2}. See |digraphs|.
2164 NOTE: This option is reset when 'compatible' is set.
2165
2166 *'directory'* *'dir'*
2167'directory' 'dir' string (default for Amiga: ".,t:",
2168 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2169 for Unix: ".,~/tmp,/var/tmp,/tmp")
2170 global
2171 List of directory names for the swap file, separated with commas.
2172 - The swap file will be created in the first directory where this is
2173 possible.
2174 - Empty means that no swap file will be used (recovery is
2175 impossible!).
2176 - A directory "." means to put the swap file in the same directory as
2177 the edited file. On Unix, a dot is prepended to the file name, so
2178 it doesn't show in a directory listing. On MS-Windows the "hidden"
2179 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002180 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002181 put the swap file relative to where the edited file is. The leading
2182 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002183 - For Unix and Win32, if a directory ends in two path separators "//"
2184 or "\\", the swap file name will be built from the complete path to
2185 the file with all path separators substituted to percent '%' signs.
2186 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002187 - Spaces after the comma are ignored, other spaces are considered part
2188 of the directory name. To have a space at the start of a directory
2189 name, precede it with a backslash.
2190 - To include a comma in a directory name precede it with a backslash.
2191 - A directory name may end in an ':' or '/'.
2192 - Environment variables are expanded |:set_env|.
2193 - Careful with '\' characters, type one before a space, type two to
2194 get one in the option (see |option-backslash|), for example: >
2195 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2196< - For backwards compatibility with Vim version 3.0 a '>' at the start
2197 of the option is removed.
2198 Using "." first in the list is recommended. This means that editing
2199 the same file twice will result in a warning. Using "/tmp" on Unix is
2200 discouraged: When the system crashes you lose the swap file.
2201 "/var/tmp" is often not cleared when rebooting, thus is a better
2202 choice than "/tmp". But it can contain a lot of files, your swap
2203 files get lost in the crowd. That is why a "tmp" directory in your
2204 home directory is tried first.
2205 The use of |:set+=| and |:set-=| is preferred when adding or removing
2206 directories from the list. This avoids problems when a future version
2207 uses another default.
2208 This option cannot be set from a |modeline| or in the |sandbox|, for
2209 security reasons.
2210 {Vi: directory to put temp file in, defaults to "/tmp"}
2211
2212 *'display'* *'dy'*
2213'display' 'dy' string (default "")
2214 global
2215 {not in Vi}
2216 Change the way text is displayed. This is comma separated list of
2217 flags:
2218 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002219 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002220 last line that doesn't fit is replaced with "@" lines.
2221 uhex Show unprintable characters hexadecimal as <xx>
2222 instead of using ^C and ~C.
2223
2224 *'eadirection'* *'ead'*
2225'eadirection' 'ead' string (default "both")
2226 global
2227 {not in Vi}
2228 {not available when compiled without the +vertsplit
2229 feature}
2230 Tells when the 'equalalways' option applies:
2231 ver vertically, width of windows is not affected
2232 hor horizontally, height of windows is not affected
2233 both width and height of windows is affected
2234
2235 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2236'edcompatible' 'ed' boolean (default off)
2237 global
2238 Makes the 'g' and 'c' flags of the ":substitute" command to be
2239 toggled each time the flag is given. See |complex-change|. See
2240 also 'gdefault' option.
2241 Switching this option on is discouraged!
2242
2243 *'encoding'* *'enc'* *E543*
2244'encoding' 'enc' string (default: "latin1" or value from $LANG)
2245 global
2246 {only available when compiled with the |+multi_byte|
2247 feature}
2248 {not in Vi}
2249 Sets the character encoding used inside Vim. It applies to text in
2250 the buffers, registers, Strings in expressions, text stored in the
2251 viminfo file, etc. It sets the kind of characters which Vim can work
2252 with. See |encoding-names| for the possible values.
2253
2254 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002255 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002256 It should normally be kept at its default value, or set when Vim
2257 starts up. See |multibyte|.
2258
2259 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2260 "utf-8". Although care has been taken to allow different values of
2261 'encoding', "utf-8" is the natural choice for the environment and
2262 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002263 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002264 versions, and to avoid changing the encoding of newly created files
2265 without your knowledge (in case 'fileencodings' is empty).
2266
2267 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002268 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002269 iconv() or as specified with 'charconvert'.
2270
2271 Normally 'encoding' will be equal to your current locale. This will
2272 be the default if Vim recognizes your environment settings. If
2273 'encoding' is not set to the current locale, 'termencoding' must be
2274 set to convert typed and displayed text. See |encoding-table|.
2275
2276 When you set this option, it fires the |EncodingChanged| autocommand
2277 event so that you can set up fonts if necessary.
2278
2279 When the option is set, the value is converted to lowercase. Thus
2280 you can set it with uppercase values too. Underscores are translated
2281 to '-' signs.
2282 When the encoding is recognized, it is changed to the standard name.
2283 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2284 "iso-8859-2" and "utf8" becomes "utf-8".
2285
2286 Note: "latin1" is also used when the encoding could not be detected.
2287 This only works when editing files in the same encoding! When the
2288 actual character set is not latin1, make sure 'fileencoding' and
2289 'fileencodings' are empty. When conversion is needed, switch to using
2290 utf-8.
2291
2292 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2293 You don't notice this while editing, but it does matter for the
2294 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2295 setting 'encoding' to one of these values instead of utf-8 only has
2296 effect for encoding used for files when 'fileencoding' is empty.
2297
Bram Moolenaar661b1822005-07-28 22:36:45 +00002298 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2299 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002300
2301 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2302'endofline' 'eol' boolean (default on)
2303 local to buffer
2304 {not in Vi}
2305 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002306 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002307 option is automatically set when starting to edit a new file, unless
2308 the file does not have an <EOL> for the last line in the file, in
2309 which case it is reset. Normally you don't have to set or reset this
2310 option. When 'binary' is off the value is not used when writing the
2311 file. When 'binary' is on it is used to remember the presence of a
2312 <EOL> for the last line in the file, so that when you write the file
2313 the situation from the original file can be kept. But you can change
2314 it if you want to.
2315
2316 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2317'equalalways' 'ea' boolean (default on)
2318 global
2319 {not in Vi}
2320 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002321 splitting or closing a window. This also happens the moment the
2322 option is switched on. When off, splitting a window will reduce the
2323 size of the current window and leave the other windows the same. When
2324 closing a window the extra lines are given to the window next to it
2325 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002326 When mixing vertically and horizontally split windows, a minimal size
2327 is computed and some windows may be larger if there is room. The
2328 'eadirection' option tells in which direction the size is affected.
2329 Changing the height of a window can be avoided by setting
2330 'winfixheight'.
2331
2332 *'equalprg'* *'ep'*
2333'equalprg' 'ep' string (default "")
2334 global or local to buffer |global-local|
2335 {not in Vi}
2336 External program to use for "=" command. When this option is empty
2337 the internal formatting functions are used ('lisp', 'cindent' or
2338 'indentexpr').
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002339 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002340 about including spaces and backslashes.
2341 This option cannot be set from a |modeline| or in the |sandbox|, for
2342 security reasons.
2343
2344 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2345'errorbells' 'eb' boolean (default off)
2346 global
2347 Ring the bell (beep or screen flash) for error messages. This only
2348 makes a difference for error messages, the bell will be used always
2349 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002350 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002351 screen flash or do nothing.
2352
2353 *'errorfile'* *'ef'*
2354'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2355 others: "errors.err")
2356 global
2357 {not in Vi}
2358 {not available when compiled without the |+quickfix|
2359 feature}
2360 Name of the errorfile for the QuickFix mode (see |:cf|).
2361 When the "-q" command-line argument is used, 'errorfile' is set to the
2362 following argument. See |-q|.
2363 NOT used for the ":make" command. See 'makeef' for that.
2364 Environment variables are expanded |:set_env|.
2365 See |option-backslash| about including spaces and backslashes.
2366 This option cannot be set from a |modeline| or in the |sandbox|, for
2367 security reasons.
2368
2369 *'errorformat'* *'efm'*
2370'errorformat' 'efm' string (default is very long)
2371 global or local to buffer |global-local|
2372 {not in Vi}
2373 {not available when compiled without the |+quickfix|
2374 feature}
2375 Scanf-like description of the format for the lines in the error file
2376 (see |errorformat|).
2377
2378 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2379'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2380 global
2381 {not in Vi}
2382 Function keys that start with an <Esc> are recognized in Insert
2383 mode. When this option is off, the cursor and function keys cannot be
2384 used in Insert mode if they start with an <Esc>. The advantage of
2385 this is that the single <Esc> is recognized immediately, instead of
2386 after one second. Instead of resetting this option, you might want to
2387 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2388 when 'esckeys' is off, you can still map anything, but the cursor keys
2389 won't work by default.
2390 NOTE: This option is set to the Vi default value when 'compatible' is
2391 set and to the Vim default value when 'compatible' is reset.
2392
2393 *'eventignore'* *'ei'*
2394'eventignore' 'ei' string (default "")
2395 global
2396 {not in Vi}
2397 {not available when compiled without the |+autocmd|
2398 feature}
2399 A list of autocommand event names, which are to be ignored.
2400 When set to "all", all autocommand events are ignored, autocommands
2401 will not be executed.
2402 Otherwise this is a comma separated list of event names. Example: >
2403 :set ei=WinEnter,WinLeave
2404<
2405 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2406'expandtab' 'et' boolean (default off)
2407 local to buffer
2408 {not in Vi}
2409 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002410 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002411 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2412 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2413 NOTE: This option is reset when 'compatible' is set.
2414
2415 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2416'exrc' 'ex' boolean (default off)
2417 global
2418 {not in Vi}
2419 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2420 directory. If you switch this option on you should also consider
2421 setting the 'secure' option (see |initialization|). Using a local
2422 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2423 also see |.vimrc| and |gui-init|.
2424 This option cannot be set from a |modeline| or in the |sandbox|, for
2425 security reasons.
2426
2427 *'fileencoding'* *'fenc'* *E213*
2428'fileencoding' 'fenc' string (default: "")
2429 local to buffer
2430 {only available when compiled with the |+multi_byte|
2431 feature}
2432 {not in Vi}
2433 Sets the character encoding for the file of this buffer.
2434 When 'fileencoding' is different from 'encoding', conversion will be
2435 done when reading and writing the file.
2436 When 'fileencoding' is empty, the same value as 'encoding' will be
2437 used (no conversion when reading or writing a file).
2438 WARNING: Conversion can cause loss of information! When
2439 'encoding' is "utf-8" conversion is most likely done in a way
2440 that the reverse conversion results in the same text. When
2441 'encoding' is not "utf-8" some characters may be lost!
2442 See 'encoding' for the possible values. Additionally, values may be
2443 specified that can be handled by the converter, see
2444 |mbyte-conversion|.
2445 When reading a file 'fileencoding' will be set from 'fileencodings'.
2446 To read a file in a certain encoding it won't work by setting
2447 'fileencoding', use the |++enc| argument.
2448 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2449 When the option is set, the value is converted to lowercase. Thus
2450 you can set it with uppercase values too. '_' characters are
2451 replaced with '-'. If a name is recognized from the list for
2452 'encoding', it is replaced by the standard name. For example
2453 "ISO8859-2" becomes "iso-8859-2".
2454 When this option is set, after starting to edit a file, the 'modified'
2455 option is set, because the file would be different when written.
2456 If you do this in a modeline, you might want to set 'nomodified' to
2457 avoid this.
2458 This option can not be changed when 'modifiable' is off.
2459
2460 *'fe'*
2461 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002462 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002463 old short name was 'fe', which is no longer used.
2464
2465 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002466'fileencodings' 'fencs' string (default: "ucs-bom",
2467 "ucs-bom,utf-8,default,latin1" when
2468 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002469 global
2470 {only available when compiled with the |+multi_byte|
2471 feature}
2472 {not in Vi}
2473 This is a list of character encodings considered when starting to edit
2474 an existing file. When a file is read, Vim tries to use the first
2475 mentioned character encoding. If an error is detected, the next one
2476 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002477 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002478 an empty string, which means the value of 'encoding' is used.
2479 WARNING: Conversion can cause loss of information! When
2480 'encoding' is "utf-8" (or one of the other Unicode variants)
2481 conversion is most likely done in a way that the reverse
2482 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002483 "utf-8" some non-ASCII characters may be lost! You can use
2484 the |++bad| argument to specify what is done with characters
2485 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002486 For an empty file or a file with only ASCII characters most encodings
2487 will work and the first entry of 'fileencodings' will be used (except
2488 "ucs-bom", which requires the BOM to be present). If you prefer
2489 another encoding use an BufReadPost autocommand event to test if your
2490 preferred encoding is to be used. Example: >
2491 au BufReadPost * if search('\S', 'w') == 0 |
2492 \ set fenc=iso-2022-jp | endif
2493< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2494 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002495 When the |++enc| argument is used then the value of 'fileencodings' is
2496 not used.
2497 Note that 'fileencodings' is not used for a new file, 'fileencoding'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002498 is always empty then. This means that a non-existing file may get a
2499 different encoding than an empty file.
2500 The special value "ucs-bom" can be used to check for a Unicode BOM
2501 (Byte Order Mark) at the start of the file. It must not be preceded
2502 by "utf-8" or another Unicode encoding for this to work properly.
2503 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2504 because Vim cannot detect an error, thus the encoding is always
2505 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002506 The special value "default" can be used for the encoding from the
2507 environment. This is the default value for 'encoding'. It is useful
2508 when 'encoding' is set to "utf-8" and your environment uses a
2509 non-latin1 encoding, such as Russian.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002510 WRONG VALUES: WHAT'S WRONG:
2511 latin1,utf-8 "latin1" will always be used
2512 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2513 file
2514 cp1250,latin1 "cp1250" will always be used
2515 If 'fileencodings' is empty, 'fileencoding' is not modified.
2516 See 'fileencoding' for the possible values.
2517 Setting this option does not have an effect until the next time a file
2518 is read.
2519
2520 *'fileformat'* *'ff'*
2521'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2522 Unix default: "unix",
2523 Macintosh default: "mac")
2524 local to buffer
2525 {not in Vi}
2526 This gives the <EOL> of the current buffer, which is used for
2527 reading/writing the buffer from/to a file:
2528 dos <CR> <NL>
2529 unix <NL>
2530 mac <CR>
2531 When "dos" is used, CTRL-Z at the end of a file is ignored.
2532 See |file-formats| and |file-read|.
2533 For the character encoding of the file see 'fileencoding'.
2534 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2535 works like it was set to "unix'.
2536 This option is set automatically when starting to edit a file and
2537 'fileformats' is not empty and 'binary' is off.
2538 When this option is set, after starting to edit a file, the 'modified'
2539 option is set, because the file would be different when written.
2540 This option can not be changed when 'modifiable' is off.
2541 For backwards compatibility: When this option is set to "dos",
2542 'textmode' is set, otherwise 'textmode' is reset.
2543
2544 *'fileformats'* *'ffs'*
2545'fileformats' 'ffs' string (default:
2546 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2547 Vim Unix: "unix,dos",
2548 Vim Mac: "mac,unix,dos",
2549 Vi Cygwin: "unix,dos",
2550 Vi others: "")
2551 global
2552 {not in Vi}
2553 This gives the end-of-line (<EOL>) formats that will be tried when
2554 starting to edit a new buffer and when reading a file into an existing
2555 buffer:
2556 - When empty, the format defined with 'fileformat' will be used
2557 always. It is not set automatically.
2558 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002559 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002560 'fileformats' name will be used when a file is read into an existing
2561 buffer, no matter what 'fileformat' for that buffer is set to.
2562 - When more than one name is present, separated by commas, automatic
2563 <EOL> detection will be done when reading a file. When starting to
2564 edit a file, a check is done for the <EOL>:
2565 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2566 'fileformat' is set to "dos".
2567 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002568 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002569 preceding <CR>, "unix" is preferred over "dos".
2570 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2571 This means that "mac" is only chosen when "unix" is not present,
2572 or when no <NL> is found in the file, and when "dos" is not
2573 present, or no <CR><NL> is present in the file.
2574 Also if "unix" was first chosen, but the first <CR> is before
2575 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2576 the file, then 'fileformat' is set to "mac".
2577 4. If 'fileformat' is still not set, the first name from
2578 'fileformats' is used.
2579 When reading a file into an existing buffer, the same is done, but
2580 this happens like 'fileformat' has been set appropriately for that
2581 file only, the option is not changed.
2582 When 'binary' is set, the value of 'fileformats' is not used.
2583
2584 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2585 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2586 done:
2587 - When 'fileformats' is empty, there is no automatic detection. Dos
2588 format will be used.
2589 - When 'fileformats' is set to one or more names, automatic detection
2590 is done. This is based on the first <NL> in the file: If there is a
2591 <CR> in front of it, Dos format is used, otherwise Unix format is
2592 used.
2593 Also see |file-formats|.
2594 For backwards compatibility: When this option is set to an empty
2595 string or one format (no comma is included), 'textauto' is reset,
2596 otherwise 'textauto' is set.
2597 NOTE: This option is set to the Vi default value when 'compatible' is
2598 set and to the Vim default value when 'compatible' is reset.
2599
2600 *'filetype'* *'ft'*
2601'filetype' 'ft' string (default: "")
2602 local to buffer
2603 {not in Vi}
2604 {not available when compiled without the |+autocmd|
2605 feature}
2606 When this option is set, the FileType autocommand event is triggered.
2607 All autocommands that match with the value of this option will be
2608 executed. Thus the value of 'filetype' is used in place of the file
2609 name.
2610 Otherwise this option does not always reflect the current file type.
2611 This option is normally set when the file type is detected. To enable
2612 this use the ":filetype on" command. |:filetype|
2613 Setting this option to a different value is most useful in a modeline,
2614 for a file for which the file type is not automatically recognized.
2615 Example, for in an IDL file: >
2616 /* vim: set filetype=idl : */
2617< |FileType| |filetypes|
2618 Do not confuse this option with 'osfiletype', which is for the file
2619 type that is actually stored with the file.
2620 This option is not copied to another buffer, independent of the 's' or
2621 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002622 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002623
2624 *'fillchars'* *'fcs'*
2625'fillchars' 'fcs' string (default "vert:|,fold:-")
2626 global
2627 {not in Vi}
2628 {not available when compiled without the |+windows|
2629 and |+folding| features}
2630 Characters to fill the statuslines and vertical separators.
2631 It is a comma separated list of items:
2632
2633 item default Used for ~
2634 stl:c ' ' or '^' statusline of the current window
2635 stlnc:c ' ' or '-' statusline of the non-current windows
2636 vert:c '|' vertical separators |:vsplit|
2637 fold:c '-' filling 'foldtext'
2638 diff:c '-' deleted lines of the 'diff' option
2639
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002640 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002641 "stlnc" the space will be used when there is highlighting, '^' or '-'
2642 otherwise.
2643
2644 Example: >
2645 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2646< This is similar to the default, except that these characters will also
2647 be used when there is highlighting.
2648
2649 The highlighting used for these items:
2650 item highlight group ~
2651 stl:c StatusLine |hl-StatusLine|
2652 stlnc:c StatusLineNC |hl-StatusLineNC|
2653 vert:c VertSplit |hl-VertSplit|
2654 fold:c Folded |hl-Folded|
2655 diff:c DiffDelete |hl-DiffDelete|
2656
2657 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2658'fkmap' 'fk' boolean (default off) *E198*
2659 global
2660 {not in Vi}
2661 {only available when compiled with the |+rightleft|
2662 feature}
2663 When on, the keyboard is mapped for the Farsi character set.
2664 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002665 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002666
2667 *'foldclose'* *'fcl'*
2668'foldclose' 'fcl' string (default "")
2669 global
2670 {not in Vi}
2671 {not available when compiled without the |+folding|
2672 feature}
2673 When set to "all", a fold is closed when the cursor isn't in it and
2674 its level is higher than 'foldlevel'. Useful if you want folds to
2675 automatically close when moving out of them.
2676
2677 *'foldcolumn'* *'fdc'*
2678'foldcolumn' 'fdc' number (default 0)
2679 local to window
2680 {not in Vi}
2681 {not available when compiled without the |+folding|
2682 feature}
2683 When non-zero, a column with the specified width is shown at the side
2684 of the window which indicates open and closed folds. The maximum
2685 value is 12.
2686 See |folding|.
2687
2688 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2689'foldenable' 'fen' boolean (default on)
2690 local to window
2691 {not in Vi}
2692 {not available when compiled without the |+folding|
2693 feature}
2694 When off, all folds are open. This option can be used to quickly
2695 switch between showing all text unfolded and viewing the text with
2696 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002697 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002698 'foldenable' is off.
2699 This option is set by commands that create a new fold or close a fold.
2700 See |folding|.
2701
2702 *'foldexpr'* *'fde'*
2703'foldexpr' 'fde' string (default: "0")
2704 local to window
2705 {not in Vi}
2706 {not available when compiled without the |+folding|
2707 or |+eval| feature}
2708 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002709 for each line to obtain its fold level. See |fold-expr|.
2710
2711 The expression may be evaluated in the |sandbox|, see
2712 |sandbox-option|.
2713
2714 It is not allowed to change text or jump to another window while
2715 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002716
2717 *'foldignore'* *'fdi'*
2718'foldignore' 'fdi' string (default: "#")
2719 local to window
2720 {not in Vi}
2721 {not available when compiled without the |+folding|
2722 feature}
2723 Used only when 'foldmethod' is "indent". Lines starting with
2724 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002725 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002726 The default "#" works well for C programs. See |fold-indent|.
2727
2728 *'foldlevel'* *'fdl'*
2729'foldlevel' 'fdl' number (default: 0)
2730 local to window
2731 {not in Vi}
2732 {not available when compiled without the |+folding|
2733 feature}
2734 Sets the fold level: Folds with a higher level will be closed.
2735 Setting this option to zero will close all folds. Higher numbers will
2736 close fewer folds.
2737 This option is set by commands like |zm|, |zM| and |zR|.
2738 See |fold-foldlevel|.
2739
2740 *'foldlevelstart'* *'fdls'*
2741'foldlevelstart' 'fdls' number (default: -1)
2742 global
2743 {not in Vi}
2744 {not available when compiled without the |+folding|
2745 feature}
2746 Sets 'foldlevel' when starting to edit another buffer in a window.
2747 Useful to always start editing with all folds closed (value zero),
2748 some folds closed (one) or no folds closed (99).
2749 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002750 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002751 ignores this option and closes all folds.
2752 It is also done before BufReadPre autocommands, to allow an autocmd to
2753 overrule the 'foldlevel' value for specific files.
2754 When the value is negative, it is not used.
2755
2756 *'foldmarker'* *'fmr'* *E536*
2757'foldmarker' 'fmr' string (default: "{{{,}}}")
2758 local to window
2759 {not in Vi}
2760 {not available when compiled without the |+folding|
2761 feature}
2762 The start and end marker used when 'foldmethod' is "marker". There
2763 must be one comma, which separates the start and end marker. The
2764 marker is a literal string (a regular expression would be too slow).
2765 See |fold-marker|.
2766
2767 *'foldmethod'* *'fdm'*
2768'foldmethod' 'fdm' string (default: "manual")
2769 local to window
2770 {not in Vi}
2771 {not available when compiled without the |+folding|
2772 feature}
2773 The kind of folding used for the current window. Possible values:
2774 |fold-manual| manual Folds are created manually.
2775 |fold-indent| indent Lines with equal indent form a fold.
2776 |fold-expr| expr 'foldexpr' gives the fold level of a line.
2777 |fold-marker| marker Markers are used to specify folds.
2778 |fold-syntax| syntax Syntax highlighting items specify folds.
2779 |fold-diff| diff Fold text that is not changed.
2780
2781 *'foldminlines'* *'fml'*
2782'foldminlines' 'fml' number (default: 1)
2783 local to window
2784 {not in Vi}
2785 {not available when compiled without the |+folding|
2786 feature}
2787 Sets the minimum number of screen lines for a fold to be displayed
2788 closed. Also for manually closed folds.
2789 Note that this only has an effect of what is displayed. After using
2790 "zc" to close a fold, which is displayed open because it's smaller
2791 than 'foldminlines', a following "zc" may close a containing fold.
2792
2793 *'foldnestmax'* *'fdn'*
2794'foldnestmax' 'fdn' number (default: 20)
2795 local to window
2796 {not in Vi}
2797 {not available when compiled without the |+folding|
2798 feature}
2799 Sets the maximum nesting of folds for the "indent" and "syntax"
2800 methods. This avoids that too many folds will be created. Using more
2801 than 20 doesn't work, because the internal limit is 20.
2802
2803 *'foldopen'* *'fdo'*
2804'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
2805 search,tag,undo")
2806 global
2807 {not in Vi}
2808 {not available when compiled without the |+folding|
2809 feature}
2810 Specifies for which type of commands folds will be opened, if the
2811 command moves the cursor into a closed fold. It is a comma separated
2812 list of items.
2813 item commands ~
2814 all any
2815 block "(", "{", "[[", "[{", etc.
2816 hor horizontal movements: "l", "w", "fx", etc.
2817 insert any command in Insert mode
2818 jump far jumps: "G", "gg", etc.
2819 mark jumping to a mark: "'m", CTRL-O, etc.
2820 percent "%"
2821 quickfix ":cn", ":crew", ":make", etc.
2822 search search for a pattern: "/", "n", "*", "gd", etc.
2823 (not for a search pattern in a ":" command)
2824 tag jumping to a tag: ":ta", CTRL-T, etc.
2825 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002826 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00002827 the |zv| command to the mapping to get the same effect.
2828 When a movement command is used for an operator (e.g., "dl" or "y%")
2829 this option is not used. This means the operator will include the
2830 whole closed fold.
2831 Note that vertical movements are not here, because it would make it
2832 very difficult to move onto a closed fold.
2833 In insert mode the folds containing the cursor will always be open
2834 when text is inserted.
2835 To close folds you can re-apply 'foldlevel' with the |zx| command or
2836 set the 'foldclose' option to "all".
2837
2838 *'foldtext'* *'fdt'*
2839'foldtext' 'fdt' string (default: "foldtext()")
2840 local to window
2841 {not in Vi}
2842 {not available when compiled without the |+folding|
2843 feature}
2844 An expression which is used to specify the text displayed for a closed
2845 fold. See |fold-foldtext|.
2846
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002847 The expression may be evaluated in the |sandbox|, see
2848 |sandbox-option|.
2849
2850 It is not allowed to change text or jump to another window while
2851 evaluating 'foldtext' |textlock|.
2852
Bram Moolenaar071d4272004-06-13 20:20:40 +00002853 *'formatoptions'* *'fo'*
2854'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
2855 local to buffer
2856 {not in Vi}
2857 This is a sequence of letters which describes how automatic
2858 formatting is to be done. See |fo-table|. When the 'paste' option is
2859 on, no formatting is done (like 'formatoptions' is empty). Commas can
2860 be inserted for readability.
2861 To avoid problems with flags that are added in the future, use the
2862 "+=" and "-=" feature of ":set" |add-option-flags|.
2863 NOTE: This option is set to the Vi default value when 'compatible' is
2864 set and to the Vim default value when 'compatible' is reset.
2865
Bram Moolenaar86b68352004-12-27 21:59:20 +00002866 *'formatlistpat'* *'flp'*
2867'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
2868 local to buffer
2869 {not in Vi}
2870 A pattern that is used to recognize a list header. This is used for
2871 the "n" flag in 'formatoptions'.
2872 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00002873 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00002874 while still checking more characters. There must be a character
2875 following the pattern, when it matches the whole line it is handled
2876 like there is no match.
2877 The default recognizes a number, followed by an optional punctuation
2878 character and white space.
2879
Bram Moolenaar071d4272004-06-13 20:20:40 +00002880 *'formatprg'* *'fp'*
2881'formatprg' 'fp' string (default "")
2882 global
2883 {not in Vi}
2884 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002885 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00002886 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00002887 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002888 If the 'formatexpr' option is not empty it will be used instead.
2889 Otherwise, if 'formatprg' option is an empty string, the internal
2890 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00002891 Environment variables are expanded |:set_env|. See |option-backslash|
2892 about including spaces and backslashes.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002893 The expression may be evaluated in the |sandbox|, see
2894 |sandbox-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002895
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002896 *'formatexpr'* *'fex'*
2897'formatexpr' 'fex' string (default "")
2898 local to buffer
2899 {not in Vi}
2900 {not available when compiled without the |+eval|
2901 feature}
2902 Expression which is evaluated to format a range of lines for the |gq|
2903 operator. The |v:lnum| variable holds the first line to be formatted,
2904 |v:count| the number of lines to be formatted.
2905 When this option is empty 'formatprg' is used.
2906 Example: >
2907 :set formatexp=mylang#Format()
2908< This will invoke the mylang#Format() function in the
2909 autoload/mylang.vim file in 'runtimepath'. |autoload|
2910
2911 The expression is also evaluated when 'textwidth' is set and adding
2912 text beyond that limit. This happens under the same conditions as
2913 when internal formatting is used. Make sure the cursor is kept in the
2914 same spot relative to the text then! The |mode()| function will
2915 return "i" or "R" in this situation. When the function returns
2916 non-zero Vim will fall back to using the internal format mechanism.
2917
2918 The expression may be evaluated in the |sandbox|, see
2919 |sandbox-option|.
2920
2921 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002922'fsync' 'fs' boolean (default on)
2923 global
2924 {not in Vi}
2925 When on, the library function fsync() will be called after writing a
2926 file. This will flush a file to disk, ensuring that it is safely
2927 written even on filesystems which do metadata-only journaling. This
2928 will force the harddrive to spin up on Linux systems running in laptop
2929 mode, so it may be undesirable in some situations. Be warned that
2930 turning this off increases the chances of data loss after a crash. On
2931 systems without an fsync() implementation, this variable is always
2932 off.
2933 Also see 'swapsync' for controlling fsync() on swap files.
2934
Bram Moolenaar071d4272004-06-13 20:20:40 +00002935 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
2936'gdefault' 'gd' boolean (default off)
2937 global
2938 {not in Vi}
2939 When on, the ":substitute" flag 'g' is default on. This means that
2940 all matches in a line are substituted instead of one. When a 'g' flag
2941 is given to a ":substitute" command, this will toggle the substitution
2942 of all or one match. See |complex-change|.
2943
2944 command 'gdefault' on 'gdefault' off ~
2945 :s/// subst. all subst. one
2946 :s///g subst. one subst. all
2947 :s///gg subst. all subst. one
2948
2949 NOTE: This option is reset when 'compatible' is set.
2950
2951 *'grepformat'* *'gfm'*
2952'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
2953 global
2954 {not in Vi}
2955 Format to recognize for the ":grep" command output.
2956 This is a scanf-like string that uses the same format as the
2957 'errorformat' option: see |errorformat|.
2958
2959 *'grepprg'* *'gp'*
2960'grepprg' 'gp' string (default "grep -n ",
2961 Unix: "grep -n $* /dev/null",
2962 Win32: "findstr /n" or "grep -n",
2963 VMS: "SEARCH/NUMBERS ")
2964 global or local to buffer |global-local|
2965 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00002966 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002967 and '#' characters, which are expanded like when used in a command-
2968 line. The placeholder "$*" is allowed to specify where the arguments
2969 will be included. Environment variables are expanded |:set_env|. See
2970 |option-backslash| about including spaces and backslashes.
2971 When your "grep" accepts the "-H" argument, use this to make ":grep"
2972 also work well with a single file: >
2973 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00002974< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00002975 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
2976 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00002977 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00002978 apply equally to 'grepprg'.
2979 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
2980 otherwise it's "grep -n".
2981 This option cannot be set from a |modeline| or in the |sandbox|, for
2982 security reasons.
2983
2984 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
2985'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
2986 ve:ver35-Cursor,
2987 o:hor50-Cursor,
2988 i-ci:ver25-Cursor/lCursor,
2989 r-cr:hor20-Cursor/lCursor,
2990 sm:block-Cursor
2991 -blinkwait175-blinkoff150-blinkon175",
2992 for MS-DOS and Win32 console:
2993 "n-v-c:block,o:hor50,i-ci:hor15,
2994 r-cr:hor30,sm:block")
2995 global
2996 {not in Vi}
2997 {only available when compiled with GUI enabled, and
2998 for MS-DOS and Win32 console}
2999 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003000 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003001 the height of the cursor can be changed. This can be done by
3002 specifying a block cursor, or a percentage for a vertical or
3003 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003004 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003005
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003006 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003007 mode-list and an argument-list:
3008 mode-list:argument-list,mode-list:argument-list,..
3009 The mode-list is a dash separated list of these modes:
3010 n Normal mode
3011 v Visual mode
3012 ve Visual mode with 'selection' "exclusive" (same as 'v',
3013 if not specified)
3014 o Operator-pending mode
3015 i Insert mode
3016 r Replace mode
3017 c Command-line Normal (append) mode
3018 ci Command-line Insert mode
3019 cr Command-line Replace mode
3020 sm showmatch in Insert mode
3021 a all modes
3022 The argument-list is a dash separated list of these arguments:
3023 hor{N} horizontal bar, {N} percent of the character height
3024 ver{N} vertical bar, {N} percent of the character width
3025 block block cursor, fills the whole character
3026 [only one of the above three should be present]
3027 blinkwait{N} *cursor-blinking*
3028 blinkon{N}
3029 blinkoff{N}
3030 blink times for cursor: blinkwait is the delay before
3031 the cursor starts blinking, blinkon is the time that
3032 the cursor is shown and blinkoff is the time that the
3033 cursor is not shown. The times are in msec. When one
3034 of the numbers is zero, there is no blinking. The
3035 default is: "blinkwait700-blinkon400-blinkoff250".
3036 These numbers are used for a missing entry. This
3037 means that blinking is enabled by default. To switch
3038 blinking off you can use "blinkon0". The cursor only
3039 blinks when Vim is waiting for input, not while
3040 executing a command.
3041 To make the cursor blink in an xterm, see
3042 |xterm-blink|.
3043 {group-name}
3044 a highlight group name, that sets the color and font
3045 for the cursor
3046 {group-name}/{group-name}
3047 Two highlight group names, the first is used when
3048 no language mappings are used, the other when they
3049 are. |language-mapping|
3050
3051 Examples of parts:
3052 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3053 block cursor with colors from the "nCursor"
3054 highlight group
3055 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3056 In Insert and Command-line Insert mode, use a
3057 30% vertical bar cursor with colors from the
3058 "iCursor" highlight group. Blink a bit
3059 faster.
3060
3061 The 'a' mode is different. It will set the given argument-list for
3062 all modes. It does not reset anything to defaults. This can be used
3063 to do a common setting for all modes. For example, to switch off
3064 blinking: "a:blinkon0"
3065
3066 Examples of cursor highlighting: >
3067 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3068 :highlight Cursor gui=NONE guifg=bg guibg=fg
3069<
3070 *'guifont'* *'gfn'*
3071 *E235* *E596* *E610* *E611*
3072'guifont' 'gfn' string (default "")
3073 global
3074 {not in Vi}
3075 {only available when compiled with GUI enabled}
3076 This is a list of fonts which will be used for the GUI version of Vim.
3077 In its simplest form the value is just one font name. When
3078 the font cannot be found you will get an error message. To try other
3079 font names a list can be specified, font names separated with commas.
3080 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003081
Bram Moolenaar05159a02005-02-26 23:04:13 +00003082 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3083 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003084
Bram Moolenaar071d4272004-06-13 20:20:40 +00003085 Spaces after a comma are ignored. To include a comma in a font name
3086 precede it with a backslash. Setting an option requires an extra
3087 backslash before a space and a backslash. See also
3088 |option-backslash|. For example: >
3089 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003090< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003091 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003092
3093 If none of the fonts can be loaded, Vim will keep the current setting.
3094 If an empty font list is given, Vim will try using other resource
3095 settings (for X, it will use the Vim.font resource), and finally it
3096 will try some builtin default which should always be there ("7x13" in
3097 the case of X). The font names given should be "normal" fonts. Vim
3098 will try to find the related bold and italic fonts.
3099
Bram Moolenaar05159a02005-02-26 23:04:13 +00003100 For Win32, GTK, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003101 :set guifont=*
3102< will bring up a font requester, where you can pick the font you want.
3103
3104 The font name depends on the GUI used. See |setting-guifont| for a
3105 way to set 'guifont' for various systems.
3106
Bram Moolenaar071d4272004-06-13 20:20:40 +00003107 For the GTK+ 2 GUI the font name looks like this: >
3108 :set guifont=Andale\ Mono\ 11
3109< That's all. XLFDs are no longer accepted.
Bram Moolenaar05159a02005-02-26 23:04:13 +00003110
3111 For Mac OSX you can use something like this: >
3112 :set guifont=Monaco:h10
3113< *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003114 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003115 width). An exception is GTK 2: all fonts are accepted, but
3116 mono-spaced fonts look best.
3117
Bram Moolenaar071d4272004-06-13 20:20:40 +00003118 To preview a font on X11, you might be able to use the "xfontsel"
3119 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003120
Bram Moolenaar071d4272004-06-13 20:20:40 +00003121 For the Win32 GUI *E244* *E245*
3122 - takes these options in the font name:
3123 hXX - height is XX (points, can be floating-point)
3124 wXX - width is XX (points, can be floating-point)
3125 b - bold
3126 i - italic
3127 u - underline
3128 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003129 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003130 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3131 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3132 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003133 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003134
3135 Use a ':' to separate the options.
3136 - A '_' can be used in the place of a space, so you don't need to use
3137 backslashes to escape the spaces.
3138 - Examples: >
3139 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3140 :set guifont=Andale_Mono:h7.5:w4.5
3141< See also |font-sizes|.
3142
3143 *'guifontset'* *'gfs'*
3144 *E250* *E252* *E234* *E597* *E598*
3145'guifontset' 'gfs' string (default "")
3146 global
3147 {not in Vi}
3148 {only available when compiled with GUI enabled and
3149 with the |+xfontset| feature}
3150 {not available in the GTK+ 2 GUI}
3151 When not empty, specifies two (or more) fonts to be used. The first
3152 one for normal English, the second one for your special language. See
3153 |xfontset|.
3154 Setting this option also means that all font names will be handled as
3155 a fontset name. Also the ones used for the "font" argument of the
3156 |:highlight| command.
3157 The fonts must match with the current locale. If fonts for the
3158 character sets that the current locale uses are not included, setting
3159 'guifontset' will fail.
3160 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3161 the comma-separated names are alternative names, one of which will be
3162 used. In 'guifontset' the whole string is one fontset name,
3163 including the commas. It is not possible to specify alternative
3164 fontset names.
3165 This example works on many X11 systems: >
3166 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3167<
3168 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3169'guifontwide' 'gfw' string (default "")
3170 global
3171 {not in Vi}
3172 {only available when compiled with GUI enabled}
3173 When not empty, specifies a comma-separated list of fonts to be used
3174 for double-width characters. The first font that can be loaded is
3175 used.
3176 Note: The size of these fonts must be exactly twice as wide as the one
3177 specified with 'guifont' and the same height.
3178
3179 All GUI versions but GTK+ 2:
3180
3181 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3182 'guifontset' is empty or invalid.
3183 When 'guifont' is set and a valid font is found in it and
3184 'guifontwide' is empty Vim will attempt to find a matching
3185 double-width font and set 'guifontwide' to it.
3186
3187 GTK+ 2 GUI only: *guifontwide_gtk2*
3188
3189 If set and valid, 'guifontwide' is always used for double width
3190 characters, even if 'encoding' is not set to "utf-8".
3191 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003192 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003193 font for characters not available in 'guifont'. Thus you do not need
3194 to set 'guifontwide' at all unless you want to override the choice
3195 made by Pango/Xft.
3196
3197 *'guiheadroom'* *'ghr'*
3198'guiheadroom' 'ghr' number (default 50)
3199 global
3200 {not in Vi} {only for GTK and X11 GUI}
3201 The number of pixels subtracted from the screen height when fitting
3202 the GUI window on the screen. Set this before the GUI is started,
3203 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003204 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003205 lines will be left for window decorations and other items on the
3206 screen. Set it to a negative value to allow windows taller than the
3207 screen.
3208
3209 *'guioptions'* *'go'*
3210'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003211 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003212 global
3213 {not in Vi}
3214 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003215 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003216 sequence of letters which describes what components and options of the
3217 GUI should be used.
3218 To avoid problems with flags that are added in the future, use the
3219 "+=" and "-=" feature of ":set" |add-option-flags|.
3220
3221 Valid letters are as follows:
3222 *guioptions_a*
3223 'a' Autoselect: If present, then whenever VISUAL mode is started,
3224 or the Visual area extended, Vim tries to become the owner of
3225 the windowing system's global selection. This means that the
3226 Visually highlighted text is available for pasting into other
3227 applications as well as into Vim itself. When the Visual mode
3228 ends, possibly due to an operation on the text, or when an
3229 application wants to paste the selection, the highlighted text
3230 is automatically yanked into the "* selection register.
3231 Thus the selection is still available for pasting into other
3232 applications after the VISUAL mode has ended.
3233 If not present, then Vim won't become the owner of the
3234 windowing system's global selection unless explicitly told to
3235 by a yank or delete operation for the "* register.
3236 The same applies to the modeless selection.
3237
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003238 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003239 applies to the modeless selection.
3240
3241 'guioptions' autoselect Visual autoselect modeless ~
3242 "" - -
3243 "a" yes yes
3244 "A" - yes
3245 "aA" yes yes
3246
3247 'c' Use console dialogs instead of popup dialogs for simple
3248 choices.
3249
3250 'f' Foreground: Don't use fork() to detach the GUI from the shell
3251 where it was started. Use this for programs that wait for the
3252 editor to finish (e.g., an e-mail program). Alternatively you
3253 can use "gvim -f" or ":gui -f" to start the GUI in the
3254 foreground. |gui-fork|
3255 Note: Set this option in the vimrc file. The forking may have
3256 happened already when the gvimrc file is read.
3257
3258 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3259 corner of the window. It's black&white on non-GTK, because of
3260 limitations of X11. For a color icon, see |X11-icon|.
3261
3262 'm' Menu bar is present.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003263 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003264 that this flag must be added in the .vimrc file, before
3265 switching on syntax or filetype recognition (when the .gvimrc
3266 file is sourced the system menu has already been loaded; the
3267 ":syntax on" and ":filetype on" commands load the menu too).
3268 'g' Grey menu items: Make menu items that are not active grey. If
3269 'g' is not included inactive menu items are not shown at all.
3270 Exception: Athena will always use grey menu items.
3271
3272 't' Include tearoff menu items. Currently only works for Win32,
3273 GTK+, and Motif 1.2 GUI.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003274 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
3275 and Athena GUIs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003276
3277 'r' Right-hand scrollbar is always present.
3278 'R' Right-hand scrollbar is present when there is a vertically
3279 split window.
3280 'l' Left-hand scrollbar is always present.
3281 'L' Left-hand scrollbar is present when there is a vertically
3282 split window.
3283 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3284 the longest visible line, or on the cursor line if the 'h'
3285 flag is included. |gui-horiz-scroll|
3286 'h' Limit horizontal scrollbar size to the length of the cursor
3287 line. Reduces computations. |gui-horiz-scroll|
3288
3289 And yes, you may even have scrollbars on the left AND the right if
3290 you really want to :-). See |gui-scrollbars| for more information.
3291
3292 'v' Use a vertical button layout for dialogs. When not included,
3293 a horizontal layout is preferred, but when it doesn't fit a
3294 vertical layout is used anyway.
3295 'p' Use Pointer callbacks for X11 GUI. This is required for some
3296 window managers. If the cursor is not blinking or hollow at
3297 the right moment, try adding this flag. This must be done
3298 before starting the GUI. Set it in your gvimrc. Adding or
3299 removing it after the GUI has started has no effect.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003300 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003301
3302 *'guipty'* *'noguipty'*
3303'guipty' boolean (default on)
3304 global
3305 {not in Vi}
3306 {only available when compiled with GUI enabled}
3307 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3308 I/O to/from shell commands. See |gui-pty|.
3309
3310 *'helpfile'* *'hf'*
3311'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3312 (others) "$VIMRUNTIME/doc/help.txt")
3313 global
3314 {not in Vi}
3315 Name of the main help file. All distributed help files should be
3316 placed together in one directory. Additionally, all "doc" directories
3317 in 'runtimepath' will be used.
3318 Environment variables are expanded |:set_env|. For example:
3319 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003320 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003321 spaces and backslashes.
3322 This option cannot be set from a |modeline| or in the |sandbox|, for
3323 security reasons.
3324
3325 *'helpheight'* *'hh'*
3326'helpheight' 'hh' number (default 20)
3327 global
3328 {not in Vi}
3329 {not available when compiled without the +windows
3330 feature}
3331 Minimal initial height of the help window when it is opened with the
3332 ":help" command. The initial height of the help window is half of the
3333 current window, or (when the 'ea' option is on) the same as other
3334 windows. When the height is less than 'helpheight', the height is
3335 set to 'helpheight'. Set to zero to disable.
3336
3337 *'helplang'* *'hlg'*
3338'helplang' 'hlg' string (default: messages language or empty)
3339 global
3340 {only available when compiled with the |+multi_lang|
3341 feature}
3342 {not in Vi}
3343 Comma separated list of languages. Vim will use the first language
3344 for which the desired help can be found. The English help will always
3345 be used as a last resort. You can add "en" to prefer English over
3346 another language, but that will only find tags that exist in that
3347 language and not in the English help.
3348 Example: >
3349 :set helplang=de,it
3350< This will first search German, then Italian and finally English help
3351 files.
3352 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3353 try to find the tag in the current language before using this option.
3354 See |help-translated|.
3355
3356 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3357'hidden' 'hid' boolean (default off)
3358 global
3359 {not in Vi}
3360 When off a buffer is unloaded when it is |abandon|ed. When on a
3361 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3362 displayed in another window, it does not become hidden, of course.
3363 The commands that move through the buffer list sometimes make a buffer
3364 hidden although the 'hidden' option is off: When the buffer is
3365 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003366 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003367 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003368 This option is set for one command with ":hide {command}" |:hide|.
3369 WARNING: It's easy to forget that you have changes in hidden buffers.
3370 Think twice when using ":q!" or ":qa!".
3371
3372 *'highlight'* *'hl'*
3373'highlight' 'hl' string (default (as a single string):
3374 "8:SpecialKey,@:NonText,d:Directory,
3375 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3376 M:ModeMsg,n:LineNr,r:Question,
3377 s:StatusLine,S:StatusLineNC,c:VertSplit
3378 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3379 f:Folded,F:FoldColumn,A:DiffAdd,
3380 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003381 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003382 R:SpellRare,L:SpellLocal,
3383 +:Pmenu,=:PmenuSel,
3384 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003385 global
3386 {not in Vi}
3387 This option can be used to set highlighting mode for various
3388 occasions. It is a comma separated list of character pairs. The
3389 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003390 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003391 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3392 |hl-NonText| @ '~' and '@' at the end of the window and
3393 characters from 'showbreak'
3394 |hl-Directory| d directories in CTRL-D listing and other special
3395 things in listings
3396 |hl-ErrorMsg| e error messages
3397 h (obsolete, ignored)
3398 |hl-IncSearch| i 'incsearch' highlighting
3399 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3400 |hl-MoreMsg| m |more-prompt|
3401 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
3402 |hl-LineNr| n line number for ":number" and ":#" commands
3403 |hl-Question| r |hit-enter| prompt and yes/no questions
3404 |hl-StatusLine| s status line of current window |status-line|
3405 |hl-StatusLineNC| S status lines of not-current windows
3406 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3407 |hl-VertSplit| c column used to separate vertically split windows
3408 |hl-Visual| v Visual mode
3409 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3410 Selection" Only X11 Gui's |gui-x11| and
3411 |xterm-clipboard|.
3412 |hl-WarningMsg| w warning messages
3413 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3414 |hl-Folded| f line used for closed folds
3415 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003416 |hl-DiffAdd| A added line in diff mode
3417 |hl-DiffChange| C changed line in diff mode
3418 |hl-DiffDelete| D deleted line in diff mode
3419 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003420 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003421 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003422 |hl-SpellCap| P word that should start with capital|spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003423 |hl-SpellRare| R rare word |spell|
3424 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003425 |hl-Pmenu| + popup menu normal line
3426 |hl-PmenuSel| = popup menu normal line
3427 |hl-PmenuSbar| x popup menu scrollbar
3428 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003429
3430 The display modes are:
3431 r reverse (termcap entry "mr" and "me")
3432 i italic (termcap entry "ZH" and "ZR")
3433 b bold (termcap entry "md" and "me")
3434 s standout (termcap entry "so" and "se")
3435 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003436 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003437 n no highlighting
3438 - no highlighting
3439 : use a highlight group
3440 The default is used for occasions that are not included.
3441 If you want to change what the display modes do, see |dos-colors|
3442 for an example.
3443 When using the ':' display mode, this must be followed by the name of
3444 a highlight group. A highlight group can be used to define any type
3445 of highlighting, including using color. See |:highlight| on how to
3446 define one. The default uses a different group for each occasion.
3447 See |highlight-default| for the default highlight groups.
3448
3449 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3450'hlsearch' 'hls' boolean (default off)
3451 global
3452 {not in Vi}
3453 {not available when compiled without the
3454 |+extra_search| feature}
3455 When there is a previous search pattern, highlight all its matches.
3456 The type of highlighting used can be set with the 'l' occasion in the
3457 'highlight' option. This uses the "Search" highlight group by
3458 default. Note that only the matching text is highlighted, any offsets
3459 are not applied.
3460 See also: 'incsearch' and |:match|.
3461 When you get bored looking at the highlighted matches, you can turn it
3462 off with |:nohlsearch|. As soon as you use a search command, the
3463 highlighting comes back.
3464 When the search pattern can match an end-of-line, Vim will try to
3465 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003466 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003467 line below a closed fold. A match in a previous line which is not
3468 drawn may not continue in an newly drawn line.
3469 NOTE: This option is reset when 'compatible' is set.
3470
3471 *'history'* *'hi'*
3472'history' 'hi' number (Vim default: 20, Vi default: 0)
3473 global
3474 {not in Vi}
3475 A history of ":" commands, and a history of previous search patterns
3476 are remembered. This option decides how many entries may be stored in
3477 each of these histories (see |cmdline-editing|).
3478 NOTE: This option is set to the Vi default value when 'compatible' is
3479 set and to the Vim default value when 'compatible' is reset.
3480
3481 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3482'hkmap' 'hk' boolean (default off)
3483 global
3484 {not in Vi}
3485 {only available when compiled with the |+rightleft|
3486 feature}
3487 When on, the keyboard is mapped for the Hebrew character set.
3488 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3489 toggle this option. See |rileft.txt|.
3490 NOTE: This option is reset when 'compatible' is set.
3491
3492 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3493'hkmapp' 'hkp' boolean (default off)
3494 global
3495 {not in Vi}
3496 {only available when compiled with the |+rightleft|
3497 feature}
3498 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3499 This is useful if you have a non-Hebrew keyboard.
3500 See |rileft.txt|.
3501 NOTE: This option is reset when 'compatible' is set.
3502
3503 *'icon'* *'noicon'*
3504'icon' boolean (default off, on when title can be restored)
3505 global
3506 {not in Vi}
3507 {not available when compiled without the |+title|
3508 feature}
3509 When on, the icon text of the window will be set to the value of
3510 'iconstring' (if it is not empty), or to the name of the file
3511 currently being edited. Only the last part of the name is used.
3512 Overridden by the 'iconstring' option.
3513 Only works if the terminal supports setting window icons (currently
3514 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3515 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3516 builtin termcap).
3517 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003518 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003519 X11.
3520
3521 *'iconstring'*
3522'iconstring' string (default "")
3523 global
3524 {not in Vi}
3525 {not available when compiled without the |+title|
3526 feature}
3527 When this option is not empty, it will be used for the icon text of
3528 the window. This happens only when the 'icon' option is on.
3529 Only works if the terminal supports setting window icon text
3530 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3531 Does not work for MS Windows.
3532 When Vim was compiled with HAVE_X11 defined, the original icon will be
3533 restored if possible |X11|.
3534 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003535 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003536 'titlestring' for example settings.
3537 {not available when compiled without the |+statusline| feature}
3538
3539 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3540'ignorecase' 'ic' boolean (default off)
3541 global
3542 Ignore case in search patterns. Also used when searching in the tags
3543 file.
3544 Also see 'smartcase'.
3545 Can be overruled by using "\c" or "\C" in the pattern, see
3546 |/ignorecase|.
3547
3548 *'imactivatekey'* *'imak'*
3549'imactivatekey' 'imak' string (default "")
3550 global
3551 {not in Vi}
3552 {only available when compiled with |+xim| and
3553 |+GUI_GTK|}
3554 Specifies the key that your Input Method in X-Windows uses for
3555 activation. When this is specified correctly, vim can fully control
3556 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3557 You can't use this option to change the activation key, the option
3558 tells Vim what the key is.
3559 Format:
3560 [MODIFIER_FLAG-]KEY_STRING
3561
3562 These characters can be used for MODIFIER_FLAG (case is ignored):
3563 S Shift key
3564 L Lock key
3565 C Control key
3566 1 Mod1 key
3567 2 Mod2 key
3568 3 Mod3 key
3569 4 Mod4 key
3570 5 Mod5 key
3571 Combinations are allowed, for example "S-C-space" or "SC-space" are
3572 both shift+ctrl+space.
3573 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3574
3575 Example: >
3576 :set imactivatekey=S-space
3577< "S-space" means shift+space. This is the activation key for kinput2 +
3578 canna (Japanese), and ami (Korean).
3579
3580 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3581'imcmdline' 'imc' boolean (default off)
3582 global
3583 {not in Vi}
3584 {only available when compiled with the |+xim|
3585 |+multi_byte_ime| or |global-ime| feature}
3586 When set the Input Method is always on when starting to edit a command
3587 line, unless entering a search pattern (see 'imsearch' for that).
3588 Setting this option is useful when your input method allows entering
3589 English characters directly, e.g., when it's used to type accented
3590 characters with dead keys.
3591
3592 *'imdisable'* *'imd'* *'nodisable'* *'noimd'*
3593'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3594 global
3595 {not in Vi}
3596 {only available when compiled with the |+xim|
3597 |+multi_byte_ime| or |global-ime| feature}
3598 When set the Input Method is never used. This is useful to disable
3599 the IM when it doesn't work properly.
3600 Currently this option is on by default for SGI/IRIX machines. This
3601 may change in later releases.
3602
3603 *'iminsert'* *'imi'*
3604'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3605 local to buffer
3606 {not in Vi}
3607 Specifies whether :lmap or an Input Method (IM) is to be used in
3608 Insert mode. Valid values:
3609 0 :lmap is off and IM is off
3610 1 :lmap is ON and IM is off
3611 2 :lmap is off and IM is ON
3612 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3613 or |global-ime|.
3614 To always reset the option to zero when leaving Insert mode with <Esc>
3615 this can be used: >
3616 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3617< This makes :lmap and IM turn off automatically when leaving Insert
3618 mode.
3619 Note that this option changes when using CTRL-^ in Insert mode
3620 |i_CTRL-^|.
3621 The value is set to 1 when setting 'keymap' to a valid keymap name.
3622 It is also used for the argument of commands like "r" and "f".
3623 The value 0 may not work correctly with Athena and Motif with some XIM
3624 methods. Use 'imdisable' to disable XIM then.
3625
3626 *'imsearch'* *'ims'*
3627'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3628 local to buffer
3629 {not in Vi}
3630 Specifies whether :lmap or an Input Method (IM) is to be used when
3631 entering a search pattern. Valid values:
3632 -1 the value of 'iminsert' is used, makes it look like
3633 'iminsert' is also used when typing a search pattern
3634 0 :lmap is off and IM is off
3635 1 :lmap is ON and IM is off
3636 2 :lmap is off and IM is ON
3637 Note that this option changes when using CTRL-^ in Command-line mode
3638 |c_CTRL-^|.
3639 The value is set to 1 when it is not -1 and setting the 'keymap'
3640 option to a valid keymap name.
3641 The value 0 may not work correctly with Athena and Motif with some XIM
3642 methods. Use 'imdisable' to disable XIM then.
3643
3644 *'include'* *'inc'*
3645'include' 'inc' string (default "^\s*#\s*include")
3646 global or local to buffer |global-local|
3647 {not in Vi}
3648 {not available when compiled without the
3649 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003650 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003651 pattern, just like for the "/" command (See |pattern|). The default
3652 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00003653 "]I", "[d", etc.
3654 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003655 comes after the matched pattern. But if "\zs" appears in the pattern
3656 then the text matched from "\zs" to the end, or until "\ze" if it
3657 appears, is used as the file name. Use this to include characters
3658 that are not in 'isfname', such as a space. You can then use
3659 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003660 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003661
3662 *'includeexpr'* *'inex'*
3663'includeexpr' 'inex' string (default "")
3664 local to buffer
3665 {not in Vi}
3666 {not available when compiled without the
3667 |+find_in_path| or |+eval| feature}
3668 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003669 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003670 :set includeexpr=substitute(v:fname,'\\.','/','g')
3671< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003672
Bram Moolenaar071d4272004-06-13 20:20:40 +00003673 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003674 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003675 Also used for |<cfile>|.
3676
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003677 The expression may be evaluated in the |sandbox|, see
3678 |sandbox-option|.
3679
3680 It is not allowed to change text or jump to another window while
3681 evaluating 'includeexpr' |textlock|.
3682
Bram Moolenaar071d4272004-06-13 20:20:40 +00003683 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3684'incsearch' 'is' boolean (default off)
3685 global
3686 {not in Vi}
3687 {not available when compiled without the
3688 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003689 While typing a search command, show where the pattern, as it was typed
3690 so far, matches. The matched string is highlighted. If the pattern
3691 is invalid or not found, nothing is shown. The screen will be updated
3692 often, this is only useful on fast terminals.
3693 Note that the match will be shown, but the cursor will return to its
3694 original position when no match is found and when pressing <Esc>. You
3695 still need to finish the search command with <Enter> to move the
3696 cursor to the match.
3697 The highlighting can be set with the 'i' flag in 'highlight'.
3698 See also: 'hlsearch'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003699 NOTE: This option is reset when 'compatible' is set.
3700
3701 *'indentexpr'* *'inde'*
3702'indentexpr' 'inde' string (default "")
3703 local to buffer
3704 {not in Vi}
3705 {not available when compiled without the |+cindent|
3706 or |+eval| features}
3707 Expression which is evaluated to obtain the proper indent for a line.
3708 It is used when a new line is created, for the |=| operator and
3709 in Insert mode as specified with the 'indentkeys' option.
3710 When this option is not empty, it overrules the 'cindent' and
3711 'smartindent' indenting.
3712 When 'paste' is set this option is not used for indenting.
3713 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003714 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00003715 when the expression is evaluated (but it may be moved around).
3716 The expression must return the number of spaces worth of indent. It
3717 can return "-1" to keep the current indent (this means 'autoindent' is
3718 used for the indent).
3719 Functions useful for computing the indent are |indent()|, |cindent()|
3720 and |lispindent()|.
3721 The evaluation of the expression must not have side effects! It must
3722 not change the text, jump to another window, etc. Afterwards the
3723 cursor position is always restored, thus the cursor may be moved.
3724 Normally this option would be set to call a function: >
3725 :set indentexpr=GetMyIndent()
3726< Error messages will be suppressed, unless the 'debug' option contains
3727 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003728 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003729 NOTE: This option is made empty when 'compatible' is set.
3730
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003731 The expression may be evaluated in the |sandbox|, see
3732 |sandbox-option|.
3733
3734 It is not allowed to change text or jump to another window while
3735 evaluating 'indentexpr' |textlock|.
3736
3737
Bram Moolenaar071d4272004-06-13 20:20:40 +00003738 *'indentkeys'* *'indk'*
3739'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
3740 local to buffer
3741 {not in Vi}
3742 {not available when compiled without the |+cindent|
3743 feature}
3744 A list of keys that, when typed in Insert mode, cause reindenting of
3745 the current line. Only happens if 'indentexpr' isn't empty.
3746 The format is identical to 'cinkeys', see |indentkeys-format|.
3747 See |C-indenting| and |indent-expression|.
3748
3749 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
3750'infercase' 'inf' boolean (default off)
3751 local to buffer
3752 {not in Vi}
3753 When doing keyword completion in insert mode |ins-completion|, and
3754 'ignorecase' is also on, the case of the match is adjusted. If the
3755 typed text contains a lowercase letter where the match has an upper
3756 case letter, the completed part is made lowercase. If the typed text
3757 has no lowercase letters and the match has a lowercase letter where
3758 the typed text has an uppercase letter, and there is a letter before
3759 it, the completed part is made uppercase.
3760
3761 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
3762'insertmode' 'im' boolean (default off)
3763 global
3764 {not in Vi}
3765 Makes Vim work in a way that Insert mode is the default mode. Useful
3766 if you want to use Vim as a modeless editor. Used for |evim|.
3767 These Insert mode commands will be useful:
3768 - Use the cursor keys to move around.
3769 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
3770 this is a mapping, it is executed as if 'insertmode' was off.
3771 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003772 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00003773 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
3774 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003775
3776 These items change when 'insertmode' is set:
3777 - when starting to edit of a file, Vim goes to Insert mode.
3778 - <Esc> in Insert mode is a no-op and beeps.
3779 - <Esc> in Normal mode makes Vim go to Insert mode.
3780 - CTRL-L in Insert mode is a command, it is not inserted.
3781 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
3782 However, when <Esc> is used inside a mapping, it behaves like
3783 'insertmode' was not set. This was done to be able to use the same
3784 mappings with 'insertmode' set or not set.
3785 When executing commands with |:normal| 'insertmode' is not used.
3786
3787 NOTE: This option is reset when 'compatible' is set.
3788
3789 *'isfname'* *'isf'*
3790'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
3791 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
3792 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
3793 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
3794 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
3795 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
3796 global
3797 {not in Vi}
3798 The characters specified by this option are included in file names and
3799 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003800 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003801 Multi-byte characters 256 and above are always included, only the
3802 characters up to 255 are specified with this option.
3803 For UTF-8 the characters 0xa0 to 0xff are included as well.
3804
3805 Note that on systems using a backslash as path separator, Vim tries to
3806 do its best to make it work as you would expect. That is a bit
3807 tricky, since Vi originally used the backslash to escape special
3808 characters. Vim will not remove a backslash in front of a normal file
3809 name character on these systems, but it will on Unix and alikes. The
3810 '&' and '^' are not included by default, because these are special for
3811 cmd.exe.
3812
3813 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003814 Each part can be a single character number or a range. A range is two
3815 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003816 decimal number between 0 and 255 or the ASCII character itself (does
3817 not work for digits). Example:
3818 "_,-,128-140,#-43" (include '_' and '-' and the range
3819 128 to 140 and '#' to 43)
3820 If a part starts with '^', the following character number or range
3821 will be excluded from the option. The option is interpreted from left
3822 to right. Put the excluded character after the range where it is
3823 included. To include '^' itself use it as the last character of the
3824 option or the end of a range. Example:
3825 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
3826 If the character is '@', all characters where isalpha() returns TRUE
3827 are included. Normally these are the characters a to z and A to Z,
3828 plus accented characters. To include '@' itself use "@-@". Examples:
3829 "@,^a-z" All alphabetic characters, excluding lower
3830 case letters.
3831 "a-z,A-Z,@-@" All letters plus the '@' character.
3832 A comma can be included by using it where a character number is
3833 expected. Example:
3834 "48-57,,,_" Digits, comma and underscore.
3835 A comma can be excluded by prepending a '^'. Example:
3836 " -~,^,,9" All characters from space to '~', excluding
3837 comma, plus <Tab>.
3838 See |option-backslash| about including spaces and backslashes.
3839
3840 *'isident'* *'isi'*
3841'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
3842 "@,48-57,_,128-167,224-235"
3843 otherwise: "@,48-57,_,192-255")
3844 global
3845 {not in Vi}
3846 The characters given by this option are included in identifiers.
3847 Identifiers are used in recognizing environment variables and after a
3848 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00003849 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00003850 option.
3851 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003852 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003853 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
3854
3855 *'iskeyword'* *'isk'*
3856'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
3857 "@,48-57,_,128-167,224-235"
3858 otherwise: "@,48-57,_,192-255"
3859 Vi default: "@,48-57,_")
3860 local to buffer
3861 {not in Vi}
3862 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003863 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003864 'isfname' for a description of the format of this option. For C
3865 programs you could use "a-z,A-Z,48-57,_,.,-,>".
3866 For a help file it is set to all non-blank printable characters except
3867 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
3868 command).
3869 When the 'lisp' option is on the '-' character is always included.
3870 NOTE: This option is set to the Vi default value when 'compatible' is
3871 set and to the Vim default value when 'compatible' is reset.
3872
3873 *'isprint'* *'isp'*
3874'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
3875 "@,~-255"; otherwise: "@,161-255")
3876 global
3877 {not in Vi}
3878 The characters given by this option are displayed directly on the
3879 screen. It is also used for "\p" in a |pattern|. The characters from
3880 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
3881 even when they are not included in 'isprint' or excluded. See
3882 'isfname' for a description of the format of this option.
3883
3884 Non-printable characters are displayed with two characters:
3885 0 - 31 "^@" - "^_"
3886 32 - 126 always single characters
3887 127 "^?"
3888 128 - 159 "~@" - "~_"
3889 160 - 254 "| " - "|~"
3890 255 "~?"
3891 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
3892 displayed as <xx>, with the hexadecimal value of the byte.
3893 When 'display' contains "uhex" all unprintable characters are
3894 displayed as <xx>.
3895 The NonText highlighting will be used for unprintable characters.
3896 |hl-NonText|
3897
3898 Multi-byte characters 256 and above are always included, only the
3899 characters up to 255 are specified with this option. When a character
3900 is printable but it is not available in the current font, a
3901 replacement character will be shown.
3902 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
3903 There is no option to specify these characters.
3904
3905 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
3906'joinspaces' 'js' boolean (default on)
3907 global
3908 {not in Vi}
3909 Insert two spaces after a '.', '?' and '!' with a join command.
3910 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
3911 Otherwise only one space is inserted.
3912 NOTE: This option is set when 'compatible' is set.
3913
3914 *'key'*
3915'key' string (default "")
3916 local to buffer
3917 {not in Vi}
3918 The key that is used for encrypting and decrypting the current buffer.
3919 See |encryption|.
3920 Careful: Do not set the key value by hand, someone might see the typed
3921 key. Use the |:X| command. But you can make 'key' empty: >
3922 :set key=
3923< It is not possible to get the value of this option with ":set key" or
3924 "echo &key". This is to avoid showing it to someone who shouldn't
3925 know. It also means you cannot see it yourself once you have set it,
3926 be careful not to make a typing error!
3927
3928 *'keymap'* *'kmp'* *E544*
3929'keymap' 'kmp' string (default "")
3930 local to buffer
3931 {not in Vi}
3932 {only available when compiled with the |+keymap|
3933 feature}
3934 Name of a keyboard mapping. See |mbyte-keymap|.
3935 Setting this option to a valid keymap name has the side effect of
3936 setting 'iminsert' to one, so that the keymap becomes effective.
3937 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003938 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003939
3940 *'keymodel'* *'km'*
3941'keymodel' 'km' string (default "")
3942 global
3943 {not in Vi}
3944 List of comma separated words, which enable special things that keys
3945 can do. These values can be used:
3946 startsel Using a shifted special key starts selection (either
3947 Select mode or Visual mode, depending on "key" being
3948 present in 'selectmode').
3949 stopsel Using a not-shifted special key stops selection.
3950 Special keys in this context are the cursor keys, <End>, <Home>,
3951 <PageUp> and <PageDown>.
3952 The 'keymodel' option is set by the |:behave| command.
3953
3954 *'keywordprg'* *'kp'*
3955'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
3956 OS/2: "view /", VMS: "help")
3957 global or local to buffer |global-local|
3958 {not in Vi}
3959 Program to use for the |K| command. Environment variables are
3960 expanded |:set_env|. ":help" may be used to access the Vim internal
3961 help. (Note that previously setting the global option to the empty
3962 value did this, which is now deprecated.)
3963 When "man" is used, Vim will automatically translate a count for the
3964 "K" command to a section number. Also for "man -s", in which case the
3965 "-s" is removed when there is no count.
3966 See |option-backslash| about including spaces and backslashes.
3967 Example: >
3968 :set keywordprg=man\ -s
3969< This option cannot be set from a |modeline| or in the |sandbox|, for
3970 security reasons.
3971
3972 *'langmap'* *'lmap'* *E357* *E358*
3973'langmap' 'lmap' string (default "")
3974 global
3975 {not in Vi}
3976 {only available when compiled with the |+langmap|
3977 feature}
3978 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003979 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00003980 inserted directly. When in command mode the 'langmap' option takes
3981 care of translating these special characters to the original meaning
3982 of the key. This means you don't have to change the keyboard mode to
3983 be able to execute Normal mode commands.
3984 This is the opposite of the 'keymap' option, where characters are
3985 mapped in Insert mode.
3986 This only works for 8-bit characters. The value of 'langmap' may be
3987 specified with multi-byte characters (e.g., UTF-8), but only the lower
3988 8 bits of each character will be used.
3989
3990 Example (for Greek): *greek* >
3991 :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
3992< Example (exchanges meaning of z and y for commands): >
3993 :set langmap=zy,yz,ZY,YZ
3994<
3995 The 'langmap' option is a list of parts, separated with commas. Each
3996 part can be in one of two forms:
3997 1. A list of pairs. Each pair is a "from" character immediately
3998 followed by the "to" character. Examples: "aA", "aAbBcC".
3999 2. A list of "from" characters, a semi-colon and a list of "to"
4000 characters. Example: "abc;ABC"
4001 Example: "aA,fgh;FGH,cCdDeE"
4002 Special characters need to be preceded with a backslash. These are
4003 ";", ',' and backslash itself.
4004
4005 This will allow you to activate vim actions without having to switch
4006 back and forth between the languages. Your language characters will
4007 be understood as normal vim English characters (according to the
4008 langmap mappings) in the following cases:
4009 o Normal/Visual mode (commands, buffer/register names, user mappings)
4010 o Insert/Replace Mode: Register names after CTRL-R
4011 o Insert/Replace Mode: Mappings
4012 Characters entered in Command-line mode will NOT be affected by
4013 this option. Note that this option can be changed at any time
4014 allowing to switch between mappings for different languages/encodings.
4015 Use a mapping to avoid having to type it each time!
4016
4017 *'langmenu'* *'lm'*
4018'langmenu' 'lm' string (default "")
4019 global
4020 {not in Vi}
4021 {only available when compiled with the |+menu| and
4022 |+multi_lang| features}
4023 Language to use for menu translation. Tells which file is loaded
4024 from the "lang" directory in 'runtimepath': >
4025 "lang/menu_" . &langmenu . ".vim"
4026< (without the spaces). For example, to always use the Dutch menus, no
4027 matter what $LANG is set to: >
4028 :set langmenu=nl_NL.ISO_8859-1
4029< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004030 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004031 If your $LANG is set to a non-English language but you do want to use
4032 the English menus: >
4033 :set langmenu=none
4034< This option must be set before loading menus, switching on filetype
4035 detection or syntax highlighting. Once the menus are defined setting
4036 this option has no effect. But you could do this: >
4037 :source $VIMRUNTIME/delmenu.vim
4038 :set langmenu=de_DE.ISO_8859-1
4039 :source $VIMRUNTIME/menu.vim
4040< Warning: This deletes all menus that you defined yourself!
4041
4042 *'laststatus'* *'ls'*
4043'laststatus' 'ls' number (default 1)
4044 global
4045 {not in Vi}
4046 The value of this option influences when the last window will have a
4047 status line:
4048 0: never
4049 1: only if there are at least two windows
4050 2: always
4051 The screen looks nicer with a status line if you have several
4052 windows, but it takes another screen line. |status-line|
4053
4054 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4055'lazyredraw' 'lz' boolean (default off)
4056 global
4057 {not in Vi}
4058 When this option is set, the screen will not be redrawn while
4059 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004060 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004061 update use |:redraw|.
4062
4063 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4064'linebreak' 'lbr' boolean (default off)
4065 local to window
4066 {not in Vi}
4067 {not available when compiled without the |+linebreak|
4068 feature}
4069 If on Vim will wrap long lines at a character in 'breakat' rather
4070 than at the last character that fits on the screen. Unlike
4071 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4072 it only affects the way the file is displayed, not its contents. The
4073 value of 'showbreak' is used to put in front of wrapped lines.
4074 This option is not used when the 'wrap' option is off or 'list' is on.
4075 Note that <Tab> characters after an <EOL> are mostly not displayed
4076 with the right amount of white space.
4077
4078 *'lines'* *E593*
4079'lines' number (default 24 or terminal height)
4080 global
4081 Number of lines of the Vim window.
4082 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004083 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004084 When Vim is running in the GUI or in a resizable window, setting this
4085 option will cause the window size to be changed. When you only want
4086 to use the size for the GUI, put the command in your |gvimrc| file.
4087 Vim limits the number of lines to what fits on the screen. You can
4088 use this command to get the tallest window possible: >
4089 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004090< Minimum value is 2, maximum value is 1000.
4091 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004092 When you set this option and Vim is unable to change the physical
4093 number of lines of the display, the display may be messed up.
4094
4095 *'linespace'* *'lsp'*
4096'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4097 global
4098 {not in Vi}
4099 {only in the GUI}
4100 Number of pixel lines inserted between characters. Useful if the font
4101 uses the full character cell height, making lines touch each other.
4102 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004103 With some fonts there can be too much room between lines (to have
4104 space for ascents and descents). Then it makes sense to set
4105 'linespace' to a negative value. This may cause display problems
4106 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004107
4108 *'lisp'* *'nolisp'*
4109'lisp' boolean (default off)
4110 local to buffer
4111 {not available when compiled without the |+lispindent|
4112 feature}
4113 Lisp mode: When <Enter> is typed in insert mode set the indent for
4114 the next line to Lisp standards (well, sort of). Also happens with
4115 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4116 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4117 better. Also see 'lispwords'.
4118 The '-' character is included in keyword characters. Redefines the
4119 "=" operator to use this same indentation algorithm rather than
4120 calling an external program if 'equalprg' is empty.
4121 This option is not used when 'paste' is set.
4122 {Vi: Does it a little bit differently}
4123
4124 *'lispwords'* *'lw'*
4125'lispwords' 'lw' string (default is very long)
4126 global
4127 {not in Vi}
4128 {not available when compiled without the |+lispindent|
4129 feature}
4130 Comma separated list of words that influence the Lisp indenting.
4131 |'lisp'|
4132
4133 *'list'* *'nolist'*
4134'list' boolean (default off)
4135 local to window
4136 List mode: Show tabs as CTRL-I, show end of line with $. Useful to
4137 see the difference between tabs and spaces and for trailing blanks.
4138 Note that this will also affect formatting (set with 'textwidth' or
4139 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
4140 changing the way tabs are displayed.
4141
4142 *'listchars'* *'lcs'*
4143'listchars' 'lcs' string (default "eol:$")
4144 global
4145 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004146 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004147 settings.
4148 eol:c Character to show at the end of each line. When
4149 omitted, there is no extra character at the end of the
4150 line.
4151 tab:xy Two characters to be used to show a Tab. The first
4152 char is used once. The second char is repeated to
4153 fill the space that the Tab normally occupies.
4154 "tab:>-" will show a Tab that takes four spaces as
4155 ">---". When omitted, a Tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004156 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004157 trailing spaces are blank.
4158 extends:c Character to show in the last column, when 'wrap' is
4159 off and the line continues beyond the right of the
4160 screen.
4161 precedes:c Character to show in the first column, when 'wrap'
4162 is off and there is text preceding the character
4163 visible in the first column.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004164 nbsp:c Character to show for a non-breakable space (character
4165 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004166
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004167 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004168 be used when 'encoding' is "utf-8", otherwise only printable
4169 characters are allowed.
4170
4171 Examples: >
4172 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004173 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004174 :set lcs=extends:>,precedes:<
4175< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004176 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004177
4178 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4179'loadplugins' 'lpl' boolean (default on)
4180 global
4181 {not in Vi}
4182 When on the plugin scripts are loaded when starting up |load-plugins|.
4183 This option can be reset in your |vimrc| file to disable the loading
4184 of plugins.
4185 Note that using the "-u NONE" and "--noplugin" command line arguments
4186 reset this option. |-u| |--noplugin|
4187
4188 *'magic'* *'nomagic'*
4189'magic' boolean (default on)
4190 global
4191 Changes the special characters that can be used in search patterns.
4192 See |pattern|.
4193 NOTE: To avoid portability problems with using patterns, always keep
4194 this option at the default "on". Only switch it off when working with
4195 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004196 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004197
4198 *'makeef'* *'mef'*
4199'makeef' 'mef' string (default: "")
4200 global
4201 {not in Vi}
4202 {not available when compiled without the |+quickfix|
4203 feature}
4204 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4205 and the |:grep| command.
4206 When it is empty, an internally generated temp file will be used.
4207 When "##" is included, it is replaced by a number to make the name
4208 unique. This makes sure that the ":make" command doesn't overwrite an
4209 existing file.
4210 NOT used for the ":cf" command. See 'errorfile' for that.
4211 Environment variables are expanded |:set_env|.
4212 See |option-backslash| about including spaces and backslashes.
4213 This option cannot be set from a |modeline| or in the |sandbox|, for
4214 security reasons.
4215
4216 *'makeprg'* *'mp'*
4217'makeprg' 'mp' string (default "make", VMS: "MMS")
4218 global or local to buffer |global-local|
4219 {not in Vi}
4220 Program to use for the ":make" command. See |:make_makeprg|. This
4221 option may contain '%' and '#' characters, which are expanded like
4222 when used in a command-line. Environment variables are expanded
4223 |:set_env|. See |option-backslash| about including spaces and
4224 backslashes. Note that a '|' must be escaped twice: once for ":set"
4225 and once for the interpretation of a command. When you use a filter
4226 called "myfilter" do it like this: >
4227 :set makeprg=gmake\ \\\|\ myfilter
4228< The placeholder "$*" can be given (even multiple times) to specify
4229 where the arguments will be included, for example: >
4230 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4231< This option cannot be set from a |modeline| or in the |sandbox|, for
4232 security reasons.
4233
4234 *'matchpairs'* *'mps'*
4235'matchpairs' 'mps' string (default "(:),{:},[:]")
4236 local to buffer
4237 {not in Vi}
4238 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004239 other. Currently only single character pairs are allowed, and they
Bram Moolenaar071d4272004-06-13 20:20:40 +00004240 must be different. The characters must be separated by a colon. The
4241 pairs must be separated by a comma. Example for including '<' and '>'
4242 (HTML): >
4243 :set mps+=<:>
4244
4245< A more exotic example, to jump between the '=' and ';' in an
4246 assignment, useful for languages like C and Java: >
4247 :au FileType c,cpp,java set mps+==:;
4248
4249< For a more advanced way of using "%", see the matchit.vim plugin in
4250 the $VIMRUNTIME/macros directory. |add-local-help|
4251
4252 *'matchtime'* *'mat'*
4253'matchtime' 'mat' number (default 5)
4254 global
4255 {not in Vi}{in Nvi}
4256 Tenths of a second to show the matching paren, when 'showmatch' is
4257 set. Note that this is not in milliseconds, like other options that
4258 set a time. This is to be compatible with Nvi.
4259
4260 *'maxfuncdepth'* *'mfd'*
4261'maxfuncdepth' 'mfd' number (default 100)
4262 global
4263 {not in Vi}
4264 Maximum depth of function calls for user functions. This normally
4265 catches endless recursion. When using a recursive function with
4266 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4267 more memory, there is the danger of failing when memory is exhausted.
4268 See also |:function|.
4269
4270 *'maxmapdepth'* *'mmd'* *E223*
4271'maxmapdepth' 'mmd' number (default 1000)
4272 global
4273 {not in Vi}
4274 Maximum number of times a mapping is done without resulting in a
4275 character to be used. This normally catches endless mappings, like
4276 ":map x y" with ":map y x". It still does not catch ":map g wg",
4277 because the 'w' is used before the next mapping is done. See also
4278 |key-mapping|.
4279
4280 *'maxmem'* *'mm'*
4281'maxmem' 'mm' number (default between 256 to 5120 (system
4282 dependent) or half the amount of memory
4283 available)
4284 global
4285 {not in Vi}
4286 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4287 limit is reached allocating extra memory for a buffer will cause
4288 other memory to be freed. Maximum value 2000000. Use this to work
4289 without a limit. Also see 'maxmemtot'.
4290
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004291 *'maxmempattern'* *'mmp'*
4292'maxmempattern' 'mmp' number (default 1000)
4293 global
4294 {not in Vi}
4295 Maximum amount of memory (in Kbyte) to use for pattern matching.
4296 Maximum value 2000000. Use this to work without a limit.
4297 *E363*
4298 When Vim runs into the limit it gives an error message mostly behaves
4299 like CTRL-C was typed.
4300 Running into the limit often means that the pattern is very
4301 inefficient or too complex. This may already happen with the pattern
4302 "\(.\)*" on a very long line. ".*" works much better.
4303 Vim may run out of memory before hitting the 'maxmempattern' limit.
4304
Bram Moolenaar071d4272004-06-13 20:20:40 +00004305 *'maxmemtot'* *'mmt'*
4306'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4307 dependent) or half the amount of memory
4308 available)
4309 global
4310 {not in Vi}
4311 Maximum amount of memory (in Kbyte) to use for all buffers together.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004312 Maximum value 2000000. Use this to work without a limit. Also see
Bram Moolenaar071d4272004-06-13 20:20:40 +00004313 'maxmem'.
4314
4315 *'menuitems'* *'mis'*
4316'menuitems' 'mis' number (default 25)
4317 global
4318 {not in Vi}
4319 {not available when compiled without the |+menu|
4320 feature}
4321 Maximum number of items to use in a menu. Used for menus that are
4322 generated from a list of items, e.g., the Buffers menu. Changing this
4323 option has no direct effect, the menu must be refreshed first.
4324
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004325 *'mkspellmem'* *'msm'*
4326'mkspellmem' 'msm' string (default "460000,2000,500")
4327 global
4328 {not in Vi}
4329 {not available when compiled without the |+syntax|
4330 feature}
4331 Parameters for |:mkspell|. This tunes when to start compressing the
4332 word tree. Compression can be slow when there are many words, but
4333 it's needed to avoid running out of memory. The amount of memory used
4334 per word depends very much on how similar the words are, that's why
4335 this tuning is complicated.
4336
4337 There are three numbers, separated by commas:
4338 {start},{inc},{added}
4339
4340 For most languages the uncompressed word tree fits in memory. {start}
4341 gives the amount of memory in Kbyte that can be used before any
4342 compression is done. It should be a bit smaller than the amount of
4343 memory that is available to Vim.
4344
4345 When going over the {start} limit the {inc} number specifies the
4346 amount of memory in Kbyte that can be allocated before another
4347 compression is done. A low number means compression is done after
4348 less words are added, which is slow. A high number means more memory
4349 will be allocated.
4350
4351 After doing compression, {added} times 1024 words can be added before
4352 the {inc} limit is ignored and compression is done when any extra
4353 amount of memory is needed. A low number means there is a smaller
4354 chance of hitting the {inc} limit, less memory is used but it's
4355 slower.
4356
4357 The languages for which these numbers are important are Italian and
4358 Hungarian. The default works for when you have about 512 Mbyte. If
4359 you have 1 Gbyte you could use: >
4360 :set mkspellmem=900000,3000,800
4361< If you have less than 512 Mbyte |:mkspell| may fail for some
4362 languages, no matter what you set 'mkspellmem' to.
4363
Bram Moolenaar071d4272004-06-13 20:20:40 +00004364 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
4365'modeline' 'ml' boolean (Vim default: on, Vi default: off)
4366 local to buffer
4367 *'modelines'* *'mls'*
4368'modelines' 'mls' number (default 5)
4369 global
4370 {not in Vi}
4371 If 'modeline' is on 'modelines' gives the number of lines that is
4372 checked for set commands. If 'modeline' is off or 'modelines' is zero
4373 no lines are checked. See |modeline|.
4374 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4375 set and to the Vim default value when 'compatible' is reset.
4376
4377 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4378'modifiable' 'ma' boolean (default on)
4379 local to buffer
4380 {not in Vi} *E21*
4381 When off the buffer contents cannot be changed. The 'fileformat' and
4382 'fileencoding' options also can't be changed.
4383 Can be reset with the |-M| command line argument.
4384
4385 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4386'modified' 'mod' boolean (default off)
4387 local to buffer
4388 {not in Vi}
4389 When on, the buffer is considered to be modified. This option is set
4390 when:
4391 1. A change was made to the text since it was last written. Using the
4392 |undo| command to go back to the original text will reset the
4393 option. But undoing changes that were made before writing the
4394 buffer will set the option again, since the text is different from
4395 when it was written.
4396 2. 'fileformat' or 'fileencoding' is different from its original
4397 value. The original value is set when the buffer is read or
4398 written. A ":set nomodified" command also resets the original
4399 values to the current values and the 'modified' option will be
4400 reset.
4401 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4402 will be ignored.
4403
4404 *'more'* *'nomore'*
4405'more' boolean (Vim default: on, Vi default: off)
4406 global
4407 {not in Vi}
4408 When on, listings pause when the whole screen is filled. You will get
4409 the |more-prompt|. When this option is off there are no pauses, the
4410 listing continues until finished.
4411 NOTE: This option is set to the Vi default value when 'compatible' is
4412 set and to the Vim default value when 'compatible' is reset.
4413
4414 *'mouse'* *E538*
4415'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4416 global
4417 {not in Vi}
4418 Enable the use of the mouse. Only works for certain terminals
4419 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, and Linux console
4420 with gpm). For using the mouse in the GUI, see |gui-mouse|.
4421 The mouse can be enabled for different modes:
4422 n Normal mode
4423 v Visual mode
4424 i Insert mode
4425 c Command-line mode
4426 h all previous modes when editing a help file
4427 a all previous modes
4428 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004429 Normally you would enable the mouse in all four modes with: >
4430 :set mouse=a
4431< When the mouse is not enabled, the GUI will still use the mouse for
4432 modeless selection. This doesn't move the text cursor.
4433
4434 See |mouse-using|. Also see |'clipboard'|.
4435
4436 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004437 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004438 the mouse buttons can still be used by keeping the shift key pressed.
4439 Also see the 'clipboard' option.
4440
4441 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4442'mousefocus' 'mousef' boolean (default off)
4443 global
4444 {not in Vi}
4445 {only works in the GUI}
4446 The window that the mouse pointer is on is automatically activated.
4447 When changing the window layout or window focus in another way, the
4448 mouse pointer is moved to the window with keyboard focus. Off is the
4449 default because it makes using the pull down menus a little goofy, as
4450 a pointer transit may activate a window unintentionally.
4451
4452 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4453'mousehide' 'mh' boolean (default on)
4454 global
4455 {not in Vi}
4456 {only works in the GUI}
4457 When on, the mouse pointer is hidden when characters are typed.
4458 The mouse pointer is restored when the mouse is moved.
4459
4460 *'mousemodel'* *'mousem'*
4461'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4462 global
4463 {not in Vi}
4464 Sets the model to use for the mouse. The name mostly specifies what
4465 the right mouse button is used for:
4466 extend Right mouse button extends a selection. This works
4467 like in an xterm.
4468 popup Right mouse button pops up a menu. The shifted left
4469 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004470 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004471 popup_setpos Like "popup", but the cursor will be moved to the
4472 position where the mouse was clicked, and thus the
4473 selected operation will act upon the clicked object.
4474 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004475 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004476 course, that right clicking outside a selection will
4477 end Visual mode.
4478 Overview of what button does what for each model:
4479 mouse extend popup(_setpos) ~
4480 left click place cursor place cursor
4481 left drag start selection start selection
4482 shift-left search word extend selection
4483 right click extend selection popup menu (place cursor)
4484 right drag extend selection -
4485 middle click paste paste
4486
4487 In the "popup" model the right mouse button produces a pop-up menu.
4488 You need to define this first, see |popup-menu|.
4489
4490 Note that you can further refine the meaning of buttons with mappings.
4491 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4492 selection (because that's handled in the GUI code directly).
4493
4494 The 'mousemodel' option is set by the |:behave| command.
4495
4496 *'mouseshape'* *'mouses'* *E547*
4497'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004498 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004499 global
4500 {not in Vi}
4501 {only available when compiled with the |+mouseshape|
4502 feature}
4503 This option tells Vim what the mouse pointer should look like in
4504 different modes. The option is a comma separated list of parts, much
4505 like used for 'guicursor'. Each part consist of a mode/location-list
4506 and an argument-list:
4507 mode-list:shape,mode-list:shape,..
4508 The mode-list is a dash separated list of these modes/locations:
4509 In a normal window: ~
4510 n Normal mode
4511 v Visual mode
4512 ve Visual mode with 'selection' "exclusive" (same as 'v',
4513 if not specified)
4514 o Operator-pending mode
4515 i Insert mode
4516 r Replace mode
4517
4518 Others: ~
4519 c appending to the command-line
4520 ci inserting in the command-line
4521 cr replacing in the command-line
4522 m at the 'Hit ENTER' or 'More' prompts
4523 ml idem, but cursor in the last line
4524 e any mode, pointer below last window
4525 s any mode, pointer on a status line
4526 sd any mode, while dragging a status line
4527 vs any mode, pointer on a vertical separator line
4528 vd any mode, while dragging a vertical separator line
4529 a everywhere
4530
4531 The shape is one of the following:
4532 avail name looks like ~
4533 w x arrow Normal mouse pointer
4534 w x blank no pointer at all (use with care!)
4535 w x beam I-beam
4536 w x updown up-down sizing arrows
4537 w x leftright left-right sizing arrows
4538 w x busy The system's usual busy pointer
4539 w x no The system's usual 'no input' pointer
4540 x udsizing indicates up-down resizing
4541 x lrsizing indicates left-right resizing
4542 x crosshair like a big thin +
4543 x hand1 black hand
4544 x hand2 white hand
4545 x pencil what you write with
4546 x question big ?
4547 x rightup-arrow arrow pointing right-up
4548 w x up-arrow arrow pointing up
4549 x <number> any X11 pointer number (see X11/cursorfont.h)
4550
4551 The "avail" column contains a 'w' if the shape is available for Win32,
4552 x for X11.
4553 Any modes not specified or shapes not available use the normal mouse
4554 pointer.
4555
4556 Example: >
4557 :set mouseshape=s:udsizing,m:no
4558< will make the mouse turn to a sizing arrow over the status lines and
4559 indicate no input when the hit-enter prompt is displayed (since
4560 clicking the mouse has no effect in this state.)
4561
4562 *'mousetime'* *'mouset'*
4563'mousetime' 'mouset' number (default 500)
4564 global
4565 {not in Vi}
4566 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4567 time in msec between two mouse clicks for the second click to be
4568 recognized as a multi click.
4569
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004570 *'mzquantum'* *'mzq'*
4571'mzquantum' 'mzq' number (default 100)
4572 global
4573 {not in Vi}
4574 {not available when compiled without the |+mzscheme|
4575 feature}
4576 The number of milliseconds between polls for MzScheme threads.
4577 Negative or zero value means no thread scheduling.
4578
Bram Moolenaar071d4272004-06-13 20:20:40 +00004579 *'nrformats'* *'nf'*
4580'nrformats' 'nf' string (default "octal,hex")
4581 local to buffer
4582 {not in Vi}
4583 This defines what bases Vim will consider for numbers when using the
4584 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4585 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004586 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004587 incremented or decremented. This is useful for a list with a
4588 letter index a), b), etc.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004589 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00004590 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00004591 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004592 considered to be hexadecimal. Example: Using CTRL-X on
4593 "0x100" results in "0x0ff".
4594 Numbers which simply begin with a digit in the range 1-9 are always
4595 considered decimal. This also happens for numbers that are not
4596 recognized as octal or hex.
4597
4598 *'number'* *'nu'* *'nonumber'* *'nonu'*
4599'number' 'nu' boolean (default off)
4600 local to window
4601 Print the line number in front of each line. When the 'n' option is
4602 excluded from 'cpoptions' a wrapped line will not use the column of
4603 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004604 The 'numberwidth' option can be used to set the room used for the line
4605 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004606 When a long, wrapped line doesn't start with the first character, '-'
4607 characters are put before the number.
4608 See |hl-LineNr| for the highlighting used for the number.
4609
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004610 *'numberwidth'* *'nuw'*
4611'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4612 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004613 {not in Vi}
4614 {only available when compiled with the |+linebreak|
4615 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004616 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00004617 when the 'number' option is set or printint lines with a line number.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004618 Since one space is always between the number and the text, there is
4619 one less character for the number itself.
4620 The value is the minimum width. A bigger width is used when needed to
4621 fit the highest line number in the buffer. Thus with the Vim default
4622 of 4 there is room for a line number up to 999. When the buffer has
4623 1000 lines five columns will be used.
4624 The minimum value is 1, the maximum value is 10.
4625 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
4626
Bram Moolenaarf75a9632005-09-13 21:20:47 +00004627 *'omnifunc'* *'ofu'*
4628'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00004629 local to buffer
4630 {not in Vi}
4631 {not available when compiled without the +eval
4632 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00004633 This option specifies a function to be used for Insert mode omni
4634 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00004635 See |complete-functions| for an explanation of how the function is
4636 invoked and what it should return.
Bram Moolenaare344bea2005-09-01 20:46:49 +00004637
4638
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00004639 *'operatorfunc'* *'opfunc'*
4640'operatorfunc' 'opfunc' string (default: empty)
4641 global
4642 {not in Vi}
4643 This option specifies a function to be called by the |g@| operator.
4644 See |:map-operator| for more info and an example.
4645
4646 This option cannot be set from a |modeline| or in the |sandbox|, for
4647 security reasons.
4648
4649
Bram Moolenaar071d4272004-06-13 20:20:40 +00004650 *'osfiletype'* *'oft'* *E366*
4651'osfiletype' 'oft' string (RISC-OS default: "Text",
4652 others default: "")
4653 local to buffer
4654 {not in Vi}
4655 {only available when compiled with the |+osfiletype|
4656 feature}
4657 Some operating systems store extra information about files besides
4658 name, datestamp and permissions. This option contains the extra
4659 information, the nature of which will vary between systems.
4660 The value of this option is usually set when the file is loaded, and
4661 use to set the file type when file is written.
4662 It can affect the pattern matching of the automatic commands.
4663 |autocmd-osfiletypes|
4664
4665 *'paragraphs'* *'para'*
4666'paragraphs' 'para' string (default "IPLPPPQPP LIpplpipbp")
4667 global
4668 Specifies the nroff macros that separate paragraphs. These are pairs
4669 of two letters (see |object-motions|).
4670
4671 *'paste'* *'nopaste'*
4672'paste' boolean (default off)
4673 global
4674 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004675 Put Vim in Paste mode. This is useful if you want to cut or copy
4676 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004677 unexpected effects.
4678 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004679 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00004680 knows about pasting and will mostly do the right thing without 'paste'
4681 being set. The same is true for a terminal where Vim handles the
4682 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00004683 This option is reset when starting the GUI. Thus if you set it in
4684 your .vimrc it will work in a terminal, but not in the GUI. Setting
4685 'paste' in the GUI has side effects: e.g., the Paste toolbar button
4686 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004687 When the 'paste' option is switched on (also when it was already on):
4688 - mapping in Insert mode and Command-line mode is disabled
4689 - abbreviations are disabled
4690 - 'textwidth' is set to 0
4691 - 'wrapmargin' is set to 0
4692 - 'autoindent' is reset
4693 - 'smartindent' is reset
4694 - 'softtabstop' is set to 0
4695 - 'revins' is reset
4696 - 'ruler' is reset
4697 - 'showmatch' is reset
4698 - 'formatoptions' is used like it is empty
4699 These options keep their value, but their effect is disabled:
4700 - 'lisp'
4701 - 'indentexpr'
4702 - 'cindent'
4703 NOTE: When you start editing another file while the 'paste' option is
4704 on, settings from the modelines or autocommands may change the
4705 settings again, causing trouble when pasting text. You might want to
4706 set the 'paste' option again.
4707 When the 'paste' option is reset the mentioned options are restored to
4708 the value before the moment 'paste' was switched from off to on.
4709 Resetting 'paste' before ever setting it does not have any effect.
4710 Since mapping doesn't work while 'paste' is active, you need to use
4711 the 'pastetoggle' option to toggle the 'paste' option with some key.
4712
4713 *'pastetoggle'* *'pt'*
4714'pastetoggle' 'pt' string (default "")
4715 global
4716 {not in Vi}
4717 When non-empty, specifies the key sequence that toggles the 'paste'
4718 option. This is like specifying a mapping: >
4719 :map {keys} :set invpaste<CR>
4720< Where {keys} is the value of 'pastetoggle'.
4721 The difference is that it will work even when 'paste' is set.
4722 'pastetoggle' works in Insert mode and Normal mode, but not in
4723 Command-line mode.
4724 Mappings are checked first, thus overrule 'pastetoggle'. However,
4725 when 'paste' is on mappings are ignored in Insert mode, thus you can do
4726 this: >
4727 :map <F10> :set paste<CR>
4728 :map <F11> :set nopaste<CR>
4729 :imap <F10> <C-O>:set paste<CR>
4730 :imap <F11> <nop>
4731 :set pastetoggle=<F11>
4732< This will make <F10> start paste mode and <F11> stop paste mode.
4733 Note that typing <F10> in paste mode inserts "<F10>", since in paste
4734 mode everything is inserted literally, except the 'pastetoggle' key
4735 sequence.
4736
4737 *'pex'* *'patchexpr'*
4738'patchexpr' 'pex' string (default "")
4739 global
4740 {not in Vi}
4741 {not available when compiled without the |+diff|
4742 feature}
4743 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004744 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004745
4746 *'patchmode'* *'pm'* *E206*
4747'patchmode' 'pm' string (default "")
4748 global
4749 {not in Vi}
4750 When non-empty the oldest version of a file is kept. This can be used
4751 to keep the original version of a file if you are changing files in a
4752 source distribution. Only the first time that a file is written a
4753 copy of the original file will be kept. The name of the copy is the
4754 name of the original file with the string in the 'patchmode' option
4755 appended. This option should start with a dot. Use a string like
4756 ".org". 'backupdir' must not be empty for this to work (Detail: The
4757 backup file is renamed to the patchmode file after the new file has
4758 been successfully written, that's why it must be possible to write a
4759 backup file). If there was no file to be backed up, an empty file is
4760 created.
4761 When the 'backupskip' pattern matches, a patchmode file is not made.
4762 Using 'patchmode' for compressed files appends the extension at the
4763 end (e.g., "file.gz.orig"), thus the resulting name isn't always
4764 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004765 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004766
4767 *'path'* *'pa'* *E343* *E345* *E347*
4768'path' 'pa' string (default on Unix: ".,/usr/include,,"
4769 on OS/2: ".,/emx/include,,"
4770 other systems: ".,,")
4771 global or local to buffer |global-local|
4772 {not in Vi}
4773 This is a list of directories which will be searched when using the
4774 |gf|, [f, ]f, ^Wf, |:find| and other commands, provided that the file
4775 being searched for has a relative path (not starting with '/'). The
4776 directories in the 'path' option may be relative or absolute.
4777 - Use commas to separate directory names: >
4778 :set path=.,/usr/local/include,/usr/include
4779< - Spaces can also be used to separate directory names (for backwards
4780 compatibility with version 3.0). To have a space in a directory
4781 name, precede it with an extra backslash, and escape the space: >
4782 :set path=.,/dir/with\\\ space
4783< - To include a comma in a directory name precede it with an extra
4784 backslash: >
4785 :set path=.,/dir/with\\,comma
4786< - To search relative to the directory of the current file, use: >
4787 :set path=.
4788< - To search in the current directory use an empty string between two
4789 commas: >
4790 :set path=,,
4791< - A directory name may end in a ':' or '/'.
4792 - Environment variables are expanded |:set_env|.
4793 - When using |netrw.vim| URLs can be used. For example, adding
4794 "http://www.vim.org" will make ":find index.html" work.
4795 - Search upwards and downwards in a directory tree:
4796 1) "*" matches a sequence of characters, e.g.: >
4797 :set path=/usr/include/*
4798< means all subdirectories in /usr/include (but not /usr/include
4799 itself). >
4800 :set path=/usr/*c
4801< matches /usr/doc and /usr/src.
4802 2) "**" matches a subtree, up to 100 directories deep. Example: >
4803 :set path=/home/user_x/src/**
4804< means search in the whole subtree under "/home/usr_x/src".
4805 3) If the path ends with a ';', this path is the startpoint
4806 for upward search.
4807 See |file-searching| for more info and exact syntax.
4808 {not available when compiled without the |+path_extra| feature}
4809 - Careful with '\' characters, type two to get one in the option: >
4810 :set path=.,c:\\include
4811< Or just use '/' instead: >
4812 :set path=.,c:/include
4813< Don't forget "." or files won't even be found in the same directory as
4814 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004815 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00004816 it is something like 256 or 1024 characters.
4817 You can check if all the include files are found, using the value of
4818 'path', see |:checkpath|.
4819 The use of |:set+=| and |:set-=| is preferred when adding or removing
4820 directories from the list. This avoids problems when a future version
4821 uses another default. To remove the current directory use: >
4822 :set path-=
4823< To add the current directory use: >
4824 :set path+=
4825< To use an environment variable, you probably need to replace the
4826 separator. Here is an example to append $INCL, in which directory
4827 names are separated with a semi-colon: >
4828 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
4829< Replace the ';' with a ':' or whatever separator is used. Note that
4830 this doesn't work when $INCL contains a comma or white space.
4831
4832 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
4833'preserveindent' 'pi' boolean (default off)
4834 local to buffer
4835 {not in Vi}
4836 When changing the indent of the current line, preserve as much of the
4837 indent structure as possible. Normally the indent is replaced by a
4838 series of tabs followed by spaces as required (unless |'expandtab'| is
4839 enabled, in which case only spaces are used). Enabling this option
4840 means the indent will preserve as many existing characters as possible
4841 for indenting, and only add additional tabs or spaces as required.
4842 NOTE: When using ">>" multiple times the resulting indent is a mix of
4843 tabs and spaces. You might not like this.
4844 NOTE: 'preserveindent' is reset when 'compatible' is set.
4845 Also see 'copyindent'.
4846 Use |:retab| to clean up white space.
4847
4848 *'previewheight'* *'pvh'*
4849'previewheight' 'pvh' number (default 12)
4850 global
4851 {not in Vi}
4852 {not available when compiled without the |+windows| or
4853 |+quickfix| feature}
4854 Default height for a preview window. Used for |:ptag| and associated
4855 commands. Used for |CTRL-W_}| when no count is given.
4856
4857 *'previewwindow'* *'nopreviewwindow'*
4858 *'pvw'* *'nopvw'* *E590*
4859'previewwindow' 'pvw' boolean (default off)
4860 local to window
4861 {not in Vi}
4862 {not available when compiled without the |+windows| or
4863 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004864 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00004865 set. It's normally not set directly, but by using one of the commands
4866 |:ptag|, |:pedit|, etc.
4867
4868 *'printdevice'* *'pdev'*
4869'printdevice' 'pdev' string (default empty)
4870 global
4871 {not in Vi}
4872 {only available when compiled with the |+printer|
4873 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004874 The name of the printer to be used for |:hardcopy|.
4875 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004876 This option cannot be set from a |modeline| or in the |sandbox|, for
4877 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004878
Bram Moolenaar8299df92004-07-10 09:47:34 +00004879 *'printencoding'* *'penc'*
4880'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004881 global
4882 {not in Vi}
4883 {only available when compiled with the |+printer|
4884 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004885 Sets the character encoding used when printing.
4886 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004887
4888 *'printexpr'* *'pexpr'*
4889'printexpr' 'pexpr' String (default: see below)
4890 global
4891 {not in Vi}
4892 {only available when compiled with the |+printer|
4893 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004894 Expression used to print the PostScript produced with |:hardcopy|.
4895 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004896
Bram Moolenaar8299df92004-07-10 09:47:34 +00004897 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004898'printfont' 'pfn' string (default "courier")
4899 global
4900 {not in Vi}
4901 {only available when compiled with the |+printer|
4902 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004903 The name of the font that will be used for |:hardcopy|.
4904 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004905
4906 *'printheader'* *'pheader'*
4907'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
4908 global
4909 {not in Vi}
4910 {only available when compiled with the |+printer|
4911 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004912 The format of the header produced in |:hardcopy| output.
4913 See |pheader-option|.
4914
4915 *'printmbcharset'* *'pmbcs'*
4916'printmbcharset' 'pmbcs' string (default "")
4917 global
4918 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004919 {only available when compiled with the |+printer|,
4920 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004921 The CJK character set to be used for CJK output from |:hardcopy|.
4922 See |pmbcs-option|.
4923
4924 *'printmbfont'* *'pmbfn'*
4925'printmbfont' 'pmbfn' string (default "")
4926 global
4927 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004928 {only available when compiled with the |+printer|,
4929 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004930 List of font names to be used for CJK output from |:hardcopy|.
4931 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004932
4933 *'printoptions'* *'popt'*
4934'printoptions' 'popt' string (default "")
4935 global
4936 {not in Vi}
4937 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004938 List of items that control the format of the output of |:hardcopy|.
4939 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004940
Bram Moolenaar26a60b42005-02-22 08:49:11 +00004941 *'prompt'* *'noprompt'*
4942'prompt' boolean (default on)
4943 global
4944 When on a ":" prompt is used in Ex mode.
4945
Bram Moolenaar677ee682005-01-27 14:41:15 +00004946 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004947'quoteescape' 'qe' string (default "\")
4948 local to buffer
4949 {not in Vi}
4950 The characters that are used to escape quotes in a string. Used for
4951 objects like a', a" and a` |a'|.
4952 When one of the characters in this option is found inside a string,
4953 the following character will be skipped. The default value makes the
4954 text "foo\"bar\\" considered to be one string.
4955
Bram Moolenaar071d4272004-06-13 20:20:40 +00004956 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
4957'readonly' 'ro' boolean (default off)
4958 local to buffer
4959 If on, writes fail unless you use a '!'. Protects you from
4960 accidentally overwriting a file. Default on when Vim is started
4961 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004962 When using ":w!" the 'readonly' option is reset for the current
4963 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004964 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004965 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004966
4967 *'remap'* *'noremap'*
4968'remap' boolean (default on)
4969 global
4970 Allows for mappings to work recursively. If you do not want this for
4971 a single entry, use the :noremap[!] command.
4972
4973 *'report'*
4974'report' number (default 2)
4975 global
4976 Threshold for reporting number of lines changed. When the number of
4977 changed lines is more than 'report' a message will be given for most
4978 ":" commands. If you want it always, set 'report' to 0.
4979 For the ":substitute" command the number of substitutions is used
4980 instead of the number of lines.
4981
4982 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
4983'restorescreen' 'rs' boolean (default on)
4984 global
4985 {not in Vi} {only in Windows 95/NT console version}
4986 When set, the screen contents is restored when exiting Vim. This also
4987 happens when executing external commands.
4988
4989 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
4990 options in your .vimrc. To disable restoring:
4991 set t_ti= t_te=
4992 To enable restoring (for an xterm):
4993 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
4994 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
4995
4996 *'revins'* *'ri'* *'norevins'* *'nori'*
4997'revins' 'ri' boolean (default off)
4998 global
4999 {not in Vi}
5000 {only available when compiled with the |+rightleft|
5001 feature}
5002 Inserting characters in Insert mode will work backwards. See "typing
5003 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5004 command in Insert mode, when 'allowrevins' is set.
5005 NOTE: This option is reset when 'compatible' or 'paste' is set.
5006
5007 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5008'rightleft' 'rl' boolean (default off)
5009 local to window
5010 {not in Vi}
5011 {only available when compiled with the |+rightleft|
5012 feature}
5013 When on, display orientation becomes right-to-left, i.e., characters
5014 that are stored in the file appear from the right to the left.
5015 Using this option, it is possible to edit files for languages that
5016 are written from the right to the left such as Hebrew and Arabic.
5017 This option is per window, so it is possible to edit mixed files
5018 simultaneously, or to view the same file in both ways (this is
5019 useful whenever you have a mixed text file with both right-to-left
5020 and left-to-right strings so that both sets are displayed properly
5021 in different windows). Also see |rileft.txt|.
5022
5023 *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'*
5024'rightleftcmd' 'rlc' string (default "search")
5025 local to window
5026 {not in Vi}
5027 {only available when compiled with the |+rightleft|
5028 feature}
5029 Each word in this option enables the command line editing to work in
5030 right-to-left mode for a group of commands:
5031
5032 search "/" and "?" commands
5033
5034 This is useful for languages such as Hebrew, Arabic and Farsi.
5035 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5036
5037 *'ruler'* *'ru'* *'noruler'* *'noru'*
5038'ruler' 'ru' boolean (default off)
5039 global
5040 {not in Vi}
5041 {not available when compiled without the
5042 |+cmdline_info| feature}
5043 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005044 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005045 text in the file is shown on the far right:
5046 Top first line is visible
5047 Bot last line is visible
5048 All first and last line are visible
5049 45% relative position in the file
5050 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005051 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005052 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005053 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005054 this option takes precedence over 'ruler' and 'rulerformat'
5055 If the number of characters displayed is different from the number of
5056 bytes in the text (e.g., for a TAB or a multi-byte character), both
5057 the text column (byte number) and the screen column are shown,
5058 separated with a dash.
5059 For an empty line "0-1" is shown.
5060 For an empty buffer the line number will also be zero: "0,0-1".
5061 This option is reset when the 'paste' option is set.
5062 If you don't want to see the ruler all the time but want to know where
5063 you are, use "g CTRL-G" |g_CTRL-G|.
5064 NOTE: This option is reset when 'compatible' is set.
5065
5066 *'rulerformat'* *'ruf'*
5067'rulerformat' 'ruf' string (default empty)
5068 global
5069 {not in Vi}
5070 {not available when compiled without the |+statusline|
5071 feature}
5072 When this option is not empty, it determines the content of the ruler
5073 string, as displayed for the 'ruler' option.
5074 The format of this option, is like that of 'statusline'.
5075 The default ruler width is 17 characters. To make the ruler 15
5076 characters wide, put "%15(" at the start and "%)" at the end.
5077 Example: >
5078 :set rulerformat=%15(%c%V\ %p%%%)
5079<
5080 *'runtimepath'* *'rtp'* *vimfiles*
5081'runtimepath' 'rtp' string (default:
5082 Unix: "$HOME/.vim,
5083 $VIM/vimfiles,
5084 $VIMRUNTIME,
5085 $VIM/vimfiles/after,
5086 $HOME/.vim/after"
5087 Amiga: "home:vimfiles,
5088 $VIM/vimfiles,
5089 $VIMRUNTIME,
5090 $VIM/vimfiles/after,
5091 home:vimfiles/after"
5092 PC, OS/2: "$HOME/vimfiles,
5093 $VIM/vimfiles,
5094 $VIMRUNTIME,
5095 $VIM/vimfiles/after,
5096 $HOME/vimfiles/after"
5097 Macintosh: "$VIM:vimfiles,
5098 $VIMRUNTIME,
5099 $VIM:vimfiles:after"
5100 RISC-OS: "Choices:vimfiles,
5101 $VIMRUNTIME,
5102 Choices:vimfiles/after"
5103 VMS: "sys$login:vimfiles,
5104 $VIM/vimfiles,
5105 $VIMRUNTIME,
5106 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005107 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005108 global
5109 {not in Vi}
5110 This is a list of directories which will be searched for runtime
5111 files:
5112 filetype.vim filetypes by file name |new-filetype|
5113 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005114 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005115 colors/ color scheme files |:colorscheme|
5116 compiler/ compiler files |:compiler|
5117 doc/ documentation |write-local-help|
5118 ftplugin/ filetype plugins |write-filetype-plugin|
5119 indent/ indent scripts |indent-expression|
5120 keymap/ key mapping files |mbyte-keymap|
5121 lang/ menu translations |:menutrans|
5122 menu.vim GUI menus |menu.vim|
5123 plugin/ plugin scripts |write-plugin|
5124 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005125 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005126 syntax/ syntax files |mysyntaxfile|
5127 tutor/ files for vimtutor |tutor|
5128
5129 And any other file searched for with the |:runtime| command.
5130
5131 The defaults for most systems are setup to search five locations:
5132 1. In your home directory, for your personal preferences.
5133 2. In a system-wide Vim directory, for preferences from the system
5134 administrator.
5135 3. In $VIMRUNTIME, for files distributed with Vim.
5136 *after-directory*
5137 4. In the "after" directory in the system-wide Vim directory. This is
5138 for the system administrator to overrule or add to the distributed
5139 defaults (rarely needed)
5140 5. In the "after" directory in your home directory. This is for
5141 personal preferences to overrule or add to the distributed defaults
5142 or system-wide settings (rarely needed).
5143
5144 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5145 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005146 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005147 wildcards.
5148 See |:runtime|.
5149 Example: >
5150 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5151< This will use the directory "~/vimruntime" first (containing your
5152 personal Vim runtime files), then "/mygroup/vim" (shared between a
5153 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5154 files).
5155 You probably should always include $VIMRUNTIME somewhere, to use the
5156 distributed runtime files. You can put a directory before $VIMRUNTIME
5157 to find files which replace a distributed runtime files. You can put
5158 a directory after $VIMRUNTIME to find files which add to distributed
5159 runtime files.
5160 This option cannot be set from a |modeline| or in the |sandbox|, for
5161 security reasons.
5162
5163 *'scroll'* *'scr'*
5164'scroll' 'scr' number (default: half the window height)
5165 local to window
5166 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5167 set to half the number of lines in the window when the window size
5168 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005169 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005170 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5171 the number of screen lines instead of file lines, makes a difference
5172 when lines wrap}
5173
5174 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5175'scrollbind' 'scb' boolean (default off)
5176 local to window
5177 {not in Vi}
5178 {not available when compiled without the |+scrollbind|
5179 feature}
5180 See also |scroll-binding|. When this option is set, the current
5181 window scrolls as other scrollbind windows (windows that also have
5182 this option set) scroll. This option is useful for viewing the
5183 differences between two versions of a file, see 'diff'.
5184 See |'scrollopt'| for options that determine how this option should be
5185 interpreted.
5186 This option is mostly reset when splitting a window to edit another
5187 file. This means that ":split | edit file" results in two windows
5188 with scroll-binding, but ":split file" does not.
5189
5190 *'scrolljump'* *'sj'*
5191'scrolljump' 'sj' number (default 1)
5192 global
5193 {not in Vi}
5194 Minimal number of lines to scroll when the cursor gets off the
5195 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5196 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005197 When set to a negative number from -1 to -100 this is used as the
5198 percentage of the window height. Thus -50 scrolls half the window
5199 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005200 NOTE: This option is set to 1 when 'compatible' is set.
5201
5202 *'scrolloff'* *'so'*
5203'scrolloff' 'so' number (default 0)
5204 global
5205 {not in Vi}
5206 Minimal number of screen lines to keep above and below the cursor.
5207 This will make some context visible around where you are working. If
5208 you set it to a very large value (999) the cursor line will always be
5209 in the middle of the window (except at the start or end of the file or
5210 when long lines wrap).
5211 For scrolling horizontally see 'sidescrolloff'.
5212 NOTE: This option is set to 0 when 'compatible' is set.
5213
5214 *'scrollopt'* *'sbo'*
5215'scrollopt' 'sbo' string (default "ver,jump")
5216 global
5217 {not available when compiled without the |+scrollbind|
5218 feature}
5219 {not in Vi}
5220 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005221 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5222 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005223 The following words are available:
5224 ver Bind vertical scrolling for 'scrollbind' windows
5225 hor Bind horizontal scrolling for 'scrollbind' windows
5226 jump Applies to the offset between two windows for vertical
5227 scrolling. This offset is the difference in the first
5228 displayed line of the bound windows. When moving
5229 around in a window, another 'scrollbind' window may
5230 reach a position before the start or after the end of
5231 the buffer. The offset is not changed though, when
5232 moving back the 'scrollbind' window will try to scroll
5233 to the desired position when possible.
5234 When now making that window the current one, two
5235 things can be done with the relative offset:
5236 1. When "jump" is not included, the relative offset is
5237 adjusted for the scroll position in the new current
5238 window. When going back to the other window, the
5239 the new relative offset will be used.
5240 2. When "jump" is included, the other windows are
5241 scrolled to keep the same relative offset. When
5242 going back to the other window, it still uses the
5243 same relative offset.
5244 Also see |scroll-binding|.
5245
5246 *'sections'* *'sect'*
5247'sections' 'sect' string (default "SHNHH HUnhsh")
5248 global
5249 Specifies the nroff macros that separate sections. These are pairs of
5250 two letters (See |object-motions|). The default makes a section start
5251 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5252
5253 *'secure'* *'nosecure'* *E523*
5254'secure' boolean (default off)
5255 global
5256 {not in Vi}
5257 When on, ":autocmd", shell and write commands are not allowed in
5258 ".vimrc" and ".exrc" in the current directory and map commands are
5259 displayed. Switch it off only if you know that you will not run into
5260 problems, or when the 'exrc' option is off. On Unix this option is
5261 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005262 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005263 'secure' at the end of your ~/.vimrc then.
5264 This option cannot be set from a |modeline| or in the |sandbox|, for
5265 security reasons.
5266
5267 *'selection'* *'sel'*
5268'selection' 'sel' string (default "inclusive")
5269 global
5270 {not in Vi}
5271 This option defines the behavior of the selection. It is only used
5272 in Visual and Select mode.
5273 Possible values:
5274 value past line inclusive ~
5275 old no yes
5276 inclusive yes yes
5277 exclusive yes no
5278 "past line" means that the cursor is allowed to be positioned one
5279 character past the line.
5280 "inclusive" means that the last character of the selection is included
5281 in an operation. For example, when "x" is used to delete the
5282 selection.
5283 Note that when "exclusive" is used and selecting from the end
5284 backwards, you cannot include the last character of a line, when
5285 starting in Normal mode and 'virtualedit' empty.
5286
5287 The 'selection' option is set by the |:behave| command.
5288
5289 *'selectmode'* *'slm'*
5290'selectmode' 'slm' string (default "")
5291 global
5292 {not in Vi}
5293 This is a comma separated list of words, which specifies when to start
5294 Select mode instead of Visual mode, when a selection is started.
5295 Possible values:
5296 mouse when using the mouse
5297 key when using shifted special keys
5298 cmd when using "v", "V" or CTRL-V
5299 See |Select-mode|.
5300 The 'selectmode' option is set by the |:behave| command.
5301
5302 *'sessionoptions'* *'ssop'*
5303'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
5304 help,options,winsize")
5305 global
5306 {not in Vi}
5307 {not available when compiled without the +mksession
5308 feature}
5309 Changes the effect of the |:mksession| command. It is a comma
5310 separated list of words. Each word enables saving and restoring
5311 something:
5312 word save and restore ~
5313 blank empty windows
5314 buffers hidden and unloaded buffers, not just those in windows
5315 curdir the current directory
5316 folds manually created folds, opened/closed folds and local
5317 fold options
5318 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005319 and contain at least one lowercase letter. Only
5320 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005321 help the help window
5322 localoptions options and mappings local to a window or buffer (not
5323 global values for local options)
5324 options all options and mappings (also global values for local
5325 options)
5326 resize size of the Vim window: 'lines' and 'columns'
5327 sesdir the directory in which the session file is located
5328 will become the current directory (useful with
5329 projects accessed over a network from different
5330 systems)
5331 slash backslashes in file names replaced with forward
5332 slashes
5333 unix with Unix end-of-line format (single <NL>), even when
5334 on Windows or DOS
5335 winpos position of the whole Vim window
5336 winsize window sizes
5337
5338 Don't include both "curdir" and "sesdir".
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00005339 There is no option to include tab pages yet, only the current tab page
5340 is stored in the session. |tab-page|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005341 When "curdir" nor "sesdir" is included, file names are stored with
5342 absolute paths.
5343 "slash" and "unix" are useful on Windows when sharing session files
5344 with Unix. The Unix version of Vim cannot source dos format scripts,
5345 but the Windows version of Vim can source unix format scripts.
5346
5347 *'shell'* *'sh'* *E91*
5348'shell' 'sh' string (default $SHELL or "sh",
5349 MS-DOS and Win32: "command.com" or
5350 "cmd.exe", OS/2: "cmd")
5351 global
5352 Name of the shell to use for ! and :! commands. When changing the
5353 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5354 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005355 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005356 See |option-backslash| about including spaces and backslashes.
5357 Environment variables are expanded |:set_env|.
5358 If the name of the shell contains a space, you might need to enclose
5359 it in quotes. Example: >
5360 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5361< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005362 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005363 "-f" is not inside the quotes, because it is not part of the command
5364 name. And Vim automagically recognizes the backslashes that are path
5365 separators.
5366 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5367 variable to change the way external commands are executed. See the
5368 libc.inf file of DJGPP.
5369 Under MS-Windows, when the executable ends in ".com" it must be
5370 included. Thus setting the shell to "command.com" or "4dos.com"
5371 works, but "command" and "4dos" do not work for all commands (e.g.,
5372 filtering).
5373 For unknown reasons, when using "4dos.com" the current directory is
5374 changed to "C:\". To avoid this set 'shell' like this: >
5375 :set shell=command.com\ /c\ 4dos
5376< This option cannot be set from a |modeline| or in the |sandbox|, for
5377 security reasons.
5378
5379 *'shellcmdflag'* *'shcf'*
5380'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5381 does not contain "sh" somewhere: "/c")
5382 global
5383 {not in Vi}
5384 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5385 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5386 systems, the default is set according to the value of 'shell', to
5387 reduce the need to set this option by the user. It's not used for
5388 OS/2 (EMX figures this out itself). See |option-backslash| about
5389 including spaces and backslashes. See |dos-shell|.
5390 This option cannot be set from a |modeline| or in the |sandbox|, for
5391 security reasons.
5392
5393 *'shellpipe'* *'sp'*
5394'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5395 global
5396 {not in Vi}
5397 {not available when compiled without the |+quickfix|
5398 feature}
5399 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005400 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005401 including spaces and backslashes.
5402 The name of the temporary file can be represented by "%s" if necessary
5403 (the file name is appended automatically if no %s appears in the value
5404 of this option).
5405 For the Amiga and MS-DOS the default is ">". The output is directly
5406 saved in a file and not echoed to the screen.
5407 For Unix the default it "| tee". The stdout of the compiler is saved
5408 in a file and echoed to the screen. If the 'shell' option is "csh" or
5409 "tcsh" after initializations, the default becomes "|& tee". If the
5410 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
5411 "2>&1| tee". This means that stderr is also included.
5412 The initialization of this option is done after reading the ".vimrc"
5413 and the other initializations, so that when the 'shell' option is set
5414 there, the 'shellpipe' option changes automatically, unless it was
5415 explicitly set before.
5416 When 'shellpipe' is set to an empty string, no redirection of the
5417 ":make" output will be done. This is useful if you use a 'makeprg'
5418 that writes to 'makeef' by itself. If you want no piping, but do
5419 want to include the 'makeef', set 'shellpipe' to a single space.
5420 Don't forget to precede the space with a backslash: ":set sp=\ ".
5421 In the future pipes may be used for filtering and this option will
5422 become obsolete (at least for Unix).
5423 This option cannot be set from a |modeline| or in the |sandbox|, for
5424 security reasons.
5425
5426 *'shellquote'* *'shq'*
5427'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5428 contains "sh" somewhere: "\"")
5429 global
5430 {not in Vi}
5431 Quoting character(s), put around the command passed to the shell, for
5432 the "!" and ":!" commands. The redirection is kept outside of the
5433 quoting. See 'shellxquote' to include the redirection. It's
5434 probably not useful to set both options.
5435 This is an empty string by default. Only known to be useful for
5436 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5437 or bash, where it should be "\"". The default is adjusted according
5438 the value of 'shell', to reduce the need to set this option by the
5439 user. See |dos-shell|.
5440 This option cannot be set from a |modeline| or in the |sandbox|, for
5441 security reasons.
5442
5443 *'shellredir'* *'srr'*
5444'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5445 global
5446 {not in Vi}
5447 String to be used to put the output of a filter command in a temporary
5448 file. See also |:!|. See |option-backslash| about including spaces
5449 and backslashes.
5450 The name of the temporary file can be represented by "%s" if necessary
5451 (the file name is appended automatically if no %s appears in the value
5452 of this option).
5453 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5454 or "zsh" during initializations, the default becomes ">&". If the
5455 'shell' option is "sh", "ksh" or "bash" the default becomes
5456 ">%s 2>&1". This means that stderr is also included.
5457 For Win32, the Unix checks are done and additionally "cmd" is checked
5458 for, which makes the default ">%s 2>&1". Also, the same names with
5459 ".exe" appended are checked for.
5460 The initialization of this option is done after reading the ".vimrc"
5461 and the other initializations, so that when the 'shell' option is set
5462 there, the 'shellredir' option changes automatically unless it was
5463 explicitly set before.
5464 In the future pipes may be used for filtering and this option will
5465 become obsolete (at least for Unix).
5466 This option cannot be set from a |modeline| or in the |sandbox|, for
5467 security reasons.
5468
5469 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5470'shellslash' 'ssl' boolean (default off)
5471 global
5472 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5473 When set, a forward slash is used when expanding file names. This is
5474 useful when a Unix-like shell is used instead of command.com or
5475 cmd.exe. Backward slashes can still be typed, but they are changed to
5476 forward slashes by Vim.
5477 Note that setting or resetting this option has no effect for some
5478 existing file names, thus this option needs to be set before opening
5479 any file for best results. This might change in the future.
5480 'shellslash' only works when a backslash can be used as a path
5481 separator. To test if this is so use: >
5482 if exists('+shellslash')
5483<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005484 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5485'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5486 global
5487 {not in Vi}
5488 When on, use temp files for shell commands. When off use a pipe.
5489 When using a pipe is not possible temp files are used anyway.
5490 Currently a pipe is only supported on Unix. You can check it with: >
5491 :if has("filterpipe")
5492< The advantage of using a pipe is that nobody can read the temp file
5493 and the 'shell' command does not need to support redirection.
5494 The advantage of using a temp file is that the file type and encoding
5495 can be detected.
5496 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5497 |FilterWritePost| autocommands event are not triggered when
5498 'shelltemp' is off.
5499
Bram Moolenaar071d4272004-06-13 20:20:40 +00005500 *'shelltype'* *'st'*
5501'shelltype' 'st' number (default 0)
5502 global
5503 {not in Vi} {only for the Amiga}
5504 On the Amiga this option influences the way how the commands work
5505 which use a shell.
5506 0 and 1: always use the shell
5507 2 and 3: use the shell only to filter lines
5508 4 and 5: use shell only for ':sh' command
5509 When not using the shell, the command is executed directly.
5510
5511 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5512 1 and 3: use "shell cmd" to start external commands
5513
5514 *'shellxquote'* *'sxq'*
5515'shellxquote' 'sxq' string (default: "";
5516 for Win32, when 'shell' contains "sh"
5517 somewhere: "\""
5518 for Unix, when using system(): "\"")
5519 global
5520 {not in Vi}
5521 Quoting character(s), put around the command passed to the shell, for
5522 the "!" and ":!" commands. Includes the redirection. See
5523 'shellquote' to exclude the redirection. It's probably not useful
5524 to set both options.
5525 This is an empty string by default. Known to be useful for
5526 third-party shells when using the Win32 version, such as the MKS Korn
5527 Shell or bash, where it should be "\"". The default is adjusted
5528 according the value of 'shell', to reduce the need to set this option
5529 by the user. See |dos-shell|.
5530 This option cannot be set from a |modeline| or in the |sandbox|, for
5531 security reasons.
5532
5533 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5534'shiftround' 'sr' boolean (default off)
5535 global
5536 {not in Vi}
5537 Round indent to multiple of 'shiftwidth'. Applies to > and <
5538 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5539 a multiple of 'shiftwidth' (this is Vi compatible).
5540 NOTE: This option is reset when 'compatible' is set.
5541
5542 *'shiftwidth'* *'sw'*
5543'shiftwidth' 'sw' number (default 8)
5544 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005545 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005546 |'cindent'|, |>>|, |<<|, etc.
5547
5548 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005549'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
5550 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005551 global
5552 {not in Vi}
5553 This option helps to avoid all the |hit-enter| prompts caused by file
5554 messages, for example with CTRL-G, and to avoid some other messages.
5555 It is a list of flags:
5556 flag meaning when present ~
5557 f use "(3 of 5)" instead of "(file 3 of 5)"
5558 i use "[noeol]" instead of "[Incomplete last line]"
5559 l use "999L, 888C" instead of "999 lines, 888 characters"
5560 m use "[+]" instead of "[Modified]"
5561 n use "[New]" instead of "[New File]"
5562 r use "[RO]" instead of "[readonly]"
5563 w use "[w]" instead of "written" for file write message
5564 and "[a]" instead of "appended" for ':w >> file' command
5565 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5566 "[unix format]" and "[mac]" instead of "[mac format]".
5567 a all of the above abbreviations
5568
5569 o overwrite message for writing a file with subsequent message
5570 for reading a file (useful for ":wn" or when 'autowrite' on)
5571 O message for reading a file overwrites any previous message.
5572 Also for quickfix message (e.g., ":cn").
5573 s don't give "search hit BOTTOM, continuing at TOP" or "search
5574 hit TOP, continuing at BOTTOM" messages
5575 t truncate file message at the start if it is too long to fit
5576 on the command-line, "<" will appear in the left most column.
5577 Ignored in Ex mode.
5578 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00005579 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005580 Ignored in Ex mode.
5581 W don't give "written" or "[w]" when writing a file
5582 A don't give the "ATTENTION" message when an existing swap file
5583 is found.
5584 I don't give the intro message when starting Vim |:intro|.
5585
5586 This gives you the opportunity to avoid that a change between buffers
5587 requires you to hit <Enter>, but still gives as useful a message as
5588 possible for the space available. To get the whole message that you
5589 would have got with 'shm' empty, use ":file!"
5590 Useful values:
5591 shm= No abbreviation of message.
5592 shm=a Abbreviation, but no loss of information.
5593 shm=at Abbreviation, and truncate message when necessary.
5594
5595 NOTE: This option is set to the Vi default value when 'compatible' is
5596 set and to the Vim default value when 'compatible' is reset.
5597
5598 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
5599'shortname' 'sn' boolean (default off)
5600 local to buffer
5601 {not in Vi, not in MS-DOS versions}
5602 Filenames are assumed to be 8 characters plus one extension of 3
5603 characters. Multiple dots in file names are not allowed. When this
5604 option is on, dots in file names are replaced with underscores when
5605 adding an extension (".~" or ".swp"). This option is not available
5606 for MS-DOS, because then it would always be on. This option is useful
5607 when editing files on an MS-DOS compatible filesystem, e.g., messydos
5608 or crossdos. When running the Win32 GUI version under Win32s, this
5609 option is always on by default.
5610
5611 *'showbreak'* *'sbr'* *E595*
5612'showbreak' 'sbr' string (default "")
5613 global
5614 {not in Vi}
5615 {not available when compiled without the |+linebreak|
5616 feature}
5617 String to put at the start of lines that have been wrapped. Useful
5618 values are "> " or "+++ ".
5619 Only printable single-cell characters are allowed, excluding <Tab> and
5620 comma (in a future version the comma might be used to separate the
5621 part that is shown at the end and at the start of a line).
5622 The characters are highlighted according to the '@' flag in
5623 'highlight'.
5624 Note that tabs after the showbreak will be displayed differently.
5625 If you want the 'showbreak' to appear in between line numbers, add the
5626 "n" flag to 'cpoptions'.
5627
5628 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
5629'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
5630 off)
5631 global
5632 {not in Vi}
5633 {not available when compiled without the
5634 |+cmdline_info| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005635 Show (partial) command in status line. Set this option off if your
Bram Moolenaar071d4272004-06-13 20:20:40 +00005636 terminal is slow.
5637 In Visual mode the size of the selected area is shown:
5638 - When selecting characters within a line, the number of characters.
5639 - When selecting more than one line, the number of lines.
5640 - When selecting a block, the size in screen characters: linesxcolumns.
5641 NOTE: This option is set to the Vi default value when 'compatible' is
5642 set and to the Vim default value when 'compatible' is reset.
5643
5644 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
5645'showfulltag' 'sft' boolean (default off)
5646 global
5647 {not in Vi}
5648 When completing a word in insert mode (see |ins-completion|) from the
5649 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005650 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00005651 matched a C function, you can see a template for what arguments are
5652 required (coding style permitting).
5653
5654 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
5655'showmatch' 'sm' boolean (default off)
5656 global
5657 When a bracket is inserted, briefly jump to the matching one. The
5658 jump is only done if the match can be seen on the screen. The time to
5659 show the match can be set with 'matchtime'.
5660 A Beep is given if there is no match (no matter if the match can be
5661 seen or not). This option is reset when the 'paste' option is set.
5662 When the 'm' flag is not included in 'cpoptions', typing a character
5663 will immediately move the cursor back to where it belongs.
5664 See the "sm" field in 'guicursor' for setting the cursor shape and
5665 blinking when showing the match.
5666 The 'matchpairs' option can be used to specify the characters to show
5667 matches for. 'rightleft' and 'revins' are used to look for opposite
5668 matches.
5669 Note: For the use of the short form parental guidance is advised.
5670
5671 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
5672'showmode' 'smd' boolean (Vim default: on, Vi default: off)
5673 global
5674 If in Insert, Replace or Visual mode put a message on the last line.
5675 Use the 'M' flag in 'highlight' to set the type of highlighting for
5676 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005677 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005678 doesn't mean XIM is really active, especially when 'imactivatekey' is
5679 not set.
5680 NOTE: This option is set to the Vi default value when 'compatible' is
5681 set and to the Vim default value when 'compatible' is reset.
5682
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00005683 *'showtabline'* *'stal'*
5684'showtabline' 'stal' number (default 1)
5685 global
5686 {not in Vi}
5687 {not available when compiled without the +windows
5688 feature}
5689 The value of this option specifies when the line with tab page labels
5690 will be displayed:
5691 0: never
5692 1: only if there are at least two tab pages
5693 2: always
5694 This is both for the GUI and non-GUI implementation of the tab pages
5695 line.
5696 See |tab-page| for more information about tab pages.
5697
Bram Moolenaar071d4272004-06-13 20:20:40 +00005698 *'sidescroll'* *'ss'*
5699'sidescroll' 'ss' number (default 0)
5700 global
5701 {not in Vi}
5702 The minimal number of columns to scroll horizontally. Used only when
5703 the 'wrap' option is off and the cursor is moved off of the screen.
5704 When it is zero the cursor will be put in the middle of the screen.
5705 When using a slow terminal set it to a large number or 0. When using
5706 a fast terminal use a small number or 1. Not used for "zh" and "zl"
5707 commands.
5708
5709 *'sidescrolloff'* *'siso'*
5710'sidescrolloff' 'siso' number (default 0)
5711 global
5712 {not in Vi}
5713 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00005714 right of the cursor if 'nowrap' is set. Setting this option to a
5715 value greater than 0 while having |'sidescroll'| also at a non-zero
5716 value makes some context visible in the line you are scrolling in
5717 horizontally (except at beginning of the line). Setting this option
5718 to a large value (like 999) has the effect of keeping the cursor
5719 horizontally centered in the window, as long as one does not come too
5720 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005721 NOTE: This option is set to 0 when 'compatible' is set.
5722
5723 Example: Try this together with 'sidescroll' and 'listchars' as
5724 in the following example to never allow the cursor to move
5725 onto the "extends" character:
5726
5727 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
5728 :set sidescrolloff=1
5729
5730
5731 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
5732'smartcase' 'scs' boolean (default off)
5733 global
5734 {not in Vi}
5735 Override the 'ignorecase' option if the search pattern contains upper
5736 case characters. Only used when the search pattern is typed and
5737 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005738 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00005739 "*" and "#" you can make 'smartcase' used by doing a "/" command,
5740 recalling the search pattern from history and hitting <Enter>.
5741 NOTE: This option is reset when 'compatible' is set.
5742
5743 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
5744'smartindent' 'si' boolean (default off)
5745 local to buffer
5746 {not in Vi}
5747 {not available when compiled without the
5748 |+smartindent| feature}
5749 Do smart autoindenting when starting a new line. Works for C-like
5750 programs, but can also be used for other languages. 'cindent' does
5751 something like this, works better in most cases, but is more strict,
5752 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
5753 'indentexpr' is a more advanced alternative.
5754 Normally 'autoindent' should also be on when using 'smartindent'.
5755 An indent is automatically inserted:
5756 - After a line ending in '{'.
5757 - After a line starting with a keyword from 'cinwords'.
5758 - Before a line starting with '}' (only with the "O" command).
5759 When typing '}' as the first character in a new line, that line is
5760 given the same indent as the matching '{'.
5761 When typing '#' as the first character in a new line, the indent for
5762 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005763 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005764 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
5765 When using the ">>" command, lines starting with '#' are not shifted
5766 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005767 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005768 is set smart indenting is disabled.
5769
5770 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
5771'smarttab' 'sta' boolean (default off)
5772 global
5773 {not in Vi}
5774 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00005775 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
5776 <BS> will delete a 'shiftwidth' worth of space at the start of the
5777 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005778 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00005779 'softtabstop'. 'shiftwidth' is only used for shifting text left or
5780 right |shift-left-right|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005781 What gets inserted (a Tab or spaces) depends on the 'expandtab'
5782 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00005783 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005784 NOTE: This option is reset when 'compatible' is set.
5785
5786 *'softtabstop'* *'sts'*
5787'softtabstop' 'sts' number (default 0)
5788 local to buffer
5789 {not in Vi}
5790 Number of spaces that a <Tab> counts for while performing editing
5791 operations, like inserting a <Tab> or using <BS>. It "feels" like
5792 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
5793 used. This is useful to keep the 'ts' setting at its standard value
5794 of 8, while being able to edit like it is set to 'sts'. However,
5795 commands like "x" still work on the actual characters.
5796 When 'sts' is zero, this feature is off.
5797 'softtabstop' is set to 0 when the 'paste' option is set.
5798 See also |ins-expandtab|. When 'expandtab' is not set, the number of
5799 spaces is minimized by using <Tab>s.
5800 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
5801 set.
5802 NOTE: This option is set to 0 when 'compatible' is set.
5803
Bram Moolenaar217ad922005-03-20 22:37:15 +00005804 *'spell'* *'nospell'*
5805'spell' boolean (default off)
5806 local to window
5807 {not in Vi}
5808 {not available when compiled without the |+syntax|
5809 feature}
5810 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005811 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005812
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005813 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005814'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005815 local to buffer
5816 {not in Vi}
5817 {not available when compiled without the |+syntax|
5818 feature}
5819 Pattern to locate the end of a sentence. The following word will be
5820 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005821 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005822 When this check is not wanted make this option empty.
5823 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005824 Be careful with special characters, see |option-backslash| about
5825 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005826 To set this option automatically depending on the language, see
5827 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005828
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005829 *'spellfile'* *'spf'*
5830'spellfile' 'spf' string (default empty)
5831 local to buffer
5832 {not in Vi}
5833 {not available when compiled without the |+syntax|
5834 feature}
5835 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00005836 commands. It must end in ".{encoding}.add". You need to include the
5837 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005838 *E765*
5839 It may also be a comma separated list of names. A count before the
5840 |zg| and |zw| commands can be used to access each. This allows using
5841 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005842 When a word is added while this option is empty Vim will set it for
5843 you: Using the first "spell" directory in 'runtimepath' that is
Bram Moolenaar3b506942005-06-23 22:36:45 +00005844 writable and the first language name that appears in 'spelllang',
5845 ignoring the region.
5846 The resulting ".spl" file will be used for spell checking, it does not
5847 have to appear in 'spelllang'.
5848 Normally one file is used for all regions, but you can add the region
5849 name if you want to. However, it will then only be used when
5850 'spellfile' is set to it, for entries in 'spelllang' only files
5851 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00005852 This option cannot be set from a |modeline| or in the |sandbox|, for
5853 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005854
Bram Moolenaar217ad922005-03-20 22:37:15 +00005855 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005856'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00005857 local to buffer
5858 {not in Vi}
5859 {not available when compiled without the |+syntax|
5860 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00005861 A comma separated list of word list names. When the 'spell' option is
5862 on spellchecking will be done for these languages. Example: >
5863 set spelllang=en_us,nl,medical
5864< This means US English, Dutch and medical words are recognized. Words
5865 that are not recognized will be highlighted.
5866 The word list name must not include a comma or dot. Using a dash is
5867 recommended to separate the two letter language name from a
5868 specification. Thus "en-rare" is used for rare English words.
5869 A region name must come last and have the form "_xx", where "xx" is
5870 the two-letter, lower case region name. You can use more than one
5871 region by listing them: "en_us,en_ca" supports both US and Canadian
5872 English, but not words specific for Australia, New Zealand or Great
5873 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005874 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00005875 As a special case the name of a .spl file can be given as-is. The
5876 first "_xx" in the name is removed and used as the region name
5877 (_xx is an underscore, two letters and followed by a non-letter).
5878 This is mainly for testing purposes. You must make sure the correct
5879 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005880 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00005881 idea to set 'spelllang' after setting 'encoding' to avoid loading the
5882 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00005883 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005884
Bram Moolenaar98692072006-02-04 00:57:42 +00005885 If the |spellfile.vim| plugin is active and you use a language name
5886 for which Vim cannot find the .spl file in 'runtimepath' the plugin
5887 will ask you if you want to download the file.
5888
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005889 After this option has been set successfully, Vim will source the files
5890 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005891 up to the first comma, dot or underscore.
5892 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005893
5894
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005895 *'spellsuggest'* *'sps'*
5896'spellsuggest' 'sps' string (default "best")
5897 global
5898 {not in Vi}
5899 {not available when compiled without the |+syntax|
5900 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005901 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005902 the |spellsuggest()| function. This is a comma-separated list of
5903 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005904
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005905 best Internal method that works best for English. Finds
5906 changes like "fast" and uses a bit of sound-a-like
5907 scoring to improve the ordering.
5908
5909 double Internal method that uses two methods and mixes the
5910 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005911 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005912 word. That only works when the language specifies
5913 sound folding. Can be slow and doesn't always give
5914 better results.
5915
5916 fast Internal method that only checks for simple changes:
5917 character inserts/deletes/swaps. Works well for
5918 simple typing mistakes.
5919
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005920 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005921 Not used for |spellsuggest()|. The number of
5922 suggestions is never more than the value of 'lines'
5923 minus two.
5924
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005925 file:{filename} Read file {filename}, which must have two columns,
5926 separated by a slash. The first column contains the
5927 bad word, the second column the suggested good word.
5928 Example:
5929 theribal/terrible ~
5930 Use this for common mistakes that do not appear at the
5931 top of the suggestion list with the internal methods.
5932 Lines without a slash are ignored, use this for
5933 comments.
5934 The file is used for all languages.
5935
5936 expr:{expr} Evaluate expression {expr}. Use a function to avoid
5937 trouble with spaces. |v:val| holds the badly spelled
5938 word. The expression must evaluate to a List of
5939 Lists, each with a suggestion and a score.
5940 Example:
5941 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005942 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005943 internal methods use. A lower score is better.
5944 This may invoke |spellsuggest()| if you temporarily
5945 set 'spellsuggest' to exclude the "expr:" part.
5946 Errors are silently ignored, unless you set the
5947 'verbose' option to a non-zero value.
5948
5949 Only one of "best", "double" or "fast" may be used. The others may
5950 appear several times in any order. Example: >
5951 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
5952<
5953 This option cannot be set from a |modeline| or in the |sandbox|, for
5954 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005955
5956
Bram Moolenaar071d4272004-06-13 20:20:40 +00005957 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
5958'splitbelow' 'sb' boolean (default off)
5959 global
5960 {not in Vi}
5961 {not available when compiled without the +windows
5962 feature}
5963 When on, splitting a window will put the new window below the current
5964 one. |:split|
5965
5966 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
5967'splitright' 'spr' boolean (default off)
5968 global
5969 {not in Vi}
5970 {not available when compiled without the +vertsplit
5971 feature}
5972 When on, splitting a window will put the new window right of the
5973 current one. |:vsplit|
5974
5975 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
5976'startofline' 'sol' boolean (default on)
5977 global
5978 {not in Vi}
5979 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00005980 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005981 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00005982 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005983 with a linewise operator, with "%" with a count and to buffer changing
5984 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
5985 only has a line number, e.g., ":25" or ":+".
5986 In case of buffer changing commands the cursor is placed at the column
5987 where it was the last time the buffer was edited.
5988 NOTE: This option is set when 'compatible' is set.
5989
5990 *'statusline'* *'stl'* *E540* *E541* *E542*
5991'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00005992 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005993 {not in Vi}
5994 {not available when compiled without the |+statusline|
5995 feature}
5996 When nonempty, this option determines the content of the status line.
5997 Also see |status-line|.
5998
5999 The option consists of printf style '%' items interspersed with
6000 normal text. Each status line item is of the form:
6001 %-0{minwid}.{maxwid}{item}
6002 All fields except the {item} is optional. A single percent sign can
6003 be given as "%%". Up to 80 items can be specified.
6004
Bram Moolenaar238a5642006-02-21 22:12:05 +00006005 When the option starts with "%!" then it is used as an expression,
6006 evaluated and the result is used as the option value. Example: >
6007 :set statusline=%!MyStatusLine()
6008< The result can contain %{} items that will be evaluated too.
6009
6010 When there is error while evaluating the option then it will be made
6011 empty to avoid further errors. Otherwise screen updating would loop.
6012
Bram Moolenaar071d4272004-06-13 20:20:40 +00006013 Note that the only effect of 'ruler' when this option is set (and
6014 'laststatus' is 2) is controlling the output of |CTRL-G|.
6015
6016 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006017 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006018 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006019 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006020 minwid Minimum width of the item, padding as set by '-' & '0'.
6021 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006022 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006023 on the left for text items. Numeric items will be
6024 shifted down to maxwid-2 digits followed by '>'number
6025 where number is the amount of missing digits, much like
6026 an exponential notation.
6027 item A one letter code as described below.
6028
6029 Following is a description of the possible statusline items. The
6030 second character in "item" is the type:
6031 N for number
6032 S for string
6033 F for flags as described below
6034 - not applicable
6035
6036 item meaning ~
6037 f S Path to the file in the buffer, relative to current directory.
6038 F S Full path to the file in the buffer.
6039 t S File name (tail) of file in the buffer.
6040 m F Modified flag, text is " [+]"; " [-]" if 'modifiable' is off.
6041 M F Modified flag, text is ",+" or ",-".
6042 r F Readonly flag, text is " [RO]".
6043 R F Readonly flag, text is ",RO".
6044 h F Help buffer flag, text is " [help]".
6045 H F Help buffer flag, text is ",HLP".
6046 w F Preview window flag, text is " [Preview]".
6047 W F Preview window flag, text is ",PRV".
6048 y F Type of file in the buffer, e.g., " [vim]". See 'filetype'.
6049 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6050 {not available when compiled without |+autocmd| feature}
6051 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6052 being used: "<keymap>"
6053 n N Buffer number.
6054 b N Value of byte under cursor.
6055 B N As above, in hexadecimal.
6056 o N Byte number in file of byte under cursor, first byte is 1.
6057 Mnemonic: Offset from start of file (with one added)
6058 {not available when compiled without |+byte_offset| feature}
6059 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006060 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006061 l N Line number.
6062 L N Number of lines in buffer.
6063 c N Column number.
6064 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006065 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006066 p N Percentage through file in lines as in |CTRL-G|.
6067 P S Percentage through file of displayed window. This is like the
6068 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006069 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006070 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006071 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006072 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006073 ( - Start of item group. Can be used for setting the width and
6074 alignment of a section. Must be followed by %) somewhere.
6075 ) - End of item group. No width fields allowed.
6076 < - Where to truncate line if too long. Default is at the start.
6077 No width fields allowed.
6078 = - Separation point between left and right aligned items.
6079 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006080 # - Set highlight group. The name must follow and then a # again.
6081 Thus use %#HLname# for highlight group HLname. The same
6082 highlighting is used, also for the statusline of non-current
6083 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006084 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006085 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006086 The difference between User{N} and StatusLine will be applied
6087 to StatusLineNC for the statusline of non-current windows.
6088 The number N must be between 1 and 9. See |hl-User1..9|
6089
6090 Display of flags are controlled by the following heuristic:
6091 If a flag text starts with comma it is assumed that it wants to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006092 separate itself from anything but preceding plaintext. If it starts
Bram Moolenaar071d4272004-06-13 20:20:40 +00006093 with a space it is assumed that it wants to separate itself from
6094 anything but other flags. That is: A leading comma is removed if the
6095 preceding character stems from plaintext. A leading space is removed
Bram Moolenaar582fd852005-03-28 20:58:01 +00006096 if the preceding character stems from another active flag. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006097 make a nice display when flags are used like in the examples below.
6098
Bram Moolenaar582fd852005-03-28 20:58:01 +00006099 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006100 not set) and a minwid is not set for the group, the whole group will
6101 become empty. This will make a group like the following disappear
6102 completely from the statusline when none of the flags are set. >
6103 :set statusline=...%(\ [%M%R%H]%)...
6104<
6105 Beware that an expression is evaluated each and every time the status
6106 line is displayed. The current buffer and current window will be set
6107 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006108 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006109 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006110 real current buffer.
6111
6112 The 'statusline' option may be evaluated in the |sandbox|, see
6113 |sandbox-option|.
6114
6115 It is not allowed to change text or jump to another window while
6116 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006117
6118 If the statusline is not updated when you want it (e.g., after setting
6119 a variable that's used in an expression), you can force an update by
6120 setting an option without changing its value. Example: >
6121 :let &ro = &ro
6122
6123< A result of all digits is regarded a number for display purposes.
6124 Otherwise the result is taken as flag text and applied to the rules
6125 described above.
6126
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006127 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006128 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6129 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6130
6131 Examples:
6132 Emulate standard status line with 'ruler' set >
6133 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6134< Similar, but add ASCII value of char under the cursor (like "ga") >
6135 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6136< Display byte count and byte value, modified flag in red. >
6137 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6138 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6139< Display a ,GZ flag if a compressed file is loaded >
6140 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6141< In the |:autocmd|'s: >
6142 :let b:gzflag = 1
6143< And: >
6144 :unlet b:gzflag
6145< And define this function: >
6146 :function VarExists(var, val)
6147 : if exists(a:var) | return a:val | else | return '' | endif
6148 :endfunction
6149<
6150 *'suffixes'* *'su'*
6151'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6152 global
6153 {not in Vi}
6154 Files with these suffixes get a lower priority when multiple files
6155 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006156 suffixes. Spaces after the comma are ignored. A dot is also seen as
6157 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006158 separator, precede it with a backslash (see |option-backslash| about
6159 including spaces and backslashes).
6160 See 'wildignore' for completely ignoring files.
6161 The use of |:set+=| and |:set-=| is preferred when adding or removing
6162 suffixes from the list. This avoids problems when a future version
6163 uses another default.
6164
6165 *'suffixesadd'* *'sua'*
6166'suffixesadd' 'sua' string (default "")
6167 local to buffer
6168 {not in Vi}
6169 {not available when compiled without the
6170 |+file_in_path| feature}
6171 Comma separated list of suffixes, which are used when searching for a
6172 file for the "gf", "[I", etc. commands. Example: >
6173 :set suffixesadd=.java
6174<
6175 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6176'swapfile' 'swf' boolean (default on)
6177 local to buffer
6178 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006179 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006180 swapfile is not wanted for a specific buffer. For example, with
6181 confidential information that even root must not be able to access.
6182 Careful: All text will be in memory:
6183 - Don't use this for big files.
6184 - Recovery will be impossible!
6185 A swapfile will only be present when |'updatecount'| is non-zero and
6186 'swapfile' is set.
6187 When 'swapfile' is reset, the swap file for the current buffer is
6188 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6189 non-zero, a swap file is immediately created.
6190 Also see |swap-file| and |'swapsync'|.
6191
6192 This option is used together with 'bufhidden' and 'buftype' to
6193 specify special kinds of buffers. See |special-buffers|.
6194
6195 *'swapsync'* *'sws'*
6196'swapsync' 'sws' string (default "fsync")
6197 global
6198 {not in Vi}
6199 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006200 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006201 When this option is empty parts of the swap file may be in memory and
6202 not written to disk. When the system crashes you may lose more work.
6203 On Unix the system does a sync now and then without Vim asking for it,
6204 so the disadvantage of setting this option off is small. On some
6205 systems the swap file will not be written at all. For a unix system
6206 setting it to "sync" will use the sync() call instead of the default
6207 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006208 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006209
6210 *'switchbuf'* *'swb'*
6211'switchbuf' 'swb' string (default "")
6212 global
6213 {not in Vi}
6214 This option controls the behavior when switching between buffers.
6215 Possible values (comma separated list):
6216 useopen If included, jump to the first open window that
6217 contains the specified buffer (if there is one).
6218 Otherwise: Do not examine other windows.
6219 This setting is checked with |quickfix| commands, when
6220 jumping to errors (":cc", ":cn", "cp", etc.). It is
6221 also used in all buffer related split commands, for
6222 example ":sbuffer", ":sbnext", or ":sbrewind".
6223 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006224 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006225 Supported in |quickfix| commands that display errors.
6226
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006227 *'synmaxcol'* *'smc'*
6228'synmaxcol' 'smc' number (default 3000)
6229 local to buffer
6230 {not in Vi}
6231 {not available when compiled without the |+syntax|
6232 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006233 Maximum column in which to search for syntax items. In long lines the
6234 text after this column is not highlighted and following lines may not
6235 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006236 This helps to avoid very slow redrawing for an XML file that is one
6237 long line.
6238 Set to zero to remove the limit.
6239
Bram Moolenaar071d4272004-06-13 20:20:40 +00006240 *'syntax'* *'syn'*
6241'syntax' 'syn' string (default empty)
6242 local to buffer
6243 {not in Vi}
6244 {not available when compiled without the |+syntax|
6245 feature}
6246 When this option is set, the syntax with this name is loaded, unless
6247 syntax highlighting has been switched off with ":syntax off".
6248 Otherwise this option does not always reflect the current syntax (the
6249 b:current_syntax variable does).
6250 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006251 not automatically recognized. Example, in an IDL file: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006252 /* vim: set syntax=idl : */
6253< To switch off syntax highlighting for the current file, use: >
6254 :set syntax=OFF
6255< To switch syntax highlighting on according to the current value of the
6256 'filetype' option: >
6257 :set syntax=ON
6258< What actually happens when setting the 'syntax' option is that the
6259 Syntax autocommand event is triggered with the value as argument.
6260 This option is not copied to another buffer, independent of the 's' or
6261 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006262 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006263
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006264 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006265'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006266 global
6267 {not in Vi}
6268 {not available when compiled without the +windows
6269 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006270 When nonempty, this option determines the content of the tab pages
6271 line at the top of the Vim window. When empty Vim will use a default
6272 tab pages line. |tab-page|
6273
6274 The tab pages line only appears as specified with the 'showtabline'
6275 option and only when there is no GUI implementation for tabs.
6276
6277 The value is evaluated like with 'statusline'. You can use
6278 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaar238a5642006-02-21 22:12:05 +00006279 the text to be displayed. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006280
6281 Keep in mind that only one of the tab pages is the current one, others
6282 are invisible and you can't jump to their windows.
6283
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006284
Bram Moolenaar071d4272004-06-13 20:20:40 +00006285 *'tabstop'* *'ts'*
6286'tabstop' 'ts' number (default 8)
6287 local to buffer
6288 Number of spaces that a <Tab> in the file counts for. Also see
6289 |:retab| command, and 'softtabstop' option.
6290
6291 Note: Setting 'tabstop' to any other value than 8 can make your file
6292 appear wrong in many places (e.g., when printing it).
6293
6294 There are four main ways to use tabs in Vim:
6295 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6296 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
6297 will use a mix of tabs and spaces, but typing Tab and BS will
6298 behave like a tab appears every 4 (or 3) characters.
6299 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6300 'expandtab'. This way you will always insert spaces. The
6301 formatting will never be messed up when 'tabstop' is changed.
6302 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006303 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006304 works when using Vim to edit the file.
6305 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6306 'noexpandtab'. This should then work (for initial indents only)
6307 for any tabstop setting that people use. It might be nice to have
6308 tabs after the first non-blank inserted as spaces if you do this
6309 though. Otherwise aligned comments will be wrong when 'tabstop' is
6310 changed.
6311
6312 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6313'tagbsearch' 'tbs' boolean (default on)
6314 global
6315 {not in Vi}
6316 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006317 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006318 searching makes searching for a tag a LOT faster, but a linear search
6319 will find more tags if the tags file wasn't properly sorted.
6320 Vim normally assumes that your tags files are sorted, or indicate that
6321 they are not sorted. Only when this is not the case does the
6322 'tagbsearch' option need to be switched off.
6323
6324 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006325 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006326 certain files, or retry all files with a linear search. When
6327 'tagbsearch' is off, only a linear search is done.
6328
6329 Linear searching is done anyway, for one file, when Vim finds a line
6330 at the start of the file indicating that it's not sorted: >
6331 !_TAG_FILE_SORTED 0 /some command/
6332< [The whitespace before and after the '0' must be a single <Tab>]
6333
6334 When a binary search was done and no match was found in any of the
6335 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6336 instead of a normal tag name, a retry is done with a linear search.
6337 Tags in unsorted tags files, and matches with different case will only
6338 be found in the retry.
6339
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006340 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006341 linear search can be avoided for the 'ignorecase' case. Use a value
6342 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6343 case-fold sorted with the -f switch to "sort" in most unices, as in
6344 the command: "sort -f -o tags tags". For "Exuberant ctags" version
6345 5.3 or higher the -f or --fold-case-sort switch can be used for this
6346 as well. Note that case must be folded to uppercase for this to work.
6347
6348 When 'tagbsearch' is off, tags searching is slower when a full match
6349 exists, but faster when no full match exists. Tags in unsorted tags
6350 files may only be found with 'tagbsearch' off.
6351 When the tags file is not sorted, or sorted in a wrong way (not on
6352 ASCII byte value), 'tagbsearch' should be off, or the line given above
6353 must be included in the tags file.
6354 This option doesn't affect commands that find all matching tags (e.g.,
6355 command-line completion and ":help").
6356 {Vi: always uses binary search in some versions}
6357
6358 *'taglength'* *'tl'*
6359'taglength' 'tl' number (default 0)
6360 global
6361 If non-zero, tags are significant up to this number of characters.
6362
6363 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6364'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6365 global
6366 {not in Vi}
6367 If on and using a tag file in another directory, file names in that
6368 tag file are relative to the directory where the tag file is.
6369 NOTE: This option is set to the Vi default value when 'compatible' is
6370 set and to the Vim default value when 'compatible' is reset.
6371
6372 *'tags'* *'tag'* *E433*
6373'tags' 'tag' string (default "./tags,tags", when compiled with
6374 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6375 global or local to buffer |global-local|
6376 Filenames for the tag command, separated by spaces or commas. To
6377 include a space or comma in a file name, precede it with a backslash
6378 (see |option-backslash| about including spaces and backslashes).
6379 When a file name starts with "./", the '.' is replaced with the path
6380 of the current file. But only when the 'd' flag is not included in
6381 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6382 |tags-option|.
6383 "*", "**" and other wildcards can be used to search for tags files in
6384 a directory tree. See |file-searching|. {not available when compiled
6385 without the |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006386 The |tagfiles()| function can be used to get a list of the file names
6387 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006388 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6389 files are also supported. They are automatically recognized. The
6390 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6391 differences are ignored (MS-Windows). |emacs-tags|
6392 The use of |:set+=| and |:set-=| is preferred when adding or removing
6393 file names from the list. This avoids problems when a future version
6394 uses another default.
6395 {Vi: default is "tags /usr/lib/tags"}
6396
6397 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6398'tagstack' 'tgst' boolean (default on)
6399 global
6400 {not in all versions of Vi}
6401 When on, the |tagstack| is used normally. When off, a ":tag" or
6402 ":tselect" command with an argument will not push the tag onto the
6403 tagstack. A following ":tag" without an argument, a ":pop" command or
6404 any other command that uses the tagstack will use the unmodified
6405 tagstack, but does change the pointer to the active entry.
6406 Resetting this option is useful when using a ":tag" command in a
6407 mapping which should not change the tagstack.
6408
6409 *'term'* *E529* *E530* *E531*
6410'term' string (default is $TERM, if that fails:
6411 in the GUI: "builtin_gui"
6412 on Amiga: "amiga"
6413 on BeOS: "beos-ansi"
6414 on Mac: "mac-ansi"
6415 on MiNT: "vt52"
6416 on MS-DOS: "pcterm"
6417 on OS/2: "os2ansi"
6418 on Unix: "ansi"
6419 on VMS: "ansi"
6420 on Win 32: "win32")
6421 global
6422 Name of the terminal. Used for choosing the terminal control
6423 characters. Environment variables are expanded |:set_env|.
6424 For example: >
6425 :set term=$TERM
6426< See |termcap|.
6427
6428 *'termbidi'* *'tbidi'*
6429 *'notermbidi'* *'notbidi'*
6430'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6431 global
6432 {not in Vi}
6433 {only available when compiled with the |+arabic|
6434 feature}
6435 The terminal is in charge of Bi-directionality of text (as specified
6436 by Unicode). The terminal is also expected to do the required shaping
6437 that some languages (such as Arabic) require.
6438 Setting this option implies that 'rightleft' will not be set when
6439 'arabic' is set and the value of 'arabicshape' will be ignored.
6440 Note that setting 'termbidi' has the immediate effect that
6441 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6442 This option is reset when the GUI is started.
6443 For further details see |arabic.txt|.
6444
6445 *'termencoding'* *'tenc'*
6446'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6447 Macintosh GUI: "macroman")
6448 global
6449 {only available when compiled with the |+multi_byte|
6450 feature}
6451 {not in Vi}
6452 Encoding used for the terminal. This specifies what character
6453 encoding the keyboard produces and the display will understand. For
6454 the GUI it only applies to the keyboard ('encoding' is used for the
6455 display).
6456 In the Win32 console version the default value is the console codepage
6457 when it differs from the ANSI codepage.
6458 *E617*
6459 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6460 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6461 Any attempts to set a different value will be rejected, and an error
6462 message is shown.
6463 For the Win32 GUI 'termencoding' is not used for typed characters,
6464 because the Win32 system always passes Unicode characters.
6465 When empty, the same encoding is used as for the 'encoding' option.
6466 This is the normal value.
6467 Not all combinations for 'termencoding' and 'encoding' are valid. See
6468 |encoding-table|.
6469 The value for this option must be supported by internal conversions or
6470 iconv(). When this is not possible no conversion will be done and you
6471 will probably experience problems with non-ASCII characters.
6472 Example: You are working with the locale set to euc-jp (Japanese) and
6473 want to edit a UTF-8 file: >
6474 :let &termencoding = &encoding
6475 :set encoding=utf-8
6476< You need to do this when your system has no locale support for UTF-8.
6477
6478 *'terse'* *'noterse'*
6479'terse' boolean (default off)
6480 global
6481 When set: Add 's' flag to 'shortmess' option (this makes the message
6482 for a search that hits the start or end of the file not being
6483 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6484 shortens a lot of messages}
6485
6486 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6487'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6488 global
6489 {not in Vi}
6490 This option is obsolete. Use 'fileformats'.
6491 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6492 set to the default value for the current system. When 'textauto' is
6493 reset, 'fileformats' is made empty.
6494 NOTE: This option is set to the Vi default value when 'compatible' is
6495 set and to the Vim default value when 'compatible' is reset.
6496
6497 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6498'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
6499 others: default off)
6500 local to buffer
6501 {not in Vi}
6502 This option is obsolete. Use 'fileformat'.
6503 For backwards compatibility, when 'textmode' is set, 'fileformat' is
6504 set to "dos". When 'textmode' is reset, 'fileformat' is set to
6505 "unix".
6506
6507 *'textwidth'* *'tw'*
6508'textwidth' 'tw' number (default 0)
6509 local to buffer
6510 {not in Vi}
6511 Maximum width of text that is being inserted. A longer line will be
6512 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006513 this. 'textwidth' is set to 0 when the 'paste' option is set. When
6514 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00006515 'formatoptions' and |ins-textwidth|.
6516 NOTE: This option is set to 0 when 'compatible' is set.
6517
6518 *'thesaurus'* *'tsr'*
6519'thesaurus' 'tsr' string (default "")
6520 global or local to buffer |global-local|
6521 {not in Vi}
6522 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006523 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00006524 the file should contain words with similar meaning, separated by
6525 non-keyword characters (white space is preferred). Maximum line
6526 length is 510 bytes.
6527 To obtain a file to be used here, check out the wordlist FAQ at
6528 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006529 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00006530 after a comma are ignored, otherwise spaces are included in the file
6531 name. See |option-backslash| about using backslashes.
6532 The use of |:set+=| and |:set-=| is preferred when adding or removing
6533 directories from the list. This avoids problems when a future version
6534 uses another default.
6535 Backticks cannot be used in this option for security reasons.
6536
6537 *'tildeop'* *'top'* *'notildeop'* *'notop'*
6538'tildeop' 'top' boolean (default off)
6539 global
6540 {not in Vi}
6541 When on: The tilde command "~" behaves like an operator.
6542 NOTE: This option is reset when 'compatible' is set.
6543
6544 *'timeout'* *'to'* *'notimeout'* *'noto'*
6545'timeout' 'to' boolean (default on)
6546 global
6547 *'ttimeout'* *'nottimeout'*
6548'ttimeout' boolean (default off)
6549 global
6550 {not in Vi}
6551 These two options together determine the behavior when part of a
6552 mapped key sequence or keyboard code has been received:
6553
6554 'timeout' 'ttimeout' action ~
6555 off off do not time out
6556 on on or off time out on :mappings and key codes
6557 off on time out on key codes
6558
6559 If both options are off, Vim will wait until either the complete
6560 mapping or key sequence has been received, or it is clear that there
6561 is no mapping or key sequence for the received characters. For
6562 example: if you have mapped "vl" and Vim has received 'v', the next
6563 character is needed to see if the 'v' is followed by an 'l'.
6564 When one of the options is on, Vim will wait for about 1 second for
6565 the next character to arrive. After that the already received
6566 characters are interpreted as single characters. The waiting time can
6567 be changed with the 'timeoutlen' option.
6568 On slow terminals or very busy systems timing out may cause
6569 malfunctioning cursor keys. If both options are off, Vim waits
6570 forever after an entered <Esc> if there are key codes that start
6571 with <Esc>. You will have to type <Esc> twice. If you do not have
6572 problems with key codes, but would like to have :mapped key
6573 sequences not timing out in 1 second, set the 'ttimeout' option and
6574 reset the 'timeout' option.
6575
6576 NOTE: 'ttimeout' is reset when 'compatible' is set.
6577
6578 *'timeoutlen'* *'tm'*
6579'timeoutlen' 'tm' number (default 1000)
6580 global
6581 {not in all versions of Vi}
6582 *'ttimeoutlen'* *'ttm'*
6583'ttimeoutlen' 'ttm' number (default -1)
6584 global
6585 {not in Vi}
6586 The time in milliseconds that is waited for a key code or mapped key
6587 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
6588 when part of a command has been typed.
6589 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
6590 different timeout value for key codes is desired set 'ttimeoutlen' to
6591 a non-negative number.
6592
6593 ttimeoutlen mapping delay key code delay ~
6594 < 0 'timeoutlen' 'timeoutlen'
6595 >= 0 'timeoutlen' 'ttimeoutlen'
6596
6597 The timeout only happens when the 'timeout' and 'ttimeout' options
6598 tell so. A useful setting would be >
6599 :set timeout timeoutlen=3000 ttimeoutlen=100
6600< (time out on mapping after three seconds, time out on key codes after
6601 a tenth of a second).
6602
6603 *'title'* *'notitle'*
6604'title' boolean (default off, on when title can be restored)
6605 global
6606 {not in Vi}
6607 {not available when compiled without the |+title|
6608 feature}
6609 When on, the title of the window will be set to the value of
6610 'titlestring' (if it is not empty), or to:
6611 filename [+=-] (path) - VIM
6612 Where:
6613 filename the name of the file being edited
6614 - indicates the file cannot be modified, 'ma' off
6615 + indicates the file was modified
6616 = indicates the file is read-only
6617 =+ indicates the file is read-only and modified
6618 (path) is the path of the file being edited
6619 - VIM the server name |v:servername| or "VIM"
6620 Only works if the terminal supports setting window titles
6621 (currently Amiga console, Win32 console, all GUI versions and
6622 terminals with a non- empty 't_ts' option - these are Unix xterm and
6623 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
6624 *X11*
6625 When Vim was compiled with HAVE_X11 defined, the original title will
6626 be restored if possible. The output of ":version" will include "+X11"
6627 when HAVE_X11 was defined, otherwise it will be "-X11". This also
6628 works for the icon name |'icon'|.
6629 But: When Vim was started with the |-X| argument, restoring the title
6630 will not work (except in the GUI).
6631 If the title cannot be restored, it is set to the value of 'titleold'.
6632 You might want to restore the title outside of Vim then.
6633 When using an xterm from a remote machine you can use this command:
6634 rsh machine_name xterm -display $DISPLAY &
6635 then the WINDOWID environment variable should be inherited and the
6636 title of the window should change back to what it should be after
6637 exiting Vim.
6638
6639 *'titlelen'*
6640'titlelen' number (default 85)
6641 global
6642 {not in Vi}
6643 {not available when compiled without the |+title|
6644 feature}
6645 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006646 title. When the title is longer, only the end of the path name is
6647 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006648 Using a percentage makes this adapt to the width of the window. But
6649 it won't work perfectly, because the actual number of characters
6650 available also depends on the font used and other things in the title
6651 bar. When 'titlelen' is zero the full path is used. Otherwise,
6652 values from 1 to 30000 percent can be used.
6653 'titlelen' is also used for the 'titlestring' option.
6654
6655 *'titleold'*
6656'titleold' string (default "Thanks for flying Vim")
6657 global
6658 {not in Vi}
6659 {only available when compiled with the |+title|
6660 feature}
6661 This option will be used for the window title when exiting Vim if the
6662 original title cannot be restored. Only happens if 'title' is on or
6663 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006664 This option cannot be set from a |modeline| or in the |sandbox|, for
6665 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006666 *'titlestring'*
6667'titlestring' string (default "")
6668 global
6669 {not in Vi}
6670 {not available when compiled without the |+title|
6671 feature}
6672 When this option is not empty, it will be used for the title of the
6673 window. This happens only when the 'title' option is on.
6674 Only works if the terminal supports setting window titles (currently
6675 Amiga console, Win32 console, all GUI versions and terminals with a
6676 non-empty 't_ts' option).
6677 When Vim was compiled with HAVE_X11 defined, the original title will
6678 be restored if possible |X11|.
6679 When this option contains printf-style '%' items, they will be
6680 expanded according to the rules used for 'statusline'.
6681 Example: >
6682 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
6683 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
6684< The value of 'titlelen' is used to align items in the middle or right
6685 of the available space.
6686 Some people prefer to have the file name first: >
6687 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
6688< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006689 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006690 separating space only when needed.
6691 NOTE: Use of special characters in 'titlestring' may cause the display
6692 to be garbled (e.g., when it contains a CR or NL character).
6693 {not available when compiled without the |+statusline| feature}
6694
6695 *'toolbar'* *'tb'*
6696'toolbar' 'tb' string (default "icons,tooltips")
6697 global
6698 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
6699 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006700 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00006701 possible values are:
6702 icons Toolbar buttons are shown with icons.
6703 text Toolbar buttons shown with text.
6704 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006705 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006706 tooltips Tooltips are active for toolbar buttons.
6707 Tooltips refer to the popup help text which appears after the mouse
6708 cursor is placed over a toolbar button for a brief moment.
6709
6710 If you want the toolbar to be shown with icons as well as text, do the
6711 following: >
6712 :set tb=icons,text
6713< Motif and Athena cannot display icons and text at the same time. They
6714 will show icons if both are requested.
6715
6716 If none of the strings specified in 'toolbar' are valid or if
6717 'toolbar' is empty, this option is ignored. If you want to disable
6718 the toolbar, you need to set the 'guioptions' option. For example: >
6719 :set guioptions-=T
6720< Also see |gui-toolbar|.
6721
6722 *'toolbariconsize'* *'tbis'*
6723'toolbariconsize' 'tbis' string (default "small")
6724 global
6725 {not in Vi}
6726 {only in the GTK+ 2 GUI}
6727 Controls the size of toolbar icons. The possible values are:
6728 tiny Use tiny toolbar icons.
6729 small Use small toolbar icons (default).
6730 medium Use medium-sized toolbar icons.
6731 large Use large toolbar icons.
6732 The exact dimensions in pixels of the various icon sizes depend on
6733 the current theme. Common dimensions are large=32x32, medium=24x24,
6734 small=20x20 and tiny=16x16.
6735
6736 If 'toolbariconsize' is empty, the global default size as determined
6737 by user preferences or the current theme is used.
6738
6739 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
6740'ttybuiltin' 'tbi' boolean (default on)
6741 global
6742 {not in Vi}
6743 When on, the builtin termcaps are searched before the external ones.
6744 When off the builtin termcaps are searched after the external ones.
6745 When this option is changed, you should set the 'term' option next for
6746 the change to take effect, for example: >
6747 :set notbi term=$TERM
6748< See also |termcap|.
6749 Rationale: The default for this option is "on", because the builtin
6750 termcap entries are generally better (many systems contain faulty
6751 xterm entries...).
6752
6753 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
6754'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
6755 sun-cmd, screen, rxvt, dtterm or
6756 iris-ansi; also on when running Vim in
6757 a DOS console)
6758 global
6759 {not in Vi}
6760 Indicates a fast terminal connection. More characters will be sent to
6761 the screen for redrawing, instead of using insert/delete line
6762 commands. Improves smoothness of redrawing when there are multiple
6763 windows and the terminal does not support a scrolling region.
6764 Also enables the extra writing of characters at the end of each screen
6765 line for lines that wrap. This helps when using copy/paste with the
6766 mouse in an xterm and other terminals.
6767
6768 *'ttymouse'* *'ttym'*
6769'ttymouse' 'ttym' string (default depends on 'term')
6770 global
6771 {not in Vi}
6772 {only in Unix and VMS, doesn't work in the GUI; not
6773 available when compiled without |+mouse|}
6774 Name of the terminal type for which mouse codes are to be recognized.
6775 Currently these three strings are valid:
6776 *xterm-mouse*
6777 xterm xterm-like mouse handling. The mouse generates
6778 "<Esc>[Mscr", where "scr" is three bytes:
6779 "s" = button state
6780 "c" = column plus 33
6781 "r" = row plus 33
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006782 This only works up to 223 columns! See "dec" for a
6783 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006784 xterm2 Works like "xterm", but with the xterm reporting the
6785 mouse position while the mouse is dragged. This works
6786 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00006787 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00006788 work. See below for how Vim detects this
6789 automatically.
6790 *netterm-mouse*
6791 netterm NetTerm mouse handling. The mouse generates
6792 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
6793 for the row and column.
6794 *dec-mouse*
6795 dec DEC terminal mouse handling. The mouse generates a
6796 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006797 This is also available for an Xterm, if it was
6798 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006799 *jsbterm-mouse*
6800 jsbterm JSB term mouse handling.
6801 *pterm-mouse*
6802 pterm QNX pterm mouse handling.
6803
6804 The mouse handling must be enabled at compile time |+mouse_xterm|
6805 |+mouse_dec| |+mouse_netterm|.
6806 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
6807 recognized, if enabled at compile time. DEC terminal mouse codes
6808 are recognized if enabled at compile time, and 'ttymouse' is not
6809 "xterm" (because the xterm and dec mouse codes conflict).
6810 This option is automatically set to "xterm", when the 'term' option is
6811 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
6812 or "xterm2" already. The main use of this option is to set it to
6813 "xterm", when the terminal name doesn't start with "xterm", but it can
6814 handle xterm mouse codes.
6815 The "xterm2" value will be set if the xterm version is reported to be
6816 95 of higher. This only works when compiled with the |+termresponse|
6817 feature and if |t_RV| is set to the escape sequence to request the
6818 xterm version number. Otherwise "xterm2" must be set explicitly.
6819 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
6820 t_RV to an empty string: >
6821 :set t_RV=
6822<
6823 *'ttyscroll'* *'tsl'*
6824'ttyscroll' 'tsl' number (default 999)
6825 global
6826 Maximum number of lines to scroll the screen. If there are more lines
6827 to scroll the window is redrawn. For terminals where scrolling is
6828 very slow and redrawing is not slow this can be set to a small number,
6829 e.g., 3, to speed up displaying.
6830
6831 *'ttytype'* *'tty'*
6832'ttytype' 'tty' string (default from $TERM)
6833 global
6834 Alias for 'term', see above.
6835
6836 *'undolevels'* *'ul'*
6837'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
6838 Win32 and OS/2)
6839 global
6840 {not in Vi}
6841 Maximum number of changes that can be undone. Since undo information
6842 is kept in memory, higher numbers will cause more memory to be used
6843 (nevertheless, a single change can use an unlimited amount of memory).
6844 Set to 0 for Vi compatibility: One level of undo and "u" undoes
6845 itself: >
6846 set ul=0
6847< But you can also get Vi compatibility by including the 'u' flag in
6848 'cpoptions', and still be able to use CTRL-R to repeat undo.
6849 Set to a negative number for no undo at all: >
6850 set ul=-1
6851< This helps when you run out of memory for a single change.
6852 Also see |undo-two-ways|.
6853
6854 *'updatecount'* *'uc'*
6855'updatecount' 'uc' number (default: 200)
6856 global
6857 {not in Vi}
6858 After typing this many characters the swap file will be written to
6859 disk. When zero, no swap file will be created at all (see chapter on
6860 recovery |crash-recovery|). 'updatecount' is set to zero by starting
6861 Vim with the "-n" option, see |startup|. When editing in readonly
6862 mode this option will be initialized to 10000.
6863 The swapfile can be disabled per buffer with |'swapfile'|.
6864 When 'updatecount' is set from zero to non-zero, swap files are
6865 created for all buffers that have 'swapfile' set. When 'updatecount'
6866 is set to zero, existing swap files are not deleted.
6867 Also see |'swapsync'|.
6868 This option has no meaning in buffers where |'buftype'| is "nofile"
6869 or "nowrite".
6870
6871 *'updatetime'* *'ut'*
6872'updatetime' 'ut' number (default 4000)
6873 global
6874 {not in Vi}
6875 If this many milliseconds nothing is typed the swap file will be
6876 written to disk (see |crash-recovery|). Also used for the
6877 |CursorHold| autocommand event.
6878
6879 *'verbose'* *'vbs'*
6880'verbose' 'vbs' number (default 0)
6881 global
6882 {not in Vi, although some versions have a boolean
6883 verbose option}
6884 When bigger than zero, Vim will give messages about what it is doing.
6885 Currently, these messages are given:
6886 >= 1 When the viminfo file is read or written.
6887 >= 2 When a file is ":source"'ed.
6888 >= 5 Every searched tags file.
6889 >= 8 Files for which a group of autocommands is executed.
6890 >= 9 Every executed autocommand.
6891 >= 12 Every executed function.
6892 >= 13 When an exception is thrown, caught, finished, or discarded.
6893 >= 14 Anything pending in a ":finally" clause.
6894 >= 15 Every executed Ex command (truncated at 200 characters).
6895
6896 This option can also be set with the "-V" argument. See |-V|.
6897 This option is also set by the |:verbose| command.
6898
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00006899 When the 'verbosefile' option is set then the verbose messages are not
6900 displayed.
6901
6902 *'verbosefile'* *'vfile'*
6903'verbosefile' 'vfile' string (default empty)
6904 global
6905 {not in Vi}
6906 When not empty all messages are written in a file with this name.
6907 When the file exists messages are appended.
6908 Writing to the file ends when Vim exits or when 'verbosefile' is made
6909 empty.
6910 Setting 'verbosefile' to a new value is like making it empty first.
6911 The difference with |:redir| is that verbose messages are not
6912 displayed when 'verbosefile' is set.
6913
Bram Moolenaar071d4272004-06-13 20:20:40 +00006914 *'viewdir'* *'vdir'*
6915'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
6916 "$VIM/vimfiles/view",
6917 for Unix: "~/.vim/view",
6918 for Macintosh: "$VIM:vimfiles:view"
6919 for VMS: "sys$login:vimfiles/view"
6920 for RiscOS: "Choices:vimfiles/view")
6921 global
6922 {not in Vi}
6923 {not available when compiled without the +mksession
6924 feature}
6925 Name of the directory where to store files for |:mkview|.
6926 This option cannot be set from a |modeline| or in the |sandbox|, for
6927 security reasons.
6928
6929 *'viewoptions'* *'vop'*
6930'viewoptions' 'vop' string (default: "folds,options,cursor")
6931 global
6932 {not in Vi}
6933 {not available when compiled without the +mksession
6934 feature}
6935 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006936 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006937 word save and restore ~
6938 cursor cursor position in file and in window
6939 folds manually created folds, opened/closed folds and local
6940 fold options
6941 options options and mappings local to a window or buffer (not
6942 global values for local options)
6943 slash backslashes in file names replaced with forward
6944 slashes
6945 unix with Unix end-of-line format (single <NL>), even when
6946 on Windows or DOS
6947
6948 "slash" and "unix" are useful on Windows when sharing view files
6949 with Unix. The Unix version of Vim cannot source dos format scripts,
6950 but the Windows version of Vim can source unix format scripts.
6951
6952 *'viminfo'* *'vi'* *E526* *E527* *E528*
6953'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
6954 Windows and OS/2: '20,<50,s10,h,rA:,rB:,
6955 for Amiga: '20,<50,s10,h,rdf0:,rdf1:,rdf2:
6956 for others: '20,<50,s10,h)
6957 global
6958 {not in Vi}
6959 {not available when compiled without the |+viminfo|
6960 feature}
6961 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006962 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00006963 separated list of parameters, each consisting of a single character
6964 identifying the particular parameter, followed by a number or string
6965 which specifies the value of that parameter. If a particular
6966 character is left out, then the default value is used for that
6967 parameter. The following is a list of the identifying characters and
6968 the effect of their value.
6969 CHAR VALUE ~
6970 ! When included, save and restore global variables that start
6971 with an uppercase letter, and don't contain a lowercase
6972 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00006973 and "_K_L_M" are not. Only String and Number types are
6974 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006975 " Maximum number of lines saved for each register. Old name of
6976 the '<' item, with the disadvantage that you need to put a
6977 backslash before the ", otherwise it will be recognized as the
6978 start of a comment!
6979 % When included, save and restore the buffer list. If Vim is
6980 started with a file name argument, the buffer list is not
6981 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006982 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00006983 without a file name and buffers for help files are not written
6984 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00006985 When followed by a number, the number specifies the maximum
6986 number of buffers that are stored. Without a number all
6987 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006988 ' Maximum number of previously edited files for which the marks
6989 are remembered. This parameter must always be included when
6990 'viminfo' is non-empty.
6991 Including this item also means that the |jumplist| and the
6992 |changelist| are stored in the viminfo file.
6993 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006994 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00006995 patterns are also saved. When not included, the value of
6996 'history' is used.
6997 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006998 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006999 < Maximum number of lines saved for each register. If zero then
7000 registers are not saved. When not included, all lines are
7001 saved. '"' is the old name for this item.
7002 Also see the 's' item below: limit specified in Kbyte.
7003 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007004 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007005 c When included, convert the text in the viminfo file from the
7006 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007007 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007008 f Whether file marks need to be stored. If zero, file marks ('0
7009 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007010 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007011 cursor position (when exiting or when doing ":wviminfo").
7012 h Disable the effect of 'hlsearch' when loading the viminfo
7013 file. When not included, it depends on whether ":nohlsearch"
7014 has been used since the last search command.
7015 n Name of the viminfo file. The name must immediately follow
7016 the 'n'. Must be the last one! If the "-i" argument was
7017 given when starting Vim, that file name overrides the one
7018 given here with 'viminfo'. Environment variables are expanded
7019 when opening the file, not when setting the option.
7020 r Removable media. The argument is a string (up to the next
7021 ','). This parameter can be given several times. Each
7022 specifies the start of a path for which no marks will be
7023 stored. This is to avoid removable media. For MS-DOS you
7024 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7025 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7026 ignored. Maximum length of each 'r' argument is 50
7027 characters.
7028 s Maximum size of an item in Kbyte. If zero then registers are
7029 not saved. Currently only applies to registers. The default
7030 "s10" will exclude registers with more than 10 Kbyte of text.
7031 Also see the '<' item above: line count limit.
7032
7033 Example: >
7034 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7035<
7036 '50 Marks will be remembered for the last 50 files you
7037 edited.
7038 <1000 Contents of registers (up to 1000 lines each) will be
7039 remembered.
7040 s100 Registers with more than 100 Kbyte text are skipped.
7041 :0 Command-line history will not be saved.
7042 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7043 no / Since '/' is not specified, the default will be used,
7044 that is, save all of the search history, and also the
7045 previous search and substitute patterns.
7046 no % The buffer list will not be saved nor read back.
7047 no h 'hlsearch' highlighting will be restored.
7048
7049 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7050 load the contents of the file, this is not done automatically.
7051
7052 This option cannot be set from a |modeline| or in the |sandbox|, for
7053 security reasons.
7054
7055 *'virtualedit'* *'ve'*
7056'virtualedit' 've' string (default "")
7057 global
7058 {not in Vi}
7059 {not available when compiled without the
7060 |+virtualedit| feature}
7061 A comma separated list of these words:
7062 block Allow virtual editing in Visual block mode.
7063 insert Allow virtual editing in Insert mode.
7064 all Allow virtual editing in all modes.
7065 Virtual editing means that the cursor can be positioned where there is
7066 no actual character. This can be halfway into a Tab or beyond the end
7067 of the line. Useful for selecting a rectangle in Visual mode and
7068 editing a table.
7069
7070 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7071'visualbell' 'vb' boolean (default off)
7072 global
7073 {not in Vi}
7074 Use visual bell instead of beeping. The terminal code to display the
7075 visual bell is given with 't_vb'. When no beep or flash is wanted,
7076 use ":set vb t_vb=".
7077 Note: When the GUI starts, 't_vb' is reset to its default value. You
7078 might want to set it again in your |gvimrc|.
7079 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7080 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7081 where 40 is the time in msec.
7082 Does not work on the Amiga, you always get a screen flash.
7083 Also see 'errorbells'.
7084
7085 *'warn'* *'nowarn'*
7086'warn' boolean (default on)
7087 global
7088 Give a warning message when a shell command is used while the buffer
7089 has been changed.
7090
7091 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7092'weirdinvert' 'wiv' boolean (default off)
7093 global
7094 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007095 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007096 It is provided for backwards compatibility with version 4.x.
7097 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7098 vice versa. Has no effect when the GUI is running.
7099
7100 *'whichwrap'* *'ww'*
7101'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7102 global
7103 {not in Vi}
7104 Allow specified keys that move the cursor left/right to move to the
7105 previous/next line when the cursor is on the first/last character in
7106 the line. Concatenate characters to allow this for these keys:
7107 char key mode ~
7108 b <BS> Normal and Visual
7109 s <Space> Normal and Visual
7110 h "h" Normal and Visual
7111 l "l" Normal and Visual
7112 < <Left> Normal and Visual
7113 > <Right> Normal and Visual
7114 ~ "~" Normal
7115 [ <Left> Insert and Replace
7116 ] <Right> Insert and Replace
7117 For example: >
7118 :set ww=<,>,[,]
7119< allows wrap only when cursor keys are used.
7120 When the movement keys are used in combination with a delete or change
7121 operator, the <EOL> also counts for a character. This makes "3h"
7122 different from "3dh" when the cursor crosses the end of a line. This
7123 is also true for "x" and "X", because they do the same as "dl" and
7124 "dh". If you use this, you may also want to use the mapping
7125 ":map <BS> X" to make backspace delete the character in front of the
7126 cursor.
7127 When 'l' is included, you get a side effect: "yl" on an empty line
7128 will include the <EOL>, so that "p" will insert a new line.
7129 NOTE: This option is set to the Vi default value when 'compatible' is
7130 set and to the Vim default value when 'compatible' is reset.
7131
7132 *'wildchar'* *'wc'*
7133'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7134 global
7135 {not in Vi}
7136 Character you have to type to start wildcard expansion in the
7137 command-line, as specified with 'wildmode'.
7138 The character is not recognized when used inside a macro. See
7139 'wildcharm' for that.
7140 Although 'wc' is a number option, you can set it to a special key: >
7141 :set wc=<Esc>
7142< NOTE: This option is set to the Vi default value when 'compatible' is
7143 set and to the Vim default value when 'compatible' is reset.
7144
7145 *'wildcharm'* *'wcm'*
7146'wildcharm' 'wcm' number (default: none (0))
7147 global
7148 {not in Vi}
7149 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007150 recognized when used inside a macro. You can find "spare" command-line
7151 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007152 you'll never actually type 'wildcharm', just use it in mappings that
7153 automatically invoke completion mode, e.g.: >
7154 :set wcm=<C-Z>
7155 :cmap ss so $vim/sessions/*.vim<C-Z>
7156< Then after typing :ss you can use CTRL-P & CTRL-N.
7157
7158 *'wildignore'* *'wig'*
7159'wildignore' 'wig' string (default "")
7160 global
7161 {not in Vi}
7162 {not available when compiled without the |+wildignore|
7163 feature}
7164 A list of file patterns. A file that matches with one of these
7165 patterns is ignored when completing file or directory names.
7166 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7167 Also see 'suffixes'.
7168 Example: >
7169 :set wildignore=*.o,*.obj
7170< The use of |:set+=| and |:set-=| is preferred when adding or removing
7171 a pattern from the list. This avoids problems when a future version
7172 uses another default.
7173
7174 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7175'wildmenu' 'wmnu' boolean (default off)
7176 global
7177 {not in Vi}
7178 {not available if compiled without the |+wildmenu|
7179 feature}
7180 When 'wildmenu' is on, command-line completion operates in an enhanced
7181 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7182 the possible matches are shown just above the command line, with the
7183 first match highlighted (overwriting the status line, if there is
7184 one). Keys that show the previous/next match, such as <Tab> or
7185 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7186 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7187 specified. "longest" and "list" do not start "wildmenu" mode.
7188 If there are more matches than can fit in the line, a ">" is shown on
7189 the right and/or a "<" is shown on the left. The status line scrolls
7190 as needed.
7191 The "wildmenu" mode is abandoned when a key is hit that is not used
7192 for selecting a completion.
7193 While the "wildmenu" is active the following keys have special
7194 meanings:
7195
7196 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7197 <Down> - in filename/menu name completion: move into a
7198 subdirectory or submenu.
7199 <CR> - in menu completion, when the cursor is just after a
7200 dot: move into a submenu.
7201 <Up> - in filename/menu name completion: move up into
7202 parent directory or parent menu.
7203
7204 This makes the menus accessible from the console |console-menus|.
7205
7206 If you prefer the <Left> and <Right> keys to move the cursor instead
7207 of selecting a different match, use this: >
7208 :cnoremap <Left> <Space><BS><Left>
7209 :cnoremap <Right> <Space><BS><Right>
7210<
7211 The "WildMenu" highlighting is used for displaying the current match
7212 |hl-WildMenu|.
7213
7214 *'wildmode'* *'wim'*
7215'wildmode' 'wim' string (Vim default: "full")
7216 global
7217 {not in Vi}
7218 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007219 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar071d4272004-06-13 20:20:40 +00007220 part specifies what to do for each consecutive use of 'wildchar. The
7221 first part specifies the behavior for the first use of 'wildchar',
7222 The second part for the second use, etc.
7223 These are the possible values for each part:
7224 "" Complete only the first match.
7225 "full" Complete the next full match. After the last match,
7226 the original string is used and then the first match
7227 again.
7228 "longest" Complete till longest common string. If this doesn't
7229 result in a longer string, use the next part.
7230 "longest:full" Like "longest", but also start 'wildmenu' if it is
7231 enabled.
7232 "list" When more than one match, list all matches.
7233 "list:full" When more than one match, list all matches and
7234 complete first match.
7235 "list:longest" When more than one match, list all matches and
7236 complete till longest common string.
7237 When there is only a single match, it is fully completed in all cases.
7238
7239 Examples: >
7240 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007241< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007242 :set wildmode=longest,full
7243< Complete longest common string, then each full match >
7244 :set wildmode=list:full
7245< List all matches and complete each full match >
7246 :set wildmode=list,full
7247< List all matches without completing, then each full match >
7248 :set wildmode=longest,list
7249< Complete longest common string, then list alternatives.
7250
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007251 *'wildoptions'* *'wop'*
7252'wildoptions' 'wop' string (default "")
7253 global
7254 {not in Vi}
7255 {not available when compiled without the |+wildignore|
7256 feature}
7257 A list of words that change how command line completion is done.
7258 Currently only one word is allowed:
7259 tagfile When using CTRL-D to list matching tags, the kind of
7260 tag and the file of the tag is listed. Only one match
7261 is displayed per line. Often used tag kinds are:
7262 d #define
7263 f function
7264 Also see |cmdline-completion|.
7265
Bram Moolenaar071d4272004-06-13 20:20:40 +00007266 *'winaltkeys'* *'wak'*
7267'winaltkeys' 'wak' string (default "menu")
7268 global
7269 {not in Vi}
7270 {only used in Win32, Motif, GTK and Photon GUI}
7271 Some GUI versions allow the access to menu entries by using the ALT
7272 key in combination with a character that appears underlined in the
7273 menu. This conflicts with the use of the ALT key for mappings and
7274 entering special characters. This option tells what to do:
7275 no Don't use ALT keys for menus. ALT key combinations can be
7276 mapped, but there is no automatic handling. This can then be
7277 done with the |:simalt| command.
7278 yes ALT key handling is done by the windowing system. ALT key
7279 combinations cannot be mapped.
7280 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007281 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007282 keys can be mapped.
7283 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7284 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007285 This option is not used for <F10>; on Win32 and with GTK <F10> will
7286 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007287
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007288 *'window'* *'wi'*
7289'window' 'wi' number (default screen height - 1)
7290 global
7291 Window height. Do not confuse this with the height of the Vim window,
7292 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007293 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7294 value is smaller than 'lines' minus one. The screen will scroll
7295 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007296 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7297 in a much smarter way, taking care of wrapping lines.
7298 When resizing the Vim window, the value is smaller than 1 or more than
7299 or equal to 'lines' it will be set to 'lines' minus 1.
7300 {Vi also uses the option to specify the number of displayed lines}
7301
Bram Moolenaar071d4272004-06-13 20:20:40 +00007302 *'winheight'* *'wh'* *E591*
7303'winheight' 'wh' number (default 1)
7304 global
7305 {not in Vi}
7306 {not available when compiled without the +windows
7307 feature}
7308 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007309 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007310 current window is smaller, its size is increased, at the cost of the
7311 height of other windows. Set it to 999 to make the current window
7312 always fill the screen (although this has the drawback that ":all"
7313 will create only two windows). Set it to a small number for normal
7314 editing.
7315 Minimum value is 1.
7316 The height is not adjusted after one of the commands to change the
7317 height of the current window.
7318 'winheight' applies to the current window. Use 'winminheight' to set
7319 the minimal height for other windows.
7320
7321 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7322'winfixheight' 'wfh' boolean (default off)
7323 local to window
7324 {not in Vi}
7325 {not available when compiled without the +windows
7326 feature}
7327 Keep the window height when windows are opened or closed and
7328 'equalalways' is set. Set by default for the |preview-window| and
7329 |quickfix-window|.
7330 The height may be changed anyway when running out of room.
7331
7332 *'winminheight'* *'wmh'*
7333'winminheight' 'wmh' number (default 1)
7334 global
7335 {not in Vi}
7336 {not available when compiled without the +windows
7337 feature}
7338 The minimal height of a window, when it's not the current window.
7339 This is a hard minimum, windows will never become smaller.
7340 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7341 status bar) if necessary. They will return to at least one line when
7342 they become active (since the cursor has to have somewhere to go.)
7343 Use 'winheight' to set the minimal height of the current window.
7344 This option is only checked when making a window smaller. Don't use a
7345 large number, it will cause errors when opening more than a few
7346 windows. A value of 0 to 3 is reasonable.
7347
7348 *'winminwidth'* *'wmw'*
7349'winminwidth' 'wmw' number (default 1)
7350 global
7351 {not in Vi}
7352 {not available when compiled without the +vertsplit
7353 feature}
7354 The minimal width of a window, when it's not the current window.
7355 This is a hard minimum, windows will never become smaller.
7356 When set to zero, windows may be "squashed" to zero columns (i.e. just
7357 a vertical separator) if necessary. They will return to at least one
7358 line when they become active (since the cursor has to have somewhere
7359 to go.)
7360 Use 'winwidth' to set the minimal width of the current window.
7361 This option is only checked when making a window smaller. Don't use a
7362 large number, it will cause errors when opening more than a few
7363 windows. A value of 0 to 12 is reasonable.
7364
7365 *'winwidth'* *'wiw'* *E592*
7366'winwidth' 'wiw' number (default 20)
7367 global
7368 {not in Vi}
7369 {not available when compiled without the +vertsplit
7370 feature}
7371 Minimal number of columns for the current window. This is not a hard
7372 minimum, Vim will use fewer columns if there is not enough room. If
7373 the current window is smaller, its size is increased, at the cost of
7374 the width of other windows. Set it to 999 to make the current window
7375 always fill the screen. Set it to a small number for normal editing.
7376 The width is not adjusted after one of the commands to change the
7377 width of the current window.
7378 'winwidth' applies to the current window. Use 'winminwidth' to set
7379 the minimal width for other windows.
7380
7381 *'wrap'* *'nowrap'*
7382'wrap' boolean (default on)
7383 local to window
7384 {not in Vi}
7385 This option changes how text is displayed. It doesn't change the text
7386 in the buffer, see 'textwidth' for that.
7387 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007388 displaying continues on the next line. When off lines will not wrap
7389 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007390 moved to a part that is not shown, the screen will scroll
7391 horizontally.
7392 The line will be broken in the middle of a word if necessary. See
7393 'linebreak' to get the break at a word boundary.
7394 To make scrolling horizontally a bit more useful, try this: >
7395 :set sidescroll=5
7396 :set listchars+=precedes:<,extends:>
7397< See 'sidescroll', 'listchars' and |wrap-off|.
7398
7399 *'wrapmargin'* *'wm'*
7400'wrapmargin' 'wm' number (default 0)
7401 local to buffer
7402 Number of characters from the right window border where wrapping
7403 starts. When typing text beyond this limit, an <EOL> will be inserted
7404 and inserting continues on the next line.
7405 Options that add a margin, such as 'number' and 'foldcolumn', cause
7406 the text width to be further reduced. This is Vi compatible.
7407 When 'textwidth' is non-zero, this option is not used.
7408 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7409 and less usefully}
7410
7411 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7412'wrapscan' 'ws' boolean (default on) *E384* *E385*
7413 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00007414 Searches wrap around the end of the file. Also applies to |]s| and
7415 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007416
7417 *'write'* *'nowrite'*
7418'write' boolean (default on)
7419 global
7420 {not in Vi}
7421 Allows writing files. When not set, writing a file is not allowed.
7422 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007423 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007424 argument. Filtering text is still possible, even though this requires
7425 writing a temporary file.
7426
7427 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
7428'writeany' 'wa' boolean (default off)
7429 global
7430 Allows writing to any file with no need for "!" override.
7431
7432 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
7433'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
7434 otherwise)
7435 global
7436 {not in Vi}
7437 Make a backup before overwriting a file. The backup is removed after
7438 the file was successfully written, unless the 'backup' option is
7439 also on. Reset this option if your file system is almost full. See
7440 |backup-table| for another explanation.
7441 When the 'backupskip' pattern matches, a backup is not made anyway.
7442 NOTE: This option is set to the default value when 'compatible' is
7443 set.
7444
7445 *'writedelay'* *'wd'*
7446'writedelay' 'wd' number (default 0)
7447 global
7448 {not in Vi}
7449 The number of microseconds to wait for each character sent to the
7450 screen. When non-zero, characters are sent to the terminal one by
7451 one. For MS-DOS pcterm this does not work. For debugging purposes.
7452
7453 vim:tw=78:ts=8:ft=help:norl: