blob: 9a88edb1a968f926acd4e1b0d459151479715dbe [file] [log] [blame]
Bram Moolenaar036986f2017-03-16 17:41:02 +01001*options.txt* For Vim version 8.0. Last change: 2017 Mar 09
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
Bram Moolenaar2ec618c2016-10-01 14:47:05 +020013For an overview of options see quickref.txt |option-list|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000014
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
Bram Moolenaar88774fd2015-08-25 19:52:04 +020053:se[t] all& Set all options to their default value. The values of
54 these options are not changed:
55 all terminal options, starting with t_
56 'columns'
57 'cryptmethod'
58 'encoding'
59 'key'
60 'lines'
61 'term'
62 'ttymouse'
63 'ttytype'
64 Warning: This may have a lot of side effects.
65 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +000066
67 *:set-args* *E487* *E521*
68:se[t] {option}={value} or
69:se[t] {option}:{value}
70 Set string or number option to {value}.
71 For numeric options the value can be given in decimal,
Bram Moolenaar3848e002016-03-19 18:42:29 +010072 hex (preceded with 0x) or octal (preceded with '0').
Bram Moolenaar071d4272004-06-13 20:20:40 +000073 The old value can be inserted by typing 'wildchar' (by
74 default this is a <Tab> or CTRL-E if 'compatible' is
75 set). See |cmdline-completion|.
76 White space between {option} and '=' is allowed and
77 will be ignored. White space between '=' and {value}
78 is not allowed.
79 See |option-backslash| for using white space and
80 backslashes in {value}.
81
82:se[t] {option}+={value} *:set+=*
83 Add the {value} to a number option, or append the
84 {value} to a string option. When the option is a
85 comma separated list, a comma is added, unless the
86 value was empty.
87 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000088 are removed. When adding a flag that was already
89 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000090 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000091 {not in Vi}
92
93:se[t] {option}^={value} *:set^=*
94 Multiply the {value} to a number option, or prepend
95 the {value} to a string option. When the option is a
96 comma separated list, a comma is added, unless the
97 value was empty.
98 Also see |:set-args| above.
99 {not in Vi}
100
101:se[t] {option}-={value} *:set-=*
102 Subtract the {value} from a number option, or remove
103 the {value} from a string option, if it is there.
104 If the {value} is not found in a string option, there
105 is no error or warning. When the option is a comma
106 separated list, a comma is deleted, unless the option
107 becomes empty.
108 When the option is a list of flags, {value} must be
109 exactly as they appear in the option. Remove flags
110 one by one to avoid problems.
111 Also see |:set-args| above.
112 {not in Vi}
113
114The {option} arguments to ":set" may be repeated. For example: >
115 :set ai nosi sw=3 ts=3
116If you make an error in one of the arguments, an error message will be given
117and the following arguments will be ignored.
118
119 *:set-verbose*
120When 'verbose' is non-zero, displaying an option value will also tell where it
121was last set. Example: >
122 :verbose set shiftwidth cindent?
Bram Moolenaar446cb832008-06-24 21:56:24 +0000123< shiftwidth=4 ~
124 Last set from modeline ~
125 cindent ~
126 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim ~
127This is only done when specific option values are requested, not for ":verbose
128set all" or ":verbose set" without an argument.
129When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000130When the option was set while executing a function, user command or
131autocommand, the script in which it was defined is reported.
132Note that an option may also have been set as a side effect of setting
133'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000134A few special texts:
135 Last set from modeline ~
136 Option was set in a |modeline|.
137 Last set from --cmd argument ~
138 Option was set with command line argument |--cmd| or +.
139 Last set from -c argument ~
140 Option was set with command line argument |-c|, +, |-S| or
141 |-q|.
142 Last set from environment variable ~
143 Option was set from an environment variable, $VIMINIT,
144 $GVIMINIT or $EXINIT.
145 Last set from error handler ~
146 Option was cleared when evaluating it resulted in an error.
147
Bram Moolenaardb84e452010-08-15 13:50:43 +0200148{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000149
150 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000151For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000152override the value from the termcap. You can then use it in a mapping. If
153the "xx" part contains special characters, use the <t_xx> form: >
154 :set <t_#4>=^[Ot
155This can also be used to translate a special code for a normal key. For
156example, if Alt-b produces <Esc>b, use this: >
157 :set <M-b>=^[b
158(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
159The advantage over a mapping is that it works in all situations.
160
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100161You can define any key codes, e.g.: >
162 :set t_xy=^[foo;
163There is no warning for using a name that isn't recognized. You can map these
164codes as you like: >
165 :map <t_xy> something
166< *E846*
167When a key code is not set, it's like it does not exist. Trying to get its
168value will result in an error: >
169 :set t_kb=
170 :set t_kb
171 E846: Key code not set: t_kb
172
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000173The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
174security reasons.
175
Bram Moolenaar071d4272004-06-13 20:20:40 +0000176The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000177at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000178"set all" probably does not fit on the screen, causing Vim to give the
179|more-prompt|.
180
181 *option-backslash*
182To include white space in a string option value it has to be preceded with a
183backslash. To include a backslash you have to use two. Effectively this
184means that the number of backslashes in an option value is halved (rounded
185down).
186A few examples: >
187 :set tags=tags\ /usr/tags results in "tags /usr/tags"
188 :set tags=tags\\,file results in "tags\,file"
189 :set tags=tags\\\ file results in "tags\ file"
190
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000191The "|" character separates a ":set" command from a following command. To
192include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000193'titlestring' option to "hi|there": >
194 :set titlestring=hi\|there
195This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
196 :set titlestring=hi|set iconstring=there
197
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000198Similarly, the double quote character starts a comment. To include the '"' in
199the option value, use '\"' instead. This example sets the 'titlestring'
200option to 'hi "there"': >
201 :set titlestring=hi\ \"there\"
202
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000203For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000204precise: For options that expect a file name (those where environment
205variables are expanded) a backslash before a normal file name character is not
206removed. But a backslash before a special character (space, backslash, comma,
207etc.) is used like explained above.
208There is one special situation, when the value starts with "\\": >
209 :set dir=\\machine\path results in "\\machine\path"
210 :set dir=\\\\machine\\path results in "\\machine\path"
211 :set dir=\\path\\file results in "\\path\file" (wrong!)
212For the first one the start is kept, but for the second one the backslashes
213are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000214halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000215result which is probably not what you want. Avoid it.
216
217 *add-option-flags* *remove-option-flags*
218 *E539* *E550* *E551* *E552*
219Some options are a list of flags. When you want to add a flag to such an
220option, without changing the existing ones, you can do it like this: >
221 :set guioptions+=a
222Remove a flag from an option like this: >
223 :set guioptions-=a
224This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000225Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000226the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
227doesn't appear.
228
229 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000230Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000231environment variable exists the '$' and the following environment variable
232name is replaced with its value. If it does not exist the '$' and the name
233are not modified. Any non-id character (not a letter, digit or '_') may
234follow the environment variable name. That character and what follows is
235appended to the value of the environment variable. Examples: >
236 :set term=$TERM.new
237 :set path=/usr/$INCLUDE,$HOME/include,.
238When adding or removing a string from an option with ":set opt-=val" or ":set
239opt+=val" the expansion is done before the adding or removing.
240
241
242Handling of local options *local-options*
243
244Some of the options only apply to a window or buffer. Each window or buffer
Bram Moolenaar51628222016-12-01 23:03:28 +0100245has its own copy of this option, thus each can have its own value. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000246allows you to set 'list' in one window but not in another. And set
247'shiftwidth' to 3 in one buffer and 4 in another.
248
249The following explains what happens to these local options in specific
250situations. You don't really need to know all of this, since Vim mostly uses
251the option values you would expect. Unfortunately, doing what the user
252expects is a bit complicated...
253
254When splitting a window, the local options are copied to the new window. Thus
255right after the split the contents of the two windows look the same.
256
257When editing a new buffer, its local option values must be initialized. Since
258the local options of the current buffer might be specifically for that buffer,
259these are not used. Instead, for each buffer-local option there also is a
260global value, which is used for new buffers. With ":set" both the local and
261global value is changed. With "setlocal" only the local value is changed,
262thus this value is not used when editing a new buffer.
263
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200264When editing a buffer that has been edited before, the options from the window
265that was last closed are used again. If this buffer has been edited in this
266window, the values from back then are used. Otherwise the values from the
267last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000268
269It's possible to set a local window option specifically for a type of buffer.
270When you edit another buffer in the same window, you don't want to keep
271using these local window options. Therefore Vim keeps a global value of the
272local window options, which is used when editing another buffer. Each window
273has its own copy of these values. Thus these are local to the window, but
274global to all buffers in the window. With this you can do: >
275 :e one
276 :set list
277 :e two
278Now the 'list' option will also be set in "two", since with the ":set list"
279command you have also set the global value. >
280 :set nolist
281 :e one
282 :setlocal list
283 :e two
284Now the 'list' option is not set, because ":set nolist" resets the global
285value, ":setlocal list" only changes the local value and ":e two" gets the
286global value. Note that if you do this next: >
287 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200288You will get back the 'list' value as it was the last time you edited "one".
289The options local to a window are remembered for each buffer. This also
290happens when the buffer is not loaded, but they are lost when the buffer is
291wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000292
293 *:setl* *:setlocal*
294:setl[ocal] ... Like ":set" but set only the value local to the
295 current buffer or window. Not all options have a
296 local value. If the option does not have a local
297 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200298 With the "all" argument: display local values for all
299 local options.
300 Without argument: Display local values for all local
301 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000302 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000303 local value. For a global/local boolean option, when
304 the global value is being used, "--" is displayed
305 before the option name.
306 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000307 shown (but that might change in the future).
308 {not in Vi}
309
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000310:setl[ocal] {option}< Set the local value of {option} to its global value by
311 copying the value.
312 {not in Vi}
313
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100314:se[t] {option}< For |global-local| options: Remove the local value of
315 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000316 {not in Vi}
317
318 *:setg* *:setglobal*
319:setg[lobal] ... Like ":set" but set only the global value for a local
320 option without changing the local value.
321 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200322 With the "all" argument: display global values for all
323 local options.
324 Without argument: display global values for all local
325 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000326 {not in Vi}
327
328For buffer-local and window-local options:
329 Command global value local value ~
330 :set option=value set set
331 :setlocal option=value - set
332:setglobal option=value set -
333 :set option? - display
334 :setlocal option? - display
335:setglobal option? display -
336
337
338Global options with a local value *global-local*
339
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000340Options are global when you mostly use one value for all buffers and windows.
341For some global options it's useful to sometimes have a different local value.
342You can set the local value with ":setlocal". That buffer or window will then
343use the local value, while other buffers and windows continue using the global
344value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000345
346For example, you have two windows, both on C source code. They use the global
347'makeprg' option. If you do this in one of the two windows: >
348 :set makeprg=gmake
349then the other window will switch to the same value. There is no need to set
350the 'makeprg' option in the other C source window too.
351However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000352another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000353files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000354 :setlocal makeprg=perlmake
355You can switch back to using the global value by making the local value empty: >
356 :setlocal makeprg=
357This only works for a string option. For a boolean option you need to use the
358"<" flag, like this: >
359 :setlocal autoread<
360Note that for non-boolean options using "<" copies the global value to the
361local value, it doesn't switch back to using the global value (that matters
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000362when the global value changes later). You can also use: >
363 :set path<
364This will make the local value of 'path' empty, so that the global value is
365used. Thus it does the same as: >
366 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000367Note: In the future more global options can be made global-local. Using
368":setlocal" on a global option might work differently then.
369
370
371Setting the filetype
372
373:setf[iletype] {filetype} *:setf* *:setfiletype*
374 Set the 'filetype' option to {filetype}, but only if
375 not done yet in a sequence of (nested) autocommands.
376 This is short for: >
377 :if !did_filetype()
378 : setlocal filetype={filetype}
379 :endif
380< This command is used in a filetype.vim file to avoid
381 setting the 'filetype' option twice, causing different
382 settings and syntax files to be loaded.
383 {not in Vi}
384
Bram Moolenaard58e9292011-02-09 17:07:58 +0100385 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000386:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
387:opt[ions] Open a window for viewing and setting all options.
388 Options are grouped by function.
389 Offers short help for each option. Hit <CR> on the
390 short help to open a help window with more help for
391 the option.
392 Modify the value of the option and hit <CR> on the
393 "set" line to set the new value. For window and
394 buffer specific options, the last accessed window is
395 used to set the option value in, unless this is a help
396 window, in which case the window below help window is
397 used (skipping the option-window).
398 {not available when compiled without the |+eval| or
399 |+autocmd| features}
400
401 *$HOME*
402Using "~" is like using "$HOME", but it is only recognized at the start of an
403option and after a space or comma.
404
405On Unix systems "~user" can be used too. It is replaced by the home directory
406of user "user". Example: >
407 :set path=~mool/include,/usr/include,.
408
409On Unix systems the form "${HOME}" can be used too. The name between {} can
410contain non-id characters then. Note that if you want to use this for the
411"gf" command, you need to add the '{' and '}' characters to 'isfname'.
412
Bram Moolenaarf1568ec2011-12-14 21:17:39 +0100413On MS-Windows, if $HOME is not defined as an environment variable, then
414at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
415
Bram Moolenaar071d4272004-06-13 20:20:40 +0000416NOTE: expanding environment variables and "~/" is only done with the ":set"
417command, not when assigning a value to an option with ":let".
418
419
420Note the maximum length of an expanded option is limited. How much depends on
421the system, mostly it is something like 256 or 1024 characters.
422
423 *:fix* *:fixdel*
424:fix[del] Set the value of 't_kD':
425 't_kb' is 't_kD' becomes ~
426 CTRL-? CTRL-H
427 not CTRL-? CTRL-?
428
429 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
430
431 If your delete key terminal code is wrong, but the
432 code for backspace is alright, you can put this in
433 your .vimrc: >
434 :fixdel
435< This works no matter what the actual code for
436 backspace is.
437
438 If the backspace key terminal code is wrong you can
439 use this: >
440 :if &term == "termname"
441 : set t_kb=^V<BS>
442 : fixdel
443 :endif
444< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000445 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000446 with your terminal name.
447
448 If your <Delete> key sends a strange key sequence (not
449 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
450 :if &term == "termname"
451 : set t_kD=^V<Delete>
452 :endif
453< Where "^V" is CTRL-V and "<Delete>" is the delete key
454 (don't type eight characters!). Replace "termname"
455 with your terminal name.
456
457 *Linux-backspace*
458 Note about Linux: By default the backspace key
459 produces CTRL-?, which is wrong. You can fix it by
460 putting this line in your rc.local: >
461 echo "keycode 14 = BackSpace" | loadkeys
462<
463 *NetBSD-backspace*
464 Note about NetBSD: If your backspace doesn't produce
465 the right code, try this: >
466 xmodmap -e "keycode 22 = BackSpace"
467< If this works, add this in your .Xmodmap file: >
468 keysym 22 = BackSpace
469< You need to restart for this to take effect.
470
471==============================================================================
4722. Automatically setting options *auto-setting*
473
474Besides changing options with the ":set" command, there are three alternatives
475to set options automatically for one or more files:
476
4771. When starting Vim initializations are read from various places. See
478 |initialization|. Most of them are performed for all editing sessions,
479 and some of them depend on the directory where Vim is started.
480 You can create an initialization file with |:mkvimrc|, |:mkview| and
481 |:mksession|.
4822. If you start editing a new file, the automatic commands are executed.
483 This can be used to set options for files matching a particular pattern and
484 many other things. See |autocommand|.
4853. If you start editing a new file, and the 'modeline' option is on, a
486 number of lines at the beginning and end of the file are checked for
487 modelines. This is explained here.
488
489 *modeline* *vim:* *vi:* *ex:* *E520*
490There are two forms of modelines. The first form:
Bram Moolenaar14b69452013-06-29 23:05:20 +0200491 [text]{white}{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000492
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200493[text] any text or empty
494{white} at least one blank character (<Space> or <Tab>)
Bram Moolenaar14b69452013-06-29 23:05:20 +0200495{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200496[white] optional white space
497{options} a list of option settings, separated with white space
498 or ':', where each part between ':' is the argument
499 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000500
Bram Moolenaar14b69452013-06-29 23:05:20 +0200501Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000502 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200503 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000504
505The second form (this is compatible with some versions of Vi):
506
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200507 [text]{white}{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000508
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200509[text] any text or empty
510{white} at least one blank character (<Space> or <Tab>)
511{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
512[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200513se[t] the string "set " or "se " (note the space); When
514 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200515{options} a list of options, separated with white space, which
516 is the argument for a ":set" command
517: a colon
518[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000519
Bram Moolenaar14b69452013-06-29 23:05:20 +0200520Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000521 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200522 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000523
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200524The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
525chance that a normal word like "lex:" is caught. There is one exception:
526"vi:" and "vim:" can also be at the start of the line (for compatibility with
527version 3.0). Using "ex:" at the start of the line will be ignored (this
528could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000529
530 *modeline-local*
531The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000532buffer and window that contain the file. Although it's possible to set global
533options from a modeline, this is unusual. If you have two windows open and
534the files in it set the same global option to a different value, the result
535depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000536
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000537When editing a file that was already loaded, only the window-local options
538from the modeline are used. Thus if you manually changed a buffer-local
539option after opening the file, it won't be changed if you edit the same buffer
540in another window. But window-local options will be set.
541
Bram Moolenaar071d4272004-06-13 20:20:40 +0000542 *modeline-version*
543If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200544number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000545 vim{vers}: version {vers} or later
546 vim<{vers}: version before {vers}
547 vim={vers}: version {vers}
548 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100549{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
550For example, to use a modeline only for Vim 7.0:
551 /* vim700: set foldmethod=marker */ ~
552To use a modeline for Vim after version 7.2:
553 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000554There can be no blanks between "vim" and the ":".
555
556
557The number of lines that are checked can be set with the 'modelines' option.
558If 'modeline' is off or 'modelines' is 0 no lines are checked.
559
560Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000561like:
562 /* vi:ts=4: */ ~
563will give an error message for the trailing "*/". This line is OK:
564 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000565
566If an error is detected the rest of the line is skipped.
567
568If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000569backslash in front of the ':' will be removed. Example:
570 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000571This sets the 'dir' option to "c:\tmp". Only a single backslash before the
572':' is removed. Thus to include "\:" you have to specify "\\:".
573
574No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000575might create a Trojan horse text file with modelines). And not all options
576can be set. For some options a flag is set, so that when it's used the
Bram Moolenaar02467872007-05-06 13:22:01 +0000577|sandbox| is effective. Still, there is always a small risk that a modeline
Bram Moolenaar8243a792007-05-01 17:05:03 +0000578causes trouble. E.g., when some joker sets 'textwidth' to 5 all your lines
579are wrapped unexpectedly. So disable modelines before editing untrusted text.
580The mail ftplugin does this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000581
582Hint: If you would like to do something else than setting an option, you could
583define an autocommand that checks the file for a specific string. For
584example: >
585 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
586And define a function SetVar() that does something with the line containing
587"VAR".
588
589==============================================================================
5903. Options summary *option-summary*
591
592In the list below all the options are mentioned with their full name and with
593an abbreviation if there is one. Both forms may be used.
594
595In this document when a boolean option is "set" that means that ":set option"
596is entered. When an option is "reset", ":set nooption" is used.
597
598For some options there are two default values: The "Vim default", which is
599used when 'compatible' is not set, and the "Vi default", which is used when
600'compatible' is set.
601
602Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000603are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000604different value in each window. For example the 'list' option can be set in
605one window and reset in another for the same text, giving both types of view
606at the same time. There are a few options that are specific to a certain
607file. These can have a different value for each file or buffer. For example
608the 'textwidth' option can be 78 for a normal text file and 0 for a C
609program.
610
611 global one option for all buffers and windows
612 local to window each window has its own copy of this option
613 local to buffer each buffer has its own copy of this option
614
615When creating a new window the option values from the currently active window
616are used as a default value for the window-specific options. For the
617buffer-specific options this depends on the 's' and 'S' flags in the
618'cpoptions' option. If 's' is included (which is the default) the values for
619buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000620first entered. If 'S' is present the options are copied each time the buffer
621is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000622present, the options are copied from the currently active buffer when the
623buffer is created.
624
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000625Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000626
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000627Not all options are supported in all versions. This depends on the supported
628features and sometimes on the system. A remark about this is in curly braces
629below. When an option is not supported it may still be set without getting an
630error, this is called a hidden option. You can't get the value of a hidden
631option though, it is not stored.
632
633To test if option "foo" can be used with ":set" use something like this: >
634 if exists('&foo')
635This also returns true for a hidden option. To test if option "foo" is really
636supported use something like this: >
637 if exists('+foo')
638<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000639 *E355*
640A jump table for the options with a short description can be found at |Q_op|.
641
642 *'aleph'* *'al'* *aleph* *Aleph*
643'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
644 global
645 {not in Vi}
646 {only available when compiled with the |+rightleft|
647 feature}
648 The ASCII code for the first letter of the Hebrew alphabet. The
649 routine that maps the keyboard in Hebrew mode, both in Insert mode
650 (when hkmap is set) and on the command-line (when hitting CTRL-_)
651 outputs the Hebrew characters in the range [aleph..aleph+26].
652 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
653 See |rileft.txt|.
654
655 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
656'allowrevins' 'ari' boolean (default off)
657 global
658 {not in Vi}
659 {only available when compiled with the |+rightleft|
660 feature}
661 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
662 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
663 into reverse Insert mode, and don't know how to get out. See
664 'revins'.
665 NOTE: This option is reset when 'compatible' is set.
666
667 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
668'altkeymap' 'akm' boolean (default off)
669 global
670 {not in Vi}
671 {only available when compiled with the |+farsi|
672 feature}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000673 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000674 the keyboard map between Farsi and English, when 'allowrevins' set.
675
Bram Moolenaar582fd852005-03-28 20:58:01 +0000676 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000677 is useful to start the Vim in native mode i.e. English (left-to-right
678 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000679 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000680
681 *'ambiwidth'* *'ambw'*
682'ambiwidth' 'ambw' string (default: "single")
683 global
684 {not in Vi}
685 {only available when compiled with the |+multi_byte|
686 feature}
687 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
688 Tells Vim what to do with characters with East Asian Width Class
689 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
690 letters, Cyrillic letters).
691
692 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000693 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000694 expected by most users.
695 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200696 *E834* *E835*
697 The value "double" cannot be used if 'listchars' or 'fillchars'
698 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000699
700 There are a number of CJK fonts for which the width of glyphs for
701 those characters are solely based on how many octets they take in
702 legacy/traditional CJK encodings. In those encodings, Euro,
703 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000704 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000705 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000706 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000707 Vim is running inside a terminal (emulators) that uses a CJK font
708 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
709 this option should be set to "double" to match the width perceived
710 by Vim with the width of glyphs in the font. Perhaps it also has
711 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
712 when the system locale is set to one of CJK locales. See Unicode
713 Standard Annex #11 (http://www.unicode.org/reports/tr11).
714
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100715 Vim may set this option automatically at startup time when Vim is
716 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaarbf884932013-04-05 22:26:15 +0200717 escape sequence to request cursor position report.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100718
Bram Moolenaar071d4272004-06-13 20:20:40 +0000719 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
720'antialias' 'anti' boolean (default: off)
721 global
722 {not in Vi}
723 {only available when compiled with GUI enabled
724 on Mac OS X}
725 This option only has an effect in the GUI version of Vim on Mac OS X
726 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
727 which can be easier to read at certain sizes on certain displays.
728 Setting this option can sometimes cause problems if 'guifont' is set
729 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100730 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000731
732 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
733'autochdir' 'acd' boolean (default off)
734 global
735 {not in Vi}
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200736 {only available when compiled with it, use
737 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000738 When on, Vim will change the current working directory whenever you
739 open a file, switch buffers, delete a buffer or open/close a window.
740 It will change to the directory containing the file which was opened
741 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000742 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000743
744 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
745'arabic' 'arab' boolean (default off)
746 local to window
747 {not in Vi}
748 {only available when compiled with the |+arabic|
749 feature}
750 This option can be set to start editing Arabic text.
751 Setting this option will:
752 - Set the 'rightleft' option, unless 'termbidi' is set.
753 - Set the 'arabicshape' option, unless 'termbidi' is set.
754 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
755 between typing English and Arabic key mapping.
756 - Set the 'delcombine' option
757 Note that 'encoding' must be "utf-8" for working with Arabic text.
758
759 Resetting this option will:
760 - Reset the 'rightleft' option.
761 - Disable the use of 'keymap' (without changing its value).
762 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200763 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100764 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000765 Also see |arabic.txt|.
766
767 *'arabicshape'* *'arshape'*
768 *'noarabicshape'* *'noarshape'*
769'arabicshape' 'arshape' boolean (default on)
770 global
771 {not in Vi}
772 {only available when compiled with the |+arabic|
773 feature}
774 When on and 'termbidi' is off, the required visual character
775 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200776 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000777 one which encompasses:
778 a) the changing/morphing of characters based on their location
779 within a word (initial, medial, final and stand-alone).
780 b) the enabling of the ability to compose characters
781 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100782 When disabled the display shows each character's true stand-alone
783 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000784 Arabic is a complex language which requires other settings, for
785 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100786 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000787
788 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
789'autoindent' 'ai' boolean (default off)
790 local to buffer
791 Copy indent from current line when starting a new line (typing <CR>
792 in Insert mode or when using the "o" or "O" command). If you do not
793 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000794 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
795 to another line has the same effect, unless the 'I' flag is included
796 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000797 When autoindent is on, formatting (with the "gq" command or when you
798 reach 'textwidth' in Insert mode) uses the indentation of the first
799 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000800 When 'smartindent' or 'cindent' is on the indent is changed in
801 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200802 The 'autoindent' option is reset when the 'paste' option is set and
803 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000804 {small difference from Vi: After the indent is deleted when typing
805 <Esc> or <CR>, the cursor position when moving up or down is after the
806 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
807
808 *'autoread'* *'ar'* *'noautoread'* *'noar'*
809'autoread' 'ar' boolean (default off)
810 global or local to buffer |global-local|
811 {not in Vi}
812 When a file has been detected to have been changed outside of Vim and
813 it has not been changed inside of Vim, automatically read it again.
814 When the file has been deleted this is not done. |timestamp|
815 If this option has a local value, use this command to switch back to
816 using the global value: >
817 :set autoread<
818<
819 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
820'autowrite' 'aw' boolean (default off)
821 global
822 Write the contents of the file, if it has been modified, on each
823 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000824 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000825 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
826 Note that for some commands the 'autowrite' option is not used, see
827 'autowriteall' for that.
828
829 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
830'autowriteall' 'awa' boolean (default off)
831 global
832 {not in Vi}
833 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
834 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
835 Setting this option also implies that Vim behaves like 'autowrite' has
836 been set.
837
838 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200839'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000840 global
841 {not in Vi}
842 When set to "dark", Vim will try to use colors that look good on a
843 dark background. When set to "light", Vim will try to use colors that
844 look good on a light background. Any other value is illegal.
845 Vim tries to set the default value according to the terminal used.
846 This will not always be correct.
847 Setting this option does not change the background color, it tells Vim
848 what the background color looks like. For changing the background
849 color, see |:hi-normal|.
850
851 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000852 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000853 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100854 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000855 setting 'background' will cause the color scheme to be reloaded. If
856 the color scheme adjusts to the value of 'background' this will work.
857 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100858 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000859
860 When setting 'background' to the default value with: >
861 :set background&
862< Vim will guess the value. In the GUI this should work correctly,
863 in other cases Vim might not be able to guess the right value.
864
865 When starting the GUI, the default value for 'background' will be
866 "light". When the value is not set in the .gvimrc, and Vim detects
867 that the background is actually quite dark, 'background' is set to
868 "dark". But this happens only AFTER the .gvimrc file has been read
869 (because the window needs to be opened to find the actual background
870 color). To get around this, force the GUI window to be opened by
871 putting a ":gui" command in the .gvimrc file, before where the value
872 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200873
874 For MS-DOS, Windows and OS/2 the default is "dark".
875 For other systems "dark" is used when 'term' is "linux",
876 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
877 background. Otherwise the default is "light".
878
Bram Moolenaar071d4272004-06-13 20:20:40 +0000879 Normally this option would be set in the .vimrc file. Possibly
880 depending on the terminal name. Example: >
881 :if &term == "pcterm"
882 : set background=dark
883 :endif
884< When this option is set, the default settings for the highlight groups
885 will change. To use other settings, place ":highlight" commands AFTER
886 the setting of the 'background' option.
887 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
888 to select the colors for syntax highlighting. After changing this
889 option, you must load syntax.vim again to see the result. This can be
890 done with ":syntax on".
891
892 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200893'backspace' 'bs' string (default "", set to "indent,eol,start"
894 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000895 global
896 {not in Vi}
897 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
898 mode. This is a list of items, separated by commas. Each item allows
899 a way to backspace over something:
900 value effect ~
901 indent allow backspacing over autoindent
902 eol allow backspacing over line breaks (join lines)
903 start allow backspacing over the start of insert; CTRL-W and CTRL-U
904 stop once at the start of insert.
905
906 When the value is empty, Vi compatible backspacing is used.
907
908 For backwards compatibility with version 5.4 and earlier:
909 value effect ~
910 0 same as ":set backspace=" (Vi compatible)
911 1 same as ":set backspace=indent,eol"
912 2 same as ":set backspace=indent,eol,start"
913
914 See |:fixdel| if your <BS> or <Del> key does not do what you want.
915 NOTE: This option is set to "" when 'compatible' is set.
916
917 *'backup'* *'bk'* *'nobackup'* *'nobk'*
918'backup' 'bk' boolean (default off)
919 global
920 {not in Vi}
921 Make a backup before overwriting a file. Leave it around after the
922 file has been successfully written. If you do not want to keep the
923 backup file, but you do want a backup while the file is being
924 written, reset this option and set the 'writebackup' option (this is
925 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000926 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000927 |backup-table| for more explanations.
928 When the 'backupskip' pattern matches, a backup is not made anyway.
929 When 'patchmode' is set, the backup may be renamed to become the
930 oldest version of a file.
931 NOTE: This option is reset when 'compatible' is set.
932
933 *'backupcopy'* *'bkc'*
934'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200935 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000936 {not in Vi}
937 When writing a file and a backup is made, this option tells how it's
938 done. This is a comma separated list of words.
939
940 The main values are:
941 "yes" make a copy of the file and overwrite the original one
942 "no" rename the file and write a new one
943 "auto" one of the previous, what works best
944
945 Extra values that can be combined with the ones above are:
946 "breaksymlink" always break symlinks when writing
947 "breakhardlink" always break hardlinks when writing
948
949 Making a copy and overwriting the original file:
950 - Takes extra time to copy the file.
951 + When the file has special attributes, is a (hard/symbolic) link or
952 has a resource fork, all this is preserved.
953 - When the file is a link the backup will have the name of the link,
954 not of the real file.
955
956 Renaming the file and writing a new one:
957 + It's fast.
958 - Sometimes not all attributes of the file can be copied to the new
959 file.
960 - When the file is a link the new file will not be a link.
961
962 The "auto" value is the middle way: When Vim sees that renaming file
963 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000964 the file is not a link) that is used. When problems are expected, a
965 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000966
967 The "breaksymlink" and "breakhardlink" values can be used in
968 combination with any of "yes", "no" and "auto". When included, they
969 force Vim to always break either symbolic or hard links by doing
970 exactly what the "no" option does, renaming the original file to
971 become the backup and writing a new file in its place. This can be
972 useful for example in source trees where all the files are symbolic or
973 hard links and any changes should stay in the local source tree, not
974 be propagated back to the original source.
975 *crontab*
976 One situation where "no" and "auto" will cause problems: A program
977 that opens a file, invokes Vim to edit that file, and then tests if
978 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000979 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000980 example.
981
982 When a copy is made, the original file is truncated and then filled
983 with the new text. This means that protection bits, owner and
984 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000985 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000986 group of the backup is set to the group of the original file. If this
987 fails, the protection bits for the group are made the same as for
988 others.
989
990 When the file is renamed this is the other way around: The backup has
991 the same attributes of the original file, and the newly written file
992 is owned by the current user. When the file was a (hard/symbolic)
993 link, the new file will not! That's why the "auto" value doesn't
994 rename when the file is a link. The owner and group of the newly
995 written file will be set to the same ones as the original file, but
996 the system may refuse to do this. In that case the "auto" value will
997 again not rename the file.
998
Bram Moolenaar036986f2017-03-16 17:41:02 +0100999 NOTE: This option is set to the Vi default value when 'compatible' is
1000 set and to the Vim default value when 'compatible' is reset.
1001
Bram Moolenaar071d4272004-06-13 20:20:40 +00001002 *'backupdir'* *'bdir'*
1003'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01001004 for MS-DOS and Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001005 for Unix: ".,~/tmp,~/")
1006 global
1007 {not in Vi}
1008 List of directories for the backup file, separated with commas.
1009 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001010 where this is possible. The directory must exist, Vim will not
1011 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001012 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001013 impossible!). Writing may fail because of this.
1014 - A directory "." means to put the backup file in the same directory
1015 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +00001016 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00001017 put the backup file relative to where the edited file is. The
1018 leading "." is replaced with the path name of the edited file.
1019 ("." inside a directory name has no special meaning).
1020 - Spaces after the comma are ignored, other spaces are considered part
1021 of the directory name. To have a space at the start of a directory
1022 name, precede it with a backslash.
1023 - To include a comma in a directory name precede it with a backslash.
1024 - A directory name may end in an '/'.
1025 - Environment variables are expanded |:set_env|.
1026 - Careful with '\' characters, type one before a space, type two to
1027 get one in the option (see |option-backslash|), for example: >
1028 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1029< - For backwards compatibility with Vim version 3.0 a '>' at the start
1030 of the option is removed.
1031 See also 'backup' and 'writebackup' options.
1032 If you want to hide your backup files on Unix, consider this value: >
1033 :set backupdir=./.backup,~/.backup,.,/tmp
1034< You must create a ".backup" directory in each directory and in your
1035 home directory for this to work properly.
1036 The use of |:set+=| and |:set-=| is preferred when adding or removing
1037 directories from the list. This avoids problems when a future version
1038 uses another default.
1039 This option cannot be set from a |modeline| or in the |sandbox|, for
1040 security reasons.
1041
1042 *'backupext'* *'bex'* *E589*
1043'backupext' 'bex' string (default "~", for VMS: "_")
1044 global
1045 {not in Vi}
1046 String which is appended to a file name to make the name of the
1047 backup file. The default is quite unusual, because this avoids
1048 accidentally overwriting existing files with a backup file. You might
1049 prefer using ".bak", but make sure that you don't have files with
1050 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001051 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001052
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001053 If you like to keep a lot of backups, you could use a BufWritePre
1054 autocommand to change 'backupext' just before writing the file to
1055 include a timestamp. >
1056 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1057< Use 'backupdir' to put the backup in a different directory.
1058
Bram Moolenaar071d4272004-06-13 20:20:40 +00001059 *'backupskip'* *'bsk'*
1060'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
1061 global
1062 {not in Vi}
1063 {not available when compiled without the |+wildignore|
1064 feature}
1065 A list of file patterns. When one of the patterns matches with the
1066 name of the file which is written, no backup file is created. Both
1067 the specified file name and the full path name of the file are used.
1068 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1069 Watch out for special characters, see |option-backslash|.
1070 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001071 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001072
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001073 WARNING: Not having a backup file means that when Vim fails to write
1074 your buffer correctly and then, for whatever reason, Vim exits, you
1075 lose both the original file and what you were writing. Only disable
1076 backups if you don't care about losing the file.
1077
Bram Moolenaar02467872007-05-06 13:22:01 +00001078 Note that environment variables are not expanded. If you want to use
1079 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001080 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001081
1082< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001083 backup would be made by renaming the original file crontab won't see
1084 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001085
1086 *'balloondelay'* *'bdlay'*
1087'balloondelay' 'bdlay' number (default: 600)
1088 global
1089 {not in Vi}
1090 {only available when compiled with the |+balloon_eval|
1091 feature}
1092 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1093
1094 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1095'ballooneval' 'beval' boolean (default off)
1096 global
1097 {not in Vi}
1098 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001099 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001100 Switch on the |balloon-eval| functionality.
1101
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001102 *'balloonexpr'* *'bexpr'*
1103'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001104 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001105 {not in Vi}
1106 {only available when compiled with the |+balloon_eval|
1107 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001108 Expression for text to show in evaluation balloon. It is only used
1109 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001110
1111 v:beval_bufnr number of the buffer in which balloon is going to show
1112 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001113 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001114 v:beval_lnum line number
1115 v:beval_col column number (byte index)
1116 v:beval_text word under or after the mouse pointer
1117
1118 The evaluation of the expression must not have side effects!
1119 Example: >
1120 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001121 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001122 \', column ' . v:beval_col .
1123 \ ' of file ' . bufname(v:beval_bufnr) .
1124 \ ' on word "' . v:beval_text . '"'
1125 endfunction
1126 set bexpr=MyBalloonExpr()
1127 set ballooneval
1128<
Bram Moolenaar214641f2017-03-05 17:04:09 +01001129 Also see |balloon_show()|, can be used if the content of the balloon
1130 is to be fetched asynchronously.
1131
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001132 NOTE: The balloon is displayed only if the cursor is on a text
1133 character. If the result of evaluating 'balloonexpr' is not empty,
1134 Vim does not try to send a message to an external debugger (Netbeans
1135 or Sun Workshop).
1136
Bram Moolenaar30b65812012-07-12 22:01:11 +02001137 The expression will be evaluated in the |sandbox| when set from a
1138 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001139
1140 It is not allowed to change text or jump to another window while
1141 evaluating 'balloonexpr' |textlock|.
1142
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001143 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001144 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001145< When they are supported "\n" characters will start a new line. If the
1146 expression evaluates to a |List| this is equal to using each List item
1147 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001148 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001149
Bram Moolenaar165bc692015-07-21 17:53:25 +02001150 *'belloff'* *'bo'*
1151'belloff' 'bo' string (default "")
1152 global
1153 {not in Vi}
1154 Specifies for which events the bell will not be rung. It is a comma
1155 separated list of items. For each item that is present, the bell
1156 will be silenced. This is most useful to specify specific events in
1157 insert mode to be silenced.
1158
1159 item meaning when present ~
1160 all All events.
1161 backspace When hitting <BS> or <Del> and deleting results in an
1162 error.
1163 cursor Fail to move around using the cursor keys or
1164 <PageUp>/<PageDown> in |Insert-mode|.
1165 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1166 |i_CTRL-X_CTRL-T|.
1167 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1168 |i_CTRL-E|.
1169 ctrlg Unknown Char after <C-G> in Insert mode.
1170 error Other Error occurred (e.g. try to join last line)
1171 (mostly used in |Normal-mode| or |Cmdline-mode|).
1172 esc hitting <Esc> in |Normal-mode|.
1173 ex In |Visual-mode|, hitting |Q| results in an error.
1174 hangul Error occurred when using hangul input.
1175 insertmode Pressing <Esc> in 'insertmode'.
1176 lang Calling the beep module for Lua/Mzscheme/TCL.
1177 mess No output available for |g<|.
1178 showmatch Error occurred for 'showmatch' function.
1179 operator Empty region error |cpo-E|.
1180 register Unknown register after <C-R> in |Insert-mode|.
1181 shell Bell from shell output |:!|.
1182 spell Error happened on spell suggest.
1183 wildmode More matches in |cmdline-completion| available
1184 (depends on the 'wildmode' setting).
1185
Bram Moolenaar036986f2017-03-16 17:41:02 +01001186 This is most useful to fine tune when in Insert mode the bell should
1187 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001188 indicate that an error occurred. It can be silenced by adding the
1189 "error" keyword.
1190
Bram Moolenaar071d4272004-06-13 20:20:40 +00001191 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1192'binary' 'bin' boolean (default off)
1193 local to buffer
1194 {not in Vi}
1195 This option should be set before editing a binary file. You can also
1196 use the |-b| Vim argument. When this option is switched on a few
1197 options will be changed (also when it already was on):
1198 'textwidth' will be set to 0
1199 'wrapmargin' will be set to 0
1200 'modeline' will be off
1201 'expandtab' will be off
1202 Also, 'fileformat' and 'fileformats' options will not be used, the
1203 file is read and written like 'fileformat' was "unix" (a single <NL>
1204 separates lines).
1205 The 'fileencoding' and 'fileencodings' options will not be used, the
1206 file is read without conversion.
1207 NOTE: When you start editing a(nother) file while the 'bin' option is
1208 on, settings from autocommands may change the settings again (e.g.,
1209 'textwidth'), causing trouble when editing. You might want to set
1210 'bin' again when the file has been loaded.
1211 The previous values of these options are remembered and restored when
1212 'bin' is switched from on to off. Each buffer has its own set of
1213 saved option values.
1214 To edit a file with 'binary' set you can use the |++bin| argument.
1215 This avoids you have to do ":set bin", which would have effect for all
1216 files you edit.
1217 When writing a file the <EOL> for the last line is only written if
1218 there was one in the original file (normally Vim appends an <EOL> to
1219 the last line if there is none; this would make the file longer). See
1220 the 'endofline' option.
1221
1222 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1223'bioskey' 'biosk' boolean (default on)
1224 global
1225 {not in Vi} {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001226 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001227
1228 *'bomb'* *'nobomb'*
1229'bomb' boolean (default off)
1230 local to buffer
1231 {not in Vi}
1232 {only available when compiled with the |+multi_byte|
1233 feature}
1234 When writing a file and the following conditions are met, a BOM (Byte
1235 Order Mark) is prepended to the file:
1236 - this option is on
1237 - the 'binary' option is off
1238 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1239 endian variants.
1240 Some applications use the BOM to recognize the encoding of the file.
1241 Often used for UCS-2 files on MS-Windows. For other applications it
1242 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001243 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001244 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1245 check for the presence of the BOM is done and 'bomb' set accordingly.
1246 Unless 'binary' is set, it is removed from the first line, so that you
1247 don't see it when editing. When you don't change the options, the BOM
1248 will be restored when writing the file.
1249
1250 *'breakat'* *'brk'*
1251'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1252 global
1253 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001254 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001255 feature}
1256 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001257 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1258 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001259
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001260 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001261'breakindent' 'bri' boolean (default off)
1262 local to window
1263 {not in Vi}
1264 {not available when compiled without the |+linebreak|
1265 feature}
1266 Every wrapped line will continue visually indented (same amount of
1267 space as the beginning of that line), thus preserving horizontal blocks
1268 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001269 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001270
1271 *'breakindentopt'* *'briopt'*
1272'breakindentopt' 'briopt' string (default empty)
1273 local to window
1274 {not in Vi}
1275 {not available when compiled without the |+linebreak|
1276 feature}
1277 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001278 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001279 min:{n} Minimum text width that will be kept after
1280 applying 'breakindent', even if the resulting
1281 text should normally be narrower. This prevents
1282 text indented almost to the right window border
1283 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001284 shift:{n} After applying 'breakindent', the wrapped line's
1285 beginning will be shifted by the given number of
1286 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001287 indentation (negative) or emphasizing the line
1288 continuation (positive).
1289 sbr Display the 'showbreak' value before applying the
1290 additional indent.
1291 The default value for min is 20 and shift is 0.
1292
Bram Moolenaar071d4272004-06-13 20:20:40 +00001293 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001294'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001295 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001296 {not in Vi} {only for Motif, Athena, GTK, Mac and
1297 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001298 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001299 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001300 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001301 buffer Use the directory of the related buffer.
1302 current Use the current directory.
1303 {path} Use the specified directory
1304
1305 *'bufhidden'* *'bh'*
1306'bufhidden' 'bh' string (default: "")
1307 local to buffer
1308 {not in Vi}
1309 {not available when compiled without the |+quickfix|
1310 feature}
1311 This option specifies what happens when a buffer is no longer
1312 displayed in a window:
1313 <empty> follow the global 'hidden' option
1314 hide hide the buffer (don't unload it), also when 'hidden'
1315 is not set
1316 unload unload the buffer, also when 'hidden' is set or using
1317 |:hide|
1318 delete delete the buffer from the buffer list, also when
1319 'hidden' is set or using |:hide|, like using
1320 |:bdelete|
1321 wipe wipe out the buffer from the buffer list, also when
1322 'hidden' is set or using |:hide|, like using
1323 |:bwipeout|
1324
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001325 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001326 are lost without a warning. Also, these values may break autocommands
1327 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001328 This option is used together with 'buftype' and 'swapfile' to specify
1329 special kinds of buffers. See |special-buffers|.
1330
1331 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1332'buflisted' 'bl' boolean (default: on)
1333 local to buffer
1334 {not in Vi}
1335 When this option is set, the buffer shows up in the buffer list. If
1336 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1337 This option is reset by Vim for buffers that are only used to remember
1338 a file name or marks. Vim sets it when starting to edit a buffer.
1339 But not when moving to a buffer with ":buffer".
1340
1341 *'buftype'* *'bt'* *E382*
1342'buftype' 'bt' string (default: "")
1343 local to buffer
1344 {not in Vi}
1345 {not available when compiled without the |+quickfix|
1346 feature}
1347 The value of this option specifies the type of a buffer:
1348 <empty> normal buffer
1349 nofile buffer which is not related to a file and will not be
1350 written
1351 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001352 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001353 autocommands. {not available when compiled without the
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001354 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001355 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001356 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001357 help help buffer (you are not supposed to set this
1358 manually)
1359
1360 This option is used together with 'bufhidden' and 'swapfile' to
1361 specify special kinds of buffers. See |special-buffers|.
1362
1363 Be careful with changing this option, it can have many side effects!
1364
Bram Moolenaar280f1262006-01-30 00:14:18 +00001365 A "quickfix" buffer is only used for the error list and the location
1366 list. This value is set by the |:cwindow| and |:lwindow| commands and
1367 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001368
1369 "nofile" and "nowrite" buffers are similar:
1370 both: The buffer is not to be written to disk, ":w" doesn't
1371 work (":w filename" does work though).
1372 both: The buffer is never considered to be |'modified'|.
1373 There is no warning when the changes will be lost, for
1374 example when you quit Vim.
1375 both: A swap file is only created when using too much memory
1376 (when 'swapfile' has been reset there is never a swap
1377 file).
1378 nofile only: The buffer name is fixed, it is not handled like a
1379 file name. It is not modified in response to a |:cd|
1380 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001381 both: When using ":e bufname" and already editing "bufname"
1382 the buffer is made empty and autocommands are
1383 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001384 *E676*
1385 "acwrite" implies that the buffer name is not related to a file, like
1386 "nofile", but it will be written. Thus, in contrast to "nofile" and
1387 "nowrite", ":w" does work and a modified buffer can't be abandoned
1388 without saving. For writing there must be matching |BufWriteCmd|,
1389 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001390
1391 *'casemap'* *'cmp'*
1392'casemap' 'cmp' string (default: "internal,keepascii")
1393 global
1394 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001395 {only available when compiled with the |+multi_byte|
1396 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001397 Specifies details about changing the case of letters. It may contain
1398 these words, separated by a comma:
1399 internal Use internal case mapping functions, the current
1400 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001401 matters when 'encoding' is a Unicode encoding,
1402 "latin1" or "iso-8859-15". When "internal" is
1403 omitted, the towupper() and towlower() system library
1404 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001405 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1406 case mapping, the current locale is not effective.
1407 This probably only matters for Turkish.
1408
1409 *'cdpath'* *'cd'* *E344* *E346*
1410'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1411 global
1412 {not in Vi}
1413 {not available when compiled without the
1414 |+file_in_path| feature}
1415 This is a list of directories which will be searched when using the
1416 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001417 for has a relative path, not an absolute part starting with "/", "./"
1418 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001419 The 'cdpath' option's value has the same form and semantics as
1420 |'path'|. Also see |file-searching|.
1421 The default value is taken from $CDPATH, with a "," prepended to look
1422 in the current directory first.
1423 If the default value taken from $CDPATH is not what you want, include
1424 a modified version of the following command in your vimrc file to
1425 override it: >
1426 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1427< This option cannot be set from a |modeline| or in the |sandbox|, for
1428 security reasons.
1429 (parts of 'cdpath' can be passed to the shell to expand file names).
1430
1431 *'cedit'*
1432'cedit' string (Vi default: "", Vim default: CTRL-F)
1433 global
1434 {not in Vi}
1435 {not available when compiled without the |+vertsplit|
1436 feature}
1437 The key used in Command-line Mode to open the command-line window.
1438 The default is CTRL-F when 'compatible' is off.
1439 Only non-printable keys are allowed.
1440 The key can be specified as a single character, but it is difficult to
1441 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001442 :exe "set cedit=\<C-Y>"
1443 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001444< |Nvi| also has this option, but it only uses the first character.
1445 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001446 NOTE: This option is set to the Vim default value when 'compatible'
1447 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001448
1449 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1450'charconvert' 'ccv' string (default "")
1451 global
1452 {only available when compiled with the |+multi_byte|
Bram Moolenaardb84e452010-08-15 13:50:43 +02001453 and |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001454 {not in Vi}
1455 An expression that is used for character encoding conversion. It is
1456 evaluated when a file that is to be read or has been written has a
1457 different encoding from what is desired.
1458 'charconvert' is not used when the internal iconv() function is
1459 supported and is able to do the conversion. Using iconv() is
1460 preferred, because it is much faster.
1461 'charconvert' is not used when reading stdin |--|, because there is no
1462 file to convert from. You will have to save the text in a file first.
1463 The expression must return zero or an empty string for success,
1464 non-zero for failure.
1465 The possible encoding names encountered are in 'encoding'.
1466 Additionally, names given in 'fileencodings' and 'fileencoding' are
1467 used.
1468 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1469 is done internally by Vim, 'charconvert' is not used for this.
1470 'charconvert' is also used to convert the viminfo file, if the 'c'
1471 flag is present in 'viminfo'. Also used for Unicode conversion.
1472 Example: >
1473 set charconvert=CharConvert()
1474 fun CharConvert()
1475 system("recode "
1476 \ . v:charconvert_from . ".." . v:charconvert_to
1477 \ . " <" . v:fname_in . " >" v:fname_out)
1478 return v:shell_error
1479 endfun
1480< The related Vim variables are:
1481 v:charconvert_from name of the current encoding
1482 v:charconvert_to name of the desired encoding
1483 v:fname_in name of the input file
1484 v:fname_out name of the output file
1485 Note that v:fname_in and v:fname_out will never be the same.
1486 Note that v:charconvert_from and v:charconvert_to may be different
1487 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1488 Encryption is not done by Vim when using 'charconvert'. If you want
1489 to encrypt the file after conversion, 'charconvert' should take care
1490 of this.
1491 This option cannot be set from a |modeline| or in the |sandbox|, for
1492 security reasons.
1493
1494 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1495'cindent' 'cin' boolean (default off)
1496 local to buffer
1497 {not in Vi}
1498 {not available when compiled without the |+cindent|
1499 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001500 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001501 that trigger reindenting in insert mode and 'cinoptions' to set your
1502 preferred indent style.
1503 If 'indentexpr' is not empty, it overrules 'cindent'.
1504 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1505 the "=" operator indents using this algorithm rather than calling an
1506 external program.
1507 See |C-indenting|.
1508 When you don't like the way 'cindent' works, try the 'smartindent'
1509 option or 'indentexpr'.
1510 This option is not used when 'paste' is set.
1511 NOTE: This option is reset when 'compatible' is set.
1512
1513 *'cinkeys'* *'cink'*
1514'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1515 local to buffer
1516 {not in Vi}
1517 {not available when compiled without the |+cindent|
1518 feature}
1519 A list of keys that, when typed in Insert mode, cause reindenting of
1520 the current line. Only used if 'cindent' is on and 'indentexpr' is
1521 empty.
1522 For the format of this option see |cinkeys-format|.
1523 See |C-indenting|.
1524
1525 *'cinoptions'* *'cino'*
1526'cinoptions' 'cino' string (default "")
1527 local to buffer
1528 {not in Vi}
1529 {not available when compiled without the |+cindent|
1530 feature}
1531 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1532 program. See |cinoptions-values| for the values of this option, and
1533 |C-indenting| for info on C indenting in general.
1534
1535
1536 *'cinwords'* *'cinw'*
1537'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1538 local to buffer
1539 {not in Vi}
1540 {not available when compiled without both the
1541 |+cindent| and the |+smartindent| features}
1542 These keywords start an extra indent in the next line when
1543 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1544 an appropriate place (inside {}).
1545 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1546 matter, include the keyword both the uppercase and lowercase:
1547 "if,If,IF".
1548
1549 *'clipboard'* *'cb'*
1550'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1551 for X-windows, "" otherwise)
1552 global
1553 {not in Vi}
1554 {only in GUI versions or when the |+xterm_clipboard|
1555 feature is included}
1556 This option is a list of comma separated names.
1557 These names are recognized:
1558
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001559 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001560 unnamed When included, Vim will use the clipboard register '*'
1561 for all yank, delete, change and put operations which
1562 would normally go to the unnamed register. When a
1563 register is explicitly specified, it will always be
1564 used regardless of whether "unnamed" is in 'clipboard'
1565 or not. The clipboard register can always be
1566 explicitly accessed using the "* notation. Also see
1567 |gui-clipboard|.
1568
Bram Moolenaar30b65812012-07-12 22:01:11 +02001569 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001570 unnamedplus A variant of the "unnamed" flag which uses the
1571 clipboard register '+' (|quoteplus|) instead of
1572 register '*' for all yank, delete, change and put
1573 operations which would normally go to the unnamed
1574 register. When "unnamed" is also included to the
1575 option, yank operations (but not delete, change or
1576 put) will additionally copy the text into register
1577 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001578 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001579 Availability can be checked with: >
1580 if has('unnamedplus')
1581<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001582 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001583 autoselect Works like the 'a' flag in 'guioptions': If present,
1584 then whenever Visual mode is started, or the Visual
1585 area extended, Vim tries to become the owner of the
1586 windowing system's global selection or put the
1587 selected text on the clipboard used by the selection
1588 register "*. See |guioptions_a| and |quotestar| for
1589 details. When the GUI is active, the 'a' flag in
1590 'guioptions' is used, when the GUI is not active, this
1591 "autoselect" flag is used.
1592 Also applies to the modeless selection.
1593
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001594 *clipboard-autoselectplus*
1595 autoselectplus Like "autoselect" but using the + register instead of
1596 the * register. Compare to the 'P' flag in
1597 'guioptions'.
1598
1599 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001600 autoselectml Like "autoselect", but for the modeless selection
1601 only. Compare to the 'A' flag in 'guioptions'.
1602
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001603 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001604 html When the clipboard contains HTML, use this when
1605 pasting. When putting text on the clipboard, mark it
1606 as HTML. This works to copy rendered HTML from
1607 Firefox, paste it as raw HTML in Vim, select the HTML
1608 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001609 You probably want to add this only temporarily,
1610 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001611 Only supported for GTK version 2 and later.
1612 Only available with the |+multi_byte| feature.
1613
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001614 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001615 exclude:{pattern}
1616 Defines a pattern that is matched against the name of
1617 the terminal 'term'. If there is a match, no
1618 connection will be made to the X server. This is
1619 useful in this situation:
1620 - Running Vim in a console.
1621 - $DISPLAY is set to start applications on another
1622 display.
1623 - You do not want to connect to the X server in the
1624 console, but do want this in a terminal emulator.
1625 To never connect to the X server use: >
1626 exclude:.*
1627< This has the same effect as using the |-X| argument.
1628 Note that when there is no connection to the X server
1629 the window title won't be restored and the clipboard
1630 cannot be accessed.
1631 The value of 'magic' is ignored, {pattern} is
1632 interpreted as if 'magic' was on.
1633 The rest of the option value will be used for
1634 {pattern}, this must be the last entry.
1635
1636 *'cmdheight'* *'ch'*
1637'cmdheight' 'ch' number (default 1)
1638 global
1639 {not in Vi}
1640 Number of screen lines to use for the command-line. Helps avoiding
1641 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001642 The value of this option is stored with the tab page, so that each tab
1643 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001644
1645 *'cmdwinheight'* *'cwh'*
1646'cmdwinheight' 'cwh' number (default 7)
1647 global
1648 {not in Vi}
1649 {not available when compiled without the |+vertsplit|
1650 feature}
1651 Number of screen lines to use for the command-line window. |cmdwin|
1652
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001653 *'colorcolumn'* *'cc'*
1654'colorcolumn' 'cc' string (default "")
1655 local to window
1656 {not in Vi}
1657 {not available when compiled without the |+syntax|
1658 feature}
1659 'colorcolumn' is a comma separated list of screen columns that are
1660 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1661 text. Will make screen redrawing slower.
1662 The screen column can be an absolute number, or a number preceded with
1663 '+' or '-', which is added to or subtracted from 'textwidth'. >
1664
1665 :set cc=+1 " highlight column after 'textwidth'
1666 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1667 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1668<
1669 When 'textwidth' is zero then the items with '-' and '+' are not used.
1670 A maximum of 256 columns are highlighted.
1671
Bram Moolenaar071d4272004-06-13 20:20:40 +00001672 *'columns'* *'co'* *E594*
1673'columns' 'co' number (default 80 or terminal width)
1674 global
1675 {not in Vi}
1676 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001677 initialization and does not have to be set by hand. Also see
1678 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001679 When Vim is running in the GUI or in a resizable window, setting this
1680 option will cause the window size to be changed. When you only want
1681 to use the size for the GUI, put the command in your |gvimrc| file.
1682 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001683 number of columns of the display, the display may be messed up. For
1684 the GUI it is always possible and Vim limits the number of columns to
1685 what fits on the screen. You can use this command to get the widest
1686 window possible: >
1687 :set columns=9999
1688< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001689
1690 *'comments'* *'com'* *E524* *E525*
1691'comments' 'com' string (default
1692 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1693 local to buffer
1694 {not in Vi}
1695 {not available when compiled without the |+comments|
1696 feature}
1697 A comma separated list of strings that can start a comment line. See
1698 |format-comments|. See |option-backslash| about using backslashes to
1699 insert a space.
1700
1701 *'commentstring'* *'cms'* *E537*
1702'commentstring' 'cms' string (default "/*%s*/")
1703 local to buffer
1704 {not in Vi}
1705 {not available when compiled without the |+folding|
1706 feature}
1707 A template for a comment. The "%s" in the value is replaced with the
1708 comment text. Currently only used to add markers for folding, see
1709 |fold-marker|.
1710
1711 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001712'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001713 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001714 global
1715 {not in Vi}
1716 This option has the effect of making Vim either more Vi-compatible, or
1717 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001718
Bram Moolenaar071d4272004-06-13 20:20:40 +00001719 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001720 other options are also changed as a side effect.
1721 NOTE: Setting or resetting this option can have a lot of unexpected
1722 effects: Mappings are interpreted in another way, undo behaves
1723 differently, etc. If you set this option in your vimrc file, you
1724 should probably put it at the very start.
1725
Bram Moolenaar071d4272004-06-13 20:20:40 +00001726 By default this option is on and the Vi defaults are used for the
1727 options. This default was chosen for those people who want to use Vim
1728 just like Vi, and don't even (want to) know about the 'compatible'
1729 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001730 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001731 this option is switched off, and all options that have not been
1732 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001733 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001734 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001735 happen for the system-wide vimrc or gvimrc file, nor for a file given
1736 with the |-u| argument). Also see |compatible-default| and
1737 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001738 You can also set this option with the "-C" argument, and reset it with
1739 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001740 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001741
Bram Moolenaar214641f2017-03-05 17:04:09 +01001742 When this option is set, numerous other options are set to make Vim as
1743 Vi-compatible as possible. When this option is unset, various options
1744 are set to make Vim more useful. The table below lists all the
1745 options affected.
1746 The {?} column indicates when the options are affected:
1747 + Means that the option is set to the value given in {set value} when
1748 'compatible' is set.
1749 & Means that the option is set to the value given in {set value} when
1750 'compatible' is set AND is set to its Vim default value when
1751 'compatible' is unset.
1752 - Means the option is NOT changed when setting 'compatible' but IS
1753 set to its Vim default when 'compatible' is unset.
1754 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001755
Bram Moolenaar036986f2017-03-16 17:41:02 +01001756 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001757
1758 'allowrevins' + off no CTRL-_ command
1759 'antialias' + off don't use antialiased fonts
1760 'arabic' + off reset arabic-related options
1761 'arabicshape' + on correct character shapes
1762 'backspace' + "" normal backspace
1763 'backup' + off no backup file
1764 'backupcopy' & Unix: "yes" backup file is a copy
1765 else: "auto" copy or rename backup file
1766 'balloonexpr' + "" text to show in evaluation balloon
1767 'breakindent' + off don't indent when wrapping lines
1768 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1769 'cindent' + off no C code indentation
1770 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1771 'copyindent' + off don't copy indent structure
1772 'cpoptions' & (all flags) Vi-compatible flags
1773 'cscopepathcomp'+ 0 don't show directories in tags list
1774 'cscoperelative'+ off
1775 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001776 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001777 'cscopeverbose' + off see |cscopeverbose|
1778 'delcombine' + off unicode: delete whole char combination
1779 'digraph' + off no digraphs
1780 'esckeys' & off no <Esc>-keys in Insert mode
1781 'expandtab' + off tabs not expanded to spaces
1782 'fileformats' & "" no automatic file format detection,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001783 "dos,unix" except for DOS, Windows and OS/2
Bram Moolenaar214641f2017-03-05 17:04:09 +01001784 'formatexpr' + "" use 'formatprg' for auto-formatting
1785 'formatoptions' & "vt" Vi compatible formatting
1786 'gdefault' + off no default 'g' flag for ":s"
1787 'history' & 0 no commandline history
1788 'hkmap' + off no Hebrew keyboard mapping
1789 'hkmapp' + off no phonetic Hebrew keyboard mapping
1790 'hlsearch' + off no highlighting of search matches
1791 'incsearch' + off no incremental searching
1792 'indentexpr' + "" no indenting by expression
1793 'insertmode' + off do not start in Insert mode
1794 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001795 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001796 'joinspaces' + on insert 2 spaces after period
1797 'modeline' & off no modelines
1798 'more' & off no pauses in listings
1799 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1800 'numberwidth' & 8 min number of columns for line number
1801 'preserveindent'+ off don't preserve current indent structure
1802 when changing it
1803 'revins' + off no reverse insert
1804 'ruler' + off no ruler
1805 'scrolljump' + 1 no jump scroll
1806 'scrolloff' + 0 no scroll offset
1807 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1808 'shiftround' + off indent not rounded to shiftwidth
1809 'shortmess' & "" no shortening of messages
1810 'showcmd' & off command characters not shown
1811 'showmode' & off current mode not shown
1812 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1813 'smartcase' + off no automatic ignore case switch
1814 'smartindent' + off no smart indentation
1815 'smarttab' + off no smart tab size
1816 'softtabstop' + 0 tabs are always 'tabstop' positions
1817 'startofline' + on goto startofline with some commands
1818 'tagcase' & "followic" 'ignorecase' when searching tags file
1819 'tagrelative' & off tag file names are not relative
1820 'termguicolors' + off don't use highlight-(guifg|guibg)
1821 'textauto' & off no automatic textmode detection
1822 'textwidth' + 0 no automatic line wrap
1823 'tildeop' + off tilde is not an operator
1824 'ttimeout' + off no terminal timeout
1825 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001826 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001827 'virtualedit' + "" cursor can only be placed on characters
1828 'whichwrap' & "" left-right movements don't wrap
1829 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001830 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001831 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001832
1833 *'complete'* *'cpt'* *E535*
1834'complete' 'cpt' string (default: ".,w,b,u,t,i")
1835 local to buffer
1836 {not in Vi}
1837 This option specifies how keyword completion |ins-completion| works
1838 when CTRL-P or CTRL-N are used. It is also used for whole-line
1839 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1840 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001841 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001842 w scan buffers from other windows
1843 b scan other loaded buffers that are in the buffer list
1844 u scan the unloaded buffers that are in the buffer list
1845 U scan the buffers that are not in the buffer list
1846 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001847 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001848 k{dict} scan the file {dict}. Several "k" flags can be given,
1849 patterns are valid too. For example: >
1850 :set cpt=k/usr/dict/*,k~/spanish
1851< s scan the files given with the 'thesaurus' option
1852 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1853 are valid too.
1854 i scan current and included files
1855 d scan current and included files for defined name or macro
1856 |i_CTRL-X_CTRL-D|
1857 ] tag completion
1858 t same as "]"
1859
1860 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1861 not executed, this may lead to unexpected completions from some files
1862 (gzipped files for example). Unloaded buffers are not scanned for
1863 whole-line completion.
1864
1865 The default is ".,w,b,u,t,i", which means to scan:
1866 1. the current buffer
1867 2. buffers in other windows
1868 3. other loaded buffers
1869 4. unloaded buffers
1870 5. tags
1871 6. included files
1872
1873 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001874 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1875 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001876
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001877 *'completefunc'* *'cfu'*
1878'completefunc' 'cfu' string (default: empty)
1879 local to buffer
1880 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001881 {not available when compiled without the |+eval|
1882 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001883 This option specifies a function to be used for Insert mode completion
1884 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001885 See |complete-functions| for an explanation of how the function is
1886 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001887 This option cannot be set from a |modeline| or in the |sandbox|, for
1888 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001889
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001890 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001891'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001892 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001893 {not available when compiled without the
1894 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001895 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001896 A comma separated list of options for Insert mode completion
1897 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001898
1899 menu Use a popup menu to show the possible completions. The
1900 menu is only shown when there is more than one match and
1901 sufficient colors are available. |ins-completion-menu|
1902
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001903 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001904 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001905 match, e.g., what file it comes from.
1906
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001907 longest Only insert the longest common text of the matches. If
1908 the menu is displayed you can use CTRL-L to add more
1909 characters. Whether case is ignored depends on the kind
1910 of completion. For buffer text the 'ignorecase' option is
1911 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001912
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001913 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001914 completion in the preview window. Only works in
1915 combination with "menu" or "menuone".
1916
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001917 noinsert Do not insert any text for a match until the user selects
1918 a match from the menu. Only works in combination with
1919 "menu" or "menuone". No effect if "longest" is present.
1920
1921 noselect Do not select a match in the menu, force the user to
1922 select one from the menu. Only works in combination with
1923 "menu" or "menuone".
1924
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001925
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001926 *'concealcursor'* *'cocu'*
1927'concealcursor' 'cocu' string (default: "")
1928 local to window
1929 {not in Vi}
1930 {not available when compiled without the |+conceal|
1931 feature}
1932 Sets the modes in which text in the cursor line can also be concealed.
1933 When the current mode is listed then concealing happens just like in
1934 other lines.
1935 n Normal mode
1936 v Visual mode
1937 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001938 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001939
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001940 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001941 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001942 are moving around text is concealed, but when starting to insert text
1943 or selecting a Visual area the concealed text is displayed, so that
1944 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001945 Keep in mind that the cursor position is not always where it's
1946 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001947
1948
1949'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001950 number (default 0)
1951 local to window
1952 {not in Vi}
1953 {not available when compiled without the |+conceal|
1954 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001955 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1956 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001957
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001958 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001959 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001960 1 Each block of concealed text is replaced with one
1961 character. If the syntax item does not have a custom
1962 replacement character defined (see |:syn-cchar|) the
1963 character defined in 'listchars' is used (default is a
1964 space).
1965 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001966 2 Concealed text is completely hidden unless it has a
1967 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001968 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001969 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001970
Bram Moolenaara7781e02010-07-19 20:13:22 +02001971 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001972 edit and copy the text. This can be changed with the 'concealcursor'
1973 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001974
Bram Moolenaar071d4272004-06-13 20:20:40 +00001975 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1976'confirm' 'cf' boolean (default off)
1977 global
1978 {not in Vi}
1979 When 'confirm' is on, certain operations that would normally
1980 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1981 instead raise a |dialog| asking if you wish to save the current
1982 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1983 If 'confirm' is off you can still activate confirmation for one
1984 command only (this is most useful in mappings) with the |:confirm|
1985 command.
1986 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1987
1988 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1989'conskey' 'consk' boolean (default off)
1990 global
1991 {not in Vi} {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001992 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001993
1994 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1995'copyindent' 'ci' boolean (default off)
1996 local to buffer
1997 {not in Vi}
1998 Copy the structure of the existing lines indent when autoindenting a
1999 new line. Normally the new indent is reconstructed by a series of
2000 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2001 in which case only spaces are used). Enabling this option makes the
2002 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002003 existing line. 'expandtab' has no effect on these characters, a Tab
2004 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002005 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002006 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002007 Also see 'preserveindent'.
2008
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002009 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002010'cpoptions' 'cpo' string (Vim default: "aABceFs",
2011 Vi default: all flags)
2012 global
2013 {not in Vi}
2014 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002015 this indicates Vi-compatible behavior. This is used for things where
2016 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002017 'cpoptions' stands for "compatible-options".
2018 Commas can be added for readability.
2019 To avoid problems with flags that are added in the future, use the
2020 "+=" and "-=" feature of ":set" |add-option-flags|.
2021 NOTE: This option is set to the Vi default value when 'compatible' is
2022 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002023 NOTE: This option is set to the POSIX default value at startup when
2024 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002025 variable exists |posix|. This means Vim tries to behave like the
2026 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002027
2028 contains behavior ~
2029 *cpo-a*
2030 a When included, a ":read" command with a file name
2031 argument will set the alternate file name for the
2032 current window.
2033 *cpo-A*
2034 A When included, a ":write" command with a file name
2035 argument will set the alternate file name for the
2036 current window.
2037 *cpo-b*
2038 b "\|" in a ":map" command is recognized as the end of
2039 the map command. The '\' is included in the mapping,
2040 the text after the '|' is interpreted as the next
2041 command. Use a CTRL-V instead of a backslash to
2042 include the '|' in the mapping. Applies to all
2043 mapping, abbreviation, menu and autocmd commands.
2044 See also |map_bar|.
2045 *cpo-B*
2046 B A backslash has no special meaning in mappings,
2047 abbreviations and the "to" part of the menu commands.
2048 Remove this flag to be able to use a backslash like a
2049 CTRL-V. For example, the command ":map X \<Esc>"
2050 results in X being mapped to:
2051 'B' included: "\^[" (^[ is a real <Esc>)
2052 'B' excluded: "<Esc>" (5 characters)
2053 ('<' excluded in both cases)
2054 *cpo-c*
2055 c Searching continues at the end of any match at the
2056 cursor position, but not further than the start of the
2057 next line. When not present searching continues
2058 one character from the cursor position. With 'c'
2059 "abababababab" only gets three matches when repeating
2060 "/abab", without 'c' there are five matches.
2061 *cpo-C*
2062 C Do not concatenate sourced lines that start with a
2063 backslash. See |line-continuation|.
2064 *cpo-d*
2065 d Using "./" in the 'tags' option doesn't mean to use
2066 the tags file relative to the current file, but the
2067 tags file in the current directory.
2068 *cpo-D*
2069 D Can't use CTRL-K to enter a digraph after Normal mode
2070 commands with a character argument, like |r|, |f| and
2071 |t|.
2072 *cpo-e*
2073 e When executing a register with ":@r", always add a
2074 <CR> to the last line, also when the register is not
2075 linewise. If this flag is not present, the register
2076 is not linewise and the last line does not end in a
2077 <CR>, then the last line is put on the command-line
2078 and can be edited before hitting <CR>.
2079 *cpo-E*
2080 E It is an error when using "y", "d", "c", "g~", "gu" or
2081 "gU" on an Empty region. The operators only work when
2082 at least one character is to be operate on. Example:
2083 This makes "y0" fail in the first column.
2084 *cpo-f*
2085 f When included, a ":read" command with a file name
2086 argument will set the file name for the current buffer,
2087 if the current buffer doesn't have a file name yet.
2088 *cpo-F*
2089 F When included, a ":write" command with a file name
2090 argument will set the file name for the current
2091 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002092 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002093 *cpo-g*
2094 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002095 *cpo-H*
2096 H When using "I" on a line with only blanks, insert
2097 before the last blank. Without this flag insert after
2098 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002099 *cpo-i*
2100 i When included, interrupting the reading of a file will
2101 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002102 *cpo-I*
2103 I When moving the cursor up or down just after inserting
2104 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002105 *cpo-j*
2106 j When joining lines, only add two spaces after a '.',
2107 not after '!' or '?'. Also see 'joinspaces'.
2108 *cpo-J*
2109 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002110 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002111 white space.
2112 *cpo-k*
2113 k Disable the recognition of raw key codes in
2114 mappings, abbreviations, and the "to" part of menu
2115 commands. For example, if <Key> sends ^[OA (where ^[
2116 is <Esc>), the command ":map X ^[OA" results in X
2117 being mapped to:
2118 'k' included: "^[OA" (3 characters)
2119 'k' excluded: "<Key>" (one key code)
2120 Also see the '<' flag below.
2121 *cpo-K*
2122 K Don't wait for a key code to complete when it is
2123 halfway a mapping. This breaks mapping <F1><F1> when
2124 only part of the second <F1> has been read. It
2125 enables cancelling the mapping by typing <F1><Esc>.
2126 *cpo-l*
2127 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002128 literally, only "\]", "\^", "\-" and "\\" are special.
2129 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002130 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2131 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002132 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002133 *cpo-L*
2134 L When the 'list' option is set, 'wrapmargin',
2135 'textwidth', 'softtabstop' and Virtual Replace mode
2136 (see |gR|) count a <Tab> as two characters, instead of
2137 the normal behavior of a <Tab>.
2138 *cpo-m*
2139 m When included, a showmatch will always wait half a
2140 second. When not included, a showmatch will wait half
2141 a second or until a character is typed. |'showmatch'|
2142 *cpo-M*
2143 M When excluded, "%" matching will take backslashes into
2144 account. Thus in "( \( )" and "\( ( \)" the outer
2145 parenthesis match. When included "%" ignores
2146 backslashes, which is Vi compatible.
2147 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002148 n When included, the column used for 'number' and
2149 'relativenumber' will also be used for text of wrapped
2150 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002151 *cpo-o*
2152 o Line offset to search command is not remembered for
2153 next search.
2154 *cpo-O*
2155 O Don't complain if a file is being overwritten, even
2156 when it didn't exist when editing it. This is a
2157 protection against a file unexpectedly created by
2158 someone else. Vi didn't complain about this.
2159 *cpo-p*
2160 p Vi compatible Lisp indenting. When not present, a
2161 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002162 *cpo-P*
2163 P When included, a ":write" command that appends to a
2164 file will set the file name for the current buffer, if
2165 the current buffer doesn't have a file name yet and
2166 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002167 *cpo-q*
2168 q When joining multiple lines leave the cursor at the
2169 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002170 *cpo-r*
2171 r Redo ("." command) uses "/" to repeat a search
2172 command, instead of the actually used search string.
2173 *cpo-R*
2174 R Remove marks from filtered lines. Without this flag
2175 marks are kept like |:keepmarks| was used.
2176 *cpo-s*
2177 s Set buffer options when entering the buffer for the
2178 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002179 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002180 set when the buffer is created.
2181 *cpo-S*
2182 S Set buffer options always when entering a buffer
2183 (except 'readonly', 'fileformat', 'filetype' and
2184 'syntax'). This is the (most) Vi compatible setting.
2185 The options are set to the values in the current
2186 buffer. When you change an option and go to another
2187 buffer, the value is copied. Effectively makes the
2188 buffer options global to all buffers.
2189
2190 's' 'S' copy buffer options
2191 no no when buffer created
2192 yes no when buffer first entered (default)
2193 X yes each time when buffer entered (vi comp.)
2194 *cpo-t*
2195 t Search pattern for the tag command is remembered for
2196 "n" command. Otherwise Vim only puts the pattern in
2197 the history for search pattern, but doesn't change the
2198 last used search pattern.
2199 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002200 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002201 *cpo-v*
2202 v Backspaced characters remain visible on the screen in
2203 Insert mode. Without this flag the characters are
2204 erased from the screen right away. With this flag the
2205 screen newly typed text overwrites backspaced
2206 characters.
2207 *cpo-w*
2208 w When using "cw" on a blank character, only change one
2209 character and not all blanks until the start of the
2210 next word.
2211 *cpo-W*
2212 W Don't overwrite a readonly file. When omitted, ":w!"
2213 overwrites a readonly file, if possible.
2214 *cpo-x*
2215 x <Esc> on the command-line executes the command-line.
2216 The default in Vim is to abandon the command-line,
2217 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002218 *cpo-X*
2219 X When using a count with "R" the replaced text is
2220 deleted only once. Also when repeating "R" with "."
2221 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002222 *cpo-y*
2223 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002224 *cpo-Z*
2225 Z When using "w!" while the 'readonly' option is set,
2226 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002227 *cpo-!*
2228 ! When redoing a filter command, use the last used
2229 external command, whatever it was. Otherwise the last
2230 used -filter- command is used.
2231 *cpo-$*
2232 $ When making a change to one line, don't redisplay the
2233 line, but put a '$' at the end of the changed text.
2234 The changed text will be overwritten when you type the
2235 new text. The line is redisplayed if you type any
2236 command that moves the cursor from the insertion
2237 point.
2238 *cpo-%*
2239 % Vi-compatible matching is done for the "%" command.
2240 Does not recognize "#if", "#endif", etc.
2241 Does not recognize "/*" and "*/".
2242 Parens inside single and double quotes are also
2243 counted, causing a string that contains a paren to
2244 disturb the matching. For example, in a line like
2245 "if (strcmp("foo(", s))" the first paren does not
2246 match the last one. When this flag is not included,
2247 parens inside single and double quotes are treated
2248 specially. When matching a paren outside of quotes,
2249 everything inside quotes is ignored. When matching a
2250 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002251 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002252 This flag is also used for other features, such as
2253 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002254 *cpo--*
2255 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002256 it would go above the first line or below the last
2257 line. Without it the cursor moves to the first or
2258 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002259 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002260 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002261 *cpo-+*
2262 + When included, a ":write file" command will reset the
2263 'modified' flag of the buffer, even though the buffer
2264 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002265 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002266 * Use ":*" in the same way as ":@". When not included,
2267 ":*" is an alias for ":'<,'>", select the Visual area.
2268 *cpo-<*
2269 < Disable the recognition of special key codes in |<>|
2270 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002271 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002272 ":map X <Tab>" results in X being mapped to:
2273 '<' included: "<Tab>" (5 characters)
2274 '<' excluded: "^I" (^I is a real <Tab>)
2275 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002276 *cpo->*
2277 > When appending to a register, put a line break before
2278 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002279 *cpo-;*
2280 ; When using |,| or |;| to repeat the last |t| search
2281 and the cursor is right in front of the searched
2282 character, the cursor won't move. When not included,
2283 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002284 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002285
2286 POSIX flags. These are not included in the Vi default value, except
2287 when $VIM_POSIX was set on startup. |posix|
2288
2289 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002290 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002291 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002292 *cpo-&*
2293 & When ":preserve" was used keep the swap file when
2294 exiting normally while this buffer is still loaded.
2295 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002296 *cpo-\*
2297 \ Backslash in a [] range in a search pattern is taken
2298 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002299 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2300 '\' excluded: "/[ \-]" finds <Space> and '-'
2301 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002302 *cpo-/*
2303 / When "%" is used as the replacement string in a |:s|
2304 command, use the previous replacement string. |:s%|
2305 *cpo-{*
2306 { The |{| and |}| commands also stop at a "{" character
2307 at the start of a line.
2308 *cpo-.*
2309 . The ":chdir" and ":cd" commands fail if the current
2310 buffer is modified, unless ! is used. Vim doesn't
2311 need this, since it remembers the full path of an
2312 opened file.
2313 *cpo-bar*
2314 | The value of the $LINES and $COLUMNS environment
2315 variables overrule the terminal size values obtained
2316 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002317
Bram Moolenaar071d4272004-06-13 20:20:40 +00002318
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002319 *'cryptmethod'* *'cm'*
Bram Moolenaar32efaf62014-11-05 17:02:17 +01002320'cryptmethod' 'cm' string (default "zip")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002321 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002322 {not in Vi}
2323 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002324 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002325 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002326 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002327 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002328 blowfish Blowfish method. Medium strong encryption but it has
2329 an implementation flaw. Requires Vim 7.3 or later,
2330 files can NOT be read by Vim 7.2 and older. This adds
2331 a "seed" to the file, every time you write the file
2332 the encrypted bytes will be different.
2333 *blowfish2*
2334 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002335 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002336 and older. This adds a "seed" to the file, every time
2337 you write the file the encrypted bytes will be
2338 different. The whole undo file is encrypted, not just
2339 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002340
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002341 You should use "blowfish2", also to re-encrypt older files.
2342
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002343 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002344 to the detected method of the file being read. Thus if you write it
2345 without changing 'cryptmethod' the same method will be used.
2346 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002347 explicitly write it, you don't get a warning unless there are other
2348 modifications. Also see |:X|.
2349
2350 When setting the global value to an empty string, it will end up with
2351 the value "zip". When setting the local value to an empty string the
2352 buffer will use the global value.
2353
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002354 When a new encryption method is added in a later version of Vim, and
2355 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002356 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002357
2358
Bram Moolenaar071d4272004-06-13 20:20:40 +00002359 *'cscopepathcomp'* *'cspc'*
2360'cscopepathcomp' 'cspc' number (default 0)
2361 global
2362 {not available when compiled without the |+cscope|
2363 feature}
2364 {not in Vi}
2365 Determines how many components of the path to show in a list of tags.
2366 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002367 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002368
2369 *'cscopeprg'* *'csprg'*
2370'cscopeprg' 'csprg' string (default "cscope")
2371 global
2372 {not available when compiled without the |+cscope|
2373 feature}
2374 {not in Vi}
2375 Specifies the command to execute cscope. See |cscopeprg|.
2376 This option cannot be set from a |modeline| or in the |sandbox|, for
2377 security reasons.
2378
2379 *'cscopequickfix'* *'csqf'*
2380'cscopequickfix' 'csqf' string (default "")
2381 global
2382 {not available when compiled without the |+cscope|
2383 or |+quickfix| features}
2384 {not in Vi}
2385 Specifies whether to use quickfix window to show cscope results.
2386 See |cscopequickfix|.
2387
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002388 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002389'cscoperelative' 'csre' boolean (default off)
2390 global
2391 {not available when compiled without the |+cscope|
2392 feature}
2393 {not in Vi}
2394 In the absence of a prefix (-P) for cscope. setting this option enables
2395 to use the basename of cscope.out path as the prefix.
2396 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002397 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002398
Bram Moolenaar071d4272004-06-13 20:20:40 +00002399 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2400'cscopetag' 'cst' boolean (default off)
2401 global
2402 {not available when compiled without the |+cscope|
2403 feature}
2404 {not in Vi}
2405 Use cscope for tag commands. See |cscope-options|.
2406 NOTE: This option is reset when 'compatible' is set.
2407
2408 *'cscopetagorder'* *'csto'*
2409'cscopetagorder' 'csto' number (default 0)
2410 global
2411 {not available when compiled without the |+cscope|
2412 feature}
2413 {not in Vi}
2414 Determines the order in which ":cstag" performs a search. See
2415 |cscopetagorder|.
2416 NOTE: This option is set to 0 when 'compatible' is set.
2417
2418 *'cscopeverbose'* *'csverb'*
2419 *'nocscopeverbose'* *'nocsverb'*
2420'cscopeverbose' 'csverb' boolean (default off)
2421 global
2422 {not available when compiled without the |+cscope|
2423 feature}
2424 {not in Vi}
2425 Give messages when adding a cscope database. See |cscopeverbose|.
2426 NOTE: This option is reset when 'compatible' is set.
2427
Bram Moolenaar860cae12010-06-05 23:22:07 +02002428 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2429'cursorbind' 'crb' boolean (default off)
2430 local to window
2431 {not in Vi}
2432 {not available when compiled without the |+cursorbind|
2433 feature}
2434 When this option is set, as the cursor in the current
2435 window moves other cursorbound windows (windows that also have
2436 this option set) move their cursors to the corresponding line and
2437 column. This option is useful for viewing the
2438 differences between two versions of a file (see 'diff'); in diff mode,
2439 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002440 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002441
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002442
2443 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2444'cursorcolumn' 'cuc' boolean (default off)
2445 local to window
2446 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002447 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002448 feature}
2449 Highlight the screen column of the cursor with CursorColumn
2450 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2451 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002452 If you only want the highlighting in the current window you can use
2453 these autocommands: >
2454 au WinLeave * set nocursorline nocursorcolumn
2455 au WinEnter * set cursorline cursorcolumn
2456<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002457
2458 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2459'cursorline' 'cul' boolean (default off)
2460 local to window
2461 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002462 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002463 feature}
2464 Highlight the screen line of the cursor with CursorLine
2465 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2466 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002467 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002468 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002469
2470
Bram Moolenaar071d4272004-06-13 20:20:40 +00002471 *'debug'*
2472'debug' string (default "")
2473 global
2474 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002475 These values can be used:
2476 msg Error messages that would otherwise be omitted will be given
2477 anyway.
2478 throw Error messages that would otherwise be omitted will be given
2479 anyway and also throw an exception and set |v:errmsg|.
2480 beep A message will be given when otherwise only a beep would be
2481 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002482 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002483 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2484 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002485
2486 *'define'* *'def'*
2487'define' 'def' string (default "^\s*#\s*define")
2488 global or local to buffer |global-local|
2489 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002490 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002491 pattern, just like for the "/" command. This option is used for the
2492 commands like "[i" and "[d" |include-search|. The 'isident' option is
2493 used to recognize the defined name after the match:
2494 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2495 See |option-backslash| about inserting backslashes to include a space
2496 or backslash.
2497 The default value is for C programs. For C++ this value would be
2498 useful, to include const type declarations: >
2499 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2500< When using the ":set" command, you need to double the backslashes!
2501
2502 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2503'delcombine' 'deco' boolean (default off)
2504 global
2505 {not in Vi}
2506 {only available when compiled with the |+multi_byte|
2507 feature}
2508 If editing Unicode and this option is set, backspace and Normal mode
2509 "x" delete each combining character on its own. When it is off (the
2510 default) the character along with its combining characters are
2511 deleted.
2512 Note: When 'delcombine' is set "xx" may work different from "2x"!
2513
2514 This is useful for Arabic, Hebrew and many other languages where one
2515 may have combining characters overtop of base characters, and want
2516 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002517 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002518
2519 *'dictionary'* *'dict'*
2520'dictionary' 'dict' string (default "")
2521 global or local to buffer |global-local|
2522 {not in Vi}
2523 List of file names, separated by commas, that are used to lookup words
2524 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2525 contain a list of words. This can be one word per line, or several
2526 words per line, separated by non-keyword characters (white space is
2527 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002528 When this option is empty, or an entry "spell" is present, spell
2529 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002530 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002531 after a comma are ignored, otherwise spaces are included in the file
2532 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002533 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002534 Where to find a list of words?
2535 - On FreeBSD, there is the file "/usr/share/dict/words".
2536 - In the Simtel archive, look in the "msdos/linguist" directory.
2537 - In "miscfiles" of the GNU collection.
2538 The use of |:set+=| and |:set-=| is preferred when adding or removing
2539 directories from the list. This avoids problems when a future version
2540 uses another default.
2541 Backticks cannot be used in this option for security reasons.
2542
2543 *'diff'* *'nodiff'*
2544'diff' boolean (default off)
2545 local to window
2546 {not in Vi}
2547 {not available when compiled without the |+diff|
2548 feature}
2549 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002550 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002551
2552 *'dex'* *'diffexpr'*
2553'diffexpr' 'dex' string (default "")
2554 global
2555 {not in Vi}
2556 {not available when compiled without the |+diff|
2557 feature}
2558 Expression which is evaluated to obtain an ed-style diff file from two
2559 versions of a file. See |diff-diffexpr|.
2560 This option cannot be set from a |modeline| or in the |sandbox|, for
2561 security reasons.
2562
2563 *'dip'* *'diffopt'*
2564'diffopt' 'dip' string (default "filler")
2565 global
2566 {not in Vi}
2567 {not available when compiled without the |+diff|
2568 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002569 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002570 All are optional. Items must be separated by a comma.
2571
2572 filler Show filler lines, to keep the text
2573 synchronized with a window that has inserted
2574 lines at the same position. Mostly useful
2575 when windows are side-by-side and 'scrollbind'
2576 is set.
2577
2578 context:{n} Use a context of {n} lines between a change
2579 and a fold that contains unchanged lines.
2580 When omitted a context of six lines is used.
2581 See |fold-diff|.
2582
2583 icase Ignore changes in case of text. "a" and "A"
2584 are considered the same. Adds the "-i" flag
2585 to the "diff" command if 'diffexpr' is empty.
2586
2587 iwhite Ignore changes in amount of white space. Adds
2588 the "-b" flag to the "diff" command if
2589 'diffexpr' is empty. Check the documentation
2590 of the "diff" command for what this does
2591 exactly. It should ignore adding trailing
2592 white space, but not leading white space.
2593
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002594 horizontal Start diff mode with horizontal splits (unless
2595 explicitly specified otherwise).
2596
2597 vertical Start diff mode with vertical splits (unless
2598 explicitly specified otherwise).
2599
2600 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2601 starting diff mode. Without this 2 is used.
2602
Bram Moolenaar071d4272004-06-13 20:20:40 +00002603 Examples: >
2604
2605 :set diffopt=filler,context:4
2606 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002607 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002608<
2609 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2610'digraph' 'dg' boolean (default off)
2611 global
2612 {not in Vi}
2613 {not available when compiled without the |+digraphs|
2614 feature}
2615 Enable the entering of digraphs in Insert mode with {char1} <BS>
2616 {char2}. See |digraphs|.
2617 NOTE: This option is reset when 'compatible' is set.
2618
2619 *'directory'* *'dir'*
2620'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01002621 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002622 for Unix: ".,~/tmp,/var/tmp,/tmp")
2623 global
2624 List of directory names for the swap file, separated with commas.
2625 - The swap file will be created in the first directory where this is
2626 possible.
2627 - Empty means that no swap file will be used (recovery is
2628 impossible!).
2629 - A directory "." means to put the swap file in the same directory as
2630 the edited file. On Unix, a dot is prepended to the file name, so
2631 it doesn't show in a directory listing. On MS-Windows the "hidden"
2632 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002633 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002634 put the swap file relative to where the edited file is. The leading
2635 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002636 - For Unix and Win32, if a directory ends in two path separators "//"
2637 or "\\", the swap file name will be built from the complete path to
2638 the file with all path separators substituted to percent '%' signs.
2639 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002640 On Win32, when a separating comma is following, you must use "//",
2641 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002642 - Spaces after the comma are ignored, other spaces are considered part
2643 of the directory name. To have a space at the start of a directory
2644 name, precede it with a backslash.
2645 - To include a comma in a directory name precede it with a backslash.
2646 - A directory name may end in an ':' or '/'.
2647 - Environment variables are expanded |:set_env|.
2648 - Careful with '\' characters, type one before a space, type two to
2649 get one in the option (see |option-backslash|), for example: >
2650 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2651< - For backwards compatibility with Vim version 3.0 a '>' at the start
2652 of the option is removed.
2653 Using "." first in the list is recommended. This means that editing
2654 the same file twice will result in a warning. Using "/tmp" on Unix is
2655 discouraged: When the system crashes you lose the swap file.
2656 "/var/tmp" is often not cleared when rebooting, thus is a better
2657 choice than "/tmp". But it can contain a lot of files, your swap
2658 files get lost in the crowd. That is why a "tmp" directory in your
2659 home directory is tried first.
2660 The use of |:set+=| and |:set-=| is preferred when adding or removing
2661 directories from the list. This avoids problems when a future version
2662 uses another default.
2663 This option cannot be set from a |modeline| or in the |sandbox|, for
2664 security reasons.
2665 {Vi: directory to put temp file in, defaults to "/tmp"}
2666
2667 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002668'display' 'dy' string (default "", set to "truncate" in
2669 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002670 global
2671 {not in Vi}
2672 Change the way text is displayed. This is comma separated list of
2673 flags:
2674 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002675 in a window will be displayed. "@@@" is put in the
2676 last columns of the last screen line to indicate the
2677 rest of the line is not displayed.
2678 truncate Like "lastline", but "@@@" is displayed in the first
2679 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002680 uhex Show unprintable characters hexadecimal as <xx>
2681 instead of using ^C and ~C.
2682
Bram Moolenaard0796902016-09-16 20:02:31 +02002683 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002684 doesn't fit is replaced with "@" lines.
2685
Bram Moolenaar071d4272004-06-13 20:20:40 +00002686 *'eadirection'* *'ead'*
2687'eadirection' 'ead' string (default "both")
2688 global
2689 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002690 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002691 feature}
2692 Tells when the 'equalalways' option applies:
2693 ver vertically, width of windows is not affected
2694 hor horizontally, height of windows is not affected
2695 both width and height of windows is affected
2696
2697 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2698'edcompatible' 'ed' boolean (default off)
2699 global
2700 Makes the 'g' and 'c' flags of the ":substitute" command to be
2701 toggled each time the flag is given. See |complex-change|. See
2702 also 'gdefault' option.
2703 Switching this option on is discouraged!
2704
Bram Moolenaar03413f42016-04-12 21:07:15 +02002705 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002706'emoji' 'emo' boolean (default: on)
2707 global
2708 {not in Vi}
2709 {only available when compiled with the |+multi_byte|
2710 feature}
2711 When on all Unicode emoji characters are considered to be full width.
2712
2713
Bram Moolenaar071d4272004-06-13 20:20:40 +00002714 *'encoding'* *'enc'* *E543*
2715'encoding' 'enc' string (default: "latin1" or value from $LANG)
2716 global
2717 {only available when compiled with the |+multi_byte|
2718 feature}
2719 {not in Vi}
2720 Sets the character encoding used inside Vim. It applies to text in
2721 the buffers, registers, Strings in expressions, text stored in the
2722 viminfo file, etc. It sets the kind of characters which Vim can work
2723 with. See |encoding-names| for the possible values.
2724
2725 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002726 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002727 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002728 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002729
Bram Moolenaar865242e2010-07-14 21:12:05 +02002730 This option cannot be set from a |modeline|. It would most likely
2731 corrupt the text.
2732
Bram Moolenaar3df01732017-02-17 22:47:16 +01002733 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2734 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002735 'encoding', "utf-8" is the natural choice for the environment and
2736 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002737 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002738 versions, and to avoid changing the encoding of newly created files
2739 without your knowledge (in case 'fileencodings' is empty).
2740
2741 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002742 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002743 iconv() or as specified with 'charconvert'.
2744
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002745 If you need to know whether 'encoding' is a multi-byte encoding, you
2746 can use: >
2747 if has("multi_byte_encoding")
2748<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002749 Normally 'encoding' will be equal to your current locale. This will
2750 be the default if Vim recognizes your environment settings. If
2751 'encoding' is not set to the current locale, 'termencoding' must be
2752 set to convert typed and displayed text. See |encoding-table|.
2753
2754 When you set this option, it fires the |EncodingChanged| autocommand
2755 event so that you can set up fonts if necessary.
2756
2757 When the option is set, the value is converted to lowercase. Thus
2758 you can set it with uppercase values too. Underscores are translated
2759 to '-' signs.
2760 When the encoding is recognized, it is changed to the standard name.
2761 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2762 "iso-8859-2" and "utf8" becomes "utf-8".
2763
2764 Note: "latin1" is also used when the encoding could not be detected.
2765 This only works when editing files in the same encoding! When the
2766 actual character set is not latin1, make sure 'fileencoding' and
2767 'fileencodings' are empty. When conversion is needed, switch to using
2768 utf-8.
2769
2770 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2771 You don't notice this while editing, but it does matter for the
2772 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2773 setting 'encoding' to one of these values instead of utf-8 only has
2774 effect for encoding used for files when 'fileencoding' is empty.
2775
Bram Moolenaar661b1822005-07-28 22:36:45 +00002776 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2777 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002778
2779 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2780'endofline' 'eol' boolean (default on)
2781 local to buffer
2782 {not in Vi}
2783 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002784 is on, or 'fixeol' option is off, no <EOL> will be written for the
2785 last line in the file. This option is automatically set or reset when
2786 starting to edit a new file, depending on whether file has an <EOL>
2787 for the last line in the file. Normally you don't have to set or
2788 reset this option.
2789 When 'binary' is off and 'fixeol' is on the value is not used when
2790 writing the file. When 'binary' is on or 'fixeol' is off it is used
2791 to remember the presence of a <EOL> for the last line in the file, so
2792 that when you write the file the situation from the original file can
2793 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002794
2795 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2796'equalalways' 'ea' boolean (default on)
2797 global
2798 {not in Vi}
2799 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002800 splitting or closing a window. This also happens the moment the
2801 option is switched on. When off, splitting a window will reduce the
2802 size of the current window and leave the other windows the same. When
2803 closing a window the extra lines are given to the window next to it
2804 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002805 When mixing vertically and horizontally split windows, a minimal size
2806 is computed and some windows may be larger if there is room. The
2807 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002808 Changing the height and width of a window can be avoided by setting
2809 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002810 If a window size is specified when creating a new window sizes are
2811 currently not equalized (it's complicated, but may be implemented in
2812 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002813
2814 *'equalprg'* *'ep'*
2815'equalprg' 'ep' string (default "")
2816 global or local to buffer |global-local|
2817 {not in Vi}
2818 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002819 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002820 or 'indentexpr'. When Vim was compiled without internal formatting,
2821 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002822 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002823 about including spaces and backslashes.
2824 This option cannot be set from a |modeline| or in the |sandbox|, for
2825 security reasons.
2826
2827 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2828'errorbells' 'eb' boolean (default off)
2829 global
2830 Ring the bell (beep or screen flash) for error messages. This only
2831 makes a difference for error messages, the bell will be used always
2832 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002833 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002834 screen flash or do nothing. See 'belloff' to finetune when to ring the
2835 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002836
2837 *'errorfile'* *'ef'*
2838'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2839 others: "errors.err")
2840 global
2841 {not in Vi}
2842 {not available when compiled without the |+quickfix|
2843 feature}
2844 Name of the errorfile for the QuickFix mode (see |:cf|).
2845 When the "-q" command-line argument is used, 'errorfile' is set to the
2846 following argument. See |-q|.
2847 NOT used for the ":make" command. See 'makeef' for that.
2848 Environment variables are expanded |:set_env|.
2849 See |option-backslash| about including spaces and backslashes.
2850 This option cannot be set from a |modeline| or in the |sandbox|, for
2851 security reasons.
2852
2853 *'errorformat'* *'efm'*
2854'errorformat' 'efm' string (default is very long)
2855 global or local to buffer |global-local|
2856 {not in Vi}
2857 {not available when compiled without the |+quickfix|
2858 feature}
2859 Scanf-like description of the format for the lines in the error file
2860 (see |errorformat|).
2861
2862 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2863'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2864 global
2865 {not in Vi}
2866 Function keys that start with an <Esc> are recognized in Insert
2867 mode. When this option is off, the cursor and function keys cannot be
2868 used in Insert mode if they start with an <Esc>. The advantage of
2869 this is that the single <Esc> is recognized immediately, instead of
2870 after one second. Instead of resetting this option, you might want to
2871 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2872 when 'esckeys' is off, you can still map anything, but the cursor keys
2873 won't work by default.
2874 NOTE: This option is set to the Vi default value when 'compatible' is
2875 set and to the Vim default value when 'compatible' is reset.
2876
2877 *'eventignore'* *'ei'*
2878'eventignore' 'ei' string (default "")
2879 global
2880 {not in Vi}
2881 {not available when compiled without the |+autocmd|
2882 feature}
2883 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002884 When set to "all" or when "all" is one of the items, all autocommand
2885 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002886 Otherwise this is a comma separated list of event names. Example: >
2887 :set ei=WinEnter,WinLeave
2888<
2889 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2890'expandtab' 'et' boolean (default off)
2891 local to buffer
2892 {not in Vi}
2893 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002894 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002895 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2896 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002897 This option is reset when the 'paste' option is set and restored when
2898 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002899 NOTE: This option is reset when 'compatible' is set.
2900
2901 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2902'exrc' 'ex' boolean (default off)
2903 global
2904 {not in Vi}
2905 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02002906 directory.
2907
2908 Setting this option is a potential security leak. E.g., consider
2909 unpacking a package or fetching files from github, a .vimrc in there
2910 might be a trojan horse. BETTER NOT SET THIS OPTION!
2911 Instead, define an autocommand in your .vimrc to set options for a
2912 matching directory.
2913
2914 If you do switch this option on you should also consider setting the
2915 'secure' option (see |initialization|).
2916 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002917 This option cannot be set from a |modeline| or in the |sandbox|, for
2918 security reasons.
2919
2920 *'fileencoding'* *'fenc'* *E213*
2921'fileencoding' 'fenc' string (default: "")
2922 local to buffer
2923 {only available when compiled with the |+multi_byte|
2924 feature}
2925 {not in Vi}
2926 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002927
Bram Moolenaar071d4272004-06-13 20:20:40 +00002928 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002929 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002930 When 'fileencoding' is empty, the same value as 'encoding' will be
2931 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01002932 No error will be given when the value is set, only when it is used,
2933 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002934 Conversion will also be done when 'encoding' and 'fileencoding' are
2935 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2936 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002937 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002938 'encoding' is "utf-8" or another Unicode encoding, conversion
2939 is most likely done in a way that the reverse conversion
2940 results in the same text. When 'encoding' is not "utf-8" some
2941 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002942
Bram Moolenaar071d4272004-06-13 20:20:40 +00002943 See 'encoding' for the possible values. Additionally, values may be
2944 specified that can be handled by the converter, see
2945 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002946
Bram Moolenaar071d4272004-06-13 20:20:40 +00002947 When reading a file 'fileencoding' will be set from 'fileencodings'.
2948 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002949 'fileencoding', use the |++enc| argument. One exception: when
2950 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002951 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002952
Bram Moolenaar071d4272004-06-13 20:20:40 +00002953 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2954 When the option is set, the value is converted to lowercase. Thus
2955 you can set it with uppercase values too. '_' characters are
2956 replaced with '-'. If a name is recognized from the list for
2957 'encoding', it is replaced by the standard name. For example
2958 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002959
Bram Moolenaar071d4272004-06-13 20:20:40 +00002960 When this option is set, after starting to edit a file, the 'modified'
2961 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002962
2963 Keep in mind that changing 'fenc' from a modeline happens
2964 AFTER the text has been read, thus it applies to when the file will be
2965 written. If you do set 'fenc' in a modeline, you might want to set
2966 'nomodified' to avoid not being able to ":q".
2967
Bram Moolenaar071d4272004-06-13 20:20:40 +00002968 This option can not be changed when 'modifiable' is off.
2969
2970 *'fe'*
2971 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002972 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002973 old short name was 'fe', which is no longer used.
2974
2975 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002976'fileencodings' 'fencs' string (default: "ucs-bom",
2977 "ucs-bom,utf-8,default,latin1" when
2978 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002979 global
2980 {only available when compiled with the |+multi_byte|
2981 feature}
2982 {not in Vi}
2983 This is a list of character encodings considered when starting to edit
2984 an existing file. When a file is read, Vim tries to use the first
2985 mentioned character encoding. If an error is detected, the next one
2986 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002987 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002988 an empty string, which means the value of 'encoding' is used.
2989 WARNING: Conversion can cause loss of information! When
2990 'encoding' is "utf-8" (or one of the other Unicode variants)
2991 conversion is most likely done in a way that the reverse
2992 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002993 "utf-8" some non-ASCII characters may be lost! You can use
2994 the |++bad| argument to specify what is done with characters
2995 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002996 For an empty file or a file with only ASCII characters most encodings
2997 will work and the first entry of 'fileencodings' will be used (except
2998 "ucs-bom", which requires the BOM to be present). If you prefer
2999 another encoding use an BufReadPost autocommand event to test if your
3000 preferred encoding is to be used. Example: >
3001 au BufReadPost * if search('\S', 'w') == 0 |
3002 \ set fenc=iso-2022-jp | endif
3003< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3004 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003005 When the |++enc| argument is used then the value of 'fileencodings' is
3006 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003007 Note that 'fileencodings' is not used for a new file, the global value
3008 of 'fileencoding' is used instead. You can set it with: >
3009 :setglobal fenc=iso-8859-2
3010< This means that a non-existing file may get a different encoding than
3011 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003012 The special value "ucs-bom" can be used to check for a Unicode BOM
3013 (Byte Order Mark) at the start of the file. It must not be preceded
3014 by "utf-8" or another Unicode encoding for this to work properly.
3015 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3016 because Vim cannot detect an error, thus the encoding is always
3017 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003018 The special value "default" can be used for the encoding from the
3019 environment. This is the default value for 'encoding'. It is useful
3020 when 'encoding' is set to "utf-8" and your environment uses a
3021 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003022 When 'encoding' is "utf-8" and a file contains an illegal byte
3023 sequence it won't be recognized as UTF-8. You can use the |8g8|
3024 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003025 WRONG VALUES: WHAT'S WRONG:
3026 latin1,utf-8 "latin1" will always be used
3027 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3028 file
3029 cp1250,latin1 "cp1250" will always be used
3030 If 'fileencodings' is empty, 'fileencoding' is not modified.
3031 See 'fileencoding' for the possible values.
3032 Setting this option does not have an effect until the next time a file
3033 is read.
3034
3035 *'fileformat'* *'ff'*
3036'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
3037 Unix default: "unix",
3038 Macintosh default: "mac")
3039 local to buffer
3040 {not in Vi}
3041 This gives the <EOL> of the current buffer, which is used for
3042 reading/writing the buffer from/to a file:
3043 dos <CR> <NL>
3044 unix <NL>
3045 mac <CR>
3046 When "dos" is used, CTRL-Z at the end of a file is ignored.
3047 See |file-formats| and |file-read|.
3048 For the character encoding of the file see 'fileencoding'.
3049 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003050 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003051 This option is set automatically when starting to edit a file and
3052 'fileformats' is not empty and 'binary' is off.
3053 When this option is set, after starting to edit a file, the 'modified'
3054 option is set, because the file would be different when written.
3055 This option can not be changed when 'modifiable' is off.
3056 For backwards compatibility: When this option is set to "dos",
3057 'textmode' is set, otherwise 'textmode' is reset.
3058
3059 *'fileformats'* *'ffs'*
3060'fileformats' 'ffs' string (default:
3061 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
3062 Vim Unix: "unix,dos",
3063 Vim Mac: "mac,unix,dos",
3064 Vi Cygwin: "unix,dos",
3065 Vi others: "")
3066 global
3067 {not in Vi}
3068 This gives the end-of-line (<EOL>) formats that will be tried when
3069 starting to edit a new buffer and when reading a file into an existing
3070 buffer:
3071 - When empty, the format defined with 'fileformat' will be used
3072 always. It is not set automatically.
3073 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003074 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003075 'fileformats' name will be used when a file is read into an existing
3076 buffer, no matter what 'fileformat' for that buffer is set to.
3077 - When more than one name is present, separated by commas, automatic
3078 <EOL> detection will be done when reading a file. When starting to
3079 edit a file, a check is done for the <EOL>:
3080 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3081 'fileformat' is set to "dos".
3082 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003083 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003084 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003085 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3086 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003087 This means that "mac" is only chosen when:
3088 "unix" is not present or no <NL> is found in the file, and
3089 "dos" is not present or no <CR><NL> is found in the file.
3090 Except: if "unix" was chosen, but there is a <CR> before
3091 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003092 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003093 4. If 'fileformat' is still not set, the first name from
3094 'fileformats' is used.
3095 When reading a file into an existing buffer, the same is done, but
3096 this happens like 'fileformat' has been set appropriately for that
3097 file only, the option is not changed.
3098 When 'binary' is set, the value of 'fileformats' is not used.
3099
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003100 When Vim starts up with an empty buffer the first item is used. You
3101 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003102
Bram Moolenaar071d4272004-06-13 20:20:40 +00003103 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3104 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3105 done:
3106 - When 'fileformats' is empty, there is no automatic detection. Dos
3107 format will be used.
3108 - When 'fileformats' is set to one or more names, automatic detection
3109 is done. This is based on the first <NL> in the file: If there is a
3110 <CR> in front of it, Dos format is used, otherwise Unix format is
3111 used.
3112 Also see |file-formats|.
3113 For backwards compatibility: When this option is set to an empty
3114 string or one format (no comma is included), 'textauto' is reset,
3115 otherwise 'textauto' is set.
3116 NOTE: This option is set to the Vi default value when 'compatible' is
3117 set and to the Vim default value when 'compatible' is reset.
3118
Bram Moolenaarbf884932013-04-05 22:26:15 +02003119 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3120'fileignorecase' 'fic' boolean (default on for systems where case in file
3121 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003122 global
3123 {not in Vi}
3124 When set case is ignored when using file names and directories.
3125 See 'wildignorecase' for only ignoring case when doing completion.
3126
Bram Moolenaar071d4272004-06-13 20:20:40 +00003127 *'filetype'* *'ft'*
3128'filetype' 'ft' string (default: "")
3129 local to buffer
3130 {not in Vi}
3131 {not available when compiled without the |+autocmd|
3132 feature}
3133 When this option is set, the FileType autocommand event is triggered.
3134 All autocommands that match with the value of this option will be
3135 executed. Thus the value of 'filetype' is used in place of the file
3136 name.
3137 Otherwise this option does not always reflect the current file type.
3138 This option is normally set when the file type is detected. To enable
3139 this use the ":filetype on" command. |:filetype|
3140 Setting this option to a different value is most useful in a modeline,
3141 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003142 Example, for in an IDL file:
3143 /* vim: set filetype=idl : */ ~
3144 |FileType| |filetypes|
3145 When a dot appears in the value then this separates two filetype
3146 names. Example:
3147 /* vim: set filetype=c.doxygen : */ ~
3148 This will use the "c" filetype first, then the "doxygen" filetype.
3149 This works both for filetype plugins and for syntax files. More than
3150 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003151 This option is not copied to another buffer, independent of the 's' or
3152 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003153 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003154
3155 *'fillchars'* *'fcs'*
3156'fillchars' 'fcs' string (default "vert:|,fold:-")
3157 global
3158 {not in Vi}
3159 {not available when compiled without the |+windows|
3160 and |+folding| features}
3161 Characters to fill the statuslines and vertical separators.
3162 It is a comma separated list of items:
3163
3164 item default Used for ~
3165 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003166 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003167 vert:c '|' vertical separators |:vsplit|
3168 fold:c '-' filling 'foldtext'
3169 diff:c '-' deleted lines of the 'diff' option
3170
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003171 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003172 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003173 otherwise.
3174
3175 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003176 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003177< This is similar to the default, except that these characters will also
3178 be used when there is highlighting.
3179
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003180 for "stl" and "stlnc" only single-byte values are supported.
3181
Bram Moolenaar071d4272004-06-13 20:20:40 +00003182 The highlighting used for these items:
3183 item highlight group ~
3184 stl:c StatusLine |hl-StatusLine|
3185 stlnc:c StatusLineNC |hl-StatusLineNC|
3186 vert:c VertSplit |hl-VertSplit|
3187 fold:c Folded |hl-Folded|
3188 diff:c DiffDelete |hl-DiffDelete|
3189
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003190 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3191'fixendofline' 'fixeol' boolean (default on)
3192 local to buffer
3193 {not in Vi}
3194 When writing a file and this option is on, <EOL> at the end of file
3195 will be restored if missing. Turn this option off if you want to
3196 preserve the situation from the original file.
3197 When the 'binary' option is set the value of this option doesn't
3198 matter.
3199 See the 'endofline' option.
3200
Bram Moolenaar071d4272004-06-13 20:20:40 +00003201 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3202'fkmap' 'fk' boolean (default off) *E198*
3203 global
3204 {not in Vi}
3205 {only available when compiled with the |+rightleft|
3206 feature}
3207 When on, the keyboard is mapped for the Farsi character set.
3208 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003209 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003210
3211 *'foldclose'* *'fcl'*
3212'foldclose' 'fcl' string (default "")
3213 global
3214 {not in Vi}
3215 {not available when compiled without the |+folding|
3216 feature}
3217 When set to "all", a fold is closed when the cursor isn't in it and
3218 its level is higher than 'foldlevel'. Useful if you want folds to
3219 automatically close when moving out of them.
3220
3221 *'foldcolumn'* *'fdc'*
3222'foldcolumn' 'fdc' number (default 0)
3223 local to window
3224 {not in Vi}
3225 {not available when compiled without the |+folding|
3226 feature}
3227 When non-zero, a column with the specified width is shown at the side
3228 of the window which indicates open and closed folds. The maximum
3229 value is 12.
3230 See |folding|.
3231
3232 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3233'foldenable' 'fen' boolean (default on)
3234 local to window
3235 {not in Vi}
3236 {not available when compiled without the |+folding|
3237 feature}
3238 When off, all folds are open. This option can be used to quickly
3239 switch between showing all text unfolded and viewing the text with
3240 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003241 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003242 'foldenable' is off.
3243 This option is set by commands that create a new fold or close a fold.
3244 See |folding|.
3245
3246 *'foldexpr'* *'fde'*
3247'foldexpr' 'fde' string (default: "0")
3248 local to window
3249 {not in Vi}
3250 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003251 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003252 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003253 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003254
Bram Moolenaar30b65812012-07-12 22:01:11 +02003255 The expression will be evaluated in the |sandbox| if set from a
3256 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003257 This option can't be set from a |modeline| when the 'diff' option is
3258 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003259
3260 It is not allowed to change text or jump to another window while
3261 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003262
3263 *'foldignore'* *'fdi'*
3264'foldignore' 'fdi' string (default: "#")
3265 local to window
3266 {not in Vi}
3267 {not available when compiled without the |+folding|
3268 feature}
3269 Used only when 'foldmethod' is "indent". Lines starting with
3270 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003271 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003272 The default "#" works well for C programs. See |fold-indent|.
3273
3274 *'foldlevel'* *'fdl'*
3275'foldlevel' 'fdl' number (default: 0)
3276 local to window
3277 {not in Vi}
3278 {not available when compiled without the |+folding|
3279 feature}
3280 Sets the fold level: Folds with a higher level will be closed.
3281 Setting this option to zero will close all folds. Higher numbers will
3282 close fewer folds.
3283 This option is set by commands like |zm|, |zM| and |zR|.
3284 See |fold-foldlevel|.
3285
3286 *'foldlevelstart'* *'fdls'*
3287'foldlevelstart' 'fdls' number (default: -1)
3288 global
3289 {not in Vi}
3290 {not available when compiled without the |+folding|
3291 feature}
3292 Sets 'foldlevel' when starting to edit another buffer in a window.
3293 Useful to always start editing with all folds closed (value zero),
3294 some folds closed (one) or no folds closed (99).
3295 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003296 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003297 ignores this option and closes all folds.
3298 It is also done before BufReadPre autocommands, to allow an autocmd to
3299 overrule the 'foldlevel' value for specific files.
3300 When the value is negative, it is not used.
3301
3302 *'foldmarker'* *'fmr'* *E536*
3303'foldmarker' 'fmr' string (default: "{{{,}}}")
3304 local to window
3305 {not in Vi}
3306 {not available when compiled without the |+folding|
3307 feature}
3308 The start and end marker used when 'foldmethod' is "marker". There
3309 must be one comma, which separates the start and end marker. The
3310 marker is a literal string (a regular expression would be too slow).
3311 See |fold-marker|.
3312
3313 *'foldmethod'* *'fdm'*
3314'foldmethod' 'fdm' string (default: "manual")
3315 local to window
3316 {not in Vi}
3317 {not available when compiled without the |+folding|
3318 feature}
3319 The kind of folding used for the current window. Possible values:
3320 |fold-manual| manual Folds are created manually.
3321 |fold-indent| indent Lines with equal indent form a fold.
3322 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3323 |fold-marker| marker Markers are used to specify folds.
3324 |fold-syntax| syntax Syntax highlighting items specify folds.
3325 |fold-diff| diff Fold text that is not changed.
3326
3327 *'foldminlines'* *'fml'*
3328'foldminlines' 'fml' number (default: 1)
3329 local to window
3330 {not in Vi}
3331 {not available when compiled without the |+folding|
3332 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003333 Sets the number of screen lines above which a fold can be displayed
3334 closed. Also for manually closed folds. With the default value of
3335 one a fold can only be closed if it takes up two or more screen lines.
3336 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003337 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003338 "zc" to close a fold, which is displayed open because it's smaller
3339 than 'foldminlines', a following "zc" may close a containing fold.
3340
3341 *'foldnestmax'* *'fdn'*
3342'foldnestmax' 'fdn' number (default: 20)
3343 local to window
3344 {not in Vi}
3345 {not available when compiled without the |+folding|
3346 feature}
3347 Sets the maximum nesting of folds for the "indent" and "syntax"
3348 methods. This avoids that too many folds will be created. Using more
3349 than 20 doesn't work, because the internal limit is 20.
3350
3351 *'foldopen'* *'fdo'*
3352'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3353 search,tag,undo")
3354 global
3355 {not in Vi}
3356 {not available when compiled without the |+folding|
3357 feature}
3358 Specifies for which type of commands folds will be opened, if the
3359 command moves the cursor into a closed fold. It is a comma separated
3360 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003361 NOTE: When the command is part of a mapping this option is not used.
3362 Add the |zv| command to the mapping to get the same effect.
3363 (rationale: the mapping may want to control opening folds itself)
3364
Bram Moolenaar071d4272004-06-13 20:20:40 +00003365 item commands ~
3366 all any
3367 block "(", "{", "[[", "[{", etc.
3368 hor horizontal movements: "l", "w", "fx", etc.
3369 insert any command in Insert mode
3370 jump far jumps: "G", "gg", etc.
3371 mark jumping to a mark: "'m", CTRL-O, etc.
3372 percent "%"
3373 quickfix ":cn", ":crew", ":make", etc.
3374 search search for a pattern: "/", "n", "*", "gd", etc.
3375 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003376 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003377 tag jumping to a tag: ":ta", CTRL-T, etc.
3378 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003379 When a movement command is used for an operator (e.g., "dl" or "y%")
3380 this option is not used. This means the operator will include the
3381 whole closed fold.
3382 Note that vertical movements are not here, because it would make it
3383 very difficult to move onto a closed fold.
3384 In insert mode the folds containing the cursor will always be open
3385 when text is inserted.
3386 To close folds you can re-apply 'foldlevel' with the |zx| command or
3387 set the 'foldclose' option to "all".
3388
3389 *'foldtext'* *'fdt'*
3390'foldtext' 'fdt' string (default: "foldtext()")
3391 local to window
3392 {not in Vi}
3393 {not available when compiled without the |+folding|
3394 feature}
3395 An expression which is used to specify the text displayed for a closed
3396 fold. See |fold-foldtext|.
3397
Bram Moolenaar30b65812012-07-12 22:01:11 +02003398 The expression will be evaluated in the |sandbox| if set from a
3399 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003400
3401 It is not allowed to change text or jump to another window while
3402 evaluating 'foldtext' |textlock|.
3403
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003404 *'formatexpr'* *'fex'*
3405'formatexpr' 'fex' string (default "")
3406 local to buffer
3407 {not in Vi}
3408 {not available when compiled without the |+eval|
3409 feature}
3410 Expression which is evaluated to format a range of lines for the |gq|
3411 operator or automatic formatting (see 'formatoptions'). When this
3412 option is empty 'formatprg' is used.
3413
3414 The |v:lnum| variable holds the first line to be formatted.
3415 The |v:count| variable holds the number of lines to be formatted.
3416 The |v:char| variable holds the character that is going to be
3417 inserted if the expression is being evaluated due to
3418 automatic formatting. This can be empty. Don't insert
3419 it yet!
3420
3421 Example: >
3422 :set formatexpr=mylang#Format()
3423< This will invoke the mylang#Format() function in the
3424 autoload/mylang.vim file in 'runtimepath'. |autoload|
3425
3426 The expression is also evaluated when 'textwidth' is set and adding
3427 text beyond that limit. This happens under the same conditions as
3428 when internal formatting is used. Make sure the cursor is kept in the
3429 same spot relative to the text then! The |mode()| function will
3430 return "i" or "R" in this situation.
3431
3432 When the expression evaluates to non-zero Vim will fall back to using
3433 the internal format mechanism.
3434
3435 The expression will be evaluated in the |sandbox| when set from a
3436 modeline, see |sandbox-option|. That stops the option from working,
3437 since changing the buffer text is not allowed.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003438 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003439
Bram Moolenaar071d4272004-06-13 20:20:40 +00003440 *'formatoptions'* *'fo'*
3441'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3442 local to buffer
3443 {not in Vi}
3444 This is a sequence of letters which describes how automatic
3445 formatting is to be done. See |fo-table|. When the 'paste' option is
3446 on, no formatting is done (like 'formatoptions' is empty). Commas can
3447 be inserted for readability.
3448 To avoid problems with flags that are added in the future, use the
3449 "+=" and "-=" feature of ":set" |add-option-flags|.
3450 NOTE: This option is set to the Vi default value when 'compatible' is
3451 set and to the Vim default value when 'compatible' is reset.
3452
Bram Moolenaar86b68352004-12-27 21:59:20 +00003453 *'formatlistpat'* *'flp'*
3454'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3455 local to buffer
3456 {not in Vi}
3457 A pattern that is used to recognize a list header. This is used for
3458 the "n" flag in 'formatoptions'.
3459 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003460 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003461 while still checking more characters. There must be a character
3462 following the pattern, when it matches the whole line it is handled
3463 like there is no match.
3464 The default recognizes a number, followed by an optional punctuation
3465 character and white space.
3466
Bram Moolenaar071d4272004-06-13 20:20:40 +00003467 *'formatprg'* *'fp'*
3468'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003469 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003470 {not in Vi}
3471 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003472 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003473 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003474 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003475 If the 'formatexpr' option is not empty it will be used instead.
3476 Otherwise, if 'formatprg' option is an empty string, the internal
3477 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003478 Environment variables are expanded |:set_env|. See |option-backslash|
3479 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003480 This option cannot be set from a |modeline| or in the |sandbox|, for
3481 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003482
Bram Moolenaard94464e2015-11-02 15:28:18 +01003483 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003484'fsync' 'fs' boolean (default on)
3485 global
3486 {not in Vi}
3487 When on, the library function fsync() will be called after writing a
3488 file. This will flush a file to disk, ensuring that it is safely
3489 written even on filesystems which do metadata-only journaling. This
3490 will force the harddrive to spin up on Linux systems running in laptop
3491 mode, so it may be undesirable in some situations. Be warned that
3492 turning this off increases the chances of data loss after a crash. On
3493 systems without an fsync() implementation, this variable is always
3494 off.
3495 Also see 'swapsync' for controlling fsync() on swap files.
3496
Bram Moolenaar071d4272004-06-13 20:20:40 +00003497 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3498'gdefault' 'gd' boolean (default off)
3499 global
3500 {not in Vi}
3501 When on, the ":substitute" flag 'g' is default on. This means that
3502 all matches in a line are substituted instead of one. When a 'g' flag
3503 is given to a ":substitute" command, this will toggle the substitution
3504 of all or one match. See |complex-change|.
3505
3506 command 'gdefault' on 'gdefault' off ~
3507 :s/// subst. all subst. one
3508 :s///g subst. one subst. all
3509 :s///gg subst. all subst. one
3510
3511 NOTE: This option is reset when 'compatible' is set.
3512
3513 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003514'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003515 global
3516 {not in Vi}
3517 Format to recognize for the ":grep" command output.
3518 This is a scanf-like string that uses the same format as the
3519 'errorformat' option: see |errorformat|.
3520
3521 *'grepprg'* *'gp'*
3522'grepprg' 'gp' string (default "grep -n ",
3523 Unix: "grep -n $* /dev/null",
3524 Win32: "findstr /n" or "grep -n",
3525 VMS: "SEARCH/NUMBERS ")
3526 global or local to buffer |global-local|
3527 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003528 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003529 and '#' characters, which are expanded like when used in a command-
3530 line. The placeholder "$*" is allowed to specify where the arguments
3531 will be included. Environment variables are expanded |:set_env|. See
3532 |option-backslash| about including spaces and backslashes.
3533 When your "grep" accepts the "-H" argument, use this to make ":grep"
3534 also work well with a single file: >
3535 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003536< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003537 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3538 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003539 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003540 apply equally to 'grepprg'.
3541 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3542 otherwise it's "grep -n".
3543 This option cannot be set from a |modeline| or in the |sandbox|, for
3544 security reasons.
3545
3546 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3547'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3548 ve:ver35-Cursor,
3549 o:hor50-Cursor,
3550 i-ci:ver25-Cursor/lCursor,
3551 r-cr:hor20-Cursor/lCursor,
3552 sm:block-Cursor
3553 -blinkwait175-blinkoff150-blinkon175",
3554 for MS-DOS and Win32 console:
3555 "n-v-c:block,o:hor50,i-ci:hor15,
3556 r-cr:hor30,sm:block")
3557 global
3558 {not in Vi}
3559 {only available when compiled with GUI enabled, and
3560 for MS-DOS and Win32 console}
3561 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003562 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003563 the height of the cursor can be changed. This can be done by
3564 specifying a block cursor, or a percentage for a vertical or
3565 horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003566 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3567 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003568
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003569 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003570 mode-list and an argument-list:
3571 mode-list:argument-list,mode-list:argument-list,..
3572 The mode-list is a dash separated list of these modes:
3573 n Normal mode
3574 v Visual mode
3575 ve Visual mode with 'selection' "exclusive" (same as 'v',
3576 if not specified)
3577 o Operator-pending mode
3578 i Insert mode
3579 r Replace mode
3580 c Command-line Normal (append) mode
3581 ci Command-line Insert mode
3582 cr Command-line Replace mode
3583 sm showmatch in Insert mode
3584 a all modes
3585 The argument-list is a dash separated list of these arguments:
3586 hor{N} horizontal bar, {N} percent of the character height
3587 ver{N} vertical bar, {N} percent of the character width
3588 block block cursor, fills the whole character
3589 [only one of the above three should be present]
3590 blinkwait{N} *cursor-blinking*
3591 blinkon{N}
3592 blinkoff{N}
3593 blink times for cursor: blinkwait is the delay before
3594 the cursor starts blinking, blinkon is the time that
3595 the cursor is shown and blinkoff is the time that the
3596 cursor is not shown. The times are in msec. When one
3597 of the numbers is zero, there is no blinking. The
3598 default is: "blinkwait700-blinkon400-blinkoff250".
3599 These numbers are used for a missing entry. This
3600 means that blinking is enabled by default. To switch
3601 blinking off you can use "blinkon0". The cursor only
3602 blinks when Vim is waiting for input, not while
3603 executing a command.
3604 To make the cursor blink in an xterm, see
3605 |xterm-blink|.
3606 {group-name}
3607 a highlight group name, that sets the color and font
3608 for the cursor
3609 {group-name}/{group-name}
3610 Two highlight group names, the first is used when
3611 no language mappings are used, the other when they
3612 are. |language-mapping|
3613
3614 Examples of parts:
3615 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3616 block cursor with colors from the "nCursor"
3617 highlight group
3618 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3619 In Insert and Command-line Insert mode, use a
3620 30% vertical bar cursor with colors from the
3621 "iCursor" highlight group. Blink a bit
3622 faster.
3623
3624 The 'a' mode is different. It will set the given argument-list for
3625 all modes. It does not reset anything to defaults. This can be used
3626 to do a common setting for all modes. For example, to switch off
3627 blinking: "a:blinkon0"
3628
3629 Examples of cursor highlighting: >
3630 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3631 :highlight Cursor gui=NONE guifg=bg guibg=fg
3632<
3633 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003634 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003635'guifont' 'gfn' string (default "")
3636 global
3637 {not in Vi}
3638 {only available when compiled with GUI enabled}
3639 This is a list of fonts which will be used for the GUI version of Vim.
3640 In its simplest form the value is just one font name. When
3641 the font cannot be found you will get an error message. To try other
3642 font names a list can be specified, font names separated with commas.
3643 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003644
Bram Moolenaar05159a02005-02-26 23:04:13 +00003645 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3646 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003647
Bram Moolenaar3df01732017-02-17 22:47:16 +01003648 Note: As to the GTK GUIs, no error is given against any invalid names,
3649 and the first element of the list is always picked up and made use of.
3650 This is because, instead of identifying a given name with a font, the
3651 GTK GUIs use it to construct a pattern and try to look up a font which
3652 best matches the pattern among available fonts, and this way, the
3653 matching never fails. An invalid name doesn't matter because a number
3654 of font properties other than name will do to get the matching done.
3655
Bram Moolenaar071d4272004-06-13 20:20:40 +00003656 Spaces after a comma are ignored. To include a comma in a font name
3657 precede it with a backslash. Setting an option requires an extra
3658 backslash before a space and a backslash. See also
3659 |option-backslash|. For example: >
3660 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003661< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003662 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003663
3664 If none of the fonts can be loaded, Vim will keep the current setting.
3665 If an empty font list is given, Vim will try using other resource
3666 settings (for X, it will use the Vim.font resource), and finally it
3667 will try some builtin default which should always be there ("7x13" in
3668 the case of X). The font names given should be "normal" fonts. Vim
3669 will try to find the related bold and italic fonts.
3670
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003671 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003672 :set guifont=*
3673< will bring up a font requester, where you can pick the font you want.
3674
3675 The font name depends on the GUI used. See |setting-guifont| for a
3676 way to set 'guifont' for various systems.
3677
Bram Moolenaar3df01732017-02-17 22:47:16 +01003678 For the GTK+ 2 and 3 GUIs, the font name looks like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003679 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003680< That's all. XLFDs are not used. For Chinese this is reported to work
3681 well: >
3682 if has("gui_gtk2")
3683 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3684 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3685 endif
3686<
Bram Moolenaar3df01732017-02-17 22:47:16 +01003687 (Replace gui_gtk2 with gui_gtk3 for the GTK+ 3 GUI)
3688
Bram Moolenaar05159a02005-02-26 23:04:13 +00003689 For Mac OSX you can use something like this: >
3690 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003691< Also see 'macatsui', it can help fix display problems.
3692 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003693 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaar3df01732017-02-17 22:47:16 +01003694 width). An exception is GTK: all fonts are accepted, but mono-spaced
3695 fonts look best.
Bram Moolenaared203462004-06-16 11:19:22 +00003696
Bram Moolenaar071d4272004-06-13 20:20:40 +00003697 To preview a font on X11, you might be able to use the "xfontsel"
3698 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003699
Bram Moolenaar071d4272004-06-13 20:20:40 +00003700 For the Win32 GUI *E244* *E245*
3701 - takes these options in the font name:
3702 hXX - height is XX (points, can be floating-point)
3703 wXX - width is XX (points, can be floating-point)
3704 b - bold
3705 i - italic
3706 u - underline
3707 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003708 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003709 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3710 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3711 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003712 Normally you would use "cDEFAULT".
Bram Moolenaar03413f42016-04-12 21:07:15 +02003713 qXX - quality XX. Valid quality names are: PROOF, DRAFT,
Bram Moolenaar06d2d382016-05-20 17:24:11 +02003714 ANTIALIASED, NONANTIALIASED, CLEARTYPE, DEFAULT.
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02003715 Normally you would use "qDEFAULT".
Bram Moolenaardc1f1642016-08-16 18:33:43 +02003716 Some quality values are not supported in legacy OSs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003717
3718 Use a ':' to separate the options.
3719 - A '_' can be used in the place of a space, so you don't need to use
3720 backslashes to escape the spaces.
3721 - Examples: >
3722 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3723 :set guifont=Andale_Mono:h7.5:w4.5
3724< See also |font-sizes|.
3725
3726 *'guifontset'* *'gfs'*
3727 *E250* *E252* *E234* *E597* *E598*
3728'guifontset' 'gfs' string (default "")
3729 global
3730 {not in Vi}
3731 {only available when compiled with GUI enabled and
3732 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003733 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003734 When not empty, specifies two (or more) fonts to be used. The first
3735 one for normal English, the second one for your special language. See
3736 |xfontset|.
3737 Setting this option also means that all font names will be handled as
3738 a fontset name. Also the ones used for the "font" argument of the
3739 |:highlight| command.
3740 The fonts must match with the current locale. If fonts for the
3741 character sets that the current locale uses are not included, setting
3742 'guifontset' will fail.
3743 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3744 the comma-separated names are alternative names, one of which will be
3745 used. In 'guifontset' the whole string is one fontset name,
3746 including the commas. It is not possible to specify alternative
3747 fontset names.
3748 This example works on many X11 systems: >
3749 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3750<
3751 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3752'guifontwide' 'gfw' string (default "")
3753 global
3754 {not in Vi}
3755 {only available when compiled with GUI enabled}
3756 When not empty, specifies a comma-separated list of fonts to be used
3757 for double-width characters. The first font that can be loaded is
3758 used.
3759 Note: The size of these fonts must be exactly twice as wide as the one
3760 specified with 'guifont' and the same height.
3761
Bram Moolenaar3df01732017-02-17 22:47:16 +01003762 All GUI versions but GTK+:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003763
3764 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3765 'guifontset' is empty or invalid.
3766 When 'guifont' is set and a valid font is found in it and
3767 'guifontwide' is empty Vim will attempt to find a matching
3768 double-width font and set 'guifontwide' to it.
3769
Bram Moolenaar3df01732017-02-17 22:47:16 +01003770 GTK+ GUI only: *guifontwide_gtk*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003771
3772 If set and valid, 'guifontwide' is always used for double width
3773 characters, even if 'encoding' is not set to "utf-8".
3774 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003775 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003776 font for characters not available in 'guifont'. Thus you do not need
3777 to set 'guifontwide' at all unless you want to override the choice
3778 made by Pango/Xft.
3779
Bram Moolenaar0f272122013-01-23 18:37:40 +01003780 Windows +multibyte only: *guifontwide_win_mbyte*
3781
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003782 If set and valid, 'guifontwide' is used for IME instead of 'guifont'.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003783
Bram Moolenaar071d4272004-06-13 20:20:40 +00003784 *'guiheadroom'* *'ghr'*
3785'guiheadroom' 'ghr' number (default 50)
3786 global
3787 {not in Vi} {only for GTK and X11 GUI}
3788 The number of pixels subtracted from the screen height when fitting
3789 the GUI window on the screen. Set this before the GUI is started,
3790 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003791 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003792 lines will be left for window decorations and other items on the
3793 screen. Set it to a negative value to allow windows taller than the
3794 screen.
3795
3796 *'guioptions'* *'go'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003797'guioptions' 'go' string (default "egmrLtT" (MS-Windows, "t" is
3798 removed in |defaults.vim|),
3799 "aegimrLtT" (GTK, Motif and Athena),
3800 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003801 global
3802 {not in Vi}
3803 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003804 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003805 sequence of letters which describes what components and options of the
3806 GUI should be used.
3807 To avoid problems with flags that are added in the future, use the
3808 "+=" and "-=" feature of ":set" |add-option-flags|.
3809
3810 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003811 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003812 'a' Autoselect: If present, then whenever VISUAL mode is started,
3813 or the Visual area extended, Vim tries to become the owner of
3814 the windowing system's global selection. This means that the
3815 Visually highlighted text is available for pasting into other
3816 applications as well as into Vim itself. When the Visual mode
3817 ends, possibly due to an operation on the text, or when an
3818 application wants to paste the selection, the highlighted text
3819 is automatically yanked into the "* selection register.
3820 Thus the selection is still available for pasting into other
3821 applications after the VISUAL mode has ended.
3822 If not present, then Vim won't become the owner of the
3823 windowing system's global selection unless explicitly told to
3824 by a yank or delete operation for the "* register.
3825 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003826 *'go-P'*
3827 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003828 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003829 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003830 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003831 applies to the modeless selection.
3832
3833 'guioptions' autoselect Visual autoselect modeless ~
3834 "" - -
3835 "a" yes yes
3836 "A" - yes
3837 "aA" yes yes
3838
Bram Moolenaar02467872007-05-06 13:22:01 +00003839 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003840 'c' Use console dialogs instead of popup dialogs for simple
3841 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003842 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003843 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003844 'guitablabel' can be used to change the text in the labels.
3845 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003846 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003847 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003848 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003849 'f' Foreground: Don't use fork() to detach the GUI from the shell
3850 where it was started. Use this for programs that wait for the
3851 editor to finish (e.g., an e-mail program). Alternatively you
3852 can use "gvim -f" or ":gui -f" to start the GUI in the
3853 foreground. |gui-fork|
3854 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003855 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003856 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003857 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3858 corner of the window. It's black&white on non-GTK, because of
3859 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003860 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003861 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003862 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003863 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003864 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003865 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003866 file is sourced the system menu has already been loaded; the
3867 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003868 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003869 'g' Grey menu items: Make menu items that are not active grey. If
3870 'g' is not included inactive menu items are not shown at all.
3871 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003872 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003873 't' Include tearoff menu items. Currently only works for Win32,
3874 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003875 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003876 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003877 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003878 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003879 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003880 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003881 'R' Right-hand scrollbar is present when there is a vertically
3882 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003883 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003884 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003885 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003886 'L' Left-hand scrollbar is present when there is a vertically
3887 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003888 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003889 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3890 the longest visible line, or on the cursor line if the 'h'
3891 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003892 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003893 'h' Limit horizontal scrollbar size to the length of the cursor
3894 line. Reduces computations. |gui-horiz-scroll|
3895
3896 And yes, you may even have scrollbars on the left AND the right if
3897 you really want to :-). See |gui-scrollbars| for more information.
3898
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003899 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003900 'v' Use a vertical button layout for dialogs. When not included,
3901 a horizontal layout is preferred, but when it doesn't fit a
3902 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003903 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003904 'p' Use Pointer callbacks for X11 GUI. This is required for some
3905 window managers. If the cursor is not blinking or hollow at
3906 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003907 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003908 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003909 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003910 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003911
Bram Moolenaar02467872007-05-06 13:22:01 +00003912
Bram Moolenaar071d4272004-06-13 20:20:40 +00003913 *'guipty'* *'noguipty'*
3914'guipty' boolean (default on)
3915 global
3916 {not in Vi}
3917 {only available when compiled with GUI enabled}
3918 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3919 I/O to/from shell commands. See |gui-pty|.
3920
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003921 *'guitablabel'* *'gtl'*
3922'guitablabel' 'gtl' string (default empty)
3923 global
3924 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003925 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003926 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003927 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003928 pages line. When empty and when the result is empty Vim will use a
3929 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003930
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003931 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003932 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003933 The expression will be evaluated in the |sandbox| when set from a
3934 modeline, see |sandbox-option|.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003935
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003936 Only used when the GUI tab pages line is displayed. 'e' must be
3937 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3938 used.
3939
Bram Moolenaar57657d82006-04-21 22:12:41 +00003940 *'guitabtooltip'* *'gtt'*
3941'guitabtooltip' 'gtt' string (default empty)
3942 global
3943 {not in Vi}
3944 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003945 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003946 When nonempty describes the text to use in a tooltip for the GUI tab
3947 pages line. When empty Vim will use a default tooltip.
3948 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003949 You can include a line break. Simplest method is to use |:let|: >
3950 :let &guitabtooltip = "line one\nline two"
3951<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003952
Bram Moolenaar071d4272004-06-13 20:20:40 +00003953 *'helpfile'* *'hf'*
3954'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3955 (others) "$VIMRUNTIME/doc/help.txt")
3956 global
3957 {not in Vi}
3958 Name of the main help file. All distributed help files should be
3959 placed together in one directory. Additionally, all "doc" directories
3960 in 'runtimepath' will be used.
3961 Environment variables are expanded |:set_env|. For example:
3962 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003963 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003964 spaces and backslashes.
3965 This option cannot be set from a |modeline| or in the |sandbox|, for
3966 security reasons.
3967
3968 *'helpheight'* *'hh'*
3969'helpheight' 'hh' number (default 20)
3970 global
3971 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003972 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003973 feature}
3974 Minimal initial height of the help window when it is opened with the
3975 ":help" command. The initial height of the help window is half of the
3976 current window, or (when the 'ea' option is on) the same as other
3977 windows. When the height is less than 'helpheight', the height is
3978 set to 'helpheight'. Set to zero to disable.
3979
3980 *'helplang'* *'hlg'*
3981'helplang' 'hlg' string (default: messages language or empty)
3982 global
3983 {only available when compiled with the |+multi_lang|
3984 feature}
3985 {not in Vi}
3986 Comma separated list of languages. Vim will use the first language
3987 for which the desired help can be found. The English help will always
3988 be used as a last resort. You can add "en" to prefer English over
3989 another language, but that will only find tags that exist in that
3990 language and not in the English help.
3991 Example: >
3992 :set helplang=de,it
3993< This will first search German, then Italian and finally English help
3994 files.
3995 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3996 try to find the tag in the current language before using this option.
3997 See |help-translated|.
3998
3999 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4000'hidden' 'hid' boolean (default off)
4001 global
4002 {not in Vi}
4003 When off a buffer is unloaded when it is |abandon|ed. When on a
4004 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4005 displayed in another window, it does not become hidden, of course.
4006 The commands that move through the buffer list sometimes make a buffer
4007 hidden although the 'hidden' option is off: When the buffer is
4008 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004009 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004010 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004011 This option is set for one command with ":hide {command}" |:hide|.
4012 WARNING: It's easy to forget that you have changes in hidden buffers.
4013 Think twice when using ":q!" or ":qa!".
4014
4015 *'highlight'* *'hl'*
4016'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004017 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4018 d:Directory,e:ErrorMsg,i:IncSearch,
4019 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
4020 N:CursorLineNr,r:Question,s:StatusLine,
4021 S:StatusLineNC,c:VertSplit,t:Title,
4022 v:Visual,w:WarningMsg,W:WildMenu,f:Folded,
4023 F:FoldColumn,A:DiffAdd,C:DiffChange,
4024 D:DiffDelete,T:DiffText,>:SignColumn,
4025 B:SpellBad,P:SpellCap,R:SpellRare,
4026 L:SpellLocal,-:Conceal,+:Pmenu,=:PmenuSel,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00004027 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004028 global
4029 {not in Vi}
4030 This option can be used to set highlighting mode for various
4031 occasions. It is a comma separated list of character pairs. The
4032 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004033 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004034 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004035 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4036 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004037 characters from 'showbreak'
4038 |hl-Directory| d directories in CTRL-D listing and other special
4039 things in listings
4040 |hl-ErrorMsg| e error messages
4041 h (obsolete, ignored)
4042 |hl-IncSearch| i 'incsearch' highlighting
4043 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4044 |hl-MoreMsg| m |more-prompt|
4045 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004046 |hl-LineNr| n line number for ":number" and ":#" commands, and
4047 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004048 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4049 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004050 |hl-Question| r |hit-enter| prompt and yes/no questions
4051 |hl-StatusLine| s status line of current window |status-line|
4052 |hl-StatusLineNC| S status lines of not-current windows
4053 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4054 |hl-VertSplit| c column used to separate vertically split windows
4055 |hl-Visual| v Visual mode
4056 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4057 Selection" Only X11 Gui's |gui-x11| and
4058 |xterm-clipboard|.
4059 |hl-WarningMsg| w warning messages
4060 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4061 |hl-Folded| f line used for closed folds
4062 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004063 |hl-DiffAdd| A added line in diff mode
4064 |hl-DiffChange| C changed line in diff mode
4065 |hl-DiffDelete| D deleted line in diff mode
4066 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004067 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004068 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004069 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004070 |hl-SpellRare| R rare word |spell|
4071 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02004072 |hl-Conceal| - the placeholders used for concealed characters
4073 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00004074 |hl-Pmenu| + popup menu normal line
4075 |hl-PmenuSel| = popup menu normal line
4076 |hl-PmenuSbar| x popup menu scrollbar
4077 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004078
4079 The display modes are:
4080 r reverse (termcap entry "mr" and "me")
4081 i italic (termcap entry "ZH" and "ZR")
4082 b bold (termcap entry "md" and "me")
4083 s standout (termcap entry "so" and "se")
4084 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004085 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004086 n no highlighting
4087 - no highlighting
4088 : use a highlight group
4089 The default is used for occasions that are not included.
4090 If you want to change what the display modes do, see |dos-colors|
4091 for an example.
4092 When using the ':' display mode, this must be followed by the name of
4093 a highlight group. A highlight group can be used to define any type
4094 of highlighting, including using color. See |:highlight| on how to
4095 define one. The default uses a different group for each occasion.
4096 See |highlight-default| for the default highlight groups.
4097
Bram Moolenaar071d4272004-06-13 20:20:40 +00004098 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004099'history' 'hi' number (Vim default: 50, Vi default: 0,
4100 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004101 global
4102 {not in Vi}
4103 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004104 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004105 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004106 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004107 NOTE: This option is set to the Vi default value when 'compatible' is
4108 set and to the Vim default value when 'compatible' is reset.
4109
4110 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4111'hkmap' 'hk' boolean (default off)
4112 global
4113 {not in Vi}
4114 {only available when compiled with the |+rightleft|
4115 feature}
4116 When on, the keyboard is mapped for the Hebrew character set.
4117 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4118 toggle this option. See |rileft.txt|.
4119 NOTE: This option is reset when 'compatible' is set.
4120
4121 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4122'hkmapp' 'hkp' boolean (default off)
4123 global
4124 {not in Vi}
4125 {only available when compiled with the |+rightleft|
4126 feature}
4127 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4128 This is useful if you have a non-Hebrew keyboard.
4129 See |rileft.txt|.
4130 NOTE: This option is reset when 'compatible' is set.
4131
Bram Moolenaar036986f2017-03-16 17:41:02 +01004132 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4133'hlsearch' 'hls' boolean (default off)
4134 global
4135 {not in Vi}
4136 {not available when compiled without the
4137 |+extra_search| feature}
4138 When there is a previous search pattern, highlight all its matches.
4139 The type of highlighting used can be set with the 'l' occasion in the
4140 'highlight' option. This uses the "Search" highlight group by
4141 default. Note that only the matching text is highlighted, any offsets
4142 are not applied.
4143 See also: 'incsearch' and |:match|.
4144 When you get bored looking at the highlighted matches, you can turn it
4145 off with |:nohlsearch|. This does not change the option value, as
4146 soon as you use a search command, the highlighting comes back.
4147 'redrawtime' specifies the maximum time spent on finding matches.
4148 When the search pattern can match an end-of-line, Vim will try to
4149 highlight all of the matched text. However, this depends on where the
4150 search starts. This will be the first line in the window or the first
4151 line below a closed fold. A match in a previous line which is not
4152 drawn may not continue in a newly drawn line.
4153 You can specify whether the highlight status is restored on startup
4154 with the 'h' flag in 'viminfo' |viminfo-h|.
4155 NOTE: This option is reset when 'compatible' is set.
4156
Bram Moolenaar071d4272004-06-13 20:20:40 +00004157 *'icon'* *'noicon'*
4158'icon' boolean (default off, on when title can be restored)
4159 global
4160 {not in Vi}
4161 {not available when compiled without the |+title|
4162 feature}
4163 When on, the icon text of the window will be set to the value of
4164 'iconstring' (if it is not empty), or to the name of the file
4165 currently being edited. Only the last part of the name is used.
4166 Overridden by the 'iconstring' option.
4167 Only works if the terminal supports setting window icons (currently
4168 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4169 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4170 builtin termcap).
4171 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004172 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004173 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004174 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004175
4176 *'iconstring'*
4177'iconstring' string (default "")
4178 global
4179 {not in Vi}
4180 {not available when compiled without the |+title|
4181 feature}
4182 When this option is not empty, it will be used for the icon text of
4183 the window. This happens only when the 'icon' option is on.
4184 Only works if the terminal supports setting window icon text
4185 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4186 Does not work for MS Windows.
4187 When Vim was compiled with HAVE_X11 defined, the original icon will be
4188 restored if possible |X11|.
4189 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004190 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004191 'titlestring' for example settings.
4192 {not available when compiled without the |+statusline| feature}
4193
4194 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4195'ignorecase' 'ic' boolean (default off)
4196 global
4197 Ignore case in search patterns. Also used when searching in the tags
4198 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004199 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004200 Can be overruled by using "\c" or "\C" in the pattern, see
4201 |/ignorecase|.
4202
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004203 *'imactivatefunc'* *'imaf'*
4204'imactivatefunc' 'imaf' string (default "")
4205 global
4206 {not in Vi}
4207 {only available when compiled with |+xim| and
4208 |+GUI_GTK|}
4209 This option specifies a function that will be called to
4210 activate/inactivate Input Method.
4211
4212 Example: >
4213 function ImActivateFunc(active)
4214 if a:active
4215 ... do something
4216 else
4217 ... do something
4218 endif
4219 " return value is not used
4220 endfunction
4221 set imactivatefunc=ImActivateFunc
4222<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004223 *'imactivatekey'* *'imak'*
4224'imactivatekey' 'imak' string (default "")
4225 global
4226 {not in Vi}
4227 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004228 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004229 Specifies the key that your Input Method in X-Windows uses for
4230 activation. When this is specified correctly, vim can fully control
4231 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4232 You can't use this option to change the activation key, the option
4233 tells Vim what the key is.
4234 Format:
4235 [MODIFIER_FLAG-]KEY_STRING
4236
4237 These characters can be used for MODIFIER_FLAG (case is ignored):
4238 S Shift key
4239 L Lock key
4240 C Control key
4241 1 Mod1 key
4242 2 Mod2 key
4243 3 Mod3 key
4244 4 Mod4 key
4245 5 Mod5 key
4246 Combinations are allowed, for example "S-C-space" or "SC-space" are
4247 both shift+ctrl+space.
4248 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4249
4250 Example: >
4251 :set imactivatekey=S-space
4252< "S-space" means shift+space. This is the activation key for kinput2 +
4253 canna (Japanese), and ami (Korean).
4254
4255 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4256'imcmdline' 'imc' boolean (default off)
4257 global
4258 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004259 {only available when compiled with the |+xim|,
4260 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004261 When set the Input Method is always on when starting to edit a command
4262 line, unless entering a search pattern (see 'imsearch' for that).
4263 Setting this option is useful when your input method allows entering
4264 English characters directly, e.g., when it's used to type accented
4265 characters with dead keys.
4266
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004267 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004268'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4269 global
4270 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004271 {only available when compiled with the |+xim|,
4272 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004273 When set the Input Method is never used. This is useful to disable
4274 the IM when it doesn't work properly.
4275 Currently this option is on by default for SGI/IRIX machines. This
4276 may change in later releases.
4277
4278 *'iminsert'* *'imi'*
4279'iminsert' 'imi' number (default 0, 2 when an input method is supported)
4280 local to buffer
4281 {not in Vi}
4282 Specifies whether :lmap or an Input Method (IM) is to be used in
4283 Insert mode. Valid values:
4284 0 :lmap is off and IM is off
4285 1 :lmap is ON and IM is off
4286 2 :lmap is off and IM is ON
4287 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
4288 or |global-ime|.
4289 To always reset the option to zero when leaving Insert mode with <Esc>
4290 this can be used: >
4291 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4292< This makes :lmap and IM turn off automatically when leaving Insert
4293 mode.
4294 Note that this option changes when using CTRL-^ in Insert mode
4295 |i_CTRL-^|.
4296 The value is set to 1 when setting 'keymap' to a valid keymap name.
4297 It is also used for the argument of commands like "r" and "f".
4298 The value 0 may not work correctly with Athena and Motif with some XIM
4299 methods. Use 'imdisable' to disable XIM then.
4300
4301 *'imsearch'* *'ims'*
4302'imsearch' 'ims' number (default 0, 2 when an input method is supported)
4303 local to buffer
4304 {not in Vi}
4305 Specifies whether :lmap or an Input Method (IM) is to be used when
4306 entering a search pattern. Valid values:
4307 -1 the value of 'iminsert' is used, makes it look like
4308 'iminsert' is also used when typing a search pattern
4309 0 :lmap is off and IM is off
4310 1 :lmap is ON and IM is off
4311 2 :lmap is off and IM is ON
4312 Note that this option changes when using CTRL-^ in Command-line mode
4313 |c_CTRL-^|.
4314 The value is set to 1 when it is not -1 and setting the 'keymap'
4315 option to a valid keymap name.
4316 The value 0 may not work correctly with Athena and Motif with some XIM
4317 methods. Use 'imdisable' to disable XIM then.
4318
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004319 *'imstatusfunc'* *'imsf'*
4320'imstatusfunc' 'imsf' string (default "")
4321 global
4322 {not in Vi}
4323 {only available when compiled with |+xim| and
4324 |+GUI_GTK|}
4325 This option specifies a function that is called to obtain the status
4326 of Input Method. It must return a positive number when IME is active.
4327
4328 Example: >
4329 function ImStatusFunc()
4330 let is_active = ...do something
4331 return is_active ? 1 : 0
4332 endfunction
4333 set imstatusfunc=ImStatusFunc
4334<
4335 NOTE: This function is invoked very often. Keep it fast.
4336
Bram Moolenaar071d4272004-06-13 20:20:40 +00004337 *'include'* *'inc'*
4338'include' 'inc' string (default "^\s*#\s*include")
4339 global or local to buffer |global-local|
4340 {not in Vi}
4341 {not available when compiled without the
4342 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004343 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004344 pattern, just like for the "/" command (See |pattern|). The default
4345 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004346 "]I", "[d", etc.
4347 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004348 comes after the matched pattern. But if "\zs" appears in the pattern
4349 then the text matched from "\zs" to the end, or until "\ze" if it
4350 appears, is used as the file name. Use this to include characters
4351 that are not in 'isfname', such as a space. You can then use
4352 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004353 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004354
4355 *'includeexpr'* *'inex'*
4356'includeexpr' 'inex' string (default "")
4357 local to buffer
4358 {not in Vi}
4359 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004360 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004361 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004362 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004363 :set includeexpr=substitute(v:fname,'\\.','/','g')
4364< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004365
Bram Moolenaar071d4272004-06-13 20:20:40 +00004366 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004367 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004368 Also used for |<cfile>|.
4369
Bram Moolenaar30b65812012-07-12 22:01:11 +02004370 The expression will be evaluated in the |sandbox| when set from a
4371 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004372
4373 It is not allowed to change text or jump to another window while
4374 evaluating 'includeexpr' |textlock|.
4375
Bram Moolenaar071d4272004-06-13 20:20:40 +00004376 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004377'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4378 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004379 global
4380 {not in Vi}
4381 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004382 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004383 While typing a search command, show where the pattern, as it was typed
4384 so far, matches. The matched string is highlighted. If the pattern
4385 is invalid or not found, nothing is shown. The screen will be updated
4386 often, this is only useful on fast terminals.
4387 Note that the match will be shown, but the cursor will return to its
4388 original position when no match is found and when pressing <Esc>. You
4389 still need to finish the search command with <Enter> to move the
4390 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004391 You can use the CTRL-G and CTRL-T keys to move to the next and
4392 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004393 When compiled with the |+reltime| feature Vim only searches for about
4394 half a second. With a complicated pattern and/or a lot of text the
4395 match may not be found. This is to avoid that Vim hangs while you
4396 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004397 The highlighting can be set with the 'i' flag in 'highlight'.
4398 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004399 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004400 to the command line. If 'ignorecase' and 'smartcase' are set and the
4401 command line has no uppercase characters, the added character is
4402 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004403 CTRL-R CTRL-W can be used to add the word at the end of the current
4404 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004405 NOTE: This option is reset when 'compatible' is set.
4406
4407 *'indentexpr'* *'inde'*
4408'indentexpr' 'inde' string (default "")
4409 local to buffer
4410 {not in Vi}
4411 {not available when compiled without the |+cindent|
4412 or |+eval| features}
4413 Expression which is evaluated to obtain the proper indent for a line.
4414 It is used when a new line is created, for the |=| operator and
4415 in Insert mode as specified with the 'indentkeys' option.
4416 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004417 'smartindent' indenting. When 'lisp' is set, this option is
4418 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004419 When 'paste' is set this option is not used for indenting.
4420 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004421 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004422 when the expression is evaluated (but it may be moved around).
4423 The expression must return the number of spaces worth of indent. It
4424 can return "-1" to keep the current indent (this means 'autoindent' is
4425 used for the indent).
4426 Functions useful for computing the indent are |indent()|, |cindent()|
4427 and |lispindent()|.
4428 The evaluation of the expression must not have side effects! It must
4429 not change the text, jump to another window, etc. Afterwards the
4430 cursor position is always restored, thus the cursor may be moved.
4431 Normally this option would be set to call a function: >
4432 :set indentexpr=GetMyIndent()
4433< Error messages will be suppressed, unless the 'debug' option contains
4434 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004435 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004436 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004437
Bram Moolenaar30b65812012-07-12 22:01:11 +02004438 The expression will be evaluated in the |sandbox| when set from a
4439 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004440
4441 It is not allowed to change text or jump to another window while
4442 evaluating 'indentexpr' |textlock|.
4443
4444
Bram Moolenaar071d4272004-06-13 20:20:40 +00004445 *'indentkeys'* *'indk'*
4446'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4447 local to buffer
4448 {not in Vi}
4449 {not available when compiled without the |+cindent|
4450 feature}
4451 A list of keys that, when typed in Insert mode, cause reindenting of
4452 the current line. Only happens if 'indentexpr' isn't empty.
4453 The format is identical to 'cinkeys', see |indentkeys-format|.
4454 See |C-indenting| and |indent-expression|.
4455
4456 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4457'infercase' 'inf' boolean (default off)
4458 local to buffer
4459 {not in Vi}
4460 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004461 'ignorecase' is also on, the case of the match is adjusted depending
4462 on the typed text. If the typed text contains a lowercase letter
4463 where the match has an upper case letter, the completed part is made
4464 lowercase. If the typed text has no lowercase letters and the match
4465 has a lowercase letter where the typed text has an uppercase letter,
4466 and there is a letter before it, the completed part is made uppercase.
4467 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004468
4469 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4470'insertmode' 'im' boolean (default off)
4471 global
4472 {not in Vi}
4473 Makes Vim work in a way that Insert mode is the default mode. Useful
4474 if you want to use Vim as a modeless editor. Used for |evim|.
4475 These Insert mode commands will be useful:
4476 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004477 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004478 this is a mapping, it is executed as if 'insertmode' was off.
4479 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004480 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004481 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4482 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004483
4484 These items change when 'insertmode' is set:
4485 - when starting to edit of a file, Vim goes to Insert mode.
4486 - <Esc> in Insert mode is a no-op and beeps.
4487 - <Esc> in Normal mode makes Vim go to Insert mode.
4488 - CTRL-L in Insert mode is a command, it is not inserted.
4489 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4490 However, when <Esc> is used inside a mapping, it behaves like
4491 'insertmode' was not set. This was done to be able to use the same
4492 mappings with 'insertmode' set or not set.
4493 When executing commands with |:normal| 'insertmode' is not used.
4494
4495 NOTE: This option is reset when 'compatible' is set.
4496
4497 *'isfname'* *'isf'*
4498'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4499 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4500 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4501 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4502 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4503 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4504 global
4505 {not in Vi}
4506 The characters specified by this option are included in file names and
4507 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004508 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004509 Multi-byte characters 256 and above are always included, only the
4510 characters up to 255 are specified with this option.
4511 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004512 Think twice before adding white space to this option. Although a
4513 space may appear inside a file name, the effect will be that Vim
4514 doesn't know where a file name starts or ends when doing completion.
4515 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004516
4517 Note that on systems using a backslash as path separator, Vim tries to
4518 do its best to make it work as you would expect. That is a bit
4519 tricky, since Vi originally used the backslash to escape special
4520 characters. Vim will not remove a backslash in front of a normal file
4521 name character on these systems, but it will on Unix and alikes. The
4522 '&' and '^' are not included by default, because these are special for
4523 cmd.exe.
4524
4525 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004526 Each part can be a single character number or a range. A range is two
4527 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004528 decimal number between 0 and 255 or the ASCII character itself (does
4529 not work for digits). Example:
4530 "_,-,128-140,#-43" (include '_' and '-' and the range
4531 128 to 140 and '#' to 43)
4532 If a part starts with '^', the following character number or range
4533 will be excluded from the option. The option is interpreted from left
4534 to right. Put the excluded character after the range where it is
4535 included. To include '^' itself use it as the last character of the
4536 option or the end of a range. Example:
4537 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4538 If the character is '@', all characters where isalpha() returns TRUE
4539 are included. Normally these are the characters a to z and A to Z,
4540 plus accented characters. To include '@' itself use "@-@". Examples:
4541 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004542 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004543 "a-z,A-Z,@-@" All letters plus the '@' character.
4544 A comma can be included by using it where a character number is
4545 expected. Example:
4546 "48-57,,,_" Digits, comma and underscore.
4547 A comma can be excluded by prepending a '^'. Example:
4548 " -~,^,,9" All characters from space to '~', excluding
4549 comma, plus <Tab>.
4550 See |option-backslash| about including spaces and backslashes.
4551
4552 *'isident'* *'isi'*
4553'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4554 "@,48-57,_,128-167,224-235"
4555 otherwise: "@,48-57,_,192-255")
4556 global
4557 {not in Vi}
4558 The characters given by this option are included in identifiers.
4559 Identifiers are used in recognizing environment variables and after a
4560 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004561 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004562 option.
4563 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004564 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004565 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4566
4567 *'iskeyword'* *'isk'*
4568'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4569 "@,48-57,_,128-167,224-235"
4570 otherwise: "@,48-57,_,192-255"
4571 Vi default: "@,48-57,_")
4572 local to buffer
4573 {not in Vi}
4574 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004575 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004576 'isfname' for a description of the format of this option. For C
4577 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4578 For a help file it is set to all non-blank printable characters except
4579 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4580 command).
4581 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004582 This option also influences syntax highlighting, unless the syntax
4583 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004584 NOTE: This option is set to the Vi default value when 'compatible' is
4585 set and to the Vim default value when 'compatible' is reset.
4586
4587 *'isprint'* *'isp'*
4588'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4589 "@,~-255"; otherwise: "@,161-255")
4590 global
4591 {not in Vi}
4592 The characters given by this option are displayed directly on the
4593 screen. It is also used for "\p" in a |pattern|. The characters from
4594 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4595 even when they are not included in 'isprint' or excluded. See
4596 'isfname' for a description of the format of this option.
4597
4598 Non-printable characters are displayed with two characters:
4599 0 - 31 "^@" - "^_"
4600 32 - 126 always single characters
4601 127 "^?"
4602 128 - 159 "~@" - "~_"
4603 160 - 254 "| " - "|~"
4604 255 "~?"
4605 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4606 displayed as <xx>, with the hexadecimal value of the byte.
4607 When 'display' contains "uhex" all unprintable characters are
4608 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004609 The SpecialKey highlighting will be used for unprintable characters.
4610 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004611
4612 Multi-byte characters 256 and above are always included, only the
4613 characters up to 255 are specified with this option. When a character
4614 is printable but it is not available in the current font, a
4615 replacement character will be shown.
4616 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4617 There is no option to specify these characters.
4618
4619 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4620'joinspaces' 'js' boolean (default on)
4621 global
4622 {not in Vi}
4623 Insert two spaces after a '.', '?' and '!' with a join command.
4624 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4625 Otherwise only one space is inserted.
4626 NOTE: This option is set when 'compatible' is set.
4627
4628 *'key'*
4629'key' string (default "")
4630 local to buffer
4631 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004632 {only available when compiled with the |+cryptv|
4633 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004634 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004635 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004636 Careful: Do not set the key value by hand, someone might see the typed
4637 key. Use the |:X| command. But you can make 'key' empty: >
4638 :set key=
4639< It is not possible to get the value of this option with ":set key" or
4640 "echo &key". This is to avoid showing it to someone who shouldn't
4641 know. It also means you cannot see it yourself once you have set it,
4642 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004643 You can use "&key" in an expression to detect whether encryption is
4644 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004645
4646 *'keymap'* *'kmp'* *E544*
4647'keymap' 'kmp' string (default "")
4648 local to buffer
4649 {not in Vi}
4650 {only available when compiled with the |+keymap|
4651 feature}
4652 Name of a keyboard mapping. See |mbyte-keymap|.
4653 Setting this option to a valid keymap name has the side effect of
4654 setting 'iminsert' to one, so that the keymap becomes effective.
4655 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004656 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004657
4658 *'keymodel'* *'km'*
4659'keymodel' 'km' string (default "")
4660 global
4661 {not in Vi}
4662 List of comma separated words, which enable special things that keys
4663 can do. These values can be used:
4664 startsel Using a shifted special key starts selection (either
4665 Select mode or Visual mode, depending on "key" being
4666 present in 'selectmode').
4667 stopsel Using a not-shifted special key stops selection.
4668 Special keys in this context are the cursor keys, <End>, <Home>,
4669 <PageUp> and <PageDown>.
4670 The 'keymodel' option is set by the |:behave| command.
4671
4672 *'keywordprg'* *'kp'*
4673'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004674 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004675 global or local to buffer |global-local|
4676 {not in Vi}
4677 Program to use for the |K| command. Environment variables are
4678 expanded |:set_env|. ":help" may be used to access the Vim internal
4679 help. (Note that previously setting the global option to the empty
4680 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004681 When the first character is ":", the command is invoked as a Vim
4682 Ex command prefixed with [count].
4683 When "man", "man -s" or an Ex command is used, Vim will automatically
4684 translate a count for the "K" command and pass it as the first
4685 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004686 See |option-backslash| about including spaces and backslashes.
4687 Example: >
4688 :set keywordprg=man\ -s
4689< This option cannot be set from a |modeline| or in the |sandbox|, for
4690 security reasons.
4691
4692 *'langmap'* *'lmap'* *E357* *E358*
4693'langmap' 'lmap' string (default "")
4694 global
4695 {not in Vi}
4696 {only available when compiled with the |+langmap|
4697 feature}
4698 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004699 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004700 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004701 care of translating these special characters to the original meaning
4702 of the key. This means you don't have to change the keyboard mode to
4703 be able to execute Normal mode commands.
4704 This is the opposite of the 'keymap' option, where characters are
4705 mapped in Insert mode.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004706 Also consider resetting 'langremap' to avoid 'langmap' applies to
Bram Moolenaarc2299672014-11-13 14:25:38 +01004707 characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004708 This option cannot be set from a |modeline| or in the |sandbox|, for
4709 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004710
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004711 Example (for Greek, in UTF-8): *greek* >
4712 :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 +00004713< Example (exchanges meaning of z and y for commands): >
4714 :set langmap=zy,yz,ZY,YZ
4715<
4716 The 'langmap' option is a list of parts, separated with commas. Each
4717 part can be in one of two forms:
4718 1. A list of pairs. Each pair is a "from" character immediately
4719 followed by the "to" character. Examples: "aA", "aAbBcC".
4720 2. A list of "from" characters, a semi-colon and a list of "to"
4721 characters. Example: "abc;ABC"
4722 Example: "aA,fgh;FGH,cCdDeE"
4723 Special characters need to be preceded with a backslash. These are
4724 ";", ',' and backslash itself.
4725
4726 This will allow you to activate vim actions without having to switch
4727 back and forth between the languages. Your language characters will
4728 be understood as normal vim English characters (according to the
4729 langmap mappings) in the following cases:
4730 o Normal/Visual mode (commands, buffer/register names, user mappings)
4731 o Insert/Replace Mode: Register names after CTRL-R
4732 o Insert/Replace Mode: Mappings
4733 Characters entered in Command-line mode will NOT be affected by
4734 this option. Note that this option can be changed at any time
4735 allowing to switch between mappings for different languages/encodings.
4736 Use a mapping to avoid having to type it each time!
4737
4738 *'langmenu'* *'lm'*
4739'langmenu' 'lm' string (default "")
4740 global
4741 {not in Vi}
4742 {only available when compiled with the |+menu| and
4743 |+multi_lang| features}
4744 Language to use for menu translation. Tells which file is loaded
4745 from the "lang" directory in 'runtimepath': >
4746 "lang/menu_" . &langmenu . ".vim"
4747< (without the spaces). For example, to always use the Dutch menus, no
4748 matter what $LANG is set to: >
4749 :set langmenu=nl_NL.ISO_8859-1
4750< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004751 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004752 If your $LANG is set to a non-English language but you do want to use
4753 the English menus: >
4754 :set langmenu=none
4755< This option must be set before loading menus, switching on filetype
4756 detection or syntax highlighting. Once the menus are defined setting
4757 this option has no effect. But you could do this: >
4758 :source $VIMRUNTIME/delmenu.vim
4759 :set langmenu=de_DE.ISO_8859-1
4760 :source $VIMRUNTIME/menu.vim
4761< Warning: This deletes all menus that you defined yourself!
4762
Bram Moolenaard94464e2015-11-02 15:28:18 +01004763 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004764'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004765 global
4766 {not in Vi}
4767 {only available when compiled with the |+langmap|
4768 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004769 This is just like 'langremap' but with the value inverted. It only
4770 exists for backwards compatibility. When setting 'langremap' then
4771 'langnoremap' is set to the inverted value, and the other way around.
4772
4773 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
4774'langremap' 'lrm' boolean (default on, reset in |defaults.vim|)
4775 global
4776 {not in Vi}
4777 {only available when compiled with the |+langmap|
4778 feature}
4779 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004780 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004781 'langmap' disables some of your mappings, try resetting this option.
4782 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004783 that works for you to avoid mappings to break.
4784
Bram Moolenaar071d4272004-06-13 20:20:40 +00004785 *'laststatus'* *'ls'*
4786'laststatus' 'ls' number (default 1)
4787 global
4788 {not in Vi}
4789 The value of this option influences when the last window will have a
4790 status line:
4791 0: never
4792 1: only if there are at least two windows
4793 2: always
4794 The screen looks nicer with a status line if you have several
4795 windows, but it takes another screen line. |status-line|
4796
4797 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4798'lazyredraw' 'lz' boolean (default off)
4799 global
4800 {not in Vi}
4801 When this option is set, the screen will not be redrawn while
4802 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004803 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004804 update use |:redraw|.
4805
4806 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4807'linebreak' 'lbr' boolean (default off)
4808 local to window
4809 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004810 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004811 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004812 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004813 than at the last character that fits on the screen. Unlike
4814 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004815 it only affects the way the file is displayed, not its contents.
4816 If 'breakindent' is set, line is visually indented. Then, the value
4817 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004818 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004819 Note that <Tab> characters after an <EOL> are mostly not displayed
4820 with the right amount of white space.
4821
4822 *'lines'* *E593*
4823'lines' number (default 24 or terminal height)
4824 global
4825 Number of lines of the Vim window.
4826 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004827 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004828 When Vim is running in the GUI or in a resizable window, setting this
4829 option will cause the window size to be changed. When you only want
4830 to use the size for the GUI, put the command in your |gvimrc| file.
4831 Vim limits the number of lines to what fits on the screen. You can
4832 use this command to get the tallest window possible: >
4833 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004834< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004835 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004836 When you set this option and Vim is unable to change the physical
4837 number of lines of the display, the display may be messed up.
4838
4839 *'linespace'* *'lsp'*
4840'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4841 global
4842 {not in Vi}
4843 {only in the GUI}
4844 Number of pixel lines inserted between characters. Useful if the font
4845 uses the full character cell height, making lines touch each other.
4846 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004847 With some fonts there can be too much room between lines (to have
4848 space for ascents and descents). Then it makes sense to set
4849 'linespace' to a negative value. This may cause display problems
4850 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004851
4852 *'lisp'* *'nolisp'*
4853'lisp' boolean (default off)
4854 local to buffer
4855 {not available when compiled without the |+lispindent|
4856 feature}
4857 Lisp mode: When <Enter> is typed in insert mode set the indent for
4858 the next line to Lisp standards (well, sort of). Also happens with
4859 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4860 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4861 better. Also see 'lispwords'.
4862 The '-' character is included in keyword characters. Redefines the
4863 "=" operator to use this same indentation algorithm rather than
4864 calling an external program if 'equalprg' is empty.
4865 This option is not used when 'paste' is set.
4866 {Vi: Does it a little bit differently}
4867
4868 *'lispwords'* *'lw'*
4869'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004870 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004871 {not in Vi}
4872 {not available when compiled without the |+lispindent|
4873 feature}
4874 Comma separated list of words that influence the Lisp indenting.
4875 |'lisp'|
4876
4877 *'list'* *'nolist'*
4878'list' boolean (default off)
4879 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004880 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4881 line. Useful to see the difference between tabs and spaces and for
4882 trailing blanks. Further changed by the 'listchars' option.
4883
4884 The cursor is displayed at the start of the space a Tab character
4885 occupies, not at the end as usual in Normal mode. To get this cursor
4886 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004887 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004888<
4889 Note that list mode will also affect formatting (set with 'textwidth'
4890 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004891 changing the way tabs are displayed.
4892
4893 *'listchars'* *'lcs'*
4894'listchars' 'lcs' string (default "eol:$")
4895 global
4896 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004897 Strings to use in 'list' mode and for the |:list| command. It is a
4898 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004899 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004900 eol:c Character to show at the end of each line. When
4901 omitted, there is no extra character at the end of the
4902 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004903 *lcs-tab*
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004904 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004905 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004906 fill the space that the tab normally occupies.
4907 "tab:>-" will show a tab that takes four spaces as
4908 ">---". When omitted, a tab is show as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004909 *lcs-space*
4910 space:c Character to show for a space. When omitted, spaces
4911 are left blank.
4912 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004913 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02004914 trailing spaces are blank. Overrides the "space"
4915 setting for trailing spaces.
4916 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004917 extends:c Character to show in the last column, when 'wrap' is
4918 off and the line continues beyond the right of the
4919 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004920 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004921 precedes:c Character to show in the first column, when 'wrap'
4922 is off and there is text preceding the character
4923 visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004924 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004925 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004926 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004927 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004928 nbsp:c Character to show for a non-breakable space character
4929 (0xA0 (160 decimal) and U+202F). Left blank when
4930 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004931
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004932 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004933 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004934 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004935
4936 Examples: >
4937 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004938 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004939 :set lcs=extends:>,precedes:<
4940< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02004941 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004942 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004943
4944 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4945'loadplugins' 'lpl' boolean (default on)
4946 global
4947 {not in Vi}
4948 When on the plugin scripts are loaded when starting up |load-plugins|.
4949 This option can be reset in your |vimrc| file to disable the loading
4950 of plugins.
4951 Note that using the "-u NONE" and "--noplugin" command line arguments
4952 reset this option. |-u| |--noplugin|
4953
Bram Moolenaard94464e2015-11-02 15:28:18 +01004954 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004955'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01004956 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004957 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01004958 {only available when compiled with the |+lua/dyn|
4959 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004960 Specifies the name of the Lua shared library. The default is
4961 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02004962 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01004963 This option cannot be set from a |modeline| or in the |sandbox|, for
4964 security reasons.
4965
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004966 *'macatsui'* *'nomacatsui'*
4967'macatsui' boolean (default on)
4968 global
4969 {only available in Mac GUI version}
4970 This is a workaround for when drawing doesn't work properly. When set
4971 and compiled with multi-byte support ATSUI text drawing is used. When
4972 not set ATSUI text drawing is not used. Switch this option off when
4973 you experience drawing problems. In a future version the problems may
4974 be solved and this option becomes obsolete. Therefore use this method
4975 to unset it: >
4976 if exists('&macatsui')
4977 set nomacatsui
4978 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004979< Another option to check if you have drawing problems is
4980 'termencoding'.
4981
Bram Moolenaar071d4272004-06-13 20:20:40 +00004982 *'magic'* *'nomagic'*
4983'magic' boolean (default on)
4984 global
4985 Changes the special characters that can be used in search patterns.
4986 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02004987 WARNING: Switching this option off most likely breaks plugins! That
4988 is because many patterns assume it's on and will fail when it's off.
4989 Only switch it off when working with old Vi scripts. In any other
4990 situation write patterns that work when 'magic' is on. Include "\M"
4991 when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004992
4993 *'makeef'* *'mef'*
4994'makeef' 'mef' string (default: "")
4995 global
4996 {not in Vi}
4997 {not available when compiled without the |+quickfix|
4998 feature}
4999 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5000 and the |:grep| command.
5001 When it is empty, an internally generated temp file will be used.
5002 When "##" is included, it is replaced by a number to make the name
5003 unique. This makes sure that the ":make" command doesn't overwrite an
5004 existing file.
5005 NOT used for the ":cf" command. See 'errorfile' for that.
5006 Environment variables are expanded |:set_env|.
5007 See |option-backslash| about including spaces and backslashes.
5008 This option cannot be set from a |modeline| or in the |sandbox|, for
5009 security reasons.
5010
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005011 *'makeencoding'* *'menc'*
5012'makeencoding' 'menc' string (default "")
5013 global or local to buffer |global-local|
5014 {only available when compiled with the |+multi_byte|
5015 feature}
5016 {not in Vi}
5017 Encoding used for reading the output of external commands. When empty,
5018 encoding is not converted.
5019 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5020 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5021 and `:laddfile`.
5022
5023 This would be mostly useful when you use MS-Windows and set 'encoding'
5024 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5025 'makeencoding' to "char" has the same effect as setting to the system
5026 locale encoding. Example: >
5027 :set encoding=utf-8
5028 :set makeencoding=char " system locale is used
5029<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005030 *'makeprg'* *'mp'*
5031'makeprg' 'mp' string (default "make", VMS: "MMS")
5032 global or local to buffer |global-local|
5033 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00005034 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar26df0922014-02-23 23:39:13 +01005035 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5036 which are expanded to the current and alternate file name. Use |::S|
5037 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005038 Environment variables are expanded |:set_env|. See |option-backslash|
5039 about including spaces and backslashes.
5040 Note that a '|' must be escaped twice: once for ":set" and once for
5041 the interpretation of a command. When you use a filter called
5042 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005043 :set makeprg=gmake\ \\\|\ myfilter
5044< The placeholder "$*" can be given (even multiple times) to specify
5045 where the arguments will be included, for example: >
5046 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5047< This option cannot be set from a |modeline| or in the |sandbox|, for
5048 security reasons.
5049
5050 *'matchpairs'* *'mps'*
5051'matchpairs' 'mps' string (default "(:),{:},[:]")
5052 local to buffer
5053 {not in Vi}
5054 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005055 other.
5056 Only character pairs are allowed that are different, thus you cannot
5057 jump between two double quotes.
5058 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005059 The pairs must be separated by a comma. Example for including '<' and
5060 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005061 :set mps+=<:>
5062
5063< A more exotic example, to jump between the '=' and ';' in an
5064 assignment, useful for languages like C and Java: >
5065 :au FileType c,cpp,java set mps+==:;
5066
5067< For a more advanced way of using "%", see the matchit.vim plugin in
5068 the $VIMRUNTIME/macros directory. |add-local-help|
5069
5070 *'matchtime'* *'mat'*
5071'matchtime' 'mat' number (default 5)
5072 global
5073 {not in Vi}{in Nvi}
5074 Tenths of a second to show the matching paren, when 'showmatch' is
5075 set. Note that this is not in milliseconds, like other options that
5076 set a time. This is to be compatible with Nvi.
5077
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005078 *'maxcombine'* *'mco'*
5079'maxcombine' 'mco' number (default 2)
5080 global
5081 {not in Vi}
5082 {only available when compiled with the |+multi_byte|
5083 feature}
5084 The maximum number of combining characters supported for displaying.
5085 Only used when 'encoding' is "utf-8".
5086 The default is OK for most languages. Hebrew may require 4.
5087 Maximum value is 6.
5088 Even when this option is set to 2 you can still edit text with more
5089 combining characters, you just can't see them. Use |g8| or |ga|.
5090 See |mbyte-combining|.
5091
Bram Moolenaar071d4272004-06-13 20:20:40 +00005092 *'maxfuncdepth'* *'mfd'*
5093'maxfuncdepth' 'mfd' number (default 100)
5094 global
5095 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005096 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005097 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005098 Maximum depth of function calls for user functions. This normally
5099 catches endless recursion. When using a recursive function with
5100 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5101 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005102 Increasing this limit above 200 also changes the maximum for Ex
5103 command resursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005104 See also |:function|.
5105
5106 *'maxmapdepth'* *'mmd'* *E223*
5107'maxmapdepth' 'mmd' number (default 1000)
5108 global
5109 {not in Vi}
5110 Maximum number of times a mapping is done without resulting in a
5111 character to be used. This normally catches endless mappings, like
5112 ":map x y" with ":map y x". It still does not catch ":map g wg",
5113 because the 'w' is used before the next mapping is done. See also
5114 |key-mapping|.
5115
5116 *'maxmem'* *'mm'*
5117'maxmem' 'mm' number (default between 256 to 5120 (system
5118 dependent) or half the amount of memory
5119 available)
5120 global
5121 {not in Vi}
5122 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5123 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005124 other memory to be freed. The maximum usable value is about 2000000.
5125 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005126
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005127 *'maxmempattern'* *'mmp'*
5128'maxmempattern' 'mmp' number (default 1000)
5129 global
5130 {not in Vi}
5131 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005132 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005133 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005134 When Vim runs into the limit it gives an error message and mostly
5135 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005136 Running into the limit often means that the pattern is very
5137 inefficient or too complex. This may already happen with the pattern
5138 "\(.\)*" on a very long line. ".*" works much better.
5139 Vim may run out of memory before hitting the 'maxmempattern' limit.
5140
Bram Moolenaar071d4272004-06-13 20:20:40 +00005141 *'maxmemtot'* *'mmt'*
5142'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5143 dependent) or half the amount of memory
5144 available)
5145 global
5146 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005147 Maximum amount of memory in Kbyte to use for all buffers together.
5148 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005149 without a limit.
5150 On 64 bit machines higher values might work. But hey, do you really
5151 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005152 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005153 need the memory to store undo info.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005154 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005155
5156 *'menuitems'* *'mis'*
5157'menuitems' 'mis' number (default 25)
5158 global
5159 {not in Vi}
5160 {not available when compiled without the |+menu|
5161 feature}
5162 Maximum number of items to use in a menu. Used for menus that are
5163 generated from a list of items, e.g., the Buffers menu. Changing this
5164 option has no direct effect, the menu must be refreshed first.
5165
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005166 *'mkspellmem'* *'msm'*
5167'mkspellmem' 'msm' string (default "460000,2000,500")
5168 global
5169 {not in Vi}
5170 {not available when compiled without the |+syntax|
5171 feature}
5172 Parameters for |:mkspell|. This tunes when to start compressing the
5173 word tree. Compression can be slow when there are many words, but
5174 it's needed to avoid running out of memory. The amount of memory used
5175 per word depends very much on how similar the words are, that's why
5176 this tuning is complicated.
5177
5178 There are three numbers, separated by commas:
5179 {start},{inc},{added}
5180
5181 For most languages the uncompressed word tree fits in memory. {start}
5182 gives the amount of memory in Kbyte that can be used before any
5183 compression is done. It should be a bit smaller than the amount of
5184 memory that is available to Vim.
5185
5186 When going over the {start} limit the {inc} number specifies the
5187 amount of memory in Kbyte that can be allocated before another
5188 compression is done. A low number means compression is done after
5189 less words are added, which is slow. A high number means more memory
5190 will be allocated.
5191
5192 After doing compression, {added} times 1024 words can be added before
5193 the {inc} limit is ignored and compression is done when any extra
5194 amount of memory is needed. A low number means there is a smaller
5195 chance of hitting the {inc} limit, less memory is used but it's
5196 slower.
5197
5198 The languages for which these numbers are important are Italian and
5199 Hungarian. The default works for when you have about 512 Mbyte. If
5200 you have 1 Gbyte you could use: >
5201 :set mkspellmem=900000,3000,800
5202< If you have less than 512 Mbyte |:mkspell| may fail for some
5203 languages, no matter what you set 'mkspellmem' to.
5204
Bram Moolenaar071d4272004-06-13 20:20:40 +00005205 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005206'modeline' 'ml' boolean (Vim default: on (off for root),
5207 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005208 local to buffer
5209 *'modelines'* *'mls'*
5210'modelines' 'mls' number (default 5)
5211 global
5212 {not in Vi}
5213 If 'modeline' is on 'modelines' gives the number of lines that is
5214 checked for set commands. If 'modeline' is off or 'modelines' is zero
5215 no lines are checked. See |modeline|.
5216 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5217 set and to the Vim default value when 'compatible' is reset.
5218
5219 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
5220'modifiable' 'ma' boolean (default on)
5221 local to buffer
5222 {not in Vi} *E21*
5223 When off the buffer contents cannot be changed. The 'fileformat' and
5224 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005225 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005226
5227 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5228'modified' 'mod' boolean (default off)
5229 local to buffer
5230 {not in Vi}
5231 When on, the buffer is considered to be modified. This option is set
5232 when:
5233 1. A change was made to the text since it was last written. Using the
5234 |undo| command to go back to the original text will reset the
5235 option. But undoing changes that were made before writing the
5236 buffer will set the option again, since the text is different from
5237 when it was written.
5238 2. 'fileformat' or 'fileencoding' is different from its original
5239 value. The original value is set when the buffer is read or
5240 written. A ":set nomodified" command also resets the original
5241 values to the current values and the 'modified' option will be
5242 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005243 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005244 This option is not set when a change is made to the buffer as the
5245 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5246 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5247 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005248 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5249 will be ignored.
5250
5251 *'more'* *'nomore'*
5252'more' boolean (Vim default: on, Vi default: off)
5253 global
5254 {not in Vi}
5255 When on, listings pause when the whole screen is filled. You will get
5256 the |more-prompt|. When this option is off there are no pauses, the
5257 listing continues until finished.
5258 NOTE: This option is set to the Vi default value when 'compatible' is
5259 set and to the Vim default value when 'compatible' is reset.
5260
5261 *'mouse'* *E538*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005262'mouse' string (default "", "a" for GUI, MS-DOS and Win32,
5263 set to "a" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005264 global
5265 {not in Vi}
5266 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00005267 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
5268 sysmouse and Linux console with gpm). For using the mouse in the
5269 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005270 The mouse can be enabled for different modes:
5271 n Normal mode
5272 v Visual mode
5273 i Insert mode
5274 c Command-line mode
5275 h all previous modes when editing a help file
5276 a all previous modes
5277 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00005278 Normally you would enable the mouse in all four modes with: >
5279 :set mouse=a
5280< When the mouse is not enabled, the GUI will still use the mouse for
5281 modeless selection. This doesn't move the text cursor.
5282
5283 See |mouse-using|. Also see |'clipboard'|.
5284
5285 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005286 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005287 the mouse buttons can still be used by keeping the shift key pressed.
5288 Also see the 'clipboard' option.
5289
5290 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5291'mousefocus' 'mousef' boolean (default off)
5292 global
5293 {not in Vi}
5294 {only works in the GUI}
5295 The window that the mouse pointer is on is automatically activated.
5296 When changing the window layout or window focus in another way, the
5297 mouse pointer is moved to the window with keyboard focus. Off is the
5298 default because it makes using the pull down menus a little goofy, as
5299 a pointer transit may activate a window unintentionally.
5300
5301 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5302'mousehide' 'mh' boolean (default on)
5303 global
5304 {not in Vi}
5305 {only works in the GUI}
5306 When on, the mouse pointer is hidden when characters are typed.
5307 The mouse pointer is restored when the mouse is moved.
5308
5309 *'mousemodel'* *'mousem'*
5310'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5311 global
5312 {not in Vi}
5313 Sets the model to use for the mouse. The name mostly specifies what
5314 the right mouse button is used for:
5315 extend Right mouse button extends a selection. This works
5316 like in an xterm.
5317 popup Right mouse button pops up a menu. The shifted left
5318 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005319 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005320 popup_setpos Like "popup", but the cursor will be moved to the
5321 position where the mouse was clicked, and thus the
5322 selected operation will act upon the clicked object.
5323 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005324 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005325 course, that right clicking outside a selection will
5326 end Visual mode.
5327 Overview of what button does what for each model:
5328 mouse extend popup(_setpos) ~
5329 left click place cursor place cursor
5330 left drag start selection start selection
5331 shift-left search word extend selection
5332 right click extend selection popup menu (place cursor)
5333 right drag extend selection -
5334 middle click paste paste
5335
5336 In the "popup" model the right mouse button produces a pop-up menu.
5337 You need to define this first, see |popup-menu|.
5338
5339 Note that you can further refine the meaning of buttons with mappings.
5340 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5341 selection (because that's handled in the GUI code directly).
5342
5343 The 'mousemodel' option is set by the |:behave| command.
5344
5345 *'mouseshape'* *'mouses'* *E547*
5346'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005347 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005348 global
5349 {not in Vi}
5350 {only available when compiled with the |+mouseshape|
5351 feature}
5352 This option tells Vim what the mouse pointer should look like in
5353 different modes. The option is a comma separated list of parts, much
5354 like used for 'guicursor'. Each part consist of a mode/location-list
5355 and an argument-list:
5356 mode-list:shape,mode-list:shape,..
5357 The mode-list is a dash separated list of these modes/locations:
5358 In a normal window: ~
5359 n Normal mode
5360 v Visual mode
5361 ve Visual mode with 'selection' "exclusive" (same as 'v',
5362 if not specified)
5363 o Operator-pending mode
5364 i Insert mode
5365 r Replace mode
5366
5367 Others: ~
5368 c appending to the command-line
5369 ci inserting in the command-line
5370 cr replacing in the command-line
5371 m at the 'Hit ENTER' or 'More' prompts
5372 ml idem, but cursor in the last line
5373 e any mode, pointer below last window
5374 s any mode, pointer on a status line
5375 sd any mode, while dragging a status line
5376 vs any mode, pointer on a vertical separator line
5377 vd any mode, while dragging a vertical separator line
5378 a everywhere
5379
5380 The shape is one of the following:
5381 avail name looks like ~
5382 w x arrow Normal mouse pointer
5383 w x blank no pointer at all (use with care!)
5384 w x beam I-beam
5385 w x updown up-down sizing arrows
5386 w x leftright left-right sizing arrows
5387 w x busy The system's usual busy pointer
5388 w x no The system's usual 'no input' pointer
5389 x udsizing indicates up-down resizing
5390 x lrsizing indicates left-right resizing
5391 x crosshair like a big thin +
5392 x hand1 black hand
5393 x hand2 white hand
5394 x pencil what you write with
5395 x question big ?
5396 x rightup-arrow arrow pointing right-up
5397 w x up-arrow arrow pointing up
5398 x <number> any X11 pointer number (see X11/cursorfont.h)
5399
5400 The "avail" column contains a 'w' if the shape is available for Win32,
5401 x for X11.
5402 Any modes not specified or shapes not available use the normal mouse
5403 pointer.
5404
5405 Example: >
5406 :set mouseshape=s:udsizing,m:no
5407< will make the mouse turn to a sizing arrow over the status lines and
5408 indicate no input when the hit-enter prompt is displayed (since
5409 clicking the mouse has no effect in this state.)
5410
5411 *'mousetime'* *'mouset'*
5412'mousetime' 'mouset' number (default 500)
5413 global
5414 {not in Vi}
5415 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5416 time in msec between two mouse clicks for the second click to be
5417 recognized as a multi click.
5418
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005419 *'mzquantum'* *'mzq'*
5420'mzquantum' 'mzq' number (default 100)
5421 global
5422 {not in Vi}
5423 {not available when compiled without the |+mzscheme|
5424 feature}
5425 The number of milliseconds between polls for MzScheme threads.
5426 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005427 NOTE: This option is set to the Vim default value when 'compatible'
5428 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005429
Bram Moolenaar071d4272004-06-13 20:20:40 +00005430 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005431'nrformats' 'nf' string (default "bin,octal,hex",
5432 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005433 local to buffer
5434 {not in Vi}
5435 This defines what bases Vim will consider for numbers when using the
5436 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5437 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005438 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005439 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005440 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005441 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005442 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005443 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005444 considered to be hexadecimal. Example: Using CTRL-X on
5445 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005446 bin If included, numbers starting with "0b" or "0B" will be
5447 considered to be binary. Example: Using CTRL-X on
5448 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005449 Numbers which simply begin with a digit in the range 1-9 are always
5450 considered decimal. This also happens for numbers that are not
5451 recognized as octal or hex.
5452
5453 *'number'* *'nu'* *'nonumber'* *'nonu'*
5454'number' 'nu' boolean (default off)
5455 local to window
5456 Print the line number in front of each line. When the 'n' option is
5457 excluded from 'cpoptions' a wrapped line will not use the column of
5458 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005459 The 'numberwidth' option can be used to set the room used for the line
5460 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005461 When a long, wrapped line doesn't start with the first character, '-'
5462 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005463 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5464 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005465 *number_relativenumber*
5466 The 'relativenumber' option changes the displayed number to be
5467 relative to the cursor. Together with 'number' there are these
5468 four combinations (cursor in line 3):
5469
Bram Moolenaar3848e002016-03-19 18:42:29 +01005470 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005471 'nornu' 'nornu' 'rnu' 'rnu'
5472
5473 |apple | 1 apple | 2 apple | 2 apple
5474 |pear | 2 pear | 1 pear | 1 pear
5475 |nobody | 3 nobody | 0 nobody |3 nobody
5476 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005477
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005478 *'numberwidth'* *'nuw'*
5479'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5480 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005481 {not in Vi}
5482 {only available when compiled with the |+linebreak|
5483 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005484 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005485 when the 'number' or 'relativenumber' option is set or printing lines
5486 with a line number. Since one space is always between the number and
5487 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005488 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005489 fit the highest line number in the buffer respectively the number of
5490 rows in the window, depending on whether 'number' or 'relativenumber'
5491 is set. Thus with the Vim default of 4 there is room for a line number
5492 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005493 The minimum value is 1, the maximum value is 10.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005494 NOTE: This option is set to the Vi default value when 'compatible' is
5495 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005496
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005497 *'omnifunc'* *'ofu'*
5498'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005499 local to buffer
5500 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005501 {not available when compiled without the |+eval|
5502 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005503 This option specifies a function to be used for Insert mode omni
5504 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005505 See |complete-functions| for an explanation of how the function is
5506 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005507 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005508 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005509 This option cannot be set from a |modeline| or in the |sandbox|, for
5510 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005511
5512
Bram Moolenaar02467872007-05-06 13:22:01 +00005513 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005514'opendevice' 'odev' boolean (default off)
5515 global
5516 {not in Vi}
5517 {only for MS-DOS, MS-Windows and OS/2}
5518 Enable reading and writing from devices. This may get Vim stuck on a
5519 device that can be opened but doesn't actually do the I/O. Therefore
5520 it is off by default.
5521 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5522 result in editing a device.
5523
5524
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005525 *'operatorfunc'* *'opfunc'*
5526'operatorfunc' 'opfunc' string (default: empty)
5527 global
5528 {not in Vi}
5529 This option specifies a function to be called by the |g@| operator.
5530 See |:map-operator| for more info and an example.
5531
5532 This option cannot be set from a |modeline| or in the |sandbox|, for
5533 security reasons.
5534
5535
Bram Moolenaar251e1912011-06-19 05:09:16 +02005536 *'osfiletype'* *'oft'*
5537'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005538 local to buffer
5539 {not in Vi}
Bram Moolenaar251e1912011-06-19 05:09:16 +02005540 This option was supported on RISC OS, which has been removed.
5541
Bram Moolenaar071d4272004-06-13 20:20:40 +00005542
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005543 *'packpath'* *'pp'*
5544'packpath' 'pp' string (default: see 'runtimepath')
5545 {not in Vi}
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005546 Directories used to find packages. See |packages|.
5547
5548
Bram Moolenaar071d4272004-06-13 20:20:40 +00005549 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005550'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005551 global
5552 Specifies the nroff macros that separate paragraphs. These are pairs
5553 of two letters (see |object-motions|).
5554
5555 *'paste'* *'nopaste'*
5556'paste' boolean (default off)
5557 global
5558 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005559 Put Vim in Paste mode. This is useful if you want to cut or copy
5560 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005561 unexpected effects.
5562 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005563 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005564 knows about pasting and will mostly do the right thing without 'paste'
5565 being set. The same is true for a terminal where Vim handles the
5566 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005567 This option is reset when starting the GUI. Thus if you set it in
5568 your .vimrc it will work in a terminal, but not in the GUI. Setting
5569 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5570 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005571 When the 'paste' option is switched on (also when it was already on):
5572 - mapping in Insert mode and Command-line mode is disabled
5573 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005574 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005575 - 'expandtab' is reset
5576 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005577 - 'revins' is reset
5578 - 'ruler' is reset
5579 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005580 - 'smartindent' is reset
5581 - 'smarttab' is reset
5582 - 'softtabstop' is set to 0
5583 - 'textwidth' is set to 0
5584 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005585 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005586 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005587 - 'indentexpr'
5588 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005589 NOTE: When you start editing another file while the 'paste' option is
5590 on, settings from the modelines or autocommands may change the
5591 settings again, causing trouble when pasting text. You might want to
5592 set the 'paste' option again.
5593 When the 'paste' option is reset the mentioned options are restored to
5594 the value before the moment 'paste' was switched from off to on.
5595 Resetting 'paste' before ever setting it does not have any effect.
5596 Since mapping doesn't work while 'paste' is active, you need to use
5597 the 'pastetoggle' option to toggle the 'paste' option with some key.
5598
5599 *'pastetoggle'* *'pt'*
5600'pastetoggle' 'pt' string (default "")
5601 global
5602 {not in Vi}
5603 When non-empty, specifies the key sequence that toggles the 'paste'
5604 option. This is like specifying a mapping: >
5605 :map {keys} :set invpaste<CR>
5606< Where {keys} is the value of 'pastetoggle'.
5607 The difference is that it will work even when 'paste' is set.
5608 'pastetoggle' works in Insert mode and Normal mode, but not in
5609 Command-line mode.
5610 Mappings are checked first, thus overrule 'pastetoggle'. However,
5611 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5612 this: >
5613 :map <F10> :set paste<CR>
5614 :map <F11> :set nopaste<CR>
5615 :imap <F10> <C-O>:set paste<CR>
5616 :imap <F11> <nop>
5617 :set pastetoggle=<F11>
5618< This will make <F10> start paste mode and <F11> stop paste mode.
5619 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5620 mode everything is inserted literally, except the 'pastetoggle' key
5621 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005622 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005623
5624 *'pex'* *'patchexpr'*
5625'patchexpr' 'pex' string (default "")
5626 global
5627 {not in Vi}
5628 {not available when compiled without the |+diff|
5629 feature}
5630 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005631 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005632
Bram Moolenaardbc28022014-07-26 13:40:44 +02005633 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005634'patchmode' 'pm' string (default "")
5635 global
5636 {not in Vi}
5637 When non-empty the oldest version of a file is kept. This can be used
5638 to keep the original version of a file if you are changing files in a
5639 source distribution. Only the first time that a file is written a
5640 copy of the original file will be kept. The name of the copy is the
5641 name of the original file with the string in the 'patchmode' option
5642 appended. This option should start with a dot. Use a string like
5643 ".org". 'backupdir' must not be empty for this to work (Detail: The
5644 backup file is renamed to the patchmode file after the new file has
5645 been successfully written, that's why it must be possible to write a
5646 backup file). If there was no file to be backed up, an empty file is
5647 created.
5648 When the 'backupskip' pattern matches, a patchmode file is not made.
5649 Using 'patchmode' for compressed files appends the extension at the
5650 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5651 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005652 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005653
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005654 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005655'path' 'pa' string (default on Unix: ".,/usr/include,,"
5656 on OS/2: ".,/emx/include,,"
5657 other systems: ".,,")
5658 global or local to buffer |global-local|
5659 {not in Vi}
5660 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005661 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5662 provided that the file being searched for has a relative path (not
5663 starting with "/", "./" or "../"). The directories in the 'path'
5664 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005665 - Use commas to separate directory names: >
5666 :set path=.,/usr/local/include,/usr/include
5667< - Spaces can also be used to separate directory names (for backwards
5668 compatibility with version 3.0). To have a space in a directory
5669 name, precede it with an extra backslash, and escape the space: >
5670 :set path=.,/dir/with\\\ space
5671< - To include a comma in a directory name precede it with an extra
5672 backslash: >
5673 :set path=.,/dir/with\\,comma
5674< - To search relative to the directory of the current file, use: >
5675 :set path=.
5676< - To search in the current directory use an empty string between two
5677 commas: >
5678 :set path=,,
5679< - A directory name may end in a ':' or '/'.
5680 - Environment variables are expanded |:set_env|.
5681 - When using |netrw.vim| URLs can be used. For example, adding
5682 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005683 - Search upwards and downwards in a directory tree using "*", "**" and
5684 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005685 {not available when compiled without the |+path_extra| feature}
5686 - Careful with '\' characters, type two to get one in the option: >
5687 :set path=.,c:\\include
5688< Or just use '/' instead: >
5689 :set path=.,c:/include
5690< Don't forget "." or files won't even be found in the same directory as
5691 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005692 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005693 it is something like 256 or 1024 characters.
5694 You can check if all the include files are found, using the value of
5695 'path', see |:checkpath|.
5696 The use of |:set+=| and |:set-=| is preferred when adding or removing
5697 directories from the list. This avoids problems when a future version
5698 uses another default. To remove the current directory use: >
5699 :set path-=
5700< To add the current directory use: >
5701 :set path+=
5702< To use an environment variable, you probably need to replace the
5703 separator. Here is an example to append $INCL, in which directory
5704 names are separated with a semi-colon: >
5705 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5706< Replace the ';' with a ':' or whatever separator is used. Note that
5707 this doesn't work when $INCL contains a comma or white space.
5708
Bram Moolenaard94464e2015-11-02 15:28:18 +01005709 *'perldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005710'perldll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005711 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005712 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01005713 {only available when compiled with the |+perl/dyn|
5714 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005715 Specifies the name of the Perl shared library. The default is
5716 DYNAMIC_PERL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005717 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005718 This option cannot be set from a |modeline| or in the |sandbox|, for
5719 security reasons.
5720
Bram Moolenaar071d4272004-06-13 20:20:40 +00005721 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5722'preserveindent' 'pi' boolean (default off)
5723 local to buffer
5724 {not in Vi}
5725 When changing the indent of the current line, preserve as much of the
5726 indent structure as possible. Normally the indent is replaced by a
5727 series of tabs followed by spaces as required (unless |'expandtab'| is
5728 enabled, in which case only spaces are used). Enabling this option
5729 means the indent will preserve as many existing characters as possible
5730 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005731 'expandtab' does not apply to the preserved white space, a Tab remains
5732 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005733 NOTE: When using ">>" multiple times the resulting indent is a mix of
5734 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005735 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005736 Also see 'copyindent'.
5737 Use |:retab| to clean up white space.
5738
5739 *'previewheight'* *'pvh'*
5740'previewheight' 'pvh' number (default 12)
5741 global
5742 {not in Vi}
5743 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005744 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005745 Default height for a preview window. Used for |:ptag| and associated
5746 commands. Used for |CTRL-W_}| when no count is given.
5747
5748 *'previewwindow'* *'nopreviewwindow'*
5749 *'pvw'* *'nopvw'* *E590*
5750'previewwindow' 'pvw' boolean (default off)
5751 local to window
5752 {not in Vi}
5753 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005754 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005755 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005756 set. It's normally not set directly, but by using one of the commands
5757 |:ptag|, |:pedit|, etc.
5758
5759 *'printdevice'* *'pdev'*
5760'printdevice' 'pdev' string (default empty)
5761 global
5762 {not in Vi}
5763 {only available when compiled with the |+printer|
5764 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005765 The name of the printer to be used for |:hardcopy|.
5766 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005767 This option cannot be set from a |modeline| or in the |sandbox|, for
5768 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005769
Bram Moolenaar8299df92004-07-10 09:47:34 +00005770 *'printencoding'* *'penc'*
5771'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005772 global
5773 {not in Vi}
5774 {only available when compiled with the |+printer|
5775 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005776 Sets the character encoding used when printing.
5777 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005778
5779 *'printexpr'* *'pexpr'*
5780'printexpr' 'pexpr' String (default: see below)
5781 global
5782 {not in Vi}
5783 {only available when compiled with the |+printer|
5784 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005785 Expression used to print the PostScript produced with |:hardcopy|.
5786 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005787 This option cannot be set from a |modeline| or in the |sandbox|, for
5788 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005789
Bram Moolenaar8299df92004-07-10 09:47:34 +00005790 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005791'printfont' 'pfn' string (default "courier")
5792 global
5793 {not in Vi}
5794 {only available when compiled with the |+printer|
5795 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005796 The name of the font that will be used for |:hardcopy|.
5797 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005798
5799 *'printheader'* *'pheader'*
5800'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5801 global
5802 {not in Vi}
5803 {only available when compiled with the |+printer|
5804 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005805 The format of the header produced in |:hardcopy| output.
5806 See |pheader-option|.
5807
5808 *'printmbcharset'* *'pmbcs'*
5809'printmbcharset' 'pmbcs' string (default "")
5810 global
5811 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005812 {only available when compiled with the |+printer|,
5813 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005814 The CJK character set to be used for CJK output from |:hardcopy|.
5815 See |pmbcs-option|.
5816
5817 *'printmbfont'* *'pmbfn'*
5818'printmbfont' 'pmbfn' string (default "")
5819 global
5820 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005821 {only available when compiled with the |+printer|,
5822 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005823 List of font names to be used for CJK output from |:hardcopy|.
5824 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005825
5826 *'printoptions'* *'popt'*
5827'printoptions' 'popt' string (default "")
5828 global
5829 {not in Vi}
5830 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005831 List of items that control the format of the output of |:hardcopy|.
5832 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005833
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005834 *'prompt'* *'noprompt'*
5835'prompt' boolean (default on)
5836 global
5837 When on a ":" prompt is used in Ex mode.
5838
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005839 *'pumheight'* *'ph'*
5840'pumheight' 'ph' number (default 0)
5841 global
5842 {not available when compiled without the
5843 |+insert_expand| feature}
5844 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005845 Determines the maximum number of items to show in the popup menu for
5846 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005847 |ins-completion-menu|.
5848
Bram Moolenaard94464e2015-11-02 15:28:18 +01005849 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005850'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005851 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005852 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01005853 {only available when compiled with the |+python/dyn|
5854 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005855 Specifies the name of the Python 2.x shared library. The default is
5856 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005857 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005858 This option cannot be set from a |modeline| or in the |sandbox|, for
5859 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005860
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005861 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005862'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005863 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005864 {not in Vi}
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005865 {only available when compiled with the |+python3/dyn|
5866 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005867 Specifies the name of the Python 3 shared library. The default is
5868 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005869 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005870 This option cannot be set from a |modeline| or in the |sandbox|, for
5871 security reasons.
5872
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005873 *'pyxversion'* *'pyx'*
5874'pyxversion' 'pyx' number (default depends on the build)
5875 global
5876 {not in Vi}
5877 {only available when compiled with the |+python| or
5878 the |+python3| feature}
5879 Specifies the python version used for pyx* functions and commands
5880 |python_x|. The default value is as follows:
5881
5882 Compiled with Default ~
5883 |+python| and |+python3| 0
5884 only |+python| 2
5885 only |+python3| 3
5886
5887 Available values are 0, 2 and 3.
5888 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
5889 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
5890 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
5891 to 2 if Python 2 is available.
5892 See also: |has-pythonx|
5893
5894 If Vim is compiled with only |+python| or |+python3| setting
5895 'pyxversion' has no effect. The pyx* functions and commands are
5896 always the same as the compiled version.
5897
5898 This option cannot be set from a |modeline| or in the |sandbox|, for
5899 security reasons.
5900
Bram Moolenaar677ee682005-01-27 14:41:15 +00005901 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005902'quoteescape' 'qe' string (default "\")
5903 local to buffer
5904 {not in Vi}
5905 The characters that are used to escape quotes in a string. Used for
5906 objects like a', a" and a` |a'|.
5907 When one of the characters in this option is found inside a string,
5908 the following character will be skipped. The default value makes the
5909 text "foo\"bar\\" considered to be one string.
5910
Bram Moolenaar071d4272004-06-13 20:20:40 +00005911 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5912'readonly' 'ro' boolean (default off)
5913 local to buffer
5914 If on, writes fail unless you use a '!'. Protects you from
5915 accidentally overwriting a file. Default on when Vim is started
5916 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005917 When using ":w!" the 'readonly' option is reset for the current
5918 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005919 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005920 set for the newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005921 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005922
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005923 *'redrawtime'* *'rdt'*
5924'redrawtime' 'rdt' number (default 2000)
5925 global
5926 {not in Vi}
5927 {only available when compiled with the |+reltime|
5928 feature}
5929 The time in milliseconds for redrawing the display. This applies to
5930 searching for patterns for 'hlsearch' and |:match| highlighting.
5931 When redrawing takes more than this many milliseconds no further
5932 matches will be highlighted. This is used to avoid that Vim hangs
5933 when using a very complicated pattern.
5934
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02005935 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005936'regexpengine' 're' number (default 0)
5937 global
5938 {not in Vi}
5939 This selects the default regexp engine. |two-engines|
5940 The possible values are:
5941 0 automatic selection
5942 1 old engine
5943 2 NFA engine
5944 Note that when using the NFA engine and the pattern contains something
5945 that is not supported the pattern will not match. This is only useful
5946 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01005947 Using automatic selection enables Vim to switch the engine, if the
5948 default engine becomes too costly. E.g., when the NFA engine uses too
5949 many states. This should prevent Vim from hanging on a combination of
5950 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005951
Bram Moolenaar64486672010-05-16 15:46:46 +02005952 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5953'relativenumber' 'rnu' boolean (default off)
5954 local to window
5955 {not in Vi}
5956 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005957 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005958 precede some vertical motion commands (e.g. j k + -) with, without
5959 having to calculate it yourself. Especially useful in combination with
5960 other commands (e.g. y d c < > gq gw =).
5961 When the 'n' option is excluded from 'cpoptions' a wrapped
5962 line will not use the column of line numbers (this is the default when
5963 'compatible' isn't set).
5964 The 'numberwidth' option can be used to set the room used for the line
5965 number.
5966 When a long, wrapped line doesn't start with the first character, '-'
5967 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005968 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5969 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005970
5971 The number in front of the cursor line also depends on the value of
5972 'number', see |number_relativenumber| for all combinations of the two
5973 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02005974
Bram Moolenaar071d4272004-06-13 20:20:40 +00005975 *'remap'* *'noremap'*
5976'remap' boolean (default on)
5977 global
5978 Allows for mappings to work recursively. If you do not want this for
5979 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005980 NOTE: To avoid portability problems with Vim scripts, always keep
5981 this option at the default "on". Only switch it off when working with
5982 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005983
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005984 *'renderoptions'* *'rop'*
5985'renderoptions' 'rop' string (default: empty)
5986 global
5987 {not in Vi}
5988 {only available when compiled with GUI and DIRECTX on
5989 MS-Windows}
5990 Select a text renderer and set its options. The options depend on the
5991 renderer.
5992
5993 Syntax: >
5994 set rop=type:{renderer}(,{name}:{value})*
5995<
5996 Currently, only one optional renderer is available.
5997
5998 render behavior ~
5999 directx Vim will draw text using DirectX (DirectWrite). It makes
6000 drawn glyphs more beautiful than default GDI.
6001 It requires 'encoding' is "utf-8", and only works on
6002 MS-Windows Vista or newer version.
6003
6004 Options:
6005 name meaning type value ~
6006 gamma gamma float 1.0 - 2.2 (maybe)
6007 contrast enhancedContrast float (unknown)
6008 level clearTypeLevel float (unknown)
6009 geom pixelGeometry int 0 - 2 (see below)
6010 renmode renderingMode int 0 - 6 (see below)
6011 taamode textAntialiasMode int 0 - 3 (see below)
6012
6013 See this URL for detail:
6014 http://msdn.microsoft.com/en-us/library/dd368190.aspx
6015
6016 For geom: structure of a device pixel.
6017 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6018 1 - DWRITE_PIXEL_GEOMETRY_RGB
6019 2 - DWRITE_PIXEL_GEOMETRY_BGR
6020
6021 See this URL for detail:
6022 http://msdn.microsoft.com/en-us/library/dd368114.aspx
6023
6024 For renmode: method of rendering glyphs.
6025 0 - DWRITE_RENDERING_MODE_DEFAULT
6026 1 - DWRITE_RENDERING_MODE_ALIASED
6027 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6028 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6029 4 - DWRITE_RENDERING_MODE_NATURAL
6030 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6031 6 - DWRITE_RENDERING_MODE_OUTLINE
6032
6033 See this URL for detail:
6034 http://msdn.microsoft.com/en-us/library/dd368118.aspx
6035
6036 For taamode: antialiasing mode used for drawing text.
6037 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6038 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6039 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6040 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6041
6042 See this URL for detail:
6043 http://msdn.microsoft.com/en-us/library/dd368170.aspx
6044
6045 Example: >
6046 set encoding=utf-8
6047 set gfn=Ricty_Diminished:h12:cSHIFTJIS
6048 set rop=type:directx
6049<
6050 If select a raster font (Courier, Terminal or FixedSys) to
6051 'guifont', it fallbacks to be drawn by GDI automatically.
6052
6053 Other render types are currently not supported.
6054
Bram Moolenaar071d4272004-06-13 20:20:40 +00006055 *'report'*
6056'report' number (default 2)
6057 global
6058 Threshold for reporting number of lines changed. When the number of
6059 changed lines is more than 'report' a message will be given for most
6060 ":" commands. If you want it always, set 'report' to 0.
6061 For the ":substitute" command the number of substitutions is used
6062 instead of the number of lines.
6063
6064 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6065'restorescreen' 'rs' boolean (default on)
6066 global
6067 {not in Vi} {only in Windows 95/NT console version}
6068 When set, the screen contents is restored when exiting Vim. This also
6069 happens when executing external commands.
6070
6071 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6072 options in your .vimrc. To disable restoring:
6073 set t_ti= t_te=
6074 To enable restoring (for an xterm):
6075 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6076 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6077
6078 *'revins'* *'ri'* *'norevins'* *'nori'*
6079'revins' 'ri' boolean (default off)
6080 global
6081 {not in Vi}
6082 {only available when compiled with the |+rightleft|
6083 feature}
6084 Inserting characters in Insert mode will work backwards. See "typing
6085 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6086 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006087 NOTE: This option is reset when 'compatible' is set.
6088 This option is reset when 'paste' is set and restored when 'paste' is
6089 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006090
6091 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6092'rightleft' 'rl' boolean (default off)
6093 local to window
6094 {not in Vi}
6095 {only available when compiled with the |+rightleft|
6096 feature}
6097 When on, display orientation becomes right-to-left, i.e., characters
6098 that are stored in the file appear from the right to the left.
6099 Using this option, it is possible to edit files for languages that
6100 are written from the right to the left such as Hebrew and Arabic.
6101 This option is per window, so it is possible to edit mixed files
6102 simultaneously, or to view the same file in both ways (this is
6103 useful whenever you have a mixed text file with both right-to-left
6104 and left-to-right strings so that both sets are displayed properly
6105 in different windows). Also see |rileft.txt|.
6106
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006107 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006108'rightleftcmd' 'rlc' string (default "search")
6109 local to window
6110 {not in Vi}
6111 {only available when compiled with the |+rightleft|
6112 feature}
6113 Each word in this option enables the command line editing to work in
6114 right-to-left mode for a group of commands:
6115
6116 search "/" and "?" commands
6117
6118 This is useful for languages such as Hebrew, Arabic and Farsi.
6119 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6120
Bram Moolenaard94464e2015-11-02 15:28:18 +01006121 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006122'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006123 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006124 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01006125 {only available when compiled with the |+ruby/dyn|
6126 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006127 Specifies the name of the Ruby shared library. The default is
6128 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006129 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006130 This option cannot be set from a |modeline| or in the |sandbox|, for
6131 security reasons.
6132
Bram Moolenaar071d4272004-06-13 20:20:40 +00006133 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006134'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006135 global
6136 {not in Vi}
6137 {not available when compiled without the
6138 |+cmdline_info| feature}
6139 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006140 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006141 text in the file is shown on the far right:
6142 Top first line is visible
6143 Bot last line is visible
6144 All first and last line are visible
6145 45% relative position in the file
6146 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006147 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006148 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006149 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006150 this option takes precedence over 'ruler' and 'rulerformat'
6151 If the number of characters displayed is different from the number of
6152 bytes in the text (e.g., for a TAB or a multi-byte character), both
6153 the text column (byte number) and the screen column are shown,
6154 separated with a dash.
6155 For an empty line "0-1" is shown.
6156 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006157 This option is reset when 'paste' is set and restored when 'paste' is
6158 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006159 If you don't want to see the ruler all the time but want to know where
6160 you are, use "g CTRL-G" |g_CTRL-G|.
6161 NOTE: This option is reset when 'compatible' is set.
6162
6163 *'rulerformat'* *'ruf'*
6164'rulerformat' 'ruf' string (default empty)
6165 global
6166 {not in Vi}
6167 {not available when compiled without the |+statusline|
6168 feature}
6169 When this option is not empty, it determines the content of the ruler
6170 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006171 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006172 The default ruler width is 17 characters. To make the ruler 15
6173 characters wide, put "%15(" at the start and "%)" at the end.
6174 Example: >
6175 :set rulerformat=%15(%c%V\ %p%%%)
6176<
6177 *'runtimepath'* *'rtp'* *vimfiles*
6178'runtimepath' 'rtp' string (default:
6179 Unix: "$HOME/.vim,
6180 $VIM/vimfiles,
6181 $VIMRUNTIME,
6182 $VIM/vimfiles/after,
6183 $HOME/.vim/after"
6184 Amiga: "home:vimfiles,
6185 $VIM/vimfiles,
6186 $VIMRUNTIME,
6187 $VIM/vimfiles/after,
6188 home:vimfiles/after"
6189 PC, OS/2: "$HOME/vimfiles,
6190 $VIM/vimfiles,
6191 $VIMRUNTIME,
6192 $VIM/vimfiles/after,
6193 $HOME/vimfiles/after"
6194 Macintosh: "$VIM:vimfiles,
6195 $VIMRUNTIME,
6196 $VIM:vimfiles:after"
6197 RISC-OS: "Choices:vimfiles,
6198 $VIMRUNTIME,
6199 Choices:vimfiles/after"
6200 VMS: "sys$login:vimfiles,
6201 $VIM/vimfiles,
6202 $VIMRUNTIME,
6203 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006204 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006205 global
6206 {not in Vi}
6207 This is a list of directories which will be searched for runtime
6208 files:
6209 filetype.vim filetypes by file name |new-filetype|
6210 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006211 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006212 colors/ color scheme files |:colorscheme|
6213 compiler/ compiler files |:compiler|
6214 doc/ documentation |write-local-help|
6215 ftplugin/ filetype plugins |write-filetype-plugin|
6216 indent/ indent scripts |indent-expression|
6217 keymap/ key mapping files |mbyte-keymap|
6218 lang/ menu translations |:menutrans|
6219 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006220 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006221 plugin/ plugin scripts |write-plugin|
6222 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006223 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006224 syntax/ syntax files |mysyntaxfile|
6225 tutor/ files for vimtutor |tutor|
6226
6227 And any other file searched for with the |:runtime| command.
6228
6229 The defaults for most systems are setup to search five locations:
6230 1. In your home directory, for your personal preferences.
6231 2. In a system-wide Vim directory, for preferences from the system
6232 administrator.
6233 3. In $VIMRUNTIME, for files distributed with Vim.
6234 *after-directory*
6235 4. In the "after" directory in the system-wide Vim directory. This is
6236 for the system administrator to overrule or add to the distributed
6237 defaults (rarely needed)
6238 5. In the "after" directory in your home directory. This is for
6239 personal preferences to overrule or add to the distributed defaults
6240 or system-wide settings (rarely needed).
6241
Bram Moolenaard0796902016-09-16 20:02:31 +02006242 More entries are added when using |packages|. If it gets very long
6243 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6244 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006245
Bram Moolenaar071d4272004-06-13 20:20:40 +00006246 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6247 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006248 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006249 wildcards.
6250 See |:runtime|.
6251 Example: >
6252 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6253< This will use the directory "~/vimruntime" first (containing your
6254 personal Vim runtime files), then "/mygroup/vim" (shared between a
6255 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6256 files).
6257 You probably should always include $VIMRUNTIME somewhere, to use the
6258 distributed runtime files. You can put a directory before $VIMRUNTIME
6259 to find files which replace a distributed runtime files. You can put
6260 a directory after $VIMRUNTIME to find files which add to distributed
6261 runtime files.
6262 This option cannot be set from a |modeline| or in the |sandbox|, for
6263 security reasons.
6264
6265 *'scroll'* *'scr'*
6266'scroll' 'scr' number (default: half the window height)
6267 local to window
6268 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6269 set to half the number of lines in the window when the window size
6270 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006271 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006272 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
6273 the number of screen lines instead of file lines, makes a difference
6274 when lines wrap}
6275
6276 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6277'scrollbind' 'scb' boolean (default off)
6278 local to window
6279 {not in Vi}
6280 {not available when compiled without the |+scrollbind|
6281 feature}
6282 See also |scroll-binding|. When this option is set, the current
6283 window scrolls as other scrollbind windows (windows that also have
6284 this option set) scroll. This option is useful for viewing the
6285 differences between two versions of a file, see 'diff'.
6286 See |'scrollopt'| for options that determine how this option should be
6287 interpreted.
6288 This option is mostly reset when splitting a window to edit another
6289 file. This means that ":split | edit file" results in two windows
6290 with scroll-binding, but ":split file" does not.
6291
6292 *'scrolljump'* *'sj'*
6293'scrolljump' 'sj' number (default 1)
6294 global
6295 {not in Vi}
6296 Minimal number of lines to scroll when the cursor gets off the
6297 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6298 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006299 When set to a negative number from -1 to -100 this is used as the
6300 percentage of the window height. Thus -50 scrolls half the window
6301 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006302 NOTE: This option is set to 1 when 'compatible' is set.
6303
6304 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006305'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006306 global
6307 {not in Vi}
6308 Minimal number of screen lines to keep above and below the cursor.
6309 This will make some context visible around where you are working. If
6310 you set it to a very large value (999) the cursor line will always be
6311 in the middle of the window (except at the start or end of the file or
6312 when long lines wrap).
6313 For scrolling horizontally see 'sidescrolloff'.
6314 NOTE: This option is set to 0 when 'compatible' is set.
6315
6316 *'scrollopt'* *'sbo'*
6317'scrollopt' 'sbo' string (default "ver,jump")
6318 global
6319 {not available when compiled without the |+scrollbind|
6320 feature}
6321 {not in Vi}
6322 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006323 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6324 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006325 The following words are available:
6326 ver Bind vertical scrolling for 'scrollbind' windows
6327 hor Bind horizontal scrolling for 'scrollbind' windows
6328 jump Applies to the offset between two windows for vertical
6329 scrolling. This offset is the difference in the first
6330 displayed line of the bound windows. When moving
6331 around in a window, another 'scrollbind' window may
6332 reach a position before the start or after the end of
6333 the buffer. The offset is not changed though, when
6334 moving back the 'scrollbind' window will try to scroll
6335 to the desired position when possible.
6336 When now making that window the current one, two
6337 things can be done with the relative offset:
6338 1. When "jump" is not included, the relative offset is
6339 adjusted for the scroll position in the new current
6340 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006341 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006342 2. When "jump" is included, the other windows are
6343 scrolled to keep the same relative offset. When
6344 going back to the other window, it still uses the
6345 same relative offset.
6346 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006347 When 'diff' mode is active there always is vertical scroll binding,
6348 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006349
6350 *'sections'* *'sect'*
6351'sections' 'sect' string (default "SHNHH HUnhsh")
6352 global
6353 Specifies the nroff macros that separate sections. These are pairs of
6354 two letters (See |object-motions|). The default makes a section start
6355 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6356
6357 *'secure'* *'nosecure'* *E523*
6358'secure' boolean (default off)
6359 global
6360 {not in Vi}
6361 When on, ":autocmd", shell and write commands are not allowed in
6362 ".vimrc" and ".exrc" in the current directory and map commands are
6363 displayed. Switch it off only if you know that you will not run into
6364 problems, or when the 'exrc' option is off. On Unix this option is
6365 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006366 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006367 'secure' at the end of your ~/.vimrc then.
6368 This option cannot be set from a |modeline| or in the |sandbox|, for
6369 security reasons.
6370
6371 *'selection'* *'sel'*
6372'selection' 'sel' string (default "inclusive")
6373 global
6374 {not in Vi}
6375 This option defines the behavior of the selection. It is only used
6376 in Visual and Select mode.
6377 Possible values:
6378 value past line inclusive ~
6379 old no yes
6380 inclusive yes yes
6381 exclusive yes no
6382 "past line" means that the cursor is allowed to be positioned one
6383 character past the line.
6384 "inclusive" means that the last character of the selection is included
6385 in an operation. For example, when "x" is used to delete the
6386 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006387 When "old" is used and 'virtualedit' allows the cursor to move past
6388 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006389 Note that when "exclusive" is used and selecting from the end
6390 backwards, you cannot include the last character of a line, when
6391 starting in Normal mode and 'virtualedit' empty.
6392
6393 The 'selection' option is set by the |:behave| command.
6394
6395 *'selectmode'* *'slm'*
6396'selectmode' 'slm' string (default "")
6397 global
6398 {not in Vi}
6399 This is a comma separated list of words, which specifies when to start
6400 Select mode instead of Visual mode, when a selection is started.
6401 Possible values:
6402 mouse when using the mouse
6403 key when using shifted special keys
6404 cmd when using "v", "V" or CTRL-V
6405 See |Select-mode|.
6406 The 'selectmode' option is set by the |:behave| command.
6407
6408 *'sessionoptions'* *'ssop'*
6409'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00006410 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006411 global
6412 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006413 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006414 feature}
6415 Changes the effect of the |:mksession| command. It is a comma
6416 separated list of words. Each word enables saving and restoring
6417 something:
6418 word save and restore ~
6419 blank empty windows
6420 buffers hidden and unloaded buffers, not just those in windows
6421 curdir the current directory
6422 folds manually created folds, opened/closed folds and local
6423 fold options
6424 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006425 and contain at least one lowercase letter. Only
6426 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006427 help the help window
6428 localoptions options and mappings local to a window or buffer (not
6429 global values for local options)
6430 options all options and mappings (also global values for local
6431 options)
6432 resize size of the Vim window: 'lines' and 'columns'
6433 sesdir the directory in which the session file is located
6434 will become the current directory (useful with
6435 projects accessed over a network from different
6436 systems)
6437 slash backslashes in file names replaced with forward
6438 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006439 tabpages all tab pages; without this only the current tab page
6440 is restored, so that you can make a session for each
6441 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00006442 unix with Unix end-of-line format (single <NL>), even when
6443 on Windows or DOS
6444 winpos position of the whole Vim window
6445 winsize window sizes
6446
6447 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006448 When neither "curdir" nor "sesdir" is included, file names are stored
6449 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006450 "slash" and "unix" are useful on Windows when sharing session files
6451 with Unix. The Unix version of Vim cannot source dos format scripts,
6452 but the Windows version of Vim can source unix format scripts.
6453
6454 *'shell'* *'sh'* *E91*
6455'shell' 'sh' string (default $SHELL or "sh",
6456 MS-DOS and Win32: "command.com" or
6457 "cmd.exe", OS/2: "cmd")
6458 global
6459 Name of the shell to use for ! and :! commands. When changing the
6460 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6461 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006462 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006463 See |option-backslash| about including spaces and backslashes.
6464 Environment variables are expanded |:set_env|.
6465 If the name of the shell contains a space, you might need to enclose
6466 it in quotes. Example: >
6467 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6468< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006469 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006470 "-f" is not inside the quotes, because it is not part of the command
6471 name. And Vim automagically recognizes the backslashes that are path
6472 separators.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006473 Under MS-Windows, when the executable ends in ".com" it must be
6474 included. Thus setting the shell to "command.com" or "4dos.com"
6475 works, but "command" and "4dos" do not work for all commands (e.g.,
6476 filtering).
6477 For unknown reasons, when using "4dos.com" the current directory is
6478 changed to "C:\". To avoid this set 'shell' like this: >
6479 :set shell=command.com\ /c\ 4dos
6480< This option cannot be set from a |modeline| or in the |sandbox|, for
6481 security reasons.
6482
6483 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006484'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006485 MS-DOS and Win32, when 'shell' does not
6486 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006487 global
6488 {not in Vi}
6489 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6490 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6491 systems, the default is set according to the value of 'shell', to
6492 reduce the need to set this option by the user. It's not used for
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006493 OS/2 (EMX figures this out itself).
6494 On Unix it can have more than one flag. Each white space separated
6495 part is passed as an argument to the shell command.
6496 See |option-backslash| about including spaces and backslashes.
6497 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006498 This option cannot be set from a |modeline| or in the |sandbox|, for
6499 security reasons.
6500
6501 *'shellpipe'* *'sp'*
6502'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6503 global
6504 {not in Vi}
6505 {not available when compiled without the |+quickfix|
6506 feature}
6507 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006508 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006509 including spaces and backslashes.
6510 The name of the temporary file can be represented by "%s" if necessary
6511 (the file name is appended automatically if no %s appears in the value
6512 of this option).
6513 For the Amiga and MS-DOS the default is ">". The output is directly
6514 saved in a file and not echoed to the screen.
6515 For Unix the default it "| tee". The stdout of the compiler is saved
6516 in a file and echoed to the screen. If the 'shell' option is "csh" or
6517 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02006518 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
6519 default becomes "2>&1| tee". This means that stderr is also included.
6520 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
6521 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006522 The initialization of this option is done after reading the ".vimrc"
6523 and the other initializations, so that when the 'shell' option is set
6524 there, the 'shellpipe' option changes automatically, unless it was
6525 explicitly set before.
6526 When 'shellpipe' is set to an empty string, no redirection of the
6527 ":make" output will be done. This is useful if you use a 'makeprg'
6528 that writes to 'makeef' by itself. If you want no piping, but do
6529 want to include the 'makeef', set 'shellpipe' to a single space.
6530 Don't forget to precede the space with a backslash: ":set sp=\ ".
6531 In the future pipes may be used for filtering and this option will
6532 become obsolete (at least for Unix).
6533 This option cannot be set from a |modeline| or in the |sandbox|, for
6534 security reasons.
6535
6536 *'shellquote'* *'shq'*
6537'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6538 contains "sh" somewhere: "\"")
6539 global
6540 {not in Vi}
6541 Quoting character(s), put around the command passed to the shell, for
6542 the "!" and ":!" commands. The redirection is kept outside of the
6543 quoting. See 'shellxquote' to include the redirection. It's
6544 probably not useful to set both options.
6545 This is an empty string by default. Only known to be useful for
6546 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6547 or bash, where it should be "\"". The default is adjusted according
6548 the value of 'shell', to reduce the need to set this option by the
6549 user. See |dos-shell|.
6550 This option cannot be set from a |modeline| or in the |sandbox|, for
6551 security reasons.
6552
6553 *'shellredir'* *'srr'*
6554'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6555 global
6556 {not in Vi}
6557 String to be used to put the output of a filter command in a temporary
6558 file. See also |:!|. See |option-backslash| about including spaces
6559 and backslashes.
6560 The name of the temporary file can be represented by "%s" if necessary
6561 (the file name is appended automatically if no %s appears in the value
6562 of this option).
6563 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6564 or "zsh" during initializations, the default becomes ">&". If the
6565 'shell' option is "sh", "ksh" or "bash" the default becomes
6566 ">%s 2>&1". This means that stderr is also included.
6567 For Win32, the Unix checks are done and additionally "cmd" is checked
6568 for, which makes the default ">%s 2>&1". Also, the same names with
6569 ".exe" appended are checked for.
6570 The initialization of this option is done after reading the ".vimrc"
6571 and the other initializations, so that when the 'shell' option is set
6572 there, the 'shellredir' option changes automatically unless it was
6573 explicitly set before.
6574 In the future pipes may be used for filtering and this option will
6575 become obsolete (at least for Unix).
6576 This option cannot be set from a |modeline| or in the |sandbox|, for
6577 security reasons.
6578
6579 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6580'shellslash' 'ssl' boolean (default off)
6581 global
6582 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
6583 When set, a forward slash is used when expanding file names. This is
6584 useful when a Unix-like shell is used instead of command.com or
6585 cmd.exe. Backward slashes can still be typed, but they are changed to
6586 forward slashes by Vim.
6587 Note that setting or resetting this option has no effect for some
6588 existing file names, thus this option needs to be set before opening
6589 any file for best results. This might change in the future.
6590 'shellslash' only works when a backslash can be used as a path
6591 separator. To test if this is so use: >
6592 if exists('+shellslash')
6593<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006594 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6595'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6596 global
6597 {not in Vi}
6598 When on, use temp files for shell commands. When off use a pipe.
6599 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006600 Currently a pipe is only supported on Unix and MS-Windows 2K and
6601 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006602 :if has("filterpipe")
6603< The advantage of using a pipe is that nobody can read the temp file
6604 and the 'shell' command does not need to support redirection.
6605 The advantage of using a temp file is that the file type and encoding
6606 can be detected.
6607 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6608 |FilterWritePost| autocommands event are not triggered when
6609 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006610 The `system()` function does not respect this option and always uses
6611 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006612 NOTE: This option is set to the Vim default value when 'compatible'
6613 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006614
Bram Moolenaar071d4272004-06-13 20:20:40 +00006615 *'shelltype'* *'st'*
6616'shelltype' 'st' number (default 0)
6617 global
6618 {not in Vi} {only for the Amiga}
6619 On the Amiga this option influences the way how the commands work
6620 which use a shell.
6621 0 and 1: always use the shell
6622 2 and 3: use the shell only to filter lines
6623 4 and 5: use shell only for ':sh' command
6624 When not using the shell, the command is executed directly.
6625
6626 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6627 1 and 3: use "shell cmd" to start external commands
6628
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006629 *'shellxescape'* *'sxe'*
6630'shellxescape' 'sxe' string (default: "";
6631 for MS-DOS and MS-Windows: "\"&|<>()@^")
6632 global
6633 {not in Vi}
6634 When 'shellxquote' is set to "(" then the characters listed in this
6635 option will be escaped with a '^' character. This makes it possible
6636 to execute most external commands with cmd.exe.
6637
Bram Moolenaar071d4272004-06-13 20:20:40 +00006638 *'shellxquote'* *'sxq'*
6639'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006640 for Win32, when 'shell' is cmd.exe: "("
6641 for Win32, when 'shell' contains "sh"
6642 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006643 for Unix, when using system(): "\"")
6644 global
6645 {not in Vi}
6646 Quoting character(s), put around the command passed to the shell, for
6647 the "!" and ":!" commands. Includes the redirection. See
6648 'shellquote' to exclude the redirection. It's probably not useful
6649 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006650 When the value is '(' then ')' is appended. When the value is '"('
6651 then ')"' is appended.
6652 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006653 This is an empty string by default on most systems, but is known to be
6654 useful for on Win32 version, either for cmd.exe which automatically
6655 strips off the first and last quote on a command, or 3rd-party shells
6656 such as the MKS Korn Shell or bash, where it should be "\"". The
6657 default is adjusted according the value of 'shell', to reduce the need
6658 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006659 This option cannot be set from a |modeline| or in the |sandbox|, for
6660 security reasons.
6661
6662 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6663'shiftround' 'sr' boolean (default off)
6664 global
6665 {not in Vi}
6666 Round indent to multiple of 'shiftwidth'. Applies to > and <
6667 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6668 a multiple of 'shiftwidth' (this is Vi compatible).
6669 NOTE: This option is reset when 'compatible' is set.
6670
6671 *'shiftwidth'* *'sw'*
6672'shiftwidth' 'sw' number (default 8)
6673 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006674 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006675 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006676 When zero the 'ts' value will be used. Use the |shiftwidth()|
6677 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006678
6679 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006680'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6681 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006682 global
6683 {not in Vi}
6684 This option helps to avoid all the |hit-enter| prompts caused by file
6685 messages, for example with CTRL-G, and to avoid some other messages.
6686 It is a list of flags:
6687 flag meaning when present ~
6688 f use "(3 of 5)" instead of "(file 3 of 5)"
6689 i use "[noeol]" instead of "[Incomplete last line]"
6690 l use "999L, 888C" instead of "999 lines, 888 characters"
6691 m use "[+]" instead of "[Modified]"
6692 n use "[New]" instead of "[New File]"
6693 r use "[RO]" instead of "[readonly]"
6694 w use "[w]" instead of "written" for file write message
6695 and "[a]" instead of "appended" for ':w >> file' command
6696 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6697 "[unix format]" and "[mac]" instead of "[mac format]".
6698 a all of the above abbreviations
6699
6700 o overwrite message for writing a file with subsequent message
6701 for reading a file (useful for ":wn" or when 'autowrite' on)
6702 O message for reading a file overwrites any previous message.
6703 Also for quickfix message (e.g., ":cn").
6704 s don't give "search hit BOTTOM, continuing at TOP" or "search
6705 hit TOP, continuing at BOTTOM" messages
6706 t truncate file message at the start if it is too long to fit
6707 on the command-line, "<" will appear in the left most column.
6708 Ignored in Ex mode.
6709 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006710 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006711 Ignored in Ex mode.
6712 W don't give "written" or "[w]" when writing a file
6713 A don't give the "ATTENTION" message when an existing swap file
6714 is found.
6715 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006716 c don't give |ins-completion-menu| messages. For example,
6717 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6718 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006719 q use "recording" instead of "recording @a"
6720 F don't give the file info when editing a file, like `:silent`
6721 was used for the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00006722
6723 This gives you the opportunity to avoid that a change between buffers
6724 requires you to hit <Enter>, but still gives as useful a message as
6725 possible for the space available. To get the whole message that you
6726 would have got with 'shm' empty, use ":file!"
6727 Useful values:
6728 shm= No abbreviation of message.
6729 shm=a Abbreviation, but no loss of information.
6730 shm=at Abbreviation, and truncate message when necessary.
6731
6732 NOTE: This option is set to the Vi default value when 'compatible' is
6733 set and to the Vim default value when 'compatible' is reset.
6734
6735 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6736'shortname' 'sn' boolean (default off)
6737 local to buffer
6738 {not in Vi, not in MS-DOS versions}
6739 Filenames are assumed to be 8 characters plus one extension of 3
6740 characters. Multiple dots in file names are not allowed. When this
6741 option is on, dots in file names are replaced with underscores when
6742 adding an extension (".~" or ".swp"). This option is not available
6743 for MS-DOS, because then it would always be on. This option is useful
6744 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6745 or crossdos. When running the Win32 GUI version under Win32s, this
6746 option is always on by default.
6747
6748 *'showbreak'* *'sbr'* *E595*
6749'showbreak' 'sbr' string (default "")
6750 global
6751 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006752 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006753 feature}
6754 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006755 values are "> " or "+++ ": >
6756 :set showbreak=>\
6757< Note the backslash to escape the trailing space. It's easier like
6758 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006759 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006760< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006761 comma (in a future version the comma might be used to separate the
6762 part that is shown at the end and at the start of a line).
6763 The characters are highlighted according to the '@' flag in
6764 'highlight'.
6765 Note that tabs after the showbreak will be displayed differently.
6766 If you want the 'showbreak' to appear in between line numbers, add the
6767 "n" flag to 'cpoptions'.
6768
6769 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006770'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6771 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006772 global
6773 {not in Vi}
6774 {not available when compiled without the
6775 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006776 Show (partial) command in the last line of the screen. Set this
6777 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006778 In Visual mode the size of the selected area is shown:
6779 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006780 If the number of bytes is different it is also displayed: "2-6"
6781 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006782 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006783 - When selecting a block, the size in screen characters:
6784 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006785 NOTE: This option is set to the Vi default value when 'compatible' is
6786 set and to the Vim default value when 'compatible' is reset.
6787
6788 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6789'showfulltag' 'sft' boolean (default off)
6790 global
6791 {not in Vi}
6792 When completing a word in insert mode (see |ins-completion|) from the
6793 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006794 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006795 matched a C function, you can see a template for what arguments are
6796 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006797 Note that this doesn't work well together with having "longest" in
6798 'completeopt', because the completion from the search pattern may not
6799 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006800
6801 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6802'showmatch' 'sm' boolean (default off)
6803 global
6804 When a bracket is inserted, briefly jump to the matching one. The
6805 jump is only done if the match can be seen on the screen. The time to
6806 show the match can be set with 'matchtime'.
6807 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006808 seen or not).
6809 This option is reset when 'paste' is set and restored when 'paste' is
6810 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006811 When the 'm' flag is not included in 'cpoptions', typing a character
6812 will immediately move the cursor back to where it belongs.
6813 See the "sm" field in 'guicursor' for setting the cursor shape and
6814 blinking when showing the match.
6815 The 'matchpairs' option can be used to specify the characters to show
6816 matches for. 'rightleft' and 'revins' are used to look for opposite
6817 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006818 Also see the matchparen plugin for highlighting the match when moving
6819 around |pi_paren.txt|.
6820 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006821
6822 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6823'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6824 global
6825 If in Insert, Replace or Visual mode put a message on the last line.
6826 Use the 'M' flag in 'highlight' to set the type of highlighting for
6827 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006828 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006829 doesn't mean XIM is really active, especially when 'imactivatekey' is
6830 not set.
6831 NOTE: This option is set to the Vi default value when 'compatible' is
6832 set and to the Vim default value when 'compatible' is reset.
6833
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006834 *'showtabline'* *'stal'*
6835'showtabline' 'stal' number (default 1)
6836 global
6837 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006838 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006839 feature}
6840 The value of this option specifies when the line with tab page labels
6841 will be displayed:
6842 0: never
6843 1: only if there are at least two tab pages
6844 2: always
6845 This is both for the GUI and non-GUI implementation of the tab pages
6846 line.
6847 See |tab-page| for more information about tab pages.
6848
Bram Moolenaar071d4272004-06-13 20:20:40 +00006849 *'sidescroll'* *'ss'*
6850'sidescroll' 'ss' number (default 0)
6851 global
6852 {not in Vi}
6853 The minimal number of columns to scroll horizontally. Used only when
6854 the 'wrap' option is off and the cursor is moved off of the screen.
6855 When it is zero the cursor will be put in the middle of the screen.
6856 When using a slow terminal set it to a large number or 0. When using
6857 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6858 commands.
6859
6860 *'sidescrolloff'* *'siso'*
6861'sidescrolloff' 'siso' number (default 0)
6862 global
6863 {not in Vi}
6864 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006865 right of the cursor if 'nowrap' is set. Setting this option to a
6866 value greater than 0 while having |'sidescroll'| also at a non-zero
6867 value makes some context visible in the line you are scrolling in
6868 horizontally (except at beginning of the line). Setting this option
6869 to a large value (like 999) has the effect of keeping the cursor
6870 horizontally centered in the window, as long as one does not come too
6871 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006872 NOTE: This option is set to 0 when 'compatible' is set.
6873
6874 Example: Try this together with 'sidescroll' and 'listchars' as
6875 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006876 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006877
6878 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6879 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006880<
6881 *'signcolumn'* *'scl'*
6882'signcolumn' 'scl' string (default "auto")
6883 local to window
6884 {not in Vi}
6885 {not available when compiled without the |+signs|
6886 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02006887 Whether or not to draw the signcolumn. Valid values are:
6888 "auto" only when there is a sign to display
6889 "no" never
6890 "yes" always
Bram Moolenaar071d4272004-06-13 20:20:40 +00006891
6892
6893 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6894'smartcase' 'scs' boolean (default off)
6895 global
6896 {not in Vi}
6897 Override the 'ignorecase' option if the search pattern contains upper
6898 case characters. Only used when the search pattern is typed and
6899 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006900 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006901 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6902 recalling the search pattern from history and hitting <Enter>.
6903 NOTE: This option is reset when 'compatible' is set.
6904
6905 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6906'smartindent' 'si' boolean (default off)
6907 local to buffer
6908 {not in Vi}
6909 {not available when compiled without the
6910 |+smartindent| feature}
6911 Do smart autoindenting when starting a new line. Works for C-like
6912 programs, but can also be used for other languages. 'cindent' does
6913 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006914 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006915 setting 'si' has no effect. 'indentexpr' is a more advanced
6916 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006917 Normally 'autoindent' should also be on when using 'smartindent'.
6918 An indent is automatically inserted:
6919 - After a line ending in '{'.
6920 - After a line starting with a keyword from 'cinwords'.
6921 - Before a line starting with '}' (only with the "O" command).
6922 When typing '}' as the first character in a new line, that line is
6923 given the same indent as the matching '{'.
6924 When typing '#' as the first character in a new line, the indent for
6925 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006926 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006927 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6928 When using the ">>" command, lines starting with '#' are not shifted
6929 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006930 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006931 This option is reset when 'paste' is set and restored when 'paste' is
6932 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006933
6934 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6935'smarttab' 'sta' boolean (default off)
6936 global
6937 {not in Vi}
6938 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006939 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6940 <BS> will delete a 'shiftwidth' worth of space at the start of the
6941 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006942 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006943 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6944 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006945 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006946 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006947 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02006948 This option is reset when 'paste' is set and restored when 'paste' is
6949 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006950 NOTE: This option is reset when 'compatible' is set.
6951
6952 *'softtabstop'* *'sts'*
6953'softtabstop' 'sts' number (default 0)
6954 local to buffer
6955 {not in Vi}
6956 Number of spaces that a <Tab> counts for while performing editing
6957 operations, like inserting a <Tab> or using <BS>. It "feels" like
6958 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6959 used. This is useful to keep the 'ts' setting at its standard value
6960 of 8, while being able to edit like it is set to 'sts'. However,
6961 commands like "x" still work on the actual characters.
6962 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006963 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02006964 'softtabstop' is set to 0 when the 'paste' option is set and restored
6965 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006966 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6967 spaces is minimized by using <Tab>s.
6968 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6969 set.
6970 NOTE: This option is set to 0 when 'compatible' is set.
6971
Bram Moolenaar217ad922005-03-20 22:37:15 +00006972 *'spell'* *'nospell'*
6973'spell' boolean (default off)
6974 local to window
6975 {not in Vi}
6976 {not available when compiled without the |+syntax|
6977 feature}
6978 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006979 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006980
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006981 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006982'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006983 local to buffer
6984 {not in Vi}
6985 {not available when compiled without the |+syntax|
6986 feature}
6987 Pattern to locate the end of a sentence. The following word will be
6988 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006989 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006990 When this check is not wanted make this option empty.
6991 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006992 Be careful with special characters, see |option-backslash| about
6993 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006994 To set this option automatically depending on the language, see
6995 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006996
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006997 *'spellfile'* *'spf'*
6998'spellfile' 'spf' string (default empty)
6999 local to buffer
7000 {not in Vi}
7001 {not available when compiled without the |+syntax|
7002 feature}
7003 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007004 commands. It must end in ".{encoding}.add". You need to include the
7005 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007006 *E765*
7007 It may also be a comma separated list of names. A count before the
7008 |zg| and |zw| commands can be used to access each. This allows using
7009 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007010 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007011 you: Using the first directory in 'runtimepath' that is writable. If
7012 there is no "spell" directory yet it will be created. For the file
7013 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007014 ignoring the region.
7015 The resulting ".spl" file will be used for spell checking, it does not
7016 have to appear in 'spelllang'.
7017 Normally one file is used for all regions, but you can add the region
7018 name if you want to. However, it will then only be used when
7019 'spellfile' is set to it, for entries in 'spelllang' only files
7020 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007021 This option cannot be set from a |modeline| or in the |sandbox|, for
7022 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007023
Bram Moolenaar217ad922005-03-20 22:37:15 +00007024 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007025'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007026 local to buffer
7027 {not in Vi}
7028 {not available when compiled without the |+syntax|
7029 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007030 A comma separated list of word list names. When the 'spell' option is
7031 on spellchecking will be done for these languages. Example: >
7032 set spelllang=en_us,nl,medical
7033< This means US English, Dutch and medical words are recognized. Words
7034 that are not recognized will be highlighted.
7035 The word list name must not include a comma or dot. Using a dash is
7036 recommended to separate the two letter language name from a
7037 specification. Thus "en-rare" is used for rare English words.
7038 A region name must come last and have the form "_xx", where "xx" is
7039 the two-letter, lower case region name. You can use more than one
7040 region by listing them: "en_us,en_ca" supports both US and Canadian
7041 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007042 Britain. (Note: currently en_au and en_nz dictionaries are older than
7043 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007044 If the name "cjk" is included East Asian characters are excluded from
7045 spell checking. This is useful when editing text that also has Asian
7046 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007047 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007048 As a special case the name of a .spl file can be given as-is. The
7049 first "_xx" in the name is removed and used as the region name
7050 (_xx is an underscore, two letters and followed by a non-letter).
7051 This is mainly for testing purposes. You must make sure the correct
7052 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007053 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007054 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7055 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007056 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007057
Bram Moolenaar98692072006-02-04 00:57:42 +00007058 If the |spellfile.vim| plugin is active and you use a language name
7059 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7060 will ask you if you want to download the file.
7061
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007062 After this option has been set successfully, Vim will source the files
7063 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007064 up to the first comma, dot or underscore.
7065 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007066
7067
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007068 *'spellsuggest'* *'sps'*
7069'spellsuggest' 'sps' string (default "best")
7070 global
7071 {not in Vi}
7072 {not available when compiled without the |+syntax|
7073 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007074 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007075 the |spellsuggest()| function. This is a comma-separated list of
7076 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007077
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007078 best Internal method that works best for English. Finds
7079 changes like "fast" and uses a bit of sound-a-like
7080 scoring to improve the ordering.
7081
7082 double Internal method that uses two methods and mixes the
7083 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007084 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007085 word. That only works when the language specifies
7086 sound folding. Can be slow and doesn't always give
7087 better results.
7088
7089 fast Internal method that only checks for simple changes:
7090 character inserts/deletes/swaps. Works well for
7091 simple typing mistakes.
7092
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007093 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007094 Not used for |spellsuggest()|. The number of
7095 suggestions is never more than the value of 'lines'
7096 minus two.
7097
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007098 file:{filename} Read file {filename}, which must have two columns,
7099 separated by a slash. The first column contains the
7100 bad word, the second column the suggested good word.
7101 Example:
7102 theribal/terrible ~
7103 Use this for common mistakes that do not appear at the
7104 top of the suggestion list with the internal methods.
7105 Lines without a slash are ignored, use this for
7106 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007107 The word in the second column must be correct,
7108 otherwise it will not be used. Add the word to an
7109 ".add" file if it is currently flagged as a spelling
7110 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007111 The file is used for all languages.
7112
7113 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7114 trouble with spaces. |v:val| holds the badly spelled
7115 word. The expression must evaluate to a List of
7116 Lists, each with a suggestion and a score.
7117 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007118 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007119 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007120 internal methods use. A lower score is better.
7121 This may invoke |spellsuggest()| if you temporarily
7122 set 'spellsuggest' to exclude the "expr:" part.
7123 Errors are silently ignored, unless you set the
7124 'verbose' option to a non-zero value.
7125
7126 Only one of "best", "double" or "fast" may be used. The others may
7127 appear several times in any order. Example: >
7128 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7129<
7130 This option cannot be set from a |modeline| or in the |sandbox|, for
7131 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007132
7133
Bram Moolenaar071d4272004-06-13 20:20:40 +00007134 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7135'splitbelow' 'sb' boolean (default off)
7136 global
7137 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007138 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007139 feature}
7140 When on, splitting a window will put the new window below the current
7141 one. |:split|
7142
7143 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7144'splitright' 'spr' boolean (default off)
7145 global
7146 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007147 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007148 feature}
7149 When on, splitting a window will put the new window right of the
7150 current one. |:vsplit|
7151
7152 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7153'startofline' 'sol' boolean (default on)
7154 global
7155 {not in Vi}
7156 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007157 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007158 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007159 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007160 with a linewise operator, with "%" with a count and to buffer changing
7161 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7162 only has a line number, e.g., ":25" or ":+".
7163 In case of buffer changing commands the cursor is placed at the column
7164 where it was the last time the buffer was edited.
7165 NOTE: This option is set when 'compatible' is set.
7166
Bram Moolenaar00654022011-02-25 14:42:19 +01007167 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007168'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007169 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007170 {not in Vi}
7171 {not available when compiled without the |+statusline|
7172 feature}
7173 When nonempty, this option determines the content of the status line.
7174 Also see |status-line|.
7175
7176 The option consists of printf style '%' items interspersed with
7177 normal text. Each status line item is of the form:
7178 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007179 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01007180 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007181
Bram Moolenaar238a5642006-02-21 22:12:05 +00007182 When the option starts with "%!" then it is used as an expression,
7183 evaluated and the result is used as the option value. Example: >
7184 :set statusline=%!MyStatusLine()
7185< The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007186 Note that the "%!" expression is evaluated in the context of the
7187 current window and buffer, while %{} items are evaluated in the
7188 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007189
7190 When there is error while evaluating the option then it will be made
7191 empty to avoid further errors. Otherwise screen updating would loop.
7192
Bram Moolenaar071d4272004-06-13 20:20:40 +00007193 Note that the only effect of 'ruler' when this option is set (and
7194 'laststatus' is 2) is controlling the output of |CTRL-G|.
7195
7196 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007197 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007198 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007199 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007200 minwid Minimum width of the item, padding as set by '-' & '0'.
7201 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007202 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007203 on the left for text items. Numeric items will be
7204 shifted down to maxwid-2 digits followed by '>'number
7205 where number is the amount of missing digits, much like
7206 an exponential notation.
7207 item A one letter code as described below.
7208
7209 Following is a description of the possible statusline items. The
7210 second character in "item" is the type:
7211 N for number
7212 S for string
7213 F for flags as described below
7214 - not applicable
7215
7216 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007217 f S Path to the file in the buffer, as typed or relative to current
7218 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007219 F S Full path to the file in the buffer.
7220 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007221 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007222 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007223 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007224 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007225 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007226 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007227 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007228 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007229 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007230 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
7231 {not available when compiled without |+autocmd| feature}
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007232 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007233 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7234 being used: "<keymap>"
7235 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007236 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007237 B N As above, in hexadecimal.
7238 o N Byte number in file of byte under cursor, first byte is 1.
7239 Mnemonic: Offset from start of file (with one added)
7240 {not available when compiled without |+byte_offset| feature}
7241 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007242 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007243 l N Line number.
7244 L N Number of lines in buffer.
7245 c N Column number.
7246 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007247 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007248 p N Percentage through file in lines as in |CTRL-G|.
7249 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007250 percentage described for 'ruler'. Always 3 in length, unless
7251 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007252 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007253 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007254 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00007255 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007256 ( - Start of item group. Can be used for setting the width and
7257 alignment of a section. Must be followed by %) somewhere.
7258 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007259 T N For 'tabline': start of tab page N label. Use %T after the last
7260 label. This information is used for mouse clicks.
7261 X N For 'tabline': start of close tab N label. Use %X after the
7262 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7263 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007264 < - Where to truncate line if too long. Default is at the start.
7265 No width fields allowed.
7266 = - Separation point between left and right aligned items.
7267 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007268 # - Set highlight group. The name must follow and then a # again.
7269 Thus use %#HLname# for highlight group HLname. The same
7270 highlighting is used, also for the statusline of non-current
7271 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007272 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007273 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007274 The difference between User{N} and StatusLine will be applied
7275 to StatusLineNC for the statusline of non-current windows.
7276 The number N must be between 1 and 9. See |hl-User1..9|
7277
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007278 When displaying a flag, Vim removes the leading comma, if any, when
7279 that flag comes right after plaintext. This will make a nice display
7280 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007281
Bram Moolenaar582fd852005-03-28 20:58:01 +00007282 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007283 not set) and a minwid is not set for the group, the whole group will
7284 become empty. This will make a group like the following disappear
7285 completely from the statusline when none of the flags are set. >
7286 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaare392eb42015-11-19 20:38:09 +01007287< *g:actual_curbuf*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007288 Beware that an expression is evaluated each and every time the status
7289 line is displayed. The current buffer and current window will be set
7290 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007291 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007292 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007293 real current buffer.
7294
Bram Moolenaar30b65812012-07-12 22:01:11 +02007295 The 'statusline' option will be evaluated in the |sandbox| if set from
7296 a modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007297
7298 It is not allowed to change text or jump to another window while
7299 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007300
7301 If the statusline is not updated when you want it (e.g., after setting
7302 a variable that's used in an expression), you can force an update by
7303 setting an option without changing its value. Example: >
7304 :let &ro = &ro
7305
7306< A result of all digits is regarded a number for display purposes.
7307 Otherwise the result is taken as flag text and applied to the rules
7308 described above.
7309
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007310 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007311 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
7312 edit your .vimrc or whatever with "vim -u NONE" to get it right.
7313
7314 Examples:
7315 Emulate standard status line with 'ruler' set >
7316 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7317< Similar, but add ASCII value of char under the cursor (like "ga") >
7318 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7319< Display byte count and byte value, modified flag in red. >
7320 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7321 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7322< Display a ,GZ flag if a compressed file is loaded >
7323 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7324< In the |:autocmd|'s: >
7325 :let b:gzflag = 1
7326< And: >
7327 :unlet b:gzflag
7328< And define this function: >
7329 :function VarExists(var, val)
7330 : if exists(a:var) | return a:val | else | return '' | endif
7331 :endfunction
7332<
7333 *'suffixes'* *'su'*
7334'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7335 global
7336 {not in Vi}
7337 Files with these suffixes get a lower priority when multiple files
7338 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007339 suffixes. Spaces after the comma are ignored. A dot is also seen as
7340 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007341 separator, precede it with a backslash (see |option-backslash| about
7342 including spaces and backslashes).
7343 See 'wildignore' for completely ignoring files.
7344 The use of |:set+=| and |:set-=| is preferred when adding or removing
7345 suffixes from the list. This avoids problems when a future version
7346 uses another default.
7347
7348 *'suffixesadd'* *'sua'*
7349'suffixesadd' 'sua' string (default "")
7350 local to buffer
7351 {not in Vi}
7352 {not available when compiled without the
7353 |+file_in_path| feature}
7354 Comma separated list of suffixes, which are used when searching for a
7355 file for the "gf", "[I", etc. commands. Example: >
7356 :set suffixesadd=.java
7357<
7358 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7359'swapfile' 'swf' boolean (default on)
7360 local to buffer
7361 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007362 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007363 swapfile is not wanted for a specific buffer. For example, with
7364 confidential information that even root must not be able to access.
7365 Careful: All text will be in memory:
7366 - Don't use this for big files.
7367 - Recovery will be impossible!
7368 A swapfile will only be present when |'updatecount'| is non-zero and
7369 'swapfile' is set.
7370 When 'swapfile' is reset, the swap file for the current buffer is
7371 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7372 non-zero, a swap file is immediately created.
7373 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007374 If you want to open a new buffer without creating a swap file for it,
7375 use the |:noswapfile| modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007376
7377 This option is used together with 'bufhidden' and 'buftype' to
7378 specify special kinds of buffers. See |special-buffers|.
7379
7380 *'swapsync'* *'sws'*
7381'swapsync' 'sws' string (default "fsync")
7382 global
7383 {not in Vi}
7384 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007385 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007386 When this option is empty parts of the swap file may be in memory and
7387 not written to disk. When the system crashes you may lose more work.
7388 On Unix the system does a sync now and then without Vim asking for it,
7389 so the disadvantage of setting this option off is small. On some
7390 systems the swap file will not be written at all. For a unix system
7391 setting it to "sync" will use the sync() call instead of the default
7392 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007393 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007394
7395 *'switchbuf'* *'swb'*
7396'switchbuf' 'swb' string (default "")
7397 global
7398 {not in Vi}
7399 This option controls the behavior when switching between buffers.
7400 Possible values (comma separated list):
7401 useopen If included, jump to the first open window that
7402 contains the specified buffer (if there is one).
7403 Otherwise: Do not examine other windows.
7404 This setting is checked with |quickfix| commands, when
7405 jumping to errors (":cc", ":cn", "cp", etc.). It is
7406 also used in all buffer related split commands, for
7407 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007408 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007409 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007410 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007411 a buffer for a |quickfix| command that display errors.
7412 Otherwise: do not split, use current window.
Bram Moolenaara594d772015-06-19 14:41:49 +02007413 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007414 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007415 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007416
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007417 *'synmaxcol'* *'smc'*
7418'synmaxcol' 'smc' number (default 3000)
7419 local to buffer
7420 {not in Vi}
7421 {not available when compiled without the |+syntax|
7422 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007423 Maximum column in which to search for syntax items. In long lines the
7424 text after this column is not highlighted and following lines may not
7425 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007426 This helps to avoid very slow redrawing for an XML file that is one
7427 long line.
7428 Set to zero to remove the limit.
7429
Bram Moolenaar071d4272004-06-13 20:20:40 +00007430 *'syntax'* *'syn'*
7431'syntax' 'syn' string (default empty)
7432 local to buffer
7433 {not in Vi}
7434 {not available when compiled without the |+syntax|
7435 feature}
7436 When this option is set, the syntax with this name is loaded, unless
7437 syntax highlighting has been switched off with ":syntax off".
7438 Otherwise this option does not always reflect the current syntax (the
7439 b:current_syntax variable does).
7440 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007441 not automatically recognized. Example, in an IDL file:
7442 /* vim: set syntax=idl : */ ~
7443 When a dot appears in the value then this separates two filetype
7444 names. Example:
7445 /* vim: set syntax=c.doxygen : */ ~
7446 This will use the "c" syntax first, then the "doxygen" syntax.
7447 Note that the second one must be prepared to be loaded as an addition,
7448 otherwise it will be skipped. More than one dot may appear.
7449 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007450 :set syntax=OFF
7451< To switch syntax highlighting on according to the current value of the
7452 'filetype' option: >
7453 :set syntax=ON
7454< What actually happens when setting the 'syntax' option is that the
7455 Syntax autocommand event is triggered with the value as argument.
7456 This option is not copied to another buffer, independent of the 's' or
7457 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007458 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007459
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007460 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007461'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007462 global
7463 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007464 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007465 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007466 When nonempty, this option determines the content of the tab pages
7467 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007468 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007469
7470 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007471 option and only when there is no GUI tab line. When 'e' is in
7472 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007473 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007474
7475 The value is evaluated like with 'statusline'. You can use
7476 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007477 the text to be displayed. Use "%1T" for the first label, "%2T" for
7478 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007479
7480 Keep in mind that only one of the tab pages is the current one, others
7481 are invisible and you can't jump to their windows.
7482
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007483
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007484 *'tabpagemax'* *'tpm'*
7485'tabpagemax' 'tpm' number (default 10)
7486 global
7487 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007488 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007489 feature}
7490 Maximum number of tab pages to be opened by the |-p| command line
7491 argument or the ":tab all" command. |tabpage|
7492
7493
7494 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007495'tabstop' 'ts' number (default 8)
7496 local to buffer
7497 Number of spaces that a <Tab> in the file counts for. Also see
7498 |:retab| command, and 'softtabstop' option.
7499
7500 Note: Setting 'tabstop' to any other value than 8 can make your file
7501 appear wrong in many places (e.g., when printing it).
7502
7503 There are four main ways to use tabs in Vim:
7504 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7505 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007506 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007507 behave like a tab appears every 4 (or 3) characters.
7508 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7509 'expandtab'. This way you will always insert spaces. The
7510 formatting will never be messed up when 'tabstop' is changed.
7511 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007512 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007513 works when using Vim to edit the file.
7514 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7515 'noexpandtab'. This should then work (for initial indents only)
7516 for any tabstop setting that people use. It might be nice to have
7517 tabs after the first non-blank inserted as spaces if you do this
7518 though. Otherwise aligned comments will be wrong when 'tabstop' is
7519 changed.
7520
7521 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7522'tagbsearch' 'tbs' boolean (default on)
7523 global
7524 {not in Vi}
7525 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007526 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007527 searching makes searching for a tag a LOT faster, but a linear search
7528 will find more tags if the tags file wasn't properly sorted.
7529 Vim normally assumes that your tags files are sorted, or indicate that
7530 they are not sorted. Only when this is not the case does the
7531 'tagbsearch' option need to be switched off.
7532
7533 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007534 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007535 certain files, or retry all files with a linear search. When
7536 'tagbsearch' is off, only a linear search is done.
7537
7538 Linear searching is done anyway, for one file, when Vim finds a line
7539 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007540 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007541< [The whitespace before and after the '0' must be a single <Tab>]
7542
7543 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007544 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007545 instead of a normal tag name, a retry is done with a linear search.
7546 Tags in unsorted tags files, and matches with different case will only
7547 be found in the retry.
7548
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007549 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007550 linear search can be avoided when case is ignored. Use a value of '2'
7551 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7552 sorted with the -f switch to "sort" in most unices, as in the command:
7553 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7554 (at least 5.5) the --sort=foldcase switch can be used for this as
7555 well. Note that case must be folded to uppercase for this to work.
7556
7557 By default, tag searches are case-sensitive. Case is ignored when
7558 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7559 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007560 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7561 'tagcase' is "smart", and the pattern contains only lowercase
7562 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007563
7564 When 'tagbsearch' is off, tags searching is slower when a full match
7565 exists, but faster when no full match exists. Tags in unsorted tags
7566 files may only be found with 'tagbsearch' off.
7567 When the tags file is not sorted, or sorted in a wrong way (not on
7568 ASCII byte value), 'tagbsearch' should be off, or the line given above
7569 must be included in the tags file.
7570 This option doesn't affect commands that find all matching tags (e.g.,
7571 command-line completion and ":help").
7572 {Vi: always uses binary search in some versions}
7573
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007574 *'tagcase'* *'tc'*
7575'tagcase' 'tc' string (default "followic")
7576 global or local to buffer |global-local|
7577 {not in Vi}
7578 This option specifies how case is handled when searching the tags
7579 file:
7580 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007581 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007582 ignore Ignore case
7583 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007584 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007585 NOTE: This option is set to the Vi default value when 'compatible' is
7586 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007587
Bram Moolenaar071d4272004-06-13 20:20:40 +00007588 *'taglength'* *'tl'*
7589'taglength' 'tl' number (default 0)
7590 global
7591 If non-zero, tags are significant up to this number of characters.
7592
7593 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7594'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7595 global
7596 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007597 If on and using a tags file in another directory, file names in that
7598 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007599 NOTE: This option is set to the Vi default value when 'compatible' is
7600 set and to the Vim default value when 'compatible' is reset.
7601
7602 *'tags'* *'tag'* *E433*
7603'tags' 'tag' string (default "./tags,tags", when compiled with
7604 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7605 global or local to buffer |global-local|
7606 Filenames for the tag command, separated by spaces or commas. To
7607 include a space or comma in a file name, precede it with a backslash
7608 (see |option-backslash| about including spaces and backslashes).
7609 When a file name starts with "./", the '.' is replaced with the path
7610 of the current file. But only when the 'd' flag is not included in
7611 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7612 |tags-option|.
7613 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007614 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7615 find all files named "tags" below "/lib". The filename itself cannot
7616 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7617 files called "tags?". {not available when compiled without the
7618 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007619 The |tagfiles()| function can be used to get a list of the file names
7620 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007621 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7622 files are also supported. They are automatically recognized. The
7623 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7624 differences are ignored (MS-Windows). |emacs-tags|
7625 The use of |:set+=| and |:set-=| is preferred when adding or removing
7626 file names from the list. This avoids problems when a future version
7627 uses another default.
7628 {Vi: default is "tags /usr/lib/tags"}
7629
7630 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7631'tagstack' 'tgst' boolean (default on)
7632 global
7633 {not in all versions of Vi}
7634 When on, the |tagstack| is used normally. When off, a ":tag" or
7635 ":tselect" command with an argument will not push the tag onto the
7636 tagstack. A following ":tag" without an argument, a ":pop" command or
7637 any other command that uses the tagstack will use the unmodified
7638 tagstack, but does change the pointer to the active entry.
7639 Resetting this option is useful when using a ":tag" command in a
7640 mapping which should not change the tagstack.
7641
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007642 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007643'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007644 global
7645 {not in Vi}
7646 {only available when compiled with the |+tcl/dyn|
7647 feature}
7648 Specifies the name of the Tcl shared library. The default is
7649 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007650 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007651 This option cannot be set from a |modeline| or in the |sandbox|, for
7652 security reasons.
7653
Bram Moolenaar071d4272004-06-13 20:20:40 +00007654 *'term'* *E529* *E530* *E531*
7655'term' string (default is $TERM, if that fails:
7656 in the GUI: "builtin_gui"
7657 on Amiga: "amiga"
7658 on BeOS: "beos-ansi"
7659 on Mac: "mac-ansi"
7660 on MiNT: "vt52"
7661 on MS-DOS: "pcterm"
7662 on OS/2: "os2ansi"
7663 on Unix: "ansi"
7664 on VMS: "ansi"
7665 on Win 32: "win32")
7666 global
7667 Name of the terminal. Used for choosing the terminal control
7668 characters. Environment variables are expanded |:set_env|.
7669 For example: >
7670 :set term=$TERM
7671< See |termcap|.
7672
7673 *'termbidi'* *'tbidi'*
7674 *'notermbidi'* *'notbidi'*
7675'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7676 global
7677 {not in Vi}
7678 {only available when compiled with the |+arabic|
7679 feature}
7680 The terminal is in charge of Bi-directionality of text (as specified
7681 by Unicode). The terminal is also expected to do the required shaping
7682 that some languages (such as Arabic) require.
7683 Setting this option implies that 'rightleft' will not be set when
7684 'arabic' is set and the value of 'arabicshape' will be ignored.
7685 Note that setting 'termbidi' has the immediate effect that
7686 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7687 This option is reset when the GUI is started.
7688 For further details see |arabic.txt|.
7689
7690 *'termencoding'* *'tenc'*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007691'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8"; with
Bram Moolenaar071d4272004-06-13 20:20:40 +00007692 Macintosh GUI: "macroman")
7693 global
7694 {only available when compiled with the |+multi_byte|
7695 feature}
7696 {not in Vi}
7697 Encoding used for the terminal. This specifies what character
7698 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007699 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007700 display). Except for the Mac when 'macatsui' is off, then
7701 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007702 *E617*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007703 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007704 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7705 Any attempts to set a different value will be rejected, and an error
7706 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007707 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007708 because the Win32 system always passes Unicode characters.
7709 When empty, the same encoding is used as for the 'encoding' option.
7710 This is the normal value.
7711 Not all combinations for 'termencoding' and 'encoding' are valid. See
7712 |encoding-table|.
7713 The value for this option must be supported by internal conversions or
7714 iconv(). When this is not possible no conversion will be done and you
7715 will probably experience problems with non-ASCII characters.
7716 Example: You are working with the locale set to euc-jp (Japanese) and
7717 want to edit a UTF-8 file: >
7718 :let &termencoding = &encoding
7719 :set encoding=utf-8
7720< You need to do this when your system has no locale support for UTF-8.
7721
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007722 *'termguicolors'* *'tgc'*
7723'termguicolors' 'tgc' boolean (default off)
7724 global
7725 {not in Vi}
7726 {not available when compiled without the
7727 |+termguicolors| feature}
7728 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
7729 the terminal (thus using 24-bit color). Requires a ISO-8613-3
7730 compatible terminal.
7731 If setting this option does not work (produces a colorless UI)
7732 reading |xterm-true-color| might help.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007733 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007734
Bram Moolenaar071d4272004-06-13 20:20:40 +00007735 *'terse'* *'noterse'*
7736'terse' boolean (default off)
7737 global
7738 When set: Add 's' flag to 'shortmess' option (this makes the message
7739 for a search that hits the start or end of the file not being
7740 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7741 shortens a lot of messages}
7742
7743 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7744'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7745 global
7746 {not in Vi}
7747 This option is obsolete. Use 'fileformats'.
7748 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7749 set to the default value for the current system. When 'textauto' is
7750 reset, 'fileformats' is made empty.
7751 NOTE: This option is set to the Vi default value when 'compatible' is
7752 set and to the Vim default value when 'compatible' is reset.
7753
7754 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7755'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7756 others: default off)
7757 local to buffer
7758 {not in Vi}
7759 This option is obsolete. Use 'fileformat'.
7760 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7761 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7762 "unix".
7763
7764 *'textwidth'* *'tw'*
7765'textwidth' 'tw' number (default 0)
7766 local to buffer
7767 {not in Vi}
7768 Maximum width of text that is being inserted. A longer line will be
7769 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02007770 this.
7771 'textwidth' is set to 0 when the 'paste' option is set and restored
7772 when 'paste' is reset.
7773 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007774 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007775 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007776 NOTE: This option is set to 0 when 'compatible' is set.
7777
7778 *'thesaurus'* *'tsr'*
7779'thesaurus' 'tsr' string (default "")
7780 global or local to buffer |global-local|
7781 {not in Vi}
7782 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007783 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00007784 the file should contain words with similar meaning, separated by
7785 non-keyword characters (white space is preferred). Maximum line
7786 length is 510 bytes.
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02007787 To obtain a file to be used here, check out this ftp site:
Bram Moolenaar38a55632016-02-15 22:07:32 +01007788 [Sorry this link doesn't work anymore, do you know the right one?]
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02007789 ftp://ftp.ox.ac.uk/pub/wordlists/ First get the README file.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007790 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007791 after a comma are ignored, otherwise spaces are included in the file
7792 name. See |option-backslash| about using backslashes.
7793 The use of |:set+=| and |:set-=| is preferred when adding or removing
7794 directories from the list. This avoids problems when a future version
7795 uses another default.
7796 Backticks cannot be used in this option for security reasons.
7797
7798 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7799'tildeop' 'top' boolean (default off)
7800 global
7801 {not in Vi}
7802 When on: The tilde command "~" behaves like an operator.
7803 NOTE: This option is reset when 'compatible' is set.
7804
7805 *'timeout'* *'to'* *'notimeout'* *'noto'*
7806'timeout' 'to' boolean (default on)
7807 global
7808 *'ttimeout'* *'nottimeout'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02007809'ttimeout' boolean (default off, set in |defaults.vim|))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007810 global
7811 {not in Vi}
7812 These two options together determine the behavior when part of a
7813 mapped key sequence or keyboard code has been received:
7814
7815 'timeout' 'ttimeout' action ~
7816 off off do not time out
7817 on on or off time out on :mappings and key codes
7818 off on time out on key codes
7819
7820 If both options are off, Vim will wait until either the complete
7821 mapping or key sequence has been received, or it is clear that there
7822 is no mapping or key sequence for the received characters. For
7823 example: if you have mapped "vl" and Vim has received 'v', the next
7824 character is needed to see if the 'v' is followed by an 'l'.
7825 When one of the options is on, Vim will wait for about 1 second for
7826 the next character to arrive. After that the already received
7827 characters are interpreted as single characters. The waiting time can
7828 be changed with the 'timeoutlen' option.
7829 On slow terminals or very busy systems timing out may cause
7830 malfunctioning cursor keys. If both options are off, Vim waits
7831 forever after an entered <Esc> if there are key codes that start
7832 with <Esc>. You will have to type <Esc> twice. If you do not have
7833 problems with key codes, but would like to have :mapped key
7834 sequences not timing out in 1 second, set the 'ttimeout' option and
7835 reset the 'timeout' option.
7836
7837 NOTE: 'ttimeout' is reset when 'compatible' is set.
7838
7839 *'timeoutlen'* *'tm'*
7840'timeoutlen' 'tm' number (default 1000)
7841 global
7842 {not in all versions of Vi}
7843 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02007844'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007845 global
7846 {not in Vi}
7847 The time in milliseconds that is waited for a key code or mapped key
7848 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7849 when part of a command has been typed.
7850 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7851 different timeout value for key codes is desired set 'ttimeoutlen' to
7852 a non-negative number.
7853
7854 ttimeoutlen mapping delay key code delay ~
7855 < 0 'timeoutlen' 'timeoutlen'
7856 >= 0 'timeoutlen' 'ttimeoutlen'
7857
7858 The timeout only happens when the 'timeout' and 'ttimeout' options
7859 tell so. A useful setting would be >
7860 :set timeout timeoutlen=3000 ttimeoutlen=100
7861< (time out on mapping after three seconds, time out on key codes after
7862 a tenth of a second).
7863
7864 *'title'* *'notitle'*
7865'title' boolean (default off, on when title can be restored)
7866 global
7867 {not in Vi}
7868 {not available when compiled without the |+title|
7869 feature}
7870 When on, the title of the window will be set to the value of
7871 'titlestring' (if it is not empty), or to:
7872 filename [+=-] (path) - VIM
7873 Where:
7874 filename the name of the file being edited
7875 - indicates the file cannot be modified, 'ma' off
7876 + indicates the file was modified
7877 = indicates the file is read-only
7878 =+ indicates the file is read-only and modified
7879 (path) is the path of the file being edited
7880 - VIM the server name |v:servername| or "VIM"
7881 Only works if the terminal supports setting window titles
7882 (currently Amiga console, Win32 console, all GUI versions and
7883 terminals with a non- empty 't_ts' option - these are Unix xterm and
7884 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7885 *X11*
7886 When Vim was compiled with HAVE_X11 defined, the original title will
7887 be restored if possible. The output of ":version" will include "+X11"
7888 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7889 works for the icon name |'icon'|.
7890 But: When Vim was started with the |-X| argument, restoring the title
7891 will not work (except in the GUI).
7892 If the title cannot be restored, it is set to the value of 'titleold'.
7893 You might want to restore the title outside of Vim then.
7894 When using an xterm from a remote machine you can use this command:
7895 rsh machine_name xterm -display $DISPLAY &
7896 then the WINDOWID environment variable should be inherited and the
7897 title of the window should change back to what it should be after
7898 exiting Vim.
7899
7900 *'titlelen'*
7901'titlelen' number (default 85)
7902 global
7903 {not in Vi}
7904 {not available when compiled without the |+title|
7905 feature}
7906 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007907 title. When the title is longer, only the end of the path name is
7908 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007909 Using a percentage makes this adapt to the width of the window. But
7910 it won't work perfectly, because the actual number of characters
7911 available also depends on the font used and other things in the title
7912 bar. When 'titlelen' is zero the full path is used. Otherwise,
7913 values from 1 to 30000 percent can be used.
7914 'titlelen' is also used for the 'titlestring' option.
7915
7916 *'titleold'*
7917'titleold' string (default "Thanks for flying Vim")
7918 global
7919 {not in Vi}
7920 {only available when compiled with the |+title|
7921 feature}
7922 This option will be used for the window title when exiting Vim if the
7923 original title cannot be restored. Only happens if 'title' is on or
7924 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007925 This option cannot be set from a |modeline| or in the |sandbox|, for
7926 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007927 *'titlestring'*
7928'titlestring' string (default "")
7929 global
7930 {not in Vi}
7931 {not available when compiled without the |+title|
7932 feature}
7933 When this option is not empty, it will be used for the title of the
7934 window. This happens only when the 'title' option is on.
7935 Only works if the terminal supports setting window titles (currently
7936 Amiga console, Win32 console, all GUI versions and terminals with a
7937 non-empty 't_ts' option).
7938 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01007939 be restored if possible, see |X11|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007940 When this option contains printf-style '%' items, they will be
7941 expanded according to the rules used for 'statusline'.
7942 Example: >
7943 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7944 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7945< The value of 'titlelen' is used to align items in the middle or right
7946 of the available space.
7947 Some people prefer to have the file name first: >
7948 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7949< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007950 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007951 separating space only when needed.
7952 NOTE: Use of special characters in 'titlestring' may cause the display
7953 to be garbled (e.g., when it contains a CR or NL character).
7954 {not available when compiled without the |+statusline| feature}
7955
7956 *'toolbar'* *'tb'*
7957'toolbar' 'tb' string (default "icons,tooltips")
7958 global
7959 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7960 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007961 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007962 possible values are:
7963 icons Toolbar buttons are shown with icons.
7964 text Toolbar buttons shown with text.
7965 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007966 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007967 tooltips Tooltips are active for toolbar buttons.
7968 Tooltips refer to the popup help text which appears after the mouse
7969 cursor is placed over a toolbar button for a brief moment.
7970
7971 If you want the toolbar to be shown with icons as well as text, do the
7972 following: >
7973 :set tb=icons,text
7974< Motif and Athena cannot display icons and text at the same time. They
7975 will show icons if both are requested.
7976
7977 If none of the strings specified in 'toolbar' are valid or if
7978 'toolbar' is empty, this option is ignored. If you want to disable
7979 the toolbar, you need to set the 'guioptions' option. For example: >
7980 :set guioptions-=T
7981< Also see |gui-toolbar|.
7982
7983 *'toolbariconsize'* *'tbis'*
7984'toolbariconsize' 'tbis' string (default "small")
7985 global
7986 {not in Vi}
Bram Moolenaar3df01732017-02-17 22:47:16 +01007987 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007988 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01007989 tiny Use tiny icons.
7990 small Use small icons (default).
7991 medium Use medium-sized icons.
7992 large Use large icons.
7993 huge Use even larger icons.
7994 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007995 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01007996 the current theme. Common dimensions are giant=48x48, huge=32x32,
7997 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007998
7999 If 'toolbariconsize' is empty, the global default size as determined
8000 by user preferences or the current theme is used.
8001
8002 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8003'ttybuiltin' 'tbi' boolean (default on)
8004 global
8005 {not in Vi}
8006 When on, the builtin termcaps are searched before the external ones.
8007 When off the builtin termcaps are searched after the external ones.
8008 When this option is changed, you should set the 'term' option next for
8009 the change to take effect, for example: >
8010 :set notbi term=$TERM
8011< See also |termcap|.
8012 Rationale: The default for this option is "on", because the builtin
8013 termcap entries are generally better (many systems contain faulty
8014 xterm entries...).
8015
8016 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8017'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8018 sun-cmd, screen, rxvt, dtterm or
8019 iris-ansi; also on when running Vim in
8020 a DOS console)
8021 global
8022 {not in Vi}
8023 Indicates a fast terminal connection. More characters will be sent to
8024 the screen for redrawing, instead of using insert/delete line
8025 commands. Improves smoothness of redrawing when there are multiple
8026 windows and the terminal does not support a scrolling region.
8027 Also enables the extra writing of characters at the end of each screen
8028 line for lines that wrap. This helps when using copy/paste with the
8029 mouse in an xterm and other terminals.
8030
8031 *'ttymouse'* *'ttym'*
8032'ttymouse' 'ttym' string (default depends on 'term')
8033 global
8034 {not in Vi}
8035 {only in Unix and VMS, doesn't work in the GUI; not
8036 available when compiled without |+mouse|}
8037 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008038 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008039 *xterm-mouse*
8040 xterm xterm-like mouse handling. The mouse generates
8041 "<Esc>[Mscr", where "scr" is three bytes:
8042 "s" = button state
8043 "c" = column plus 33
8044 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008045 This only works up to 223 columns! See "dec",
8046 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008047 xterm2 Works like "xterm", but with the xterm reporting the
8048 mouse position while the mouse is dragged. This works
8049 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008050 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008051 work. See below for how Vim detects this
8052 automatically.
8053 *netterm-mouse*
8054 netterm NetTerm mouse handling. The mouse generates
8055 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
8056 for the row and column.
8057 *dec-mouse*
8058 dec DEC terminal mouse handling. The mouse generates a
8059 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008060 This is also available for an Xterm, if it was
8061 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008062 *jsbterm-mouse*
8063 jsbterm JSB term mouse handling.
8064 *pterm-mouse*
8065 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008066 *urxvt-mouse*
8067 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008068 The mouse works only if the terminal supports this
8069 encoding style, but it does not have 223 columns limit
8070 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008071 *sgr-mouse*
8072 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008073 mouse reporting. The mouse works even in columns
8074 beyond 223. This option is backward compatible with
8075 "xterm2" because it can also decode "xterm2" style
8076 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008077
8078 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008079 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8080 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008081 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8082 recognized, if enabled at compile time. DEC terminal mouse codes
8083 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008084 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8085 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008086 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008087 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8088 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8089 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008090 Additionally, if vim is compiled with the |+termresponse| feature and
8091 |t_RV| is set to the escape sequence to request the xterm version
8092 number, more intelligent detection process runs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008093 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaare968e362014-05-13 20:23:24 +02008094 from 95 to 276. The "sgr" value will be set if the xterm version is
8095 277 or highter.
8096 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8097 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008098 :set t_RV=
8099<
8100 *'ttyscroll'* *'tsl'*
8101'ttyscroll' 'tsl' number (default 999)
8102 global
8103 Maximum number of lines to scroll the screen. If there are more lines
8104 to scroll the window is redrawn. For terminals where scrolling is
8105 very slow and redrawing is not slow this can be set to a small number,
8106 e.g., 3, to speed up displaying.
8107
8108 *'ttytype'* *'tty'*
8109'ttytype' 'tty' string (default from $TERM)
8110 global
8111 Alias for 'term', see above.
8112
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008113 *'undodir'* *'udir'*
8114'undodir' 'udir' string (default ".")
8115 global
8116 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008117 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008118 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008119 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008120 "." means using the directory of the file. The undo file name for
8121 "file.txt" is ".file.txt.un~".
8122 For other directories the file name is the full path of the edited
8123 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008124 When writing: The first directory that exists is used. "." always
8125 works, no directories after "." will be used for writing.
8126 When reading all entries are tried to find an undo file. The first
8127 undo file that exists is used. When it cannot be read an error is
8128 given, no further entry is used.
8129 See |undo-persistence|.
8130
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008131 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008132'undofile' 'udf' boolean (default off)
8133 local to buffer
8134 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008135 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008136 When on, Vim automatically saves undo history to an undo file when
8137 writing a buffer to a file, and restores undo history from the same
8138 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008139 The directory where the undo file is stored is specified by 'undodir'.
8140 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008141 The undo file is not read when 'undoreload' causes the buffer from
8142 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008143 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008144 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008145
Bram Moolenaar071d4272004-06-13 20:20:40 +00008146 *'undolevels'* *'ul'*
8147'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
8148 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008149 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008150 {not in Vi}
8151 Maximum number of changes that can be undone. Since undo information
8152 is kept in memory, higher numbers will cause more memory to be used
8153 (nevertheless, a single change can use an unlimited amount of memory).
8154 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8155 itself: >
8156 set ul=0
8157< But you can also get Vi compatibility by including the 'u' flag in
8158 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008159 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008160 Set to -1 for no undo at all. You might want to do this only for the
8161 current buffer: >
8162 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008163< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008164
8165 The local value is set to -123456 when the global value is to be used.
8166
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008167 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008168
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008169 *'undoreload'* *'ur'*
8170'undoreload' 'ur' number (default 10000)
8171 global
8172 {not in Vi}
8173 Save the whole buffer for undo when reloading it. This applies to the
8174 ":e!" command and reloading for when the buffer changed outside of
8175 Vim. |FileChangedShell|
8176 The save only happens when this options is negative or when the number
8177 of lines is smaller than the value of this option.
8178 Set this option to zero to disable undo for a reload.
8179
8180 When saving undo for a reload, any undo file is not read.
8181
8182 Note that this causes the whole buffer to be stored in memory. Set
8183 this option to a lower value if you run out of memory.
8184
Bram Moolenaar071d4272004-06-13 20:20:40 +00008185 *'updatecount'* *'uc'*
8186'updatecount' 'uc' number (default: 200)
8187 global
8188 {not in Vi}
8189 After typing this many characters the swap file will be written to
8190 disk. When zero, no swap file will be created at all (see chapter on
8191 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8192 Vim with the "-n" option, see |startup|. When editing in readonly
8193 mode this option will be initialized to 10000.
8194 The swapfile can be disabled per buffer with |'swapfile'|.
8195 When 'updatecount' is set from zero to non-zero, swap files are
8196 created for all buffers that have 'swapfile' set. When 'updatecount'
8197 is set to zero, existing swap files are not deleted.
8198 Also see |'swapsync'|.
8199 This option has no meaning in buffers where |'buftype'| is "nofile"
8200 or "nowrite".
8201
8202 *'updatetime'* *'ut'*
8203'updatetime' 'ut' number (default 4000)
8204 global
8205 {not in Vi}
8206 If this many milliseconds nothing is typed the swap file will be
8207 written to disk (see |crash-recovery|). Also used for the
8208 |CursorHold| autocommand event.
8209
8210 *'verbose'* *'vbs'*
8211'verbose' 'vbs' number (default 0)
8212 global
8213 {not in Vi, although some versions have a boolean
8214 verbose option}
8215 When bigger than zero, Vim will give messages about what it is doing.
8216 Currently, these messages are given:
8217 >= 1 When the viminfo file is read or written.
8218 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008219 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008220 >= 8 Files for which a group of autocommands is executed.
8221 >= 9 Every executed autocommand.
8222 >= 12 Every executed function.
8223 >= 13 When an exception is thrown, caught, finished, or discarded.
8224 >= 14 Anything pending in a ":finally" clause.
8225 >= 15 Every executed Ex command (truncated at 200 characters).
8226
8227 This option can also be set with the "-V" argument. See |-V|.
8228 This option is also set by the |:verbose| command.
8229
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008230 When the 'verbosefile' option is set then the verbose messages are not
8231 displayed.
8232
8233 *'verbosefile'* *'vfile'*
8234'verbosefile' 'vfile' string (default empty)
8235 global
8236 {not in Vi}
8237 When not empty all messages are written in a file with this name.
8238 When the file exists messages are appended.
8239 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008240 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008241 Setting 'verbosefile' to a new value is like making it empty first.
8242 The difference with |:redir| is that verbose messages are not
8243 displayed when 'verbosefile' is set.
8244
Bram Moolenaar071d4272004-06-13 20:20:40 +00008245 *'viewdir'* *'vdir'*
8246'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
8247 "$VIM/vimfiles/view",
8248 for Unix: "~/.vim/view",
8249 for Macintosh: "$VIM:vimfiles:view"
8250 for VMS: "sys$login:vimfiles/view"
8251 for RiscOS: "Choices:vimfiles/view")
8252 global
8253 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008254 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008255 feature}
8256 Name of the directory where to store files for |:mkview|.
8257 This option cannot be set from a |modeline| or in the |sandbox|, for
8258 security reasons.
8259
8260 *'viewoptions'* *'vop'*
8261'viewoptions' 'vop' string (default: "folds,options,cursor")
8262 global
8263 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008264 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008265 feature}
8266 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008267 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008268 word save and restore ~
8269 cursor cursor position in file and in window
8270 folds manually created folds, opened/closed folds and local
8271 fold options
8272 options options and mappings local to a window or buffer (not
8273 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008274 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008275 slash backslashes in file names replaced with forward
8276 slashes
8277 unix with Unix end-of-line format (single <NL>), even when
8278 on Windows or DOS
8279
8280 "slash" and "unix" are useful on Windows when sharing view files
8281 with Unix. The Unix version of Vim cannot source dos format scripts,
8282 but the Windows version of Vim can source unix format scripts.
8283
8284 *'viminfo'* *'vi'* *E526* *E527* *E528*
8285'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008286 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
8287 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8288 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008289 global
8290 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008291 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008292 feature}
8293 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008294 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00008295 separated list of parameters, each consisting of a single character
8296 identifying the particular parameter, followed by a number or string
8297 which specifies the value of that parameter. If a particular
8298 character is left out, then the default value is used for that
8299 parameter. The following is a list of the identifying characters and
8300 the effect of their value.
8301 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008302 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008303 ! When included, save and restore global variables that start
8304 with an uppercase letter, and don't contain a lowercase
8305 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008306 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008307 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008308 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008309 " Maximum number of lines saved for each register. Old name of
8310 the '<' item, with the disadvantage that you need to put a
8311 backslash before the ", otherwise it will be recognized as the
8312 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008313 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008314 % When included, save and restore the buffer list. If Vim is
8315 started with a file name argument, the buffer list is not
8316 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008317 buffer list is restored from the viminfo file. Quickfix
8318 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8319 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008320 When followed by a number, the number specifies the maximum
8321 number of buffers that are stored. Without a number all
8322 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008323 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008324 ' Maximum number of previously edited files for which the marks
8325 are remembered. This parameter must always be included when
8326 'viminfo' is non-empty.
8327 Including this item also means that the |jumplist| and the
8328 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008329 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008330 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008331 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008332 patterns are also saved. When not included, the value of
8333 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008334 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008335 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008336 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008337 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008338 < Maximum number of lines saved for each register. If zero then
8339 registers are not saved. When not included, all lines are
8340 saved. '"' is the old name for this item.
8341 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008342 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008343 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008344 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008345 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008346 c When included, convert the text in the viminfo file from the
8347 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008348 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008349 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008350 f Whether file marks need to be stored. If zero, file marks ('0
8351 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008352 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008353 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008354 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008355 h Disable the effect of 'hlsearch' when loading the viminfo
8356 file. When not included, it depends on whether ":nohlsearch"
8357 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008358 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008359 n Name of the viminfo file. The name must immediately follow
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008360 the 'n'. Must be at the end of the option! If the "-i"
8361 argument was given when starting Vim, that file name overrides
8362 the one given here with 'viminfo'. Environment variables are
8363 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008364 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008365 r Removable media. The argument is a string (up to the next
8366 ','). This parameter can be given several times. Each
8367 specifies the start of a path for which no marks will be
8368 stored. This is to avoid removable media. For MS-DOS you
8369 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8370 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8371 ignored. Maximum length of each 'r' argument is 50
8372 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008373 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008374 s Maximum size of an item in Kbyte. If zero then registers are
8375 not saved. Currently only applies to registers. The default
8376 "s10" will exclude registers with more than 10 Kbyte of text.
8377 Also see the '<' item above: line count limit.
8378
8379 Example: >
8380 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8381<
8382 '50 Marks will be remembered for the last 50 files you
8383 edited.
8384 <1000 Contents of registers (up to 1000 lines each) will be
8385 remembered.
8386 s100 Registers with more than 100 Kbyte text are skipped.
8387 :0 Command-line history will not be saved.
8388 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8389 no / Since '/' is not specified, the default will be used,
8390 that is, save all of the search history, and also the
8391 previous search and substitute patterns.
8392 no % The buffer list will not be saved nor read back.
8393 no h 'hlsearch' highlighting will be restored.
8394
8395 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8396 load the contents of the file, this is not done automatically.
8397
8398 This option cannot be set from a |modeline| or in the |sandbox|, for
8399 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008400 NOTE: This option is set to the Vim default value when 'compatible'
8401 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008402
8403 *'virtualedit'* *'ve'*
8404'virtualedit' 've' string (default "")
8405 global
8406 {not in Vi}
8407 {not available when compiled without the
8408 |+virtualedit| feature}
8409 A comma separated list of these words:
8410 block Allow virtual editing in Visual block mode.
8411 insert Allow virtual editing in Insert mode.
8412 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008413 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008414
Bram Moolenaar071d4272004-06-13 20:20:40 +00008415 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008416 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008417 of the line. Useful for selecting a rectangle in Visual mode and
8418 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008419 "onemore" is not the same, it will only allow moving the cursor just
8420 after the last character of the line. This makes some commands more
8421 consistent. Previously the cursor was always past the end of the line
8422 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008423 break some plugins or Vim scripts. For example because |l| can move
8424 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008425 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008426 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008427 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008428 It doesn't make sense to combine "all" with "onemore", but you will
8429 not get a warning for it.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008430 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008431
8432 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8433'visualbell' 'vb' boolean (default off)
8434 global
8435 {not in Vi}
8436 Use visual bell instead of beeping. The terminal code to display the
8437 visual bell is given with 't_vb'. When no beep or flash is wanted,
8438 use ":set vb t_vb=".
8439 Note: When the GUI starts, 't_vb' is reset to its default value. You
8440 might want to set it again in your |gvimrc|.
8441 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8442 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8443 where 40 is the time in msec.
8444 Does not work on the Amiga, you always get a screen flash.
8445 Also see 'errorbells'.
8446
8447 *'warn'* *'nowarn'*
8448'warn' boolean (default on)
8449 global
8450 Give a warning message when a shell command is used while the buffer
8451 has been changed.
8452
8453 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8454'weirdinvert' 'wiv' boolean (default off)
8455 global
8456 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008457 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008458 It is provided for backwards compatibility with version 4.x.
8459 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8460 vice versa. Has no effect when the GUI is running.
8461
8462 *'whichwrap'* *'ww'*
8463'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8464 global
8465 {not in Vi}
8466 Allow specified keys that move the cursor left/right to move to the
8467 previous/next line when the cursor is on the first/last character in
8468 the line. Concatenate characters to allow this for these keys:
8469 char key mode ~
8470 b <BS> Normal and Visual
8471 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008472 h "h" Normal and Visual (not recommended)
8473 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008474 < <Left> Normal and Visual
8475 > <Right> Normal and Visual
8476 ~ "~" Normal
8477 [ <Left> Insert and Replace
8478 ] <Right> Insert and Replace
8479 For example: >
8480 :set ww=<,>,[,]
8481< allows wrap only when cursor keys are used.
8482 When the movement keys are used in combination with a delete or change
8483 operator, the <EOL> also counts for a character. This makes "3h"
8484 different from "3dh" when the cursor crosses the end of a line. This
8485 is also true for "x" and "X", because they do the same as "dl" and
8486 "dh". If you use this, you may also want to use the mapping
8487 ":map <BS> X" to make backspace delete the character in front of the
8488 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008489 When 'l' is included and it is used after an operator at the end of a
8490 line then it will not move to the next line. This makes "dl", "cl",
8491 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008492 NOTE: This option is set to the Vi default value when 'compatible' is
8493 set and to the Vim default value when 'compatible' is reset.
8494
8495 *'wildchar'* *'wc'*
8496'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8497 global
8498 {not in Vi}
8499 Character you have to type to start wildcard expansion in the
8500 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008501 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008502 The character is not recognized when used inside a macro. See
8503 'wildcharm' for that.
8504 Although 'wc' is a number option, you can set it to a special key: >
8505 :set wc=<Esc>
8506< NOTE: This option is set to the Vi default value when 'compatible' is
8507 set and to the Vim default value when 'compatible' is reset.
8508
8509 *'wildcharm'* *'wcm'*
8510'wildcharm' 'wcm' number (default: none (0))
8511 global
8512 {not in Vi}
8513 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008514 recognized when used inside a macro. You can find "spare" command-line
8515 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008516 you'll never actually type 'wildcharm', just use it in mappings that
8517 automatically invoke completion mode, e.g.: >
8518 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008519 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008520< Then after typing :ss you can use CTRL-P & CTRL-N.
8521
8522 *'wildignore'* *'wig'*
8523'wildignore' 'wig' string (default "")
8524 global
8525 {not in Vi}
8526 {not available when compiled without the |+wildignore|
8527 feature}
8528 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008529 patterns is ignored when expanding |wildcards|, completing file or
8530 directory names, and influences the result of |expand()|, |glob()| and
8531 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008532 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8533 Also see 'suffixes'.
8534 Example: >
8535 :set wildignore=*.o,*.obj
8536< The use of |:set+=| and |:set-=| is preferred when adding or removing
8537 a pattern from the list. This avoids problems when a future version
8538 uses another default.
8539
Bram Moolenaar94950a92010-12-02 16:01:29 +01008540
Bram Moolenaar81af9252010-12-10 20:35:50 +01008541 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008542'wildignorecase' 'wic' boolean (default off)
8543 global
8544 {not in Vi}
8545 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008546 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008547 Does not apply when the shell is used to expand wildcards, which
8548 happens when there are special characters.
8549
8550
Bram Moolenaar071d4272004-06-13 20:20:40 +00008551 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008552'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008553 global
8554 {not in Vi}
8555 {not available if compiled without the |+wildmenu|
8556 feature}
8557 When 'wildmenu' is on, command-line completion operates in an enhanced
8558 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8559 the possible matches are shown just above the command line, with the
8560 first match highlighted (overwriting the status line, if there is
8561 one). Keys that show the previous/next match, such as <Tab> or
8562 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8563 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8564 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008565 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008566 If there are more matches than can fit in the line, a ">" is shown on
8567 the right and/or a "<" is shown on the left. The status line scrolls
8568 as needed.
8569 The "wildmenu" mode is abandoned when a key is hit that is not used
8570 for selecting a completion.
8571 While the "wildmenu" is active the following keys have special
8572 meanings:
8573
8574 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8575 <Down> - in filename/menu name completion: move into a
8576 subdirectory or submenu.
8577 <CR> - in menu completion, when the cursor is just after a
8578 dot: move into a submenu.
8579 <Up> - in filename/menu name completion: move up into
8580 parent directory or parent menu.
8581
8582 This makes the menus accessible from the console |console-menus|.
8583
8584 If you prefer the <Left> and <Right> keys to move the cursor instead
8585 of selecting a different match, use this: >
8586 :cnoremap <Left> <Space><BS><Left>
8587 :cnoremap <Right> <Space><BS><Right>
8588<
8589 The "WildMenu" highlighting is used for displaying the current match
8590 |hl-WildMenu|.
8591
8592 *'wildmode'* *'wim'*
8593'wildmode' 'wim' string (Vim default: "full")
8594 global
8595 {not in Vi}
8596 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008597 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008598 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008599 first part specifies the behavior for the first use of 'wildchar',
8600 The second part for the second use, etc.
8601 These are the possible values for each part:
8602 "" Complete only the first match.
8603 "full" Complete the next full match. After the last match,
8604 the original string is used and then the first match
8605 again.
8606 "longest" Complete till longest common string. If this doesn't
8607 result in a longer string, use the next part.
8608 "longest:full" Like "longest", but also start 'wildmenu' if it is
8609 enabled.
8610 "list" When more than one match, list all matches.
8611 "list:full" When more than one match, list all matches and
8612 complete first match.
8613 "list:longest" When more than one match, list all matches and
8614 complete till longest common string.
8615 When there is only a single match, it is fully completed in all cases.
8616
8617 Examples: >
8618 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008619< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008620 :set wildmode=longest,full
8621< Complete longest common string, then each full match >
8622 :set wildmode=list:full
8623< List all matches and complete each full match >
8624 :set wildmode=list,full
8625< List all matches without completing, then each full match >
8626 :set wildmode=longest,list
8627< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008628 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008629
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008630 *'wildoptions'* *'wop'*
8631'wildoptions' 'wop' string (default "")
8632 global
8633 {not in Vi}
8634 {not available when compiled without the |+wildignore|
8635 feature}
8636 A list of words that change how command line completion is done.
8637 Currently only one word is allowed:
8638 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008639 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008640 is displayed per line. Often used tag kinds are:
8641 d #define
8642 f function
8643 Also see |cmdline-completion|.
8644
Bram Moolenaar071d4272004-06-13 20:20:40 +00008645 *'winaltkeys'* *'wak'*
8646'winaltkeys' 'wak' string (default "menu")
8647 global
8648 {not in Vi}
8649 {only used in Win32, Motif, GTK and Photon GUI}
8650 Some GUI versions allow the access to menu entries by using the ALT
8651 key in combination with a character that appears underlined in the
8652 menu. This conflicts with the use of the ALT key for mappings and
8653 entering special characters. This option tells what to do:
8654 no Don't use ALT keys for menus. ALT key combinations can be
8655 mapped, but there is no automatic handling. This can then be
8656 done with the |:simalt| command.
8657 yes ALT key handling is done by the windowing system. ALT key
8658 combinations cannot be mapped.
8659 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008660 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008661 keys can be mapped.
8662 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8663 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008664 This option is not used for <F10>; on Win32 and with GTK <F10> will
8665 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008666
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008667 *'window'* *'wi'*
8668'window' 'wi' number (default screen height - 1)
8669 global
8670 Window height. Do not confuse this with the height of the Vim window,
8671 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008672 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8673 value is smaller than 'lines' minus one. The screen will scroll
8674 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008675 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8676 in a much smarter way, taking care of wrapping lines.
8677 When resizing the Vim window, the value is smaller than 1 or more than
8678 or equal to 'lines' it will be set to 'lines' minus 1.
8679 {Vi also uses the option to specify the number of displayed lines}
8680
Bram Moolenaar071d4272004-06-13 20:20:40 +00008681 *'winheight'* *'wh'* *E591*
8682'winheight' 'wh' number (default 1)
8683 global
8684 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008685 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008686 feature}
8687 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008688 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008689 focus goes to a window that is smaller, its size is increased, at the
8690 cost of the height of other windows.
8691 Set 'winheight' to a small number for normal editing.
8692 Set it to 999 to make the current window fill most of the screen.
8693 Other windows will be only 'winminheight' high. This has the drawback
8694 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8695 to create only two windows, set the option after startup is done,
8696 using the |VimEnter| event: >
8697 au VimEnter * set winheight=999
8698< Minimum value is 1.
8699 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008700 height of the current window.
8701 'winheight' applies to the current window. Use 'winminheight' to set
8702 the minimal height for other windows.
8703
8704 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8705'winfixheight' 'wfh' boolean (default off)
8706 local to window
8707 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008708 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008709 feature}
8710 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008711 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8712 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008713 The height may be changed anyway when running out of room.
8714
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008715 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8716'winfixwidth' 'wfw' boolean (default off)
8717 local to window
8718 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008719 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008720 feature}
8721 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008722 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008723 The width may be changed anyway when running out of room.
8724
Bram Moolenaar071d4272004-06-13 20:20:40 +00008725 *'winminheight'* *'wmh'*
8726'winminheight' 'wmh' number (default 1)
8727 global
8728 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008729 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008730 feature}
8731 The minimal height of a window, when it's not the current window.
8732 This is a hard minimum, windows will never become smaller.
8733 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8734 status bar) if necessary. They will return to at least one line when
8735 they become active (since the cursor has to have somewhere to go.)
8736 Use 'winheight' to set the minimal height of the current window.
8737 This option is only checked when making a window smaller. Don't use a
8738 large number, it will cause errors when opening more than a few
8739 windows. A value of 0 to 3 is reasonable.
8740
8741 *'winminwidth'* *'wmw'*
8742'winminwidth' 'wmw' number (default 1)
8743 global
8744 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008745 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008746 feature}
8747 The minimal width of a window, when it's not the current window.
8748 This is a hard minimum, windows will never become smaller.
8749 When set to zero, windows may be "squashed" to zero columns (i.e. just
8750 a vertical separator) if necessary. They will return to at least one
8751 line when they become active (since the cursor has to have somewhere
8752 to go.)
8753 Use 'winwidth' to set the minimal width of the current window.
8754 This option is only checked when making a window smaller. Don't use a
8755 large number, it will cause errors when opening more than a few
8756 windows. A value of 0 to 12 is reasonable.
8757
8758 *'winwidth'* *'wiw'* *E592*
8759'winwidth' 'wiw' number (default 20)
8760 global
8761 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008762 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008763 feature}
8764 Minimal number of columns for the current window. This is not a hard
8765 minimum, Vim will use fewer columns if there is not enough room. If
8766 the current window is smaller, its size is increased, at the cost of
8767 the width of other windows. Set it to 999 to make the current window
8768 always fill the screen. Set it to a small number for normal editing.
8769 The width is not adjusted after one of the commands to change the
8770 width of the current window.
8771 'winwidth' applies to the current window. Use 'winminwidth' to set
8772 the minimal width for other windows.
8773
8774 *'wrap'* *'nowrap'*
8775'wrap' boolean (default on)
8776 local to window
8777 {not in Vi}
8778 This option changes how text is displayed. It doesn't change the text
8779 in the buffer, see 'textwidth' for that.
8780 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008781 displaying continues on the next line. When off lines will not wrap
8782 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008783 moved to a part that is not shown, the screen will scroll
8784 horizontally.
8785 The line will be broken in the middle of a word if necessary. See
8786 'linebreak' to get the break at a word boundary.
8787 To make scrolling horizontally a bit more useful, try this: >
8788 :set sidescroll=5
8789 :set listchars+=precedes:<,extends:>
8790< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008791 This option can't be set from a |modeline| when the 'diff' option is
8792 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008793
8794 *'wrapmargin'* *'wm'*
8795'wrapmargin' 'wm' number (default 0)
8796 local to buffer
8797 Number of characters from the right window border where wrapping
8798 starts. When typing text beyond this limit, an <EOL> will be inserted
8799 and inserting continues on the next line.
8800 Options that add a margin, such as 'number' and 'foldcolumn', cause
8801 the text width to be further reduced. This is Vi compatible.
8802 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02008803 This option is set to 0 when 'paste' is set and restored when 'paste'
8804 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008805 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
8806 and less usefully}
8807
8808 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8809'wrapscan' 'ws' boolean (default on) *E384* *E385*
8810 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008811 Searches wrap around the end of the file. Also applies to |]s| and
8812 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008813
8814 *'write'* *'nowrite'*
8815'write' boolean (default on)
8816 global
8817 {not in Vi}
8818 Allows writing files. When not set, writing a file is not allowed.
8819 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008820 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008821 argument. Filtering text is still possible, even though this requires
8822 writing a temporary file.
8823
8824 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8825'writeany' 'wa' boolean (default off)
8826 global
8827 Allows writing to any file with no need for "!" override.
8828
8829 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8830'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8831 otherwise)
8832 global
8833 {not in Vi}
8834 Make a backup before overwriting a file. The backup is removed after
8835 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008836 also on.
8837 WARNING: Switching this option off means that when Vim fails to write
8838 your buffer correctly and then, for whatever reason, Vim exits, you
8839 lose both the original file and what you were writing. Only reset
8840 this option if your file system is almost full and it makes the write
8841 fail (and make sure not to exit Vim until the write was successful).
8842 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008843 When the 'backupskip' pattern matches, a backup is not made anyway.
8844 NOTE: This option is set to the default value when 'compatible' is
8845 set.
8846
8847 *'writedelay'* *'wd'*
8848'writedelay' 'wd' number (default 0)
8849 global
8850 {not in Vi}
Bram Moolenaar802a0d92016-06-26 16:17:58 +02008851 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008852 screen. When non-zero, characters are sent to the terminal one by
8853 one. For MS-DOS pcterm this does not work. For debugging purposes.
8854
8855 vim:tw=78:ts=8:ft=help:norl: