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