blob: b48030f1281dc065b759c9f98acb188c4cd13c83 [file] [log] [blame]
Bram Moolenaarfff2bee2010-05-15 13:56:02 +02001*options.txt* For Vim version 7.3a. Last change: 2010 May 13
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
Bram Moolenaar00a927d2010-05-14 23:24:24 +020043 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000044:se[t] {option}! or
45:se[t] inv{option} Toggle option: Invert value. {not in Vi}
46
47 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
48:se[t] {option}& Reset option to its default value. May depend on the
49 current value of 'compatible'. {not in Vi}
50:se[t] {option}&vi Reset option to its Vi default value. {not in Vi}
51:se[t] {option}&vim Reset option to its Vim default value. {not in Vi}
52
53:se[t] all& Set all options, except terminal options, to their
Bram Moolenaarf4b8e572004-06-24 15:53:16 +000054 default value. The values of 'term', 'lines' and
Bram Moolenaar071d4272004-06-13 20:20:40 +000055 'columns' are not changed. {not in Vi}
56
57 *:set-args* *E487* *E521*
58:se[t] {option}={value} or
59:se[t] {option}:{value}
60 Set string or number option to {value}.
61 For numeric options the value can be given in decimal,
62 hex (preceded with 0x) or octal (preceded with '0')
63 (hex and octal are only available for machines which
64 have the strtol() function).
65 The old value can be inserted by typing 'wildchar' (by
66 default this is a <Tab> or CTRL-E if 'compatible' is
67 set). See |cmdline-completion|.
68 White space between {option} and '=' is allowed and
69 will be ignored. White space between '=' and {value}
70 is not allowed.
71 See |option-backslash| for using white space and
72 backslashes in {value}.
73
74:se[t] {option}+={value} *:set+=*
75 Add the {value} to a number option, or append the
76 {value} to a string option. When the option is a
77 comma separated list, a comma is added, unless the
78 value was empty.
79 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000080 are removed. When adding a flag that was already
81 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000082 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000083 {not in Vi}
84
85:se[t] {option}^={value} *:set^=*
86 Multiply the {value} to a number option, or prepend
87 the {value} to a string option. When the option is a
88 comma separated list, a comma is added, unless the
89 value was empty.
90 Also see |:set-args| above.
91 {not in Vi}
92
93:se[t] {option}-={value} *:set-=*
94 Subtract the {value} from a number option, or remove
95 the {value} from a string option, if it is there.
96 If the {value} is not found in a string option, there
97 is no error or warning. When the option is a comma
98 separated list, a comma is deleted, unless the option
99 becomes empty.
100 When the option is a list of flags, {value} must be
101 exactly as they appear in the option. Remove flags
102 one by one to avoid problems.
103 Also see |:set-args| above.
104 {not in Vi}
105
106The {option} arguments to ":set" may be repeated. For example: >
107 :set ai nosi sw=3 ts=3
108If you make an error in one of the arguments, an error message will be given
109and the following arguments will be ignored.
110
111 *:set-verbose*
112When 'verbose' is non-zero, displaying an option value will also tell where it
113was last set. Example: >
114 :verbose set shiftwidth cindent?
Bram Moolenaar446cb832008-06-24 21:56:24 +0000115< shiftwidth=4 ~
116 Last set from modeline ~
117 cindent ~
118 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim ~
119This is only done when specific option values are requested, not for ":verbose
120set all" or ":verbose set" without an argument.
121When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000122When the option was set while executing a function, user command or
123autocommand, the script in which it was defined is reported.
124Note that an option may also have been set as a side effect of setting
125'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000126A few special texts:
127 Last set from modeline ~
128 Option was set in a |modeline|.
129 Last set from --cmd argument ~
130 Option was set with command line argument |--cmd| or +.
131 Last set from -c argument ~
132 Option was set with command line argument |-c|, +, |-S| or
133 |-q|.
134 Last set from environment variable ~
135 Option was set from an environment variable, $VIMINIT,
136 $GVIMINIT or $EXINIT.
137 Last set from error handler ~
138 Option was cleared when evaluating it resulted in an error.
139
Bram Moolenaar071d4272004-06-13 20:20:40 +0000140{not available when compiled without the +eval feature}
141
142 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000143For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000144override the value from the termcap. You can then use it in a mapping. If
145the "xx" part contains special characters, use the <t_xx> form: >
146 :set <t_#4>=^[Ot
147This can also be used to translate a special code for a normal key. For
148example, if Alt-b produces <Esc>b, use this: >
149 :set <M-b>=^[b
150(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
151The advantage over a mapping is that it works in all situations.
152
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000153The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
154security reasons.
155
Bram Moolenaar071d4272004-06-13 20:20:40 +0000156The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000157at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000158"set all" probably does not fit on the screen, causing Vim to give the
159|more-prompt|.
160
161 *option-backslash*
162To include white space in a string option value it has to be preceded with a
163backslash. To include a backslash you have to use two. Effectively this
164means that the number of backslashes in an option value is halved (rounded
165down).
166A few examples: >
167 :set tags=tags\ /usr/tags results in "tags /usr/tags"
168 :set tags=tags\\,file results in "tags\,file"
169 :set tags=tags\\\ file results in "tags\ file"
170
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000171The "|" character separates a ":set" command from a following command. To
172include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000173'titlestring' option to "hi|there": >
174 :set titlestring=hi\|there
175This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
176 :set titlestring=hi|set iconstring=there
177
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000178Similarly, the double quote character starts a comment. To include the '"' in
179the option value, use '\"' instead. This example sets the 'titlestring'
180option to 'hi "there"': >
181 :set titlestring=hi\ \"there\"
182
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000183For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000184precise: For options that expect a file name (those where environment
185variables are expanded) a backslash before a normal file name character is not
186removed. But a backslash before a special character (space, backslash, comma,
187etc.) is used like explained above.
188There is one special situation, when the value starts with "\\": >
189 :set dir=\\machine\path results in "\\machine\path"
190 :set dir=\\\\machine\\path results in "\\machine\path"
191 :set dir=\\path\\file results in "\\path\file" (wrong!)
192For the first one the start is kept, but for the second one the backslashes
193are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000194halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000195result which is probably not what you want. Avoid it.
196
197 *add-option-flags* *remove-option-flags*
198 *E539* *E550* *E551* *E552*
199Some options are a list of flags. When you want to add a flag to such an
200option, without changing the existing ones, you can do it like this: >
201 :set guioptions+=a
202Remove a flag from an option like this: >
203 :set guioptions-=a
204This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000205Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000206the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
207doesn't appear.
208
209 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000210Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000211environment variable exists the '$' and the following environment variable
212name is replaced with its value. If it does not exist the '$' and the name
213are not modified. Any non-id character (not a letter, digit or '_') may
214follow the environment variable name. That character and what follows is
215appended to the value of the environment variable. Examples: >
216 :set term=$TERM.new
217 :set path=/usr/$INCLUDE,$HOME/include,.
218When adding or removing a string from an option with ":set opt-=val" or ":set
219opt+=val" the expansion is done before the adding or removing.
220
221
222Handling of local options *local-options*
223
224Some of the options only apply to a window or buffer. Each window or buffer
225has its own copy of this option, thus can each have their own value. This
226allows you to set 'list' in one window but not in another. And set
227'shiftwidth' to 3 in one buffer and 4 in another.
228
229The following explains what happens to these local options in specific
230situations. You don't really need to know all of this, since Vim mostly uses
231the option values you would expect. Unfortunately, doing what the user
232expects is a bit complicated...
233
234When splitting a window, the local options are copied to the new window. Thus
235right after the split the contents of the two windows look the same.
236
237When editing a new buffer, its local option values must be initialized. Since
238the local options of the current buffer might be specifically for that buffer,
239these are not used. Instead, for each buffer-local option there also is a
240global value, which is used for new buffers. With ":set" both the local and
241global value is changed. With "setlocal" only the local value is changed,
242thus this value is not used when editing a new buffer.
243
244When editing a buffer that has been edited before, the last used window
245options are used again. If this buffer has been edited in this window, the
246values from back then are used. Otherwise the values from the window where
247the buffer was edited last are used.
248
249It's possible to set a local window option specifically for a type of buffer.
250When you edit another buffer in the same window, you don't want to keep
251using these local window options. Therefore Vim keeps a global value of the
252local window options, which is used when editing another buffer. Each window
253has its own copy of these values. Thus these are local to the window, but
254global to all buffers in the window. With this you can do: >
255 :e one
256 :set list
257 :e two
258Now the 'list' option will also be set in "two", since with the ":set list"
259command you have also set the global value. >
260 :set nolist
261 :e one
262 :setlocal list
263 :e two
264Now the 'list' option is not set, because ":set nolist" resets the global
265value, ":setlocal list" only changes the local value and ":e two" gets the
266global value. Note that if you do this next: >
267 :e one
268You will not get back the 'list' value as it was the last time you edited
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000269"one". The options local to a window are not remembered for each buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000270
271 *:setl* *:setlocal*
272:setl[ocal] ... Like ":set" but set only the value local to the
273 current buffer or window. Not all options have a
274 local value. If the option does not have a local
275 value the global value is set.
276 With the "all" argument: display all local option's
277 local values.
278 Without argument: Display all local option's local
279 values which are different from the default.
280 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000281 local value. For a global/local boolean option, when
282 the global value is being used, "--" is displayed
283 before the option name.
284 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000285 shown (but that might change in the future).
286 {not in Vi}
287
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000288:setl[ocal] {option}< Set the local value of {option} to its global value by
289 copying the value.
290 {not in Vi}
291
292:se[t] {option}< Set the local value of {option} to its global value by
293 making it empty. Only makes sense for |global-local|
294 options.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000295 {not in Vi}
296
297 *:setg* *:setglobal*
298:setg[lobal] ... Like ":set" but set only the global value for a local
299 option without changing the local value.
300 When displaying an option, the global value is shown.
301 With the "all" argument: display all local option's
302 global values.
303 Without argument: display all local option's global
304 values which are different from the default.
305 {not in Vi}
306
307For buffer-local and window-local options:
308 Command global value local value ~
309 :set option=value set set
310 :setlocal option=value - set
311:setglobal option=value set -
312 :set option? - display
313 :setlocal option? - display
314:setglobal option? display -
315
316
317Global options with a local value *global-local*
318
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000319Options are global when you mostly use one value for all buffers and windows.
320For some global options it's useful to sometimes have a different local value.
321You can set the local value with ":setlocal". That buffer or window will then
322use the local value, while other buffers and windows continue using the global
323value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000324
325For example, you have two windows, both on C source code. They use the global
326'makeprg' option. If you do this in one of the two windows: >
327 :set makeprg=gmake
328then the other window will switch to the same value. There is no need to set
329the 'makeprg' option in the other C source window too.
330However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000331another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000332files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000333 :setlocal makeprg=perlmake
334You can switch back to using the global value by making the local value empty: >
335 :setlocal makeprg=
336This only works for a string option. For a boolean option you need to use the
337"<" flag, like this: >
338 :setlocal autoread<
339Note that for non-boolean options using "<" copies the global value to the
340local value, it doesn't switch back to using the global value (that matters
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000341when the global value changes later). You can also use: >
342 :set path<
343This will make the local value of 'path' empty, so that the global value is
344used. Thus it does the same as: >
345 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000346Note: In the future more global options can be made global-local. Using
347":setlocal" on a global option might work differently then.
348
349
350Setting the filetype
351
352:setf[iletype] {filetype} *:setf* *:setfiletype*
353 Set the 'filetype' option to {filetype}, but only if
354 not done yet in a sequence of (nested) autocommands.
355 This is short for: >
356 :if !did_filetype()
357 : setlocal filetype={filetype}
358 :endif
359< This command is used in a filetype.vim file to avoid
360 setting the 'filetype' option twice, causing different
361 settings and syntax files to be loaded.
362 {not in Vi}
363
364:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
365:opt[ions] Open a window for viewing and setting all options.
366 Options are grouped by function.
367 Offers short help for each option. Hit <CR> on the
368 short help to open a help window with more help for
369 the option.
370 Modify the value of the option and hit <CR> on the
371 "set" line to set the new value. For window and
372 buffer specific options, the last accessed window is
373 used to set the option value in, unless this is a help
374 window, in which case the window below help window is
375 used (skipping the option-window).
376 {not available when compiled without the |+eval| or
377 |+autocmd| features}
378
379 *$HOME*
380Using "~" is like using "$HOME", but it is only recognized at the start of an
381option and after a space or comma.
382
383On Unix systems "~user" can be used too. It is replaced by the home directory
384of user "user". Example: >
385 :set path=~mool/include,/usr/include,.
386
387On Unix systems the form "${HOME}" can be used too. The name between {} can
388contain non-id characters then. Note that if you want to use this for the
389"gf" command, you need to add the '{' and '}' characters to 'isfname'.
390
391NOTE: expanding environment variables and "~/" is only done with the ":set"
392command, not when assigning a value to an option with ":let".
393
394
395Note the maximum length of an expanded option is limited. How much depends on
396the system, mostly it is something like 256 or 1024 characters.
397
398 *:fix* *:fixdel*
399:fix[del] Set the value of 't_kD':
400 't_kb' is 't_kD' becomes ~
401 CTRL-? CTRL-H
402 not CTRL-? CTRL-?
403
404 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
405
406 If your delete key terminal code is wrong, but the
407 code for backspace is alright, you can put this in
408 your .vimrc: >
409 :fixdel
410< This works no matter what the actual code for
411 backspace is.
412
413 If the backspace key terminal code is wrong you can
414 use this: >
415 :if &term == "termname"
416 : set t_kb=^V<BS>
417 : fixdel
418 :endif
419< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000420 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000421 with your terminal name.
422
423 If your <Delete> key sends a strange key sequence (not
424 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
425 :if &term == "termname"
426 : set t_kD=^V<Delete>
427 :endif
428< Where "^V" is CTRL-V and "<Delete>" is the delete key
429 (don't type eight characters!). Replace "termname"
430 with your terminal name.
431
432 *Linux-backspace*
433 Note about Linux: By default the backspace key
434 produces CTRL-?, which is wrong. You can fix it by
435 putting this line in your rc.local: >
436 echo "keycode 14 = BackSpace" | loadkeys
437<
438 *NetBSD-backspace*
439 Note about NetBSD: If your backspace doesn't produce
440 the right code, try this: >
441 xmodmap -e "keycode 22 = BackSpace"
442< If this works, add this in your .Xmodmap file: >
443 keysym 22 = BackSpace
444< You need to restart for this to take effect.
445
446==============================================================================
4472. Automatically setting options *auto-setting*
448
449Besides changing options with the ":set" command, there are three alternatives
450to set options automatically for one or more files:
451
4521. When starting Vim initializations are read from various places. See
453 |initialization|. Most of them are performed for all editing sessions,
454 and some of them depend on the directory where Vim is started.
455 You can create an initialization file with |:mkvimrc|, |:mkview| and
456 |:mksession|.
4572. If you start editing a new file, the automatic commands are executed.
458 This can be used to set options for files matching a particular pattern and
459 many other things. See |autocommand|.
4603. If you start editing a new file, and the 'modeline' option is on, a
461 number of lines at the beginning and end of the file are checked for
462 modelines. This is explained here.
463
464 *modeline* *vim:* *vi:* *ex:* *E520*
465There are two forms of modelines. The first form:
466 [text]{white}{vi:|vim:|ex:}[white]{options}
467
468[text] any text or empty
469{white} at least one blank character (<Space> or <Tab>)
470{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
471[white] optional white space
472{options} a list of option settings, separated with white space or ':',
473 where each part between ':' is the argument for a ":set"
Bram Moolenaar02467872007-05-06 13:22:01 +0000474 command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000475
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000476Example:
477 vi:noai:sw=3 ts=6 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000478
479The second form (this is compatible with some versions of Vi):
480
481 [text]{white}{vi:|vim:|ex:}[white]se[t] {options}:[text]
482
483[text] any text or empty
484{white} at least one blank character (<Space> or <Tab>)
485{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
486[white] optional white space
487se[t] the string "set " or "se " (note the space)
488{options} a list of options, separated with white space, which is the
489 argument for a ":set" command
490: a colon
491[text] any text or empty
492
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000493Example:
494 /* vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000495
496The white space before {vi:|vim:|ex:} is required. This minimizes the chance
497that a normal word like "lex:" is caught. There is one exception: "vi:" and
498"vim:" can also be at the start of the line (for compatibility with version
4993.0). Using "ex:" at the start of the line will be ignored (this could be
500short for "example:").
501
502 *modeline-local*
503The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000504buffer and window that contain the file. Although it's possible to set global
505options from a modeline, this is unusual. If you have two windows open and
506the files in it set the same global option to a different value, the result
507depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000508
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000509When editing a file that was already loaded, only the window-local options
510from the modeline are used. Thus if you manually changed a buffer-local
511option after opening the file, it won't be changed if you edit the same buffer
512in another window. But window-local options will be set.
513
Bram Moolenaar071d4272004-06-13 20:20:40 +0000514 *modeline-version*
515If the modeline is only to be used for some versions of Vim, the version
516number can be specified where "vim:" is used:
517 vim{vers}: version {vers} or later
518 vim<{vers}: version before {vers}
519 vim={vers}: version {vers}
520 vim>{vers}: version after {vers}
521{vers} is 600 for Vim 6.0 (hundred times the major version plus minor).
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000522For example, to use a modeline only for Vim 6.0 and later:
523 /* vim600: set foldmethod=marker: */ ~
524To use a modeline for Vim before version 5.7:
525 /* vim<570: set sw=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000526There can be no blanks between "vim" and the ":".
527
528
529The number of lines that are checked can be set with the 'modelines' option.
530If 'modeline' is off or 'modelines' is 0 no lines are checked.
531
532Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000533like:
534 /* vi:ts=4: */ ~
535will give an error message for the trailing "*/". This line is OK:
536 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000537
538If an error is detected the rest of the line is skipped.
539
540If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000541backslash in front of the ':' will be removed. Example:
542 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000543This sets the 'dir' option to "c:\tmp". Only a single backslash before the
544':' is removed. Thus to include "\:" you have to specify "\\:".
545
546No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000547might create a Trojan horse text file with modelines). And not all options
548can be set. For some options a flag is set, so that when it's used the
Bram Moolenaar02467872007-05-06 13:22:01 +0000549|sandbox| is effective. Still, there is always a small risk that a modeline
Bram Moolenaar8243a792007-05-01 17:05:03 +0000550causes trouble. E.g., when some joker sets 'textwidth' to 5 all your lines
551are wrapped unexpectedly. So disable modelines before editing untrusted text.
552The mail ftplugin does this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000553
554Hint: If you would like to do something else than setting an option, you could
555define an autocommand that checks the file for a specific string. For
556example: >
557 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
558And define a function SetVar() that does something with the line containing
559"VAR".
560
561==============================================================================
5623. Options summary *option-summary*
563
564In the list below all the options are mentioned with their full name and with
565an abbreviation if there is one. Both forms may be used.
566
567In this document when a boolean option is "set" that means that ":set option"
568is entered. When an option is "reset", ":set nooption" is used.
569
570For some options there are two default values: The "Vim default", which is
571used when 'compatible' is not set, and the "Vi default", which is used when
572'compatible' is set.
573
574Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000575are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000576different value in each window. For example the 'list' option can be set in
577one window and reset in another for the same text, giving both types of view
578at the same time. There are a few options that are specific to a certain
579file. These can have a different value for each file or buffer. For example
580the 'textwidth' option can be 78 for a normal text file and 0 for a C
581program.
582
583 global one option for all buffers and windows
584 local to window each window has its own copy of this option
585 local to buffer each buffer has its own copy of this option
586
587When creating a new window the option values from the currently active window
588are used as a default value for the window-specific options. For the
589buffer-specific options this depends on the 's' and 'S' flags in the
590'cpoptions' option. If 's' is included (which is the default) the values for
591buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000592first entered. If 'S' is present the options are copied each time the buffer
593is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000594present, the options are copied from the currently active buffer when the
595buffer is created.
596
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000597Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000598
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000599Not all options are supported in all versions. This depends on the supported
600features and sometimes on the system. A remark about this is in curly braces
601below. When an option is not supported it may still be set without getting an
602error, this is called a hidden option. You can't get the value of a hidden
603option though, it is not stored.
604
605To test if option "foo" can be used with ":set" use something like this: >
606 if exists('&foo')
607This also returns true for a hidden option. To test if option "foo" is really
608supported use something like this: >
609 if exists('+foo')
610<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000611 *E355*
612A jump table for the options with a short description can be found at |Q_op|.
613
614 *'aleph'* *'al'* *aleph* *Aleph*
615'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
616 global
617 {not in Vi}
618 {only available when compiled with the |+rightleft|
619 feature}
620 The ASCII code for the first letter of the Hebrew alphabet. The
621 routine that maps the keyboard in Hebrew mode, both in Insert mode
622 (when hkmap is set) and on the command-line (when hitting CTRL-_)
623 outputs the Hebrew characters in the range [aleph..aleph+26].
624 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
625 See |rileft.txt|.
626
627 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
628'allowrevins' 'ari' boolean (default off)
629 global
630 {not in Vi}
631 {only available when compiled with the |+rightleft|
632 feature}
633 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
634 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
635 into reverse Insert mode, and don't know how to get out. See
636 'revins'.
637 NOTE: This option is reset when 'compatible' is set.
638
639 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
640'altkeymap' 'akm' boolean (default off)
641 global
642 {not in Vi}
643 {only available when compiled with the |+farsi|
644 feature}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000645 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000646 the keyboard map between Farsi and English, when 'allowrevins' set.
647
Bram Moolenaar582fd852005-03-28 20:58:01 +0000648 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000649 is useful to start the Vim in native mode i.e. English (left-to-right
650 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000651 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000652
653 *'ambiwidth'* *'ambw'*
654'ambiwidth' 'ambw' string (default: "single")
655 global
656 {not in Vi}
657 {only available when compiled with the |+multi_byte|
658 feature}
659 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
660 Tells Vim what to do with characters with East Asian Width Class
661 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
662 letters, Cyrillic letters).
663
664 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000665 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000666 expected by most users.
667 "double": Use twice the width of ASCII characters.
668
669 There are a number of CJK fonts for which the width of glyphs for
670 those characters are solely based on how many octets they take in
671 legacy/traditional CJK encodings. In those encodings, Euro,
672 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000673 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000674 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000675 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000676 Vim is running inside a terminal (emulators) that uses a CJK font
677 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
678 this option should be set to "double" to match the width perceived
679 by Vim with the width of glyphs in the font. Perhaps it also has
680 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
681 when the system locale is set to one of CJK locales. See Unicode
682 Standard Annex #11 (http://www.unicode.org/reports/tr11).
683
684 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
685'antialias' 'anti' boolean (default: off)
686 global
687 {not in Vi}
688 {only available when compiled with GUI enabled
689 on Mac OS X}
690 This option only has an effect in the GUI version of Vim on Mac OS X
691 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
692 which can be easier to read at certain sizes on certain displays.
693 Setting this option can sometimes cause problems if 'guifont' is set
694 to its default (empty string).
695
696 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
697'autochdir' 'acd' boolean (default off)
698 global
699 {not in Vi}
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200700 {only available when compiled with it, use
701 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000702 When on, Vim will change the current working directory whenever you
703 open a file, switch buffers, delete a buffer or open/close a window.
704 It will change to the directory containing the file which was opened
705 or selected.
706 This option is provided for backward compatibility with the Vim
707 released with Sun ONE Studio 4 Enterprise Edition.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000708 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000709
710 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
711'arabic' 'arab' boolean (default off)
712 local to window
713 {not in Vi}
714 {only available when compiled with the |+arabic|
715 feature}
716 This option can be set to start editing Arabic text.
717 Setting this option will:
718 - Set the 'rightleft' option, unless 'termbidi' is set.
719 - Set the 'arabicshape' option, unless 'termbidi' is set.
720 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
721 between typing English and Arabic key mapping.
722 - Set the 'delcombine' option
723 Note that 'encoding' must be "utf-8" for working with Arabic text.
724
725 Resetting this option will:
726 - Reset the 'rightleft' option.
727 - Disable the use of 'keymap' (without changing its value).
728 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
729 option.
730 Also see |arabic.txt|.
731
732 *'arabicshape'* *'arshape'*
733 *'noarabicshape'* *'noarshape'*
734'arabicshape' 'arshape' boolean (default on)
735 global
736 {not in Vi}
737 {only available when compiled with the |+arabic|
738 feature}
739 When on and 'termbidi' is off, the required visual character
740 corrections that need to take place for displaying the Arabic language
741 take affect. Shaping, in essence, gets enabled; the term is a broad
742 one which encompasses:
743 a) the changing/morphing of characters based on their location
744 within a word (initial, medial, final and stand-alone).
745 b) the enabling of the ability to compose characters
746 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100747 When disabled the display shows each character's true stand-alone
748 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000749 Arabic is a complex language which requires other settings, for
750 further details see |arabic.txt|.
751
752 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
753'autoindent' 'ai' boolean (default off)
754 local to buffer
755 Copy indent from current line when starting a new line (typing <CR>
756 in Insert mode or when using the "o" or "O" command). If you do not
757 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000758 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
759 to another line has the same effect, unless the 'I' flag is included
760 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000761 When autoindent is on, formatting (with the "gq" command or when you
762 reach 'textwidth' in Insert mode) uses the indentation of the first
763 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000764 When 'smartindent' or 'cindent' is on the indent is changed in
765 a different way.
766 The 'autoindent' option is reset when the 'paste' option is set.
767 {small difference from Vi: After the indent is deleted when typing
768 <Esc> or <CR>, the cursor position when moving up or down is after the
769 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
770
771 *'autoread'* *'ar'* *'noautoread'* *'noar'*
772'autoread' 'ar' boolean (default off)
773 global or local to buffer |global-local|
774 {not in Vi}
775 When a file has been detected to have been changed outside of Vim and
776 it has not been changed inside of Vim, automatically read it again.
777 When the file has been deleted this is not done. |timestamp|
778 If this option has a local value, use this command to switch back to
779 using the global value: >
780 :set autoread<
781<
782 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
783'autowrite' 'aw' boolean (default off)
784 global
785 Write the contents of the file, if it has been modified, on each
786 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000787 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000788 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
789 Note that for some commands the 'autowrite' option is not used, see
790 'autowriteall' for that.
791
792 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
793'autowriteall' 'awa' boolean (default off)
794 global
795 {not in Vi}
796 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
797 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
798 Setting this option also implies that Vim behaves like 'autowrite' has
799 been set.
800
801 *'background'* *'bg'*
802'background' 'bg' string (default "dark" or "light")
803 global
804 {not in Vi}
805 When set to "dark", Vim will try to use colors that look good on a
806 dark background. When set to "light", Vim will try to use colors that
807 look good on a light background. Any other value is illegal.
808 Vim tries to set the default value according to the terminal used.
809 This will not always be correct.
810 Setting this option does not change the background color, it tells Vim
811 what the background color looks like. For changing the background
812 color, see |:hi-normal|.
813
814 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000815 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000816 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100817 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000818 setting 'background' will cause the color scheme to be reloaded. If
819 the color scheme adjusts to the value of 'background' this will work.
820 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100821 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000822
823 When setting 'background' to the default value with: >
824 :set background&
825< Vim will guess the value. In the GUI this should work correctly,
826 in other cases Vim might not be able to guess the right value.
827
828 When starting the GUI, the default value for 'background' will be
829 "light". When the value is not set in the .gvimrc, and Vim detects
830 that the background is actually quite dark, 'background' is set to
831 "dark". But this happens only AFTER the .gvimrc file has been read
832 (because the window needs to be opened to find the actual background
833 color). To get around this, force the GUI window to be opened by
834 putting a ":gui" command in the .gvimrc file, before where the value
835 of 'background' is used (e.g., before ":syntax on").
836 Normally this option would be set in the .vimrc file. Possibly
837 depending on the terminal name. Example: >
838 :if &term == "pcterm"
839 : set background=dark
840 :endif
841< When this option is set, the default settings for the highlight groups
842 will change. To use other settings, place ":highlight" commands AFTER
843 the setting of the 'background' option.
844 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
845 to select the colors for syntax highlighting. After changing this
846 option, you must load syntax.vim again to see the result. This can be
847 done with ":syntax on".
848
849 *'backspace'* *'bs'*
850'backspace' 'bs' string (default "")
851 global
852 {not in Vi}
853 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
854 mode. This is a list of items, separated by commas. Each item allows
855 a way to backspace over something:
856 value effect ~
857 indent allow backspacing over autoindent
858 eol allow backspacing over line breaks (join lines)
859 start allow backspacing over the start of insert; CTRL-W and CTRL-U
860 stop once at the start of insert.
861
862 When the value is empty, Vi compatible backspacing is used.
863
864 For backwards compatibility with version 5.4 and earlier:
865 value effect ~
866 0 same as ":set backspace=" (Vi compatible)
867 1 same as ":set backspace=indent,eol"
868 2 same as ":set backspace=indent,eol,start"
869
870 See |:fixdel| if your <BS> or <Del> key does not do what you want.
871 NOTE: This option is set to "" when 'compatible' is set.
872
873 *'backup'* *'bk'* *'nobackup'* *'nobk'*
874'backup' 'bk' boolean (default off)
875 global
876 {not in Vi}
877 Make a backup before overwriting a file. Leave it around after the
878 file has been successfully written. If you do not want to keep the
879 backup file, but you do want a backup while the file is being
880 written, reset this option and set the 'writebackup' option (this is
881 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000882 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000883 |backup-table| for more explanations.
884 When the 'backupskip' pattern matches, a backup is not made anyway.
885 When 'patchmode' is set, the backup may be renamed to become the
886 oldest version of a file.
887 NOTE: This option is reset when 'compatible' is set.
888
889 *'backupcopy'* *'bkc'*
890'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
891 global
892 {not in Vi}
893 When writing a file and a backup is made, this option tells how it's
894 done. This is a comma separated list of words.
895
896 The main values are:
897 "yes" make a copy of the file and overwrite the original one
898 "no" rename the file and write a new one
899 "auto" one of the previous, what works best
900
901 Extra values that can be combined with the ones above are:
902 "breaksymlink" always break symlinks when writing
903 "breakhardlink" always break hardlinks when writing
904
905 Making a copy and overwriting the original file:
906 - Takes extra time to copy the file.
907 + When the file has special attributes, is a (hard/symbolic) link or
908 has a resource fork, all this is preserved.
909 - When the file is a link the backup will have the name of the link,
910 not of the real file.
911
912 Renaming the file and writing a new one:
913 + It's fast.
914 - Sometimes not all attributes of the file can be copied to the new
915 file.
916 - When the file is a link the new file will not be a link.
917
918 The "auto" value is the middle way: When Vim sees that renaming file
919 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000920 the file is not a link) that is used. When problems are expected, a
921 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000922
923 The "breaksymlink" and "breakhardlink" values can be used in
924 combination with any of "yes", "no" and "auto". When included, they
925 force Vim to always break either symbolic or hard links by doing
926 exactly what the "no" option does, renaming the original file to
927 become the backup and writing a new file in its place. This can be
928 useful for example in source trees where all the files are symbolic or
929 hard links and any changes should stay in the local source tree, not
930 be propagated back to the original source.
931 *crontab*
932 One situation where "no" and "auto" will cause problems: A program
933 that opens a file, invokes Vim to edit that file, and then tests if
934 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000935 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000936 example.
937
938 When a copy is made, the original file is truncated and then filled
939 with the new text. This means that protection bits, owner and
940 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000941 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000942 group of the backup is set to the group of the original file. If this
943 fails, the protection bits for the group are made the same as for
944 others.
945
946 When the file is renamed this is the other way around: The backup has
947 the same attributes of the original file, and the newly written file
948 is owned by the current user. When the file was a (hard/symbolic)
949 link, the new file will not! That's why the "auto" value doesn't
950 rename when the file is a link. The owner and group of the newly
951 written file will be set to the same ones as the original file, but
952 the system may refuse to do this. In that case the "auto" value will
953 again not rename the file.
954
955 *'backupdir'* *'bdir'*
956'backupdir' 'bdir' string (default for Amiga: ".,t:",
957 for MS-DOS and Win32: ".,c:/tmp,c:/temp"
958 for Unix: ".,~/tmp,~/")
959 global
960 {not in Vi}
961 List of directories for the backup file, separated with commas.
962 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100963 where this is possible. The directory must exist, Vim will not
964 create it for you.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000965 - Empty means that no backup file will be created ('patchmode' is
966 impossible!). Writing may fail because of this.
967 - A directory "." means to put the backup file in the same directory
968 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +0000969 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000970 put the backup file relative to where the edited file is. The
971 leading "." is replaced with the path name of the edited file.
972 ("." inside a directory name has no special meaning).
973 - Spaces after the comma are ignored, other spaces are considered part
974 of the directory name. To have a space at the start of a directory
975 name, precede it with a backslash.
976 - To include a comma in a directory name precede it with a backslash.
977 - A directory name may end in an '/'.
978 - Environment variables are expanded |:set_env|.
979 - Careful with '\' characters, type one before a space, type two to
980 get one in the option (see |option-backslash|), for example: >
981 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
982< - For backwards compatibility with Vim version 3.0 a '>' at the start
983 of the option is removed.
984 See also 'backup' and 'writebackup' options.
985 If you want to hide your backup files on Unix, consider this value: >
986 :set backupdir=./.backup,~/.backup,.,/tmp
987< You must create a ".backup" directory in each directory and in your
988 home directory for this to work properly.
989 The use of |:set+=| and |:set-=| is preferred when adding or removing
990 directories from the list. This avoids problems when a future version
991 uses another default.
992 This option cannot be set from a |modeline| or in the |sandbox|, for
993 security reasons.
994
995 *'backupext'* *'bex'* *E589*
996'backupext' 'bex' string (default "~", for VMS: "_")
997 global
998 {not in Vi}
999 String which is appended to a file name to make the name of the
1000 backup file. The default is quite unusual, because this avoids
1001 accidentally overwriting existing files with a backup file. You might
1002 prefer using ".bak", but make sure that you don't have files with
1003 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001004 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001005
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001006 If you like to keep a lot of backups, you could use a BufWritePre
1007 autocommand to change 'backupext' just before writing the file to
1008 include a timestamp. >
1009 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1010< Use 'backupdir' to put the backup in a different directory.
1011
Bram Moolenaar071d4272004-06-13 20:20:40 +00001012 *'backupskip'* *'bsk'*
1013'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
1014 global
1015 {not in Vi}
1016 {not available when compiled without the |+wildignore|
1017 feature}
1018 A list of file patterns. When one of the patterns matches with the
1019 name of the file which is written, no backup file is created. Both
1020 the specified file name and the full path name of the file are used.
1021 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1022 Watch out for special characters, see |option-backslash|.
1023 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001024 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001025
1026 Note that environment variables are not expanded. If you want to use
1027 $HOME you must expand it explicitly, e.g.: >
1028 :let backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
1029
1030< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001031 backup would be made by renaming the original file crontab won't see
1032 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001033
1034 *'balloondelay'* *'bdlay'*
1035'balloondelay' 'bdlay' number (default: 600)
1036 global
1037 {not in Vi}
1038 {only available when compiled with the |+balloon_eval|
1039 feature}
1040 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1041
1042 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1043'ballooneval' 'beval' boolean (default off)
1044 global
1045 {not in Vi}
1046 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001047 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001048 Switch on the |balloon-eval| functionality.
1049
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001050 *'balloonexpr'* *'bexpr'*
1051'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001052 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001053 {not in Vi}
1054 {only available when compiled with the |+balloon_eval|
1055 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001056 Expression for text to show in evaluation balloon. It is only used
1057 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001058
1059 v:beval_bufnr number of the buffer in which balloon is going to show
1060 v:beval_winnr number of the window
1061 v:beval_lnum line number
1062 v:beval_col column number (byte index)
1063 v:beval_text word under or after the mouse pointer
1064
1065 The evaluation of the expression must not have side effects!
1066 Example: >
1067 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001068 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001069 \', column ' . v:beval_col .
1070 \ ' of file ' . bufname(v:beval_bufnr) .
1071 \ ' on word "' . v:beval_text . '"'
1072 endfunction
1073 set bexpr=MyBalloonExpr()
1074 set ballooneval
1075<
1076 NOTE: The balloon is displayed only if the cursor is on a text
1077 character. If the result of evaluating 'balloonexpr' is not empty,
1078 Vim does not try to send a message to an external debugger (Netbeans
1079 or Sun Workshop).
1080
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001081 The expression may be evaluated in the |sandbox|, see
1082 |sandbox-option|.
1083
1084 It is not allowed to change text or jump to another window while
1085 evaluating 'balloonexpr' |textlock|.
1086
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001087 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001088 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001089< When they are supported "\n" characters will start a new line. If the
1090 expression evaluates to a |List| this is equal to using each List item
1091 as a string and putting "\n" in between them.
1092
Bram Moolenaar071d4272004-06-13 20:20:40 +00001093 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1094'binary' 'bin' boolean (default off)
1095 local to buffer
1096 {not in Vi}
1097 This option should be set before editing a binary file. You can also
1098 use the |-b| Vim argument. When this option is switched on a few
1099 options will be changed (also when it already was on):
1100 'textwidth' will be set to 0
1101 'wrapmargin' will be set to 0
1102 'modeline' will be off
1103 'expandtab' will be off
1104 Also, 'fileformat' and 'fileformats' options will not be used, the
1105 file is read and written like 'fileformat' was "unix" (a single <NL>
1106 separates lines).
1107 The 'fileencoding' and 'fileencodings' options will not be used, the
1108 file is read without conversion.
1109 NOTE: When you start editing a(nother) file while the 'bin' option is
1110 on, settings from autocommands may change the settings again (e.g.,
1111 'textwidth'), causing trouble when editing. You might want to set
1112 'bin' again when the file has been loaded.
1113 The previous values of these options are remembered and restored when
1114 'bin' is switched from on to off. Each buffer has its own set of
1115 saved option values.
1116 To edit a file with 'binary' set you can use the |++bin| argument.
1117 This avoids you have to do ":set bin", which would have effect for all
1118 files you edit.
1119 When writing a file the <EOL> for the last line is only written if
1120 there was one in the original file (normally Vim appends an <EOL> to
1121 the last line if there is none; this would make the file longer). See
1122 the 'endofline' option.
1123
1124 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1125'bioskey' 'biosk' boolean (default on)
1126 global
1127 {not in Vi} {only for MS-DOS}
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001128 When on the BIOS is called to obtain a keyboard character. This works
Bram Moolenaar071d4272004-06-13 20:20:40 +00001129 better to detect CTRL-C, but only works for the console. When using a
1130 terminal over a serial port reset this option.
1131 Also see |'conskey'|.
1132
1133 *'bomb'* *'nobomb'*
1134'bomb' boolean (default off)
1135 local to buffer
1136 {not in Vi}
1137 {only available when compiled with the |+multi_byte|
1138 feature}
1139 When writing a file and the following conditions are met, a BOM (Byte
1140 Order Mark) is prepended to the file:
1141 - this option is on
1142 - the 'binary' option is off
1143 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1144 endian variants.
1145 Some applications use the BOM to recognize the encoding of the file.
1146 Often used for UCS-2 files on MS-Windows. For other applications it
1147 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001148 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001149 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1150 check for the presence of the BOM is done and 'bomb' set accordingly.
1151 Unless 'binary' is set, it is removed from the first line, so that you
1152 don't see it when editing. When you don't change the options, the BOM
1153 will be restored when writing the file.
1154
1155 *'breakat'* *'brk'*
1156'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1157 global
1158 {not in Vi}
1159 {not available when compiled without the |+linebreak|
1160 feature}
1161 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001162 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1163 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001164
1165 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001166'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001167 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001168 {not in Vi} {only for Motif, Athena, GTK, Mac and
1169 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001170 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001171 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001172 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001173 buffer Use the directory of the related buffer.
1174 current Use the current directory.
1175 {path} Use the specified directory
1176
1177 *'bufhidden'* *'bh'*
1178'bufhidden' 'bh' string (default: "")
1179 local to buffer
1180 {not in Vi}
1181 {not available when compiled without the |+quickfix|
1182 feature}
1183 This option specifies what happens when a buffer is no longer
1184 displayed in a window:
1185 <empty> follow the global 'hidden' option
1186 hide hide the buffer (don't unload it), also when 'hidden'
1187 is not set
1188 unload unload the buffer, also when 'hidden' is set or using
1189 |:hide|
1190 delete delete the buffer from the buffer list, also when
1191 'hidden' is set or using |:hide|, like using
1192 |:bdelete|
1193 wipe wipe out the buffer from the buffer list, also when
1194 'hidden' is set or using |:hide|, like using
1195 |:bwipeout|
1196
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001197 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
1198 are lost without a warning.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001199 This option is used together with 'buftype' and 'swapfile' to specify
1200 special kinds of buffers. See |special-buffers|.
1201
1202 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1203'buflisted' 'bl' boolean (default: on)
1204 local to buffer
1205 {not in Vi}
1206 When this option is set, the buffer shows up in the buffer list. If
1207 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1208 This option is reset by Vim for buffers that are only used to remember
1209 a file name or marks. Vim sets it when starting to edit a buffer.
1210 But not when moving to a buffer with ":buffer".
1211
1212 *'buftype'* *'bt'* *E382*
1213'buftype' 'bt' string (default: "")
1214 local to buffer
1215 {not in Vi}
1216 {not available when compiled without the |+quickfix|
1217 feature}
1218 The value of this option specifies the type of a buffer:
1219 <empty> normal buffer
1220 nofile buffer which is not related to a file and will not be
1221 written
1222 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001223 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001224 autocommands. {not available when compiled without the
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001225 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001226 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001227 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001228 help help buffer (you are not supposed to set this
1229 manually)
1230
1231 This option is used together with 'bufhidden' and 'swapfile' to
1232 specify special kinds of buffers. See |special-buffers|.
1233
1234 Be careful with changing this option, it can have many side effects!
1235
Bram Moolenaar280f1262006-01-30 00:14:18 +00001236 A "quickfix" buffer is only used for the error list and the location
1237 list. This value is set by the |:cwindow| and |:lwindow| commands and
1238 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001239
1240 "nofile" and "nowrite" buffers are similar:
1241 both: The buffer is not to be written to disk, ":w" doesn't
1242 work (":w filename" does work though).
1243 both: The buffer is never considered to be |'modified'|.
1244 There is no warning when the changes will be lost, for
1245 example when you quit Vim.
1246 both: A swap file is only created when using too much memory
1247 (when 'swapfile' has been reset there is never a swap
1248 file).
1249 nofile only: The buffer name is fixed, it is not handled like a
1250 file name. It is not modified in response to a |:cd|
1251 command.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001252 *E676*
1253 "acwrite" implies that the buffer name is not related to a file, like
1254 "nofile", but it will be written. Thus, in contrast to "nofile" and
1255 "nowrite", ":w" does work and a modified buffer can't be abandoned
1256 without saving. For writing there must be matching |BufWriteCmd|,
1257 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001258
1259 *'casemap'* *'cmp'*
1260'casemap' 'cmp' string (default: "internal,keepascii")
1261 global
1262 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001263 {only available when compiled with the |+multi_byte|
1264 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001265 Specifies details about changing the case of letters. It may contain
1266 these words, separated by a comma:
1267 internal Use internal case mapping functions, the current
1268 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001269 matters when 'encoding' is a Unicode encoding,
1270 "latin1" or "iso-8859-15". When "internal" is
1271 omitted, the towupper() and towlower() system library
1272 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001273 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1274 case mapping, the current locale is not effective.
1275 This probably only matters for Turkish.
1276
1277 *'cdpath'* *'cd'* *E344* *E346*
1278'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1279 global
1280 {not in Vi}
1281 {not available when compiled without the
1282 |+file_in_path| feature}
1283 This is a list of directories which will be searched when using the
1284 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001285 for has a relative path, not an absolute part starting with "/", "./"
1286 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001287 The 'cdpath' option's value has the same form and semantics as
1288 |'path'|. Also see |file-searching|.
1289 The default value is taken from $CDPATH, with a "," prepended to look
1290 in the current directory first.
1291 If the default value taken from $CDPATH is not what you want, include
1292 a modified version of the following command in your vimrc file to
1293 override it: >
1294 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1295< This option cannot be set from a |modeline| or in the |sandbox|, for
1296 security reasons.
1297 (parts of 'cdpath' can be passed to the shell to expand file names).
1298
1299 *'cedit'*
1300'cedit' string (Vi default: "", Vim default: CTRL-F)
1301 global
1302 {not in Vi}
1303 {not available when compiled without the |+vertsplit|
1304 feature}
1305 The key used in Command-line Mode to open the command-line window.
1306 The default is CTRL-F when 'compatible' is off.
1307 Only non-printable keys are allowed.
1308 The key can be specified as a single character, but it is difficult to
1309 type. The preferred way is to use the <> notation. Examples: >
1310 :set cedit=<C-Y>
1311 :set cedit=<Esc>
1312< |Nvi| also has this option, but it only uses the first character.
1313 See |cmdwin|.
1314
1315 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1316'charconvert' 'ccv' string (default "")
1317 global
1318 {only available when compiled with the |+multi_byte|
1319 feature and the |+eval| feature}
1320 {not in Vi}
1321 An expression that is used for character encoding conversion. It is
1322 evaluated when a file that is to be read or has been written has a
1323 different encoding from what is desired.
1324 'charconvert' is not used when the internal iconv() function is
1325 supported and is able to do the conversion. Using iconv() is
1326 preferred, because it is much faster.
1327 'charconvert' is not used when reading stdin |--|, because there is no
1328 file to convert from. You will have to save the text in a file first.
1329 The expression must return zero or an empty string for success,
1330 non-zero for failure.
1331 The possible encoding names encountered are in 'encoding'.
1332 Additionally, names given in 'fileencodings' and 'fileencoding' are
1333 used.
1334 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1335 is done internally by Vim, 'charconvert' is not used for this.
1336 'charconvert' is also used to convert the viminfo file, if the 'c'
1337 flag is present in 'viminfo'. Also used for Unicode conversion.
1338 Example: >
1339 set charconvert=CharConvert()
1340 fun CharConvert()
1341 system("recode "
1342 \ . v:charconvert_from . ".." . v:charconvert_to
1343 \ . " <" . v:fname_in . " >" v:fname_out)
1344 return v:shell_error
1345 endfun
1346< The related Vim variables are:
1347 v:charconvert_from name of the current encoding
1348 v:charconvert_to name of the desired encoding
1349 v:fname_in name of the input file
1350 v:fname_out name of the output file
1351 Note that v:fname_in and v:fname_out will never be the same.
1352 Note that v:charconvert_from and v:charconvert_to may be different
1353 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1354 Encryption is not done by Vim when using 'charconvert'. If you want
1355 to encrypt the file after conversion, 'charconvert' should take care
1356 of this.
1357 This option cannot be set from a |modeline| or in the |sandbox|, for
1358 security reasons.
1359
1360 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1361'cindent' 'cin' boolean (default off)
1362 local to buffer
1363 {not in Vi}
1364 {not available when compiled without the |+cindent|
1365 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001366 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001367 that trigger reindenting in insert mode and 'cinoptions' to set your
1368 preferred indent style.
1369 If 'indentexpr' is not empty, it overrules 'cindent'.
1370 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1371 the "=" operator indents using this algorithm rather than calling an
1372 external program.
1373 See |C-indenting|.
1374 When you don't like the way 'cindent' works, try the 'smartindent'
1375 option or 'indentexpr'.
1376 This option is not used when 'paste' is set.
1377 NOTE: This option is reset when 'compatible' is set.
1378
1379 *'cinkeys'* *'cink'*
1380'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1381 local to buffer
1382 {not in Vi}
1383 {not available when compiled without the |+cindent|
1384 feature}
1385 A list of keys that, when typed in Insert mode, cause reindenting of
1386 the current line. Only used if 'cindent' is on and 'indentexpr' is
1387 empty.
1388 For the format of this option see |cinkeys-format|.
1389 See |C-indenting|.
1390
1391 *'cinoptions'* *'cino'*
1392'cinoptions' 'cino' string (default "")
1393 local to buffer
1394 {not in Vi}
1395 {not available when compiled without the |+cindent|
1396 feature}
1397 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1398 program. See |cinoptions-values| for the values of this option, and
1399 |C-indenting| for info on C indenting in general.
1400
1401
1402 *'cinwords'* *'cinw'*
1403'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1404 local to buffer
1405 {not in Vi}
1406 {not available when compiled without both the
1407 |+cindent| and the |+smartindent| features}
1408 These keywords start an extra indent in the next line when
1409 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1410 an appropriate place (inside {}).
1411 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1412 matter, include the keyword both the uppercase and lowercase:
1413 "if,If,IF".
1414
1415 *'clipboard'* *'cb'*
1416'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1417 for X-windows, "" otherwise)
1418 global
1419 {not in Vi}
1420 {only in GUI versions or when the |+xterm_clipboard|
1421 feature is included}
1422 This option is a list of comma separated names.
1423 These names are recognized:
1424
1425 unnamed When included, Vim will use the clipboard register '*'
1426 for all yank, delete, change and put operations which
1427 would normally go to the unnamed register. When a
1428 register is explicitly specified, it will always be
1429 used regardless of whether "unnamed" is in 'clipboard'
1430 or not. The clipboard register can always be
1431 explicitly accessed using the "* notation. Also see
1432 |gui-clipboard|.
1433
1434 autoselect Works like the 'a' flag in 'guioptions': If present,
1435 then whenever Visual mode is started, or the Visual
1436 area extended, Vim tries to become the owner of the
1437 windowing system's global selection or put the
1438 selected text on the clipboard used by the selection
1439 register "*. See |guioptions_a| and |quotestar| for
1440 details. When the GUI is active, the 'a' flag in
1441 'guioptions' is used, when the GUI is not active, this
1442 "autoselect" flag is used.
1443 Also applies to the modeless selection.
1444
1445 autoselectml Like "autoselect", but for the modeless selection
1446 only. Compare to the 'A' flag in 'guioptions'.
1447
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001448 html When the clipboard contains HTML, use this when
1449 pasting. When putting text on the clipboard, mark it
1450 as HTML. This works to copy rendered HTML from
1451 Firefox, paste it as raw HTML in Vim, select the HTML
1452 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001453 You probably want to add this only temporarily,
1454 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001455 Only supported for GTK version 2 and later.
1456 Only available with the |+multi_byte| feature.
1457
Bram Moolenaar071d4272004-06-13 20:20:40 +00001458 exclude:{pattern}
1459 Defines a pattern that is matched against the name of
1460 the terminal 'term'. If there is a match, no
1461 connection will be made to the X server. This is
1462 useful in this situation:
1463 - Running Vim in a console.
1464 - $DISPLAY is set to start applications on another
1465 display.
1466 - You do not want to connect to the X server in the
1467 console, but do want this in a terminal emulator.
1468 To never connect to the X server use: >
1469 exclude:.*
1470< This has the same effect as using the |-X| argument.
1471 Note that when there is no connection to the X server
1472 the window title won't be restored and the clipboard
1473 cannot be accessed.
1474 The value of 'magic' is ignored, {pattern} is
1475 interpreted as if 'magic' was on.
1476 The rest of the option value will be used for
1477 {pattern}, this must be the last entry.
1478
1479 *'cmdheight'* *'ch'*
1480'cmdheight' 'ch' number (default 1)
1481 global
1482 {not in Vi}
1483 Number of screen lines to use for the command-line. Helps avoiding
1484 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001485 The value of this option is stored with the tab page, so that each tab
1486 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001487
1488 *'cmdwinheight'* *'cwh'*
1489'cmdwinheight' 'cwh' number (default 7)
1490 global
1491 {not in Vi}
1492 {not available when compiled without the |+vertsplit|
1493 feature}
1494 Number of screen lines to use for the command-line window. |cmdwin|
1495
1496 *'columns'* *'co'* *E594*
1497'columns' 'co' number (default 80 or terminal width)
1498 global
1499 {not in Vi}
1500 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001501 initialization and does not have to be set by hand. Also see
1502 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001503 When Vim is running in the GUI or in a resizable window, setting this
1504 option will cause the window size to be changed. When you only want
1505 to use the size for the GUI, put the command in your |gvimrc| file.
1506 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001507 number of columns of the display, the display may be messed up. For
1508 the GUI it is always possible and Vim limits the number of columns to
1509 what fits on the screen. You can use this command to get the widest
1510 window possible: >
1511 :set columns=9999
1512< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001513
1514 *'comments'* *'com'* *E524* *E525*
1515'comments' 'com' string (default
1516 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1517 local to buffer
1518 {not in Vi}
1519 {not available when compiled without the |+comments|
1520 feature}
1521 A comma separated list of strings that can start a comment line. See
1522 |format-comments|. See |option-backslash| about using backslashes to
1523 insert a space.
1524
1525 *'commentstring'* *'cms'* *E537*
1526'commentstring' 'cms' string (default "/*%s*/")
1527 local to buffer
1528 {not in Vi}
1529 {not available when compiled without the |+folding|
1530 feature}
1531 A template for a comment. The "%s" in the value is replaced with the
1532 comment text. Currently only used to add markers for folding, see
1533 |fold-marker|.
1534
1535 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001536'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
1537 file is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001538 global
1539 {not in Vi}
1540 This option has the effect of making Vim either more Vi-compatible, or
1541 make Vim behave in a more useful way.
1542 This is a special kind of option, because when it's set or reset,
1543 other options are also changed as a side effect. CAREFUL: Setting or
1544 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001545 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001546 set this option in your vimrc file, you should probably put it at the
1547 very start.
1548 By default this option is on and the Vi defaults are used for the
1549 options. This default was chosen for those people who want to use Vim
1550 just like Vi, and don't even (want to) know about the 'compatible'
1551 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001552 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001553 this option is switched off, and all options that have not been
1554 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001555 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001556 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001557 happen for the system-wide vimrc or gvimrc file, nor for a file given
1558 with the |-u| argument). Also see |compatible-default| and
1559 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001560 You can also set this option with the "-C" argument, and reset it with
1561 "-N". See |-C| and |-N|.
1562 Switching this option off makes the Vim defaults be used for options
1563 that have a different Vi and Vim default value. See the options
1564 marked with a '+' below. Other options are not modified.
1565 At the moment this option is set, several other options will be set
1566 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001567 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001568 editing.
1569 See also 'cpoptions'.
1570
1571 option + set value effect ~
1572
1573 'allowrevins' off no CTRL-_ command
1574 'backupcopy' Unix: "yes" backup file is a copy
1575 others: "auto" copy or rename backup file
1576 'backspace' "" normal backspace
1577 'backup' off no backup file
1578 'cindent' off no C code indentation
1579 'cedit' + "" no key to open the |cmdwin|
1580 'cpoptions' + (all flags) Vi-compatible flags
1581 'cscopetag' off don't use cscope for ":tag"
1582 'cscopetagorder' 0 see |cscopetagorder|
1583 'cscopeverbose' off see |cscopeverbose|
1584 'digraph' off no digraphs
1585 'esckeys' + off no <Esc>-keys in Insert mode
1586 'expandtab' off tabs not expanded to spaces
1587 'fileformats' + "" no automatic file format detection,
1588 "dos,unix" except for DOS, Windows and OS/2
1589 'formatoptions' + "vt" Vi compatible formatting
1590 'gdefault' off no default 'g' flag for ":s"
1591 'history' + 0 no commandline history
1592 'hkmap' off no Hebrew keyboard mapping
1593 'hkmapp' off no phonetic Hebrew keyboard mapping
1594 'hlsearch' off no highlighting of search matches
1595 'incsearch' off no incremental searching
1596 'indentexpr' "" no indenting by expression
1597 'insertmode' off do not start in Insert mode
1598 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1599 characters and '_'
1600 'joinspaces' on insert 2 spaces after period
1601 'modeline' + off no modelines
1602 'more' + off no pauses in listings
1603 'revins' off no reverse insert
1604 'ruler' off no ruler
1605 'scrolljump' 1 no jump scroll
1606 'scrolloff' 0 no scroll offset
1607 'shiftround' off indent not rounded to shiftwidth
1608 'shortmess' + "" no shortening of messages
1609 'showcmd' + off command characters not shown
1610 'showmode' + off current mode not shown
1611 'smartcase' off no automatic ignore case switch
1612 'smartindent' off no smart indentation
1613 'smarttab' off no smart tab size
1614 'softtabstop' 0 tabs are always 'tabstop' positions
1615 'startofline' on goto startofline with some commands
1616 'tagrelative' + off tag file names are not relative
1617 'textauto' + off no automatic textmode detection
1618 'textwidth' 0 no automatic line wrap
1619 'tildeop' off tilde is not an operator
1620 'ttimeout' off no terminal timeout
1621 'whichwrap' + "" left-right movements don't wrap
1622 'wildchar' + CTRL-E only when the current value is <Tab>
1623 use CTRL-E for cmdline completion
1624 'writebackup' on or off depends on +writebackup feature
1625
1626 *'complete'* *'cpt'* *E535*
1627'complete' 'cpt' string (default: ".,w,b,u,t,i")
1628 local to buffer
1629 {not in Vi}
1630 This option specifies how keyword completion |ins-completion| works
1631 when CTRL-P or CTRL-N are used. It is also used for whole-line
1632 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1633 and the places to scan. It is a comma separated list of flags:
1634 . scan the current buffer ('wrapscan' is ignored)
1635 w scan buffers from other windows
1636 b scan other loaded buffers that are in the buffer list
1637 u scan the unloaded buffers that are in the buffer list
1638 U scan the buffers that are not in the buffer list
1639 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001640 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001641 k{dict} scan the file {dict}. Several "k" flags can be given,
1642 patterns are valid too. For example: >
1643 :set cpt=k/usr/dict/*,k~/spanish
1644< s scan the files given with the 'thesaurus' option
1645 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1646 are valid too.
1647 i scan current and included files
1648 d scan current and included files for defined name or macro
1649 |i_CTRL-X_CTRL-D|
1650 ] tag completion
1651 t same as "]"
1652
1653 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1654 not executed, this may lead to unexpected completions from some files
1655 (gzipped files for example). Unloaded buffers are not scanned for
1656 whole-line completion.
1657
1658 The default is ".,w,b,u,t,i", which means to scan:
1659 1. the current buffer
1660 2. buffers in other windows
1661 3. other loaded buffers
1662 4. unloaded buffers
1663 5. tags
1664 6. included files
1665
1666 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001667 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1668 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001669
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001670 *'completefunc'* *'cfu'*
1671'completefunc' 'cfu' string (default: empty)
1672 local to buffer
1673 {not in Vi}
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001674 {not available when compiled without the +eval
1675 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001676 This option specifies a function to be used for Insert mode completion
1677 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001678 See |complete-functions| for an explanation of how the function is
1679 invoked and what it should return.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001680
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001681
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001682 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001683'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001684 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001685 {not available when compiled without the
1686 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001687 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001688 A comma separated list of options for Insert mode completion
1689 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001690
1691 menu Use a popup menu to show the possible completions. The
1692 menu is only shown when there is more than one match and
1693 sufficient colors are available. |ins-completion-menu|
1694
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001695 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001696 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001697 match, e.g., what file it comes from.
1698
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001699 longest Only insert the longest common text of the matches. If
1700 the menu is displayed you can use CTRL-L to add more
1701 characters. Whether case is ignored depends on the kind
1702 of completion. For buffer text the 'ignorecase' option is
1703 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001704
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001705 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001706 completion in the preview window. Only works in
1707 combination with "menu" or "menuone".
1708
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001709
Bram Moolenaar860cae12010-06-05 23:22:07 +02001710'conceallevel' 'conc' *'conceallevel'* *'conc'*
1711 number (default 0)
1712 local to window
1713 {not in Vi}
1714 {not available when compiled without the |+conceal|
1715 feature}
1716 Determine how text with the "conceal" syntax attribute is shown:
1717
1718 'conceallevel' Effect
1719 0 Text is shown normally
1720 1 Each block of concealed text is replaced with the
1721 character defined in 'listchars' (default is a dash)
1722 and highlighted with the "Conceal" highlight group.
1723 2 Concealed text is completely hidden unless it has a
1724 custom replacement character defined (see
1725 |:syn-cchar|.
1726 3 Concealed text is completely hidden.
1727
1728
Bram Moolenaar071d4272004-06-13 20:20:40 +00001729 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1730'confirm' 'cf' boolean (default off)
1731 global
1732 {not in Vi}
1733 When 'confirm' is on, certain operations that would normally
1734 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1735 instead raise a |dialog| asking if you wish to save the current
1736 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1737 If 'confirm' is off you can still activate confirmation for one
1738 command only (this is most useful in mappings) with the |:confirm|
1739 command.
1740 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1741
1742 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1743'conskey' 'consk' boolean (default off)
1744 global
1745 {not in Vi} {only for MS-DOS}
1746 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001747 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001748 three methods of console input are available:
1749 'conskey' 'bioskey' action ~
1750 on on or off direct console input
1751 off on BIOS
1752 off off STDIN
1753
1754 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1755'copyindent' 'ci' boolean (default off)
1756 local to buffer
1757 {not in Vi}
1758 Copy the structure of the existing lines indent when autoindenting a
1759 new line. Normally the new indent is reconstructed by a series of
1760 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1761 in which case only spaces are used). Enabling this option makes the
1762 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001763 existing line. 'expandtab' has no effect on these characters, a Tab
1764 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001765 line, the remaining space is filled in the normal manner.
1766 NOTE: 'copyindent' is reset when 'compatible' is set.
1767 Also see 'preserveindent'.
1768
1769 *'cpoptions'* *'cpo'*
1770'cpoptions' 'cpo' string (Vim default: "aABceFs",
1771 Vi default: all flags)
1772 global
1773 {not in Vi}
1774 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001775 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001776 not being vi-compatible is mostly or sometimes preferred.
1777 'cpoptions' stands for "compatible-options".
1778 Commas can be added for readability.
1779 To avoid problems with flags that are added in the future, use the
1780 "+=" and "-=" feature of ":set" |add-option-flags|.
1781 NOTE: This option is set to the Vi default value when 'compatible' is
1782 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001783 NOTE: This option is set to the POSIX default value at startup when
1784 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001785 variable exists |posix|. This means Vim tries to behave like the
1786 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001787
1788 contains behavior ~
1789 *cpo-a*
1790 a When included, a ":read" command with a file name
1791 argument will set the alternate file name for the
1792 current window.
1793 *cpo-A*
1794 A When included, a ":write" command with a file name
1795 argument will set the alternate file name for the
1796 current window.
1797 *cpo-b*
1798 b "\|" in a ":map" command is recognized as the end of
1799 the map command. The '\' is included in the mapping,
1800 the text after the '|' is interpreted as the next
1801 command. Use a CTRL-V instead of a backslash to
1802 include the '|' in the mapping. Applies to all
1803 mapping, abbreviation, menu and autocmd commands.
1804 See also |map_bar|.
1805 *cpo-B*
1806 B A backslash has no special meaning in mappings,
1807 abbreviations and the "to" part of the menu commands.
1808 Remove this flag to be able to use a backslash like a
1809 CTRL-V. For example, the command ":map X \<Esc>"
1810 results in X being mapped to:
1811 'B' included: "\^[" (^[ is a real <Esc>)
1812 'B' excluded: "<Esc>" (5 characters)
1813 ('<' excluded in both cases)
1814 *cpo-c*
1815 c Searching continues at the end of any match at the
1816 cursor position, but not further than the start of the
1817 next line. When not present searching continues
1818 one character from the cursor position. With 'c'
1819 "abababababab" only gets three matches when repeating
1820 "/abab", without 'c' there are five matches.
1821 *cpo-C*
1822 C Do not concatenate sourced lines that start with a
1823 backslash. See |line-continuation|.
1824 *cpo-d*
1825 d Using "./" in the 'tags' option doesn't mean to use
1826 the tags file relative to the current file, but the
1827 tags file in the current directory.
1828 *cpo-D*
1829 D Can't use CTRL-K to enter a digraph after Normal mode
1830 commands with a character argument, like |r|, |f| and
1831 |t|.
1832 *cpo-e*
1833 e When executing a register with ":@r", always add a
1834 <CR> to the last line, also when the register is not
1835 linewise. If this flag is not present, the register
1836 is not linewise and the last line does not end in a
1837 <CR>, then the last line is put on the command-line
1838 and can be edited before hitting <CR>.
1839 *cpo-E*
1840 E It is an error when using "y", "d", "c", "g~", "gu" or
1841 "gU" on an Empty region. The operators only work when
1842 at least one character is to be operate on. Example:
1843 This makes "y0" fail in the first column.
1844 *cpo-f*
1845 f When included, a ":read" command with a file name
1846 argument will set the file name for the current buffer,
1847 if the current buffer doesn't have a file name yet.
1848 *cpo-F*
1849 F When included, a ":write" command with a file name
1850 argument will set the file name for the current
1851 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001852 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001853 *cpo-g*
1854 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001855 *cpo-H*
1856 H When using "I" on a line with only blanks, insert
1857 before the last blank. Without this flag insert after
1858 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001859 *cpo-i*
1860 i When included, interrupting the reading of a file will
1861 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001862 *cpo-I*
1863 I When moving the cursor up or down just after inserting
1864 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001865 *cpo-j*
1866 j When joining lines, only add two spaces after a '.',
1867 not after '!' or '?'. Also see 'joinspaces'.
1868 *cpo-J*
1869 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001870 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001871 white space.
1872 *cpo-k*
1873 k Disable the recognition of raw key codes in
1874 mappings, abbreviations, and the "to" part of menu
1875 commands. For example, if <Key> sends ^[OA (where ^[
1876 is <Esc>), the command ":map X ^[OA" results in X
1877 being mapped to:
1878 'k' included: "^[OA" (3 characters)
1879 'k' excluded: "<Key>" (one key code)
1880 Also see the '<' flag below.
1881 *cpo-K*
1882 K Don't wait for a key code to complete when it is
1883 halfway a mapping. This breaks mapping <F1><F1> when
1884 only part of the second <F1> has been read. It
1885 enables cancelling the mapping by typing <F1><Esc>.
1886 *cpo-l*
1887 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001888 literally, only "\]", "\^", "\-" and "\\" are special.
1889 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001890 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1891 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001892 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001893 *cpo-L*
1894 L When the 'list' option is set, 'wrapmargin',
1895 'textwidth', 'softtabstop' and Virtual Replace mode
1896 (see |gR|) count a <Tab> as two characters, instead of
1897 the normal behavior of a <Tab>.
1898 *cpo-m*
1899 m When included, a showmatch will always wait half a
1900 second. When not included, a showmatch will wait half
1901 a second or until a character is typed. |'showmatch'|
1902 *cpo-M*
1903 M When excluded, "%" matching will take backslashes into
1904 account. Thus in "( \( )" and "\( ( \)" the outer
1905 parenthesis match. When included "%" ignores
1906 backslashes, which is Vi compatible.
1907 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02001908 n When included, the column used for 'number' and
1909 'relativenumber' will also be used for text of wrapped
1910 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001911 *cpo-o*
1912 o Line offset to search command is not remembered for
1913 next search.
1914 *cpo-O*
1915 O Don't complain if a file is being overwritten, even
1916 when it didn't exist when editing it. This is a
1917 protection against a file unexpectedly created by
1918 someone else. Vi didn't complain about this.
1919 *cpo-p*
1920 p Vi compatible Lisp indenting. When not present, a
1921 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00001922 *cpo-P*
1923 P When included, a ":write" command that appends to a
1924 file will set the file name for the current buffer, if
1925 the current buffer doesn't have a file name yet and
1926 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001927 *cpo-q*
1928 q When joining multiple lines leave the cursor at the
1929 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001930 *cpo-r*
1931 r Redo ("." command) uses "/" to repeat a search
1932 command, instead of the actually used search string.
1933 *cpo-R*
1934 R Remove marks from filtered lines. Without this flag
1935 marks are kept like |:keepmarks| was used.
1936 *cpo-s*
1937 s Set buffer options when entering the buffer for the
1938 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001939 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001940 set when the buffer is created.
1941 *cpo-S*
1942 S Set buffer options always when entering a buffer
1943 (except 'readonly', 'fileformat', 'filetype' and
1944 'syntax'). This is the (most) Vi compatible setting.
1945 The options are set to the values in the current
1946 buffer. When you change an option and go to another
1947 buffer, the value is copied. Effectively makes the
1948 buffer options global to all buffers.
1949
1950 's' 'S' copy buffer options
1951 no no when buffer created
1952 yes no when buffer first entered (default)
1953 X yes each time when buffer entered (vi comp.)
1954 *cpo-t*
1955 t Search pattern for the tag command is remembered for
1956 "n" command. Otherwise Vim only puts the pattern in
1957 the history for search pattern, but doesn't change the
1958 last used search pattern.
1959 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001960 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001961 *cpo-v*
1962 v Backspaced characters remain visible on the screen in
1963 Insert mode. Without this flag the characters are
1964 erased from the screen right away. With this flag the
1965 screen newly typed text overwrites backspaced
1966 characters.
1967 *cpo-w*
1968 w When using "cw" on a blank character, only change one
1969 character and not all blanks until the start of the
1970 next word.
1971 *cpo-W*
1972 W Don't overwrite a readonly file. When omitted, ":w!"
1973 overwrites a readonly file, if possible.
1974 *cpo-x*
1975 x <Esc> on the command-line executes the command-line.
1976 The default in Vim is to abandon the command-line,
1977 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001978 *cpo-X*
1979 X When using a count with "R" the replaced text is
1980 deleted only once. Also when repeating "R" with "."
1981 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001982 *cpo-y*
1983 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001984 *cpo-Z*
1985 Z When using "w!" while the 'readonly' option is set,
1986 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001987 *cpo-!*
1988 ! When redoing a filter command, use the last used
1989 external command, whatever it was. Otherwise the last
1990 used -filter- command is used.
1991 *cpo-$*
1992 $ When making a change to one line, don't redisplay the
1993 line, but put a '$' at the end of the changed text.
1994 The changed text will be overwritten when you type the
1995 new text. The line is redisplayed if you type any
1996 command that moves the cursor from the insertion
1997 point.
1998 *cpo-%*
1999 % Vi-compatible matching is done for the "%" command.
2000 Does not recognize "#if", "#endif", etc.
2001 Does not recognize "/*" and "*/".
2002 Parens inside single and double quotes are also
2003 counted, causing a string that contains a paren to
2004 disturb the matching. For example, in a line like
2005 "if (strcmp("foo(", s))" the first paren does not
2006 match the last one. When this flag is not included,
2007 parens inside single and double quotes are treated
2008 specially. When matching a paren outside of quotes,
2009 everything inside quotes is ignored. When matching a
2010 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002011 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002012 This flag is also used for other features, such as
2013 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002014 *cpo--*
2015 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002016 it would go above the first line or below the last
2017 line. Without it the cursor moves to the first or
2018 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002019 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002020 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002021 *cpo-+*
2022 + When included, a ":write file" command will reset the
2023 'modified' flag of the buffer, even though the buffer
2024 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002025 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002026 * Use ":*" in the same way as ":@". When not included,
2027 ":*" is an alias for ":'<,'>", select the Visual area.
2028 *cpo-<*
2029 < Disable the recognition of special key codes in |<>|
2030 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002031 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002032 ":map X <Tab>" results in X being mapped to:
2033 '<' included: "<Tab>" (5 characters)
2034 '<' excluded: "^I" (^I is a real <Tab>)
2035 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002036 *cpo->*
2037 > When appending to a register, put a line break before
2038 the appended text.
2039
2040 POSIX flags. These are not included in the Vi default value, except
2041 when $VIM_POSIX was set on startup. |posix|
2042
2043 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002044 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002045 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002046 *cpo-&*
2047 & When ":preserve" was used keep the swap file when
2048 exiting normally while this buffer is still loaded.
2049 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002050 *cpo-\*
2051 \ Backslash in a [] range in a search pattern is taken
2052 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002053 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2054 '\' excluded: "/[ \-]" finds <Space> and '-'
2055 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002056 *cpo-/*
2057 / When "%" is used as the replacement string in a |:s|
2058 command, use the previous replacement string. |:s%|
2059 *cpo-{*
2060 { The |{| and |}| commands also stop at a "{" character
2061 at the start of a line.
2062 *cpo-.*
2063 . The ":chdir" and ":cd" commands fail if the current
2064 buffer is modified, unless ! is used. Vim doesn't
2065 need this, since it remembers the full path of an
2066 opened file.
2067 *cpo-bar*
2068 | The value of the $LINES and $COLUMNS environment
2069 variables overrule the terminal size values obtained
2070 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002071
Bram Moolenaar071d4272004-06-13 20:20:40 +00002072
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002073 *'cryptmethod'* *'cm'*
2074'cryptmethod' number (default 0)
2075 local to buffer
2076 {not in Vi}
2077 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002078 *pkzip*
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002079 0 PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002080 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002081 *blowfish*
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002082 1 Blowfish method. Strong encryption. Requires Vim 7.3
2083 or later, files can NOT be read by Vim 7.2 and older.
2084 This adds a "seed" to the file, every time you write
2085 the file the encrypted bytes will be different.
2086
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002087 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002088 to the detected method of the file being read. Thus if you write it
2089 without changing 'cryptmethod' the same method will be used.
2090 Changing 'cryptmethod' does not mark the file as modified, you have to
2091 explicitly write it when not making modifications.
2092 Also see |:X|.
2093 When a new encryption method is added in a later version of Vim, and
2094 the current version does not recognize it, you will get *E821* .
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002095
2096
Bram Moolenaar071d4272004-06-13 20:20:40 +00002097 *'cscopepathcomp'* *'cspc'*
2098'cscopepathcomp' 'cspc' number (default 0)
2099 global
2100 {not available when compiled without the |+cscope|
2101 feature}
2102 {not in Vi}
2103 Determines how many components of the path to show in a list of tags.
2104 See |cscopepathcomp|.
2105
2106 *'cscopeprg'* *'csprg'*
2107'cscopeprg' 'csprg' string (default "cscope")
2108 global
2109 {not available when compiled without the |+cscope|
2110 feature}
2111 {not in Vi}
2112 Specifies the command to execute cscope. See |cscopeprg|.
2113 This option cannot be set from a |modeline| or in the |sandbox|, for
2114 security reasons.
2115
2116 *'cscopequickfix'* *'csqf'*
2117'cscopequickfix' 'csqf' string (default "")
2118 global
2119 {not available when compiled without the |+cscope|
2120 or |+quickfix| features}
2121 {not in Vi}
2122 Specifies whether to use quickfix window to show cscope results.
2123 See |cscopequickfix|.
2124
2125 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2126'cscopetag' 'cst' boolean (default off)
2127 global
2128 {not available when compiled without the |+cscope|
2129 feature}
2130 {not in Vi}
2131 Use cscope for tag commands. See |cscope-options|.
2132 NOTE: This option is reset when 'compatible' is set.
2133
2134 *'cscopetagorder'* *'csto'*
2135'cscopetagorder' 'csto' number (default 0)
2136 global
2137 {not available when compiled without the |+cscope|
2138 feature}
2139 {not in Vi}
2140 Determines the order in which ":cstag" performs a search. See
2141 |cscopetagorder|.
2142 NOTE: This option is set to 0 when 'compatible' is set.
2143
2144 *'cscopeverbose'* *'csverb'*
2145 *'nocscopeverbose'* *'nocsverb'*
2146'cscopeverbose' 'csverb' boolean (default off)
2147 global
2148 {not available when compiled without the |+cscope|
2149 feature}
2150 {not in Vi}
2151 Give messages when adding a cscope database. See |cscopeverbose|.
2152 NOTE: This option is reset when 'compatible' is set.
2153
Bram Moolenaar860cae12010-06-05 23:22:07 +02002154 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2155'cursorbind' 'crb' boolean (default off)
2156 local to window
2157 {not in Vi}
2158 {not available when compiled without the |+cursorbind|
2159 feature}
2160 When this option is set, as the cursor in the current
2161 window moves other cursorbound windows (windows that also have
2162 this option set) move their cursors to the corresponding line and
2163 column. This option is useful for viewing the
2164 differences between two versions of a file (see 'diff'); in diff mode,
2165 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002166 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002167
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002168
2169 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2170'cursorcolumn' 'cuc' boolean (default off)
2171 local to window
2172 {not in Vi}
2173 {not available when compiled without the |+syntax|
2174 feature}
2175 Highlight the screen column of the cursor with CursorColumn
2176 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2177 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002178 If you only want the highlighting in the current window you can use
2179 these autocommands: >
2180 au WinLeave * set nocursorline nocursorcolumn
2181 au WinEnter * set cursorline cursorcolumn
2182<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002183
2184 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2185'cursorline' 'cul' boolean (default off)
2186 local to window
2187 {not in Vi}
2188 {not available when compiled without the |+syntax|
2189 feature}
2190 Highlight the screen line of the cursor with CursorLine
2191 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2192 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002193 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002194 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002195
2196
Bram Moolenaar071d4272004-06-13 20:20:40 +00002197 *'debug'*
2198'debug' string (default "")
2199 global
2200 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002201 These values can be used:
2202 msg Error messages that would otherwise be omitted will be given
2203 anyway.
2204 throw Error messages that would otherwise be omitted will be given
2205 anyway and also throw an exception and set |v:errmsg|.
2206 beep A message will be given when otherwise only a beep would be
2207 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002208 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002209 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2210 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002211
2212 *'define'* *'def'*
2213'define' 'def' string (default "^\s*#\s*define")
2214 global or local to buffer |global-local|
2215 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002216 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002217 pattern, just like for the "/" command. This option is used for the
2218 commands like "[i" and "[d" |include-search|. The 'isident' option is
2219 used to recognize the defined name after the match:
2220 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2221 See |option-backslash| about inserting backslashes to include a space
2222 or backslash.
2223 The default value is for C programs. For C++ this value would be
2224 useful, to include const type declarations: >
2225 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2226< When using the ":set" command, you need to double the backslashes!
2227
2228 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2229'delcombine' 'deco' boolean (default off)
2230 global
2231 {not in Vi}
2232 {only available when compiled with the |+multi_byte|
2233 feature}
2234 If editing Unicode and this option is set, backspace and Normal mode
2235 "x" delete each combining character on its own. When it is off (the
2236 default) the character along with its combining characters are
2237 deleted.
2238 Note: When 'delcombine' is set "xx" may work different from "2x"!
2239
2240 This is useful for Arabic, Hebrew and many other languages where one
2241 may have combining characters overtop of base characters, and want
2242 to remove only the combining ones.
2243
2244 *'dictionary'* *'dict'*
2245'dictionary' 'dict' string (default "")
2246 global or local to buffer |global-local|
2247 {not in Vi}
2248 List of file names, separated by commas, that are used to lookup words
2249 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2250 contain a list of words. This can be one word per line, or several
2251 words per line, separated by non-keyword characters (white space is
2252 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002253 When this option is empty, or an entry "spell" is present, spell
2254 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002255 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002256 after a comma are ignored, otherwise spaces are included in the file
2257 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002258 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002259 Where to find a list of words?
2260 - On FreeBSD, there is the file "/usr/share/dict/words".
2261 - In the Simtel archive, look in the "msdos/linguist" directory.
2262 - In "miscfiles" of the GNU collection.
2263 The use of |:set+=| and |:set-=| is preferred when adding or removing
2264 directories from the list. This avoids problems when a future version
2265 uses another default.
2266 Backticks cannot be used in this option for security reasons.
2267
2268 *'diff'* *'nodiff'*
2269'diff' boolean (default off)
2270 local to window
2271 {not in Vi}
2272 {not available when compiled without the |+diff|
2273 feature}
2274 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002275 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002276
2277 *'dex'* *'diffexpr'*
2278'diffexpr' 'dex' string (default "")
2279 global
2280 {not in Vi}
2281 {not available when compiled without the |+diff|
2282 feature}
2283 Expression which is evaluated to obtain an ed-style diff file from two
2284 versions of a file. See |diff-diffexpr|.
2285 This option cannot be set from a |modeline| or in the |sandbox|, for
2286 security reasons.
2287
2288 *'dip'* *'diffopt'*
2289'diffopt' 'dip' string (default "filler")
2290 global
2291 {not in Vi}
2292 {not available when compiled without the |+diff|
2293 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002294 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002295 All are optional. Items must be separated by a comma.
2296
2297 filler Show filler lines, to keep the text
2298 synchronized with a window that has inserted
2299 lines at the same position. Mostly useful
2300 when windows are side-by-side and 'scrollbind'
2301 is set.
2302
2303 context:{n} Use a context of {n} lines between a change
2304 and a fold that contains unchanged lines.
2305 When omitted a context of six lines is used.
2306 See |fold-diff|.
2307
2308 icase Ignore changes in case of text. "a" and "A"
2309 are considered the same. Adds the "-i" flag
2310 to the "diff" command if 'diffexpr' is empty.
2311
2312 iwhite Ignore changes in amount of white space. Adds
2313 the "-b" flag to the "diff" command if
2314 'diffexpr' is empty. Check the documentation
2315 of the "diff" command for what this does
2316 exactly. It should ignore adding trailing
2317 white space, but not leading white space.
2318
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002319 horizontal Start diff mode with horizontal splits (unless
2320 explicitly specified otherwise).
2321
2322 vertical Start diff mode with vertical splits (unless
2323 explicitly specified otherwise).
2324
2325 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2326 starting diff mode. Without this 2 is used.
2327
Bram Moolenaar071d4272004-06-13 20:20:40 +00002328 Examples: >
2329
2330 :set diffopt=filler,context:4
2331 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002332 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002333<
2334 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2335'digraph' 'dg' boolean (default off)
2336 global
2337 {not in Vi}
2338 {not available when compiled without the |+digraphs|
2339 feature}
2340 Enable the entering of digraphs in Insert mode with {char1} <BS>
2341 {char2}. See |digraphs|.
2342 NOTE: This option is reset when 'compatible' is set.
2343
2344 *'directory'* *'dir'*
2345'directory' 'dir' string (default for Amiga: ".,t:",
2346 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2347 for Unix: ".,~/tmp,/var/tmp,/tmp")
2348 global
2349 List of directory names for the swap file, separated with commas.
2350 - The swap file will be created in the first directory where this is
2351 possible.
2352 - Empty means that no swap file will be used (recovery is
2353 impossible!).
2354 - A directory "." means to put the swap file in the same directory as
2355 the edited file. On Unix, a dot is prepended to the file name, so
2356 it doesn't show in a directory listing. On MS-Windows the "hidden"
2357 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002358 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002359 put the swap file relative to where the edited file is. The leading
2360 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002361 - For Unix and Win32, if a directory ends in two path separators "//"
2362 or "\\", the swap file name will be built from the complete path to
2363 the file with all path separators substituted to percent '%' signs.
2364 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002365 On Win32, when a separating comma is following, you must use "//",
2366 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002367 - Spaces after the comma are ignored, other spaces are considered part
2368 of the directory name. To have a space at the start of a directory
2369 name, precede it with a backslash.
2370 - To include a comma in a directory name precede it with a backslash.
2371 - A directory name may end in an ':' or '/'.
2372 - Environment variables are expanded |:set_env|.
2373 - Careful with '\' characters, type one before a space, type two to
2374 get one in the option (see |option-backslash|), for example: >
2375 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2376< - For backwards compatibility with Vim version 3.0 a '>' at the start
2377 of the option is removed.
2378 Using "." first in the list is recommended. This means that editing
2379 the same file twice will result in a warning. Using "/tmp" on Unix is
2380 discouraged: When the system crashes you lose the swap file.
2381 "/var/tmp" is often not cleared when rebooting, thus is a better
2382 choice than "/tmp". But it can contain a lot of files, your swap
2383 files get lost in the crowd. That is why a "tmp" directory in your
2384 home directory is tried first.
2385 The use of |:set+=| and |:set-=| is preferred when adding or removing
2386 directories from the list. This avoids problems when a future version
2387 uses another default.
2388 This option cannot be set from a |modeline| or in the |sandbox|, for
2389 security reasons.
2390 {Vi: directory to put temp file in, defaults to "/tmp"}
2391
2392 *'display'* *'dy'*
2393'display' 'dy' string (default "")
2394 global
2395 {not in Vi}
2396 Change the way text is displayed. This is comma separated list of
2397 flags:
2398 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002399 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002400 last line that doesn't fit is replaced with "@" lines.
2401 uhex Show unprintable characters hexadecimal as <xx>
2402 instead of using ^C and ~C.
2403
2404 *'eadirection'* *'ead'*
2405'eadirection' 'ead' string (default "both")
2406 global
2407 {not in Vi}
2408 {not available when compiled without the +vertsplit
2409 feature}
2410 Tells when the 'equalalways' option applies:
2411 ver vertically, width of windows is not affected
2412 hor horizontally, height of windows is not affected
2413 both width and height of windows is affected
2414
2415 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2416'edcompatible' 'ed' boolean (default off)
2417 global
2418 Makes the 'g' and 'c' flags of the ":substitute" command to be
2419 toggled each time the flag is given. See |complex-change|. See
2420 also 'gdefault' option.
2421 Switching this option on is discouraged!
2422
2423 *'encoding'* *'enc'* *E543*
2424'encoding' 'enc' string (default: "latin1" or value from $LANG)
2425 global
2426 {only available when compiled with the |+multi_byte|
2427 feature}
2428 {not in Vi}
2429 Sets the character encoding used inside Vim. It applies to text in
2430 the buffers, registers, Strings in expressions, text stored in the
2431 viminfo file, etc. It sets the kind of characters which Vim can work
2432 with. See |encoding-names| for the possible values.
2433
2434 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002435 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002436 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002437 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002438
Bram Moolenaar865242e2010-07-14 21:12:05 +02002439 This option cannot be set from a |modeline|. It would most likely
2440 corrupt the text.
2441
Bram Moolenaar071d4272004-06-13 20:20:40 +00002442 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2443 "utf-8". Although care has been taken to allow different values of
2444 'encoding', "utf-8" is the natural choice for the environment and
2445 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002446 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002447 versions, and to avoid changing the encoding of newly created files
2448 without your knowledge (in case 'fileencodings' is empty).
2449
2450 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002451 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002452 iconv() or as specified with 'charconvert'.
2453
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002454 If you need to know whether 'encoding' is a multi-byte encoding, you
2455 can use: >
2456 if has("multi_byte_encoding")
2457<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002458 Normally 'encoding' will be equal to your current locale. This will
2459 be the default if Vim recognizes your environment settings. If
2460 'encoding' is not set to the current locale, 'termencoding' must be
2461 set to convert typed and displayed text. See |encoding-table|.
2462
2463 When you set this option, it fires the |EncodingChanged| autocommand
2464 event so that you can set up fonts if necessary.
2465
2466 When the option is set, the value is converted to lowercase. Thus
2467 you can set it with uppercase values too. Underscores are translated
2468 to '-' signs.
2469 When the encoding is recognized, it is changed to the standard name.
2470 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2471 "iso-8859-2" and "utf8" becomes "utf-8".
2472
2473 Note: "latin1" is also used when the encoding could not be detected.
2474 This only works when editing files in the same encoding! When the
2475 actual character set is not latin1, make sure 'fileencoding' and
2476 'fileencodings' are empty. When conversion is needed, switch to using
2477 utf-8.
2478
2479 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2480 You don't notice this while editing, but it does matter for the
2481 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2482 setting 'encoding' to one of these values instead of utf-8 only has
2483 effect for encoding used for files when 'fileencoding' is empty.
2484
Bram Moolenaar661b1822005-07-28 22:36:45 +00002485 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2486 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002487
2488 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2489'endofline' 'eol' boolean (default on)
2490 local to buffer
2491 {not in Vi}
2492 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002493 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002494 option is automatically set when starting to edit a new file, unless
2495 the file does not have an <EOL> for the last line in the file, in
2496 which case it is reset. Normally you don't have to set or reset this
2497 option. When 'binary' is off the value is not used when writing the
2498 file. When 'binary' is on it is used to remember the presence of a
2499 <EOL> for the last line in the file, so that when you write the file
2500 the situation from the original file can be kept. But you can change
2501 it if you want to.
2502
2503 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2504'equalalways' 'ea' boolean (default on)
2505 global
2506 {not in Vi}
2507 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002508 splitting or closing a window. This also happens the moment the
2509 option is switched on. When off, splitting a window will reduce the
2510 size of the current window and leave the other windows the same. When
2511 closing a window the extra lines are given to the window next to it
2512 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002513 When mixing vertically and horizontally split windows, a minimal size
2514 is computed and some windows may be larger if there is room. The
2515 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002516 Changing the height and width of a window can be avoided by setting
2517 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002518 If a window size is specified when creating a new window sizes are
2519 currently not equalized (it's complicated, but may be implemented in
2520 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002521
2522 *'equalprg'* *'ep'*
2523'equalprg' 'ep' string (default "")
2524 global or local to buffer |global-local|
2525 {not in Vi}
2526 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002527 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002528 or 'indentexpr'. When Vim was compiled without internal formatting,
2529 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002530 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002531 about including spaces and backslashes.
2532 This option cannot be set from a |modeline| or in the |sandbox|, for
2533 security reasons.
2534
2535 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2536'errorbells' 'eb' boolean (default off)
2537 global
2538 Ring the bell (beep or screen flash) for error messages. This only
2539 makes a difference for error messages, the bell will be used always
2540 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002541 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002542 screen flash or do nothing.
2543
2544 *'errorfile'* *'ef'*
2545'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2546 others: "errors.err")
2547 global
2548 {not in Vi}
2549 {not available when compiled without the |+quickfix|
2550 feature}
2551 Name of the errorfile for the QuickFix mode (see |:cf|).
2552 When the "-q" command-line argument is used, 'errorfile' is set to the
2553 following argument. See |-q|.
2554 NOT used for the ":make" command. See 'makeef' for that.
2555 Environment variables are expanded |:set_env|.
2556 See |option-backslash| about including spaces and backslashes.
2557 This option cannot be set from a |modeline| or in the |sandbox|, for
2558 security reasons.
2559
2560 *'errorformat'* *'efm'*
2561'errorformat' 'efm' string (default is very long)
2562 global or local to buffer |global-local|
2563 {not in Vi}
2564 {not available when compiled without the |+quickfix|
2565 feature}
2566 Scanf-like description of the format for the lines in the error file
2567 (see |errorformat|).
2568
2569 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2570'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2571 global
2572 {not in Vi}
2573 Function keys that start with an <Esc> are recognized in Insert
2574 mode. When this option is off, the cursor and function keys cannot be
2575 used in Insert mode if they start with an <Esc>. The advantage of
2576 this is that the single <Esc> is recognized immediately, instead of
2577 after one second. Instead of resetting this option, you might want to
2578 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2579 when 'esckeys' is off, you can still map anything, but the cursor keys
2580 won't work by default.
2581 NOTE: This option is set to the Vi default value when 'compatible' is
2582 set and to the Vim default value when 'compatible' is reset.
2583
2584 *'eventignore'* *'ei'*
2585'eventignore' 'ei' string (default "")
2586 global
2587 {not in Vi}
2588 {not available when compiled without the |+autocmd|
2589 feature}
2590 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002591 When set to "all" or when "all" is one of the items, all autocommand
2592 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002593 Otherwise this is a comma separated list of event names. Example: >
2594 :set ei=WinEnter,WinLeave
2595<
2596 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2597'expandtab' 'et' boolean (default off)
2598 local to buffer
2599 {not in Vi}
2600 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002601 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002602 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2603 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2604 NOTE: This option is reset when 'compatible' is set.
2605
2606 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2607'exrc' 'ex' boolean (default off)
2608 global
2609 {not in Vi}
2610 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2611 directory. If you switch this option on you should also consider
2612 setting the 'secure' option (see |initialization|). Using a local
2613 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2614 also see |.vimrc| and |gui-init|.
2615 This option cannot be set from a |modeline| or in the |sandbox|, for
2616 security reasons.
2617
2618 *'fileencoding'* *'fenc'* *E213*
2619'fileencoding' 'fenc' string (default: "")
2620 local to buffer
2621 {only available when compiled with the |+multi_byte|
2622 feature}
2623 {not in Vi}
2624 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002625
Bram Moolenaar071d4272004-06-13 20:20:40 +00002626 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002627 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002628 When 'fileencoding' is empty, the same value as 'encoding' will be
2629 used (no conversion when reading or writing a file).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002630 Conversion will also be done when 'encoding' and 'fileencoding' are
2631 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2632 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002633 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002634 'encoding' is "utf-8" or another Unicode encoding, conversion
2635 is most likely done in a way that the reverse conversion
2636 results in the same text. When 'encoding' is not "utf-8" some
2637 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002638
Bram Moolenaar071d4272004-06-13 20:20:40 +00002639 See 'encoding' for the possible values. Additionally, values may be
2640 specified that can be handled by the converter, see
2641 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002642
Bram Moolenaar071d4272004-06-13 20:20:40 +00002643 When reading a file 'fileencoding' will be set from 'fileencodings'.
2644 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002645 'fileencoding', use the |++enc| argument. One exception: when
2646 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002647 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002648
Bram Moolenaar071d4272004-06-13 20:20:40 +00002649 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2650 When the option is set, the value is converted to lowercase. Thus
2651 you can set it with uppercase values too. '_' characters are
2652 replaced with '-'. If a name is recognized from the list for
2653 'encoding', it is replaced by the standard name. For example
2654 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002655
Bram Moolenaar071d4272004-06-13 20:20:40 +00002656 When this option is set, after starting to edit a file, the 'modified'
2657 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002658
2659 Keep in mind that changing 'fenc' from a modeline happens
2660 AFTER the text has been read, thus it applies to when the file will be
2661 written. If you do set 'fenc' in a modeline, you might want to set
2662 'nomodified' to avoid not being able to ":q".
2663
Bram Moolenaar071d4272004-06-13 20:20:40 +00002664 This option can not be changed when 'modifiable' is off.
2665
2666 *'fe'*
2667 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002668 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002669 old short name was 'fe', which is no longer used.
2670
2671 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002672'fileencodings' 'fencs' string (default: "ucs-bom",
2673 "ucs-bom,utf-8,default,latin1" when
2674 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002675 global
2676 {only available when compiled with the |+multi_byte|
2677 feature}
2678 {not in Vi}
2679 This is a list of character encodings considered when starting to edit
2680 an existing file. When a file is read, Vim tries to use the first
2681 mentioned character encoding. If an error is detected, the next one
2682 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002683 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002684 an empty string, which means the value of 'encoding' is used.
2685 WARNING: Conversion can cause loss of information! When
2686 'encoding' is "utf-8" (or one of the other Unicode variants)
2687 conversion is most likely done in a way that the reverse
2688 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002689 "utf-8" some non-ASCII characters may be lost! You can use
2690 the |++bad| argument to specify what is done with characters
2691 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002692 For an empty file or a file with only ASCII characters most encodings
2693 will work and the first entry of 'fileencodings' will be used (except
2694 "ucs-bom", which requires the BOM to be present). If you prefer
2695 another encoding use an BufReadPost autocommand event to test if your
2696 preferred encoding is to be used. Example: >
2697 au BufReadPost * if search('\S', 'w') == 0 |
2698 \ set fenc=iso-2022-jp | endif
2699< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2700 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002701 When the |++enc| argument is used then the value of 'fileencodings' is
2702 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002703 Note that 'fileencodings' is not used for a new file, the global value
2704 of 'fileencoding' is used instead. You can set it with: >
2705 :setglobal fenc=iso-8859-2
2706< This means that a non-existing file may get a different encoding than
2707 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002708 The special value "ucs-bom" can be used to check for a Unicode BOM
2709 (Byte Order Mark) at the start of the file. It must not be preceded
2710 by "utf-8" or another Unicode encoding for this to work properly.
2711 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2712 because Vim cannot detect an error, thus the encoding is always
2713 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002714 The special value "default" can be used for the encoding from the
2715 environment. This is the default value for 'encoding'. It is useful
2716 when 'encoding' is set to "utf-8" and your environment uses a
2717 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002718 When 'encoding' is "utf-8" and a file contains an illegal byte
2719 sequence it won't be recognized as UTF-8. You can use the |8g8|
2720 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002721 WRONG VALUES: WHAT'S WRONG:
2722 latin1,utf-8 "latin1" will always be used
2723 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2724 file
2725 cp1250,latin1 "cp1250" will always be used
2726 If 'fileencodings' is empty, 'fileencoding' is not modified.
2727 See 'fileencoding' for the possible values.
2728 Setting this option does not have an effect until the next time a file
2729 is read.
2730
2731 *'fileformat'* *'ff'*
2732'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2733 Unix default: "unix",
2734 Macintosh default: "mac")
2735 local to buffer
2736 {not in Vi}
2737 This gives the <EOL> of the current buffer, which is used for
2738 reading/writing the buffer from/to a file:
2739 dos <CR> <NL>
2740 unix <NL>
2741 mac <CR>
2742 When "dos" is used, CTRL-Z at the end of a file is ignored.
2743 See |file-formats| and |file-read|.
2744 For the character encoding of the file see 'fileencoding'.
2745 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2746 works like it was set to "unix'.
2747 This option is set automatically when starting to edit a file and
2748 'fileformats' is not empty and 'binary' is off.
2749 When this option is set, after starting to edit a file, the 'modified'
2750 option is set, because the file would be different when written.
2751 This option can not be changed when 'modifiable' is off.
2752 For backwards compatibility: When this option is set to "dos",
2753 'textmode' is set, otherwise 'textmode' is reset.
2754
2755 *'fileformats'* *'ffs'*
2756'fileformats' 'ffs' string (default:
2757 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2758 Vim Unix: "unix,dos",
2759 Vim Mac: "mac,unix,dos",
2760 Vi Cygwin: "unix,dos",
2761 Vi others: "")
2762 global
2763 {not in Vi}
2764 This gives the end-of-line (<EOL>) formats that will be tried when
2765 starting to edit a new buffer and when reading a file into an existing
2766 buffer:
2767 - When empty, the format defined with 'fileformat' will be used
2768 always. It is not set automatically.
2769 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002770 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002771 'fileformats' name will be used when a file is read into an existing
2772 buffer, no matter what 'fileformat' for that buffer is set to.
2773 - When more than one name is present, separated by commas, automatic
2774 <EOL> detection will be done when reading a file. When starting to
2775 edit a file, a check is done for the <EOL>:
2776 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2777 'fileformat' is set to "dos".
2778 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002779 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002780 preceding <CR>, "unix" is preferred over "dos".
2781 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2782 This means that "mac" is only chosen when "unix" is not present,
2783 or when no <NL> is found in the file, and when "dos" is not
2784 present, or no <CR><NL> is present in the file.
2785 Also if "unix" was first chosen, but the first <CR> is before
2786 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2787 the file, then 'fileformat' is set to "mac".
2788 4. If 'fileformat' is still not set, the first name from
2789 'fileformats' is used.
2790 When reading a file into an existing buffer, the same is done, but
2791 this happens like 'fileformat' has been set appropriately for that
2792 file only, the option is not changed.
2793 When 'binary' is set, the value of 'fileformats' is not used.
2794
2795 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2796 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2797 done:
2798 - When 'fileformats' is empty, there is no automatic detection. Dos
2799 format will be used.
2800 - When 'fileformats' is set to one or more names, automatic detection
2801 is done. This is based on the first <NL> in the file: If there is a
2802 <CR> in front of it, Dos format is used, otherwise Unix format is
2803 used.
2804 Also see |file-formats|.
2805 For backwards compatibility: When this option is set to an empty
2806 string or one format (no comma is included), 'textauto' is reset,
2807 otherwise 'textauto' is set.
2808 NOTE: This option is set to the Vi default value when 'compatible' is
2809 set and to the Vim default value when 'compatible' is reset.
2810
2811 *'filetype'* *'ft'*
2812'filetype' 'ft' string (default: "")
2813 local to buffer
2814 {not in Vi}
2815 {not available when compiled without the |+autocmd|
2816 feature}
2817 When this option is set, the FileType autocommand event is triggered.
2818 All autocommands that match with the value of this option will be
2819 executed. Thus the value of 'filetype' is used in place of the file
2820 name.
2821 Otherwise this option does not always reflect the current file type.
2822 This option is normally set when the file type is detected. To enable
2823 this use the ":filetype on" command. |:filetype|
2824 Setting this option to a different value is most useful in a modeline,
2825 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002826 Example, for in an IDL file:
2827 /* vim: set filetype=idl : */ ~
2828 |FileType| |filetypes|
2829 When a dot appears in the value then this separates two filetype
2830 names. Example:
2831 /* vim: set filetype=c.doxygen : */ ~
2832 This will use the "c" filetype first, then the "doxygen" filetype.
2833 This works both for filetype plugins and for syntax files. More than
2834 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002835 Do not confuse this option with 'osfiletype', which is for the file
2836 type that is actually stored with the file.
2837 This option is not copied to another buffer, independent of the 's' or
2838 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002839 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002840
2841 *'fillchars'* *'fcs'*
2842'fillchars' 'fcs' string (default "vert:|,fold:-")
2843 global
2844 {not in Vi}
2845 {not available when compiled without the |+windows|
2846 and |+folding| features}
2847 Characters to fill the statuslines and vertical separators.
2848 It is a comma separated list of items:
2849
2850 item default Used for ~
2851 stl:c ' ' or '^' statusline of the current window
2852 stlnc:c ' ' or '-' statusline of the non-current windows
2853 vert:c '|' vertical separators |:vsplit|
2854 fold:c '-' filling 'foldtext'
2855 diff:c '-' deleted lines of the 'diff' option
2856
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002857 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002858 "stlnc" the space will be used when there is highlighting, '^' or '-'
2859 otherwise.
2860
2861 Example: >
2862 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2863< This is similar to the default, except that these characters will also
2864 be used when there is highlighting.
2865
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002866 for "stl" and "stlnc" only single-byte values are supported.
2867
Bram Moolenaar071d4272004-06-13 20:20:40 +00002868 The highlighting used for these items:
2869 item highlight group ~
2870 stl:c StatusLine |hl-StatusLine|
2871 stlnc:c StatusLineNC |hl-StatusLineNC|
2872 vert:c VertSplit |hl-VertSplit|
2873 fold:c Folded |hl-Folded|
2874 diff:c DiffDelete |hl-DiffDelete|
2875
2876 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2877'fkmap' 'fk' boolean (default off) *E198*
2878 global
2879 {not in Vi}
2880 {only available when compiled with the |+rightleft|
2881 feature}
2882 When on, the keyboard is mapped for the Farsi character set.
2883 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002884 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002885
2886 *'foldclose'* *'fcl'*
2887'foldclose' 'fcl' string (default "")
2888 global
2889 {not in Vi}
2890 {not available when compiled without the |+folding|
2891 feature}
2892 When set to "all", a fold is closed when the cursor isn't in it and
2893 its level is higher than 'foldlevel'. Useful if you want folds to
2894 automatically close when moving out of them.
2895
2896 *'foldcolumn'* *'fdc'*
2897'foldcolumn' 'fdc' number (default 0)
2898 local to window
2899 {not in Vi}
2900 {not available when compiled without the |+folding|
2901 feature}
2902 When non-zero, a column with the specified width is shown at the side
2903 of the window which indicates open and closed folds. The maximum
2904 value is 12.
2905 See |folding|.
2906
2907 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2908'foldenable' 'fen' boolean (default on)
2909 local to window
2910 {not in Vi}
2911 {not available when compiled without the |+folding|
2912 feature}
2913 When off, all folds are open. This option can be used to quickly
2914 switch between showing all text unfolded and viewing the text with
2915 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002916 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002917 'foldenable' is off.
2918 This option is set by commands that create a new fold or close a fold.
2919 See |folding|.
2920
2921 *'foldexpr'* *'fde'*
2922'foldexpr' 'fde' string (default: "0")
2923 local to window
2924 {not in Vi}
2925 {not available when compiled without the |+folding|
2926 or |+eval| feature}
2927 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002928 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002929
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002930 The expression may be evaluated in the |sandbox|, see
2931 |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002932 This option can't be set from a |modeline| when the 'diff' option is
2933 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002934
2935 It is not allowed to change text or jump to another window while
2936 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002937
2938 *'foldignore'* *'fdi'*
2939'foldignore' 'fdi' string (default: "#")
2940 local to window
2941 {not in Vi}
2942 {not available when compiled without the |+folding|
2943 feature}
2944 Used only when 'foldmethod' is "indent". Lines starting with
2945 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002946 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002947 The default "#" works well for C programs. See |fold-indent|.
2948
2949 *'foldlevel'* *'fdl'*
2950'foldlevel' 'fdl' number (default: 0)
2951 local to window
2952 {not in Vi}
2953 {not available when compiled without the |+folding|
2954 feature}
2955 Sets the fold level: Folds with a higher level will be closed.
2956 Setting this option to zero will close all folds. Higher numbers will
2957 close fewer folds.
2958 This option is set by commands like |zm|, |zM| and |zR|.
2959 See |fold-foldlevel|.
2960
2961 *'foldlevelstart'* *'fdls'*
2962'foldlevelstart' 'fdls' number (default: -1)
2963 global
2964 {not in Vi}
2965 {not available when compiled without the |+folding|
2966 feature}
2967 Sets 'foldlevel' when starting to edit another buffer in a window.
2968 Useful to always start editing with all folds closed (value zero),
2969 some folds closed (one) or no folds closed (99).
2970 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002971 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002972 ignores this option and closes all folds.
2973 It is also done before BufReadPre autocommands, to allow an autocmd to
2974 overrule the 'foldlevel' value for specific files.
2975 When the value is negative, it is not used.
2976
2977 *'foldmarker'* *'fmr'* *E536*
2978'foldmarker' 'fmr' string (default: "{{{,}}}")
2979 local to window
2980 {not in Vi}
2981 {not available when compiled without the |+folding|
2982 feature}
2983 The start and end marker used when 'foldmethod' is "marker". There
2984 must be one comma, which separates the start and end marker. The
2985 marker is a literal string (a regular expression would be too slow).
2986 See |fold-marker|.
2987
2988 *'foldmethod'* *'fdm'*
2989'foldmethod' 'fdm' string (default: "manual")
2990 local to window
2991 {not in Vi}
2992 {not available when compiled without the |+folding|
2993 feature}
2994 The kind of folding used for the current window. Possible values:
2995 |fold-manual| manual Folds are created manually.
2996 |fold-indent| indent Lines with equal indent form a fold.
2997 |fold-expr| expr 'foldexpr' gives the fold level of a line.
2998 |fold-marker| marker Markers are used to specify folds.
2999 |fold-syntax| syntax Syntax highlighting items specify folds.
3000 |fold-diff| diff Fold text that is not changed.
3001
3002 *'foldminlines'* *'fml'*
3003'foldminlines' 'fml' number (default: 1)
3004 local to window
3005 {not in Vi}
3006 {not available when compiled without the |+folding|
3007 feature}
3008 Sets the minimum number of screen lines for a fold to be displayed
3009 closed. Also for manually closed folds.
3010 Note that this only has an effect of what is displayed. After using
3011 "zc" to close a fold, which is displayed open because it's smaller
3012 than 'foldminlines', a following "zc" may close a containing fold.
3013
3014 *'foldnestmax'* *'fdn'*
3015'foldnestmax' 'fdn' number (default: 20)
3016 local to window
3017 {not in Vi}
3018 {not available when compiled without the |+folding|
3019 feature}
3020 Sets the maximum nesting of folds for the "indent" and "syntax"
3021 methods. This avoids that too many folds will be created. Using more
3022 than 20 doesn't work, because the internal limit is 20.
3023
3024 *'foldopen'* *'fdo'*
3025'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3026 search,tag,undo")
3027 global
3028 {not in Vi}
3029 {not available when compiled without the |+folding|
3030 feature}
3031 Specifies for which type of commands folds will be opened, if the
3032 command moves the cursor into a closed fold. It is a comma separated
3033 list of items.
3034 item commands ~
3035 all any
3036 block "(", "{", "[[", "[{", etc.
3037 hor horizontal movements: "l", "w", "fx", etc.
3038 insert any command in Insert mode
3039 jump far jumps: "G", "gg", etc.
3040 mark jumping to a mark: "'m", CTRL-O, etc.
3041 percent "%"
3042 quickfix ":cn", ":crew", ":make", etc.
3043 search search for a pattern: "/", "n", "*", "gd", etc.
3044 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003045 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003046 tag jumping to a tag: ":ta", CTRL-T, etc.
3047 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003048 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00003049 the |zv| command to the mapping to get the same effect.
3050 When a movement command is used for an operator (e.g., "dl" or "y%")
3051 this option is not used. This means the operator will include the
3052 whole closed fold.
3053 Note that vertical movements are not here, because it would make it
3054 very difficult to move onto a closed fold.
3055 In insert mode the folds containing the cursor will always be open
3056 when text is inserted.
3057 To close folds you can re-apply 'foldlevel' with the |zx| command or
3058 set the 'foldclose' option to "all".
3059
3060 *'foldtext'* *'fdt'*
3061'foldtext' 'fdt' string (default: "foldtext()")
3062 local to window
3063 {not in Vi}
3064 {not available when compiled without the |+folding|
3065 feature}
3066 An expression which is used to specify the text displayed for a closed
3067 fold. See |fold-foldtext|.
3068
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003069 The expression may be evaluated in the |sandbox|, see
3070 |sandbox-option|.
3071
3072 It is not allowed to change text or jump to another window while
3073 evaluating 'foldtext' |textlock|.
3074
Bram Moolenaar071d4272004-06-13 20:20:40 +00003075 *'formatoptions'* *'fo'*
3076'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3077 local to buffer
3078 {not in Vi}
3079 This is a sequence of letters which describes how automatic
3080 formatting is to be done. See |fo-table|. When the 'paste' option is
3081 on, no formatting is done (like 'formatoptions' is empty). Commas can
3082 be inserted for readability.
3083 To avoid problems with flags that are added in the future, use the
3084 "+=" and "-=" feature of ":set" |add-option-flags|.
3085 NOTE: This option is set to the Vi default value when 'compatible' is
3086 set and to the Vim default value when 'compatible' is reset.
3087
Bram Moolenaar86b68352004-12-27 21:59:20 +00003088 *'formatlistpat'* *'flp'*
3089'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3090 local to buffer
3091 {not in Vi}
3092 A pattern that is used to recognize a list header. This is used for
3093 the "n" flag in 'formatoptions'.
3094 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003095 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003096 while still checking more characters. There must be a character
3097 following the pattern, when it matches the whole line it is handled
3098 like there is no match.
3099 The default recognizes a number, followed by an optional punctuation
3100 character and white space.
3101
Bram Moolenaar071d4272004-06-13 20:20:40 +00003102 *'formatprg'* *'fp'*
3103'formatprg' 'fp' string (default "")
3104 global
3105 {not in Vi}
3106 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003107 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003108 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003109 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003110 If the 'formatexpr' option is not empty it will be used instead.
3111 Otherwise, if 'formatprg' option is an empty string, the internal
3112 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003113 Environment variables are expanded |:set_env|. See |option-backslash|
3114 about including spaces and backslashes.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003115 The expression may be evaluated in the |sandbox|, see
3116 |sandbox-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003117
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003118 *'formatexpr'* *'fex'*
3119'formatexpr' 'fex' string (default "")
3120 local to buffer
3121 {not in Vi}
3122 {not available when compiled without the |+eval|
3123 feature}
3124 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003125 operator. When this option is empty 'formatprg' is used.
3126
3127 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003128 The |v:count| variable holds the number of lines to be formatted.
3129 The |v:char| variable holds the character that is going to be
3130 inserted. This can be empty. Don't insert it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003131
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003132 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003133 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003134< This will invoke the mylang#Format() function in the
3135 autoload/mylang.vim file in 'runtimepath'. |autoload|
3136
3137 The expression is also evaluated when 'textwidth' is set and adding
3138 text beyond that limit. This happens under the same conditions as
3139 when internal formatting is used. Make sure the cursor is kept in the
3140 same spot relative to the text then! The |mode()| function will
Bram Moolenaar700303e2010-07-11 17:35:50 +02003141 return "i" or "R" in this situation.
3142
3143 When the expression evaluates to non-zero Vim will fall back to using
3144 the internal format mechanism.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003145
3146 The expression may be evaluated in the |sandbox|, see
3147 |sandbox-option|.
3148
3149 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003150'fsync' 'fs' boolean (default on)
3151 global
3152 {not in Vi}
3153 When on, the library function fsync() will be called after writing a
3154 file. This will flush a file to disk, ensuring that it is safely
3155 written even on filesystems which do metadata-only journaling. This
3156 will force the harddrive to spin up on Linux systems running in laptop
3157 mode, so it may be undesirable in some situations. Be warned that
3158 turning this off increases the chances of data loss after a crash. On
3159 systems without an fsync() implementation, this variable is always
3160 off.
3161 Also see 'swapsync' for controlling fsync() on swap files.
3162
Bram Moolenaar071d4272004-06-13 20:20:40 +00003163 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3164'gdefault' 'gd' boolean (default off)
3165 global
3166 {not in Vi}
3167 When on, the ":substitute" flag 'g' is default on. This means that
3168 all matches in a line are substituted instead of one. When a 'g' flag
3169 is given to a ":substitute" command, this will toggle the substitution
3170 of all or one match. See |complex-change|.
3171
3172 command 'gdefault' on 'gdefault' off ~
3173 :s/// subst. all subst. one
3174 :s///g subst. one subst. all
3175 :s///gg subst. all subst. one
3176
3177 NOTE: This option is reset when 'compatible' is set.
3178
3179 *'grepformat'* *'gfm'*
3180'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3181 global
3182 {not in Vi}
3183 Format to recognize for the ":grep" command output.
3184 This is a scanf-like string that uses the same format as the
3185 'errorformat' option: see |errorformat|.
3186
3187 *'grepprg'* *'gp'*
3188'grepprg' 'gp' string (default "grep -n ",
3189 Unix: "grep -n $* /dev/null",
3190 Win32: "findstr /n" or "grep -n",
3191 VMS: "SEARCH/NUMBERS ")
3192 global or local to buffer |global-local|
3193 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003194 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003195 and '#' characters, which are expanded like when used in a command-
3196 line. The placeholder "$*" is allowed to specify where the arguments
3197 will be included. Environment variables are expanded |:set_env|. See
3198 |option-backslash| about including spaces and backslashes.
3199 When your "grep" accepts the "-H" argument, use this to make ":grep"
3200 also work well with a single file: >
3201 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003202< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003203 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3204 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003205 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003206 apply equally to 'grepprg'.
3207 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3208 otherwise it's "grep -n".
3209 This option cannot be set from a |modeline| or in the |sandbox|, for
3210 security reasons.
3211
3212 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3213'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3214 ve:ver35-Cursor,
3215 o:hor50-Cursor,
3216 i-ci:ver25-Cursor/lCursor,
3217 r-cr:hor20-Cursor/lCursor,
3218 sm:block-Cursor
3219 -blinkwait175-blinkoff150-blinkon175",
3220 for MS-DOS and Win32 console:
3221 "n-v-c:block,o:hor50,i-ci:hor15,
3222 r-cr:hor30,sm:block")
3223 global
3224 {not in Vi}
3225 {only available when compiled with GUI enabled, and
3226 for MS-DOS and Win32 console}
3227 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003228 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003229 the height of the cursor can be changed. This can be done by
3230 specifying a block cursor, or a percentage for a vertical or
3231 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003232 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003233
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003234 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003235 mode-list and an argument-list:
3236 mode-list:argument-list,mode-list:argument-list,..
3237 The mode-list is a dash separated list of these modes:
3238 n Normal mode
3239 v Visual mode
3240 ve Visual mode with 'selection' "exclusive" (same as 'v',
3241 if not specified)
3242 o Operator-pending mode
3243 i Insert mode
3244 r Replace mode
3245 c Command-line Normal (append) mode
3246 ci Command-line Insert mode
3247 cr Command-line Replace mode
3248 sm showmatch in Insert mode
3249 a all modes
3250 The argument-list is a dash separated list of these arguments:
3251 hor{N} horizontal bar, {N} percent of the character height
3252 ver{N} vertical bar, {N} percent of the character width
3253 block block cursor, fills the whole character
3254 [only one of the above three should be present]
3255 blinkwait{N} *cursor-blinking*
3256 blinkon{N}
3257 blinkoff{N}
3258 blink times for cursor: blinkwait is the delay before
3259 the cursor starts blinking, blinkon is the time that
3260 the cursor is shown and blinkoff is the time that the
3261 cursor is not shown. The times are in msec. When one
3262 of the numbers is zero, there is no blinking. The
3263 default is: "blinkwait700-blinkon400-blinkoff250".
3264 These numbers are used for a missing entry. This
3265 means that blinking is enabled by default. To switch
3266 blinking off you can use "blinkon0". The cursor only
3267 blinks when Vim is waiting for input, not while
3268 executing a command.
3269 To make the cursor blink in an xterm, see
3270 |xterm-blink|.
3271 {group-name}
3272 a highlight group name, that sets the color and font
3273 for the cursor
3274 {group-name}/{group-name}
3275 Two highlight group names, the first is used when
3276 no language mappings are used, the other when they
3277 are. |language-mapping|
3278
3279 Examples of parts:
3280 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3281 block cursor with colors from the "nCursor"
3282 highlight group
3283 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3284 In Insert and Command-line Insert mode, use a
3285 30% vertical bar cursor with colors from the
3286 "iCursor" highlight group. Blink a bit
3287 faster.
3288
3289 The 'a' mode is different. It will set the given argument-list for
3290 all modes. It does not reset anything to defaults. This can be used
3291 to do a common setting for all modes. For example, to switch off
3292 blinking: "a:blinkon0"
3293
3294 Examples of cursor highlighting: >
3295 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3296 :highlight Cursor gui=NONE guifg=bg guibg=fg
3297<
3298 *'guifont'* *'gfn'*
3299 *E235* *E596* *E610* *E611*
3300'guifont' 'gfn' string (default "")
3301 global
3302 {not in Vi}
3303 {only available when compiled with GUI enabled}
3304 This is a list of fonts which will be used for the GUI version of Vim.
3305 In its simplest form the value is just one font name. When
3306 the font cannot be found you will get an error message. To try other
3307 font names a list can be specified, font names separated with commas.
3308 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003309
Bram Moolenaar05159a02005-02-26 23:04:13 +00003310 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3311 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003312
Bram Moolenaar071d4272004-06-13 20:20:40 +00003313 Spaces after a comma are ignored. To include a comma in a font name
3314 precede it with a backslash. Setting an option requires an extra
3315 backslash before a space and a backslash. See also
3316 |option-backslash|. For example: >
3317 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003318< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003319 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003320
3321 If none of the fonts can be loaded, Vim will keep the current setting.
3322 If an empty font list is given, Vim will try using other resource
3323 settings (for X, it will use the Vim.font resource), and finally it
3324 will try some builtin default which should always be there ("7x13" in
3325 the case of X). The font names given should be "normal" fonts. Vim
3326 will try to find the related bold and italic fonts.
3327
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003328 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003329 :set guifont=*
3330< will bring up a font requester, where you can pick the font you want.
3331
3332 The font name depends on the GUI used. See |setting-guifont| for a
3333 way to set 'guifont' for various systems.
3334
Bram Moolenaar071d4272004-06-13 20:20:40 +00003335 For the GTK+ 2 GUI the font name looks like this: >
3336 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003337< That's all. XLFDs are not used. For Chinese this is reported to work
3338 well: >
3339 if has("gui_gtk2")
3340 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3341 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3342 endif
3343<
Bram Moolenaar05159a02005-02-26 23:04:13 +00003344 For Mac OSX you can use something like this: >
3345 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003346< Also see 'macatsui', it can help fix display problems.
3347 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003348 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003349 width). An exception is GTK 2: all fonts are accepted, but
3350 mono-spaced fonts look best.
3351
Bram Moolenaar071d4272004-06-13 20:20:40 +00003352 To preview a font on X11, you might be able to use the "xfontsel"
3353 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003354
Bram Moolenaar071d4272004-06-13 20:20:40 +00003355 For the Win32 GUI *E244* *E245*
3356 - takes these options in the font name:
3357 hXX - height is XX (points, can be floating-point)
3358 wXX - width is XX (points, can be floating-point)
3359 b - bold
3360 i - italic
3361 u - underline
3362 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003363 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003364 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3365 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3366 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003367 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003368
3369 Use a ':' to separate the options.
3370 - A '_' can be used in the place of a space, so you don't need to use
3371 backslashes to escape the spaces.
3372 - Examples: >
3373 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3374 :set guifont=Andale_Mono:h7.5:w4.5
3375< See also |font-sizes|.
3376
3377 *'guifontset'* *'gfs'*
3378 *E250* *E252* *E234* *E597* *E598*
3379'guifontset' 'gfs' string (default "")
3380 global
3381 {not in Vi}
3382 {only available when compiled with GUI enabled and
3383 with the |+xfontset| feature}
3384 {not available in the GTK+ 2 GUI}
3385 When not empty, specifies two (or more) fonts to be used. The first
3386 one for normal English, the second one for your special language. See
3387 |xfontset|.
3388 Setting this option also means that all font names will be handled as
3389 a fontset name. Also the ones used for the "font" argument of the
3390 |:highlight| command.
3391 The fonts must match with the current locale. If fonts for the
3392 character sets that the current locale uses are not included, setting
3393 'guifontset' will fail.
3394 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3395 the comma-separated names are alternative names, one of which will be
3396 used. In 'guifontset' the whole string is one fontset name,
3397 including the commas. It is not possible to specify alternative
3398 fontset names.
3399 This example works on many X11 systems: >
3400 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3401<
3402 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3403'guifontwide' 'gfw' string (default "")
3404 global
3405 {not in Vi}
3406 {only available when compiled with GUI enabled}
3407 When not empty, specifies a comma-separated list of fonts to be used
3408 for double-width characters. The first font that can be loaded is
3409 used.
3410 Note: The size of these fonts must be exactly twice as wide as the one
3411 specified with 'guifont' and the same height.
3412
3413 All GUI versions but GTK+ 2:
3414
3415 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3416 'guifontset' is empty or invalid.
3417 When 'guifont' is set and a valid font is found in it and
3418 'guifontwide' is empty Vim will attempt to find a matching
3419 double-width font and set 'guifontwide' to it.
3420
3421 GTK+ 2 GUI only: *guifontwide_gtk2*
3422
3423 If set and valid, 'guifontwide' is always used for double width
3424 characters, even if 'encoding' is not set to "utf-8".
3425 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003426 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003427 font for characters not available in 'guifont'. Thus you do not need
3428 to set 'guifontwide' at all unless you want to override the choice
3429 made by Pango/Xft.
3430
3431 *'guiheadroom'* *'ghr'*
3432'guiheadroom' 'ghr' number (default 50)
3433 global
3434 {not in Vi} {only for GTK and X11 GUI}
3435 The number of pixels subtracted from the screen height when fitting
3436 the GUI window on the screen. Set this before the GUI is started,
3437 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003438 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003439 lines will be left for window decorations and other items on the
3440 screen. Set it to a negative value to allow windows taller than the
3441 screen.
3442
3443 *'guioptions'* *'go'*
3444'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003445 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003446 global
3447 {not in Vi}
3448 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003449 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003450 sequence of letters which describes what components and options of the
3451 GUI should be used.
3452 To avoid problems with flags that are added in the future, use the
3453 "+=" and "-=" feature of ":set" |add-option-flags|.
3454
3455 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003456 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003457 'a' Autoselect: If present, then whenever VISUAL mode is started,
3458 or the Visual area extended, Vim tries to become the owner of
3459 the windowing system's global selection. This means that the
3460 Visually highlighted text is available for pasting into other
3461 applications as well as into Vim itself. When the Visual mode
3462 ends, possibly due to an operation on the text, or when an
3463 application wants to paste the selection, the highlighted text
3464 is automatically yanked into the "* selection register.
3465 Thus the selection is still available for pasting into other
3466 applications after the VISUAL mode has ended.
3467 If not present, then Vim won't become the owner of the
3468 windowing system's global selection unless explicitly told to
3469 by a yank or delete operation for the "* register.
3470 The same applies to the modeless selection.
Bram Moolenaar02467872007-05-06 13:22:01 +00003471 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003472 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003473 applies to the modeless selection.
3474
3475 'guioptions' autoselect Visual autoselect modeless ~
3476 "" - -
3477 "a" yes yes
3478 "A" - yes
3479 "aA" yes yes
3480
Bram Moolenaar02467872007-05-06 13:22:01 +00003481 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003482 'c' Use console dialogs instead of popup dialogs for simple
3483 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003484 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003485 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003486 'guitablabel' can be used to change the text in the labels.
3487 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003488 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003489 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003490 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003491 'f' Foreground: Don't use fork() to detach the GUI from the shell
3492 where it was started. Use this for programs that wait for the
3493 editor to finish (e.g., an e-mail program). Alternatively you
3494 can use "gvim -f" or ":gui -f" to start the GUI in the
3495 foreground. |gui-fork|
3496 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003497 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003498 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003499 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3500 corner of the window. It's black&white on non-GTK, because of
3501 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003502 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003503 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003504 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003505 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003506 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003507 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003508 file is sourced the system menu has already been loaded; the
3509 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003510 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003511 'g' Grey menu items: Make menu items that are not active grey. If
3512 'g' is not included inactive menu items are not shown at all.
3513 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003514 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003515 't' Include tearoff menu items. Currently only works for Win32,
3516 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003517 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003518 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003519 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003520 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003521 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003522 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003523 'R' Right-hand scrollbar is present when there is a vertically
3524 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003525 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003526 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003527 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003528 'L' Left-hand scrollbar is present when there is a vertically
3529 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003530 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003531 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3532 the longest visible line, or on the cursor line if the 'h'
3533 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003534 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003535 'h' Limit horizontal scrollbar size to the length of the cursor
3536 line. Reduces computations. |gui-horiz-scroll|
3537
3538 And yes, you may even have scrollbars on the left AND the right if
3539 you really want to :-). See |gui-scrollbars| for more information.
3540
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003541 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003542 'v' Use a vertical button layout for dialogs. When not included,
3543 a horizontal layout is preferred, but when it doesn't fit a
3544 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003545 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003546 'p' Use Pointer callbacks for X11 GUI. This is required for some
3547 window managers. If the cursor is not blinking or hollow at
3548 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003549 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003550 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003551 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003552 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003553
Bram Moolenaar02467872007-05-06 13:22:01 +00003554
Bram Moolenaar071d4272004-06-13 20:20:40 +00003555 *'guipty'* *'noguipty'*
3556'guipty' boolean (default on)
3557 global
3558 {not in Vi}
3559 {only available when compiled with GUI enabled}
3560 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3561 I/O to/from shell commands. See |gui-pty|.
3562
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003563 *'guitablabel'* *'gtl'*
3564'guitablabel' 'gtl' string (default empty)
3565 global
3566 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003567 {only available when compiled with GUI enabled and
3568 with the +windows feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003569 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003570 pages line. When empty and when the result is empty Vim will use a
3571 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003572
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003573 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003574 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003575
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003576 Only used when the GUI tab pages line is displayed. 'e' must be
3577 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3578 used.
3579
Bram Moolenaar57657d82006-04-21 22:12:41 +00003580 *'guitabtooltip'* *'gtt'*
3581'guitabtooltip' 'gtt' string (default empty)
3582 global
3583 {not in Vi}
3584 {only available when compiled with GUI enabled and
3585 with the +windows feature}
3586 When nonempty describes the text to use in a tooltip for the GUI tab
3587 pages line. When empty Vim will use a default tooltip.
3588 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003589 You can include a line break. Simplest method is to use |:let|: >
3590 :let &guitabtooltip = "line one\nline two"
3591<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003592
Bram Moolenaar071d4272004-06-13 20:20:40 +00003593 *'helpfile'* *'hf'*
3594'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3595 (others) "$VIMRUNTIME/doc/help.txt")
3596 global
3597 {not in Vi}
3598 Name of the main help file. All distributed help files should be
3599 placed together in one directory. Additionally, all "doc" directories
3600 in 'runtimepath' will be used.
3601 Environment variables are expanded |:set_env|. For example:
3602 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003603 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003604 spaces and backslashes.
3605 This option cannot be set from a |modeline| or in the |sandbox|, for
3606 security reasons.
3607
3608 *'helpheight'* *'hh'*
3609'helpheight' 'hh' number (default 20)
3610 global
3611 {not in Vi}
3612 {not available when compiled without the +windows
3613 feature}
3614 Minimal initial height of the help window when it is opened with the
3615 ":help" command. The initial height of the help window is half of the
3616 current window, or (when the 'ea' option is on) the same as other
3617 windows. When the height is less than 'helpheight', the height is
3618 set to 'helpheight'. Set to zero to disable.
3619
3620 *'helplang'* *'hlg'*
3621'helplang' 'hlg' string (default: messages language or empty)
3622 global
3623 {only available when compiled with the |+multi_lang|
3624 feature}
3625 {not in Vi}
3626 Comma separated list of languages. Vim will use the first language
3627 for which the desired help can be found. The English help will always
3628 be used as a last resort. You can add "en" to prefer English over
3629 another language, but that will only find tags that exist in that
3630 language and not in the English help.
3631 Example: >
3632 :set helplang=de,it
3633< This will first search German, then Italian and finally English help
3634 files.
3635 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3636 try to find the tag in the current language before using this option.
3637 See |help-translated|.
3638
3639 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3640'hidden' 'hid' boolean (default off)
3641 global
3642 {not in Vi}
3643 When off a buffer is unloaded when it is |abandon|ed. When on a
3644 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3645 displayed in another window, it does not become hidden, of course.
3646 The commands that move through the buffer list sometimes make a buffer
3647 hidden although the 'hidden' option is off: When the buffer is
3648 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003649 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003650 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003651 This option is set for one command with ":hide {command}" |:hide|.
3652 WARNING: It's easy to forget that you have changes in hidden buffers.
3653 Think twice when using ":q!" or ":qa!".
3654
3655 *'highlight'* *'hl'*
3656'highlight' 'hl' string (default (as a single string):
3657 "8:SpecialKey,@:NonText,d:Directory,
3658 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3659 M:ModeMsg,n:LineNr,r:Question,
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003660 s:StatusLine,S:StatusLineNC,c:VertSplit,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003661 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3662 f:Folded,F:FoldColumn,A:DiffAdd,
3663 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003664 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar860cae12010-06-05 23:22:07 +02003665 R:SpellRare,L:SpellLocal,-:Conceal,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003666 +:Pmenu,=:PmenuSel,
3667 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003668 global
3669 {not in Vi}
3670 This option can be used to set highlighting mode for various
3671 occasions. It is a comma separated list of character pairs. The
3672 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003673 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003674 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3675 |hl-NonText| @ '~' and '@' at the end of the window and
3676 characters from 'showbreak'
3677 |hl-Directory| d directories in CTRL-D listing and other special
3678 things in listings
3679 |hl-ErrorMsg| e error messages
3680 h (obsolete, ignored)
3681 |hl-IncSearch| i 'incsearch' highlighting
3682 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3683 |hl-MoreMsg| m |more-prompt|
3684 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003685 |hl-LineNr| n line number for ":number" and ":#" commands, and
3686 when 'number' or 'relativenumber' option is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003687 |hl-Question| r |hit-enter| prompt and yes/no questions
3688 |hl-StatusLine| s status line of current window |status-line|
3689 |hl-StatusLineNC| S status lines of not-current windows
3690 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3691 |hl-VertSplit| c column used to separate vertically split windows
3692 |hl-Visual| v Visual mode
3693 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3694 Selection" Only X11 Gui's |gui-x11| and
3695 |xterm-clipboard|.
3696 |hl-WarningMsg| w warning messages
3697 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3698 |hl-Folded| f line used for closed folds
3699 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003700 |hl-DiffAdd| A added line in diff mode
3701 |hl-DiffChange| C changed line in diff mode
3702 |hl-DiffDelete| D deleted line in diff mode
3703 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003704 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003705 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003706 |hl-SpellCap| P word that should start with capital|spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003707 |hl-SpellRare| R rare word |spell|
3708 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02003709 |hl-Conceal| - the placeholders used for concealed characters
3710 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003711 |hl-Pmenu| + popup menu normal line
3712 |hl-PmenuSel| = popup menu normal line
3713 |hl-PmenuSbar| x popup menu scrollbar
3714 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003715
3716 The display modes are:
3717 r reverse (termcap entry "mr" and "me")
3718 i italic (termcap entry "ZH" and "ZR")
3719 b bold (termcap entry "md" and "me")
3720 s standout (termcap entry "so" and "se")
3721 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003722 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003723 n no highlighting
3724 - no highlighting
3725 : use a highlight group
3726 The default is used for occasions that are not included.
3727 If you want to change what the display modes do, see |dos-colors|
3728 for an example.
3729 When using the ':' display mode, this must be followed by the name of
3730 a highlight group. A highlight group can be used to define any type
3731 of highlighting, including using color. See |:highlight| on how to
3732 define one. The default uses a different group for each occasion.
3733 See |highlight-default| for the default highlight groups.
3734
3735 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3736'hlsearch' 'hls' boolean (default off)
3737 global
3738 {not in Vi}
3739 {not available when compiled without the
3740 |+extra_search| feature}
3741 When there is a previous search pattern, highlight all its matches.
3742 The type of highlighting used can be set with the 'l' occasion in the
3743 'highlight' option. This uses the "Search" highlight group by
3744 default. Note that only the matching text is highlighted, any offsets
3745 are not applied.
3746 See also: 'incsearch' and |:match|.
3747 When you get bored looking at the highlighted matches, you can turn it
3748 off with |:nohlsearch|. As soon as you use a search command, the
3749 highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003750 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003751 When the search pattern can match an end-of-line, Vim will try to
3752 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003753 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003754 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003755 drawn may not continue in a newly drawn line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003756 NOTE: This option is reset when 'compatible' is set.
3757
3758 *'history'* *'hi'*
3759'history' 'hi' number (Vim default: 20, Vi default: 0)
3760 global
3761 {not in Vi}
3762 A history of ":" commands, and a history of previous search patterns
3763 are remembered. This option decides how many entries may be stored in
3764 each of these histories (see |cmdline-editing|).
3765 NOTE: This option is set to the Vi default value when 'compatible' is
3766 set and to the Vim default value when 'compatible' is reset.
3767
3768 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3769'hkmap' 'hk' boolean (default off)
3770 global
3771 {not in Vi}
3772 {only available when compiled with the |+rightleft|
3773 feature}
3774 When on, the keyboard is mapped for the Hebrew character set.
3775 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3776 toggle this option. See |rileft.txt|.
3777 NOTE: This option is reset when 'compatible' is set.
3778
3779 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3780'hkmapp' 'hkp' boolean (default off)
3781 global
3782 {not in Vi}
3783 {only available when compiled with the |+rightleft|
3784 feature}
3785 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3786 This is useful if you have a non-Hebrew keyboard.
3787 See |rileft.txt|.
3788 NOTE: This option is reset when 'compatible' is set.
3789
3790 *'icon'* *'noicon'*
3791'icon' boolean (default off, on when title can be restored)
3792 global
3793 {not in Vi}
3794 {not available when compiled without the |+title|
3795 feature}
3796 When on, the icon text of the window will be set to the value of
3797 'iconstring' (if it is not empty), or to the name of the file
3798 currently being edited. Only the last part of the name is used.
3799 Overridden by the 'iconstring' option.
3800 Only works if the terminal supports setting window icons (currently
3801 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3802 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3803 builtin termcap).
3804 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003805 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003806 X11.
3807
3808 *'iconstring'*
3809'iconstring' string (default "")
3810 global
3811 {not in Vi}
3812 {not available when compiled without the |+title|
3813 feature}
3814 When this option is not empty, it will be used for the icon text of
3815 the window. This happens only when the 'icon' option is on.
3816 Only works if the terminal supports setting window icon text
3817 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3818 Does not work for MS Windows.
3819 When Vim was compiled with HAVE_X11 defined, the original icon will be
3820 restored if possible |X11|.
3821 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003822 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003823 'titlestring' for example settings.
3824 {not available when compiled without the |+statusline| feature}
3825
3826 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3827'ignorecase' 'ic' boolean (default off)
3828 global
3829 Ignore case in search patterns. Also used when searching in the tags
3830 file.
3831 Also see 'smartcase'.
3832 Can be overruled by using "\c" or "\C" in the pattern, see
3833 |/ignorecase|.
3834
3835 *'imactivatekey'* *'imak'*
3836'imactivatekey' 'imak' string (default "")
3837 global
3838 {not in Vi}
3839 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02003840 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003841 Specifies the key that your Input Method in X-Windows uses for
3842 activation. When this is specified correctly, vim can fully control
3843 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3844 You can't use this option to change the activation key, the option
3845 tells Vim what the key is.
3846 Format:
3847 [MODIFIER_FLAG-]KEY_STRING
3848
3849 These characters can be used for MODIFIER_FLAG (case is ignored):
3850 S Shift key
3851 L Lock key
3852 C Control key
3853 1 Mod1 key
3854 2 Mod2 key
3855 3 Mod3 key
3856 4 Mod4 key
3857 5 Mod5 key
3858 Combinations are allowed, for example "S-C-space" or "SC-space" are
3859 both shift+ctrl+space.
3860 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3861
3862 Example: >
3863 :set imactivatekey=S-space
3864< "S-space" means shift+space. This is the activation key for kinput2 +
3865 canna (Japanese), and ami (Korean).
3866
3867 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3868'imcmdline' 'imc' boolean (default off)
3869 global
3870 {not in Vi}
3871 {only available when compiled with the |+xim|
3872 |+multi_byte_ime| or |global-ime| feature}
3873 When set the Input Method is always on when starting to edit a command
3874 line, unless entering a search pattern (see 'imsearch' for that).
3875 Setting this option is useful when your input method allows entering
3876 English characters directly, e.g., when it's used to type accented
3877 characters with dead keys.
3878
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003879 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003880'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3881 global
3882 {not in Vi}
3883 {only available when compiled with the |+xim|
3884 |+multi_byte_ime| or |global-ime| feature}
3885 When set the Input Method is never used. This is useful to disable
3886 the IM when it doesn't work properly.
3887 Currently this option is on by default for SGI/IRIX machines. This
3888 may change in later releases.
3889
3890 *'iminsert'* *'imi'*
3891'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3892 local to buffer
3893 {not in Vi}
3894 Specifies whether :lmap or an Input Method (IM) is to be used in
3895 Insert mode. Valid values:
3896 0 :lmap is off and IM is off
3897 1 :lmap is ON and IM is off
3898 2 :lmap is off and IM is ON
3899 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3900 or |global-ime|.
3901 To always reset the option to zero when leaving Insert mode with <Esc>
3902 this can be used: >
3903 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3904< This makes :lmap and IM turn off automatically when leaving Insert
3905 mode.
3906 Note that this option changes when using CTRL-^ in Insert mode
3907 |i_CTRL-^|.
3908 The value is set to 1 when setting 'keymap' to a valid keymap name.
3909 It is also used for the argument of commands like "r" and "f".
3910 The value 0 may not work correctly with Athena and Motif with some XIM
3911 methods. Use 'imdisable' to disable XIM then.
3912
3913 *'imsearch'* *'ims'*
3914'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3915 local to buffer
3916 {not in Vi}
3917 Specifies whether :lmap or an Input Method (IM) is to be used when
3918 entering a search pattern. Valid values:
3919 -1 the value of 'iminsert' is used, makes it look like
3920 'iminsert' is also used when typing a search pattern
3921 0 :lmap is off and IM is off
3922 1 :lmap is ON and IM is off
3923 2 :lmap is off and IM is ON
3924 Note that this option changes when using CTRL-^ in Command-line mode
3925 |c_CTRL-^|.
3926 The value is set to 1 when it is not -1 and setting the 'keymap'
3927 option to a valid keymap name.
3928 The value 0 may not work correctly with Athena and Motif with some XIM
3929 methods. Use 'imdisable' to disable XIM then.
3930
3931 *'include'* *'inc'*
3932'include' 'inc' string (default "^\s*#\s*include")
3933 global or local to buffer |global-local|
3934 {not in Vi}
3935 {not available when compiled without the
3936 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003937 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003938 pattern, just like for the "/" command (See |pattern|). The default
3939 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00003940 "]I", "[d", etc.
3941 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003942 comes after the matched pattern. But if "\zs" appears in the pattern
3943 then the text matched from "\zs" to the end, or until "\ze" if it
3944 appears, is used as the file name. Use this to include characters
3945 that are not in 'isfname', such as a space. You can then use
3946 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003947 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003948
3949 *'includeexpr'* *'inex'*
3950'includeexpr' 'inex' string (default "")
3951 local to buffer
3952 {not in Vi}
3953 {not available when compiled without the
3954 |+find_in_path| or |+eval| feature}
3955 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003956 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003957 :set includeexpr=substitute(v:fname,'\\.','/','g')
3958< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003959
Bram Moolenaar071d4272004-06-13 20:20:40 +00003960 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003961 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003962 Also used for |<cfile>|.
3963
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003964 The expression may be evaluated in the |sandbox|, see
3965 |sandbox-option|.
3966
3967 It is not allowed to change text or jump to another window while
3968 evaluating 'includeexpr' |textlock|.
3969
Bram Moolenaar071d4272004-06-13 20:20:40 +00003970 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3971'incsearch' 'is' boolean (default off)
3972 global
3973 {not in Vi}
3974 {not available when compiled without the
3975 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003976 While typing a search command, show where the pattern, as it was typed
3977 so far, matches. The matched string is highlighted. If the pattern
3978 is invalid or not found, nothing is shown. The screen will be updated
3979 often, this is only useful on fast terminals.
3980 Note that the match will be shown, but the cursor will return to its
3981 original position when no match is found and when pressing <Esc>. You
3982 still need to finish the search command with <Enter> to move the
3983 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00003984 When compiled with the |+reltime| feature Vim only searches for about
3985 half a second. With a complicated pattern and/or a lot of text the
3986 match may not be found. This is to avoid that Vim hangs while you
3987 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003988 The highlighting can be set with the 'i' flag in 'highlight'.
3989 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00003990 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02003991 to the command line. If 'ignorecase' and 'smartcase' are set and the
3992 command line has no uppercase characters, the added character is
3993 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00003994 CTRL-R CTRL-W can be used to add the word at the end of the current
3995 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003996 NOTE: This option is reset when 'compatible' is set.
3997
3998 *'indentexpr'* *'inde'*
3999'indentexpr' 'inde' string (default "")
4000 local to buffer
4001 {not in Vi}
4002 {not available when compiled without the |+cindent|
4003 or |+eval| features}
4004 Expression which is evaluated to obtain the proper indent for a line.
4005 It is used when a new line is created, for the |=| operator and
4006 in Insert mode as specified with the 'indentkeys' option.
4007 When this option is not empty, it overrules the 'cindent' and
4008 'smartindent' indenting.
4009 When 'paste' is set this option is not used for indenting.
4010 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004011 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004012 when the expression is evaluated (but it may be moved around).
4013 The expression must return the number of spaces worth of indent. It
4014 can return "-1" to keep the current indent (this means 'autoindent' is
4015 used for the indent).
4016 Functions useful for computing the indent are |indent()|, |cindent()|
4017 and |lispindent()|.
4018 The evaluation of the expression must not have side effects! It must
4019 not change the text, jump to another window, etc. Afterwards the
4020 cursor position is always restored, thus the cursor may be moved.
4021 Normally this option would be set to call a function: >
4022 :set indentexpr=GetMyIndent()
4023< Error messages will be suppressed, unless the 'debug' option contains
4024 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004025 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004026 NOTE: This option is made empty when 'compatible' is set.
4027
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004028 The expression may be evaluated in the |sandbox|, see
4029 |sandbox-option|.
4030
4031 It is not allowed to change text or jump to another window while
4032 evaluating 'indentexpr' |textlock|.
4033
4034
Bram Moolenaar071d4272004-06-13 20:20:40 +00004035 *'indentkeys'* *'indk'*
4036'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4037 local to buffer
4038 {not in Vi}
4039 {not available when compiled without the |+cindent|
4040 feature}
4041 A list of keys that, when typed in Insert mode, cause reindenting of
4042 the current line. Only happens if 'indentexpr' isn't empty.
4043 The format is identical to 'cinkeys', see |indentkeys-format|.
4044 See |C-indenting| and |indent-expression|.
4045
4046 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4047'infercase' 'inf' boolean (default off)
4048 local to buffer
4049 {not in Vi}
4050 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004051 'ignorecase' is also on, the case of the match is adjusted depending
4052 on the typed text. If the typed text contains a lowercase letter
4053 where the match has an upper case letter, the completed part is made
4054 lowercase. If the typed text has no lowercase letters and the match
4055 has a lowercase letter where the typed text has an uppercase letter,
4056 and there is a letter before it, the completed part is made uppercase.
4057 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004058
4059 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4060'insertmode' 'im' boolean (default off)
4061 global
4062 {not in Vi}
4063 Makes Vim work in a way that Insert mode is the default mode. Useful
4064 if you want to use Vim as a modeless editor. Used for |evim|.
4065 These Insert mode commands will be useful:
4066 - Use the cursor keys to move around.
4067 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
4068 this is a mapping, it is executed as if 'insertmode' was off.
4069 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004070 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004071 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4072 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004073
4074 These items change when 'insertmode' is set:
4075 - when starting to edit of a file, Vim goes to Insert mode.
4076 - <Esc> in Insert mode is a no-op and beeps.
4077 - <Esc> in Normal mode makes Vim go to Insert mode.
4078 - CTRL-L in Insert mode is a command, it is not inserted.
4079 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4080 However, when <Esc> is used inside a mapping, it behaves like
4081 'insertmode' was not set. This was done to be able to use the same
4082 mappings with 'insertmode' set or not set.
4083 When executing commands with |:normal| 'insertmode' is not used.
4084
4085 NOTE: This option is reset when 'compatible' is set.
4086
4087 *'isfname'* *'isf'*
4088'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4089 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4090 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4091 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4092 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4093 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4094 global
4095 {not in Vi}
4096 The characters specified by this option are included in file names and
4097 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004098 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004099 Multi-byte characters 256 and above are always included, only the
4100 characters up to 255 are specified with this option.
4101 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004102 Think twice before adding white space to this option. Although a
4103 space may appear inside a file name, the effect will be that Vim
4104 doesn't know where a file name starts or ends when doing completion.
4105 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004106
4107 Note that on systems using a backslash as path separator, Vim tries to
4108 do its best to make it work as you would expect. That is a bit
4109 tricky, since Vi originally used the backslash to escape special
4110 characters. Vim will not remove a backslash in front of a normal file
4111 name character on these systems, but it will on Unix and alikes. The
4112 '&' and '^' are not included by default, because these are special for
4113 cmd.exe.
4114
4115 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004116 Each part can be a single character number or a range. A range is two
4117 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004118 decimal number between 0 and 255 or the ASCII character itself (does
4119 not work for digits). Example:
4120 "_,-,128-140,#-43" (include '_' and '-' and the range
4121 128 to 140 and '#' to 43)
4122 If a part starts with '^', the following character number or range
4123 will be excluded from the option. The option is interpreted from left
4124 to right. Put the excluded character after the range where it is
4125 included. To include '^' itself use it as the last character of the
4126 option or the end of a range. Example:
4127 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4128 If the character is '@', all characters where isalpha() returns TRUE
4129 are included. Normally these are the characters a to z and A to Z,
4130 plus accented characters. To include '@' itself use "@-@". Examples:
4131 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004132 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004133 "a-z,A-Z,@-@" All letters plus the '@' character.
4134 A comma can be included by using it where a character number is
4135 expected. Example:
4136 "48-57,,,_" Digits, comma and underscore.
4137 A comma can be excluded by prepending a '^'. Example:
4138 " -~,^,,9" All characters from space to '~', excluding
4139 comma, plus <Tab>.
4140 See |option-backslash| about including spaces and backslashes.
4141
4142 *'isident'* *'isi'*
4143'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4144 "@,48-57,_,128-167,224-235"
4145 otherwise: "@,48-57,_,192-255")
4146 global
4147 {not in Vi}
4148 The characters given by this option are included in identifiers.
4149 Identifiers are used in recognizing environment variables and after a
4150 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004151 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004152 option.
4153 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004154 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004155 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4156
4157 *'iskeyword'* *'isk'*
4158'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4159 "@,48-57,_,128-167,224-235"
4160 otherwise: "@,48-57,_,192-255"
4161 Vi default: "@,48-57,_")
4162 local to buffer
4163 {not in Vi}
4164 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004165 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004166 'isfname' for a description of the format of this option. For C
4167 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4168 For a help file it is set to all non-blank printable characters except
4169 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4170 command).
4171 When the 'lisp' option is on the '-' character is always included.
4172 NOTE: This option is set to the Vi default value when 'compatible' is
4173 set and to the Vim default value when 'compatible' is reset.
4174
4175 *'isprint'* *'isp'*
4176'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4177 "@,~-255"; otherwise: "@,161-255")
4178 global
4179 {not in Vi}
4180 The characters given by this option are displayed directly on the
4181 screen. It is also used for "\p" in a |pattern|. The characters from
4182 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4183 even when they are not included in 'isprint' or excluded. See
4184 'isfname' for a description of the format of this option.
4185
4186 Non-printable characters are displayed with two characters:
4187 0 - 31 "^@" - "^_"
4188 32 - 126 always single characters
4189 127 "^?"
4190 128 - 159 "~@" - "~_"
4191 160 - 254 "| " - "|~"
4192 255 "~?"
4193 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4194 displayed as <xx>, with the hexadecimal value of the byte.
4195 When 'display' contains "uhex" all unprintable characters are
4196 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004197 The SpecialKey highlighting will be used for unprintable characters.
4198 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004199
4200 Multi-byte characters 256 and above are always included, only the
4201 characters up to 255 are specified with this option. When a character
4202 is printable but it is not available in the current font, a
4203 replacement character will be shown.
4204 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4205 There is no option to specify these characters.
4206
4207 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4208'joinspaces' 'js' boolean (default on)
4209 global
4210 {not in Vi}
4211 Insert two spaces after a '.', '?' and '!' with a join command.
4212 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4213 Otherwise only one space is inserted.
4214 NOTE: This option is set when 'compatible' is set.
4215
4216 *'key'*
4217'key' string (default "")
4218 local to buffer
4219 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004220 {only available when compiled with the |+cryptv|
4221 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004222 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004223 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004224 Careful: Do not set the key value by hand, someone might see the typed
4225 key. Use the |:X| command. But you can make 'key' empty: >
4226 :set key=
4227< It is not possible to get the value of this option with ":set key" or
4228 "echo &key". This is to avoid showing it to someone who shouldn't
4229 know. It also means you cannot see it yourself once you have set it,
4230 be careful not to make a typing error!
4231
4232 *'keymap'* *'kmp'* *E544*
4233'keymap' 'kmp' string (default "")
4234 local to buffer
4235 {not in Vi}
4236 {only available when compiled with the |+keymap|
4237 feature}
4238 Name of a keyboard mapping. See |mbyte-keymap|.
4239 Setting this option to a valid keymap name has the side effect of
4240 setting 'iminsert' to one, so that the keymap becomes effective.
4241 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004242 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004243
4244 *'keymodel'* *'km'*
4245'keymodel' 'km' string (default "")
4246 global
4247 {not in Vi}
4248 List of comma separated words, which enable special things that keys
4249 can do. These values can be used:
4250 startsel Using a shifted special key starts selection (either
4251 Select mode or Visual mode, depending on "key" being
4252 present in 'selectmode').
4253 stopsel Using a not-shifted special key stops selection.
4254 Special keys in this context are the cursor keys, <End>, <Home>,
4255 <PageUp> and <PageDown>.
4256 The 'keymodel' option is set by the |:behave| command.
4257
4258 *'keywordprg'* *'kp'*
4259'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4260 OS/2: "view /", VMS: "help")
4261 global or local to buffer |global-local|
4262 {not in Vi}
4263 Program to use for the |K| command. Environment variables are
4264 expanded |:set_env|. ":help" may be used to access the Vim internal
4265 help. (Note that previously setting the global option to the empty
4266 value did this, which is now deprecated.)
4267 When "man" is used, Vim will automatically translate a count for the
4268 "K" command to a section number. Also for "man -s", in which case the
4269 "-s" is removed when there is no count.
4270 See |option-backslash| about including spaces and backslashes.
4271 Example: >
4272 :set keywordprg=man\ -s
4273< This option cannot be set from a |modeline| or in the |sandbox|, for
4274 security reasons.
4275
4276 *'langmap'* *'lmap'* *E357* *E358*
4277'langmap' 'lmap' string (default "")
4278 global
4279 {not in Vi}
4280 {only available when compiled with the |+langmap|
4281 feature}
4282 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004283 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004284 inserted directly. When in command mode the 'langmap' option takes
4285 care of translating these special characters to the original meaning
4286 of the key. This means you don't have to change the keyboard mode to
4287 be able to execute Normal mode commands.
4288 This is the opposite of the 'keymap' option, where characters are
4289 mapped in Insert mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004290
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004291 Example (for Greek, in UTF-8): *greek* >
4292 :set langmap=ΑA,ΒB,ΨC,ΔD,ΕE,ΦF,ΓG,ΗH,ΙI,ΞJ,ΚK,ΛL,ΜM,ΝN,ΟO,ΠP,QQ,ΡR,ΣS,ΤT,ΘU,ΩV,WW,ΧX,ΥY,ΖZ,αa,βb,ψc,δd,εe,φf,γg,ηh,ιi,ξj,κk,λl,μm,νn,οo,πp,qq,ρr,σs,τt,θu,ωv,ςw,χx,υy,ζz
Bram Moolenaar071d4272004-06-13 20:20:40 +00004293< Example (exchanges meaning of z and y for commands): >
4294 :set langmap=zy,yz,ZY,YZ
4295<
4296 The 'langmap' option is a list of parts, separated with commas. Each
4297 part can be in one of two forms:
4298 1. A list of pairs. Each pair is a "from" character immediately
4299 followed by the "to" character. Examples: "aA", "aAbBcC".
4300 2. A list of "from" characters, a semi-colon and a list of "to"
4301 characters. Example: "abc;ABC"
4302 Example: "aA,fgh;FGH,cCdDeE"
4303 Special characters need to be preceded with a backslash. These are
4304 ";", ',' and backslash itself.
4305
4306 This will allow you to activate vim actions without having to switch
4307 back and forth between the languages. Your language characters will
4308 be understood as normal vim English characters (according to the
4309 langmap mappings) in the following cases:
4310 o Normal/Visual mode (commands, buffer/register names, user mappings)
4311 o Insert/Replace Mode: Register names after CTRL-R
4312 o Insert/Replace Mode: Mappings
4313 Characters entered in Command-line mode will NOT be affected by
4314 this option. Note that this option can be changed at any time
4315 allowing to switch between mappings for different languages/encodings.
4316 Use a mapping to avoid having to type it each time!
4317
4318 *'langmenu'* *'lm'*
4319'langmenu' 'lm' string (default "")
4320 global
4321 {not in Vi}
4322 {only available when compiled with the |+menu| and
4323 |+multi_lang| features}
4324 Language to use for menu translation. Tells which file is loaded
4325 from the "lang" directory in 'runtimepath': >
4326 "lang/menu_" . &langmenu . ".vim"
4327< (without the spaces). For example, to always use the Dutch menus, no
4328 matter what $LANG is set to: >
4329 :set langmenu=nl_NL.ISO_8859-1
4330< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004331 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004332 If your $LANG is set to a non-English language but you do want to use
4333 the English menus: >
4334 :set langmenu=none
4335< This option must be set before loading menus, switching on filetype
4336 detection or syntax highlighting. Once the menus are defined setting
4337 this option has no effect. But you could do this: >
4338 :source $VIMRUNTIME/delmenu.vim
4339 :set langmenu=de_DE.ISO_8859-1
4340 :source $VIMRUNTIME/menu.vim
4341< Warning: This deletes all menus that you defined yourself!
4342
4343 *'laststatus'* *'ls'*
4344'laststatus' 'ls' number (default 1)
4345 global
4346 {not in Vi}
4347 The value of this option influences when the last window will have a
4348 status line:
4349 0: never
4350 1: only if there are at least two windows
4351 2: always
4352 The screen looks nicer with a status line if you have several
4353 windows, but it takes another screen line. |status-line|
4354
4355 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4356'lazyredraw' 'lz' boolean (default off)
4357 global
4358 {not in Vi}
4359 When this option is set, the screen will not be redrawn while
4360 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004361 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004362 update use |:redraw|.
4363
4364 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4365'linebreak' 'lbr' boolean (default off)
4366 local to window
4367 {not in Vi}
4368 {not available when compiled without the |+linebreak|
4369 feature}
4370 If on Vim will wrap long lines at a character in 'breakat' rather
4371 than at the last character that fits on the screen. Unlike
4372 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4373 it only affects the way the file is displayed, not its contents. The
4374 value of 'showbreak' is used to put in front of wrapped lines.
4375 This option is not used when the 'wrap' option is off or 'list' is on.
4376 Note that <Tab> characters after an <EOL> are mostly not displayed
4377 with the right amount of white space.
4378
4379 *'lines'* *E593*
4380'lines' number (default 24 or terminal height)
4381 global
4382 Number of lines of the Vim window.
4383 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004384 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004385 When Vim is running in the GUI or in a resizable window, setting this
4386 option will cause the window size to be changed. When you only want
4387 to use the size for the GUI, put the command in your |gvimrc| file.
4388 Vim limits the number of lines to what fits on the screen. You can
4389 use this command to get the tallest window possible: >
4390 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004391< Minimum value is 2, maximum value is 1000.
4392 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004393 When you set this option and Vim is unable to change the physical
4394 number of lines of the display, the display may be messed up.
4395
4396 *'linespace'* *'lsp'*
4397'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4398 global
4399 {not in Vi}
4400 {only in the GUI}
4401 Number of pixel lines inserted between characters. Useful if the font
4402 uses the full character cell height, making lines touch each other.
4403 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004404 With some fonts there can be too much room between lines (to have
4405 space for ascents and descents). Then it makes sense to set
4406 'linespace' to a negative value. This may cause display problems
4407 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004408
4409 *'lisp'* *'nolisp'*
4410'lisp' boolean (default off)
4411 local to buffer
4412 {not available when compiled without the |+lispindent|
4413 feature}
4414 Lisp mode: When <Enter> is typed in insert mode set the indent for
4415 the next line to Lisp standards (well, sort of). Also happens with
4416 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4417 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4418 better. Also see 'lispwords'.
4419 The '-' character is included in keyword characters. Redefines the
4420 "=" operator to use this same indentation algorithm rather than
4421 calling an external program if 'equalprg' is empty.
4422 This option is not used when 'paste' is set.
4423 {Vi: Does it a little bit differently}
4424
4425 *'lispwords'* *'lw'*
4426'lispwords' 'lw' string (default is very long)
4427 global
4428 {not in Vi}
4429 {not available when compiled without the |+lispindent|
4430 feature}
4431 Comma separated list of words that influence the Lisp indenting.
4432 |'lisp'|
4433
4434 *'list'* *'nolist'*
4435'list' boolean (default off)
4436 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004437 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4438 line. Useful to see the difference between tabs and spaces and for
4439 trailing blanks. Further changed by the 'listchars' option.
4440
4441 The cursor is displayed at the start of the space a Tab character
4442 occupies, not at the end as usual in Normal mode. To get this cursor
4443 position while displaying Tabs with spaces, use: >
4444 :set list lcs=tab\ \
4445<
4446 Note that list mode will also affect formatting (set with 'textwidth'
4447 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004448 changing the way tabs are displayed.
4449
4450 *'listchars'* *'lcs'*
4451'listchars' 'lcs' string (default "eol:$")
4452 global
4453 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004454 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004455 settings.
4456 eol:c Character to show at the end of each line. When
4457 omitted, there is no extra character at the end of the
4458 line.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004459 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004460 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004461 fill the space that the tab normally occupies.
4462 "tab:>-" will show a tab that takes four spaces as
4463 ">---". When omitted, a tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004464 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004465 trailing spaces are blank.
4466 extends:c Character to show in the last column, when 'wrap' is
4467 off and the line continues beyond the right of the
4468 screen.
4469 precedes:c Character to show in the first column, when 'wrap'
4470 is off and there is text preceding the character
4471 visible in the first column.
Bram Moolenaar860cae12010-06-05 23:22:07 +02004472 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004473 'conceallevel' is set to 1.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004474 nbsp:c Character to show for a non-breakable space (character
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004475 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004476
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004477 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004478 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004479 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004480
4481 Examples: >
4482 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004483 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004484 :set lcs=extends:>,precedes:<
4485< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004486 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004487 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004488
4489 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4490'loadplugins' 'lpl' boolean (default on)
4491 global
4492 {not in Vi}
4493 When on the plugin scripts are loaded when starting up |load-plugins|.
4494 This option can be reset in your |vimrc| file to disable the loading
4495 of plugins.
4496 Note that using the "-u NONE" and "--noplugin" command line arguments
4497 reset this option. |-u| |--noplugin|
4498
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004499 *'macatsui'* *'nomacatsui'*
4500'macatsui' boolean (default on)
4501 global
4502 {only available in Mac GUI version}
4503 This is a workaround for when drawing doesn't work properly. When set
4504 and compiled with multi-byte support ATSUI text drawing is used. When
4505 not set ATSUI text drawing is not used. Switch this option off when
4506 you experience drawing problems. In a future version the problems may
4507 be solved and this option becomes obsolete. Therefore use this method
4508 to unset it: >
4509 if exists('&macatsui')
4510 set nomacatsui
4511 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004512< Another option to check if you have drawing problems is
4513 'termencoding'.
4514
Bram Moolenaar071d4272004-06-13 20:20:40 +00004515 *'magic'* *'nomagic'*
4516'magic' boolean (default on)
4517 global
4518 Changes the special characters that can be used in search patterns.
4519 See |pattern|.
4520 NOTE: To avoid portability problems with using patterns, always keep
4521 this option at the default "on". Only switch it off when working with
4522 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004523 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004524
4525 *'makeef'* *'mef'*
4526'makeef' 'mef' string (default: "")
4527 global
4528 {not in Vi}
4529 {not available when compiled without the |+quickfix|
4530 feature}
4531 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4532 and the |:grep| command.
4533 When it is empty, an internally generated temp file will be used.
4534 When "##" is included, it is replaced by a number to make the name
4535 unique. This makes sure that the ":make" command doesn't overwrite an
4536 existing file.
4537 NOT used for the ":cf" command. See 'errorfile' for that.
4538 Environment variables are expanded |:set_env|.
4539 See |option-backslash| about including spaces and backslashes.
4540 This option cannot be set from a |modeline| or in the |sandbox|, for
4541 security reasons.
4542
4543 *'makeprg'* *'mp'*
4544'makeprg' 'mp' string (default "make", VMS: "MMS")
4545 global or local to buffer |global-local|
4546 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004547 Program to use for the ":make" command. See |:make_makeprg|.
4548 This option may contain '%' and '#' characters, which are expanded to
4549 the current and alternate file name. |:_%| |:_#|
4550 Environment variables are expanded |:set_env|. See |option-backslash|
4551 about including spaces and backslashes.
4552 Note that a '|' must be escaped twice: once for ":set" and once for
4553 the interpretation of a command. When you use a filter called
4554 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004555 :set makeprg=gmake\ \\\|\ myfilter
4556< The placeholder "$*" can be given (even multiple times) to specify
4557 where the arguments will be included, for example: >
4558 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4559< This option cannot be set from a |modeline| or in the |sandbox|, for
4560 security reasons.
4561
Bram Moolenaar1a384422010-07-14 19:53:30 +02004562 *'colorcolumn'* *'cc'*
4563'colorcolumn' 'cc' string (default "")
4564 local to window
4565 {not in Vi}
4566 {not available when compiled without the |+syntax|
4567 feature}
4568 'colorcolumn' is a comma separated list of screen columns that are
4569 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
4570 text. Will make screen redrawing slower.
4571 The screen column can be an absolute number, or a number preceded with
4572 '+' or '-', which is added to or subtracted from 'textwidth'. >
4573
4574 :set cc=+1 " highlight column after 'textwidth'
4575 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
4576 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
4577<
4578 When 'textwidth' is zero then the items with '-' and '+' are not used.
4579 A maximum of 256 columns are highlighted.
4580
Bram Moolenaar071d4272004-06-13 20:20:40 +00004581 *'matchpairs'* *'mps'*
4582'matchpairs' 'mps' string (default "(:),{:},[:]")
4583 local to buffer
4584 {not in Vi}
4585 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaar02467872007-05-06 13:22:01 +00004586 other. Currently only single byte character pairs are allowed, and
4587 they must be different. The characters must be separated by a colon.
4588 The pairs must be separated by a comma. Example for including '<' and
4589 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004590 :set mps+=<:>
4591
4592< A more exotic example, to jump between the '=' and ';' in an
4593 assignment, useful for languages like C and Java: >
4594 :au FileType c,cpp,java set mps+==:;
4595
4596< For a more advanced way of using "%", see the matchit.vim plugin in
4597 the $VIMRUNTIME/macros directory. |add-local-help|
4598
4599 *'matchtime'* *'mat'*
4600'matchtime' 'mat' number (default 5)
4601 global
4602 {not in Vi}{in Nvi}
4603 Tenths of a second to show the matching paren, when 'showmatch' is
4604 set. Note that this is not in milliseconds, like other options that
4605 set a time. This is to be compatible with Nvi.
4606
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004607 *'maxcombine'* *'mco'*
4608'maxcombine' 'mco' number (default 2)
4609 global
4610 {not in Vi}
4611 {only available when compiled with the |+multi_byte|
4612 feature}
4613 The maximum number of combining characters supported for displaying.
4614 Only used when 'encoding' is "utf-8".
4615 The default is OK for most languages. Hebrew may require 4.
4616 Maximum value is 6.
4617 Even when this option is set to 2 you can still edit text with more
4618 combining characters, you just can't see them. Use |g8| or |ga|.
4619 See |mbyte-combining|.
4620
Bram Moolenaar071d4272004-06-13 20:20:40 +00004621 *'maxfuncdepth'* *'mfd'*
4622'maxfuncdepth' 'mfd' number (default 100)
4623 global
4624 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004625 {not available when compiled without the +eval
4626 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004627 Maximum depth of function calls for user functions. This normally
4628 catches endless recursion. When using a recursive function with
4629 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4630 more memory, there is the danger of failing when memory is exhausted.
4631 See also |:function|.
4632
4633 *'maxmapdepth'* *'mmd'* *E223*
4634'maxmapdepth' 'mmd' number (default 1000)
4635 global
4636 {not in Vi}
4637 Maximum number of times a mapping is done without resulting in a
4638 character to be used. This normally catches endless mappings, like
4639 ":map x y" with ":map y x". It still does not catch ":map g wg",
4640 because the 'w' is used before the next mapping is done. See also
4641 |key-mapping|.
4642
4643 *'maxmem'* *'mm'*
4644'maxmem' 'mm' number (default between 256 to 5120 (system
4645 dependent) or half the amount of memory
4646 available)
4647 global
4648 {not in Vi}
4649 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4650 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004651 other memory to be freed. The maximum usable value is about 2000000.
4652 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004653
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004654 *'maxmempattern'* *'mmp'*
4655'maxmempattern' 'mmp' number (default 1000)
4656 global
4657 {not in Vi}
4658 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004659 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004660 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004661 When Vim runs into the limit it gives an error message and mostly
4662 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004663 Running into the limit often means that the pattern is very
4664 inefficient or too complex. This may already happen with the pattern
4665 "\(.\)*" on a very long line. ".*" works much better.
4666 Vim may run out of memory before hitting the 'maxmempattern' limit.
4667
Bram Moolenaar071d4272004-06-13 20:20:40 +00004668 *'maxmemtot'* *'mmt'*
4669'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4670 dependent) or half the amount of memory
4671 available)
4672 global
4673 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004674 Maximum amount of memory in Kbyte to use for all buffers together.
4675 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
4676 without a limit. On 64 bit machines higher values might work. But
4677 hey, do you really need more than 2 Gbyte for text editing?
4678 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004679
4680 *'menuitems'* *'mis'*
4681'menuitems' 'mis' number (default 25)
4682 global
4683 {not in Vi}
4684 {not available when compiled without the |+menu|
4685 feature}
4686 Maximum number of items to use in a menu. Used for menus that are
4687 generated from a list of items, e.g., the Buffers menu. Changing this
4688 option has no direct effect, the menu must be refreshed first.
4689
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004690 *'mkspellmem'* *'msm'*
4691'mkspellmem' 'msm' string (default "460000,2000,500")
4692 global
4693 {not in Vi}
4694 {not available when compiled without the |+syntax|
4695 feature}
4696 Parameters for |:mkspell|. This tunes when to start compressing the
4697 word tree. Compression can be slow when there are many words, but
4698 it's needed to avoid running out of memory. The amount of memory used
4699 per word depends very much on how similar the words are, that's why
4700 this tuning is complicated.
4701
4702 There are three numbers, separated by commas:
4703 {start},{inc},{added}
4704
4705 For most languages the uncompressed word tree fits in memory. {start}
4706 gives the amount of memory in Kbyte that can be used before any
4707 compression is done. It should be a bit smaller than the amount of
4708 memory that is available to Vim.
4709
4710 When going over the {start} limit the {inc} number specifies the
4711 amount of memory in Kbyte that can be allocated before another
4712 compression is done. A low number means compression is done after
4713 less words are added, which is slow. A high number means more memory
4714 will be allocated.
4715
4716 After doing compression, {added} times 1024 words can be added before
4717 the {inc} limit is ignored and compression is done when any extra
4718 amount of memory is needed. A low number means there is a smaller
4719 chance of hitting the {inc} limit, less memory is used but it's
4720 slower.
4721
4722 The languages for which these numbers are important are Italian and
4723 Hungarian. The default works for when you have about 512 Mbyte. If
4724 you have 1 Gbyte you could use: >
4725 :set mkspellmem=900000,3000,800
4726< If you have less than 512 Mbyte |:mkspell| may fail for some
4727 languages, no matter what you set 'mkspellmem' to.
4728
Bram Moolenaar071d4272004-06-13 20:20:40 +00004729 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00004730'modeline' 'ml' boolean (Vim default: on (off for root),
4731 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004732 local to buffer
4733 *'modelines'* *'mls'*
4734'modelines' 'mls' number (default 5)
4735 global
4736 {not in Vi}
4737 If 'modeline' is on 'modelines' gives the number of lines that is
4738 checked for set commands. If 'modeline' is off or 'modelines' is zero
4739 no lines are checked. See |modeline|.
4740 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4741 set and to the Vim default value when 'compatible' is reset.
4742
4743 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4744'modifiable' 'ma' boolean (default on)
4745 local to buffer
4746 {not in Vi} *E21*
4747 When off the buffer contents cannot be changed. The 'fileformat' and
4748 'fileencoding' options also can't be changed.
4749 Can be reset with the |-M| command line argument.
4750
4751 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4752'modified' 'mod' boolean (default off)
4753 local to buffer
4754 {not in Vi}
4755 When on, the buffer is considered to be modified. This option is set
4756 when:
4757 1. A change was made to the text since it was last written. Using the
4758 |undo| command to go back to the original text will reset the
4759 option. But undoing changes that were made before writing the
4760 buffer will set the option again, since the text is different from
4761 when it was written.
4762 2. 'fileformat' or 'fileencoding' is different from its original
4763 value. The original value is set when the buffer is read or
4764 written. A ":set nomodified" command also resets the original
4765 values to the current values and the 'modified' option will be
4766 reset.
4767 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4768 will be ignored.
4769
4770 *'more'* *'nomore'*
4771'more' boolean (Vim default: on, Vi default: off)
4772 global
4773 {not in Vi}
4774 When on, listings pause when the whole screen is filled. You will get
4775 the |more-prompt|. When this option is off there are no pauses, the
4776 listing continues until finished.
4777 NOTE: This option is set to the Vi default value when 'compatible' is
4778 set and to the Vim default value when 'compatible' is reset.
4779
4780 *'mouse'* *E538*
4781'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4782 global
4783 {not in Vi}
4784 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00004785 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
4786 sysmouse and Linux console with gpm). For using the mouse in the
4787 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004788 The mouse can be enabled for different modes:
4789 n Normal mode
4790 v Visual mode
4791 i Insert mode
4792 c Command-line mode
4793 h all previous modes when editing a help file
4794 a all previous modes
4795 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004796 Normally you would enable the mouse in all four modes with: >
4797 :set mouse=a
4798< When the mouse is not enabled, the GUI will still use the mouse for
4799 modeless selection. This doesn't move the text cursor.
4800
4801 See |mouse-using|. Also see |'clipboard'|.
4802
4803 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004804 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004805 the mouse buttons can still be used by keeping the shift key pressed.
4806 Also see the 'clipboard' option.
4807
4808 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4809'mousefocus' 'mousef' boolean (default off)
4810 global
4811 {not in Vi}
4812 {only works in the GUI}
4813 The window that the mouse pointer is on is automatically activated.
4814 When changing the window layout or window focus in another way, the
4815 mouse pointer is moved to the window with keyboard focus. Off is the
4816 default because it makes using the pull down menus a little goofy, as
4817 a pointer transit may activate a window unintentionally.
4818
4819 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4820'mousehide' 'mh' boolean (default on)
4821 global
4822 {not in Vi}
4823 {only works in the GUI}
4824 When on, the mouse pointer is hidden when characters are typed.
4825 The mouse pointer is restored when the mouse is moved.
4826
4827 *'mousemodel'* *'mousem'*
4828'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4829 global
4830 {not in Vi}
4831 Sets the model to use for the mouse. The name mostly specifies what
4832 the right mouse button is used for:
4833 extend Right mouse button extends a selection. This works
4834 like in an xterm.
4835 popup Right mouse button pops up a menu. The shifted left
4836 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004837 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004838 popup_setpos Like "popup", but the cursor will be moved to the
4839 position where the mouse was clicked, and thus the
4840 selected operation will act upon the clicked object.
4841 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004842 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004843 course, that right clicking outside a selection will
4844 end Visual mode.
4845 Overview of what button does what for each model:
4846 mouse extend popup(_setpos) ~
4847 left click place cursor place cursor
4848 left drag start selection start selection
4849 shift-left search word extend selection
4850 right click extend selection popup menu (place cursor)
4851 right drag extend selection -
4852 middle click paste paste
4853
4854 In the "popup" model the right mouse button produces a pop-up menu.
4855 You need to define this first, see |popup-menu|.
4856
4857 Note that you can further refine the meaning of buttons with mappings.
4858 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4859 selection (because that's handled in the GUI code directly).
4860
4861 The 'mousemodel' option is set by the |:behave| command.
4862
4863 *'mouseshape'* *'mouses'* *E547*
4864'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004865 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004866 global
4867 {not in Vi}
4868 {only available when compiled with the |+mouseshape|
4869 feature}
4870 This option tells Vim what the mouse pointer should look like in
4871 different modes. The option is a comma separated list of parts, much
4872 like used for 'guicursor'. Each part consist of a mode/location-list
4873 and an argument-list:
4874 mode-list:shape,mode-list:shape,..
4875 The mode-list is a dash separated list of these modes/locations:
4876 In a normal window: ~
4877 n Normal mode
4878 v Visual mode
4879 ve Visual mode with 'selection' "exclusive" (same as 'v',
4880 if not specified)
4881 o Operator-pending mode
4882 i Insert mode
4883 r Replace mode
4884
4885 Others: ~
4886 c appending to the command-line
4887 ci inserting in the command-line
4888 cr replacing in the command-line
4889 m at the 'Hit ENTER' or 'More' prompts
4890 ml idem, but cursor in the last line
4891 e any mode, pointer below last window
4892 s any mode, pointer on a status line
4893 sd any mode, while dragging a status line
4894 vs any mode, pointer on a vertical separator line
4895 vd any mode, while dragging a vertical separator line
4896 a everywhere
4897
4898 The shape is one of the following:
4899 avail name looks like ~
4900 w x arrow Normal mouse pointer
4901 w x blank no pointer at all (use with care!)
4902 w x beam I-beam
4903 w x updown up-down sizing arrows
4904 w x leftright left-right sizing arrows
4905 w x busy The system's usual busy pointer
4906 w x no The system's usual 'no input' pointer
4907 x udsizing indicates up-down resizing
4908 x lrsizing indicates left-right resizing
4909 x crosshair like a big thin +
4910 x hand1 black hand
4911 x hand2 white hand
4912 x pencil what you write with
4913 x question big ?
4914 x rightup-arrow arrow pointing right-up
4915 w x up-arrow arrow pointing up
4916 x <number> any X11 pointer number (see X11/cursorfont.h)
4917
4918 The "avail" column contains a 'w' if the shape is available for Win32,
4919 x for X11.
4920 Any modes not specified or shapes not available use the normal mouse
4921 pointer.
4922
4923 Example: >
4924 :set mouseshape=s:udsizing,m:no
4925< will make the mouse turn to a sizing arrow over the status lines and
4926 indicate no input when the hit-enter prompt is displayed (since
4927 clicking the mouse has no effect in this state.)
4928
4929 *'mousetime'* *'mouset'*
4930'mousetime' 'mouset' number (default 500)
4931 global
4932 {not in Vi}
4933 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4934 time in msec between two mouse clicks for the second click to be
4935 recognized as a multi click.
4936
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004937 *'mzquantum'* *'mzq'*
4938'mzquantum' 'mzq' number (default 100)
4939 global
4940 {not in Vi}
4941 {not available when compiled without the |+mzscheme|
4942 feature}
4943 The number of milliseconds between polls for MzScheme threads.
4944 Negative or zero value means no thread scheduling.
4945
Bram Moolenaar071d4272004-06-13 20:20:40 +00004946 *'nrformats'* *'nf'*
4947'nrformats' 'nf' string (default "octal,hex")
4948 local to buffer
4949 {not in Vi}
4950 This defines what bases Vim will consider for numbers when using the
4951 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4952 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004953 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004954 incremented or decremented. This is useful for a list with a
Bram Moolenaara3f41662010-07-11 19:01:06 +02004955 letter index a), b), etc. *octal-number*
Bram Moolenaar4770d092006-01-12 23:22:24 +00004956 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00004957 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00004958 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004959 considered to be hexadecimal. Example: Using CTRL-X on
4960 "0x100" results in "0x0ff".
4961 Numbers which simply begin with a digit in the range 1-9 are always
4962 considered decimal. This also happens for numbers that are not
4963 recognized as octal or hex.
4964
4965 *'number'* *'nu'* *'nonumber'* *'nonu'*
4966'number' 'nu' boolean (default off)
4967 local to window
4968 Print the line number in front of each line. When the 'n' option is
4969 excluded from 'cpoptions' a wrapped line will not use the column of
4970 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004971 The 'numberwidth' option can be used to set the room used for the line
4972 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004973 When a long, wrapped line doesn't start with the first character, '-'
4974 characters are put before the number.
4975 See |hl-LineNr| for the highlighting used for the number.
Bram Moolenaar64486672010-05-16 15:46:46 +02004976 When setting this option, 'relativenumber' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004977
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004978 *'numberwidth'* *'nuw'*
4979'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4980 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004981 {not in Vi}
4982 {only available when compiled with the |+linebreak|
4983 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004984 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02004985 when the 'number' or 'relativenumber' option is set or printing lines
4986 with a line number. Since one space is always between the number and
4987 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004988 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02004989 fit the highest line number in the buffer respectively the number of
4990 rows in the window, depending on whether 'number' or 'relativenumber'
4991 is set. Thus with the Vim default of 4 there is room for a line number
4992 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004993 The minimum value is 1, the maximum value is 10.
4994 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
4995
Bram Moolenaarf75a9632005-09-13 21:20:47 +00004996 *'omnifunc'* *'ofu'*
4997'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00004998 local to buffer
4999 {not in Vi}
5000 {not available when compiled without the +eval
5001 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005002 This option specifies a function to be used for Insert mode omni
5003 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005004 See |complete-functions| for an explanation of how the function is
5005 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005006 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005007 |:filetype-plugin-on|
Bram Moolenaare344bea2005-09-01 20:46:49 +00005008
5009
Bram Moolenaar02467872007-05-06 13:22:01 +00005010 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005011'opendevice' 'odev' boolean (default off)
5012 global
5013 {not in Vi}
5014 {only for MS-DOS, MS-Windows and OS/2}
5015 Enable reading and writing from devices. This may get Vim stuck on a
5016 device that can be opened but doesn't actually do the I/O. Therefore
5017 it is off by default.
5018 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5019 result in editing a device.
5020
5021
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005022 *'operatorfunc'* *'opfunc'*
5023'operatorfunc' 'opfunc' string (default: empty)
5024 global
5025 {not in Vi}
5026 This option specifies a function to be called by the |g@| operator.
5027 See |:map-operator| for more info and an example.
5028
5029 This option cannot be set from a |modeline| or in the |sandbox|, for
5030 security reasons.
5031
5032
Bram Moolenaar071d4272004-06-13 20:20:40 +00005033 *'osfiletype'* *'oft'* *E366*
5034'osfiletype' 'oft' string (RISC-OS default: "Text",
5035 others default: "")
5036 local to buffer
5037 {not in Vi}
5038 {only available when compiled with the |+osfiletype|
5039 feature}
5040 Some operating systems store extra information about files besides
5041 name, datestamp and permissions. This option contains the extra
5042 information, the nature of which will vary between systems.
5043 The value of this option is usually set when the file is loaded, and
Bram Moolenaare37d50a2008-08-06 17:06:04 +00005044 is used to set the operating system file type when file is written.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005045 It can affect the pattern matching of the automatic commands.
5046 |autocmd-osfiletypes|
5047
5048 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005049'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005050 global
5051 Specifies the nroff macros that separate paragraphs. These are pairs
5052 of two letters (see |object-motions|).
5053
5054 *'paste'* *'nopaste'*
5055'paste' boolean (default off)
5056 global
5057 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005058 Put Vim in Paste mode. This is useful if you want to cut or copy
5059 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005060 unexpected effects.
5061 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005062 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005063 knows about pasting and will mostly do the right thing without 'paste'
5064 being set. The same is true for a terminal where Vim handles the
5065 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005066 This option is reset when starting the GUI. Thus if you set it in
5067 your .vimrc it will work in a terminal, but not in the GUI. Setting
5068 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5069 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005070 When the 'paste' option is switched on (also when it was already on):
5071 - mapping in Insert mode and Command-line mode is disabled
5072 - abbreviations are disabled
5073 - 'textwidth' is set to 0
5074 - 'wrapmargin' is set to 0
5075 - 'autoindent' is reset
5076 - 'smartindent' is reset
5077 - 'softtabstop' is set to 0
5078 - 'revins' is reset
5079 - 'ruler' is reset
5080 - 'showmatch' is reset
5081 - 'formatoptions' is used like it is empty
5082 These options keep their value, but their effect is disabled:
5083 - 'lisp'
5084 - 'indentexpr'
5085 - 'cindent'
5086 NOTE: When you start editing another file while the 'paste' option is
5087 on, settings from the modelines or autocommands may change the
5088 settings again, causing trouble when pasting text. You might want to
5089 set the 'paste' option again.
5090 When the 'paste' option is reset the mentioned options are restored to
5091 the value before the moment 'paste' was switched from off to on.
5092 Resetting 'paste' before ever setting it does not have any effect.
5093 Since mapping doesn't work while 'paste' is active, you need to use
5094 the 'pastetoggle' option to toggle the 'paste' option with some key.
5095
5096 *'pastetoggle'* *'pt'*
5097'pastetoggle' 'pt' string (default "")
5098 global
5099 {not in Vi}
5100 When non-empty, specifies the key sequence that toggles the 'paste'
5101 option. This is like specifying a mapping: >
5102 :map {keys} :set invpaste<CR>
5103< Where {keys} is the value of 'pastetoggle'.
5104 The difference is that it will work even when 'paste' is set.
5105 'pastetoggle' works in Insert mode and Normal mode, but not in
5106 Command-line mode.
5107 Mappings are checked first, thus overrule 'pastetoggle'. However,
5108 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5109 this: >
5110 :map <F10> :set paste<CR>
5111 :map <F11> :set nopaste<CR>
5112 :imap <F10> <C-O>:set paste<CR>
5113 :imap <F11> <nop>
5114 :set pastetoggle=<F11>
5115< This will make <F10> start paste mode and <F11> stop paste mode.
5116 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5117 mode everything is inserted literally, except the 'pastetoggle' key
5118 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005119 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005120
5121 *'pex'* *'patchexpr'*
5122'patchexpr' 'pex' string (default "")
5123 global
5124 {not in Vi}
5125 {not available when compiled without the |+diff|
5126 feature}
5127 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005128 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005129
5130 *'patchmode'* *'pm'* *E206*
5131'patchmode' 'pm' string (default "")
5132 global
5133 {not in Vi}
5134 When non-empty the oldest version of a file is kept. This can be used
5135 to keep the original version of a file if you are changing files in a
5136 source distribution. Only the first time that a file is written a
5137 copy of the original file will be kept. The name of the copy is the
5138 name of the original file with the string in the 'patchmode' option
5139 appended. This option should start with a dot. Use a string like
5140 ".org". 'backupdir' must not be empty for this to work (Detail: The
5141 backup file is renamed to the patchmode file after the new file has
5142 been successfully written, that's why it must be possible to write a
5143 backup file). If there was no file to be backed up, an empty file is
5144 created.
5145 When the 'backupskip' pattern matches, a patchmode file is not made.
5146 Using 'patchmode' for compressed files appends the extension at the
5147 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5148 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005149 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005150
5151 *'path'* *'pa'* *E343* *E345* *E347*
5152'path' 'pa' string (default on Unix: ".,/usr/include,,"
5153 on OS/2: ".,/emx/include,,"
5154 other systems: ".,,")
5155 global or local to buffer |global-local|
5156 {not in Vi}
5157 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005158 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5159 provided that the file being searched for has a relative path (not
5160 starting with "/", "./" or "../"). The directories in the 'path'
5161 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005162 - Use commas to separate directory names: >
5163 :set path=.,/usr/local/include,/usr/include
5164< - Spaces can also be used to separate directory names (for backwards
5165 compatibility with version 3.0). To have a space in a directory
5166 name, precede it with an extra backslash, and escape the space: >
5167 :set path=.,/dir/with\\\ space
5168< - To include a comma in a directory name precede it with an extra
5169 backslash: >
5170 :set path=.,/dir/with\\,comma
5171< - To search relative to the directory of the current file, use: >
5172 :set path=.
5173< - To search in the current directory use an empty string between two
5174 commas: >
5175 :set path=,,
5176< - A directory name may end in a ':' or '/'.
5177 - Environment variables are expanded |:set_env|.
5178 - When using |netrw.vim| URLs can be used. For example, adding
5179 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005180 - Search upwards and downwards in a directory tree using "*", "**" and
5181 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005182 {not available when compiled without the |+path_extra| feature}
5183 - Careful with '\' characters, type two to get one in the option: >
5184 :set path=.,c:\\include
5185< Or just use '/' instead: >
5186 :set path=.,c:/include
5187< Don't forget "." or files won't even be found in the same directory as
5188 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005189 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005190 it is something like 256 or 1024 characters.
5191 You can check if all the include files are found, using the value of
5192 'path', see |:checkpath|.
5193 The use of |:set+=| and |:set-=| is preferred when adding or removing
5194 directories from the list. This avoids problems when a future version
5195 uses another default. To remove the current directory use: >
5196 :set path-=
5197< To add the current directory use: >
5198 :set path+=
5199< To use an environment variable, you probably need to replace the
5200 separator. Here is an example to append $INCL, in which directory
5201 names are separated with a semi-colon: >
5202 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5203< Replace the ';' with a ':' or whatever separator is used. Note that
5204 this doesn't work when $INCL contains a comma or white space.
5205
5206 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5207'preserveindent' 'pi' boolean (default off)
5208 local to buffer
5209 {not in Vi}
5210 When changing the indent of the current line, preserve as much of the
5211 indent structure as possible. Normally the indent is replaced by a
5212 series of tabs followed by spaces as required (unless |'expandtab'| is
5213 enabled, in which case only spaces are used). Enabling this option
5214 means the indent will preserve as many existing characters as possible
5215 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005216 'expandtab' does not apply to the preserved white space, a Tab remains
5217 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005218 NOTE: When using ">>" multiple times the resulting indent is a mix of
5219 tabs and spaces. You might not like this.
5220 NOTE: 'preserveindent' is reset when 'compatible' is set.
5221 Also see 'copyindent'.
5222 Use |:retab| to clean up white space.
5223
5224 *'previewheight'* *'pvh'*
5225'previewheight' 'pvh' number (default 12)
5226 global
5227 {not in Vi}
5228 {not available when compiled without the |+windows| or
5229 |+quickfix| feature}
5230 Default height for a preview window. Used for |:ptag| and associated
5231 commands. Used for |CTRL-W_}| when no count is given.
5232
5233 *'previewwindow'* *'nopreviewwindow'*
5234 *'pvw'* *'nopvw'* *E590*
5235'previewwindow' 'pvw' boolean (default off)
5236 local to window
5237 {not in Vi}
5238 {not available when compiled without the |+windows| or
5239 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005240 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005241 set. It's normally not set directly, but by using one of the commands
5242 |:ptag|, |:pedit|, etc.
5243
5244 *'printdevice'* *'pdev'*
5245'printdevice' 'pdev' string (default empty)
5246 global
5247 {not in Vi}
5248 {only available when compiled with the |+printer|
5249 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005250 The name of the printer to be used for |:hardcopy|.
5251 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005252 This option cannot be set from a |modeline| or in the |sandbox|, for
5253 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005254
Bram Moolenaar8299df92004-07-10 09:47:34 +00005255 *'printencoding'* *'penc'*
5256'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005257 global
5258 {not in Vi}
5259 {only available when compiled with the |+printer|
5260 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005261 Sets the character encoding used when printing.
5262 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005263
5264 *'printexpr'* *'pexpr'*
5265'printexpr' 'pexpr' String (default: see below)
5266 global
5267 {not in Vi}
5268 {only available when compiled with the |+printer|
5269 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005270 Expression used to print the PostScript produced with |:hardcopy|.
5271 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005272
Bram Moolenaar8299df92004-07-10 09:47:34 +00005273 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005274'printfont' 'pfn' string (default "courier")
5275 global
5276 {not in Vi}
5277 {only available when compiled with the |+printer|
5278 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005279 The name of the font that will be used for |:hardcopy|.
5280 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005281
5282 *'printheader'* *'pheader'*
5283'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5284 global
5285 {not in Vi}
5286 {only available when compiled with the |+printer|
5287 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005288 The format of the header produced in |:hardcopy| output.
5289 See |pheader-option|.
5290
5291 *'printmbcharset'* *'pmbcs'*
5292'printmbcharset' 'pmbcs' string (default "")
5293 global
5294 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005295 {only available when compiled with the |+printer|,
5296 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005297 The CJK character set to be used for CJK output from |:hardcopy|.
5298 See |pmbcs-option|.
5299
5300 *'printmbfont'* *'pmbfn'*
5301'printmbfont' 'pmbfn' string (default "")
5302 global
5303 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005304 {only available when compiled with the |+printer|,
5305 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005306 List of font names to be used for CJK output from |:hardcopy|.
5307 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005308
5309 *'printoptions'* *'popt'*
5310'printoptions' 'popt' string (default "")
5311 global
5312 {not in Vi}
5313 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005314 List of items that control the format of the output of |:hardcopy|.
5315 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005316
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005317 *'prompt'* *'noprompt'*
5318'prompt' boolean (default on)
5319 global
5320 When on a ":" prompt is used in Ex mode.
5321
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005322 *'pumheight'* *'ph'*
5323'pumheight' 'ph' number (default 0)
5324 global
5325 {not available when compiled without the
5326 |+insert_expand| feature}
5327 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005328 Determines the maximum number of items to show in the popup menu for
5329 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005330 |ins-completion-menu|.
5331
5332
Bram Moolenaar677ee682005-01-27 14:41:15 +00005333 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005334'quoteescape' 'qe' string (default "\")
5335 local to buffer
5336 {not in Vi}
5337 The characters that are used to escape quotes in a string. Used for
5338 objects like a', a" and a` |a'|.
5339 When one of the characters in this option is found inside a string,
5340 the following character will be skipped. The default value makes the
5341 text "foo\"bar\\" considered to be one string.
5342
Bram Moolenaar071d4272004-06-13 20:20:40 +00005343 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5344'readonly' 'ro' boolean (default off)
5345 local to buffer
5346 If on, writes fail unless you use a '!'. Protects you from
5347 accidentally overwriting a file. Default on when Vim is started
5348 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005349 When using ":w!" the 'readonly' option is reset for the current
5350 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005351 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005352 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005353
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005354 *'redrawtime'* *'rdt'*
5355'redrawtime' 'rdt' number (default 2000)
5356 global
5357 {not in Vi}
5358 {only available when compiled with the |+reltime|
5359 feature}
5360 The time in milliseconds for redrawing the display. This applies to
5361 searching for patterns for 'hlsearch' and |:match| highlighting.
5362 When redrawing takes more than this many milliseconds no further
5363 matches will be highlighted. This is used to avoid that Vim hangs
5364 when using a very complicated pattern.
5365
Bram Moolenaar64486672010-05-16 15:46:46 +02005366 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5367'relativenumber' 'rnu' boolean (default off)
5368 local to window
5369 {not in Vi}
5370 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005371 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005372 precede some vertical motion commands (e.g. j k + -) with, without
5373 having to calculate it yourself. Especially useful in combination with
5374 other commands (e.g. y d c < > gq gw =).
5375 When the 'n' option is excluded from 'cpoptions' a wrapped
5376 line will not use the column of line numbers (this is the default when
5377 'compatible' isn't set).
5378 The 'numberwidth' option can be used to set the room used for the line
5379 number.
5380 When a long, wrapped line doesn't start with the first character, '-'
5381 characters are put before the number.
5382 See |hl-LineNr| for the highlighting used for the number.
5383 When setting this option, 'number' is reset.
5384
Bram Moolenaar071d4272004-06-13 20:20:40 +00005385 *'remap'* *'noremap'*
5386'remap' boolean (default on)
5387 global
5388 Allows for mappings to work recursively. If you do not want this for
5389 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005390 NOTE: To avoid portability problems with Vim scripts, always keep
5391 this option at the default "on". Only switch it off when working with
5392 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005393
5394 *'report'*
5395'report' number (default 2)
5396 global
5397 Threshold for reporting number of lines changed. When the number of
5398 changed lines is more than 'report' a message will be given for most
5399 ":" commands. If you want it always, set 'report' to 0.
5400 For the ":substitute" command the number of substitutions is used
5401 instead of the number of lines.
5402
5403 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5404'restorescreen' 'rs' boolean (default on)
5405 global
5406 {not in Vi} {only in Windows 95/NT console version}
5407 When set, the screen contents is restored when exiting Vim. This also
5408 happens when executing external commands.
5409
5410 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5411 options in your .vimrc. To disable restoring:
5412 set t_ti= t_te=
5413 To enable restoring (for an xterm):
5414 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5415 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5416
5417 *'revins'* *'ri'* *'norevins'* *'nori'*
5418'revins' 'ri' boolean (default off)
5419 global
5420 {not in Vi}
5421 {only available when compiled with the |+rightleft|
5422 feature}
5423 Inserting characters in Insert mode will work backwards. See "typing
5424 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5425 command in Insert mode, when 'allowrevins' is set.
5426 NOTE: This option is reset when 'compatible' or 'paste' is set.
5427
5428 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5429'rightleft' 'rl' boolean (default off)
5430 local to window
5431 {not in Vi}
5432 {only available when compiled with the |+rightleft|
5433 feature}
5434 When on, display orientation becomes right-to-left, i.e., characters
5435 that are stored in the file appear from the right to the left.
5436 Using this option, it is possible to edit files for languages that
5437 are written from the right to the left such as Hebrew and Arabic.
5438 This option is per window, so it is possible to edit mixed files
5439 simultaneously, or to view the same file in both ways (this is
5440 useful whenever you have a mixed text file with both right-to-left
5441 and left-to-right strings so that both sets are displayed properly
5442 in different windows). Also see |rileft.txt|.
5443
5444 *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'*
5445'rightleftcmd' 'rlc' string (default "search")
5446 local to window
5447 {not in Vi}
5448 {only available when compiled with the |+rightleft|
5449 feature}
5450 Each word in this option enables the command line editing to work in
5451 right-to-left mode for a group of commands:
5452
5453 search "/" and "?" commands
5454
5455 This is useful for languages such as Hebrew, Arabic and Farsi.
5456 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5457
5458 *'ruler'* *'ru'* *'noruler'* *'noru'*
5459'ruler' 'ru' boolean (default off)
5460 global
5461 {not in Vi}
5462 {not available when compiled without the
5463 |+cmdline_info| feature}
5464 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005465 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005466 text in the file is shown on the far right:
5467 Top first line is visible
5468 Bot last line is visible
5469 All first and last line are visible
5470 45% relative position in the file
5471 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005472 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005473 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005474 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005475 this option takes precedence over 'ruler' and 'rulerformat'
5476 If the number of characters displayed is different from the number of
5477 bytes in the text (e.g., for a TAB or a multi-byte character), both
5478 the text column (byte number) and the screen column are shown,
5479 separated with a dash.
5480 For an empty line "0-1" is shown.
5481 For an empty buffer the line number will also be zero: "0,0-1".
5482 This option is reset when the 'paste' option is set.
5483 If you don't want to see the ruler all the time but want to know where
5484 you are, use "g CTRL-G" |g_CTRL-G|.
5485 NOTE: This option is reset when 'compatible' is set.
5486
5487 *'rulerformat'* *'ruf'*
5488'rulerformat' 'ruf' string (default empty)
5489 global
5490 {not in Vi}
5491 {not available when compiled without the |+statusline|
5492 feature}
5493 When this option is not empty, it determines the content of the ruler
5494 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005495 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005496 The default ruler width is 17 characters. To make the ruler 15
5497 characters wide, put "%15(" at the start and "%)" at the end.
5498 Example: >
5499 :set rulerformat=%15(%c%V\ %p%%%)
5500<
5501 *'runtimepath'* *'rtp'* *vimfiles*
5502'runtimepath' 'rtp' string (default:
5503 Unix: "$HOME/.vim,
5504 $VIM/vimfiles,
5505 $VIMRUNTIME,
5506 $VIM/vimfiles/after,
5507 $HOME/.vim/after"
5508 Amiga: "home:vimfiles,
5509 $VIM/vimfiles,
5510 $VIMRUNTIME,
5511 $VIM/vimfiles/after,
5512 home:vimfiles/after"
5513 PC, OS/2: "$HOME/vimfiles,
5514 $VIM/vimfiles,
5515 $VIMRUNTIME,
5516 $VIM/vimfiles/after,
5517 $HOME/vimfiles/after"
5518 Macintosh: "$VIM:vimfiles,
5519 $VIMRUNTIME,
5520 $VIM:vimfiles:after"
5521 RISC-OS: "Choices:vimfiles,
5522 $VIMRUNTIME,
5523 Choices:vimfiles/after"
5524 VMS: "sys$login:vimfiles,
5525 $VIM/vimfiles,
5526 $VIMRUNTIME,
5527 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005528 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005529 global
5530 {not in Vi}
5531 This is a list of directories which will be searched for runtime
5532 files:
5533 filetype.vim filetypes by file name |new-filetype|
5534 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005535 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005536 colors/ color scheme files |:colorscheme|
5537 compiler/ compiler files |:compiler|
5538 doc/ documentation |write-local-help|
5539 ftplugin/ filetype plugins |write-filetype-plugin|
5540 indent/ indent scripts |indent-expression|
5541 keymap/ key mapping files |mbyte-keymap|
5542 lang/ menu translations |:menutrans|
5543 menu.vim GUI menus |menu.vim|
5544 plugin/ plugin scripts |write-plugin|
5545 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005546 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005547 syntax/ syntax files |mysyntaxfile|
5548 tutor/ files for vimtutor |tutor|
5549
5550 And any other file searched for with the |:runtime| command.
5551
5552 The defaults for most systems are setup to search five locations:
5553 1. In your home directory, for your personal preferences.
5554 2. In a system-wide Vim directory, for preferences from the system
5555 administrator.
5556 3. In $VIMRUNTIME, for files distributed with Vim.
5557 *after-directory*
5558 4. In the "after" directory in the system-wide Vim directory. This is
5559 for the system administrator to overrule or add to the distributed
5560 defaults (rarely needed)
5561 5. In the "after" directory in your home directory. This is for
5562 personal preferences to overrule or add to the distributed defaults
5563 or system-wide settings (rarely needed).
5564
5565 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5566 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005567 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005568 wildcards.
5569 See |:runtime|.
5570 Example: >
5571 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5572< This will use the directory "~/vimruntime" first (containing your
5573 personal Vim runtime files), then "/mygroup/vim" (shared between a
5574 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5575 files).
5576 You probably should always include $VIMRUNTIME somewhere, to use the
5577 distributed runtime files. You can put a directory before $VIMRUNTIME
5578 to find files which replace a distributed runtime files. You can put
5579 a directory after $VIMRUNTIME to find files which add to distributed
5580 runtime files.
5581 This option cannot be set from a |modeline| or in the |sandbox|, for
5582 security reasons.
5583
5584 *'scroll'* *'scr'*
5585'scroll' 'scr' number (default: half the window height)
5586 local to window
5587 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5588 set to half the number of lines in the window when the window size
5589 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005590 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005591 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5592 the number of screen lines instead of file lines, makes a difference
5593 when lines wrap}
5594
5595 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5596'scrollbind' 'scb' boolean (default off)
5597 local to window
5598 {not in Vi}
5599 {not available when compiled without the |+scrollbind|
5600 feature}
5601 See also |scroll-binding|. When this option is set, the current
5602 window scrolls as other scrollbind windows (windows that also have
5603 this option set) scroll. This option is useful for viewing the
5604 differences between two versions of a file, see 'diff'.
5605 See |'scrollopt'| for options that determine how this option should be
5606 interpreted.
5607 This option is mostly reset when splitting a window to edit another
5608 file. This means that ":split | edit file" results in two windows
5609 with scroll-binding, but ":split file" does not.
5610
5611 *'scrolljump'* *'sj'*
5612'scrolljump' 'sj' number (default 1)
5613 global
5614 {not in Vi}
5615 Minimal number of lines to scroll when the cursor gets off the
5616 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5617 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005618 When set to a negative number from -1 to -100 this is used as the
5619 percentage of the window height. Thus -50 scrolls half the window
5620 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005621 NOTE: This option is set to 1 when 'compatible' is set.
5622
5623 *'scrolloff'* *'so'*
5624'scrolloff' 'so' number (default 0)
5625 global
5626 {not in Vi}
5627 Minimal number of screen lines to keep above and below the cursor.
5628 This will make some context visible around where you are working. If
5629 you set it to a very large value (999) the cursor line will always be
5630 in the middle of the window (except at the start or end of the file or
5631 when long lines wrap).
5632 For scrolling horizontally see 'sidescrolloff'.
5633 NOTE: This option is set to 0 when 'compatible' is set.
5634
5635 *'scrollopt'* *'sbo'*
5636'scrollopt' 'sbo' string (default "ver,jump")
5637 global
5638 {not available when compiled without the |+scrollbind|
5639 feature}
5640 {not in Vi}
5641 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005642 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5643 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005644 The following words are available:
5645 ver Bind vertical scrolling for 'scrollbind' windows
5646 hor Bind horizontal scrolling for 'scrollbind' windows
5647 jump Applies to the offset between two windows for vertical
5648 scrolling. This offset is the difference in the first
5649 displayed line of the bound windows. When moving
5650 around in a window, another 'scrollbind' window may
5651 reach a position before the start or after the end of
5652 the buffer. The offset is not changed though, when
5653 moving back the 'scrollbind' window will try to scroll
5654 to the desired position when possible.
5655 When now making that window the current one, two
5656 things can be done with the relative offset:
5657 1. When "jump" is not included, the relative offset is
5658 adjusted for the scroll position in the new current
5659 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00005660 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005661 2. When "jump" is included, the other windows are
5662 scrolled to keep the same relative offset. When
5663 going back to the other window, it still uses the
5664 same relative offset.
5665 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005666 When 'diff' mode is active there always is vertical scroll binding,
5667 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005668
5669 *'sections'* *'sect'*
5670'sections' 'sect' string (default "SHNHH HUnhsh")
5671 global
5672 Specifies the nroff macros that separate sections. These are pairs of
5673 two letters (See |object-motions|). The default makes a section start
5674 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5675
5676 *'secure'* *'nosecure'* *E523*
5677'secure' boolean (default off)
5678 global
5679 {not in Vi}
5680 When on, ":autocmd", shell and write commands are not allowed in
5681 ".vimrc" and ".exrc" in the current directory and map commands are
5682 displayed. Switch it off only if you know that you will not run into
5683 problems, or when the 'exrc' option is off. On Unix this option is
5684 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005685 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005686 'secure' at the end of your ~/.vimrc then.
5687 This option cannot be set from a |modeline| or in the |sandbox|, for
5688 security reasons.
5689
5690 *'selection'* *'sel'*
5691'selection' 'sel' string (default "inclusive")
5692 global
5693 {not in Vi}
5694 This option defines the behavior of the selection. It is only used
5695 in Visual and Select mode.
5696 Possible values:
5697 value past line inclusive ~
5698 old no yes
5699 inclusive yes yes
5700 exclusive yes no
5701 "past line" means that the cursor is allowed to be positioned one
5702 character past the line.
5703 "inclusive" means that the last character of the selection is included
5704 in an operation. For example, when "x" is used to delete the
5705 selection.
5706 Note that when "exclusive" is used and selecting from the end
5707 backwards, you cannot include the last character of a line, when
5708 starting in Normal mode and 'virtualedit' empty.
5709
5710 The 'selection' option is set by the |:behave| command.
5711
5712 *'selectmode'* *'slm'*
5713'selectmode' 'slm' string (default "")
5714 global
5715 {not in Vi}
5716 This is a comma separated list of words, which specifies when to start
5717 Select mode instead of Visual mode, when a selection is started.
5718 Possible values:
5719 mouse when using the mouse
5720 key when using shifted special keys
5721 cmd when using "v", "V" or CTRL-V
5722 See |Select-mode|.
5723 The 'selectmode' option is set by the |:behave| command.
5724
5725 *'sessionoptions'* *'ssop'*
5726'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00005727 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005728 global
5729 {not in Vi}
5730 {not available when compiled without the +mksession
5731 feature}
5732 Changes the effect of the |:mksession| command. It is a comma
5733 separated list of words. Each word enables saving and restoring
5734 something:
5735 word save and restore ~
5736 blank empty windows
5737 buffers hidden and unloaded buffers, not just those in windows
5738 curdir the current directory
5739 folds manually created folds, opened/closed folds and local
5740 fold options
5741 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005742 and contain at least one lowercase letter. Only
5743 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005744 help the help window
5745 localoptions options and mappings local to a window or buffer (not
5746 global values for local options)
5747 options all options and mappings (also global values for local
5748 options)
5749 resize size of the Vim window: 'lines' and 'columns'
5750 sesdir the directory in which the session file is located
5751 will become the current directory (useful with
5752 projects accessed over a network from different
5753 systems)
5754 slash backslashes in file names replaced with forward
5755 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00005756 tabpages all tab pages; without this only the current tab page
5757 is restored, so that you can make a session for each
5758 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00005759 unix with Unix end-of-line format (single <NL>), even when
5760 on Windows or DOS
5761 winpos position of the whole Vim window
5762 winsize window sizes
5763
5764 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005765 When neither "curdir" nor "sesdir" is included, file names are stored
5766 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005767 "slash" and "unix" are useful on Windows when sharing session files
5768 with Unix. The Unix version of Vim cannot source dos format scripts,
5769 but the Windows version of Vim can source unix format scripts.
5770
5771 *'shell'* *'sh'* *E91*
5772'shell' 'sh' string (default $SHELL or "sh",
5773 MS-DOS and Win32: "command.com" or
5774 "cmd.exe", OS/2: "cmd")
5775 global
5776 Name of the shell to use for ! and :! commands. When changing the
5777 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5778 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005779 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005780 See |option-backslash| about including spaces and backslashes.
5781 Environment variables are expanded |:set_env|.
5782 If the name of the shell contains a space, you might need to enclose
5783 it in quotes. Example: >
5784 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5785< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005786 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005787 "-f" is not inside the quotes, because it is not part of the command
5788 name. And Vim automagically recognizes the backslashes that are path
5789 separators.
5790 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5791 variable to change the way external commands are executed. See the
5792 libc.inf file of DJGPP.
5793 Under MS-Windows, when the executable ends in ".com" it must be
5794 included. Thus setting the shell to "command.com" or "4dos.com"
5795 works, but "command" and "4dos" do not work for all commands (e.g.,
5796 filtering).
5797 For unknown reasons, when using "4dos.com" the current directory is
5798 changed to "C:\". To avoid this set 'shell' like this: >
5799 :set shell=command.com\ /c\ 4dos
5800< This option cannot be set from a |modeline| or in the |sandbox|, for
5801 security reasons.
5802
5803 *'shellcmdflag'* *'shcf'*
5804'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5805 does not contain "sh" somewhere: "/c")
5806 global
5807 {not in Vi}
5808 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5809 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5810 systems, the default is set according to the value of 'shell', to
5811 reduce the need to set this option by the user. It's not used for
5812 OS/2 (EMX figures this out itself). See |option-backslash| about
5813 including spaces and backslashes. See |dos-shell|.
5814 This option cannot be set from a |modeline| or in the |sandbox|, for
5815 security reasons.
5816
5817 *'shellpipe'* *'sp'*
5818'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5819 global
5820 {not in Vi}
5821 {not available when compiled without the |+quickfix|
5822 feature}
5823 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005824 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005825 including spaces and backslashes.
5826 The name of the temporary file can be represented by "%s" if necessary
5827 (the file name is appended automatically if no %s appears in the value
5828 of this option).
5829 For the Amiga and MS-DOS the default is ">". The output is directly
5830 saved in a file and not echoed to the screen.
5831 For Unix the default it "| tee". The stdout of the compiler is saved
5832 in a file and echoed to the screen. If the 'shell' option is "csh" or
5833 "tcsh" after initializations, the default becomes "|& tee". If the
5834 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
Bram Moolenaar00a927d2010-05-14 23:24:24 +02005835 "2>&1| tee". This means that stderr is also included. Before using
5836 the 'shell' option a path is removed, thus "/bin/sh" uses "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005837 The initialization of this option is done after reading the ".vimrc"
5838 and the other initializations, so that when the 'shell' option is set
5839 there, the 'shellpipe' option changes automatically, unless it was
5840 explicitly set before.
5841 When 'shellpipe' is set to an empty string, no redirection of the
5842 ":make" output will be done. This is useful if you use a 'makeprg'
5843 that writes to 'makeef' by itself. If you want no piping, but do
5844 want to include the 'makeef', set 'shellpipe' to a single space.
5845 Don't forget to precede the space with a backslash: ":set sp=\ ".
5846 In the future pipes may be used for filtering and this option will
5847 become obsolete (at least for Unix).
5848 This option cannot be set from a |modeline| or in the |sandbox|, for
5849 security reasons.
5850
5851 *'shellquote'* *'shq'*
5852'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5853 contains "sh" somewhere: "\"")
5854 global
5855 {not in Vi}
5856 Quoting character(s), put around the command passed to the shell, for
5857 the "!" and ":!" commands. The redirection is kept outside of the
5858 quoting. See 'shellxquote' to include the redirection. It's
5859 probably not useful to set both options.
5860 This is an empty string by default. Only known to be useful for
5861 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5862 or bash, where it should be "\"". The default is adjusted according
5863 the value of 'shell', to reduce the need to set this option by the
5864 user. See |dos-shell|.
5865 This option cannot be set from a |modeline| or in the |sandbox|, for
5866 security reasons.
5867
5868 *'shellredir'* *'srr'*
5869'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5870 global
5871 {not in Vi}
5872 String to be used to put the output of a filter command in a temporary
5873 file. See also |:!|. See |option-backslash| about including spaces
5874 and backslashes.
5875 The name of the temporary file can be represented by "%s" if necessary
5876 (the file name is appended automatically if no %s appears in the value
5877 of this option).
5878 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5879 or "zsh" during initializations, the default becomes ">&". If the
5880 'shell' option is "sh", "ksh" or "bash" the default becomes
5881 ">%s 2>&1". This means that stderr is also included.
5882 For Win32, the Unix checks are done and additionally "cmd" is checked
5883 for, which makes the default ">%s 2>&1". Also, the same names with
5884 ".exe" appended are checked for.
5885 The initialization of this option is done after reading the ".vimrc"
5886 and the other initializations, so that when the 'shell' option is set
5887 there, the 'shellredir' option changes automatically unless it was
5888 explicitly set before.
5889 In the future pipes may be used for filtering and this option will
5890 become obsolete (at least for Unix).
5891 This option cannot be set from a |modeline| or in the |sandbox|, for
5892 security reasons.
5893
5894 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5895'shellslash' 'ssl' boolean (default off)
5896 global
5897 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5898 When set, a forward slash is used when expanding file names. This is
5899 useful when a Unix-like shell is used instead of command.com or
5900 cmd.exe. Backward slashes can still be typed, but they are changed to
5901 forward slashes by Vim.
5902 Note that setting or resetting this option has no effect for some
5903 existing file names, thus this option needs to be set before opening
5904 any file for best results. This might change in the future.
5905 'shellslash' only works when a backslash can be used as a path
5906 separator. To test if this is so use: >
5907 if exists('+shellslash')
5908<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005909 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5910'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5911 global
5912 {not in Vi}
5913 When on, use temp files for shell commands. When off use a pipe.
5914 When using a pipe is not possible temp files are used anyway.
5915 Currently a pipe is only supported on Unix. You can check it with: >
5916 :if has("filterpipe")
5917< The advantage of using a pipe is that nobody can read the temp file
5918 and the 'shell' command does not need to support redirection.
5919 The advantage of using a temp file is that the file type and encoding
5920 can be detected.
5921 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5922 |FilterWritePost| autocommands event are not triggered when
5923 'shelltemp' is off.
5924
Bram Moolenaar071d4272004-06-13 20:20:40 +00005925 *'shelltype'* *'st'*
5926'shelltype' 'st' number (default 0)
5927 global
5928 {not in Vi} {only for the Amiga}
5929 On the Amiga this option influences the way how the commands work
5930 which use a shell.
5931 0 and 1: always use the shell
5932 2 and 3: use the shell only to filter lines
5933 4 and 5: use shell only for ':sh' command
5934 When not using the shell, the command is executed directly.
5935
5936 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5937 1 and 3: use "shell cmd" to start external commands
5938
5939 *'shellxquote'* *'sxq'*
5940'shellxquote' 'sxq' string (default: "";
5941 for Win32, when 'shell' contains "sh"
5942 somewhere: "\""
5943 for Unix, when using system(): "\"")
5944 global
5945 {not in Vi}
5946 Quoting character(s), put around the command passed to the shell, for
5947 the "!" and ":!" commands. Includes the redirection. See
5948 'shellquote' to exclude the redirection. It's probably not useful
5949 to set both options.
5950 This is an empty string by default. Known to be useful for
5951 third-party shells when using the Win32 version, such as the MKS Korn
5952 Shell or bash, where it should be "\"". The default is adjusted
5953 according the value of 'shell', to reduce the need to set this option
5954 by the user. See |dos-shell|.
5955 This option cannot be set from a |modeline| or in the |sandbox|, for
5956 security reasons.
5957
5958 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5959'shiftround' 'sr' boolean (default off)
5960 global
5961 {not in Vi}
5962 Round indent to multiple of 'shiftwidth'. Applies to > and <
5963 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5964 a multiple of 'shiftwidth' (this is Vi compatible).
5965 NOTE: This option is reset when 'compatible' is set.
5966
5967 *'shiftwidth'* *'sw'*
5968'shiftwidth' 'sw' number (default 8)
5969 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005970 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005971 |'cindent'|, |>>|, |<<|, etc.
5972
5973 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005974'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
5975 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005976 global
5977 {not in Vi}
5978 This option helps to avoid all the |hit-enter| prompts caused by file
5979 messages, for example with CTRL-G, and to avoid some other messages.
5980 It is a list of flags:
5981 flag meaning when present ~
5982 f use "(3 of 5)" instead of "(file 3 of 5)"
5983 i use "[noeol]" instead of "[Incomplete last line]"
5984 l use "999L, 888C" instead of "999 lines, 888 characters"
5985 m use "[+]" instead of "[Modified]"
5986 n use "[New]" instead of "[New File]"
5987 r use "[RO]" instead of "[readonly]"
5988 w use "[w]" instead of "written" for file write message
5989 and "[a]" instead of "appended" for ':w >> file' command
5990 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5991 "[unix format]" and "[mac]" instead of "[mac format]".
5992 a all of the above abbreviations
5993
5994 o overwrite message for writing a file with subsequent message
5995 for reading a file (useful for ":wn" or when 'autowrite' on)
5996 O message for reading a file overwrites any previous message.
5997 Also for quickfix message (e.g., ":cn").
5998 s don't give "search hit BOTTOM, continuing at TOP" or "search
5999 hit TOP, continuing at BOTTOM" messages
6000 t truncate file message at the start if it is too long to fit
6001 on the command-line, "<" will appear in the left most column.
6002 Ignored in Ex mode.
6003 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006004 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006005 Ignored in Ex mode.
6006 W don't give "written" or "[w]" when writing a file
6007 A don't give the "ATTENTION" message when an existing swap file
6008 is found.
6009 I don't give the intro message when starting Vim |:intro|.
6010
6011 This gives you the opportunity to avoid that a change between buffers
6012 requires you to hit <Enter>, but still gives as useful a message as
6013 possible for the space available. To get the whole message that you
6014 would have got with 'shm' empty, use ":file!"
6015 Useful values:
6016 shm= No abbreviation of message.
6017 shm=a Abbreviation, but no loss of information.
6018 shm=at Abbreviation, and truncate message when necessary.
6019
6020 NOTE: This option is set to the Vi default value when 'compatible' is
6021 set and to the Vim default value when 'compatible' is reset.
6022
6023 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6024'shortname' 'sn' boolean (default off)
6025 local to buffer
6026 {not in Vi, not in MS-DOS versions}
6027 Filenames are assumed to be 8 characters plus one extension of 3
6028 characters. Multiple dots in file names are not allowed. When this
6029 option is on, dots in file names are replaced with underscores when
6030 adding an extension (".~" or ".swp"). This option is not available
6031 for MS-DOS, because then it would always be on. This option is useful
6032 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6033 or crossdos. When running the Win32 GUI version under Win32s, this
6034 option is always on by default.
6035
6036 *'showbreak'* *'sbr'* *E595*
6037'showbreak' 'sbr' string (default "")
6038 global
6039 {not in Vi}
6040 {not available when compiled without the |+linebreak|
6041 feature}
6042 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006043 values are "> " or "+++ ": >
6044 :set showbreak=>\
6045< Note the backslash to escape the trailing space. It's easier like
6046 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006047 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006048< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006049 comma (in a future version the comma might be used to separate the
6050 part that is shown at the end and at the start of a line).
6051 The characters are highlighted according to the '@' flag in
6052 'highlight'.
6053 Note that tabs after the showbreak will be displayed differently.
6054 If you want the 'showbreak' to appear in between line numbers, add the
6055 "n" flag to 'cpoptions'.
6056
6057 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
6058'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
6059 off)
6060 global
6061 {not in Vi}
6062 {not available when compiled without the
6063 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006064 Show (partial) command in the last line of the screen. Set this
6065 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006066 In Visual mode the size of the selected area is shown:
6067 - When selecting characters within a line, the number of characters.
6068 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006069 - When selecting a block, the size in screen characters:
6070 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006071 NOTE: This option is set to the Vi default value when 'compatible' is
6072 set and to the Vim default value when 'compatible' is reset.
6073
6074 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6075'showfulltag' 'sft' boolean (default off)
6076 global
6077 {not in Vi}
6078 When completing a word in insert mode (see |ins-completion|) from the
6079 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006080 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006081 matched a C function, you can see a template for what arguments are
6082 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006083 Note that this doesn't work well together with having "longest" in
6084 'completeopt', because the completion from the search pattern may not
6085 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006086
6087 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6088'showmatch' 'sm' boolean (default off)
6089 global
6090 When a bracket is inserted, briefly jump to the matching one. The
6091 jump is only done if the match can be seen on the screen. The time to
6092 show the match can be set with 'matchtime'.
6093 A Beep is given if there is no match (no matter if the match can be
6094 seen or not). This option is reset when the 'paste' option is set.
6095 When the 'm' flag is not included in 'cpoptions', typing a character
6096 will immediately move the cursor back to where it belongs.
6097 See the "sm" field in 'guicursor' for setting the cursor shape and
6098 blinking when showing the match.
6099 The 'matchpairs' option can be used to specify the characters to show
6100 matches for. 'rightleft' and 'revins' are used to look for opposite
6101 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006102 Also see the matchparen plugin for highlighting the match when moving
6103 around |pi_paren.txt|.
6104 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006105
6106 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6107'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6108 global
6109 If in Insert, Replace or Visual mode put a message on the last line.
6110 Use the 'M' flag in 'highlight' to set the type of highlighting for
6111 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006112 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006113 doesn't mean XIM is really active, especially when 'imactivatekey' is
6114 not set.
6115 NOTE: This option is set to the Vi default value when 'compatible' is
6116 set and to the Vim default value when 'compatible' is reset.
6117
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006118 *'showtabline'* *'stal'*
6119'showtabline' 'stal' number (default 1)
6120 global
6121 {not in Vi}
6122 {not available when compiled without the +windows
6123 feature}
6124 The value of this option specifies when the line with tab page labels
6125 will be displayed:
6126 0: never
6127 1: only if there are at least two tab pages
6128 2: always
6129 This is both for the GUI and non-GUI implementation of the tab pages
6130 line.
6131 See |tab-page| for more information about tab pages.
6132
Bram Moolenaar071d4272004-06-13 20:20:40 +00006133 *'sidescroll'* *'ss'*
6134'sidescroll' 'ss' number (default 0)
6135 global
6136 {not in Vi}
6137 The minimal number of columns to scroll horizontally. Used only when
6138 the 'wrap' option is off and the cursor is moved off of the screen.
6139 When it is zero the cursor will be put in the middle of the screen.
6140 When using a slow terminal set it to a large number or 0. When using
6141 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6142 commands.
6143
6144 *'sidescrolloff'* *'siso'*
6145'sidescrolloff' 'siso' number (default 0)
6146 global
6147 {not in Vi}
6148 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006149 right of the cursor if 'nowrap' is set. Setting this option to a
6150 value greater than 0 while having |'sidescroll'| also at a non-zero
6151 value makes some context visible in the line you are scrolling in
6152 horizontally (except at beginning of the line). Setting this option
6153 to a large value (like 999) has the effect of keeping the cursor
6154 horizontally centered in the window, as long as one does not come too
6155 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006156 NOTE: This option is set to 0 when 'compatible' is set.
6157
6158 Example: Try this together with 'sidescroll' and 'listchars' as
6159 in the following example to never allow the cursor to move
6160 onto the "extends" character:
6161
6162 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6163 :set sidescrolloff=1
6164
6165
6166 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6167'smartcase' 'scs' boolean (default off)
6168 global
6169 {not in Vi}
6170 Override the 'ignorecase' option if the search pattern contains upper
6171 case characters. Only used when the search pattern is typed and
6172 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006173 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006174 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6175 recalling the search pattern from history and hitting <Enter>.
6176 NOTE: This option is reset when 'compatible' is set.
6177
6178 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6179'smartindent' 'si' boolean (default off)
6180 local to buffer
6181 {not in Vi}
6182 {not available when compiled without the
6183 |+smartindent| feature}
6184 Do smart autoindenting when starting a new line. Works for C-like
6185 programs, but can also be used for other languages. 'cindent' does
6186 something like this, works better in most cases, but is more strict,
6187 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
6188 'indentexpr' is a more advanced alternative.
6189 Normally 'autoindent' should also be on when using 'smartindent'.
6190 An indent is automatically inserted:
6191 - After a line ending in '{'.
6192 - After a line starting with a keyword from 'cinwords'.
6193 - Before a line starting with '}' (only with the "O" command).
6194 When typing '}' as the first character in a new line, that line is
6195 given the same indent as the matching '{'.
6196 When typing '#' as the first character in a new line, the indent for
6197 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006198 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006199 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6200 When using the ">>" command, lines starting with '#' are not shifted
6201 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006202 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006203 is set smart indenting is disabled.
6204
6205 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6206'smarttab' 'sta' boolean (default off)
6207 global
6208 {not in Vi}
6209 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006210 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6211 <BS> will delete a 'shiftwidth' worth of space at the start of the
6212 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006213 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006214 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6215 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006216 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006217 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006218 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006219 NOTE: This option is reset when 'compatible' is set.
6220
6221 *'softtabstop'* *'sts'*
6222'softtabstop' 'sts' number (default 0)
6223 local to buffer
6224 {not in Vi}
6225 Number of spaces that a <Tab> counts for while performing editing
6226 operations, like inserting a <Tab> or using <BS>. It "feels" like
6227 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6228 used. This is useful to keep the 'ts' setting at its standard value
6229 of 8, while being able to edit like it is set to 'sts'. However,
6230 commands like "x" still work on the actual characters.
6231 When 'sts' is zero, this feature is off.
6232 'softtabstop' is set to 0 when the 'paste' option is set.
6233 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6234 spaces is minimized by using <Tab>s.
6235 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6236 set.
6237 NOTE: This option is set to 0 when 'compatible' is set.
6238
Bram Moolenaar217ad922005-03-20 22:37:15 +00006239 *'spell'* *'nospell'*
6240'spell' boolean (default off)
6241 local to window
6242 {not in Vi}
6243 {not available when compiled without the |+syntax|
6244 feature}
6245 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006246 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006247
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006248 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006249'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006250 local to buffer
6251 {not in Vi}
6252 {not available when compiled without the |+syntax|
6253 feature}
6254 Pattern to locate the end of a sentence. The following word will be
6255 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006256 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006257 When this check is not wanted make this option empty.
6258 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006259 Be careful with special characters, see |option-backslash| about
6260 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006261 To set this option automatically depending on the language, see
6262 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006263
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006264 *'spellfile'* *'spf'*
6265'spellfile' 'spf' string (default empty)
6266 local to buffer
6267 {not in Vi}
6268 {not available when compiled without the |+syntax|
6269 feature}
6270 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006271 commands. It must end in ".{encoding}.add". You need to include the
6272 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006273 *E765*
6274 It may also be a comma separated list of names. A count before the
6275 |zg| and |zw| commands can be used to access each. This allows using
6276 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006277 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006278 you: Using the first directory in 'runtimepath' that is writable. If
6279 there is no "spell" directory yet it will be created. For the file
6280 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006281 ignoring the region.
6282 The resulting ".spl" file will be used for spell checking, it does not
6283 have to appear in 'spelllang'.
6284 Normally one file is used for all regions, but you can add the region
6285 name if you want to. However, it will then only be used when
6286 'spellfile' is set to it, for entries in 'spelllang' only files
6287 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006288 This option cannot be set from a |modeline| or in the |sandbox|, for
6289 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006290
Bram Moolenaar217ad922005-03-20 22:37:15 +00006291 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006292'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006293 local to buffer
6294 {not in Vi}
6295 {not available when compiled without the |+syntax|
6296 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006297 A comma separated list of word list names. When the 'spell' option is
6298 on spellchecking will be done for these languages. Example: >
6299 set spelllang=en_us,nl,medical
6300< This means US English, Dutch and medical words are recognized. Words
6301 that are not recognized will be highlighted.
6302 The word list name must not include a comma or dot. Using a dash is
6303 recommended to separate the two letter language name from a
6304 specification. Thus "en-rare" is used for rare English words.
6305 A region name must come last and have the form "_xx", where "xx" is
6306 the two-letter, lower case region name. You can use more than one
6307 region by listing them: "en_us,en_ca" supports both US and Canadian
6308 English, but not words specific for Australia, New Zealand or Great
6309 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006310 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006311 As a special case the name of a .spl file can be given as-is. The
6312 first "_xx" in the name is removed and used as the region name
6313 (_xx is an underscore, two letters and followed by a non-letter).
6314 This is mainly for testing purposes. You must make sure the correct
6315 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006316 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006317 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6318 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006319 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006320
Bram Moolenaar98692072006-02-04 00:57:42 +00006321 If the |spellfile.vim| plugin is active and you use a language name
6322 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6323 will ask you if you want to download the file.
6324
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006325 After this option has been set successfully, Vim will source the files
6326 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006327 up to the first comma, dot or underscore.
6328 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006329
6330
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006331 *'spellsuggest'* *'sps'*
6332'spellsuggest' 'sps' string (default "best")
6333 global
6334 {not in Vi}
6335 {not available when compiled without the |+syntax|
6336 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006337 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006338 the |spellsuggest()| function. This is a comma-separated list of
6339 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006340
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006341 best Internal method that works best for English. Finds
6342 changes like "fast" and uses a bit of sound-a-like
6343 scoring to improve the ordering.
6344
6345 double Internal method that uses two methods and mixes the
6346 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006347 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006348 word. That only works when the language specifies
6349 sound folding. Can be slow and doesn't always give
6350 better results.
6351
6352 fast Internal method that only checks for simple changes:
6353 character inserts/deletes/swaps. Works well for
6354 simple typing mistakes.
6355
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006356 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006357 Not used for |spellsuggest()|. The number of
6358 suggestions is never more than the value of 'lines'
6359 minus two.
6360
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006361 file:{filename} Read file {filename}, which must have two columns,
6362 separated by a slash. The first column contains the
6363 bad word, the second column the suggested good word.
6364 Example:
6365 theribal/terrible ~
6366 Use this for common mistakes that do not appear at the
6367 top of the suggestion list with the internal methods.
6368 Lines without a slash are ignored, use this for
6369 comments.
6370 The file is used for all languages.
6371
6372 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6373 trouble with spaces. |v:val| holds the badly spelled
6374 word. The expression must evaluate to a List of
6375 Lists, each with a suggestion and a score.
6376 Example:
6377 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006378 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006379 internal methods use. A lower score is better.
6380 This may invoke |spellsuggest()| if you temporarily
6381 set 'spellsuggest' to exclude the "expr:" part.
6382 Errors are silently ignored, unless you set the
6383 'verbose' option to a non-zero value.
6384
6385 Only one of "best", "double" or "fast" may be used. The others may
6386 appear several times in any order. Example: >
6387 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6388<
6389 This option cannot be set from a |modeline| or in the |sandbox|, for
6390 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006391
6392
Bram Moolenaar071d4272004-06-13 20:20:40 +00006393 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6394'splitbelow' 'sb' boolean (default off)
6395 global
6396 {not in Vi}
6397 {not available when compiled without the +windows
6398 feature}
6399 When on, splitting a window will put the new window below the current
6400 one. |:split|
6401
6402 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6403'splitright' 'spr' boolean (default off)
6404 global
6405 {not in Vi}
6406 {not available when compiled without the +vertsplit
6407 feature}
6408 When on, splitting a window will put the new window right of the
6409 current one. |:vsplit|
6410
6411 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6412'startofline' 'sol' boolean (default on)
6413 global
6414 {not in Vi}
6415 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006416 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006417 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006418 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006419 with a linewise operator, with "%" with a count and to buffer changing
6420 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6421 only has a line number, e.g., ":25" or ":+".
6422 In case of buffer changing commands the cursor is placed at the column
6423 where it was the last time the buffer was edited.
6424 NOTE: This option is set when 'compatible' is set.
6425
6426 *'statusline'* *'stl'* *E540* *E541* *E542*
6427'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006428 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006429 {not in Vi}
6430 {not available when compiled without the |+statusline|
6431 feature}
6432 When nonempty, this option determines the content of the status line.
6433 Also see |status-line|.
6434
6435 The option consists of printf style '%' items interspersed with
6436 normal text. Each status line item is of the form:
6437 %-0{minwid}.{maxwid}{item}
6438 All fields except the {item} is optional. A single percent sign can
6439 be given as "%%". Up to 80 items can be specified.
6440
Bram Moolenaar238a5642006-02-21 22:12:05 +00006441 When the option starts with "%!" then it is used as an expression,
6442 evaluated and the result is used as the option value. Example: >
6443 :set statusline=%!MyStatusLine()
6444< The result can contain %{} items that will be evaluated too.
6445
6446 When there is error while evaluating the option then it will be made
6447 empty to avoid further errors. Otherwise screen updating would loop.
6448
Bram Moolenaar071d4272004-06-13 20:20:40 +00006449 Note that the only effect of 'ruler' when this option is set (and
6450 'laststatus' is 2) is controlling the output of |CTRL-G|.
6451
6452 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006453 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006454 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006455 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006456 minwid Minimum width of the item, padding as set by '-' & '0'.
6457 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006458 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006459 on the left for text items. Numeric items will be
6460 shifted down to maxwid-2 digits followed by '>'number
6461 where number is the amount of missing digits, much like
6462 an exponential notation.
6463 item A one letter code as described below.
6464
6465 Following is a description of the possible statusline items. The
6466 second character in "item" is the type:
6467 N for number
6468 S for string
6469 F for flags as described below
6470 - not applicable
6471
6472 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00006473 f S Path to the file in the buffer, as typed or relative to current
6474 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006475 F S Full path to the file in the buffer.
6476 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006477 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006478 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006479 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006480 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006481 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006482 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006483 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006484 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006485 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006486 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6487 {not available when compiled without |+autocmd| feature}
6488 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6489 being used: "<keymap>"
6490 n N Buffer number.
6491 b N Value of byte under cursor.
6492 B N As above, in hexadecimal.
6493 o N Byte number in file of byte under cursor, first byte is 1.
6494 Mnemonic: Offset from start of file (with one added)
6495 {not available when compiled without |+byte_offset| feature}
6496 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006497 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006498 l N Line number.
6499 L N Number of lines in buffer.
6500 c N Column number.
6501 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006502 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006503 p N Percentage through file in lines as in |CTRL-G|.
6504 P S Percentage through file of displayed window. This is like the
6505 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006506 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006507 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006508 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006509 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006510 ( - Start of item group. Can be used for setting the width and
6511 alignment of a section. Must be followed by %) somewhere.
6512 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006513 T N For 'tabline': start of tab page N label. Use %T after the last
6514 label. This information is used for mouse clicks.
6515 X N For 'tabline': start of close tab N label. Use %X after the
6516 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6517 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006518 < - Where to truncate line if too long. Default is at the start.
6519 No width fields allowed.
6520 = - Separation point between left and right aligned items.
6521 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006522 # - Set highlight group. The name must follow and then a # again.
6523 Thus use %#HLname# for highlight group HLname. The same
6524 highlighting is used, also for the statusline of non-current
6525 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006526 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006527 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006528 The difference between User{N} and StatusLine will be applied
6529 to StatusLineNC for the statusline of non-current windows.
6530 The number N must be between 1 and 9. See |hl-User1..9|
6531
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006532 When displaying a flag, Vim removes the leading comma, if any, when
6533 that flag comes right after plaintext. This will make a nice display
6534 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006535
Bram Moolenaar582fd852005-03-28 20:58:01 +00006536 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006537 not set) and a minwid is not set for the group, the whole group will
6538 become empty. This will make a group like the following disappear
6539 completely from the statusline when none of the flags are set. >
6540 :set statusline=...%(\ [%M%R%H]%)...
6541<
6542 Beware that an expression is evaluated each and every time the status
6543 line is displayed. The current buffer and current window will be set
6544 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006545 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006546 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006547 real current buffer.
6548
6549 The 'statusline' option may be evaluated in the |sandbox|, see
6550 |sandbox-option|.
6551
6552 It is not allowed to change text or jump to another window while
6553 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006554
6555 If the statusline is not updated when you want it (e.g., after setting
6556 a variable that's used in an expression), you can force an update by
6557 setting an option without changing its value. Example: >
6558 :let &ro = &ro
6559
6560< A result of all digits is regarded a number for display purposes.
6561 Otherwise the result is taken as flag text and applied to the rules
6562 described above.
6563
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006564 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006565 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6566 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6567
6568 Examples:
6569 Emulate standard status line with 'ruler' set >
6570 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6571< Similar, but add ASCII value of char under the cursor (like "ga") >
6572 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6573< Display byte count and byte value, modified flag in red. >
6574 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6575 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6576< Display a ,GZ flag if a compressed file is loaded >
6577 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6578< In the |:autocmd|'s: >
6579 :let b:gzflag = 1
6580< And: >
6581 :unlet b:gzflag
6582< And define this function: >
6583 :function VarExists(var, val)
6584 : if exists(a:var) | return a:val | else | return '' | endif
6585 :endfunction
6586<
6587 *'suffixes'* *'su'*
6588'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6589 global
6590 {not in Vi}
6591 Files with these suffixes get a lower priority when multiple files
6592 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006593 suffixes. Spaces after the comma are ignored. A dot is also seen as
6594 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006595 separator, precede it with a backslash (see |option-backslash| about
6596 including spaces and backslashes).
6597 See 'wildignore' for completely ignoring files.
6598 The use of |:set+=| and |:set-=| is preferred when adding or removing
6599 suffixes from the list. This avoids problems when a future version
6600 uses another default.
6601
6602 *'suffixesadd'* *'sua'*
6603'suffixesadd' 'sua' string (default "")
6604 local to buffer
6605 {not in Vi}
6606 {not available when compiled without the
6607 |+file_in_path| feature}
6608 Comma separated list of suffixes, which are used when searching for a
6609 file for the "gf", "[I", etc. commands. Example: >
6610 :set suffixesadd=.java
6611<
6612 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6613'swapfile' 'swf' boolean (default on)
6614 local to buffer
6615 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006616 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006617 swapfile is not wanted for a specific buffer. For example, with
6618 confidential information that even root must not be able to access.
6619 Careful: All text will be in memory:
6620 - Don't use this for big files.
6621 - Recovery will be impossible!
6622 A swapfile will only be present when |'updatecount'| is non-zero and
6623 'swapfile' is set.
6624 When 'swapfile' is reset, the swap file for the current buffer is
6625 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6626 non-zero, a swap file is immediately created.
6627 Also see |swap-file| and |'swapsync'|.
6628
6629 This option is used together with 'bufhidden' and 'buftype' to
6630 specify special kinds of buffers. See |special-buffers|.
6631
6632 *'swapsync'* *'sws'*
6633'swapsync' 'sws' string (default "fsync")
6634 global
6635 {not in Vi}
6636 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006637 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006638 When this option is empty parts of the swap file may be in memory and
6639 not written to disk. When the system crashes you may lose more work.
6640 On Unix the system does a sync now and then without Vim asking for it,
6641 so the disadvantage of setting this option off is small. On some
6642 systems the swap file will not be written at all. For a unix system
6643 setting it to "sync" will use the sync() call instead of the default
6644 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006645 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006646
6647 *'switchbuf'* *'swb'*
6648'switchbuf' 'swb' string (default "")
6649 global
6650 {not in Vi}
6651 This option controls the behavior when switching between buffers.
6652 Possible values (comma separated list):
6653 useopen If included, jump to the first open window that
6654 contains the specified buffer (if there is one).
6655 Otherwise: Do not examine other windows.
6656 This setting is checked with |quickfix| commands, when
6657 jumping to errors (":cc", ":cn", "cp", etc.). It is
6658 also used in all buffer related split commands, for
6659 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00006660 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006661 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006662 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006663 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006664 Supported in |quickfix| commands that display errors.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006665 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02006666 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006667
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006668 *'synmaxcol'* *'smc'*
6669'synmaxcol' 'smc' number (default 3000)
6670 local to buffer
6671 {not in Vi}
6672 {not available when compiled without the |+syntax|
6673 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006674 Maximum column in which to search for syntax items. In long lines the
6675 text after this column is not highlighted and following lines may not
6676 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006677 This helps to avoid very slow redrawing for an XML file that is one
6678 long line.
6679 Set to zero to remove the limit.
6680
Bram Moolenaar071d4272004-06-13 20:20:40 +00006681 *'syntax'* *'syn'*
6682'syntax' 'syn' string (default empty)
6683 local to buffer
6684 {not in Vi}
6685 {not available when compiled without the |+syntax|
6686 feature}
6687 When this option is set, the syntax with this name is loaded, unless
6688 syntax highlighting has been switched off with ":syntax off".
6689 Otherwise this option does not always reflect the current syntax (the
6690 b:current_syntax variable does).
6691 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006692 not automatically recognized. Example, in an IDL file:
6693 /* vim: set syntax=idl : */ ~
6694 When a dot appears in the value then this separates two filetype
6695 names. Example:
6696 /* vim: set syntax=c.doxygen : */ ~
6697 This will use the "c" syntax first, then the "doxygen" syntax.
6698 Note that the second one must be prepared to be loaded as an addition,
6699 otherwise it will be skipped. More than one dot may appear.
6700 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006701 :set syntax=OFF
6702< To switch syntax highlighting on according to the current value of the
6703 'filetype' option: >
6704 :set syntax=ON
6705< What actually happens when setting the 'syntax' option is that the
6706 Syntax autocommand event is triggered with the value as argument.
6707 This option is not copied to another buffer, independent of the 's' or
6708 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006709 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006710
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006711 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006712'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006713 global
6714 {not in Vi}
6715 {not available when compiled without the +windows
6716 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006717 When nonempty, this option determines the content of the tab pages
6718 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006719 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006720
6721 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006722 option and only when there is no GUI tab line. When 'e' is in
6723 'guioptions' and the GUI supports a tab line 'guitablabel' is used
6724 instead.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006725
6726 The value is evaluated like with 'statusline'. You can use
6727 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006728 the text to be displayed. Use "%1T" for the first label, "%2T" for
6729 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006730
6731 Keep in mind that only one of the tab pages is the current one, others
6732 are invisible and you can't jump to their windows.
6733
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006734
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006735 *'tabpagemax'* *'tpm'*
6736'tabpagemax' 'tpm' number (default 10)
6737 global
6738 {not in Vi}
6739 {not available when compiled without the +windows
6740 feature}
6741 Maximum number of tab pages to be opened by the |-p| command line
6742 argument or the ":tab all" command. |tabpage|
6743
6744
6745 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006746'tabstop' 'ts' number (default 8)
6747 local to buffer
6748 Number of spaces that a <Tab> in the file counts for. Also see
6749 |:retab| command, and 'softtabstop' option.
6750
6751 Note: Setting 'tabstop' to any other value than 8 can make your file
6752 appear wrong in many places (e.g., when printing it).
6753
6754 There are four main ways to use tabs in Vim:
6755 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6756 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006757 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006758 behave like a tab appears every 4 (or 3) characters.
6759 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6760 'expandtab'. This way you will always insert spaces. The
6761 formatting will never be messed up when 'tabstop' is changed.
6762 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006763 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006764 works when using Vim to edit the file.
6765 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6766 'noexpandtab'. This should then work (for initial indents only)
6767 for any tabstop setting that people use. It might be nice to have
6768 tabs after the first non-blank inserted as spaces if you do this
6769 though. Otherwise aligned comments will be wrong when 'tabstop' is
6770 changed.
6771
6772 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6773'tagbsearch' 'tbs' boolean (default on)
6774 global
6775 {not in Vi}
6776 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006777 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006778 searching makes searching for a tag a LOT faster, but a linear search
6779 will find more tags if the tags file wasn't properly sorted.
6780 Vim normally assumes that your tags files are sorted, or indicate that
6781 they are not sorted. Only when this is not the case does the
6782 'tagbsearch' option need to be switched off.
6783
6784 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006785 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006786 certain files, or retry all files with a linear search. When
6787 'tagbsearch' is off, only a linear search is done.
6788
6789 Linear searching is done anyway, for one file, when Vim finds a line
6790 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00006791 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00006792< [The whitespace before and after the '0' must be a single <Tab>]
6793
6794 When a binary search was done and no match was found in any of the
6795 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6796 instead of a normal tag name, a retry is done with a linear search.
6797 Tags in unsorted tags files, and matches with different case will only
6798 be found in the retry.
6799
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006800 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006801 linear search can be avoided for the 'ignorecase' case. Use a value
6802 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6803 case-fold sorted with the -f switch to "sort" in most unices, as in
6804 the command: "sort -f -o tags tags". For "Exuberant ctags" version
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006805 5.x or higher (at least 5.5) the --sort=foldcase switch can be used
6806 for this as well. Note that case must be folded to uppercase for this
6807 to work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006808
6809 When 'tagbsearch' is off, tags searching is slower when a full match
6810 exists, but faster when no full match exists. Tags in unsorted tags
6811 files may only be found with 'tagbsearch' off.
6812 When the tags file is not sorted, or sorted in a wrong way (not on
6813 ASCII byte value), 'tagbsearch' should be off, or the line given above
6814 must be included in the tags file.
6815 This option doesn't affect commands that find all matching tags (e.g.,
6816 command-line completion and ":help").
6817 {Vi: always uses binary search in some versions}
6818
6819 *'taglength'* *'tl'*
6820'taglength' 'tl' number (default 0)
6821 global
6822 If non-zero, tags are significant up to this number of characters.
6823
6824 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6825'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6826 global
6827 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00006828 If on and using a tags file in another directory, file names in that
6829 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006830 NOTE: This option is set to the Vi default value when 'compatible' is
6831 set and to the Vim default value when 'compatible' is reset.
6832
6833 *'tags'* *'tag'* *E433*
6834'tags' 'tag' string (default "./tags,tags", when compiled with
6835 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6836 global or local to buffer |global-local|
6837 Filenames for the tag command, separated by spaces or commas. To
6838 include a space or comma in a file name, precede it with a backslash
6839 (see |option-backslash| about including spaces and backslashes).
6840 When a file name starts with "./", the '.' is replaced with the path
6841 of the current file. But only when the 'd' flag is not included in
6842 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6843 |tags-option|.
6844 "*", "**" and other wildcards can be used to search for tags files in
6845 a directory tree. See |file-searching|. {not available when compiled
6846 without the |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006847 The |tagfiles()| function can be used to get a list of the file names
6848 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006849 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6850 files are also supported. They are automatically recognized. The
6851 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6852 differences are ignored (MS-Windows). |emacs-tags|
6853 The use of |:set+=| and |:set-=| is preferred when adding or removing
6854 file names from the list. This avoids problems when a future version
6855 uses another default.
6856 {Vi: default is "tags /usr/lib/tags"}
6857
6858 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6859'tagstack' 'tgst' boolean (default on)
6860 global
6861 {not in all versions of Vi}
6862 When on, the |tagstack| is used normally. When off, a ":tag" or
6863 ":tselect" command with an argument will not push the tag onto the
6864 tagstack. A following ":tag" without an argument, a ":pop" command or
6865 any other command that uses the tagstack will use the unmodified
6866 tagstack, but does change the pointer to the active entry.
6867 Resetting this option is useful when using a ":tag" command in a
6868 mapping which should not change the tagstack.
6869
6870 *'term'* *E529* *E530* *E531*
6871'term' string (default is $TERM, if that fails:
6872 in the GUI: "builtin_gui"
6873 on Amiga: "amiga"
6874 on BeOS: "beos-ansi"
6875 on Mac: "mac-ansi"
6876 on MiNT: "vt52"
6877 on MS-DOS: "pcterm"
6878 on OS/2: "os2ansi"
6879 on Unix: "ansi"
6880 on VMS: "ansi"
6881 on Win 32: "win32")
6882 global
6883 Name of the terminal. Used for choosing the terminal control
6884 characters. Environment variables are expanded |:set_env|.
6885 For example: >
6886 :set term=$TERM
6887< See |termcap|.
6888
6889 *'termbidi'* *'tbidi'*
6890 *'notermbidi'* *'notbidi'*
6891'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6892 global
6893 {not in Vi}
6894 {only available when compiled with the |+arabic|
6895 feature}
6896 The terminal is in charge of Bi-directionality of text (as specified
6897 by Unicode). The terminal is also expected to do the required shaping
6898 that some languages (such as Arabic) require.
6899 Setting this option implies that 'rightleft' will not be set when
6900 'arabic' is set and the value of 'arabicshape' will be ignored.
6901 Note that setting 'termbidi' has the immediate effect that
6902 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6903 This option is reset when the GUI is started.
6904 For further details see |arabic.txt|.
6905
6906 *'termencoding'* *'tenc'*
6907'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6908 Macintosh GUI: "macroman")
6909 global
6910 {only available when compiled with the |+multi_byte|
6911 feature}
6912 {not in Vi}
6913 Encoding used for the terminal. This specifies what character
6914 encoding the keyboard produces and the display will understand. For
6915 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00006916 display). Except for the Mac when 'macatsui' is off, then
6917 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006918 In the Win32 console version the default value is the console codepage
6919 when it differs from the ANSI codepage.
6920 *E617*
6921 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6922 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6923 Any attempts to set a different value will be rejected, and an error
6924 message is shown.
6925 For the Win32 GUI 'termencoding' is not used for typed characters,
6926 because the Win32 system always passes Unicode characters.
6927 When empty, the same encoding is used as for the 'encoding' option.
6928 This is the normal value.
6929 Not all combinations for 'termencoding' and 'encoding' are valid. See
6930 |encoding-table|.
6931 The value for this option must be supported by internal conversions or
6932 iconv(). When this is not possible no conversion will be done and you
6933 will probably experience problems with non-ASCII characters.
6934 Example: You are working with the locale set to euc-jp (Japanese) and
6935 want to edit a UTF-8 file: >
6936 :let &termencoding = &encoding
6937 :set encoding=utf-8
6938< You need to do this when your system has no locale support for UTF-8.
6939
6940 *'terse'* *'noterse'*
6941'terse' boolean (default off)
6942 global
6943 When set: Add 's' flag to 'shortmess' option (this makes the message
6944 for a search that hits the start or end of the file not being
6945 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6946 shortens a lot of messages}
6947
6948 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6949'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6950 global
6951 {not in Vi}
6952 This option is obsolete. Use 'fileformats'.
6953 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6954 set to the default value for the current system. When 'textauto' is
6955 reset, 'fileformats' is made empty.
6956 NOTE: This option is set to the Vi default value when 'compatible' is
6957 set and to the Vim default value when 'compatible' is reset.
6958
6959 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6960'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
6961 others: default off)
6962 local to buffer
6963 {not in Vi}
6964 This option is obsolete. Use 'fileformat'.
6965 For backwards compatibility, when 'textmode' is set, 'fileformat' is
6966 set to "dos". When 'textmode' is reset, 'fileformat' is set to
6967 "unix".
6968
6969 *'textwidth'* *'tw'*
6970'textwidth' 'tw' number (default 0)
6971 local to buffer
6972 {not in Vi}
6973 Maximum width of text that is being inserted. A longer line will be
6974 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006975 this. 'textwidth' is set to 0 when the 'paste' option is set. When
6976 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00006977 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00006978 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006979 NOTE: This option is set to 0 when 'compatible' is set.
6980
6981 *'thesaurus'* *'tsr'*
6982'thesaurus' 'tsr' string (default "")
6983 global or local to buffer |global-local|
6984 {not in Vi}
6985 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006986 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00006987 the file should contain words with similar meaning, separated by
6988 non-keyword characters (white space is preferred). Maximum line
6989 length is 510 bytes.
6990 To obtain a file to be used here, check out the wordlist FAQ at
6991 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006992 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00006993 after a comma are ignored, otherwise spaces are included in the file
6994 name. See |option-backslash| about using backslashes.
6995 The use of |:set+=| and |:set-=| is preferred when adding or removing
6996 directories from the list. This avoids problems when a future version
6997 uses another default.
6998 Backticks cannot be used in this option for security reasons.
6999
7000 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7001'tildeop' 'top' boolean (default off)
7002 global
7003 {not in Vi}
7004 When on: The tilde command "~" behaves like an operator.
7005 NOTE: This option is reset when 'compatible' is set.
7006
7007 *'timeout'* *'to'* *'notimeout'* *'noto'*
7008'timeout' 'to' boolean (default on)
7009 global
7010 *'ttimeout'* *'nottimeout'*
7011'ttimeout' boolean (default off)
7012 global
7013 {not in Vi}
7014 These two options together determine the behavior when part of a
7015 mapped key sequence or keyboard code has been received:
7016
7017 'timeout' 'ttimeout' action ~
7018 off off do not time out
7019 on on or off time out on :mappings and key codes
7020 off on time out on key codes
7021
7022 If both options are off, Vim will wait until either the complete
7023 mapping or key sequence has been received, or it is clear that there
7024 is no mapping or key sequence for the received characters. For
7025 example: if you have mapped "vl" and Vim has received 'v', the next
7026 character is needed to see if the 'v' is followed by an 'l'.
7027 When one of the options is on, Vim will wait for about 1 second for
7028 the next character to arrive. After that the already received
7029 characters are interpreted as single characters. The waiting time can
7030 be changed with the 'timeoutlen' option.
7031 On slow terminals or very busy systems timing out may cause
7032 malfunctioning cursor keys. If both options are off, Vim waits
7033 forever after an entered <Esc> if there are key codes that start
7034 with <Esc>. You will have to type <Esc> twice. If you do not have
7035 problems with key codes, but would like to have :mapped key
7036 sequences not timing out in 1 second, set the 'ttimeout' option and
7037 reset the 'timeout' option.
7038
7039 NOTE: 'ttimeout' is reset when 'compatible' is set.
7040
7041 *'timeoutlen'* *'tm'*
7042'timeoutlen' 'tm' number (default 1000)
7043 global
7044 {not in all versions of Vi}
7045 *'ttimeoutlen'* *'ttm'*
7046'ttimeoutlen' 'ttm' number (default -1)
7047 global
7048 {not in Vi}
7049 The time in milliseconds that is waited for a key code or mapped key
7050 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7051 when part of a command has been typed.
7052 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7053 different timeout value for key codes is desired set 'ttimeoutlen' to
7054 a non-negative number.
7055
7056 ttimeoutlen mapping delay key code delay ~
7057 < 0 'timeoutlen' 'timeoutlen'
7058 >= 0 'timeoutlen' 'ttimeoutlen'
7059
7060 The timeout only happens when the 'timeout' and 'ttimeout' options
7061 tell so. A useful setting would be >
7062 :set timeout timeoutlen=3000 ttimeoutlen=100
7063< (time out on mapping after three seconds, time out on key codes after
7064 a tenth of a second).
7065
7066 *'title'* *'notitle'*
7067'title' boolean (default off, on when title can be restored)
7068 global
7069 {not in Vi}
7070 {not available when compiled without the |+title|
7071 feature}
7072 When on, the title of the window will be set to the value of
7073 'titlestring' (if it is not empty), or to:
7074 filename [+=-] (path) - VIM
7075 Where:
7076 filename the name of the file being edited
7077 - indicates the file cannot be modified, 'ma' off
7078 + indicates the file was modified
7079 = indicates the file is read-only
7080 =+ indicates the file is read-only and modified
7081 (path) is the path of the file being edited
7082 - VIM the server name |v:servername| or "VIM"
7083 Only works if the terminal supports setting window titles
7084 (currently Amiga console, Win32 console, all GUI versions and
7085 terminals with a non- empty 't_ts' option - these are Unix xterm and
7086 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7087 *X11*
7088 When Vim was compiled with HAVE_X11 defined, the original title will
7089 be restored if possible. The output of ":version" will include "+X11"
7090 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7091 works for the icon name |'icon'|.
7092 But: When Vim was started with the |-X| argument, restoring the title
7093 will not work (except in the GUI).
7094 If the title cannot be restored, it is set to the value of 'titleold'.
7095 You might want to restore the title outside of Vim then.
7096 When using an xterm from a remote machine you can use this command:
7097 rsh machine_name xterm -display $DISPLAY &
7098 then the WINDOWID environment variable should be inherited and the
7099 title of the window should change back to what it should be after
7100 exiting Vim.
7101
7102 *'titlelen'*
7103'titlelen' number (default 85)
7104 global
7105 {not in Vi}
7106 {not available when compiled without the |+title|
7107 feature}
7108 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007109 title. When the title is longer, only the end of the path name is
7110 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007111 Using a percentage makes this adapt to the width of the window. But
7112 it won't work perfectly, because the actual number of characters
7113 available also depends on the font used and other things in the title
7114 bar. When 'titlelen' is zero the full path is used. Otherwise,
7115 values from 1 to 30000 percent can be used.
7116 'titlelen' is also used for the 'titlestring' option.
7117
7118 *'titleold'*
7119'titleold' string (default "Thanks for flying Vim")
7120 global
7121 {not in Vi}
7122 {only available when compiled with the |+title|
7123 feature}
7124 This option will be used for the window title when exiting Vim if the
7125 original title cannot be restored. Only happens if 'title' is on or
7126 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007127 This option cannot be set from a |modeline| or in the |sandbox|, for
7128 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007129 *'titlestring'*
7130'titlestring' string (default "")
7131 global
7132 {not in Vi}
7133 {not available when compiled without the |+title|
7134 feature}
7135 When this option is not empty, it will be used for the title of the
7136 window. This happens only when the 'title' option is on.
7137 Only works if the terminal supports setting window titles (currently
7138 Amiga console, Win32 console, all GUI versions and terminals with a
7139 non-empty 't_ts' option).
7140 When Vim was compiled with HAVE_X11 defined, the original title will
7141 be restored if possible |X11|.
7142 When this option contains printf-style '%' items, they will be
7143 expanded according to the rules used for 'statusline'.
7144 Example: >
7145 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7146 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7147< The value of 'titlelen' is used to align items in the middle or right
7148 of the available space.
7149 Some people prefer to have the file name first: >
7150 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7151< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007152 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007153 separating space only when needed.
7154 NOTE: Use of special characters in 'titlestring' may cause the display
7155 to be garbled (e.g., when it contains a CR or NL character).
7156 {not available when compiled without the |+statusline| feature}
7157
7158 *'toolbar'* *'tb'*
7159'toolbar' 'tb' string (default "icons,tooltips")
7160 global
7161 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7162 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007163 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007164 possible values are:
7165 icons Toolbar buttons are shown with icons.
7166 text Toolbar buttons shown with text.
7167 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007168 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007169 tooltips Tooltips are active for toolbar buttons.
7170 Tooltips refer to the popup help text which appears after the mouse
7171 cursor is placed over a toolbar button for a brief moment.
7172
7173 If you want the toolbar to be shown with icons as well as text, do the
7174 following: >
7175 :set tb=icons,text
7176< Motif and Athena cannot display icons and text at the same time. They
7177 will show icons if both are requested.
7178
7179 If none of the strings specified in 'toolbar' are valid or if
7180 'toolbar' is empty, this option is ignored. If you want to disable
7181 the toolbar, you need to set the 'guioptions' option. For example: >
7182 :set guioptions-=T
7183< Also see |gui-toolbar|.
7184
7185 *'toolbariconsize'* *'tbis'*
7186'toolbariconsize' 'tbis' string (default "small")
7187 global
7188 {not in Vi}
7189 {only in the GTK+ 2 GUI}
7190 Controls the size of toolbar icons. The possible values are:
7191 tiny Use tiny toolbar icons.
7192 small Use small toolbar icons (default).
7193 medium Use medium-sized toolbar icons.
7194 large Use large toolbar icons.
7195 The exact dimensions in pixels of the various icon sizes depend on
7196 the current theme. Common dimensions are large=32x32, medium=24x24,
7197 small=20x20 and tiny=16x16.
7198
7199 If 'toolbariconsize' is empty, the global default size as determined
7200 by user preferences or the current theme is used.
7201
7202 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7203'ttybuiltin' 'tbi' boolean (default on)
7204 global
7205 {not in Vi}
7206 When on, the builtin termcaps are searched before the external ones.
7207 When off the builtin termcaps are searched after the external ones.
7208 When this option is changed, you should set the 'term' option next for
7209 the change to take effect, for example: >
7210 :set notbi term=$TERM
7211< See also |termcap|.
7212 Rationale: The default for this option is "on", because the builtin
7213 termcap entries are generally better (many systems contain faulty
7214 xterm entries...).
7215
7216 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7217'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7218 sun-cmd, screen, rxvt, dtterm or
7219 iris-ansi; also on when running Vim in
7220 a DOS console)
7221 global
7222 {not in Vi}
7223 Indicates a fast terminal connection. More characters will be sent to
7224 the screen for redrawing, instead of using insert/delete line
7225 commands. Improves smoothness of redrawing when there are multiple
7226 windows and the terminal does not support a scrolling region.
7227 Also enables the extra writing of characters at the end of each screen
7228 line for lines that wrap. This helps when using copy/paste with the
7229 mouse in an xterm and other terminals.
7230
7231 *'ttymouse'* *'ttym'*
7232'ttymouse' 'ttym' string (default depends on 'term')
7233 global
7234 {not in Vi}
7235 {only in Unix and VMS, doesn't work in the GUI; not
7236 available when compiled without |+mouse|}
7237 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007238 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007239 *xterm-mouse*
7240 xterm xterm-like mouse handling. The mouse generates
7241 "<Esc>[Mscr", where "scr" is three bytes:
7242 "s" = button state
7243 "c" = column plus 33
7244 "r" = row plus 33
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007245 This only works up to 223 columns! See "dec" for a
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007246 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007247 xterm2 Works like "xterm", but with the xterm reporting the
7248 mouse position while the mouse is dragged. This works
7249 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007250 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007251 work. See below for how Vim detects this
7252 automatically.
7253 *netterm-mouse*
7254 netterm NetTerm mouse handling. The mouse generates
7255 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7256 for the row and column.
7257 *dec-mouse*
7258 dec DEC terminal mouse handling. The mouse generates a
7259 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007260 This is also available for an Xterm, if it was
7261 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007262 *jsbterm-mouse*
7263 jsbterm JSB term mouse handling.
7264 *pterm-mouse*
7265 pterm QNX pterm mouse handling.
7266
7267 The mouse handling must be enabled at compile time |+mouse_xterm|
7268 |+mouse_dec| |+mouse_netterm|.
7269 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7270 recognized, if enabled at compile time. DEC terminal mouse codes
7271 are recognized if enabled at compile time, and 'ttymouse' is not
7272 "xterm" (because the xterm and dec mouse codes conflict).
7273 This option is automatically set to "xterm", when the 'term' option is
7274 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
7275 or "xterm2" already. The main use of this option is to set it to
7276 "xterm", when the terminal name doesn't start with "xterm", but it can
7277 handle xterm mouse codes.
7278 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaar446cb832008-06-24 21:56:24 +00007279 95 or higher. This only works when compiled with the |+termresponse|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007280 feature and if |t_RV| is set to the escape sequence to request the
7281 xterm version number. Otherwise "xterm2" must be set explicitly.
7282 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
7283 t_RV to an empty string: >
7284 :set t_RV=
7285<
7286 *'ttyscroll'* *'tsl'*
7287'ttyscroll' 'tsl' number (default 999)
7288 global
7289 Maximum number of lines to scroll the screen. If there are more lines
7290 to scroll the window is redrawn. For terminals where scrolling is
7291 very slow and redrawing is not slow this can be set to a small number,
7292 e.g., 3, to speed up displaying.
7293
7294 *'ttytype'* *'tty'*
7295'ttytype' 'tty' string (default from $TERM)
7296 global
7297 Alias for 'term', see above.
7298
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007299 *'undodir'* *'udir'*
7300'undodir' 'udir' string (default ".")
7301 global
7302 {not in Vi}
7303 {only when compiled with the +persistent_undo feature}
7304 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007305 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02007306 "." means using the directory of the file. The undo file name for
7307 "file.txt" is ".file.txt.un~".
7308 For other directories the file name is the full path of the edited
7309 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007310 When writing: The first directory that exists is used. "." always
7311 works, no directories after "." will be used for writing.
7312 When reading all entries are tried to find an undo file. The first
7313 undo file that exists is used. When it cannot be read an error is
7314 given, no further entry is used.
7315 See |undo-persistence|.
7316
7317 *'undofile'* *'udf'*
7318'undofile' 'udf' boolean (default off)
7319 local to buffer
7320 {not in Vi}
7321 {only when compiled with the +persistent_undo feature}
7322 When on, Vim automatically saves undo history to an undo file when
7323 writing a buffer to a file, and restores undo history from the same
7324 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007325 The directory where the undo file is stored is specified by 'undodir'.
7326 For more information about this feature see |undo-persistence|.
7327 WARNING: this is a very new feature. Use at your own risk!
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007328
Bram Moolenaar071d4272004-06-13 20:20:40 +00007329 *'undolevels'* *'ul'*
7330'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7331 Win32 and OS/2)
7332 global
7333 {not in Vi}
7334 Maximum number of changes that can be undone. Since undo information
7335 is kept in memory, higher numbers will cause more memory to be used
7336 (nevertheless, a single change can use an unlimited amount of memory).
7337 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7338 itself: >
7339 set ul=0
7340< But you can also get Vi compatibility by including the 'u' flag in
7341 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007342 Also see |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007343 Set to a negative number for no undo at all: >
7344 set ul=-1
7345< This helps when you run out of memory for a single change.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007346 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007347
7348 *'updatecount'* *'uc'*
7349'updatecount' 'uc' number (default: 200)
7350 global
7351 {not in Vi}
7352 After typing this many characters the swap file will be written to
7353 disk. When zero, no swap file will be created at all (see chapter on
7354 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7355 Vim with the "-n" option, see |startup|. When editing in readonly
7356 mode this option will be initialized to 10000.
7357 The swapfile can be disabled per buffer with |'swapfile'|.
7358 When 'updatecount' is set from zero to non-zero, swap files are
7359 created for all buffers that have 'swapfile' set. When 'updatecount'
7360 is set to zero, existing swap files are not deleted.
7361 Also see |'swapsync'|.
7362 This option has no meaning in buffers where |'buftype'| is "nofile"
7363 or "nowrite".
7364
7365 *'updatetime'* *'ut'*
7366'updatetime' 'ut' number (default 4000)
7367 global
7368 {not in Vi}
7369 If this many milliseconds nothing is typed the swap file will be
7370 written to disk (see |crash-recovery|). Also used for the
7371 |CursorHold| autocommand event.
7372
7373 *'verbose'* *'vbs'*
7374'verbose' 'vbs' number (default 0)
7375 global
7376 {not in Vi, although some versions have a boolean
7377 verbose option}
7378 When bigger than zero, Vim will give messages about what it is doing.
7379 Currently, these messages are given:
7380 >= 1 When the viminfo file is read or written.
7381 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007382 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007383 >= 8 Files for which a group of autocommands is executed.
7384 >= 9 Every executed autocommand.
7385 >= 12 Every executed function.
7386 >= 13 When an exception is thrown, caught, finished, or discarded.
7387 >= 14 Anything pending in a ":finally" clause.
7388 >= 15 Every executed Ex command (truncated at 200 characters).
7389
7390 This option can also be set with the "-V" argument. See |-V|.
7391 This option is also set by the |:verbose| command.
7392
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007393 When the 'verbosefile' option is set then the verbose messages are not
7394 displayed.
7395
7396 *'verbosefile'* *'vfile'*
7397'verbosefile' 'vfile' string (default empty)
7398 global
7399 {not in Vi}
7400 When not empty all messages are written in a file with this name.
7401 When the file exists messages are appended.
7402 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02007403 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007404 Setting 'verbosefile' to a new value is like making it empty first.
7405 The difference with |:redir| is that verbose messages are not
7406 displayed when 'verbosefile' is set.
7407
Bram Moolenaar071d4272004-06-13 20:20:40 +00007408 *'viewdir'* *'vdir'*
7409'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7410 "$VIM/vimfiles/view",
7411 for Unix: "~/.vim/view",
7412 for Macintosh: "$VIM:vimfiles:view"
7413 for VMS: "sys$login:vimfiles/view"
7414 for RiscOS: "Choices:vimfiles/view")
7415 global
7416 {not in Vi}
7417 {not available when compiled without the +mksession
7418 feature}
7419 Name of the directory where to store files for |:mkview|.
7420 This option cannot be set from a |modeline| or in the |sandbox|, for
7421 security reasons.
7422
7423 *'viewoptions'* *'vop'*
7424'viewoptions' 'vop' string (default: "folds,options,cursor")
7425 global
7426 {not in Vi}
7427 {not available when compiled without the +mksession
7428 feature}
7429 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007430 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007431 word save and restore ~
7432 cursor cursor position in file and in window
7433 folds manually created folds, opened/closed folds and local
7434 fold options
7435 options options and mappings local to a window or buffer (not
7436 global values for local options)
7437 slash backslashes in file names replaced with forward
7438 slashes
7439 unix with Unix end-of-line format (single <NL>), even when
7440 on Windows or DOS
7441
7442 "slash" and "unix" are useful on Windows when sharing view files
7443 with Unix. The Unix version of Vim cannot source dos format scripts,
7444 but the Windows version of Vim can source unix format scripts.
7445
7446 *'viminfo'* *'vi'* *E526* *E527* *E528*
7447'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007448 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
7449 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
7450 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007451 global
7452 {not in Vi}
7453 {not available when compiled without the |+viminfo|
7454 feature}
7455 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007456 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007457 separated list of parameters, each consisting of a single character
7458 identifying the particular parameter, followed by a number or string
7459 which specifies the value of that parameter. If a particular
7460 character is left out, then the default value is used for that
7461 parameter. The following is a list of the identifying characters and
7462 the effect of their value.
7463 CHAR VALUE ~
7464 ! When included, save and restore global variables that start
7465 with an uppercase letter, and don't contain a lowercase
7466 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00007467 and "_K_L_M" are not. Only String and Number types are
7468 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007469 " Maximum number of lines saved for each register. Old name of
7470 the '<' item, with the disadvantage that you need to put a
7471 backslash before the ", otherwise it will be recognized as the
7472 start of a comment!
7473 % When included, save and restore the buffer list. If Vim is
7474 started with a file name argument, the buffer list is not
7475 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007476 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007477 without a file name and buffers for help files are not written
7478 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007479 When followed by a number, the number specifies the maximum
7480 number of buffers that are stored. Without a number all
7481 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007482 ' Maximum number of previously edited files for which the marks
7483 are remembered. This parameter must always be included when
7484 'viminfo' is non-empty.
7485 Including this item also means that the |jumplist| and the
7486 |changelist| are stored in the viminfo file.
7487 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007488 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007489 patterns are also saved. When not included, the value of
7490 'history' is used.
7491 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007492 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007493 < Maximum number of lines saved for each register. If zero then
7494 registers are not saved. When not included, all lines are
7495 saved. '"' is the old name for this item.
7496 Also see the 's' item below: limit specified in Kbyte.
7497 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007498 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007499 c When included, convert the text in the viminfo file from the
7500 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007501 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007502 f Whether file marks need to be stored. If zero, file marks ('0
7503 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007504 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007505 cursor position (when exiting or when doing ":wviminfo").
7506 h Disable the effect of 'hlsearch' when loading the viminfo
7507 file. When not included, it depends on whether ":nohlsearch"
7508 has been used since the last search command.
7509 n Name of the viminfo file. The name must immediately follow
7510 the 'n'. Must be the last one! If the "-i" argument was
7511 given when starting Vim, that file name overrides the one
7512 given here with 'viminfo'. Environment variables are expanded
7513 when opening the file, not when setting the option.
7514 r Removable media. The argument is a string (up to the next
7515 ','). This parameter can be given several times. Each
7516 specifies the start of a path for which no marks will be
7517 stored. This is to avoid removable media. For MS-DOS you
7518 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7519 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7520 ignored. Maximum length of each 'r' argument is 50
7521 characters.
7522 s Maximum size of an item in Kbyte. If zero then registers are
7523 not saved. Currently only applies to registers. The default
7524 "s10" will exclude registers with more than 10 Kbyte of text.
7525 Also see the '<' item above: line count limit.
7526
7527 Example: >
7528 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7529<
7530 '50 Marks will be remembered for the last 50 files you
7531 edited.
7532 <1000 Contents of registers (up to 1000 lines each) will be
7533 remembered.
7534 s100 Registers with more than 100 Kbyte text are skipped.
7535 :0 Command-line history will not be saved.
7536 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7537 no / Since '/' is not specified, the default will be used,
7538 that is, save all of the search history, and also the
7539 previous search and substitute patterns.
7540 no % The buffer list will not be saved nor read back.
7541 no h 'hlsearch' highlighting will be restored.
7542
7543 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7544 load the contents of the file, this is not done automatically.
7545
7546 This option cannot be set from a |modeline| or in the |sandbox|, for
7547 security reasons.
7548
7549 *'virtualedit'* *'ve'*
7550'virtualedit' 've' string (default "")
7551 global
7552 {not in Vi}
7553 {not available when compiled without the
7554 |+virtualedit| feature}
7555 A comma separated list of these words:
7556 block Allow virtual editing in Visual block mode.
7557 insert Allow virtual editing in Insert mode.
7558 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007559 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007560
Bram Moolenaar071d4272004-06-13 20:20:40 +00007561 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007562 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00007563 of the line. Useful for selecting a rectangle in Visual mode and
7564 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007565 "onemore" is not the same, it will only allow moving the cursor just
7566 after the last character of the line. This makes some commands more
7567 consistent. Previously the cursor was always past the end of the line
7568 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007569 break some plugins or Vim scripts. For example because |l| can move
7570 the cursor after the last character. Use with care!
7571 Using the |$| command will move to the last character in the line, not
7572 past it. This may actually move the cursor to the left!
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007573 It doesn't make sense to combine "all" with "onemore", but you will
7574 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007575
7576 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7577'visualbell' 'vb' boolean (default off)
7578 global
7579 {not in Vi}
7580 Use visual bell instead of beeping. The terminal code to display the
7581 visual bell is given with 't_vb'. When no beep or flash is wanted,
7582 use ":set vb t_vb=".
7583 Note: When the GUI starts, 't_vb' is reset to its default value. You
7584 might want to set it again in your |gvimrc|.
7585 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7586 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7587 where 40 is the time in msec.
7588 Does not work on the Amiga, you always get a screen flash.
7589 Also see 'errorbells'.
7590
7591 *'warn'* *'nowarn'*
7592'warn' boolean (default on)
7593 global
7594 Give a warning message when a shell command is used while the buffer
7595 has been changed.
7596
7597 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7598'weirdinvert' 'wiv' boolean (default off)
7599 global
7600 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007601 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007602 It is provided for backwards compatibility with version 4.x.
7603 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7604 vice versa. Has no effect when the GUI is running.
7605
7606 *'whichwrap'* *'ww'*
7607'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7608 global
7609 {not in Vi}
7610 Allow specified keys that move the cursor left/right to move to the
7611 previous/next line when the cursor is on the first/last character in
7612 the line. Concatenate characters to allow this for these keys:
7613 char key mode ~
7614 b <BS> Normal and Visual
7615 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007616 h "h" Normal and Visual (not recommended)
7617 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007618 < <Left> Normal and Visual
7619 > <Right> Normal and Visual
7620 ~ "~" Normal
7621 [ <Left> Insert and Replace
7622 ] <Right> Insert and Replace
7623 For example: >
7624 :set ww=<,>,[,]
7625< allows wrap only when cursor keys are used.
7626 When the movement keys are used in combination with a delete or change
7627 operator, the <EOL> also counts for a character. This makes "3h"
7628 different from "3dh" when the cursor crosses the end of a line. This
7629 is also true for "x" and "X", because they do the same as "dl" and
7630 "dh". If you use this, you may also want to use the mapping
7631 ":map <BS> X" to make backspace delete the character in front of the
7632 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007633 When 'l' is included and it is used after an operator at the end of a
7634 line then it will not move to the next line. This makes "dl", "cl",
7635 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007636 NOTE: This option is set to the Vi default value when 'compatible' is
7637 set and to the Vim default value when 'compatible' is reset.
7638
7639 *'wildchar'* *'wc'*
7640'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7641 global
7642 {not in Vi}
7643 Character you have to type to start wildcard expansion in the
7644 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007645 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007646 The character is not recognized when used inside a macro. See
7647 'wildcharm' for that.
7648 Although 'wc' is a number option, you can set it to a special key: >
7649 :set wc=<Esc>
7650< NOTE: This option is set to the Vi default value when 'compatible' is
7651 set and to the Vim default value when 'compatible' is reset.
7652
7653 *'wildcharm'* *'wcm'*
7654'wildcharm' 'wcm' number (default: none (0))
7655 global
7656 {not in Vi}
7657 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007658 recognized when used inside a macro. You can find "spare" command-line
7659 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007660 you'll never actually type 'wildcharm', just use it in mappings that
7661 automatically invoke completion mode, e.g.: >
7662 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00007663 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00007664< Then after typing :ss you can use CTRL-P & CTRL-N.
7665
7666 *'wildignore'* *'wig'*
7667'wildignore' 'wig' string (default "")
7668 global
7669 {not in Vi}
7670 {not available when compiled without the |+wildignore|
7671 feature}
7672 A list of file patterns. A file that matches with one of these
Bram Moolenaarbb5ddda2008-11-28 10:01:10 +00007673 patterns is ignored when completing file or directory names, and
7674 influences the result of |expand()|, |glob()| and |globpath()| unless
7675 a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007676 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7677 Also see 'suffixes'.
7678 Example: >
7679 :set wildignore=*.o,*.obj
7680< The use of |:set+=| and |:set-=| is preferred when adding or removing
7681 a pattern from the list. This avoids problems when a future version
7682 uses another default.
7683
7684 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7685'wildmenu' 'wmnu' boolean (default off)
7686 global
7687 {not in Vi}
7688 {not available if compiled without the |+wildmenu|
7689 feature}
7690 When 'wildmenu' is on, command-line completion operates in an enhanced
7691 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7692 the possible matches are shown just above the command line, with the
7693 first match highlighted (overwriting the status line, if there is
7694 one). Keys that show the previous/next match, such as <Tab> or
7695 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7696 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7697 specified. "longest" and "list" do not start "wildmenu" mode.
7698 If there are more matches than can fit in the line, a ">" is shown on
7699 the right and/or a "<" is shown on the left. The status line scrolls
7700 as needed.
7701 The "wildmenu" mode is abandoned when a key is hit that is not used
7702 for selecting a completion.
7703 While the "wildmenu" is active the following keys have special
7704 meanings:
7705
7706 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7707 <Down> - in filename/menu name completion: move into a
7708 subdirectory or submenu.
7709 <CR> - in menu completion, when the cursor is just after a
7710 dot: move into a submenu.
7711 <Up> - in filename/menu name completion: move up into
7712 parent directory or parent menu.
7713
7714 This makes the menus accessible from the console |console-menus|.
7715
7716 If you prefer the <Left> and <Right> keys to move the cursor instead
7717 of selecting a different match, use this: >
7718 :cnoremap <Left> <Space><BS><Left>
7719 :cnoremap <Right> <Space><BS><Right>
7720<
7721 The "WildMenu" highlighting is used for displaying the current match
7722 |hl-WildMenu|.
7723
7724 *'wildmode'* *'wim'*
7725'wildmode' 'wim' string (Vim default: "full")
7726 global
7727 {not in Vi}
7728 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007729 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00007730 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007731 first part specifies the behavior for the first use of 'wildchar',
7732 The second part for the second use, etc.
7733 These are the possible values for each part:
7734 "" Complete only the first match.
7735 "full" Complete the next full match. After the last match,
7736 the original string is used and then the first match
7737 again.
7738 "longest" Complete till longest common string. If this doesn't
7739 result in a longer string, use the next part.
7740 "longest:full" Like "longest", but also start 'wildmenu' if it is
7741 enabled.
7742 "list" When more than one match, list all matches.
7743 "list:full" When more than one match, list all matches and
7744 complete first match.
7745 "list:longest" When more than one match, list all matches and
7746 complete till longest common string.
7747 When there is only a single match, it is fully completed in all cases.
7748
7749 Examples: >
7750 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007751< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007752 :set wildmode=longest,full
7753< Complete longest common string, then each full match >
7754 :set wildmode=list:full
7755< List all matches and complete each full match >
7756 :set wildmode=list,full
7757< List all matches without completing, then each full match >
7758 :set wildmode=longest,list
7759< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007760 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007761
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007762 *'wildoptions'* *'wop'*
7763'wildoptions' 'wop' string (default "")
7764 global
7765 {not in Vi}
7766 {not available when compiled without the |+wildignore|
7767 feature}
7768 A list of words that change how command line completion is done.
7769 Currently only one word is allowed:
7770 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007771 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007772 is displayed per line. Often used tag kinds are:
7773 d #define
7774 f function
7775 Also see |cmdline-completion|.
7776
Bram Moolenaar071d4272004-06-13 20:20:40 +00007777 *'winaltkeys'* *'wak'*
7778'winaltkeys' 'wak' string (default "menu")
7779 global
7780 {not in Vi}
7781 {only used in Win32, Motif, GTK and Photon GUI}
7782 Some GUI versions allow the access to menu entries by using the ALT
7783 key in combination with a character that appears underlined in the
7784 menu. This conflicts with the use of the ALT key for mappings and
7785 entering special characters. This option tells what to do:
7786 no Don't use ALT keys for menus. ALT key combinations can be
7787 mapped, but there is no automatic handling. This can then be
7788 done with the |:simalt| command.
7789 yes ALT key handling is done by the windowing system. ALT key
7790 combinations cannot be mapped.
7791 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007792 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007793 keys can be mapped.
7794 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7795 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007796 This option is not used for <F10>; on Win32 and with GTK <F10> will
7797 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007798
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007799 *'window'* *'wi'*
7800'window' 'wi' number (default screen height - 1)
7801 global
7802 Window height. Do not confuse this with the height of the Vim window,
7803 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007804 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7805 value is smaller than 'lines' minus one. The screen will scroll
7806 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007807 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7808 in a much smarter way, taking care of wrapping lines.
7809 When resizing the Vim window, the value is smaller than 1 or more than
7810 or equal to 'lines' it will be set to 'lines' minus 1.
7811 {Vi also uses the option to specify the number of displayed lines}
7812
Bram Moolenaar071d4272004-06-13 20:20:40 +00007813 *'winheight'* *'wh'* *E591*
7814'winheight' 'wh' number (default 1)
7815 global
7816 {not in Vi}
7817 {not available when compiled without the +windows
7818 feature}
7819 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007820 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00007821 focus goes to a window that is smaller, its size is increased, at the
7822 cost of the height of other windows.
7823 Set 'winheight' to a small number for normal editing.
7824 Set it to 999 to make the current window fill most of the screen.
7825 Other windows will be only 'winminheight' high. This has the drawback
7826 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
7827 to create only two windows, set the option after startup is done,
7828 using the |VimEnter| event: >
7829 au VimEnter * set winheight=999
7830< Minimum value is 1.
7831 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007832 height of the current window.
7833 'winheight' applies to the current window. Use 'winminheight' to set
7834 the minimal height for other windows.
7835
7836 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7837'winfixheight' 'wfh' boolean (default off)
7838 local to window
7839 {not in Vi}
7840 {not available when compiled without the +windows
7841 feature}
7842 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007843 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
7844 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007845 The height may be changed anyway when running out of room.
7846
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007847 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
7848'winfixwidth' 'wfw' boolean (default off)
7849 local to window
7850 {not in Vi}
7851 {not available when compiled without the +windows
7852 feature}
7853 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007854 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007855 The width may be changed anyway when running out of room.
7856
Bram Moolenaar071d4272004-06-13 20:20:40 +00007857 *'winminheight'* *'wmh'*
7858'winminheight' 'wmh' number (default 1)
7859 global
7860 {not in Vi}
7861 {not available when compiled without the +windows
7862 feature}
7863 The minimal height of a window, when it's not the current window.
7864 This is a hard minimum, windows will never become smaller.
7865 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7866 status bar) if necessary. They will return to at least one line when
7867 they become active (since the cursor has to have somewhere to go.)
7868 Use 'winheight' to set the minimal height of the current window.
7869 This option is only checked when making a window smaller. Don't use a
7870 large number, it will cause errors when opening more than a few
7871 windows. A value of 0 to 3 is reasonable.
7872
7873 *'winminwidth'* *'wmw'*
7874'winminwidth' 'wmw' number (default 1)
7875 global
7876 {not in Vi}
7877 {not available when compiled without the +vertsplit
7878 feature}
7879 The minimal width of a window, when it's not the current window.
7880 This is a hard minimum, windows will never become smaller.
7881 When set to zero, windows may be "squashed" to zero columns (i.e. just
7882 a vertical separator) if necessary. They will return to at least one
7883 line when they become active (since the cursor has to have somewhere
7884 to go.)
7885 Use 'winwidth' to set the minimal width of the current window.
7886 This option is only checked when making a window smaller. Don't use a
7887 large number, it will cause errors when opening more than a few
7888 windows. A value of 0 to 12 is reasonable.
7889
7890 *'winwidth'* *'wiw'* *E592*
7891'winwidth' 'wiw' number (default 20)
7892 global
7893 {not in Vi}
7894 {not available when compiled without the +vertsplit
7895 feature}
7896 Minimal number of columns for the current window. This is not a hard
7897 minimum, Vim will use fewer columns if there is not enough room. If
7898 the current window is smaller, its size is increased, at the cost of
7899 the width of other windows. Set it to 999 to make the current window
7900 always fill the screen. Set it to a small number for normal editing.
7901 The width is not adjusted after one of the commands to change the
7902 width of the current window.
7903 'winwidth' applies to the current window. Use 'winminwidth' to set
7904 the minimal width for other windows.
7905
7906 *'wrap'* *'nowrap'*
7907'wrap' boolean (default on)
7908 local to window
7909 {not in Vi}
7910 This option changes how text is displayed. It doesn't change the text
7911 in the buffer, see 'textwidth' for that.
7912 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007913 displaying continues on the next line. When off lines will not wrap
7914 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007915 moved to a part that is not shown, the screen will scroll
7916 horizontally.
7917 The line will be broken in the middle of a word if necessary. See
7918 'linebreak' to get the break at a word boundary.
7919 To make scrolling horizontally a bit more useful, try this: >
7920 :set sidescroll=5
7921 :set listchars+=precedes:<,extends:>
7922< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007923 This option can't be set from a |modeline| when the 'diff' option is
7924 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007925
7926 *'wrapmargin'* *'wm'*
7927'wrapmargin' 'wm' number (default 0)
7928 local to buffer
7929 Number of characters from the right window border where wrapping
7930 starts. When typing text beyond this limit, an <EOL> will be inserted
7931 and inserting continues on the next line.
7932 Options that add a margin, such as 'number' and 'foldcolumn', cause
7933 the text width to be further reduced. This is Vi compatible.
7934 When 'textwidth' is non-zero, this option is not used.
7935 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7936 and less usefully}
7937
7938 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7939'wrapscan' 'ws' boolean (default on) *E384* *E385*
7940 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00007941 Searches wrap around the end of the file. Also applies to |]s| and
7942 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007943
7944 *'write'* *'nowrite'*
7945'write' boolean (default on)
7946 global
7947 {not in Vi}
7948 Allows writing files. When not set, writing a file is not allowed.
7949 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007950 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007951 argument. Filtering text is still possible, even though this requires
7952 writing a temporary file.
7953
7954 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
7955'writeany' 'wa' boolean (default off)
7956 global
7957 Allows writing to any file with no need for "!" override.
7958
7959 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
7960'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
7961 otherwise)
7962 global
7963 {not in Vi}
7964 Make a backup before overwriting a file. The backup is removed after
7965 the file was successfully written, unless the 'backup' option is
7966 also on. Reset this option if your file system is almost full. See
7967 |backup-table| for another explanation.
7968 When the 'backupskip' pattern matches, a backup is not made anyway.
7969 NOTE: This option is set to the default value when 'compatible' is
7970 set.
7971
7972 *'writedelay'* *'wd'*
7973'writedelay' 'wd' number (default 0)
7974 global
7975 {not in Vi}
7976 The number of microseconds to wait for each character sent to the
7977 screen. When non-zero, characters are sent to the terminal one by
7978 one. For MS-DOS pcterm this does not work. For debugging purposes.
7979
7980 vim:tw=78:ts=8:ft=help:norl: