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