blob: 0a70e13ebf68b26a8e72a0b965767e64e0884f2c [file] [log] [blame]
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001*options.txt* For Vim version 8.0. Last change: 2017 Jul 23
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
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
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200373:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000374 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.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200383
384 When the optional FALLBACK argument is present, a
385 later :setfiletype command will override the
386 'filetype'. This is to used for filetype detections
387 that are just a guess. |did_filetype()| will return
388 false after this command.
389
Bram Moolenaar071d4272004-06-13 20:20:40 +0000390 {not in Vi}
391
Bram Moolenaard58e9292011-02-09 17:07:58 +0100392 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000393:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
394:opt[ions] Open a window for viewing and setting all options.
395 Options are grouped by function.
396 Offers short help for each option. Hit <CR> on the
397 short help to open a help window with more help for
398 the option.
399 Modify the value of the option and hit <CR> on the
400 "set" line to set the new value. For window and
401 buffer specific options, the last accessed window is
402 used to set the option value in, unless this is a help
403 window, in which case the window below help window is
404 used (skipping the option-window).
405 {not available when compiled without the |+eval| or
406 |+autocmd| features}
407
408 *$HOME*
409Using "~" is like using "$HOME", but it is only recognized at the start of an
410option and after a space or comma.
411
412On Unix systems "~user" can be used too. It is replaced by the home directory
413of user "user". Example: >
414 :set path=~mool/include,/usr/include,.
415
416On Unix systems the form "${HOME}" can be used too. The name between {} can
417contain non-id characters then. Note that if you want to use this for the
418"gf" command, you need to add the '{' and '}' characters to 'isfname'.
419
Bram Moolenaarf1568ec2011-12-14 21:17:39 +0100420On MS-Windows, if $HOME is not defined as an environment variable, then
421at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
422
Bram Moolenaar071d4272004-06-13 20:20:40 +0000423NOTE: expanding environment variables and "~/" is only done with the ":set"
424command, not when assigning a value to an option with ":let".
425
426
427Note the maximum length of an expanded option is limited. How much depends on
428the system, mostly it is something like 256 or 1024 characters.
429
430 *:fix* *:fixdel*
431:fix[del] Set the value of 't_kD':
432 't_kb' is 't_kD' becomes ~
433 CTRL-? CTRL-H
434 not CTRL-? CTRL-?
435
436 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
437
438 If your delete key terminal code is wrong, but the
439 code for backspace is alright, you can put this in
440 your .vimrc: >
441 :fixdel
442< This works no matter what the actual code for
443 backspace is.
444
445 If the backspace key terminal code is wrong you can
446 use this: >
447 :if &term == "termname"
448 : set t_kb=^V<BS>
449 : fixdel
450 :endif
451< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000452 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000453 with your terminal name.
454
455 If your <Delete> key sends a strange key sequence (not
456 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
457 :if &term == "termname"
458 : set t_kD=^V<Delete>
459 :endif
460< Where "^V" is CTRL-V and "<Delete>" is the delete key
461 (don't type eight characters!). Replace "termname"
462 with your terminal name.
463
464 *Linux-backspace*
465 Note about Linux: By default the backspace key
466 produces CTRL-?, which is wrong. You can fix it by
467 putting this line in your rc.local: >
468 echo "keycode 14 = BackSpace" | loadkeys
469<
470 *NetBSD-backspace*
471 Note about NetBSD: If your backspace doesn't produce
472 the right code, try this: >
473 xmodmap -e "keycode 22 = BackSpace"
474< If this works, add this in your .Xmodmap file: >
475 keysym 22 = BackSpace
476< You need to restart for this to take effect.
477
478==============================================================================
4792. Automatically setting options *auto-setting*
480
481Besides changing options with the ":set" command, there are three alternatives
482to set options automatically for one or more files:
483
4841. When starting Vim initializations are read from various places. See
485 |initialization|. Most of them are performed for all editing sessions,
486 and some of them depend on the directory where Vim is started.
487 You can create an initialization file with |:mkvimrc|, |:mkview| and
488 |:mksession|.
4892. If you start editing a new file, the automatic commands are executed.
490 This can be used to set options for files matching a particular pattern and
491 many other things. See |autocommand|.
4923. If you start editing a new file, and the 'modeline' option is on, a
493 number of lines at the beginning and end of the file are checked for
494 modelines. This is explained here.
495
496 *modeline* *vim:* *vi:* *ex:* *E520*
497There are two forms of modelines. The first form:
Bram Moolenaar14b69452013-06-29 23:05:20 +0200498 [text]{white}{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000499
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200500[text] any text or empty
501{white} at least one blank character (<Space> or <Tab>)
Bram Moolenaar14b69452013-06-29 23:05:20 +0200502{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200503[white] optional white space
504{options} a list of option settings, separated with white space
505 or ':', where each part between ':' is the argument
506 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000507
Bram Moolenaar14b69452013-06-29 23:05:20 +0200508Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000509 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200510 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000511
512The second form (this is compatible with some versions of Vi):
513
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200514 [text]{white}{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000515
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200516[text] any text or empty
517{white} at least one blank character (<Space> or <Tab>)
518{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
519[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200520se[t] the string "set " or "se " (note the space); When
521 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200522{options} a list of options, separated with white space, which
523 is the argument for a ":set" command
524: a colon
525[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000526
Bram Moolenaar14b69452013-06-29 23:05:20 +0200527Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000528 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200529 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000530
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200531The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
532chance that a normal word like "lex:" is caught. There is one exception:
533"vi:" and "vim:" can also be at the start of the line (for compatibility with
534version 3.0). Using "ex:" at the start of the line will be ignored (this
535could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000536
537 *modeline-local*
538The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000539buffer and window that contain the file. Although it's possible to set global
540options from a modeline, this is unusual. If you have two windows open and
541the files in it set the same global option to a different value, the result
542depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000543
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000544When editing a file that was already loaded, only the window-local options
545from the modeline are used. Thus if you manually changed a buffer-local
546option after opening the file, it won't be changed if you edit the same buffer
547in another window. But window-local options will be set.
548
Bram Moolenaar071d4272004-06-13 20:20:40 +0000549 *modeline-version*
550If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200551number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000552 vim{vers}: version {vers} or later
553 vim<{vers}: version before {vers}
554 vim={vers}: version {vers}
555 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100556{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
557For example, to use a modeline only for Vim 7.0:
558 /* vim700: set foldmethod=marker */ ~
559To use a modeline for Vim after version 7.2:
560 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000561There can be no blanks between "vim" and the ":".
562
563
564The number of lines that are checked can be set with the 'modelines' option.
565If 'modeline' is off or 'modelines' is 0 no lines are checked.
566
567Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000568like:
569 /* vi:ts=4: */ ~
570will give an error message for the trailing "*/". This line is OK:
571 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000572
573If an error is detected the rest of the line is skipped.
574
575If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000576backslash in front of the ':' will be removed. Example:
577 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000578This sets the 'dir' option to "c:\tmp". Only a single backslash before the
579':' is removed. Thus to include "\:" you have to specify "\\:".
580
581No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000582might create a Trojan horse text file with modelines). And not all options
583can be set. For some options a flag is set, so that when it's used the
Bram Moolenaar02467872007-05-06 13:22:01 +0000584|sandbox| is effective. Still, there is always a small risk that a modeline
Bram Moolenaar8243a792007-05-01 17:05:03 +0000585causes trouble. E.g., when some joker sets 'textwidth' to 5 all your lines
586are wrapped unexpectedly. So disable modelines before editing untrusted text.
587The mail ftplugin does this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000588
589Hint: If you would like to do something else than setting an option, you could
590define an autocommand that checks the file for a specific string. For
591example: >
592 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
593And define a function SetVar() that does something with the line containing
594"VAR".
595
596==============================================================================
5973. Options summary *option-summary*
598
599In the list below all the options are mentioned with their full name and with
600an abbreviation if there is one. Both forms may be used.
601
602In this document when a boolean option is "set" that means that ":set option"
603is entered. When an option is "reset", ":set nooption" is used.
604
605For some options there are two default values: The "Vim default", which is
606used when 'compatible' is not set, and the "Vi default", which is used when
607'compatible' is set.
608
609Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000610are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000611different value in each window. For example the 'list' option can be set in
612one window and reset in another for the same text, giving both types of view
613at the same time. There are a few options that are specific to a certain
614file. These can have a different value for each file or buffer. For example
615the 'textwidth' option can be 78 for a normal text file and 0 for a C
616program.
617
618 global one option for all buffers and windows
619 local to window each window has its own copy of this option
620 local to buffer each buffer has its own copy of this option
621
622When creating a new window the option values from the currently active window
623are used as a default value for the window-specific options. For the
624buffer-specific options this depends on the 's' and 'S' flags in the
625'cpoptions' option. If 's' is included (which is the default) the values for
626buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000627first entered. If 'S' is present the options are copied each time the buffer
628is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000629present, the options are copied from the currently active buffer when the
630buffer is created.
631
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000632Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000633
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000634Not all options are supported in all versions. This depends on the supported
635features and sometimes on the system. A remark about this is in curly braces
636below. When an option is not supported it may still be set without getting an
637error, this is called a hidden option. You can't get the value of a hidden
638option though, it is not stored.
639
640To test if option "foo" can be used with ":set" use something like this: >
641 if exists('&foo')
642This also returns true for a hidden option. To test if option "foo" is really
643supported use something like this: >
644 if exists('+foo')
645<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000646 *E355*
647A jump table for the options with a short description can be found at |Q_op|.
648
649 *'aleph'* *'al'* *aleph* *Aleph*
650'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
651 global
652 {not in Vi}
653 {only available when compiled with the |+rightleft|
654 feature}
655 The ASCII code for the first letter of the Hebrew alphabet. The
656 routine that maps the keyboard in Hebrew mode, both in Insert mode
657 (when hkmap is set) and on the command-line (when hitting CTRL-_)
658 outputs the Hebrew characters in the range [aleph..aleph+26].
659 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
660 See |rileft.txt|.
661
662 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
663'allowrevins' 'ari' boolean (default off)
664 global
665 {not in Vi}
666 {only available when compiled with the |+rightleft|
667 feature}
668 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
669 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
670 into reverse Insert mode, and don't know how to get out. See
671 'revins'.
672 NOTE: This option is reset when 'compatible' is set.
673
674 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
675'altkeymap' 'akm' boolean (default off)
676 global
677 {not in Vi}
678 {only available when compiled with the |+farsi|
679 feature}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000680 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000681 the keyboard map between Farsi and English, when 'allowrevins' set.
682
Bram Moolenaar582fd852005-03-28 20:58:01 +0000683 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000684 is useful to start the Vim in native mode i.e. English (left-to-right
685 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000686 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000687
688 *'ambiwidth'* *'ambw'*
689'ambiwidth' 'ambw' string (default: "single")
690 global
691 {not in Vi}
692 {only available when compiled with the |+multi_byte|
693 feature}
694 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
695 Tells Vim what to do with characters with East Asian Width Class
696 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
697 letters, Cyrillic letters).
698
699 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000700 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000701 expected by most users.
702 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200703 *E834* *E835*
704 The value "double" cannot be used if 'listchars' or 'fillchars'
705 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000706
707 There are a number of CJK fonts for which the width of glyphs for
708 those characters are solely based on how many octets they take in
709 legacy/traditional CJK encodings. In those encodings, Euro,
710 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000711 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000712 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000713 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000714 Vim is running inside a terminal (emulators) that uses a CJK font
715 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
716 this option should be set to "double" to match the width perceived
717 by Vim with the width of glyphs in the font. Perhaps it also has
718 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
719 when the system locale is set to one of CJK locales. See Unicode
720 Standard Annex #11 (http://www.unicode.org/reports/tr11).
721
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100722 Vim may set this option automatically at startup time when Vim is
723 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaarbf884932013-04-05 22:26:15 +0200724 escape sequence to request cursor position report.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100725
Bram Moolenaar071d4272004-06-13 20:20:40 +0000726 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
727'antialias' 'anti' boolean (default: off)
728 global
729 {not in Vi}
730 {only available when compiled with GUI enabled
731 on Mac OS X}
732 This option only has an effect in the GUI version of Vim on Mac OS X
733 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
734 which can be easier to read at certain sizes on certain displays.
735 Setting this option can sometimes cause problems if 'guifont' is set
736 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100737 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000738
739 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
740'autochdir' 'acd' boolean (default off)
741 global
742 {not in Vi}
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200743 {only available when compiled with it, use
744 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000745 When on, Vim will change the current working directory whenever you
746 open a file, switch buffers, delete a buffer or open/close a window.
747 It will change to the directory containing the file which was opened
748 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000749 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000750
751 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
752'arabic' 'arab' boolean (default off)
753 local to window
754 {not in Vi}
755 {only available when compiled with the |+arabic|
756 feature}
757 This option can be set to start editing Arabic text.
758 Setting this option will:
759 - Set the 'rightleft' option, unless 'termbidi' is set.
760 - Set the 'arabicshape' option, unless 'termbidi' is set.
761 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
762 between typing English and Arabic key mapping.
763 - Set the 'delcombine' option
764 Note that 'encoding' must be "utf-8" for working with Arabic text.
765
766 Resetting this option will:
767 - Reset the 'rightleft' option.
768 - Disable the use of 'keymap' (without changing its value).
769 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200770 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100771 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000772 Also see |arabic.txt|.
773
774 *'arabicshape'* *'arshape'*
775 *'noarabicshape'* *'noarshape'*
776'arabicshape' 'arshape' boolean (default on)
777 global
778 {not in Vi}
779 {only available when compiled with the |+arabic|
780 feature}
781 When on and 'termbidi' is off, the required visual character
782 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200783 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000784 one which encompasses:
785 a) the changing/morphing of characters based on their location
786 within a word (initial, medial, final and stand-alone).
787 b) the enabling of the ability to compose characters
788 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100789 When disabled the display shows each character's true stand-alone
790 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000791 Arabic is a complex language which requires other settings, for
792 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100793 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000794
795 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
796'autoindent' 'ai' boolean (default off)
797 local to buffer
798 Copy indent from current line when starting a new line (typing <CR>
799 in Insert mode or when using the "o" or "O" command). If you do not
800 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000801 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
802 to another line has the same effect, unless the 'I' flag is included
803 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000804 When autoindent is on, formatting (with the "gq" command or when you
805 reach 'textwidth' in Insert mode) uses the indentation of the first
806 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000807 When 'smartindent' or 'cindent' is on the indent is changed in
808 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200809 The 'autoindent' option is reset when the 'paste' option is set and
810 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000811 {small difference from Vi: After the indent is deleted when typing
812 <Esc> or <CR>, the cursor position when moving up or down is after the
813 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
814
815 *'autoread'* *'ar'* *'noautoread'* *'noar'*
816'autoread' 'ar' boolean (default off)
817 global or local to buffer |global-local|
818 {not in Vi}
819 When a file has been detected to have been changed outside of Vim and
820 it has not been changed inside of Vim, automatically read it again.
821 When the file has been deleted this is not done. |timestamp|
822 If this option has a local value, use this command to switch back to
823 using the global value: >
824 :set autoread<
825<
826 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
827'autowrite' 'aw' boolean (default off)
828 global
829 Write the contents of the file, if it has been modified, on each
830 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000831 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000832 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
833 Note that for some commands the 'autowrite' option is not used, see
834 'autowriteall' for that.
835
836 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
837'autowriteall' 'awa' boolean (default off)
838 global
839 {not in Vi}
840 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
841 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
842 Setting this option also implies that Vim behaves like 'autowrite' has
843 been set.
844
845 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200846'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000847 global
848 {not in Vi}
849 When set to "dark", Vim will try to use colors that look good on a
850 dark background. When set to "light", Vim will try to use colors that
851 look good on a light background. Any other value is illegal.
852 Vim tries to set the default value according to the terminal used.
853 This will not always be correct.
854 Setting this option does not change the background color, it tells Vim
855 what the background color looks like. For changing the background
856 color, see |:hi-normal|.
857
858 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000859 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000860 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100861 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000862 setting 'background' will cause the color scheme to be reloaded. If
863 the color scheme adjusts to the value of 'background' this will work.
864 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100865 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000866
867 When setting 'background' to the default value with: >
868 :set background&
869< Vim will guess the value. In the GUI this should work correctly,
870 in other cases Vim might not be able to guess the right value.
871
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200872 When the t_BG option is set, Vim will use it to request the background
873 color from the terminal. If the returned RGB value is dark/light and
874 'background' is not dark/light, 'background' will be set and the
875 screen is redrawn. This may have side effects, make t_BG empty in
876 your .vimrc if you suspect this problem.
877
Bram Moolenaar071d4272004-06-13 20:20:40 +0000878 When starting the GUI, the default value for 'background' will be
879 "light". When the value is not set in the .gvimrc, and Vim detects
880 that the background is actually quite dark, 'background' is set to
881 "dark". But this happens only AFTER the .gvimrc file has been read
882 (because the window needs to be opened to find the actual background
883 color). To get around this, force the GUI window to be opened by
884 putting a ":gui" command in the .gvimrc file, before where the value
885 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200886
887 For MS-DOS, Windows and OS/2 the default is "dark".
888 For other systems "dark" is used when 'term' is "linux",
889 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
890 background. Otherwise the default is "light".
891
Bram Moolenaar071d4272004-06-13 20:20:40 +0000892 Normally this option would be set in the .vimrc file. Possibly
893 depending on the terminal name. Example: >
894 :if &term == "pcterm"
895 : set background=dark
896 :endif
897< When this option is set, the default settings for the highlight groups
898 will change. To use other settings, place ":highlight" commands AFTER
899 the setting of the 'background' option.
900 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
901 to select the colors for syntax highlighting. After changing this
902 option, you must load syntax.vim again to see the result. This can be
903 done with ":syntax on".
904
905 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200906'backspace' 'bs' string (default "", set to "indent,eol,start"
907 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000908 global
909 {not in Vi}
910 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
911 mode. This is a list of items, separated by commas. Each item allows
912 a way to backspace over something:
913 value effect ~
914 indent allow backspacing over autoindent
915 eol allow backspacing over line breaks (join lines)
916 start allow backspacing over the start of insert; CTRL-W and CTRL-U
917 stop once at the start of insert.
918
919 When the value is empty, Vi compatible backspacing is used.
920
921 For backwards compatibility with version 5.4 and earlier:
922 value effect ~
923 0 same as ":set backspace=" (Vi compatible)
924 1 same as ":set backspace=indent,eol"
925 2 same as ":set backspace=indent,eol,start"
926
927 See |:fixdel| if your <BS> or <Del> key does not do what you want.
928 NOTE: This option is set to "" when 'compatible' is set.
929
930 *'backup'* *'bk'* *'nobackup'* *'nobk'*
931'backup' 'bk' boolean (default off)
932 global
933 {not in Vi}
934 Make a backup before overwriting a file. Leave it around after the
935 file has been successfully written. If you do not want to keep the
936 backup file, but you do want a backup while the file is being
937 written, reset this option and set the 'writebackup' option (this is
938 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000939 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000940 |backup-table| for more explanations.
941 When the 'backupskip' pattern matches, a backup is not made anyway.
942 When 'patchmode' is set, the backup may be renamed to become the
943 oldest version of a file.
944 NOTE: This option is reset when 'compatible' is set.
945
946 *'backupcopy'* *'bkc'*
947'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200948 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000949 {not in Vi}
950 When writing a file and a backup is made, this option tells how it's
951 done. This is a comma separated list of words.
952
953 The main values are:
954 "yes" make a copy of the file and overwrite the original one
955 "no" rename the file and write a new one
956 "auto" one of the previous, what works best
957
958 Extra values that can be combined with the ones above are:
959 "breaksymlink" always break symlinks when writing
960 "breakhardlink" always break hardlinks when writing
961
962 Making a copy and overwriting the original file:
963 - Takes extra time to copy the file.
964 + When the file has special attributes, is a (hard/symbolic) link or
965 has a resource fork, all this is preserved.
966 - When the file is a link the backup will have the name of the link,
967 not of the real file.
968
969 Renaming the file and writing a new one:
970 + It's fast.
971 - Sometimes not all attributes of the file can be copied to the new
972 file.
973 - When the file is a link the new file will not be a link.
974
975 The "auto" value is the middle way: When Vim sees that renaming file
976 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000977 the file is not a link) that is used. When problems are expected, a
978 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000979
980 The "breaksymlink" and "breakhardlink" values can be used in
981 combination with any of "yes", "no" and "auto". When included, they
982 force Vim to always break either symbolic or hard links by doing
983 exactly what the "no" option does, renaming the original file to
984 become the backup and writing a new file in its place. This can be
985 useful for example in source trees where all the files are symbolic or
986 hard links and any changes should stay in the local source tree, not
987 be propagated back to the original source.
988 *crontab*
989 One situation where "no" and "auto" will cause problems: A program
990 that opens a file, invokes Vim to edit that file, and then tests if
991 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000992 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000993 example.
994
995 When a copy is made, the original file is truncated and then filled
996 with the new text. This means that protection bits, owner and
997 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000998 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000999 group of the backup is set to the group of the original file. If this
1000 fails, the protection bits for the group are made the same as for
1001 others.
1002
1003 When the file is renamed this is the other way around: The backup has
1004 the same attributes of the original file, and the newly written file
1005 is owned by the current user. When the file was a (hard/symbolic)
1006 link, the new file will not! That's why the "auto" value doesn't
1007 rename when the file is a link. The owner and group of the newly
1008 written file will be set to the same ones as the original file, but
1009 the system may refuse to do this. In that case the "auto" value will
1010 again not rename the file.
1011
Bram Moolenaar036986f2017-03-16 17:41:02 +01001012 NOTE: This option is set to the Vi default value when 'compatible' is
1013 set and to the Vim default value when 'compatible' is reset.
1014
Bram Moolenaar071d4272004-06-13 20:20:40 +00001015 *'backupdir'* *'bdir'*
1016'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01001017 for MS-DOS and Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001018 for Unix: ".,~/tmp,~/")
1019 global
1020 {not in Vi}
1021 List of directories for the backup file, separated with commas.
1022 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001023 where this is possible. The directory must exist, Vim will not
1024 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001025 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001026 impossible!). Writing may fail because of this.
1027 - A directory "." means to put the backup file in the same directory
1028 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +00001029 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00001030 put the backup file relative to where the edited file is. The
1031 leading "." is replaced with the path name of the edited file.
1032 ("." inside a directory name has no special meaning).
1033 - Spaces after the comma are ignored, other spaces are considered part
1034 of the directory name. To have a space at the start of a directory
1035 name, precede it with a backslash.
1036 - To include a comma in a directory name precede it with a backslash.
1037 - A directory name may end in an '/'.
1038 - Environment variables are expanded |:set_env|.
1039 - Careful with '\' characters, type one before a space, type two to
1040 get one in the option (see |option-backslash|), for example: >
1041 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1042< - For backwards compatibility with Vim version 3.0 a '>' at the start
1043 of the option is removed.
1044 See also 'backup' and 'writebackup' options.
1045 If you want to hide your backup files on Unix, consider this value: >
1046 :set backupdir=./.backup,~/.backup,.,/tmp
1047< You must create a ".backup" directory in each directory and in your
1048 home directory for this to work properly.
1049 The use of |:set+=| and |:set-=| is preferred when adding or removing
1050 directories from the list. This avoids problems when a future version
1051 uses another default.
1052 This option cannot be set from a |modeline| or in the |sandbox|, for
1053 security reasons.
1054
1055 *'backupext'* *'bex'* *E589*
1056'backupext' 'bex' string (default "~", for VMS: "_")
1057 global
1058 {not in Vi}
1059 String which is appended to a file name to make the name of the
1060 backup file. The default is quite unusual, because this avoids
1061 accidentally overwriting existing files with a backup file. You might
1062 prefer using ".bak", but make sure that you don't have files with
1063 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001064 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001065
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001066 If you like to keep a lot of backups, you could use a BufWritePre
1067 autocommand to change 'backupext' just before writing the file to
1068 include a timestamp. >
1069 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1070< Use 'backupdir' to put the backup in a different directory.
1071
Bram Moolenaar071d4272004-06-13 20:20:40 +00001072 *'backupskip'* *'bsk'*
1073'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
1074 global
1075 {not in Vi}
1076 {not available when compiled without the |+wildignore|
1077 feature}
1078 A list of file patterns. When one of the patterns matches with the
1079 name of the file which is written, no backup file is created. Both
1080 the specified file name and the full path name of the file are used.
1081 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1082 Watch out for special characters, see |option-backslash|.
1083 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001084 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001085
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001086 WARNING: Not having a backup file means that when Vim fails to write
1087 your buffer correctly and then, for whatever reason, Vim exits, you
1088 lose both the original file and what you were writing. Only disable
1089 backups if you don't care about losing the file.
1090
Bram Moolenaar02467872007-05-06 13:22:01 +00001091 Note that environment variables are not expanded. If you want to use
1092 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001093 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001094
1095< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001096 backup would be made by renaming the original file crontab won't see
1097 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001098
1099 *'balloondelay'* *'bdlay'*
1100'balloondelay' 'bdlay' number (default: 600)
1101 global
1102 {not in Vi}
1103 {only available when compiled with the |+balloon_eval|
1104 feature}
1105 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1106
1107 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1108'ballooneval' 'beval' boolean (default off)
1109 global
1110 {not in Vi}
1111 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001112 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001113 Switch on the |balloon-eval| functionality.
1114
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001115 *'balloonexpr'* *'bexpr'*
1116'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001117 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001118 {not in Vi}
1119 {only available when compiled with the |+balloon_eval|
1120 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001121 Expression for text to show in evaluation balloon. It is only used
1122 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001123
1124 v:beval_bufnr number of the buffer in which balloon is going to show
1125 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001126 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001127 v:beval_lnum line number
1128 v:beval_col column number (byte index)
1129 v:beval_text word under or after the mouse pointer
1130
1131 The evaluation of the expression must not have side effects!
1132 Example: >
1133 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001134 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001135 \', column ' . v:beval_col .
1136 \ ' of file ' . bufname(v:beval_bufnr) .
1137 \ ' on word "' . v:beval_text . '"'
1138 endfunction
1139 set bexpr=MyBalloonExpr()
1140 set ballooneval
1141<
Bram Moolenaar214641f2017-03-05 17:04:09 +01001142 Also see |balloon_show()|, can be used if the content of the balloon
1143 is to be fetched asynchronously.
1144
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001145 NOTE: The balloon is displayed only if the cursor is on a text
1146 character. If the result of evaluating 'balloonexpr' is not empty,
1147 Vim does not try to send a message to an external debugger (Netbeans
1148 or Sun Workshop).
1149
Bram Moolenaar30b65812012-07-12 22:01:11 +02001150 The expression will be evaluated in the |sandbox| when set from a
1151 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001152
1153 It is not allowed to change text or jump to another window while
1154 evaluating 'balloonexpr' |textlock|.
1155
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001156 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001157 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001158< When they are supported "\n" characters will start a new line. If the
1159 expression evaluates to a |List| this is equal to using each List item
1160 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001161 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001162
Bram Moolenaar165bc692015-07-21 17:53:25 +02001163 *'belloff'* *'bo'*
1164'belloff' 'bo' string (default "")
1165 global
1166 {not in Vi}
1167 Specifies for which events the bell will not be rung. It is a comma
1168 separated list of items. For each item that is present, the bell
1169 will be silenced. This is most useful to specify specific events in
1170 insert mode to be silenced.
1171
1172 item meaning when present ~
1173 all All events.
1174 backspace When hitting <BS> or <Del> and deleting results in an
1175 error.
1176 cursor Fail to move around using the cursor keys or
1177 <PageUp>/<PageDown> in |Insert-mode|.
1178 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1179 |i_CTRL-X_CTRL-T|.
1180 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1181 |i_CTRL-E|.
1182 ctrlg Unknown Char after <C-G> in Insert mode.
1183 error Other Error occurred (e.g. try to join last line)
1184 (mostly used in |Normal-mode| or |Cmdline-mode|).
1185 esc hitting <Esc> in |Normal-mode|.
1186 ex In |Visual-mode|, hitting |Q| results in an error.
1187 hangul Error occurred when using hangul input.
1188 insertmode Pressing <Esc> in 'insertmode'.
1189 lang Calling the beep module for Lua/Mzscheme/TCL.
1190 mess No output available for |g<|.
1191 showmatch Error occurred for 'showmatch' function.
1192 operator Empty region error |cpo-E|.
1193 register Unknown register after <C-R> in |Insert-mode|.
1194 shell Bell from shell output |:!|.
1195 spell Error happened on spell suggest.
1196 wildmode More matches in |cmdline-completion| available
1197 (depends on the 'wildmode' setting).
1198
Bram Moolenaar036986f2017-03-16 17:41:02 +01001199 This is most useful to fine tune when in Insert mode the bell should
1200 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001201 indicate that an error occurred. It can be silenced by adding the
1202 "error" keyword.
1203
Bram Moolenaar071d4272004-06-13 20:20:40 +00001204 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1205'binary' 'bin' boolean (default off)
1206 local to buffer
1207 {not in Vi}
1208 This option should be set before editing a binary file. You can also
1209 use the |-b| Vim argument. When this option is switched on a few
1210 options will be changed (also when it already was on):
1211 'textwidth' will be set to 0
1212 'wrapmargin' will be set to 0
1213 'modeline' will be off
1214 'expandtab' will be off
1215 Also, 'fileformat' and 'fileformats' options will not be used, the
1216 file is read and written like 'fileformat' was "unix" (a single <NL>
1217 separates lines).
1218 The 'fileencoding' and 'fileencodings' options will not be used, the
1219 file is read without conversion.
1220 NOTE: When you start editing a(nother) file while the 'bin' option is
1221 on, settings from autocommands may change the settings again (e.g.,
1222 'textwidth'), causing trouble when editing. You might want to set
1223 'bin' again when the file has been loaded.
1224 The previous values of these options are remembered and restored when
1225 'bin' is switched from on to off. Each buffer has its own set of
1226 saved option values.
1227 To edit a file with 'binary' set you can use the |++bin| argument.
1228 This avoids you have to do ":set bin", which would have effect for all
1229 files you edit.
1230 When writing a file the <EOL> for the last line is only written if
1231 there was one in the original file (normally Vim appends an <EOL> to
1232 the last line if there is none; this would make the file longer). See
1233 the 'endofline' option.
1234
1235 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1236'bioskey' 'biosk' boolean (default on)
1237 global
1238 {not in Vi} {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001239 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001240
1241 *'bomb'* *'nobomb'*
1242'bomb' boolean (default off)
1243 local to buffer
1244 {not in Vi}
1245 {only available when compiled with the |+multi_byte|
1246 feature}
1247 When writing a file and the following conditions are met, a BOM (Byte
1248 Order Mark) is prepended to the file:
1249 - this option is on
1250 - the 'binary' option is off
1251 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1252 endian variants.
1253 Some applications use the BOM to recognize the encoding of the file.
1254 Often used for UCS-2 files on MS-Windows. For other applications it
1255 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001256 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001257 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1258 check for the presence of the BOM is done and 'bomb' set accordingly.
1259 Unless 'binary' is set, it is removed from the first line, so that you
1260 don't see it when editing. When you don't change the options, the BOM
1261 will be restored when writing the file.
1262
1263 *'breakat'* *'brk'*
1264'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1265 global
1266 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001267 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001268 feature}
1269 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001270 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1271 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001272
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001273 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001274'breakindent' 'bri' boolean (default off)
1275 local to window
1276 {not in Vi}
1277 {not available when compiled without the |+linebreak|
1278 feature}
1279 Every wrapped line will continue visually indented (same amount of
1280 space as the beginning of that line), thus preserving horizontal blocks
1281 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001282 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001283
1284 *'breakindentopt'* *'briopt'*
1285'breakindentopt' 'briopt' string (default empty)
1286 local to window
1287 {not in Vi}
1288 {not available when compiled without the |+linebreak|
1289 feature}
1290 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001291 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001292 min:{n} Minimum text width that will be kept after
1293 applying 'breakindent', even if the resulting
1294 text should normally be narrower. This prevents
1295 text indented almost to the right window border
1296 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001297 shift:{n} After applying 'breakindent', the wrapped line's
1298 beginning will be shifted by the given number of
1299 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001300 indentation (negative) or emphasizing the line
1301 continuation (positive).
1302 sbr Display the 'showbreak' value before applying the
1303 additional indent.
1304 The default value for min is 20 and shift is 0.
1305
Bram Moolenaar071d4272004-06-13 20:20:40 +00001306 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001307'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001308 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001309 {not in Vi} {only for Motif, Athena, GTK, Mac and
1310 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001311 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001312 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001313 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001314 buffer Use the directory of the related buffer.
1315 current Use the current directory.
1316 {path} Use the specified directory
1317
1318 *'bufhidden'* *'bh'*
1319'bufhidden' 'bh' string (default: "")
1320 local to buffer
1321 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001322 This option specifies what happens when a buffer is no longer
1323 displayed in a window:
1324 <empty> follow the global 'hidden' option
1325 hide hide the buffer (don't unload it), also when 'hidden'
1326 is not set
1327 unload unload the buffer, also when 'hidden' is set or using
1328 |:hide|
1329 delete delete the buffer from the buffer list, also when
1330 'hidden' is set or using |:hide|, like using
1331 |:bdelete|
1332 wipe wipe out the buffer from the buffer list, also when
1333 'hidden' is set or using |:hide|, like using
1334 |:bwipeout|
1335
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001336 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001337 are lost without a warning. Also, these values may break autocommands
1338 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001339 This option is used together with 'buftype' and 'swapfile' to specify
1340 special kinds of buffers. See |special-buffers|.
1341
1342 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1343'buflisted' 'bl' boolean (default: on)
1344 local to buffer
1345 {not in Vi}
1346 When this option is set, the buffer shows up in the buffer list. If
1347 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1348 This option is reset by Vim for buffers that are only used to remember
1349 a file name or marks. Vim sets it when starting to edit a buffer.
1350 But not when moving to a buffer with ":buffer".
1351
1352 *'buftype'* *'bt'* *E382*
1353'buftype' 'bt' string (default: "")
1354 local to buffer
1355 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001356 The value of this option specifies the type of a buffer:
1357 <empty> normal buffer
1358 nofile buffer which is not related to a file and will not be
1359 written
1360 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001361 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001362 autocommands. {not available when compiled without the
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001363 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001364 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001365 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001366 help help buffer (you are not supposed to set this
1367 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001368 terminal buffer for a |terminal| (you are not supposed to set
1369 this manually)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001370
1371 This option is used together with 'bufhidden' and 'swapfile' to
1372 specify special kinds of buffers. See |special-buffers|.
1373
1374 Be careful with changing this option, it can have many side effects!
1375
Bram Moolenaar280f1262006-01-30 00:14:18 +00001376 A "quickfix" buffer is only used for the error list and the location
1377 list. This value is set by the |:cwindow| and |:lwindow| commands and
1378 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001379
1380 "nofile" and "nowrite" buffers are similar:
1381 both: The buffer is not to be written to disk, ":w" doesn't
1382 work (":w filename" does work though).
1383 both: The buffer is never considered to be |'modified'|.
1384 There is no warning when the changes will be lost, for
1385 example when you quit Vim.
1386 both: A swap file is only created when using too much memory
1387 (when 'swapfile' has been reset there is never a swap
1388 file).
1389 nofile only: The buffer name is fixed, it is not handled like a
1390 file name. It is not modified in response to a |:cd|
1391 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001392 both: When using ":e bufname" and already editing "bufname"
1393 the buffer is made empty and autocommands are
1394 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001395 *E676*
1396 "acwrite" implies that the buffer name is not related to a file, like
1397 "nofile", but it will be written. Thus, in contrast to "nofile" and
1398 "nowrite", ":w" does work and a modified buffer can't be abandoned
1399 without saving. For writing there must be matching |BufWriteCmd|,
1400 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001401
1402 *'casemap'* *'cmp'*
1403'casemap' 'cmp' string (default: "internal,keepascii")
1404 global
1405 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001406 {only available when compiled with the |+multi_byte|
1407 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001408 Specifies details about changing the case of letters. It may contain
1409 these words, separated by a comma:
1410 internal Use internal case mapping functions, the current
1411 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001412 matters when 'encoding' is a Unicode encoding,
1413 "latin1" or "iso-8859-15". When "internal" is
1414 omitted, the towupper() and towlower() system library
1415 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001416 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1417 case mapping, the current locale is not effective.
1418 This probably only matters for Turkish.
1419
1420 *'cdpath'* *'cd'* *E344* *E346*
1421'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1422 global
1423 {not in Vi}
1424 {not available when compiled without the
1425 |+file_in_path| feature}
1426 This is a list of directories which will be searched when using the
1427 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001428 for has a relative path, not an absolute part starting with "/", "./"
1429 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001430 The 'cdpath' option's value has the same form and semantics as
1431 |'path'|. Also see |file-searching|.
1432 The default value is taken from $CDPATH, with a "," prepended to look
1433 in the current directory first.
1434 If the default value taken from $CDPATH is not what you want, include
1435 a modified version of the following command in your vimrc file to
1436 override it: >
1437 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1438< This option cannot be set from a |modeline| or in the |sandbox|, for
1439 security reasons.
1440 (parts of 'cdpath' can be passed to the shell to expand file names).
1441
1442 *'cedit'*
1443'cedit' string (Vi default: "", Vim default: CTRL-F)
1444 global
1445 {not in Vi}
1446 {not available when compiled without the |+vertsplit|
1447 feature}
1448 The key used in Command-line Mode to open the command-line window.
1449 The default is CTRL-F when 'compatible' is off.
1450 Only non-printable keys are allowed.
1451 The key can be specified as a single character, but it is difficult to
1452 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001453 :exe "set cedit=\<C-Y>"
1454 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001455< |Nvi| also has this option, but it only uses the first character.
1456 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001457 NOTE: This option is set to the Vim default value when 'compatible'
1458 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001459
1460 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1461'charconvert' 'ccv' string (default "")
1462 global
1463 {only available when compiled with the |+multi_byte|
Bram Moolenaardb84e452010-08-15 13:50:43 +02001464 and |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001465 {not in Vi}
1466 An expression that is used for character encoding conversion. It is
1467 evaluated when a file that is to be read or has been written has a
1468 different encoding from what is desired.
1469 'charconvert' is not used when the internal iconv() function is
1470 supported and is able to do the conversion. Using iconv() is
1471 preferred, because it is much faster.
1472 'charconvert' is not used when reading stdin |--|, because there is no
1473 file to convert from. You will have to save the text in a file first.
1474 The expression must return zero or an empty string for success,
1475 non-zero for failure.
1476 The possible encoding names encountered are in 'encoding'.
1477 Additionally, names given in 'fileencodings' and 'fileencoding' are
1478 used.
1479 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1480 is done internally by Vim, 'charconvert' is not used for this.
1481 'charconvert' is also used to convert the viminfo file, if the 'c'
1482 flag is present in 'viminfo'. Also used for Unicode conversion.
1483 Example: >
1484 set charconvert=CharConvert()
1485 fun CharConvert()
1486 system("recode "
1487 \ . v:charconvert_from . ".." . v:charconvert_to
1488 \ . " <" . v:fname_in . " >" v:fname_out)
1489 return v:shell_error
1490 endfun
1491< The related Vim variables are:
1492 v:charconvert_from name of the current encoding
1493 v:charconvert_to name of the desired encoding
1494 v:fname_in name of the input file
1495 v:fname_out name of the output file
1496 Note that v:fname_in and v:fname_out will never be the same.
1497 Note that v:charconvert_from and v:charconvert_to may be different
1498 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1499 Encryption is not done by Vim when using 'charconvert'. If you want
1500 to encrypt the file after conversion, 'charconvert' should take care
1501 of this.
1502 This option cannot be set from a |modeline| or in the |sandbox|, for
1503 security reasons.
1504
1505 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1506'cindent' 'cin' boolean (default off)
1507 local to buffer
1508 {not in Vi}
1509 {not available when compiled without the |+cindent|
1510 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001511 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001512 that trigger reindenting in insert mode and 'cinoptions' to set your
1513 preferred indent style.
1514 If 'indentexpr' is not empty, it overrules 'cindent'.
1515 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1516 the "=" operator indents using this algorithm rather than calling an
1517 external program.
1518 See |C-indenting|.
1519 When you don't like the way 'cindent' works, try the 'smartindent'
1520 option or 'indentexpr'.
1521 This option is not used when 'paste' is set.
1522 NOTE: This option is reset when 'compatible' is set.
1523
1524 *'cinkeys'* *'cink'*
1525'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1526 local to buffer
1527 {not in Vi}
1528 {not available when compiled without the |+cindent|
1529 feature}
1530 A list of keys that, when typed in Insert mode, cause reindenting of
1531 the current line. Only used if 'cindent' is on and 'indentexpr' is
1532 empty.
1533 For the format of this option see |cinkeys-format|.
1534 See |C-indenting|.
1535
1536 *'cinoptions'* *'cino'*
1537'cinoptions' 'cino' string (default "")
1538 local to buffer
1539 {not in Vi}
1540 {not available when compiled without the |+cindent|
1541 feature}
1542 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1543 program. See |cinoptions-values| for the values of this option, and
1544 |C-indenting| for info on C indenting in general.
1545
1546
1547 *'cinwords'* *'cinw'*
1548'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1549 local to buffer
1550 {not in Vi}
1551 {not available when compiled without both the
1552 |+cindent| and the |+smartindent| features}
1553 These keywords start an extra indent in the next line when
1554 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1555 an appropriate place (inside {}).
1556 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1557 matter, include the keyword both the uppercase and lowercase:
1558 "if,If,IF".
1559
1560 *'clipboard'* *'cb'*
1561'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1562 for X-windows, "" otherwise)
1563 global
1564 {not in Vi}
1565 {only in GUI versions or when the |+xterm_clipboard|
1566 feature is included}
1567 This option is a list of comma separated names.
1568 These names are recognized:
1569
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001570 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001571 unnamed When included, Vim will use the clipboard register '*'
1572 for all yank, delete, change and put operations which
1573 would normally go to the unnamed register. When a
1574 register is explicitly specified, it will always be
1575 used regardless of whether "unnamed" is in 'clipboard'
1576 or not. The clipboard register can always be
1577 explicitly accessed using the "* notation. Also see
1578 |gui-clipboard|.
1579
Bram Moolenaar30b65812012-07-12 22:01:11 +02001580 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001581 unnamedplus A variant of the "unnamed" flag which uses the
1582 clipboard register '+' (|quoteplus|) instead of
1583 register '*' for all yank, delete, change and put
1584 operations which would normally go to the unnamed
1585 register. When "unnamed" is also included to the
1586 option, yank operations (but not delete, change or
1587 put) will additionally copy the text into register
1588 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001589 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001590 Availability can be checked with: >
1591 if has('unnamedplus')
1592<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001593 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001594 autoselect Works like the 'a' flag in 'guioptions': If present,
1595 then whenever Visual mode is started, or the Visual
1596 area extended, Vim tries to become the owner of the
1597 windowing system's global selection or put the
1598 selected text on the clipboard used by the selection
1599 register "*. See |guioptions_a| and |quotestar| for
1600 details. When the GUI is active, the 'a' flag in
1601 'guioptions' is used, when the GUI is not active, this
1602 "autoselect" flag is used.
1603 Also applies to the modeless selection.
1604
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001605 *clipboard-autoselectplus*
1606 autoselectplus Like "autoselect" but using the + register instead of
1607 the * register. Compare to the 'P' flag in
1608 'guioptions'.
1609
1610 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001611 autoselectml Like "autoselect", but for the modeless selection
1612 only. Compare to the 'A' flag in 'guioptions'.
1613
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001614 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001615 html When the clipboard contains HTML, use this when
1616 pasting. When putting text on the clipboard, mark it
1617 as HTML. This works to copy rendered HTML from
1618 Firefox, paste it as raw HTML in Vim, select the HTML
1619 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001620 You probably want to add this only temporarily,
1621 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001622 Only supported for GTK version 2 and later.
1623 Only available with the |+multi_byte| feature.
1624
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001625 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001626 exclude:{pattern}
1627 Defines a pattern that is matched against the name of
1628 the terminal 'term'. If there is a match, no
1629 connection will be made to the X server. This is
1630 useful in this situation:
1631 - Running Vim in a console.
1632 - $DISPLAY is set to start applications on another
1633 display.
1634 - You do not want to connect to the X server in the
1635 console, but do want this in a terminal emulator.
1636 To never connect to the X server use: >
1637 exclude:.*
1638< This has the same effect as using the |-X| argument.
1639 Note that when there is no connection to the X server
1640 the window title won't be restored and the clipboard
1641 cannot be accessed.
1642 The value of 'magic' is ignored, {pattern} is
1643 interpreted as if 'magic' was on.
1644 The rest of the option value will be used for
1645 {pattern}, this must be the last entry.
1646
1647 *'cmdheight'* *'ch'*
1648'cmdheight' 'ch' number (default 1)
1649 global
1650 {not in Vi}
1651 Number of screen lines to use for the command-line. Helps avoiding
1652 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001653 The value of this option is stored with the tab page, so that each tab
1654 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001655
1656 *'cmdwinheight'* *'cwh'*
1657'cmdwinheight' 'cwh' number (default 7)
1658 global
1659 {not in Vi}
1660 {not available when compiled without the |+vertsplit|
1661 feature}
1662 Number of screen lines to use for the command-line window. |cmdwin|
1663
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001664 *'colorcolumn'* *'cc'*
1665'colorcolumn' 'cc' string (default "")
1666 local to window
1667 {not in Vi}
1668 {not available when compiled without the |+syntax|
1669 feature}
1670 'colorcolumn' is a comma separated list of screen columns that are
1671 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1672 text. Will make screen redrawing slower.
1673 The screen column can be an absolute number, or a number preceded with
1674 '+' or '-', which is added to or subtracted from 'textwidth'. >
1675
1676 :set cc=+1 " highlight column after 'textwidth'
1677 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1678 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1679<
1680 When 'textwidth' is zero then the items with '-' and '+' are not used.
1681 A maximum of 256 columns are highlighted.
1682
Bram Moolenaar071d4272004-06-13 20:20:40 +00001683 *'columns'* *'co'* *E594*
1684'columns' 'co' number (default 80 or terminal width)
1685 global
1686 {not in Vi}
1687 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001688 initialization and does not have to be set by hand. Also see
1689 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001690 When Vim is running in the GUI or in a resizable window, setting this
1691 option will cause the window size to be changed. When you only want
1692 to use the size for the GUI, put the command in your |gvimrc| file.
1693 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001694 number of columns of the display, the display may be messed up. For
1695 the GUI it is always possible and Vim limits the number of columns to
1696 what fits on the screen. You can use this command to get the widest
1697 window possible: >
1698 :set columns=9999
1699< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001700
1701 *'comments'* *'com'* *E524* *E525*
1702'comments' 'com' string (default
1703 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1704 local to buffer
1705 {not in Vi}
1706 {not available when compiled without the |+comments|
1707 feature}
1708 A comma separated list of strings that can start a comment line. See
1709 |format-comments|. See |option-backslash| about using backslashes to
1710 insert a space.
1711
1712 *'commentstring'* *'cms'* *E537*
1713'commentstring' 'cms' string (default "/*%s*/")
1714 local to buffer
1715 {not in Vi}
1716 {not available when compiled without the |+folding|
1717 feature}
1718 A template for a comment. The "%s" in the value is replaced with the
1719 comment text. Currently only used to add markers for folding, see
1720 |fold-marker|.
1721
1722 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001723'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001724 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001725 global
1726 {not in Vi}
1727 This option has the effect of making Vim either more Vi-compatible, or
1728 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001729
Bram Moolenaar071d4272004-06-13 20:20:40 +00001730 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001731 other options are also changed as a side effect.
1732 NOTE: Setting or resetting this option can have a lot of unexpected
1733 effects: Mappings are interpreted in another way, undo behaves
1734 differently, etc. If you set this option in your vimrc file, you
1735 should probably put it at the very start.
1736
Bram Moolenaar071d4272004-06-13 20:20:40 +00001737 By default this option is on and the Vi defaults are used for the
1738 options. This default was chosen for those people who want to use Vim
1739 just like Vi, and don't even (want to) know about the 'compatible'
1740 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001741 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001742 this option is switched off, and all options that have not been
1743 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001744 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001745 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001746 happen for the system-wide vimrc or gvimrc file, nor for a file given
1747 with the |-u| argument). Also see |compatible-default| and
1748 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001749 You can also set this option with the "-C" argument, and reset it with
1750 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001751 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001752
Bram Moolenaar214641f2017-03-05 17:04:09 +01001753 When this option is set, numerous other options are set to make Vim as
1754 Vi-compatible as possible. When this option is unset, various options
1755 are set to make Vim more useful. The table below lists all the
1756 options affected.
1757 The {?} column indicates when the options are affected:
1758 + Means that the option is set to the value given in {set value} when
1759 'compatible' is set.
1760 & Means that the option is set to the value given in {set value} when
1761 'compatible' is set AND is set to its Vim default value when
1762 'compatible' is unset.
1763 - Means the option is NOT changed when setting 'compatible' but IS
1764 set to its Vim default when 'compatible' is unset.
1765 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001766
Bram Moolenaar036986f2017-03-16 17:41:02 +01001767 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001768
1769 'allowrevins' + off no CTRL-_ command
1770 'antialias' + off don't use antialiased fonts
1771 'arabic' + off reset arabic-related options
1772 'arabicshape' + on correct character shapes
1773 'backspace' + "" normal backspace
1774 'backup' + off no backup file
1775 'backupcopy' & Unix: "yes" backup file is a copy
1776 else: "auto" copy or rename backup file
1777 'balloonexpr' + "" text to show in evaluation balloon
1778 'breakindent' + off don't indent when wrapping lines
1779 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1780 'cindent' + off no C code indentation
1781 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1782 'copyindent' + off don't copy indent structure
1783 'cpoptions' & (all flags) Vi-compatible flags
1784 'cscopepathcomp'+ 0 don't show directories in tags list
1785 'cscoperelative'+ off
1786 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001787 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001788 'cscopeverbose' + off see |cscopeverbose|
1789 'delcombine' + off unicode: delete whole char combination
1790 'digraph' + off no digraphs
1791 'esckeys' & off no <Esc>-keys in Insert mode
1792 'expandtab' + off tabs not expanded to spaces
1793 'fileformats' & "" no automatic file format detection,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001794 "dos,unix" except for DOS, Windows and OS/2
Bram Moolenaar214641f2017-03-05 17:04:09 +01001795 'formatexpr' + "" use 'formatprg' for auto-formatting
1796 'formatoptions' & "vt" Vi compatible formatting
1797 'gdefault' + off no default 'g' flag for ":s"
1798 'history' & 0 no commandline history
1799 'hkmap' + off no Hebrew keyboard mapping
1800 'hkmapp' + off no phonetic Hebrew keyboard mapping
1801 'hlsearch' + off no highlighting of search matches
1802 'incsearch' + off no incremental searching
1803 'indentexpr' + "" no indenting by expression
1804 'insertmode' + off do not start in Insert mode
1805 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001806 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001807 'joinspaces' + on insert 2 spaces after period
1808 'modeline' & off no modelines
1809 'more' & off no pauses in listings
1810 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1811 'numberwidth' & 8 min number of columns for line number
1812 'preserveindent'+ off don't preserve current indent structure
1813 when changing it
1814 'revins' + off no reverse insert
1815 'ruler' + off no ruler
1816 'scrolljump' + 1 no jump scroll
1817 'scrolloff' + 0 no scroll offset
1818 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1819 'shiftround' + off indent not rounded to shiftwidth
1820 'shortmess' & "" no shortening of messages
1821 'showcmd' & off command characters not shown
1822 'showmode' & off current mode not shown
1823 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1824 'smartcase' + off no automatic ignore case switch
1825 'smartindent' + off no smart indentation
1826 'smarttab' + off no smart tab size
1827 'softtabstop' + 0 tabs are always 'tabstop' positions
1828 'startofline' + on goto startofline with some commands
1829 'tagcase' & "followic" 'ignorecase' when searching tags file
1830 'tagrelative' & off tag file names are not relative
1831 'termguicolors' + off don't use highlight-(guifg|guibg)
1832 'textauto' & off no automatic textmode detection
1833 'textwidth' + 0 no automatic line wrap
1834 'tildeop' + off tilde is not an operator
1835 'ttimeout' + off no terminal timeout
1836 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001837 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001838 'virtualedit' + "" cursor can only be placed on characters
1839 'whichwrap' & "" left-right movements don't wrap
1840 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001841 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001842 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001843
1844 *'complete'* *'cpt'* *E535*
1845'complete' 'cpt' string (default: ".,w,b,u,t,i")
1846 local to buffer
1847 {not in Vi}
1848 This option specifies how keyword completion |ins-completion| works
1849 when CTRL-P or CTRL-N are used. It is also used for whole-line
1850 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1851 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001852 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001853 w scan buffers from other windows
1854 b scan other loaded buffers that are in the buffer list
1855 u scan the unloaded buffers that are in the buffer list
1856 U scan the buffers that are not in the buffer list
1857 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001858 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001859 k{dict} scan the file {dict}. Several "k" flags can be given,
1860 patterns are valid too. For example: >
1861 :set cpt=k/usr/dict/*,k~/spanish
1862< s scan the files given with the 'thesaurus' option
1863 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1864 are valid too.
1865 i scan current and included files
1866 d scan current and included files for defined name or macro
1867 |i_CTRL-X_CTRL-D|
1868 ] tag completion
1869 t same as "]"
1870
1871 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1872 not executed, this may lead to unexpected completions from some files
1873 (gzipped files for example). Unloaded buffers are not scanned for
1874 whole-line completion.
1875
1876 The default is ".,w,b,u,t,i", which means to scan:
1877 1. the current buffer
1878 2. buffers in other windows
1879 3. other loaded buffers
1880 4. unloaded buffers
1881 5. tags
1882 6. included files
1883
1884 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001885 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1886 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001887
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001888 *'completefunc'* *'cfu'*
1889'completefunc' 'cfu' string (default: empty)
1890 local to buffer
1891 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001892 {not available when compiled without the |+eval|
1893 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001894 This option specifies a function to be used for Insert mode completion
1895 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001896 See |complete-functions| for an explanation of how the function is
1897 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001898 This option cannot be set from a |modeline| or in the |sandbox|, for
1899 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001900
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001901 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001902'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001903 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001904 {not available when compiled without the
1905 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001906 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001907 A comma separated list of options for Insert mode completion
1908 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001909
1910 menu Use a popup menu to show the possible completions. The
1911 menu is only shown when there is more than one match and
1912 sufficient colors are available. |ins-completion-menu|
1913
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001914 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001915 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001916 match, e.g., what file it comes from.
1917
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001918 longest Only insert the longest common text of the matches. If
1919 the menu is displayed you can use CTRL-L to add more
1920 characters. Whether case is ignored depends on the kind
1921 of completion. For buffer text the 'ignorecase' option is
1922 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001923
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001924 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001925 completion in the preview window. Only works in
1926 combination with "menu" or "menuone".
1927
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001928 noinsert Do not insert any text for a match until the user selects
1929 a match from the menu. Only works in combination with
1930 "menu" or "menuone". No effect if "longest" is present.
1931
1932 noselect Do not select a match in the menu, force the user to
1933 select one from the menu. Only works in combination with
1934 "menu" or "menuone".
1935
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001936
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001937 *'concealcursor'* *'cocu'*
1938'concealcursor' 'cocu' string (default: "")
1939 local to window
1940 {not in Vi}
1941 {not available when compiled without the |+conceal|
1942 feature}
1943 Sets the modes in which text in the cursor line can also be concealed.
1944 When the current mode is listed then concealing happens just like in
1945 other lines.
1946 n Normal mode
1947 v Visual mode
1948 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001949 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001950
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001951 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001952 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001953 are moving around text is concealed, but when starting to insert text
1954 or selecting a Visual area the concealed text is displayed, so that
1955 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001956 Keep in mind that the cursor position is not always where it's
1957 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001958
1959
1960'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001961 number (default 0)
1962 local to window
1963 {not in Vi}
1964 {not available when compiled without the |+conceal|
1965 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001966 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1967 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001968
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001969 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001970 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001971 1 Each block of concealed text is replaced with one
1972 character. If the syntax item does not have a custom
1973 replacement character defined (see |:syn-cchar|) the
1974 character defined in 'listchars' is used (default is a
1975 space).
1976 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001977 2 Concealed text is completely hidden unless it has a
1978 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001979 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001980 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001981
Bram Moolenaara7781e02010-07-19 20:13:22 +02001982 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001983 edit and copy the text. This can be changed with the 'concealcursor'
1984 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001985
Bram Moolenaar071d4272004-06-13 20:20:40 +00001986 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1987'confirm' 'cf' boolean (default off)
1988 global
1989 {not in Vi}
1990 When 'confirm' is on, certain operations that would normally
1991 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1992 instead raise a |dialog| asking if you wish to save the current
1993 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1994 If 'confirm' is off you can still activate confirmation for one
1995 command only (this is most useful in mappings) with the |:confirm|
1996 command.
1997 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1998
1999 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2000'conskey' 'consk' boolean (default off)
2001 global
2002 {not in Vi} {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01002003 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002004
2005 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2006'copyindent' 'ci' boolean (default off)
2007 local to buffer
2008 {not in Vi}
2009 Copy the structure of the existing lines indent when autoindenting a
2010 new line. Normally the new indent is reconstructed by a series of
2011 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2012 in which case only spaces are used). Enabling this option makes the
2013 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002014 existing line. 'expandtab' has no effect on these characters, a Tab
2015 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002016 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002017 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002018 Also see 'preserveindent'.
2019
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002020 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002021'cpoptions' 'cpo' string (Vim default: "aABceFs",
2022 Vi default: all flags)
2023 global
2024 {not in Vi}
2025 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002026 this indicates Vi-compatible behavior. This is used for things where
2027 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002028 'cpoptions' stands for "compatible-options".
2029 Commas can be added for readability.
2030 To avoid problems with flags that are added in the future, use the
2031 "+=" and "-=" feature of ":set" |add-option-flags|.
2032 NOTE: This option is set to the Vi default value when 'compatible' is
2033 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002034 NOTE: This option is set to the POSIX default value at startup when
2035 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002036 variable exists |posix|. This means Vim tries to behave like the
2037 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002038
2039 contains behavior ~
2040 *cpo-a*
2041 a When included, a ":read" command with a file name
2042 argument will set the alternate file name for the
2043 current window.
2044 *cpo-A*
2045 A When included, a ":write" command with a file name
2046 argument will set the alternate file name for the
2047 current window.
2048 *cpo-b*
2049 b "\|" in a ":map" command is recognized as the end of
2050 the map command. The '\' is included in the mapping,
2051 the text after the '|' is interpreted as the next
2052 command. Use a CTRL-V instead of a backslash to
2053 include the '|' in the mapping. Applies to all
2054 mapping, abbreviation, menu and autocmd commands.
2055 See also |map_bar|.
2056 *cpo-B*
2057 B A backslash has no special meaning in mappings,
2058 abbreviations and the "to" part of the menu commands.
2059 Remove this flag to be able to use a backslash like a
2060 CTRL-V. For example, the command ":map X \<Esc>"
2061 results in X being mapped to:
2062 'B' included: "\^[" (^[ is a real <Esc>)
2063 'B' excluded: "<Esc>" (5 characters)
2064 ('<' excluded in both cases)
2065 *cpo-c*
2066 c Searching continues at the end of any match at the
2067 cursor position, but not further than the start of the
2068 next line. When not present searching continues
2069 one character from the cursor position. With 'c'
2070 "abababababab" only gets three matches when repeating
2071 "/abab", without 'c' there are five matches.
2072 *cpo-C*
2073 C Do not concatenate sourced lines that start with a
2074 backslash. See |line-continuation|.
2075 *cpo-d*
2076 d Using "./" in the 'tags' option doesn't mean to use
2077 the tags file relative to the current file, but the
2078 tags file in the current directory.
2079 *cpo-D*
2080 D Can't use CTRL-K to enter a digraph after Normal mode
2081 commands with a character argument, like |r|, |f| and
2082 |t|.
2083 *cpo-e*
2084 e When executing a register with ":@r", always add a
2085 <CR> to the last line, also when the register is not
2086 linewise. If this flag is not present, the register
2087 is not linewise and the last line does not end in a
2088 <CR>, then the last line is put on the command-line
2089 and can be edited before hitting <CR>.
2090 *cpo-E*
2091 E It is an error when using "y", "d", "c", "g~", "gu" or
2092 "gU" on an Empty region. The operators only work when
2093 at least one character is to be operate on. Example:
2094 This makes "y0" fail in the first column.
2095 *cpo-f*
2096 f When included, a ":read" command with a file name
2097 argument will set the file name for the current buffer,
2098 if the current buffer doesn't have a file name yet.
2099 *cpo-F*
2100 F When included, a ":write" command with a file name
2101 argument will set the file name for the current
2102 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002103 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002104 *cpo-g*
2105 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002106 *cpo-H*
2107 H When using "I" on a line with only blanks, insert
2108 before the last blank. Without this flag insert after
2109 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002110 *cpo-i*
2111 i When included, interrupting the reading of a file will
2112 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002113 *cpo-I*
2114 I When moving the cursor up or down just after inserting
2115 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002116 *cpo-j*
2117 j When joining lines, only add two spaces after a '.',
2118 not after '!' or '?'. Also see 'joinspaces'.
2119 *cpo-J*
2120 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002121 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002122 white space.
2123 *cpo-k*
2124 k Disable the recognition of raw key codes in
2125 mappings, abbreviations, and the "to" part of menu
2126 commands. For example, if <Key> sends ^[OA (where ^[
2127 is <Esc>), the command ":map X ^[OA" results in X
2128 being mapped to:
2129 'k' included: "^[OA" (3 characters)
2130 'k' excluded: "<Key>" (one key code)
2131 Also see the '<' flag below.
2132 *cpo-K*
2133 K Don't wait for a key code to complete when it is
2134 halfway a mapping. This breaks mapping <F1><F1> when
2135 only part of the second <F1> has been read. It
2136 enables cancelling the mapping by typing <F1><Esc>.
2137 *cpo-l*
2138 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002139 literally, only "\]", "\^", "\-" and "\\" are special.
2140 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002141 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2142 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002143 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002144 *cpo-L*
2145 L When the 'list' option is set, 'wrapmargin',
2146 'textwidth', 'softtabstop' and Virtual Replace mode
2147 (see |gR|) count a <Tab> as two characters, instead of
2148 the normal behavior of a <Tab>.
2149 *cpo-m*
2150 m When included, a showmatch will always wait half a
2151 second. When not included, a showmatch will wait half
2152 a second or until a character is typed. |'showmatch'|
2153 *cpo-M*
2154 M When excluded, "%" matching will take backslashes into
2155 account. Thus in "( \( )" and "\( ( \)" the outer
2156 parenthesis match. When included "%" ignores
2157 backslashes, which is Vi compatible.
2158 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002159 n When included, the column used for 'number' and
2160 'relativenumber' will also be used for text of wrapped
2161 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002162 *cpo-o*
2163 o Line offset to search command is not remembered for
2164 next search.
2165 *cpo-O*
2166 O Don't complain if a file is being overwritten, even
2167 when it didn't exist when editing it. This is a
2168 protection against a file unexpectedly created by
2169 someone else. Vi didn't complain about this.
2170 *cpo-p*
2171 p Vi compatible Lisp indenting. When not present, a
2172 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002173 *cpo-P*
2174 P When included, a ":write" command that appends to a
2175 file will set the file name for the current buffer, if
2176 the current buffer doesn't have a file name yet and
2177 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002178 *cpo-q*
2179 q When joining multiple lines leave the cursor at the
2180 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002181 *cpo-r*
2182 r Redo ("." command) uses "/" to repeat a search
2183 command, instead of the actually used search string.
2184 *cpo-R*
2185 R Remove marks from filtered lines. Without this flag
2186 marks are kept like |:keepmarks| was used.
2187 *cpo-s*
2188 s Set buffer options when entering the buffer for the
2189 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002190 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002191 set when the buffer is created.
2192 *cpo-S*
2193 S Set buffer options always when entering a buffer
2194 (except 'readonly', 'fileformat', 'filetype' and
2195 'syntax'). This is the (most) Vi compatible setting.
2196 The options are set to the values in the current
2197 buffer. When you change an option and go to another
2198 buffer, the value is copied. Effectively makes the
2199 buffer options global to all buffers.
2200
2201 's' 'S' copy buffer options
2202 no no when buffer created
2203 yes no when buffer first entered (default)
2204 X yes each time when buffer entered (vi comp.)
2205 *cpo-t*
2206 t Search pattern for the tag command is remembered for
2207 "n" command. Otherwise Vim only puts the pattern in
2208 the history for search pattern, but doesn't change the
2209 last used search pattern.
2210 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002211 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002212 *cpo-v*
2213 v Backspaced characters remain visible on the screen in
2214 Insert mode. Without this flag the characters are
2215 erased from the screen right away. With this flag the
2216 screen newly typed text overwrites backspaced
2217 characters.
2218 *cpo-w*
2219 w When using "cw" on a blank character, only change one
2220 character and not all blanks until the start of the
2221 next word.
2222 *cpo-W*
2223 W Don't overwrite a readonly file. When omitted, ":w!"
2224 overwrites a readonly file, if possible.
2225 *cpo-x*
2226 x <Esc> on the command-line executes the command-line.
2227 The default in Vim is to abandon the command-line,
2228 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002229 *cpo-X*
2230 X When using a count with "R" the replaced text is
2231 deleted only once. Also when repeating "R" with "."
2232 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002233 *cpo-y*
2234 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002235 *cpo-Z*
2236 Z When using "w!" while the 'readonly' option is set,
2237 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002238 *cpo-!*
2239 ! When redoing a filter command, use the last used
2240 external command, whatever it was. Otherwise the last
2241 used -filter- command is used.
2242 *cpo-$*
2243 $ When making a change to one line, don't redisplay the
2244 line, but put a '$' at the end of the changed text.
2245 The changed text will be overwritten when you type the
2246 new text. The line is redisplayed if you type any
2247 command that moves the cursor from the insertion
2248 point.
2249 *cpo-%*
2250 % Vi-compatible matching is done for the "%" command.
2251 Does not recognize "#if", "#endif", etc.
2252 Does not recognize "/*" and "*/".
2253 Parens inside single and double quotes are also
2254 counted, causing a string that contains a paren to
2255 disturb the matching. For example, in a line like
2256 "if (strcmp("foo(", s))" the first paren does not
2257 match the last one. When this flag is not included,
2258 parens inside single and double quotes are treated
2259 specially. When matching a paren outside of quotes,
2260 everything inside quotes is ignored. When matching a
2261 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002262 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002263 This flag is also used for other features, such as
2264 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002265 *cpo--*
2266 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002267 it would go above the first line or below the last
2268 line. Without it the cursor moves to the first or
2269 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002270 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002271 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002272 *cpo-+*
2273 + When included, a ":write file" command will reset the
2274 'modified' flag of the buffer, even though the buffer
2275 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002276 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002277 * Use ":*" in the same way as ":@". When not included,
2278 ":*" is an alias for ":'<,'>", select the Visual area.
2279 *cpo-<*
2280 < Disable the recognition of special key codes in |<>|
2281 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002282 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002283 ":map X <Tab>" results in X being mapped to:
2284 '<' included: "<Tab>" (5 characters)
2285 '<' excluded: "^I" (^I is a real <Tab>)
2286 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002287 *cpo->*
2288 > When appending to a register, put a line break before
2289 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002290 *cpo-;*
2291 ; When using |,| or |;| to repeat the last |t| search
2292 and the cursor is right in front of the searched
2293 character, the cursor won't move. When not included,
2294 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002295 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002296
2297 POSIX flags. These are not included in the Vi default value, except
2298 when $VIM_POSIX was set on startup. |posix|
2299
2300 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002301 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002302 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002303 *cpo-&*
2304 & When ":preserve" was used keep the swap file when
2305 exiting normally while this buffer is still loaded.
2306 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002307 *cpo-\*
2308 \ Backslash in a [] range in a search pattern is taken
2309 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002310 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2311 '\' excluded: "/[ \-]" finds <Space> and '-'
2312 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002313 *cpo-/*
2314 / When "%" is used as the replacement string in a |:s|
2315 command, use the previous replacement string. |:s%|
2316 *cpo-{*
2317 { The |{| and |}| commands also stop at a "{" character
2318 at the start of a line.
2319 *cpo-.*
2320 . The ":chdir" and ":cd" commands fail if the current
2321 buffer is modified, unless ! is used. Vim doesn't
2322 need this, since it remembers the full path of an
2323 opened file.
2324 *cpo-bar*
2325 | The value of the $LINES and $COLUMNS environment
2326 variables overrule the terminal size values obtained
2327 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002328
Bram Moolenaar071d4272004-06-13 20:20:40 +00002329
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002330 *'cryptmethod'* *'cm'*
Bram Moolenaar32efaf62014-11-05 17:02:17 +01002331'cryptmethod' 'cm' string (default "zip")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002332 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002333 {not in Vi}
2334 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002335 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002336 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002337 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002338 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002339 blowfish Blowfish method. Medium strong encryption but it has
2340 an implementation flaw. Requires Vim 7.3 or later,
2341 files can NOT be read by Vim 7.2 and older. This adds
2342 a "seed" to the file, every time you write the file
2343 the encrypted bytes will be different.
2344 *blowfish2*
2345 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002346 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002347 and older. This adds a "seed" to the file, every time
2348 you write the file the encrypted bytes will be
2349 different. The whole undo file is encrypted, not just
2350 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002351
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002352 You should use "blowfish2", also to re-encrypt older files.
2353
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002354 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002355 to the detected method of the file being read. Thus if you write it
2356 without changing 'cryptmethod' the same method will be used.
2357 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002358 explicitly write it, you don't get a warning unless there are other
2359 modifications. Also see |:X|.
2360
2361 When setting the global value to an empty string, it will end up with
2362 the value "zip". When setting the local value to an empty string the
2363 buffer will use the global value.
2364
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002365 When a new encryption method is added in a later version of Vim, and
2366 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002367 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002368
2369
Bram Moolenaar071d4272004-06-13 20:20:40 +00002370 *'cscopepathcomp'* *'cspc'*
2371'cscopepathcomp' 'cspc' number (default 0)
2372 global
2373 {not available when compiled without the |+cscope|
2374 feature}
2375 {not in Vi}
2376 Determines how many components of the path to show in a list of tags.
2377 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002378 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002379
2380 *'cscopeprg'* *'csprg'*
2381'cscopeprg' 'csprg' string (default "cscope")
2382 global
2383 {not available when compiled without the |+cscope|
2384 feature}
2385 {not in Vi}
2386 Specifies the command to execute cscope. See |cscopeprg|.
2387 This option cannot be set from a |modeline| or in the |sandbox|, for
2388 security reasons.
2389
2390 *'cscopequickfix'* *'csqf'*
2391'cscopequickfix' 'csqf' string (default "")
2392 global
2393 {not available when compiled without the |+cscope|
2394 or |+quickfix| features}
2395 {not in Vi}
2396 Specifies whether to use quickfix window to show cscope results.
2397 See |cscopequickfix|.
2398
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002399 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002400'cscoperelative' 'csre' boolean (default off)
2401 global
2402 {not available when compiled without the |+cscope|
2403 feature}
2404 {not in Vi}
2405 In the absence of a prefix (-P) for cscope. setting this option enables
2406 to use the basename of cscope.out path as the prefix.
2407 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002408 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002409
Bram Moolenaar071d4272004-06-13 20:20:40 +00002410 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2411'cscopetag' 'cst' boolean (default off)
2412 global
2413 {not available when compiled without the |+cscope|
2414 feature}
2415 {not in Vi}
2416 Use cscope for tag commands. See |cscope-options|.
2417 NOTE: This option is reset when 'compatible' is set.
2418
2419 *'cscopetagorder'* *'csto'*
2420'cscopetagorder' 'csto' number (default 0)
2421 global
2422 {not available when compiled without the |+cscope|
2423 feature}
2424 {not in Vi}
2425 Determines the order in which ":cstag" performs a search. See
2426 |cscopetagorder|.
2427 NOTE: This option is set to 0 when 'compatible' is set.
2428
2429 *'cscopeverbose'* *'csverb'*
2430 *'nocscopeverbose'* *'nocsverb'*
2431'cscopeverbose' 'csverb' boolean (default off)
2432 global
2433 {not available when compiled without the |+cscope|
2434 feature}
2435 {not in Vi}
2436 Give messages when adding a cscope database. See |cscopeverbose|.
2437 NOTE: This option is reset when 'compatible' is set.
2438
Bram Moolenaar860cae12010-06-05 23:22:07 +02002439 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2440'cursorbind' 'crb' boolean (default off)
2441 local to window
2442 {not in Vi}
2443 {not available when compiled without the |+cursorbind|
2444 feature}
2445 When this option is set, as the cursor in the current
2446 window moves other cursorbound windows (windows that also have
2447 this option set) move their cursors to the corresponding line and
2448 column. This option is useful for viewing the
2449 differences between two versions of a file (see 'diff'); in diff mode,
2450 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002451 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002452
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002453
2454 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2455'cursorcolumn' 'cuc' boolean (default off)
2456 local to window
2457 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002458 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002459 feature}
2460 Highlight the screen column of the cursor with CursorColumn
2461 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2462 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002463 If you only want the highlighting in the current window you can use
2464 these autocommands: >
2465 au WinLeave * set nocursorline nocursorcolumn
2466 au WinEnter * set cursorline cursorcolumn
2467<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002468
2469 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2470'cursorline' 'cul' boolean (default off)
2471 local to window
2472 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002473 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002474 feature}
2475 Highlight the screen line of the cursor with CursorLine
2476 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2477 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002478 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002479 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002480
2481
Bram Moolenaar071d4272004-06-13 20:20:40 +00002482 *'debug'*
2483'debug' string (default "")
2484 global
2485 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002486 These values can be used:
2487 msg Error messages that would otherwise be omitted will be given
2488 anyway.
2489 throw Error messages that would otherwise be omitted will be given
2490 anyway and also throw an exception and set |v:errmsg|.
2491 beep A message will be given when otherwise only a beep would be
2492 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002493 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002494 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2495 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002496
2497 *'define'* *'def'*
2498'define' 'def' string (default "^\s*#\s*define")
2499 global or local to buffer |global-local|
2500 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002501 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002502 pattern, just like for the "/" command. This option is used for the
2503 commands like "[i" and "[d" |include-search|. The 'isident' option is
2504 used to recognize the defined name after the match:
2505 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2506 See |option-backslash| about inserting backslashes to include a space
2507 or backslash.
2508 The default value is for C programs. For C++ this value would be
2509 useful, to include const type declarations: >
2510 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2511< When using the ":set" command, you need to double the backslashes!
2512
2513 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2514'delcombine' 'deco' boolean (default off)
2515 global
2516 {not in Vi}
2517 {only available when compiled with the |+multi_byte|
2518 feature}
2519 If editing Unicode and this option is set, backspace and Normal mode
2520 "x" delete each combining character on its own. When it is off (the
2521 default) the character along with its combining characters are
2522 deleted.
2523 Note: When 'delcombine' is set "xx" may work different from "2x"!
2524
2525 This is useful for Arabic, Hebrew and many other languages where one
2526 may have combining characters overtop of base characters, and want
2527 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002528 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002529
2530 *'dictionary'* *'dict'*
2531'dictionary' 'dict' string (default "")
2532 global or local to buffer |global-local|
2533 {not in Vi}
2534 List of file names, separated by commas, that are used to lookup words
2535 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2536 contain a list of words. This can be one word per line, or several
2537 words per line, separated by non-keyword characters (white space is
2538 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002539 When this option is empty, or an entry "spell" is present, spell
2540 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002541 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002542 after a comma are ignored, otherwise spaces are included in the file
2543 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002544 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002545 Where to find a list of words?
2546 - On FreeBSD, there is the file "/usr/share/dict/words".
2547 - In the Simtel archive, look in the "msdos/linguist" directory.
2548 - In "miscfiles" of the GNU collection.
2549 The use of |:set+=| and |:set-=| is preferred when adding or removing
2550 directories from the list. This avoids problems when a future version
2551 uses another default.
2552 Backticks cannot be used in this option for security reasons.
2553
2554 *'diff'* *'nodiff'*
2555'diff' boolean (default off)
2556 local to window
2557 {not in Vi}
2558 {not available when compiled without the |+diff|
2559 feature}
2560 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002561 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002562
2563 *'dex'* *'diffexpr'*
2564'diffexpr' 'dex' string (default "")
2565 global
2566 {not in Vi}
2567 {not available when compiled without the |+diff|
2568 feature}
2569 Expression which is evaluated to obtain an ed-style diff file from two
2570 versions of a file. See |diff-diffexpr|.
2571 This option cannot be set from a |modeline| or in the |sandbox|, for
2572 security reasons.
2573
2574 *'dip'* *'diffopt'*
2575'diffopt' 'dip' string (default "filler")
2576 global
2577 {not in Vi}
2578 {not available when compiled without the |+diff|
2579 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002580 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002581 All are optional. Items must be separated by a comma.
2582
2583 filler Show filler lines, to keep the text
2584 synchronized with a window that has inserted
2585 lines at the same position. Mostly useful
2586 when windows are side-by-side and 'scrollbind'
2587 is set.
2588
2589 context:{n} Use a context of {n} lines between a change
2590 and a fold that contains unchanged lines.
2591 When omitted a context of six lines is used.
2592 See |fold-diff|.
2593
2594 icase Ignore changes in case of text. "a" and "A"
2595 are considered the same. Adds the "-i" flag
2596 to the "diff" command if 'diffexpr' is empty.
2597
2598 iwhite Ignore changes in amount of white space. Adds
2599 the "-b" flag to the "diff" command if
2600 'diffexpr' is empty. Check the documentation
2601 of the "diff" command for what this does
2602 exactly. It should ignore adding trailing
2603 white space, but not leading white space.
2604
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002605 horizontal Start diff mode with horizontal splits (unless
2606 explicitly specified otherwise).
2607
2608 vertical Start diff mode with vertical splits (unless
2609 explicitly specified otherwise).
2610
2611 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2612 starting diff mode. Without this 2 is used.
2613
Bram Moolenaar071d4272004-06-13 20:20:40 +00002614 Examples: >
2615
2616 :set diffopt=filler,context:4
2617 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002618 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002619<
2620 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2621'digraph' 'dg' boolean (default off)
2622 global
2623 {not in Vi}
2624 {not available when compiled without the |+digraphs|
2625 feature}
2626 Enable the entering of digraphs in Insert mode with {char1} <BS>
2627 {char2}. See |digraphs|.
2628 NOTE: This option is reset when 'compatible' is set.
2629
2630 *'directory'* *'dir'*
2631'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01002632 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002633 for Unix: ".,~/tmp,/var/tmp,/tmp")
2634 global
2635 List of directory names for the swap file, separated with commas.
2636 - The swap file will be created in the first directory where this is
2637 possible.
2638 - Empty means that no swap file will be used (recovery is
2639 impossible!).
2640 - A directory "." means to put the swap file in the same directory as
2641 the edited file. On Unix, a dot is prepended to the file name, so
2642 it doesn't show in a directory listing. On MS-Windows the "hidden"
2643 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002644 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002645 put the swap file relative to where the edited file is. The leading
2646 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002647 - For Unix and Win32, if a directory ends in two path separators "//"
2648 or "\\", the swap file name will be built from the complete path to
2649 the file with all path separators substituted to percent '%' signs.
2650 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002651 On Win32, when a separating comma is following, you must use "//",
2652 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002653 - Spaces after the comma are ignored, other spaces are considered part
2654 of the directory name. To have a space at the start of a directory
2655 name, precede it with a backslash.
2656 - To include a comma in a directory name precede it with a backslash.
2657 - A directory name may end in an ':' or '/'.
2658 - Environment variables are expanded |:set_env|.
2659 - Careful with '\' characters, type one before a space, type two to
2660 get one in the option (see |option-backslash|), for example: >
2661 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2662< - For backwards compatibility with Vim version 3.0 a '>' at the start
2663 of the option is removed.
2664 Using "." first in the list is recommended. This means that editing
2665 the same file twice will result in a warning. Using "/tmp" on Unix is
2666 discouraged: When the system crashes you lose the swap file.
2667 "/var/tmp" is often not cleared when rebooting, thus is a better
2668 choice than "/tmp". But it can contain a lot of files, your swap
2669 files get lost in the crowd. That is why a "tmp" directory in your
2670 home directory is tried first.
2671 The use of |:set+=| and |:set-=| is preferred when adding or removing
2672 directories from the list. This avoids problems when a future version
2673 uses another default.
2674 This option cannot be set from a |modeline| or in the |sandbox|, for
2675 security reasons.
2676 {Vi: directory to put temp file in, defaults to "/tmp"}
2677
2678 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002679'display' 'dy' string (default "", set to "truncate" in
2680 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002681 global
2682 {not in Vi}
2683 Change the way text is displayed. This is comma separated list of
2684 flags:
2685 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002686 in a window will be displayed. "@@@" is put in the
2687 last columns of the last screen line to indicate the
2688 rest of the line is not displayed.
2689 truncate Like "lastline", but "@@@" is displayed in the first
2690 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002691 uhex Show unprintable characters hexadecimal as <xx>
2692 instead of using ^C and ~C.
2693
Bram Moolenaard0796902016-09-16 20:02:31 +02002694 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002695 doesn't fit is replaced with "@" lines.
2696
Bram Moolenaar071d4272004-06-13 20:20:40 +00002697 *'eadirection'* *'ead'*
2698'eadirection' 'ead' string (default "both")
2699 global
2700 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002701 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002702 feature}
2703 Tells when the 'equalalways' option applies:
2704 ver vertically, width of windows is not affected
2705 hor horizontally, height of windows is not affected
2706 both width and height of windows is affected
2707
2708 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2709'edcompatible' 'ed' boolean (default off)
2710 global
2711 Makes the 'g' and 'c' flags of the ":substitute" command to be
2712 toggled each time the flag is given. See |complex-change|. See
2713 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002714 Switching this option on may break plugins!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002715
Bram Moolenaar03413f42016-04-12 21:07:15 +02002716 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002717'emoji' 'emo' boolean (default: on)
2718 global
2719 {not in Vi}
2720 {only available when compiled with the |+multi_byte|
2721 feature}
2722 When on all Unicode emoji characters are considered to be full width.
2723
2724
Bram Moolenaar071d4272004-06-13 20:20:40 +00002725 *'encoding'* *'enc'* *E543*
2726'encoding' 'enc' string (default: "latin1" or value from $LANG)
2727 global
2728 {only available when compiled with the |+multi_byte|
2729 feature}
2730 {not in Vi}
2731 Sets the character encoding used inside Vim. It applies to text in
2732 the buffers, registers, Strings in expressions, text stored in the
2733 viminfo file, etc. It sets the kind of characters which Vim can work
2734 with. See |encoding-names| for the possible values.
2735
2736 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002737 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002738 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002739 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002740
Bram Moolenaar865242e2010-07-14 21:12:05 +02002741 This option cannot be set from a |modeline|. It would most likely
2742 corrupt the text.
2743
Bram Moolenaar3df01732017-02-17 22:47:16 +01002744 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2745 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002746 'encoding', "utf-8" is the natural choice for the environment and
2747 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002748 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002749 versions, and to avoid changing the encoding of newly created files
2750 without your knowledge (in case 'fileencodings' is empty).
2751
2752 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002753 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002754 iconv() or as specified with 'charconvert'.
2755
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002756 If you need to know whether 'encoding' is a multi-byte encoding, you
2757 can use: >
2758 if has("multi_byte_encoding")
2759<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002760 Normally 'encoding' will be equal to your current locale. This will
2761 be the default if Vim recognizes your environment settings. If
2762 'encoding' is not set to the current locale, 'termencoding' must be
2763 set to convert typed and displayed text. See |encoding-table|.
2764
2765 When you set this option, it fires the |EncodingChanged| autocommand
2766 event so that you can set up fonts if necessary.
2767
2768 When the option is set, the value is converted to lowercase. Thus
2769 you can set it with uppercase values too. Underscores are translated
2770 to '-' signs.
2771 When the encoding is recognized, it is changed to the standard name.
2772 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2773 "iso-8859-2" and "utf8" becomes "utf-8".
2774
2775 Note: "latin1" is also used when the encoding could not be detected.
2776 This only works when editing files in the same encoding! When the
2777 actual character set is not latin1, make sure 'fileencoding' and
2778 'fileencodings' are empty. When conversion is needed, switch to using
2779 utf-8.
2780
2781 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2782 You don't notice this while editing, but it does matter for the
2783 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2784 setting 'encoding' to one of these values instead of utf-8 only has
2785 effect for encoding used for files when 'fileencoding' is empty.
2786
Bram Moolenaar661b1822005-07-28 22:36:45 +00002787 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2788 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002789
2790 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2791'endofline' 'eol' boolean (default on)
2792 local to buffer
2793 {not in Vi}
2794 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002795 is on, or 'fixeol' option is off, no <EOL> will be written for the
2796 last line in the file. This option is automatically set or reset when
2797 starting to edit a new file, depending on whether file has an <EOL>
2798 for the last line in the file. Normally you don't have to set or
2799 reset this option.
2800 When 'binary' is off and 'fixeol' is on the value is not used when
2801 writing the file. When 'binary' is on or 'fixeol' is off it is used
2802 to remember the presence of a <EOL> for the last line in the file, so
2803 that when you write the file the situation from the original file can
2804 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002805
2806 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2807'equalalways' 'ea' boolean (default on)
2808 global
2809 {not in Vi}
2810 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002811 splitting or closing a window. This also happens the moment the
2812 option is switched on. When off, splitting a window will reduce the
2813 size of the current window and leave the other windows the same. When
2814 closing a window the extra lines are given to the window next to it
2815 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002816 When mixing vertically and horizontally split windows, a minimal size
2817 is computed and some windows may be larger if there is room. The
2818 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002819 Changing the height and width of a window can be avoided by setting
2820 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002821 If a window size is specified when creating a new window sizes are
2822 currently not equalized (it's complicated, but may be implemented in
2823 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002824
2825 *'equalprg'* *'ep'*
2826'equalprg' 'ep' string (default "")
2827 global or local to buffer |global-local|
2828 {not in Vi}
2829 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002830 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002831 or 'indentexpr'. When Vim was compiled without internal formatting,
2832 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002833 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002834 about including spaces and backslashes.
2835 This option cannot be set from a |modeline| or in the |sandbox|, for
2836 security reasons.
2837
2838 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2839'errorbells' 'eb' boolean (default off)
2840 global
2841 Ring the bell (beep or screen flash) for error messages. This only
2842 makes a difference for error messages, the bell will be used always
2843 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002844 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002845 screen flash or do nothing. See 'belloff' to finetune when to ring the
2846 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002847
2848 *'errorfile'* *'ef'*
2849'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2850 others: "errors.err")
2851 global
2852 {not in Vi}
2853 {not available when compiled without the |+quickfix|
2854 feature}
2855 Name of the errorfile for the QuickFix mode (see |:cf|).
2856 When the "-q" command-line argument is used, 'errorfile' is set to the
2857 following argument. See |-q|.
2858 NOT used for the ":make" command. See 'makeef' for that.
2859 Environment variables are expanded |:set_env|.
2860 See |option-backslash| about including spaces and backslashes.
2861 This option cannot be set from a |modeline| or in the |sandbox|, for
2862 security reasons.
2863
2864 *'errorformat'* *'efm'*
2865'errorformat' 'efm' string (default is very long)
2866 global or local to buffer |global-local|
2867 {not in Vi}
2868 {not available when compiled without the |+quickfix|
2869 feature}
2870 Scanf-like description of the format for the lines in the error file
2871 (see |errorformat|).
2872
2873 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2874'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2875 global
2876 {not in Vi}
2877 Function keys that start with an <Esc> are recognized in Insert
2878 mode. When this option is off, the cursor and function keys cannot be
2879 used in Insert mode if they start with an <Esc>. The advantage of
2880 this is that the single <Esc> is recognized immediately, instead of
2881 after one second. Instead of resetting this option, you might want to
2882 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2883 when 'esckeys' is off, you can still map anything, but the cursor keys
2884 won't work by default.
2885 NOTE: This option is set to the Vi default value when 'compatible' is
2886 set and to the Vim default value when 'compatible' is reset.
2887
2888 *'eventignore'* *'ei'*
2889'eventignore' 'ei' string (default "")
2890 global
2891 {not in Vi}
2892 {not available when compiled without the |+autocmd|
2893 feature}
2894 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002895 When set to "all" or when "all" is one of the items, all autocommand
2896 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002897 Otherwise this is a comma separated list of event names. Example: >
2898 :set ei=WinEnter,WinLeave
2899<
2900 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2901'expandtab' 'et' boolean (default off)
2902 local to buffer
2903 {not in Vi}
2904 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002905 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002906 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2907 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002908 This option is reset when the 'paste' option is set and restored when
2909 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002910 NOTE: This option is reset when 'compatible' is set.
2911
2912 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2913'exrc' 'ex' boolean (default off)
2914 global
2915 {not in Vi}
2916 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02002917 directory.
2918
2919 Setting this option is a potential security leak. E.g., consider
2920 unpacking a package or fetching files from github, a .vimrc in there
2921 might be a trojan horse. BETTER NOT SET THIS OPTION!
2922 Instead, define an autocommand in your .vimrc to set options for a
2923 matching directory.
2924
2925 If you do switch this option on you should also consider setting the
2926 'secure' option (see |initialization|).
2927 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002928 This option cannot be set from a |modeline| or in the |sandbox|, for
2929 security reasons.
2930
2931 *'fileencoding'* *'fenc'* *E213*
2932'fileencoding' 'fenc' string (default: "")
2933 local to buffer
2934 {only available when compiled with the |+multi_byte|
2935 feature}
2936 {not in Vi}
2937 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002938
Bram Moolenaar071d4272004-06-13 20:20:40 +00002939 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002940 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002941 When 'fileencoding' is empty, the same value as 'encoding' will be
2942 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01002943 No error will be given when the value is set, only when it is used,
2944 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002945 Conversion will also be done when 'encoding' and 'fileencoding' are
2946 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2947 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002948 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002949 'encoding' is "utf-8" or another Unicode encoding, conversion
2950 is most likely done in a way that the reverse conversion
2951 results in the same text. When 'encoding' is not "utf-8" some
2952 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002953
Bram Moolenaar071d4272004-06-13 20:20:40 +00002954 See 'encoding' for the possible values. Additionally, values may be
2955 specified that can be handled by the converter, see
2956 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002957
Bram Moolenaar071d4272004-06-13 20:20:40 +00002958 When reading a file 'fileencoding' will be set from 'fileencodings'.
2959 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002960 'fileencoding', use the |++enc| argument. One exception: when
2961 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002962 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002963
Bram Moolenaar071d4272004-06-13 20:20:40 +00002964 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2965 When the option is set, the value is converted to lowercase. Thus
2966 you can set it with uppercase values too. '_' characters are
2967 replaced with '-'. If a name is recognized from the list for
2968 'encoding', it is replaced by the standard name. For example
2969 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002970
Bram Moolenaar071d4272004-06-13 20:20:40 +00002971 When this option is set, after starting to edit a file, the 'modified'
2972 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002973
2974 Keep in mind that changing 'fenc' from a modeline happens
2975 AFTER the text has been read, thus it applies to when the file will be
2976 written. If you do set 'fenc' in a modeline, you might want to set
2977 'nomodified' to avoid not being able to ":q".
2978
Bram Moolenaar071d4272004-06-13 20:20:40 +00002979 This option can not be changed when 'modifiable' is off.
2980
2981 *'fe'*
2982 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002983 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002984 old short name was 'fe', which is no longer used.
2985
2986 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002987'fileencodings' 'fencs' string (default: "ucs-bom",
2988 "ucs-bom,utf-8,default,latin1" when
2989 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002990 global
2991 {only available when compiled with the |+multi_byte|
2992 feature}
2993 {not in Vi}
2994 This is a list of character encodings considered when starting to edit
2995 an existing file. When a file is read, Vim tries to use the first
2996 mentioned character encoding. If an error is detected, the next one
2997 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002998 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002999 an empty string, which means the value of 'encoding' is used.
3000 WARNING: Conversion can cause loss of information! When
3001 'encoding' is "utf-8" (or one of the other Unicode variants)
3002 conversion is most likely done in a way that the reverse
3003 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003004 "utf-8" some non-ASCII characters may be lost! You can use
3005 the |++bad| argument to specify what is done with characters
3006 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003007 For an empty file or a file with only ASCII characters most encodings
3008 will work and the first entry of 'fileencodings' will be used (except
3009 "ucs-bom", which requires the BOM to be present). If you prefer
3010 another encoding use an BufReadPost autocommand event to test if your
3011 preferred encoding is to be used. Example: >
3012 au BufReadPost * if search('\S', 'w') == 0 |
3013 \ set fenc=iso-2022-jp | endif
3014< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3015 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003016 When the |++enc| argument is used then the value of 'fileencodings' is
3017 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003018 Note that 'fileencodings' is not used for a new file, the global value
3019 of 'fileencoding' is used instead. You can set it with: >
3020 :setglobal fenc=iso-8859-2
3021< This means that a non-existing file may get a different encoding than
3022 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003023 The special value "ucs-bom" can be used to check for a Unicode BOM
3024 (Byte Order Mark) at the start of the file. It must not be preceded
3025 by "utf-8" or another Unicode encoding for this to work properly.
3026 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3027 because Vim cannot detect an error, thus the encoding is always
3028 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003029 The special value "default" can be used for the encoding from the
3030 environment. This is the default value for 'encoding'. It is useful
3031 when 'encoding' is set to "utf-8" and your environment uses a
3032 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003033 When 'encoding' is "utf-8" and a file contains an illegal byte
3034 sequence it won't be recognized as UTF-8. You can use the |8g8|
3035 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003036 WRONG VALUES: WHAT'S WRONG:
3037 latin1,utf-8 "latin1" will always be used
3038 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3039 file
3040 cp1250,latin1 "cp1250" will always be used
3041 If 'fileencodings' is empty, 'fileencoding' is not modified.
3042 See 'fileencoding' for the possible values.
3043 Setting this option does not have an effect until the next time a file
3044 is read.
3045
3046 *'fileformat'* *'ff'*
3047'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
3048 Unix default: "unix",
3049 Macintosh default: "mac")
3050 local to buffer
3051 {not in Vi}
3052 This gives the <EOL> of the current buffer, which is used for
3053 reading/writing the buffer from/to a file:
3054 dos <CR> <NL>
3055 unix <NL>
3056 mac <CR>
3057 When "dos" is used, CTRL-Z at the end of a file is ignored.
3058 See |file-formats| and |file-read|.
3059 For the character encoding of the file see 'fileencoding'.
3060 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003061 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003062 This option is set automatically when starting to edit a file and
3063 'fileformats' is not empty and 'binary' is off.
3064 When this option is set, after starting to edit a file, the 'modified'
3065 option is set, because the file would be different when written.
3066 This option can not be changed when 'modifiable' is off.
3067 For backwards compatibility: When this option is set to "dos",
3068 'textmode' is set, otherwise 'textmode' is reset.
3069
3070 *'fileformats'* *'ffs'*
3071'fileformats' 'ffs' string (default:
3072 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
3073 Vim Unix: "unix,dos",
3074 Vim Mac: "mac,unix,dos",
3075 Vi Cygwin: "unix,dos",
3076 Vi others: "")
3077 global
3078 {not in Vi}
3079 This gives the end-of-line (<EOL>) formats that will be tried when
3080 starting to edit a new buffer and when reading a file into an existing
3081 buffer:
3082 - When empty, the format defined with 'fileformat' will be used
3083 always. It is not set automatically.
3084 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003085 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003086 'fileformats' name will be used when a file is read into an existing
3087 buffer, no matter what 'fileformat' for that buffer is set to.
3088 - When more than one name is present, separated by commas, automatic
3089 <EOL> detection will be done when reading a file. When starting to
3090 edit a file, a check is done for the <EOL>:
3091 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3092 'fileformat' is set to "dos".
3093 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003094 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003095 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003096 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3097 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003098 This means that "mac" is only chosen when:
3099 "unix" is not present or no <NL> is found in the file, and
3100 "dos" is not present or no <CR><NL> is found in the file.
3101 Except: if "unix" was chosen, but there is a <CR> before
3102 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003103 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003104 4. If 'fileformat' is still not set, the first name from
3105 'fileformats' is used.
3106 When reading a file into an existing buffer, the same is done, but
3107 this happens like 'fileformat' has been set appropriately for that
3108 file only, the option is not changed.
3109 When 'binary' is set, the value of 'fileformats' is not used.
3110
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003111 When Vim starts up with an empty buffer the first item is used. You
3112 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003113
Bram Moolenaar071d4272004-06-13 20:20:40 +00003114 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3115 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3116 done:
3117 - When 'fileformats' is empty, there is no automatic detection. Dos
3118 format will be used.
3119 - When 'fileformats' is set to one or more names, automatic detection
3120 is done. This is based on the first <NL> in the file: If there is a
3121 <CR> in front of it, Dos format is used, otherwise Unix format is
3122 used.
3123 Also see |file-formats|.
3124 For backwards compatibility: When this option is set to an empty
3125 string or one format (no comma is included), 'textauto' is reset,
3126 otherwise 'textauto' is set.
3127 NOTE: This option is set to the Vi default value when 'compatible' is
3128 set and to the Vim default value when 'compatible' is reset.
3129
Bram Moolenaarbf884932013-04-05 22:26:15 +02003130 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3131'fileignorecase' 'fic' boolean (default on for systems where case in file
3132 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003133 global
3134 {not in Vi}
3135 When set case is ignored when using file names and directories.
3136 See 'wildignorecase' for only ignoring case when doing completion.
3137
Bram Moolenaar071d4272004-06-13 20:20:40 +00003138 *'filetype'* *'ft'*
3139'filetype' 'ft' string (default: "")
3140 local to buffer
3141 {not in Vi}
3142 {not available when compiled without the |+autocmd|
3143 feature}
3144 When this option is set, the FileType autocommand event is triggered.
3145 All autocommands that match with the value of this option will be
3146 executed. Thus the value of 'filetype' is used in place of the file
3147 name.
3148 Otherwise this option does not always reflect the current file type.
3149 This option is normally set when the file type is detected. To enable
3150 this use the ":filetype on" command. |:filetype|
3151 Setting this option to a different value is most useful in a modeline,
3152 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003153 Example, for in an IDL file:
3154 /* vim: set filetype=idl : */ ~
3155 |FileType| |filetypes|
3156 When a dot appears in the value then this separates two filetype
3157 names. Example:
3158 /* vim: set filetype=c.doxygen : */ ~
3159 This will use the "c" filetype first, then the "doxygen" filetype.
3160 This works both for filetype plugins and for syntax files. More than
3161 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003162 This option is not copied to another buffer, independent of the 's' or
3163 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003164 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003165
3166 *'fillchars'* *'fcs'*
3167'fillchars' 'fcs' string (default "vert:|,fold:-")
3168 global
3169 {not in Vi}
3170 {not available when compiled without the |+windows|
3171 and |+folding| features}
3172 Characters to fill the statuslines and vertical separators.
3173 It is a comma separated list of items:
3174
3175 item default Used for ~
3176 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003177 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003178 vert:c '|' vertical separators |:vsplit|
3179 fold:c '-' filling 'foldtext'
3180 diff:c '-' deleted lines of the 'diff' option
3181
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003182 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003183 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003184 otherwise.
3185
3186 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003187 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003188< This is similar to the default, except that these characters will also
3189 be used when there is highlighting.
3190
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003191 for "stl" and "stlnc" only single-byte values are supported.
3192
Bram Moolenaar071d4272004-06-13 20:20:40 +00003193 The highlighting used for these items:
3194 item highlight group ~
3195 stl:c StatusLine |hl-StatusLine|
3196 stlnc:c StatusLineNC |hl-StatusLineNC|
3197 vert:c VertSplit |hl-VertSplit|
3198 fold:c Folded |hl-Folded|
3199 diff:c DiffDelete |hl-DiffDelete|
3200
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003201 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3202'fixendofline' 'fixeol' boolean (default on)
3203 local to buffer
3204 {not in Vi}
3205 When writing a file and this option is on, <EOL> at the end of file
3206 will be restored if missing. Turn this option off if you want to
3207 preserve the situation from the original file.
3208 When the 'binary' option is set the value of this option doesn't
3209 matter.
3210 See the 'endofline' option.
3211
Bram Moolenaar071d4272004-06-13 20:20:40 +00003212 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3213'fkmap' 'fk' boolean (default off) *E198*
3214 global
3215 {not in Vi}
3216 {only available when compiled with the |+rightleft|
3217 feature}
3218 When on, the keyboard is mapped for the Farsi character set.
3219 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003220 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003221
3222 *'foldclose'* *'fcl'*
3223'foldclose' 'fcl' string (default "")
3224 global
3225 {not in Vi}
3226 {not available when compiled without the |+folding|
3227 feature}
3228 When set to "all", a fold is closed when the cursor isn't in it and
3229 its level is higher than 'foldlevel'. Useful if you want folds to
3230 automatically close when moving out of them.
3231
3232 *'foldcolumn'* *'fdc'*
3233'foldcolumn' 'fdc' number (default 0)
3234 local to window
3235 {not in Vi}
3236 {not available when compiled without the |+folding|
3237 feature}
3238 When non-zero, a column with the specified width is shown at the side
3239 of the window which indicates open and closed folds. The maximum
3240 value is 12.
3241 See |folding|.
3242
3243 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3244'foldenable' 'fen' boolean (default on)
3245 local to window
3246 {not in Vi}
3247 {not available when compiled without the |+folding|
3248 feature}
3249 When off, all folds are open. This option can be used to quickly
3250 switch between showing all text unfolded and viewing the text with
3251 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003252 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003253 'foldenable' is off.
3254 This option is set by commands that create a new fold or close a fold.
3255 See |folding|.
3256
3257 *'foldexpr'* *'fde'*
3258'foldexpr' 'fde' string (default: "0")
3259 local to window
3260 {not in Vi}
3261 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003262 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003263 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003264 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003265
Bram Moolenaar30b65812012-07-12 22:01:11 +02003266 The expression will be evaluated in the |sandbox| if set from a
3267 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003268 This option can't be set from a |modeline| when the 'diff' option is
3269 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003270
3271 It is not allowed to change text or jump to another window while
3272 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003273
3274 *'foldignore'* *'fdi'*
3275'foldignore' 'fdi' string (default: "#")
3276 local to window
3277 {not in Vi}
3278 {not available when compiled without the |+folding|
3279 feature}
3280 Used only when 'foldmethod' is "indent". Lines starting with
3281 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003282 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003283 The default "#" works well for C programs. See |fold-indent|.
3284
3285 *'foldlevel'* *'fdl'*
3286'foldlevel' 'fdl' number (default: 0)
3287 local to window
3288 {not in Vi}
3289 {not available when compiled without the |+folding|
3290 feature}
3291 Sets the fold level: Folds with a higher level will be closed.
3292 Setting this option to zero will close all folds. Higher numbers will
3293 close fewer folds.
3294 This option is set by commands like |zm|, |zM| and |zR|.
3295 See |fold-foldlevel|.
3296
3297 *'foldlevelstart'* *'fdls'*
3298'foldlevelstart' 'fdls' number (default: -1)
3299 global
3300 {not in Vi}
3301 {not available when compiled without the |+folding|
3302 feature}
3303 Sets 'foldlevel' when starting to edit another buffer in a window.
3304 Useful to always start editing with all folds closed (value zero),
3305 some folds closed (one) or no folds closed (99).
3306 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003307 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003308 ignores this option and closes all folds.
3309 It is also done before BufReadPre autocommands, to allow an autocmd to
3310 overrule the 'foldlevel' value for specific files.
3311 When the value is negative, it is not used.
3312
3313 *'foldmarker'* *'fmr'* *E536*
3314'foldmarker' 'fmr' string (default: "{{{,}}}")
3315 local to window
3316 {not in Vi}
3317 {not available when compiled without the |+folding|
3318 feature}
3319 The start and end marker used when 'foldmethod' is "marker". There
3320 must be one comma, which separates the start and end marker. The
3321 marker is a literal string (a regular expression would be too slow).
3322 See |fold-marker|.
3323
3324 *'foldmethod'* *'fdm'*
3325'foldmethod' 'fdm' string (default: "manual")
3326 local to window
3327 {not in Vi}
3328 {not available when compiled without the |+folding|
3329 feature}
3330 The kind of folding used for the current window. Possible values:
3331 |fold-manual| manual Folds are created manually.
3332 |fold-indent| indent Lines with equal indent form a fold.
3333 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3334 |fold-marker| marker Markers are used to specify folds.
3335 |fold-syntax| syntax Syntax highlighting items specify folds.
3336 |fold-diff| diff Fold text that is not changed.
3337
3338 *'foldminlines'* *'fml'*
3339'foldminlines' 'fml' number (default: 1)
3340 local to window
3341 {not in Vi}
3342 {not available when compiled without the |+folding|
3343 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003344 Sets the number of screen lines above which a fold can be displayed
3345 closed. Also for manually closed folds. With the default value of
3346 one a fold can only be closed if it takes up two or more screen lines.
3347 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003348 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003349 "zc" to close a fold, which is displayed open because it's smaller
3350 than 'foldminlines', a following "zc" may close a containing fold.
3351
3352 *'foldnestmax'* *'fdn'*
3353'foldnestmax' 'fdn' number (default: 20)
3354 local to window
3355 {not in Vi}
3356 {not available when compiled without the |+folding|
3357 feature}
3358 Sets the maximum nesting of folds for the "indent" and "syntax"
3359 methods. This avoids that too many folds will be created. Using more
3360 than 20 doesn't work, because the internal limit is 20.
3361
3362 *'foldopen'* *'fdo'*
3363'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3364 search,tag,undo")
3365 global
3366 {not in Vi}
3367 {not available when compiled without the |+folding|
3368 feature}
3369 Specifies for which type of commands folds will be opened, if the
3370 command moves the cursor into a closed fold. It is a comma separated
3371 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003372 NOTE: When the command is part of a mapping this option is not used.
3373 Add the |zv| command to the mapping to get the same effect.
3374 (rationale: the mapping may want to control opening folds itself)
3375
Bram Moolenaar071d4272004-06-13 20:20:40 +00003376 item commands ~
3377 all any
3378 block "(", "{", "[[", "[{", etc.
3379 hor horizontal movements: "l", "w", "fx", etc.
3380 insert any command in Insert mode
3381 jump far jumps: "G", "gg", etc.
3382 mark jumping to a mark: "'m", CTRL-O, etc.
3383 percent "%"
3384 quickfix ":cn", ":crew", ":make", etc.
3385 search search for a pattern: "/", "n", "*", "gd", etc.
3386 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003387 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003388 tag jumping to a tag: ":ta", CTRL-T, etc.
3389 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003390 When a movement command is used for an operator (e.g., "dl" or "y%")
3391 this option is not used. This means the operator will include the
3392 whole closed fold.
3393 Note that vertical movements are not here, because it would make it
3394 very difficult to move onto a closed fold.
3395 In insert mode the folds containing the cursor will always be open
3396 when text is inserted.
3397 To close folds you can re-apply 'foldlevel' with the |zx| command or
3398 set the 'foldclose' option to "all".
3399
3400 *'foldtext'* *'fdt'*
3401'foldtext' 'fdt' string (default: "foldtext()")
3402 local to window
3403 {not in Vi}
3404 {not available when compiled without the |+folding|
3405 feature}
3406 An expression which is used to specify the text displayed for a closed
3407 fold. See |fold-foldtext|.
3408
Bram Moolenaar30b65812012-07-12 22:01:11 +02003409 The expression will be evaluated in the |sandbox| if set from a
3410 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003411
3412 It is not allowed to change text or jump to another window while
3413 evaluating 'foldtext' |textlock|.
3414
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003415 *'formatexpr'* *'fex'*
3416'formatexpr' 'fex' string (default "")
3417 local to buffer
3418 {not in Vi}
3419 {not available when compiled without the |+eval|
3420 feature}
3421 Expression which is evaluated to format a range of lines for the |gq|
3422 operator or automatic formatting (see 'formatoptions'). When this
3423 option is empty 'formatprg' is used.
3424
3425 The |v:lnum| variable holds the first line to be formatted.
3426 The |v:count| variable holds the number of lines to be formatted.
3427 The |v:char| variable holds the character that is going to be
3428 inserted if the expression is being evaluated due to
3429 automatic formatting. This can be empty. Don't insert
3430 it yet!
3431
3432 Example: >
3433 :set formatexpr=mylang#Format()
3434< This will invoke the mylang#Format() function in the
3435 autoload/mylang.vim file in 'runtimepath'. |autoload|
3436
3437 The expression is also evaluated when 'textwidth' is set and adding
3438 text beyond that limit. This happens under the same conditions as
3439 when internal formatting is used. Make sure the cursor is kept in the
3440 same spot relative to the text then! The |mode()| function will
3441 return "i" or "R" in this situation.
3442
3443 When the expression evaluates to non-zero Vim will fall back to using
3444 the internal format mechanism.
3445
3446 The expression will be evaluated in the |sandbox| when set from a
3447 modeline, see |sandbox-option|. That stops the option from working,
3448 since changing the buffer text is not allowed.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003449 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003450
Bram Moolenaar071d4272004-06-13 20:20:40 +00003451 *'formatoptions'* *'fo'*
3452'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3453 local to buffer
3454 {not in Vi}
3455 This is a sequence of letters which describes how automatic
3456 formatting is to be done. See |fo-table|. When the 'paste' option is
3457 on, no formatting is done (like 'formatoptions' is empty). Commas can
3458 be inserted for readability.
3459 To avoid problems with flags that are added in the future, use the
3460 "+=" and "-=" feature of ":set" |add-option-flags|.
3461 NOTE: This option is set to the Vi default value when 'compatible' is
3462 set and to the Vim default value when 'compatible' is reset.
3463
Bram Moolenaar86b68352004-12-27 21:59:20 +00003464 *'formatlistpat'* *'flp'*
3465'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3466 local to buffer
3467 {not in Vi}
3468 A pattern that is used to recognize a list header. This is used for
3469 the "n" flag in 'formatoptions'.
3470 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003471 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003472 while still checking more characters. There must be a character
3473 following the pattern, when it matches the whole line it is handled
3474 like there is no match.
3475 The default recognizes a number, followed by an optional punctuation
3476 character and white space.
3477
Bram Moolenaar071d4272004-06-13 20:20:40 +00003478 *'formatprg'* *'fp'*
3479'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003480 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003481 {not in Vi}
3482 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003483 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003484 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003485 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003486 If the 'formatexpr' option is not empty it will be used instead.
3487 Otherwise, if 'formatprg' option is an empty string, the internal
3488 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003489 Environment variables are expanded |:set_env|. See |option-backslash|
3490 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003491 This option cannot be set from a |modeline| or in the |sandbox|, for
3492 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003493
Bram Moolenaard94464e2015-11-02 15:28:18 +01003494 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003495'fsync' 'fs' boolean (default on)
3496 global
3497 {not in Vi}
3498 When on, the library function fsync() will be called after writing a
3499 file. This will flush a file to disk, ensuring that it is safely
3500 written even on filesystems which do metadata-only journaling. This
3501 will force the harddrive to spin up on Linux systems running in laptop
3502 mode, so it may be undesirable in some situations. Be warned that
3503 turning this off increases the chances of data loss after a crash. On
3504 systems without an fsync() implementation, this variable is always
3505 off.
3506 Also see 'swapsync' for controlling fsync() on swap files.
3507
Bram Moolenaar071d4272004-06-13 20:20:40 +00003508 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3509'gdefault' 'gd' boolean (default off)
3510 global
3511 {not in Vi}
3512 When on, the ":substitute" flag 'g' is default on. This means that
3513 all matches in a line are substituted instead of one. When a 'g' flag
3514 is given to a ":substitute" command, this will toggle the substitution
3515 of all or one match. See |complex-change|.
3516
3517 command 'gdefault' on 'gdefault' off ~
3518 :s/// subst. all subst. one
3519 :s///g subst. one subst. all
3520 :s///gg subst. all subst. one
3521
3522 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003523 DEPRECATED: Setting this option may break plugins that are not aware
3524 of this option. Also, many users get confused that adding the /g flag
3525 has the opposite effect of that it normally does.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003526
3527 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003528'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003529 global
3530 {not in Vi}
3531 Format to recognize for the ":grep" command output.
3532 This is a scanf-like string that uses the same format as the
3533 'errorformat' option: see |errorformat|.
3534
3535 *'grepprg'* *'gp'*
3536'grepprg' 'gp' string (default "grep -n ",
3537 Unix: "grep -n $* /dev/null",
3538 Win32: "findstr /n" or "grep -n",
3539 VMS: "SEARCH/NUMBERS ")
3540 global or local to buffer |global-local|
3541 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003542 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003543 and '#' characters, which are expanded like when used in a command-
3544 line. The placeholder "$*" is allowed to specify where the arguments
3545 will be included. Environment variables are expanded |:set_env|. See
3546 |option-backslash| about including spaces and backslashes.
3547 When your "grep" accepts the "-H" argument, use this to make ":grep"
3548 also work well with a single file: >
3549 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003550< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003551 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3552 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003553 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003554 apply equally to 'grepprg'.
3555 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3556 otherwise it's "grep -n".
3557 This option cannot be set from a |modeline| or in the |sandbox|, for
3558 security reasons.
3559
3560 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3561'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3562 ve:ver35-Cursor,
3563 o:hor50-Cursor,
3564 i-ci:ver25-Cursor/lCursor,
3565 r-cr:hor20-Cursor/lCursor,
3566 sm:block-Cursor
3567 -blinkwait175-blinkoff150-blinkon175",
3568 for MS-DOS and Win32 console:
3569 "n-v-c:block,o:hor50,i-ci:hor15,
3570 r-cr:hor30,sm:block")
3571 global
3572 {not in Vi}
3573 {only available when compiled with GUI enabled, and
3574 for MS-DOS and Win32 console}
3575 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003576 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003577 the height of the cursor can be changed. This can be done by
3578 specifying a block cursor, or a percentage for a vertical or
3579 horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003580 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3581 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003582
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003583 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003584 mode-list and an argument-list:
3585 mode-list:argument-list,mode-list:argument-list,..
3586 The mode-list is a dash separated list of these modes:
3587 n Normal mode
3588 v Visual mode
3589 ve Visual mode with 'selection' "exclusive" (same as 'v',
3590 if not specified)
3591 o Operator-pending mode
3592 i Insert mode
3593 r Replace mode
3594 c Command-line Normal (append) mode
3595 ci Command-line Insert mode
3596 cr Command-line Replace mode
3597 sm showmatch in Insert mode
3598 a all modes
3599 The argument-list is a dash separated list of these arguments:
3600 hor{N} horizontal bar, {N} percent of the character height
3601 ver{N} vertical bar, {N} percent of the character width
3602 block block cursor, fills the whole character
3603 [only one of the above three should be present]
3604 blinkwait{N} *cursor-blinking*
3605 blinkon{N}
3606 blinkoff{N}
3607 blink times for cursor: blinkwait is the delay before
3608 the cursor starts blinking, blinkon is the time that
3609 the cursor is shown and blinkoff is the time that the
3610 cursor is not shown. The times are in msec. When one
3611 of the numbers is zero, there is no blinking. The
3612 default is: "blinkwait700-blinkon400-blinkoff250".
3613 These numbers are used for a missing entry. This
3614 means that blinking is enabled by default. To switch
3615 blinking off you can use "blinkon0". The cursor only
3616 blinks when Vim is waiting for input, not while
3617 executing a command.
3618 To make the cursor blink in an xterm, see
3619 |xterm-blink|.
3620 {group-name}
3621 a highlight group name, that sets the color and font
3622 for the cursor
3623 {group-name}/{group-name}
3624 Two highlight group names, the first is used when
3625 no language mappings are used, the other when they
3626 are. |language-mapping|
3627
3628 Examples of parts:
3629 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3630 block cursor with colors from the "nCursor"
3631 highlight group
3632 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3633 In Insert and Command-line Insert mode, use a
3634 30% vertical bar cursor with colors from the
3635 "iCursor" highlight group. Blink a bit
3636 faster.
3637
3638 The 'a' mode is different. It will set the given argument-list for
3639 all modes. It does not reset anything to defaults. This can be used
3640 to do a common setting for all modes. For example, to switch off
3641 blinking: "a:blinkon0"
3642
3643 Examples of cursor highlighting: >
3644 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3645 :highlight Cursor gui=NONE guifg=bg guibg=fg
3646<
3647 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003648 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003649'guifont' 'gfn' string (default "")
3650 global
3651 {not in Vi}
3652 {only available when compiled with GUI enabled}
3653 This is a list of fonts which will be used for the GUI version of Vim.
3654 In its simplest form the value is just one font name. When
3655 the font cannot be found you will get an error message. To try other
3656 font names a list can be specified, font names separated with commas.
3657 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003658
Bram Moolenaar05159a02005-02-26 23:04:13 +00003659 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3660 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003661
Bram Moolenaar3df01732017-02-17 22:47:16 +01003662 Note: As to the GTK GUIs, no error is given against any invalid names,
3663 and the first element of the list is always picked up and made use of.
3664 This is because, instead of identifying a given name with a font, the
3665 GTK GUIs use it to construct a pattern and try to look up a font which
3666 best matches the pattern among available fonts, and this way, the
3667 matching never fails. An invalid name doesn't matter because a number
3668 of font properties other than name will do to get the matching done.
3669
Bram Moolenaar071d4272004-06-13 20:20:40 +00003670 Spaces after a comma are ignored. To include a comma in a font name
3671 precede it with a backslash. Setting an option requires an extra
3672 backslash before a space and a backslash. See also
3673 |option-backslash|. For example: >
3674 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003675< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003676 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003677
3678 If none of the fonts can be loaded, Vim will keep the current setting.
3679 If an empty font list is given, Vim will try using other resource
3680 settings (for X, it will use the Vim.font resource), and finally it
3681 will try some builtin default which should always be there ("7x13" in
3682 the case of X). The font names given should be "normal" fonts. Vim
3683 will try to find the related bold and italic fonts.
3684
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003685 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003686 :set guifont=*
3687< will bring up a font requester, where you can pick the font you want.
3688
3689 The font name depends on the GUI used. See |setting-guifont| for a
3690 way to set 'guifont' for various systems.
3691
Bram Moolenaar3df01732017-02-17 22:47:16 +01003692 For the GTK+ 2 and 3 GUIs, the font name looks like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003693 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003694< That's all. XLFDs are not used. For Chinese this is reported to work
3695 well: >
3696 if has("gui_gtk2")
3697 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3698 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3699 endif
3700<
Bram Moolenaar3df01732017-02-17 22:47:16 +01003701 (Replace gui_gtk2 with gui_gtk3 for the GTK+ 3 GUI)
3702
Bram Moolenaar05159a02005-02-26 23:04:13 +00003703 For Mac OSX you can use something like this: >
3704 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003705< Also see 'macatsui', it can help fix display problems.
3706 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003707 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaar3df01732017-02-17 22:47:16 +01003708 width). An exception is GTK: all fonts are accepted, but mono-spaced
3709 fonts look best.
Bram Moolenaared203462004-06-16 11:19:22 +00003710
Bram Moolenaar071d4272004-06-13 20:20:40 +00003711 To preview a font on X11, you might be able to use the "xfontsel"
3712 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003713
Bram Moolenaar071d4272004-06-13 20:20:40 +00003714 For the Win32 GUI *E244* *E245*
3715 - takes these options in the font name:
3716 hXX - height is XX (points, can be floating-point)
3717 wXX - width is XX (points, can be floating-point)
3718 b - bold
3719 i - italic
3720 u - underline
3721 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003722 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003723 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3724 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3725 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003726 Normally you would use "cDEFAULT".
Bram Moolenaar03413f42016-04-12 21:07:15 +02003727 qXX - quality XX. Valid quality names are: PROOF, DRAFT,
Bram Moolenaar06d2d382016-05-20 17:24:11 +02003728 ANTIALIASED, NONANTIALIASED, CLEARTYPE, DEFAULT.
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02003729 Normally you would use "qDEFAULT".
Bram Moolenaardc1f1642016-08-16 18:33:43 +02003730 Some quality values are not supported in legacy OSs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003731
3732 Use a ':' to separate the options.
3733 - A '_' can be used in the place of a space, so you don't need to use
3734 backslashes to escape the spaces.
3735 - Examples: >
3736 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3737 :set guifont=Andale_Mono:h7.5:w4.5
3738< See also |font-sizes|.
3739
3740 *'guifontset'* *'gfs'*
3741 *E250* *E252* *E234* *E597* *E598*
3742'guifontset' 'gfs' string (default "")
3743 global
3744 {not in Vi}
3745 {only available when compiled with GUI enabled and
3746 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003747 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003748 When not empty, specifies two (or more) fonts to be used. The first
3749 one for normal English, the second one for your special language. See
3750 |xfontset|.
3751 Setting this option also means that all font names will be handled as
3752 a fontset name. Also the ones used for the "font" argument of the
3753 |:highlight| command.
3754 The fonts must match with the current locale. If fonts for the
3755 character sets that the current locale uses are not included, setting
3756 'guifontset' will fail.
3757 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3758 the comma-separated names are alternative names, one of which will be
3759 used. In 'guifontset' the whole string is one fontset name,
3760 including the commas. It is not possible to specify alternative
3761 fontset names.
3762 This example works on many X11 systems: >
3763 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3764<
3765 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3766'guifontwide' 'gfw' string (default "")
3767 global
3768 {not in Vi}
3769 {only available when compiled with GUI enabled}
3770 When not empty, specifies a comma-separated list of fonts to be used
3771 for double-width characters. The first font that can be loaded is
3772 used.
3773 Note: The size of these fonts must be exactly twice as wide as the one
3774 specified with 'guifont' and the same height.
3775
Bram Moolenaar3df01732017-02-17 22:47:16 +01003776 All GUI versions but GTK+:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003777
3778 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3779 'guifontset' is empty or invalid.
3780 When 'guifont' is set and a valid font is found in it and
3781 'guifontwide' is empty Vim will attempt to find a matching
3782 double-width font and set 'guifontwide' to it.
3783
Bram Moolenaar3df01732017-02-17 22:47:16 +01003784 GTK+ GUI only: *guifontwide_gtk*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003785
3786 If set and valid, 'guifontwide' is always used for double width
3787 characters, even if 'encoding' is not set to "utf-8".
3788 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003789 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003790 font for characters not available in 'guifont'. Thus you do not need
3791 to set 'guifontwide' at all unless you want to override the choice
3792 made by Pango/Xft.
3793
Bram Moolenaar0f272122013-01-23 18:37:40 +01003794 Windows +multibyte only: *guifontwide_win_mbyte*
3795
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003796 If set and valid, 'guifontwide' is used for IME instead of 'guifont'.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003797
Bram Moolenaar071d4272004-06-13 20:20:40 +00003798 *'guiheadroom'* *'ghr'*
3799'guiheadroom' 'ghr' number (default 50)
3800 global
3801 {not in Vi} {only for GTK and X11 GUI}
3802 The number of pixels subtracted from the screen height when fitting
3803 the GUI window on the screen. Set this before the GUI is started,
3804 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003805 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003806 lines will be left for window decorations and other items on the
3807 screen. Set it to a negative value to allow windows taller than the
3808 screen.
3809
3810 *'guioptions'* *'go'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003811'guioptions' 'go' string (default "egmrLtT" (MS-Windows, "t" is
3812 removed in |defaults.vim|),
3813 "aegimrLtT" (GTK, Motif and Athena),
3814 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003815 global
3816 {not in Vi}
3817 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003818 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003819 sequence of letters which describes what components and options of the
3820 GUI should be used.
3821 To avoid problems with flags that are added in the future, use the
3822 "+=" and "-=" feature of ":set" |add-option-flags|.
3823
3824 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003825 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003826 'a' Autoselect: If present, then whenever VISUAL mode is started,
3827 or the Visual area extended, Vim tries to become the owner of
3828 the windowing system's global selection. This means that the
3829 Visually highlighted text is available for pasting into other
3830 applications as well as into Vim itself. When the Visual mode
3831 ends, possibly due to an operation on the text, or when an
3832 application wants to paste the selection, the highlighted text
3833 is automatically yanked into the "* selection register.
3834 Thus the selection is still available for pasting into other
3835 applications after the VISUAL mode has ended.
3836 If not present, then Vim won't become the owner of the
3837 windowing system's global selection unless explicitly told to
3838 by a yank or delete operation for the "* register.
3839 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003840 *'go-P'*
3841 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003842 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003843 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003844 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003845 applies to the modeless selection.
3846
3847 'guioptions' autoselect Visual autoselect modeless ~
3848 "" - -
3849 "a" yes yes
3850 "A" - yes
3851 "aA" yes yes
3852
Bram Moolenaar02467872007-05-06 13:22:01 +00003853 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003854 'c' Use console dialogs instead of popup dialogs for simple
3855 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003856 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003857 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003858 'guitablabel' can be used to change the text in the labels.
3859 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003860 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003861 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003862 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003863 'f' Foreground: Don't use fork() to detach the GUI from the shell
3864 where it was started. Use this for programs that wait for the
3865 editor to finish (e.g., an e-mail program). Alternatively you
3866 can use "gvim -f" or ":gui -f" to start the GUI in the
3867 foreground. |gui-fork|
3868 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003869 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003870 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003871 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3872 corner of the window. It's black&white on non-GTK, because of
3873 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003874 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003875 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003876 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003877 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003878 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003879 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003880 file is sourced the system menu has already been loaded; the
3881 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003882 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003883 'g' Grey menu items: Make menu items that are not active grey. If
3884 'g' is not included inactive menu items are not shown at all.
3885 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003886 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003887 't' Include tearoff menu items. Currently only works for Win32,
3888 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003889 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003890 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003891 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003892 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003893 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003894 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003895 'R' Right-hand scrollbar is present when there is a vertically
3896 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003897 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003898 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003899 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003900 'L' Left-hand scrollbar is present when there is a vertically
3901 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003902 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003903 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3904 the longest visible line, or on the cursor line if the 'h'
3905 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003906 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003907 'h' Limit horizontal scrollbar size to the length of the cursor
3908 line. Reduces computations. |gui-horiz-scroll|
3909
3910 And yes, you may even have scrollbars on the left AND the right if
3911 you really want to :-). See |gui-scrollbars| for more information.
3912
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003913 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003914 'v' Use a vertical button layout for dialogs. When not included,
3915 a horizontal layout is preferred, but when it doesn't fit a
3916 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003917 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003918 'p' Use Pointer callbacks for X11 GUI. This is required for some
3919 window managers. If the cursor is not blinking or hollow at
3920 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003921 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003922 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003923 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003924 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003925
Bram Moolenaar02467872007-05-06 13:22:01 +00003926
Bram Moolenaar071d4272004-06-13 20:20:40 +00003927 *'guipty'* *'noguipty'*
3928'guipty' boolean (default on)
3929 global
3930 {not in Vi}
3931 {only available when compiled with GUI enabled}
3932 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3933 I/O to/from shell commands. See |gui-pty|.
3934
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003935 *'guitablabel'* *'gtl'*
3936'guitablabel' 'gtl' string (default empty)
3937 global
3938 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003939 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003940 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003941 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003942 pages line. When empty and when the result is empty Vim will use a
3943 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003944
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003945 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003946 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003947 The expression will be evaluated in the |sandbox| when set from a
3948 modeline, see |sandbox-option|.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003949
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003950 Only used when the GUI tab pages line is displayed. 'e' must be
3951 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3952 used.
3953
Bram Moolenaar57657d82006-04-21 22:12:41 +00003954 *'guitabtooltip'* *'gtt'*
3955'guitabtooltip' 'gtt' string (default empty)
3956 global
3957 {not in Vi}
3958 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003959 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003960 When nonempty describes the text to use in a tooltip for the GUI tab
3961 pages line. When empty Vim will use a default tooltip.
3962 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003963 You can include a line break. Simplest method is to use |:let|: >
3964 :let &guitabtooltip = "line one\nline two"
3965<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003966
Bram Moolenaar071d4272004-06-13 20:20:40 +00003967 *'helpfile'* *'hf'*
3968'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3969 (others) "$VIMRUNTIME/doc/help.txt")
3970 global
3971 {not in Vi}
3972 Name of the main help file. All distributed help files should be
3973 placed together in one directory. Additionally, all "doc" directories
3974 in 'runtimepath' will be used.
3975 Environment variables are expanded |:set_env|. For example:
3976 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003977 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003978 spaces and backslashes.
3979 This option cannot be set from a |modeline| or in the |sandbox|, for
3980 security reasons.
3981
3982 *'helpheight'* *'hh'*
3983'helpheight' 'hh' number (default 20)
3984 global
3985 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003986 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003987 feature}
3988 Minimal initial height of the help window when it is opened with the
3989 ":help" command. The initial height of the help window is half of the
3990 current window, or (when the 'ea' option is on) the same as other
3991 windows. When the height is less than 'helpheight', the height is
3992 set to 'helpheight'. Set to zero to disable.
3993
3994 *'helplang'* *'hlg'*
3995'helplang' 'hlg' string (default: messages language or empty)
3996 global
3997 {only available when compiled with the |+multi_lang|
3998 feature}
3999 {not in Vi}
4000 Comma separated list of languages. Vim will use the first language
4001 for which the desired help can be found. The English help will always
4002 be used as a last resort. You can add "en" to prefer English over
4003 another language, but that will only find tags that exist in that
4004 language and not in the English help.
4005 Example: >
4006 :set helplang=de,it
4007< This will first search German, then Italian and finally English help
4008 files.
4009 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4010 try to find the tag in the current language before using this option.
4011 See |help-translated|.
4012
4013 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4014'hidden' 'hid' boolean (default off)
4015 global
4016 {not in Vi}
4017 When off a buffer is unloaded when it is |abandon|ed. When on a
4018 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4019 displayed in another window, it does not become hidden, of course.
4020 The commands that move through the buffer list sometimes make a buffer
4021 hidden although the 'hidden' option is off: When the buffer is
4022 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004023 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004024 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004025 This option is set for one command with ":hide {command}" |:hide|.
4026 WARNING: It's easy to forget that you have changes in hidden buffers.
4027 Think twice when using ":q!" or ":qa!".
4028
4029 *'highlight'* *'hl'*
4030'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004031 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4032 d:Directory,e:ErrorMsg,i:IncSearch,
4033 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
4034 N:CursorLineNr,r:Question,s:StatusLine,
4035 S:StatusLineNC,c:VertSplit,t:Title,
4036 v:Visual,w:WarningMsg,W:WildMenu,f:Folded,
4037 F:FoldColumn,A:DiffAdd,C:DiffChange,
4038 D:DiffDelete,T:DiffText,>:SignColumn,
4039 B:SpellBad,P:SpellCap,R:SpellRare,
4040 L:SpellLocal,-:Conceal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004041 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4042 #:TabLineSel,_:TabLineFill,!:CursorColumn,
4043 .:CursorLine,o:ColorColumn,q:QuickFixLine")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004044 global
4045 {not in Vi}
4046 This option can be used to set highlighting mode for various
4047 occasions. It is a comma separated list of character pairs. The
4048 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004049 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004050 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004051 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4052 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004053 characters from 'showbreak'
4054 |hl-Directory| d directories in CTRL-D listing and other special
4055 things in listings
4056 |hl-ErrorMsg| e error messages
4057 h (obsolete, ignored)
4058 |hl-IncSearch| i 'incsearch' highlighting
4059 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4060 |hl-MoreMsg| m |more-prompt|
4061 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004062 |hl-LineNr| n line number for ":number" and ":#" commands, and
4063 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004064 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4065 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004066 |hl-Question| r |hit-enter| prompt and yes/no questions
4067 |hl-StatusLine| s status line of current window |status-line|
4068 |hl-StatusLineNC| S status lines of not-current windows
4069 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4070 |hl-VertSplit| c column used to separate vertically split windows
4071 |hl-Visual| v Visual mode
4072 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4073 Selection" Only X11 Gui's |gui-x11| and
4074 |xterm-clipboard|.
4075 |hl-WarningMsg| w warning messages
4076 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4077 |hl-Folded| f line used for closed folds
4078 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004079 |hl-DiffAdd| A added line in diff mode
4080 |hl-DiffChange| C changed line in diff mode
4081 |hl-DiffDelete| D deleted line in diff mode
4082 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004083 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004084 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004085 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004086 |hl-SpellRare| R rare word |spell|
4087 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02004088 |hl-Conceal| - the placeholders used for concealed characters
4089 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00004090 |hl-Pmenu| + popup menu normal line
4091 |hl-PmenuSel| = popup menu normal line
4092 |hl-PmenuSbar| x popup menu scrollbar
4093 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004094
4095 The display modes are:
4096 r reverse (termcap entry "mr" and "me")
4097 i italic (termcap entry "ZH" and "ZR")
4098 b bold (termcap entry "md" and "me")
4099 s standout (termcap entry "so" and "se")
4100 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004101 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004102 n no highlighting
4103 - no highlighting
4104 : use a highlight group
4105 The default is used for occasions that are not included.
4106 If you want to change what the display modes do, see |dos-colors|
4107 for an example.
4108 When using the ':' display mode, this must be followed by the name of
4109 a highlight group. A highlight group can be used to define any type
4110 of highlighting, including using color. See |:highlight| on how to
4111 define one. The default uses a different group for each occasion.
4112 See |highlight-default| for the default highlight groups.
4113
Bram Moolenaar071d4272004-06-13 20:20:40 +00004114 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004115'history' 'hi' number (Vim default: 50, Vi default: 0,
4116 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004117 global
4118 {not in Vi}
4119 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004120 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004121 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004122 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004123 NOTE: This option is set to the Vi default value when 'compatible' is
4124 set and to the Vim default value when 'compatible' is reset.
4125
4126 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4127'hkmap' 'hk' boolean (default off)
4128 global
4129 {not in Vi}
4130 {only available when compiled with the |+rightleft|
4131 feature}
4132 When on, the keyboard is mapped for the Hebrew character set.
4133 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4134 toggle this option. See |rileft.txt|.
4135 NOTE: This option is reset when 'compatible' is set.
4136
4137 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4138'hkmapp' 'hkp' boolean (default off)
4139 global
4140 {not in Vi}
4141 {only available when compiled with the |+rightleft|
4142 feature}
4143 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4144 This is useful if you have a non-Hebrew keyboard.
4145 See |rileft.txt|.
4146 NOTE: This option is reset when 'compatible' is set.
4147
Bram Moolenaar036986f2017-03-16 17:41:02 +01004148 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4149'hlsearch' 'hls' boolean (default off)
4150 global
4151 {not in Vi}
4152 {not available when compiled without the
4153 |+extra_search| feature}
4154 When there is a previous search pattern, highlight all its matches.
4155 The type of highlighting used can be set with the 'l' occasion in the
4156 'highlight' option. This uses the "Search" highlight group by
4157 default. Note that only the matching text is highlighted, any offsets
4158 are not applied.
4159 See also: 'incsearch' and |:match|.
4160 When you get bored looking at the highlighted matches, you can turn it
4161 off with |:nohlsearch|. This does not change the option value, as
4162 soon as you use a search command, the highlighting comes back.
4163 'redrawtime' specifies the maximum time spent on finding matches.
4164 When the search pattern can match an end-of-line, Vim will try to
4165 highlight all of the matched text. However, this depends on where the
4166 search starts. This will be the first line in the window or the first
4167 line below a closed fold. A match in a previous line which is not
4168 drawn may not continue in a newly drawn line.
4169 You can specify whether the highlight status is restored on startup
4170 with the 'h' flag in 'viminfo' |viminfo-h|.
4171 NOTE: This option is reset when 'compatible' is set.
4172
Bram Moolenaar071d4272004-06-13 20:20:40 +00004173 *'icon'* *'noicon'*
4174'icon' boolean (default off, on when title can be restored)
4175 global
4176 {not in Vi}
4177 {not available when compiled without the |+title|
4178 feature}
4179 When on, the icon text of the window will be set to the value of
4180 'iconstring' (if it is not empty), or to the name of the file
4181 currently being edited. Only the last part of the name is used.
4182 Overridden by the 'iconstring' option.
4183 Only works if the terminal supports setting window icons (currently
4184 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4185 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4186 builtin termcap).
4187 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004188 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004189 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004190 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004191
4192 *'iconstring'*
4193'iconstring' string (default "")
4194 global
4195 {not in Vi}
4196 {not available when compiled without the |+title|
4197 feature}
4198 When this option is not empty, it will be used for the icon text of
4199 the window. This happens only when the 'icon' option is on.
4200 Only works if the terminal supports setting window icon text
4201 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4202 Does not work for MS Windows.
4203 When Vim was compiled with HAVE_X11 defined, the original icon will be
4204 restored if possible |X11|.
4205 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004206 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004207 'titlestring' for example settings.
4208 {not available when compiled without the |+statusline| feature}
4209
4210 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4211'ignorecase' 'ic' boolean (default off)
4212 global
4213 Ignore case in search patterns. Also used when searching in the tags
4214 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004215 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004216 Can be overruled by using "\c" or "\C" in the pattern, see
4217 |/ignorecase|.
4218
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004219 *'imactivatefunc'* *'imaf'*
4220'imactivatefunc' 'imaf' string (default "")
4221 global
4222 {not in Vi}
4223 {only available when compiled with |+xim| and
4224 |+GUI_GTK|}
4225 This option specifies a function that will be called to
4226 activate/inactivate Input Method.
4227
4228 Example: >
4229 function ImActivateFunc(active)
4230 if a:active
4231 ... do something
4232 else
4233 ... do something
4234 endif
4235 " return value is not used
4236 endfunction
4237 set imactivatefunc=ImActivateFunc
4238<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004239 *'imactivatekey'* *'imak'*
4240'imactivatekey' 'imak' string (default "")
4241 global
4242 {not in Vi}
4243 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004244 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004245 Specifies the key that your Input Method in X-Windows uses for
4246 activation. When this is specified correctly, vim can fully control
4247 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4248 You can't use this option to change the activation key, the option
4249 tells Vim what the key is.
4250 Format:
4251 [MODIFIER_FLAG-]KEY_STRING
4252
4253 These characters can be used for MODIFIER_FLAG (case is ignored):
4254 S Shift key
4255 L Lock key
4256 C Control key
4257 1 Mod1 key
4258 2 Mod2 key
4259 3 Mod3 key
4260 4 Mod4 key
4261 5 Mod5 key
4262 Combinations are allowed, for example "S-C-space" or "SC-space" are
4263 both shift+ctrl+space.
4264 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4265
4266 Example: >
4267 :set imactivatekey=S-space
4268< "S-space" means shift+space. This is the activation key for kinput2 +
4269 canna (Japanese), and ami (Korean).
4270
4271 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4272'imcmdline' 'imc' boolean (default off)
4273 global
4274 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004275 {only available when compiled with the |+xim|,
4276 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004277 When set the Input Method is always on when starting to edit a command
4278 line, unless entering a search pattern (see 'imsearch' for that).
4279 Setting this option is useful when your input method allows entering
4280 English characters directly, e.g., when it's used to type accented
4281 characters with dead keys.
4282
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004283 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004284'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4285 global
4286 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004287 {only available when compiled with the |+xim|,
4288 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004289 When set the Input Method is never used. This is useful to disable
4290 the IM when it doesn't work properly.
4291 Currently this option is on by default for SGI/IRIX machines. This
4292 may change in later releases.
4293
4294 *'iminsert'* *'imi'*
4295'iminsert' 'imi' number (default 0, 2 when an input method is supported)
4296 local to buffer
4297 {not in Vi}
4298 Specifies whether :lmap or an Input Method (IM) is to be used in
4299 Insert mode. Valid values:
4300 0 :lmap is off and IM is off
4301 1 :lmap is ON and IM is off
4302 2 :lmap is off and IM is ON
4303 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
4304 or |global-ime|.
4305 To always reset the option to zero when leaving Insert mode with <Esc>
4306 this can be used: >
4307 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4308< This makes :lmap and IM turn off automatically when leaving Insert
4309 mode.
4310 Note that this option changes when using CTRL-^ in Insert mode
4311 |i_CTRL-^|.
4312 The value is set to 1 when setting 'keymap' to a valid keymap name.
4313 It is also used for the argument of commands like "r" and "f".
4314 The value 0 may not work correctly with Athena and Motif with some XIM
4315 methods. Use 'imdisable' to disable XIM then.
4316
4317 *'imsearch'* *'ims'*
4318'imsearch' 'ims' number (default 0, 2 when an input method is supported)
4319 local to buffer
4320 {not in Vi}
4321 Specifies whether :lmap or an Input Method (IM) is to be used when
4322 entering a search pattern. Valid values:
4323 -1 the value of 'iminsert' is used, makes it look like
4324 'iminsert' is also used when typing a search pattern
4325 0 :lmap is off and IM is off
4326 1 :lmap is ON and IM is off
4327 2 :lmap is off and IM is ON
4328 Note that this option changes when using CTRL-^ in Command-line mode
4329 |c_CTRL-^|.
4330 The value is set to 1 when it is not -1 and setting the 'keymap'
4331 option to a valid keymap name.
4332 The value 0 may not work correctly with Athena and Motif with some XIM
4333 methods. Use 'imdisable' to disable XIM then.
4334
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004335 *'imstatusfunc'* *'imsf'*
4336'imstatusfunc' 'imsf' string (default "")
4337 global
4338 {not in Vi}
4339 {only available when compiled with |+xim| and
4340 |+GUI_GTK|}
4341 This option specifies a function that is called to obtain the status
4342 of Input Method. It must return a positive number when IME is active.
4343
4344 Example: >
4345 function ImStatusFunc()
4346 let is_active = ...do something
4347 return is_active ? 1 : 0
4348 endfunction
4349 set imstatusfunc=ImStatusFunc
4350<
4351 NOTE: This function is invoked very often. Keep it fast.
4352
Bram Moolenaar071d4272004-06-13 20:20:40 +00004353 *'include'* *'inc'*
4354'include' 'inc' string (default "^\s*#\s*include")
4355 global or local to buffer |global-local|
4356 {not in Vi}
4357 {not available when compiled without the
4358 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004359 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004360 pattern, just like for the "/" command (See |pattern|). The default
4361 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004362 "]I", "[d", etc.
4363 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004364 comes after the matched pattern. But if "\zs" appears in the pattern
4365 then the text matched from "\zs" to the end, or until "\ze" if it
4366 appears, is used as the file name. Use this to include characters
4367 that are not in 'isfname', such as a space. You can then use
4368 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004369 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004370
4371 *'includeexpr'* *'inex'*
4372'includeexpr' 'inex' string (default "")
4373 local to buffer
4374 {not in Vi}
4375 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004376 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004377 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004378 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004379 :set includeexpr=substitute(v:fname,'\\.','/','g')
4380< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004381
Bram Moolenaar071d4272004-06-13 20:20:40 +00004382 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004383 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004384 Also used for |<cfile>|.
4385
Bram Moolenaar30b65812012-07-12 22:01:11 +02004386 The expression will be evaluated in the |sandbox| when set from a
4387 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004388
4389 It is not allowed to change text or jump to another window while
4390 evaluating 'includeexpr' |textlock|.
4391
Bram Moolenaar071d4272004-06-13 20:20:40 +00004392 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004393'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4394 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004395 global
4396 {not in Vi}
4397 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004398 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004399 While typing a search command, show where the pattern, as it was typed
4400 so far, matches. The matched string is highlighted. If the pattern
4401 is invalid or not found, nothing is shown. The screen will be updated
4402 often, this is only useful on fast terminals.
4403 Note that the match will be shown, but the cursor will return to its
4404 original position when no match is found and when pressing <Esc>. You
4405 still need to finish the search command with <Enter> to move the
4406 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004407 You can use the CTRL-G and CTRL-T keys to move to the next and
4408 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004409 When compiled with the |+reltime| feature Vim only searches for about
4410 half a second. With a complicated pattern and/or a lot of text the
4411 match may not be found. This is to avoid that Vim hangs while you
4412 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004413 The highlighting can be set with the 'i' flag in 'highlight'.
4414 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004415 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004416 to the command line. If 'ignorecase' and 'smartcase' are set and the
4417 command line has no uppercase characters, the added character is
4418 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004419 CTRL-R CTRL-W can be used to add the word at the end of the current
4420 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004421 NOTE: This option is reset when 'compatible' is set.
4422
4423 *'indentexpr'* *'inde'*
4424'indentexpr' 'inde' string (default "")
4425 local to buffer
4426 {not in Vi}
4427 {not available when compiled without the |+cindent|
4428 or |+eval| features}
4429 Expression which is evaluated to obtain the proper indent for a line.
4430 It is used when a new line is created, for the |=| operator and
4431 in Insert mode as specified with the 'indentkeys' option.
4432 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004433 'smartindent' indenting. When 'lisp' is set, this option is
4434 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004435 When 'paste' is set this option is not used for indenting.
4436 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004437 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004438 when the expression is evaluated (but it may be moved around).
4439 The expression must return the number of spaces worth of indent. It
4440 can return "-1" to keep the current indent (this means 'autoindent' is
4441 used for the indent).
4442 Functions useful for computing the indent are |indent()|, |cindent()|
4443 and |lispindent()|.
4444 The evaluation of the expression must not have side effects! It must
4445 not change the text, jump to another window, etc. Afterwards the
4446 cursor position is always restored, thus the cursor may be moved.
4447 Normally this option would be set to call a function: >
4448 :set indentexpr=GetMyIndent()
4449< Error messages will be suppressed, unless the 'debug' option contains
4450 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004451 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004452 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004453
Bram Moolenaar30b65812012-07-12 22:01:11 +02004454 The expression will be evaluated in the |sandbox| when set from a
4455 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004456
4457 It is not allowed to change text or jump to another window while
4458 evaluating 'indentexpr' |textlock|.
4459
4460
Bram Moolenaar071d4272004-06-13 20:20:40 +00004461 *'indentkeys'* *'indk'*
4462'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4463 local to buffer
4464 {not in Vi}
4465 {not available when compiled without the |+cindent|
4466 feature}
4467 A list of keys that, when typed in Insert mode, cause reindenting of
4468 the current line. Only happens if 'indentexpr' isn't empty.
4469 The format is identical to 'cinkeys', see |indentkeys-format|.
4470 See |C-indenting| and |indent-expression|.
4471
4472 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4473'infercase' 'inf' boolean (default off)
4474 local to buffer
4475 {not in Vi}
4476 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004477 'ignorecase' is also on, the case of the match is adjusted depending
4478 on the typed text. If the typed text contains a lowercase letter
4479 where the match has an upper case letter, the completed part is made
4480 lowercase. If the typed text has no lowercase letters and the match
4481 has a lowercase letter where the typed text has an uppercase letter,
4482 and there is a letter before it, the completed part is made uppercase.
4483 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004484
4485 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4486'insertmode' 'im' boolean (default off)
4487 global
4488 {not in Vi}
4489 Makes Vim work in a way that Insert mode is the default mode. Useful
4490 if you want to use Vim as a modeless editor. Used for |evim|.
4491 These Insert mode commands will be useful:
4492 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004493 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004494 this is a mapping, it is executed as if 'insertmode' was off.
4495 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004496 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004497 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4498 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004499
4500 These items change when 'insertmode' is set:
4501 - when starting to edit of a file, Vim goes to Insert mode.
4502 - <Esc> in Insert mode is a no-op and beeps.
4503 - <Esc> in Normal mode makes Vim go to Insert mode.
4504 - CTRL-L in Insert mode is a command, it is not inserted.
4505 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4506 However, when <Esc> is used inside a mapping, it behaves like
4507 'insertmode' was not set. This was done to be able to use the same
4508 mappings with 'insertmode' set or not set.
4509 When executing commands with |:normal| 'insertmode' is not used.
4510
4511 NOTE: This option is reset when 'compatible' is set.
4512
4513 *'isfname'* *'isf'*
4514'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4515 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4516 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4517 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4518 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4519 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4520 global
4521 {not in Vi}
4522 The characters specified by this option are included in file names and
4523 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004524 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004525 Multi-byte characters 256 and above are always included, only the
4526 characters up to 255 are specified with this option.
4527 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004528 Think twice before adding white space to this option. Although a
4529 space may appear inside a file name, the effect will be that Vim
4530 doesn't know where a file name starts or ends when doing completion.
4531 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004532
4533 Note that on systems using a backslash as path separator, Vim tries to
4534 do its best to make it work as you would expect. That is a bit
4535 tricky, since Vi originally used the backslash to escape special
4536 characters. Vim will not remove a backslash in front of a normal file
4537 name character on these systems, but it will on Unix and alikes. The
4538 '&' and '^' are not included by default, because these are special for
4539 cmd.exe.
4540
4541 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004542 Each part can be a single character number or a range. A range is two
4543 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004544 decimal number between 0 and 255 or the ASCII character itself (does
4545 not work for digits). Example:
4546 "_,-,128-140,#-43" (include '_' and '-' and the range
4547 128 to 140 and '#' to 43)
4548 If a part starts with '^', the following character number or range
4549 will be excluded from the option. The option is interpreted from left
4550 to right. Put the excluded character after the range where it is
4551 included. To include '^' itself use it as the last character of the
4552 option or the end of a range. Example:
4553 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4554 If the character is '@', all characters where isalpha() returns TRUE
4555 are included. Normally these are the characters a to z and A to Z,
4556 plus accented characters. To include '@' itself use "@-@". Examples:
4557 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004558 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004559 "a-z,A-Z,@-@" All letters plus the '@' character.
4560 A comma can be included by using it where a character number is
4561 expected. Example:
4562 "48-57,,,_" Digits, comma and underscore.
4563 A comma can be excluded by prepending a '^'. Example:
4564 " -~,^,,9" All characters from space to '~', excluding
4565 comma, plus <Tab>.
4566 See |option-backslash| about including spaces and backslashes.
4567
4568 *'isident'* *'isi'*
4569'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4570 "@,48-57,_,128-167,224-235"
4571 otherwise: "@,48-57,_,192-255")
4572 global
4573 {not in Vi}
4574 The characters given by this option are included in identifiers.
4575 Identifiers are used in recognizing environment variables and after a
4576 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004577 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004578 option.
4579 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004580 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004581 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4582
4583 *'iskeyword'* *'isk'*
4584'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4585 "@,48-57,_,128-167,224-235"
4586 otherwise: "@,48-57,_,192-255"
4587 Vi default: "@,48-57,_")
4588 local to buffer
4589 {not in Vi}
4590 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004591 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004592 'isfname' for a description of the format of this option. For C
4593 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4594 For a help file it is set to all non-blank printable characters except
4595 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4596 command).
4597 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004598 This option also influences syntax highlighting, unless the syntax
4599 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004600 NOTE: This option is set to the Vi default value when 'compatible' is
4601 set and to the Vim default value when 'compatible' is reset.
4602
4603 *'isprint'* *'isp'*
4604'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4605 "@,~-255"; otherwise: "@,161-255")
4606 global
4607 {not in Vi}
4608 The characters given by this option are displayed directly on the
4609 screen. It is also used for "\p" in a |pattern|. The characters from
4610 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4611 even when they are not included in 'isprint' or excluded. See
4612 'isfname' for a description of the format of this option.
4613
4614 Non-printable characters are displayed with two characters:
4615 0 - 31 "^@" - "^_"
4616 32 - 126 always single characters
4617 127 "^?"
4618 128 - 159 "~@" - "~_"
4619 160 - 254 "| " - "|~"
4620 255 "~?"
4621 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4622 displayed as <xx>, with the hexadecimal value of the byte.
4623 When 'display' contains "uhex" all unprintable characters are
4624 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004625 The SpecialKey highlighting will be used for unprintable characters.
4626 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004627
4628 Multi-byte characters 256 and above are always included, only the
4629 characters up to 255 are specified with this option. When a character
4630 is printable but it is not available in the current font, a
4631 replacement character will be shown.
4632 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4633 There is no option to specify these characters.
4634
4635 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4636'joinspaces' 'js' boolean (default on)
4637 global
4638 {not in Vi}
4639 Insert two spaces after a '.', '?' and '!' with a join command.
4640 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4641 Otherwise only one space is inserted.
4642 NOTE: This option is set when 'compatible' is set.
4643
4644 *'key'*
4645'key' string (default "")
4646 local to buffer
4647 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004648 {only available when compiled with the |+cryptv|
4649 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004650 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004651 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004652 Careful: Do not set the key value by hand, someone might see the typed
4653 key. Use the |:X| command. But you can make 'key' empty: >
4654 :set key=
4655< It is not possible to get the value of this option with ":set key" or
4656 "echo &key". This is to avoid showing it to someone who shouldn't
4657 know. It also means you cannot see it yourself once you have set it,
4658 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004659 You can use "&key" in an expression to detect whether encryption is
4660 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004661
4662 *'keymap'* *'kmp'* *E544*
4663'keymap' 'kmp' string (default "")
4664 local to buffer
4665 {not in Vi}
4666 {only available when compiled with the |+keymap|
4667 feature}
4668 Name of a keyboard mapping. See |mbyte-keymap|.
4669 Setting this option to a valid keymap name has the side effect of
4670 setting 'iminsert' to one, so that the keymap becomes effective.
4671 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004672 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004673
4674 *'keymodel'* *'km'*
4675'keymodel' 'km' string (default "")
4676 global
4677 {not in Vi}
4678 List of comma separated words, which enable special things that keys
4679 can do. These values can be used:
4680 startsel Using a shifted special key starts selection (either
4681 Select mode or Visual mode, depending on "key" being
4682 present in 'selectmode').
4683 stopsel Using a not-shifted special key stops selection.
4684 Special keys in this context are the cursor keys, <End>, <Home>,
4685 <PageUp> and <PageDown>.
4686 The 'keymodel' option is set by the |:behave| command.
4687
4688 *'keywordprg'* *'kp'*
4689'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004690 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004691 global or local to buffer |global-local|
4692 {not in Vi}
4693 Program to use for the |K| command. Environment variables are
4694 expanded |:set_env|. ":help" may be used to access the Vim internal
4695 help. (Note that previously setting the global option to the empty
4696 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004697 When the first character is ":", the command is invoked as a Vim
4698 Ex command prefixed with [count].
4699 When "man", "man -s" or an Ex command is used, Vim will automatically
4700 translate a count for the "K" command and pass it as the first
4701 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004702 See |option-backslash| about including spaces and backslashes.
4703 Example: >
4704 :set keywordprg=man\ -s
4705< This option cannot be set from a |modeline| or in the |sandbox|, for
4706 security reasons.
4707
4708 *'langmap'* *'lmap'* *E357* *E358*
4709'langmap' 'lmap' string (default "")
4710 global
4711 {not in Vi}
4712 {only available when compiled with the |+langmap|
4713 feature}
4714 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004715 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004716 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004717 care of translating these special characters to the original meaning
4718 of the key. This means you don't have to change the keyboard mode to
4719 be able to execute Normal mode commands.
4720 This is the opposite of the 'keymap' option, where characters are
4721 mapped in Insert mode.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004722 Also consider resetting 'langremap' to avoid 'langmap' applies to
Bram Moolenaarc2299672014-11-13 14:25:38 +01004723 characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004724 This option cannot be set from a |modeline| or in the |sandbox|, for
4725 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004726
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004727 Example (for Greek, in UTF-8): *greek* >
4728 :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 +00004729< Example (exchanges meaning of z and y for commands): >
4730 :set langmap=zy,yz,ZY,YZ
4731<
4732 The 'langmap' option is a list of parts, separated with commas. Each
4733 part can be in one of two forms:
4734 1. A list of pairs. Each pair is a "from" character immediately
4735 followed by the "to" character. Examples: "aA", "aAbBcC".
4736 2. A list of "from" characters, a semi-colon and a list of "to"
4737 characters. Example: "abc;ABC"
4738 Example: "aA,fgh;FGH,cCdDeE"
4739 Special characters need to be preceded with a backslash. These are
4740 ";", ',' and backslash itself.
4741
4742 This will allow you to activate vim actions without having to switch
4743 back and forth between the languages. Your language characters will
4744 be understood as normal vim English characters (according to the
4745 langmap mappings) in the following cases:
4746 o Normal/Visual mode (commands, buffer/register names, user mappings)
4747 o Insert/Replace Mode: Register names after CTRL-R
4748 o Insert/Replace Mode: Mappings
4749 Characters entered in Command-line mode will NOT be affected by
4750 this option. Note that this option can be changed at any time
4751 allowing to switch between mappings for different languages/encodings.
4752 Use a mapping to avoid having to type it each time!
4753
4754 *'langmenu'* *'lm'*
4755'langmenu' 'lm' string (default "")
4756 global
4757 {not in Vi}
4758 {only available when compiled with the |+menu| and
4759 |+multi_lang| features}
4760 Language to use for menu translation. Tells which file is loaded
4761 from the "lang" directory in 'runtimepath': >
4762 "lang/menu_" . &langmenu . ".vim"
4763< (without the spaces). For example, to always use the Dutch menus, no
4764 matter what $LANG is set to: >
4765 :set langmenu=nl_NL.ISO_8859-1
4766< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004767 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004768 If your $LANG is set to a non-English language but you do want to use
4769 the English menus: >
4770 :set langmenu=none
4771< This option must be set before loading menus, switching on filetype
4772 detection or syntax highlighting. Once the menus are defined setting
4773 this option has no effect. But you could do this: >
4774 :source $VIMRUNTIME/delmenu.vim
4775 :set langmenu=de_DE.ISO_8859-1
4776 :source $VIMRUNTIME/menu.vim
4777< Warning: This deletes all menus that you defined yourself!
4778
Bram Moolenaard94464e2015-11-02 15:28:18 +01004779 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004780'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004781 global
4782 {not in Vi}
4783 {only available when compiled with the |+langmap|
4784 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004785 This is just like 'langremap' but with the value inverted. It only
4786 exists for backwards compatibility. When setting 'langremap' then
4787 'langnoremap' is set to the inverted value, and the other way around.
4788
4789 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
4790'langremap' 'lrm' boolean (default on, reset in |defaults.vim|)
4791 global
4792 {not in Vi}
4793 {only available when compiled with the |+langmap|
4794 feature}
4795 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004796 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004797 'langmap' disables some of your mappings, try resetting this option.
4798 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004799 that works for you to avoid mappings to break.
4800
Bram Moolenaar071d4272004-06-13 20:20:40 +00004801 *'laststatus'* *'ls'*
4802'laststatus' 'ls' number (default 1)
4803 global
4804 {not in Vi}
4805 The value of this option influences when the last window will have a
4806 status line:
4807 0: never
4808 1: only if there are at least two windows
4809 2: always
4810 The screen looks nicer with a status line if you have several
4811 windows, but it takes another screen line. |status-line|
4812
4813 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4814'lazyredraw' 'lz' boolean (default off)
4815 global
4816 {not in Vi}
4817 When this option is set, the screen will not be redrawn while
4818 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004819 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004820 update use |:redraw|.
4821
4822 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4823'linebreak' 'lbr' boolean (default off)
4824 local to window
4825 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004826 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004827 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004828 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004829 than at the last character that fits on the screen. Unlike
4830 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004831 it only affects the way the file is displayed, not its contents.
4832 If 'breakindent' is set, line is visually indented. Then, the value
4833 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004834 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004835 Note that <Tab> characters after an <EOL> are mostly not displayed
4836 with the right amount of white space.
4837
4838 *'lines'* *E593*
4839'lines' number (default 24 or terminal height)
4840 global
4841 Number of lines of the Vim window.
4842 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004843 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004844 When Vim is running in the GUI or in a resizable window, setting this
4845 option will cause the window size to be changed. When you only want
4846 to use the size for the GUI, put the command in your |gvimrc| file.
4847 Vim limits the number of lines to what fits on the screen. You can
4848 use this command to get the tallest window possible: >
4849 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004850< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004851 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004852 When you set this option and Vim is unable to change the physical
4853 number of lines of the display, the display may be messed up.
4854
4855 *'linespace'* *'lsp'*
4856'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4857 global
4858 {not in Vi}
4859 {only in the GUI}
4860 Number of pixel lines inserted between characters. Useful if the font
4861 uses the full character cell height, making lines touch each other.
4862 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004863 With some fonts there can be too much room between lines (to have
4864 space for ascents and descents). Then it makes sense to set
4865 'linespace' to a negative value. This may cause display problems
4866 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004867
4868 *'lisp'* *'nolisp'*
4869'lisp' boolean (default off)
4870 local to buffer
4871 {not available when compiled without the |+lispindent|
4872 feature}
4873 Lisp mode: When <Enter> is typed in insert mode set the indent for
4874 the next line to Lisp standards (well, sort of). Also happens with
4875 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4876 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4877 better. Also see 'lispwords'.
4878 The '-' character is included in keyword characters. Redefines the
4879 "=" operator to use this same indentation algorithm rather than
4880 calling an external program if 'equalprg' is empty.
4881 This option is not used when 'paste' is set.
4882 {Vi: Does it a little bit differently}
4883
4884 *'lispwords'* *'lw'*
4885'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004886 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004887 {not in Vi}
4888 {not available when compiled without the |+lispindent|
4889 feature}
4890 Comma separated list of words that influence the Lisp indenting.
4891 |'lisp'|
4892
4893 *'list'* *'nolist'*
4894'list' boolean (default off)
4895 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004896 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4897 line. Useful to see the difference between tabs and spaces and for
4898 trailing blanks. Further changed by the 'listchars' option.
4899
4900 The cursor is displayed at the start of the space a Tab character
4901 occupies, not at the end as usual in Normal mode. To get this cursor
4902 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004903 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004904<
4905 Note that list mode will also affect formatting (set with 'textwidth'
4906 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004907 changing the way tabs are displayed.
4908
4909 *'listchars'* *'lcs'*
4910'listchars' 'lcs' string (default "eol:$")
4911 global
4912 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004913 Strings to use in 'list' mode and for the |:list| command. It is a
4914 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004915 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004916 eol:c Character to show at the end of each line. When
4917 omitted, there is no extra character at the end of the
4918 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004919 *lcs-tab*
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004920 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004921 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004922 fill the space that the tab normally occupies.
4923 "tab:>-" will show a tab that takes four spaces as
4924 ">---". When omitted, a tab is show as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004925 *lcs-space*
4926 space:c Character to show for a space. When omitted, spaces
4927 are left blank.
4928 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004929 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02004930 trailing spaces are blank. Overrides the "space"
4931 setting for trailing spaces.
4932 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004933 extends:c Character to show in the last column, when 'wrap' is
4934 off and the line continues beyond the right of the
4935 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004936 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004937 precedes:c Character to show in the first column, when 'wrap'
4938 is off and there is text preceding the character
4939 visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004940 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004941 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004942 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004943 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004944 nbsp:c Character to show for a non-breakable space character
4945 (0xA0 (160 decimal) and U+202F). Left blank when
4946 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004947
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004948 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004949 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004950 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004951
4952 Examples: >
4953 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004954 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004955 :set lcs=extends:>,precedes:<
4956< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02004957 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004958 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004959
4960 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4961'loadplugins' 'lpl' boolean (default on)
4962 global
4963 {not in Vi}
4964 When on the plugin scripts are loaded when starting up |load-plugins|.
4965 This option can be reset in your |vimrc| file to disable the loading
4966 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02004967 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
4968 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004969
Bram Moolenaard94464e2015-11-02 15:28:18 +01004970 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004971'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01004972 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004973 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01004974 {only available when compiled with the |+lua/dyn|
4975 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004976 Specifies the name of the Lua shared library. The default is
4977 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02004978 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01004979 This option cannot be set from a |modeline| or in the |sandbox|, for
4980 security reasons.
4981
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004982 *'macatsui'* *'nomacatsui'*
4983'macatsui' boolean (default on)
4984 global
4985 {only available in Mac GUI version}
4986 This is a workaround for when drawing doesn't work properly. When set
4987 and compiled with multi-byte support ATSUI text drawing is used. When
4988 not set ATSUI text drawing is not used. Switch this option off when
4989 you experience drawing problems. In a future version the problems may
4990 be solved and this option becomes obsolete. Therefore use this method
4991 to unset it: >
4992 if exists('&macatsui')
4993 set nomacatsui
4994 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004995< Another option to check if you have drawing problems is
4996 'termencoding'.
4997
Bram Moolenaar071d4272004-06-13 20:20:40 +00004998 *'magic'* *'nomagic'*
4999'magic' boolean (default on)
5000 global
5001 Changes the special characters that can be used in search patterns.
5002 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005003 WARNING: Switching this option off most likely breaks plugins! That
5004 is because many patterns assume it's on and will fail when it's off.
5005 Only switch it off when working with old Vi scripts. In any other
5006 situation write patterns that work when 'magic' is on. Include "\M"
5007 when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005008
5009 *'makeef'* *'mef'*
5010'makeef' 'mef' string (default: "")
5011 global
5012 {not in Vi}
5013 {not available when compiled without the |+quickfix|
5014 feature}
5015 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5016 and the |:grep| command.
5017 When it is empty, an internally generated temp file will be used.
5018 When "##" is included, it is replaced by a number to make the name
5019 unique. This makes sure that the ":make" command doesn't overwrite an
5020 existing file.
5021 NOT used for the ":cf" command. See 'errorfile' for that.
5022 Environment variables are expanded |:set_env|.
5023 See |option-backslash| about including spaces and backslashes.
5024 This option cannot be set from a |modeline| or in the |sandbox|, for
5025 security reasons.
5026
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005027 *'makeencoding'* *'menc'*
5028'makeencoding' 'menc' string (default "")
5029 global or local to buffer |global-local|
5030 {only available when compiled with the |+multi_byte|
5031 feature}
5032 {not in Vi}
5033 Encoding used for reading the output of external commands. When empty,
5034 encoding is not converted.
5035 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5036 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5037 and `:laddfile`.
5038
5039 This would be mostly useful when you use MS-Windows and set 'encoding'
5040 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5041 'makeencoding' to "char" has the same effect as setting to the system
5042 locale encoding. Example: >
5043 :set encoding=utf-8
5044 :set makeencoding=char " system locale is used
5045<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005046 *'makeprg'* *'mp'*
5047'makeprg' 'mp' string (default "make", VMS: "MMS")
5048 global or local to buffer |global-local|
5049 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00005050 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar26df0922014-02-23 23:39:13 +01005051 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5052 which are expanded to the current and alternate file name. Use |::S|
5053 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005054 Environment variables are expanded |:set_env|. See |option-backslash|
5055 about including spaces and backslashes.
5056 Note that a '|' must be escaped twice: once for ":set" and once for
5057 the interpretation of a command. When you use a filter called
5058 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005059 :set makeprg=gmake\ \\\|\ myfilter
5060< The placeholder "$*" can be given (even multiple times) to specify
5061 where the arguments will be included, for example: >
5062 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5063< This option cannot be set from a |modeline| or in the |sandbox|, for
5064 security reasons.
5065
5066 *'matchpairs'* *'mps'*
5067'matchpairs' 'mps' string (default "(:),{:},[:]")
5068 local to buffer
5069 {not in Vi}
5070 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005071 other.
5072 Only character pairs are allowed that are different, thus you cannot
5073 jump between two double quotes.
5074 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005075 The pairs must be separated by a comma. Example for including '<' and
5076 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005077 :set mps+=<:>
5078
5079< A more exotic example, to jump between the '=' and ';' in an
5080 assignment, useful for languages like C and Java: >
5081 :au FileType c,cpp,java set mps+==:;
5082
5083< For a more advanced way of using "%", see the matchit.vim plugin in
5084 the $VIMRUNTIME/macros directory. |add-local-help|
5085
5086 *'matchtime'* *'mat'*
5087'matchtime' 'mat' number (default 5)
5088 global
5089 {not in Vi}{in Nvi}
5090 Tenths of a second to show the matching paren, when 'showmatch' is
5091 set. Note that this is not in milliseconds, like other options that
5092 set a time. This is to be compatible with Nvi.
5093
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005094 *'maxcombine'* *'mco'*
5095'maxcombine' 'mco' number (default 2)
5096 global
5097 {not in Vi}
5098 {only available when compiled with the |+multi_byte|
5099 feature}
5100 The maximum number of combining characters supported for displaying.
5101 Only used when 'encoding' is "utf-8".
5102 The default is OK for most languages. Hebrew may require 4.
5103 Maximum value is 6.
5104 Even when this option is set to 2 you can still edit text with more
5105 combining characters, you just can't see them. Use |g8| or |ga|.
5106 See |mbyte-combining|.
5107
Bram Moolenaar071d4272004-06-13 20:20:40 +00005108 *'maxfuncdepth'* *'mfd'*
5109'maxfuncdepth' 'mfd' number (default 100)
5110 global
5111 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005112 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005113 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005114 Maximum depth of function calls for user functions. This normally
5115 catches endless recursion. When using a recursive function with
5116 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5117 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005118 Increasing this limit above 200 also changes the maximum for Ex
5119 command resursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005120 See also |:function|.
5121
5122 *'maxmapdepth'* *'mmd'* *E223*
5123'maxmapdepth' 'mmd' number (default 1000)
5124 global
5125 {not in Vi}
5126 Maximum number of times a mapping is done without resulting in a
5127 character to be used. This normally catches endless mappings, like
5128 ":map x y" with ":map y x". It still does not catch ":map g wg",
5129 because the 'w' is used before the next mapping is done. See also
5130 |key-mapping|.
5131
5132 *'maxmem'* *'mm'*
5133'maxmem' 'mm' number (default between 256 to 5120 (system
5134 dependent) or half the amount of memory
5135 available)
5136 global
5137 {not in Vi}
5138 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5139 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005140 other memory to be freed. The maximum usable value is about 2000000.
5141 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005142
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005143 *'maxmempattern'* *'mmp'*
5144'maxmempattern' 'mmp' number (default 1000)
5145 global
5146 {not in Vi}
5147 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005148 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005149 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005150 When Vim runs into the limit it gives an error message and mostly
5151 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005152 Running into the limit often means that the pattern is very
5153 inefficient or too complex. This may already happen with the pattern
5154 "\(.\)*" on a very long line. ".*" works much better.
5155 Vim may run out of memory before hitting the 'maxmempattern' limit.
5156
Bram Moolenaar071d4272004-06-13 20:20:40 +00005157 *'maxmemtot'* *'mmt'*
5158'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5159 dependent) or half the amount of memory
5160 available)
5161 global
5162 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005163 Maximum amount of memory in Kbyte to use for all buffers together.
5164 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005165 without a limit.
5166 On 64 bit machines higher values might work. But hey, do you really
5167 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005168 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005169 need the memory to store undo info.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005170 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005171
5172 *'menuitems'* *'mis'*
5173'menuitems' 'mis' number (default 25)
5174 global
5175 {not in Vi}
5176 {not available when compiled without the |+menu|
5177 feature}
5178 Maximum number of items to use in a menu. Used for menus that are
5179 generated from a list of items, e.g., the Buffers menu. Changing this
5180 option has no direct effect, the menu must be refreshed first.
5181
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005182 *'mkspellmem'* *'msm'*
5183'mkspellmem' 'msm' string (default "460000,2000,500")
5184 global
5185 {not in Vi}
5186 {not available when compiled without the |+syntax|
5187 feature}
5188 Parameters for |:mkspell|. This tunes when to start compressing the
5189 word tree. Compression can be slow when there are many words, but
5190 it's needed to avoid running out of memory. The amount of memory used
5191 per word depends very much on how similar the words are, that's why
5192 this tuning is complicated.
5193
5194 There are three numbers, separated by commas:
5195 {start},{inc},{added}
5196
5197 For most languages the uncompressed word tree fits in memory. {start}
5198 gives the amount of memory in Kbyte that can be used before any
5199 compression is done. It should be a bit smaller than the amount of
5200 memory that is available to Vim.
5201
5202 When going over the {start} limit the {inc} number specifies the
5203 amount of memory in Kbyte that can be allocated before another
5204 compression is done. A low number means compression is done after
5205 less words are added, which is slow. A high number means more memory
5206 will be allocated.
5207
5208 After doing compression, {added} times 1024 words can be added before
5209 the {inc} limit is ignored and compression is done when any extra
5210 amount of memory is needed. A low number means there is a smaller
5211 chance of hitting the {inc} limit, less memory is used but it's
5212 slower.
5213
5214 The languages for which these numbers are important are Italian and
5215 Hungarian. The default works for when you have about 512 Mbyte. If
5216 you have 1 Gbyte you could use: >
5217 :set mkspellmem=900000,3000,800
5218< If you have less than 512 Mbyte |:mkspell| may fail for some
5219 languages, no matter what you set 'mkspellmem' to.
5220
Bram Moolenaar071d4272004-06-13 20:20:40 +00005221 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005222'modeline' 'ml' boolean (Vim default: on (off for root),
5223 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005224 local to buffer
5225 *'modelines'* *'mls'*
5226'modelines' 'mls' number (default 5)
5227 global
5228 {not in Vi}
5229 If 'modeline' is on 'modelines' gives the number of lines that is
5230 checked for set commands. If 'modeline' is off or 'modelines' is zero
5231 no lines are checked. See |modeline|.
5232 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5233 set and to the Vim default value when 'compatible' is reset.
5234
5235 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
5236'modifiable' 'ma' boolean (default on)
5237 local to buffer
5238 {not in Vi} *E21*
5239 When off the buffer contents cannot be changed. The 'fileformat' and
5240 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005241 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005242
5243 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5244'modified' 'mod' boolean (default off)
5245 local to buffer
5246 {not in Vi}
5247 When on, the buffer is considered to be modified. This option is set
5248 when:
5249 1. A change was made to the text since it was last written. Using the
5250 |undo| command to go back to the original text will reset the
5251 option. But undoing changes that were made before writing the
5252 buffer will set the option again, since the text is different from
5253 when it was written.
5254 2. 'fileformat' or 'fileencoding' is different from its original
5255 value. The original value is set when the buffer is read or
5256 written. A ":set nomodified" command also resets the original
5257 values to the current values and the 'modified' option will be
5258 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005259 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005260 This option is not set when a change is made to the buffer as the
5261 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5262 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5263 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005264 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5265 will be ignored.
5266
5267 *'more'* *'nomore'*
5268'more' boolean (Vim default: on, Vi default: off)
5269 global
5270 {not in Vi}
5271 When on, listings pause when the whole screen is filled. You will get
5272 the |more-prompt|. When this option is off there are no pauses, the
5273 listing continues until finished.
5274 NOTE: This option is set to the Vi default value when 'compatible' is
5275 set and to the Vim default value when 'compatible' is reset.
5276
5277 *'mouse'* *E538*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005278'mouse' string (default "", "a" for GUI, MS-DOS and Win32,
5279 set to "a" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005280 global
5281 {not in Vi}
5282 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00005283 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
5284 sysmouse and Linux console with gpm). For using the mouse in the
5285 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005286 The mouse can be enabled for different modes:
5287 n Normal mode
5288 v Visual mode
5289 i Insert mode
5290 c Command-line mode
5291 h all previous modes when editing a help file
5292 a all previous modes
5293 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00005294 Normally you would enable the mouse in all four modes with: >
5295 :set mouse=a
5296< When the mouse is not enabled, the GUI will still use the mouse for
5297 modeless selection. This doesn't move the text cursor.
5298
5299 See |mouse-using|. Also see |'clipboard'|.
5300
5301 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005302 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005303 the mouse buttons can still be used by keeping the shift key pressed.
5304 Also see the 'clipboard' option.
5305
5306 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5307'mousefocus' 'mousef' boolean (default off)
5308 global
5309 {not in Vi}
5310 {only works in the GUI}
5311 The window that the mouse pointer is on is automatically activated.
5312 When changing the window layout or window focus in another way, the
5313 mouse pointer is moved to the window with keyboard focus. Off is the
5314 default because it makes using the pull down menus a little goofy, as
5315 a pointer transit may activate a window unintentionally.
5316
5317 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5318'mousehide' 'mh' boolean (default on)
5319 global
5320 {not in Vi}
5321 {only works in the GUI}
5322 When on, the mouse pointer is hidden when characters are typed.
5323 The mouse pointer is restored when the mouse is moved.
5324
5325 *'mousemodel'* *'mousem'*
5326'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5327 global
5328 {not in Vi}
5329 Sets the model to use for the mouse. The name mostly specifies what
5330 the right mouse button is used for:
5331 extend Right mouse button extends a selection. This works
5332 like in an xterm.
5333 popup Right mouse button pops up a menu. The shifted left
5334 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005335 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005336 popup_setpos Like "popup", but the cursor will be moved to the
5337 position where the mouse was clicked, and thus the
5338 selected operation will act upon the clicked object.
5339 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005340 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005341 course, that right clicking outside a selection will
5342 end Visual mode.
5343 Overview of what button does what for each model:
5344 mouse extend popup(_setpos) ~
5345 left click place cursor place cursor
5346 left drag start selection start selection
5347 shift-left search word extend selection
5348 right click extend selection popup menu (place cursor)
5349 right drag extend selection -
5350 middle click paste paste
5351
5352 In the "popup" model the right mouse button produces a pop-up menu.
5353 You need to define this first, see |popup-menu|.
5354
5355 Note that you can further refine the meaning of buttons with mappings.
5356 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5357 selection (because that's handled in the GUI code directly).
5358
5359 The 'mousemodel' option is set by the |:behave| command.
5360
5361 *'mouseshape'* *'mouses'* *E547*
5362'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005363 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005364 global
5365 {not in Vi}
5366 {only available when compiled with the |+mouseshape|
5367 feature}
5368 This option tells Vim what the mouse pointer should look like in
5369 different modes. The option is a comma separated list of parts, much
5370 like used for 'guicursor'. Each part consist of a mode/location-list
5371 and an argument-list:
5372 mode-list:shape,mode-list:shape,..
5373 The mode-list is a dash separated list of these modes/locations:
5374 In a normal window: ~
5375 n Normal mode
5376 v Visual mode
5377 ve Visual mode with 'selection' "exclusive" (same as 'v',
5378 if not specified)
5379 o Operator-pending mode
5380 i Insert mode
5381 r Replace mode
5382
5383 Others: ~
5384 c appending to the command-line
5385 ci inserting in the command-line
5386 cr replacing in the command-line
5387 m at the 'Hit ENTER' or 'More' prompts
5388 ml idem, but cursor in the last line
5389 e any mode, pointer below last window
5390 s any mode, pointer on a status line
5391 sd any mode, while dragging a status line
5392 vs any mode, pointer on a vertical separator line
5393 vd any mode, while dragging a vertical separator line
5394 a everywhere
5395
5396 The shape is one of the following:
5397 avail name looks like ~
5398 w x arrow Normal mouse pointer
5399 w x blank no pointer at all (use with care!)
5400 w x beam I-beam
5401 w x updown up-down sizing arrows
5402 w x leftright left-right sizing arrows
5403 w x busy The system's usual busy pointer
5404 w x no The system's usual 'no input' pointer
5405 x udsizing indicates up-down resizing
5406 x lrsizing indicates left-right resizing
5407 x crosshair like a big thin +
5408 x hand1 black hand
5409 x hand2 white hand
5410 x pencil what you write with
5411 x question big ?
5412 x rightup-arrow arrow pointing right-up
5413 w x up-arrow arrow pointing up
5414 x <number> any X11 pointer number (see X11/cursorfont.h)
5415
5416 The "avail" column contains a 'w' if the shape is available for Win32,
5417 x for X11.
5418 Any modes not specified or shapes not available use the normal mouse
5419 pointer.
5420
5421 Example: >
5422 :set mouseshape=s:udsizing,m:no
5423< will make the mouse turn to a sizing arrow over the status lines and
5424 indicate no input when the hit-enter prompt is displayed (since
5425 clicking the mouse has no effect in this state.)
5426
5427 *'mousetime'* *'mouset'*
5428'mousetime' 'mouset' number (default 500)
5429 global
5430 {not in Vi}
5431 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5432 time in msec between two mouse clicks for the second click to be
5433 recognized as a multi click.
5434
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005435 *'mzquantum'* *'mzq'*
5436'mzquantum' 'mzq' number (default 100)
5437 global
5438 {not in Vi}
5439 {not available when compiled without the |+mzscheme|
5440 feature}
5441 The number of milliseconds between polls for MzScheme threads.
5442 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005443 NOTE: This option is set to the Vim default value when 'compatible'
5444 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005445
Bram Moolenaar071d4272004-06-13 20:20:40 +00005446 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005447'nrformats' 'nf' string (default "bin,octal,hex",
5448 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005449 local to buffer
5450 {not in Vi}
5451 This defines what bases Vim will consider for numbers when using the
5452 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5453 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005454 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005455 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005456 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005457 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005458 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005459 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005460 considered to be hexadecimal. Example: Using CTRL-X on
5461 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005462 bin If included, numbers starting with "0b" or "0B" will be
5463 considered to be binary. Example: Using CTRL-X on
5464 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005465 Numbers which simply begin with a digit in the range 1-9 are always
5466 considered decimal. This also happens for numbers that are not
5467 recognized as octal or hex.
5468
5469 *'number'* *'nu'* *'nonumber'* *'nonu'*
5470'number' 'nu' boolean (default off)
5471 local to window
5472 Print the line number in front of each line. When the 'n' option is
5473 excluded from 'cpoptions' a wrapped line will not use the column of
5474 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005475 The 'numberwidth' option can be used to set the room used for the line
5476 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005477 When a long, wrapped line doesn't start with the first character, '-'
5478 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005479 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5480 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005481 *number_relativenumber*
5482 The 'relativenumber' option changes the displayed number to be
5483 relative to the cursor. Together with 'number' there are these
5484 four combinations (cursor in line 3):
5485
Bram Moolenaar3848e002016-03-19 18:42:29 +01005486 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005487 'nornu' 'nornu' 'rnu' 'rnu'
5488
5489 |apple | 1 apple | 2 apple | 2 apple
5490 |pear | 2 pear | 1 pear | 1 pear
5491 |nobody | 3 nobody | 0 nobody |3 nobody
5492 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005493
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005494 *'numberwidth'* *'nuw'*
5495'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5496 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005497 {not in Vi}
5498 {only available when compiled with the |+linebreak|
5499 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005500 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005501 when the 'number' or 'relativenumber' option is set or printing lines
5502 with a line number. Since one space is always between the number and
5503 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005504 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005505 fit the highest line number in the buffer respectively the number of
5506 rows in the window, depending on whether 'number' or 'relativenumber'
5507 is set. Thus with the Vim default of 4 there is room for a line number
5508 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005509 The minimum value is 1, the maximum value is 10.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005510 NOTE: This option is set to the Vi default value when 'compatible' is
5511 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005512
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005513 *'omnifunc'* *'ofu'*
5514'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005515 local to buffer
5516 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005517 {not available when compiled without the |+eval|
5518 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005519 This option specifies a function to be used for Insert mode omni
5520 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005521 See |complete-functions| for an explanation of how the function is
5522 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005523 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005524 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005525 This option cannot be set from a |modeline| or in the |sandbox|, for
5526 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005527
5528
Bram Moolenaar02467872007-05-06 13:22:01 +00005529 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005530'opendevice' 'odev' boolean (default off)
5531 global
5532 {not in Vi}
5533 {only for MS-DOS, MS-Windows and OS/2}
5534 Enable reading and writing from devices. This may get Vim stuck on a
5535 device that can be opened but doesn't actually do the I/O. Therefore
5536 it is off by default.
5537 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5538 result in editing a device.
5539
5540
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005541 *'operatorfunc'* *'opfunc'*
5542'operatorfunc' 'opfunc' string (default: empty)
5543 global
5544 {not in Vi}
5545 This option specifies a function to be called by the |g@| operator.
5546 See |:map-operator| for more info and an example.
5547
5548 This option cannot be set from a |modeline| or in the |sandbox|, for
5549 security reasons.
5550
5551
Bram Moolenaar251e1912011-06-19 05:09:16 +02005552 *'osfiletype'* *'oft'*
5553'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005554 local to buffer
5555 {not in Vi}
Bram Moolenaar251e1912011-06-19 05:09:16 +02005556 This option was supported on RISC OS, which has been removed.
5557
Bram Moolenaar071d4272004-06-13 20:20:40 +00005558
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005559 *'packpath'* *'pp'*
5560'packpath' 'pp' string (default: see 'runtimepath')
5561 {not in Vi}
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005562 Directories used to find packages. See |packages|.
5563
5564
Bram Moolenaar071d4272004-06-13 20:20:40 +00005565 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005566'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005567 global
5568 Specifies the nroff macros that separate paragraphs. These are pairs
5569 of two letters (see |object-motions|).
5570
5571 *'paste'* *'nopaste'*
5572'paste' boolean (default off)
5573 global
5574 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005575 Put Vim in Paste mode. This is useful if you want to cut or copy
5576 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005577 unexpected effects.
5578 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005579 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005580 knows about pasting and will mostly do the right thing without 'paste'
5581 being set. The same is true for a terminal where Vim handles the
5582 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005583 This option is reset when starting the GUI. Thus if you set it in
5584 your .vimrc it will work in a terminal, but not in the GUI. Setting
5585 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5586 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005587 When the 'paste' option is switched on (also when it was already on):
5588 - mapping in Insert mode and Command-line mode is disabled
5589 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005590 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005591 - 'expandtab' is reset
5592 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005593 - 'revins' is reset
5594 - 'ruler' is reset
5595 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005596 - 'smartindent' is reset
5597 - 'smarttab' is reset
5598 - 'softtabstop' is set to 0
5599 - 'textwidth' is set to 0
5600 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005601 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005602 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005603 - 'indentexpr'
5604 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005605 NOTE: When you start editing another file while the 'paste' option is
5606 on, settings from the modelines or autocommands may change the
5607 settings again, causing trouble when pasting text. You might want to
5608 set the 'paste' option again.
5609 When the 'paste' option is reset the mentioned options are restored to
5610 the value before the moment 'paste' was switched from off to on.
5611 Resetting 'paste' before ever setting it does not have any effect.
5612 Since mapping doesn't work while 'paste' is active, you need to use
5613 the 'pastetoggle' option to toggle the 'paste' option with some key.
5614
5615 *'pastetoggle'* *'pt'*
5616'pastetoggle' 'pt' string (default "")
5617 global
5618 {not in Vi}
5619 When non-empty, specifies the key sequence that toggles the 'paste'
5620 option. This is like specifying a mapping: >
5621 :map {keys} :set invpaste<CR>
5622< Where {keys} is the value of 'pastetoggle'.
5623 The difference is that it will work even when 'paste' is set.
5624 'pastetoggle' works in Insert mode and Normal mode, but not in
5625 Command-line mode.
5626 Mappings are checked first, thus overrule 'pastetoggle'. However,
5627 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5628 this: >
5629 :map <F10> :set paste<CR>
5630 :map <F11> :set nopaste<CR>
5631 :imap <F10> <C-O>:set paste<CR>
5632 :imap <F11> <nop>
5633 :set pastetoggle=<F11>
5634< This will make <F10> start paste mode and <F11> stop paste mode.
5635 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5636 mode everything is inserted literally, except the 'pastetoggle' key
5637 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005638 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005639
5640 *'pex'* *'patchexpr'*
5641'patchexpr' 'pex' string (default "")
5642 global
5643 {not in Vi}
5644 {not available when compiled without the |+diff|
5645 feature}
5646 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005647 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005648
Bram Moolenaardbc28022014-07-26 13:40:44 +02005649 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005650'patchmode' 'pm' string (default "")
5651 global
5652 {not in Vi}
5653 When non-empty the oldest version of a file is kept. This can be used
5654 to keep the original version of a file if you are changing files in a
5655 source distribution. Only the first time that a file is written a
5656 copy of the original file will be kept. The name of the copy is the
5657 name of the original file with the string in the 'patchmode' option
5658 appended. This option should start with a dot. Use a string like
5659 ".org". 'backupdir' must not be empty for this to work (Detail: The
5660 backup file is renamed to the patchmode file after the new file has
5661 been successfully written, that's why it must be possible to write a
5662 backup file). If there was no file to be backed up, an empty file is
5663 created.
5664 When the 'backupskip' pattern matches, a patchmode file is not made.
5665 Using 'patchmode' for compressed files appends the extension at the
5666 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5667 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005668 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005669
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005670 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005671'path' 'pa' string (default on Unix: ".,/usr/include,,"
5672 on OS/2: ".,/emx/include,,"
5673 other systems: ".,,")
5674 global or local to buffer |global-local|
5675 {not in Vi}
5676 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005677 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5678 provided that the file being searched for has a relative path (not
5679 starting with "/", "./" or "../"). The directories in the 'path'
5680 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005681 - Use commas to separate directory names: >
5682 :set path=.,/usr/local/include,/usr/include
5683< - Spaces can also be used to separate directory names (for backwards
5684 compatibility with version 3.0). To have a space in a directory
5685 name, precede it with an extra backslash, and escape the space: >
5686 :set path=.,/dir/with\\\ space
5687< - To include a comma in a directory name precede it with an extra
5688 backslash: >
5689 :set path=.,/dir/with\\,comma
5690< - To search relative to the directory of the current file, use: >
5691 :set path=.
5692< - To search in the current directory use an empty string between two
5693 commas: >
5694 :set path=,,
5695< - A directory name may end in a ':' or '/'.
5696 - Environment variables are expanded |:set_env|.
5697 - When using |netrw.vim| URLs can be used. For example, adding
5698 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005699 - Search upwards and downwards in a directory tree using "*", "**" and
5700 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005701 {not available when compiled without the |+path_extra| feature}
5702 - Careful with '\' characters, type two to get one in the option: >
5703 :set path=.,c:\\include
5704< Or just use '/' instead: >
5705 :set path=.,c:/include
5706< Don't forget "." or files won't even be found in the same directory as
5707 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005708 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005709 it is something like 256 or 1024 characters.
5710 You can check if all the include files are found, using the value of
5711 'path', see |:checkpath|.
5712 The use of |:set+=| and |:set-=| is preferred when adding or removing
5713 directories from the list. This avoids problems when a future version
5714 uses another default. To remove the current directory use: >
5715 :set path-=
5716< To add the current directory use: >
5717 :set path+=
5718< To use an environment variable, you probably need to replace the
5719 separator. Here is an example to append $INCL, in which directory
5720 names are separated with a semi-colon: >
5721 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5722< Replace the ';' with a ':' or whatever separator is used. Note that
5723 this doesn't work when $INCL contains a comma or white space.
5724
Bram Moolenaard94464e2015-11-02 15:28:18 +01005725 *'perldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005726'perldll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005727 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005728 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01005729 {only available when compiled with the |+perl/dyn|
5730 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005731 Specifies the name of the Perl shared library. The default is
5732 DYNAMIC_PERL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005733 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005734 This option cannot be set from a |modeline| or in the |sandbox|, for
5735 security reasons.
5736
Bram Moolenaar071d4272004-06-13 20:20:40 +00005737 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5738'preserveindent' 'pi' boolean (default off)
5739 local to buffer
5740 {not in Vi}
5741 When changing the indent of the current line, preserve as much of the
5742 indent structure as possible. Normally the indent is replaced by a
5743 series of tabs followed by spaces as required (unless |'expandtab'| is
5744 enabled, in which case only spaces are used). Enabling this option
5745 means the indent will preserve as many existing characters as possible
5746 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005747 'expandtab' does not apply to the preserved white space, a Tab remains
5748 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005749 NOTE: When using ">>" multiple times the resulting indent is a mix of
5750 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005751 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005752 Also see 'copyindent'.
5753 Use |:retab| to clean up white space.
5754
5755 *'previewheight'* *'pvh'*
5756'previewheight' 'pvh' number (default 12)
5757 global
5758 {not in Vi}
5759 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005760 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005761 Default height for a preview window. Used for |:ptag| and associated
5762 commands. Used for |CTRL-W_}| when no count is given.
5763
5764 *'previewwindow'* *'nopreviewwindow'*
5765 *'pvw'* *'nopvw'* *E590*
5766'previewwindow' 'pvw' boolean (default off)
5767 local to window
5768 {not in Vi}
5769 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005770 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005771 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005772 set. It's normally not set directly, but by using one of the commands
5773 |:ptag|, |:pedit|, etc.
5774
5775 *'printdevice'* *'pdev'*
5776'printdevice' 'pdev' string (default empty)
5777 global
5778 {not in Vi}
5779 {only available when compiled with the |+printer|
5780 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005781 The name of the printer to be used for |:hardcopy|.
5782 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005783 This option cannot be set from a |modeline| or in the |sandbox|, for
5784 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005785
Bram Moolenaar8299df92004-07-10 09:47:34 +00005786 *'printencoding'* *'penc'*
5787'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005788 global
5789 {not in Vi}
5790 {only available when compiled with the |+printer|
5791 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005792 Sets the character encoding used when printing.
5793 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005794
5795 *'printexpr'* *'pexpr'*
5796'printexpr' 'pexpr' String (default: see below)
5797 global
5798 {not in Vi}
5799 {only available when compiled with the |+printer|
5800 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005801 Expression used to print the PostScript produced with |:hardcopy|.
5802 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005803 This option cannot be set from a |modeline| or in the |sandbox|, for
5804 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005805
Bram Moolenaar8299df92004-07-10 09:47:34 +00005806 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005807'printfont' 'pfn' string (default "courier")
5808 global
5809 {not in Vi}
5810 {only available when compiled with the |+printer|
5811 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005812 The name of the font that will be used for |:hardcopy|.
5813 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005814
5815 *'printheader'* *'pheader'*
5816'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5817 global
5818 {not in Vi}
5819 {only available when compiled with the |+printer|
5820 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005821 The format of the header produced in |:hardcopy| output.
5822 See |pheader-option|.
5823
5824 *'printmbcharset'* *'pmbcs'*
5825'printmbcharset' 'pmbcs' string (default "")
5826 global
5827 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005828 {only available when compiled with the |+printer|,
5829 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005830 The CJK character set to be used for CJK output from |:hardcopy|.
5831 See |pmbcs-option|.
5832
5833 *'printmbfont'* *'pmbfn'*
5834'printmbfont' 'pmbfn' string (default "")
5835 global
5836 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005837 {only available when compiled with the |+printer|,
5838 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005839 List of font names to be used for CJK output from |:hardcopy|.
5840 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005841
5842 *'printoptions'* *'popt'*
5843'printoptions' 'popt' string (default "")
5844 global
5845 {not in Vi}
5846 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005847 List of items that control the format of the output of |:hardcopy|.
5848 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005849
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005850 *'prompt'* *'noprompt'*
5851'prompt' boolean (default on)
5852 global
5853 When on a ":" prompt is used in Ex mode.
5854
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005855 *'pumheight'* *'ph'*
5856'pumheight' 'ph' number (default 0)
5857 global
5858 {not available when compiled without the
5859 |+insert_expand| feature}
5860 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005861 Determines the maximum number of items to show in the popup menu for
5862 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005863 |ins-completion-menu|.
5864
Bram Moolenaard94464e2015-11-02 15:28:18 +01005865 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005866'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005867 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005868 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01005869 {only available when compiled with the |+python/dyn|
5870 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005871 Specifies the name of the Python 2.x shared library. The default is
5872 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005873 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005874 This option cannot be set from a |modeline| or in the |sandbox|, for
5875 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005876
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005877 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005878'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005879 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005880 {not in Vi}
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005881 {only available when compiled with the |+python3/dyn|
5882 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005883 Specifies the name of the Python 3 shared library. The default is
5884 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005885 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005886 This option cannot be set from a |modeline| or in the |sandbox|, for
5887 security reasons.
5888
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005889 *'pyxversion'* *'pyx'*
5890'pyxversion' 'pyx' number (default depends on the build)
5891 global
5892 {not in Vi}
5893 {only available when compiled with the |+python| or
5894 the |+python3| feature}
5895 Specifies the python version used for pyx* functions and commands
5896 |python_x|. The default value is as follows:
5897
5898 Compiled with Default ~
5899 |+python| and |+python3| 0
5900 only |+python| 2
5901 only |+python3| 3
5902
5903 Available values are 0, 2 and 3.
5904 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
5905 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
5906 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
5907 to 2 if Python 2 is available.
5908 See also: |has-pythonx|
5909
5910 If Vim is compiled with only |+python| or |+python3| setting
5911 'pyxversion' has no effect. The pyx* functions and commands are
5912 always the same as the compiled version.
5913
5914 This option cannot be set from a |modeline| or in the |sandbox|, for
5915 security reasons.
5916
Bram Moolenaar677ee682005-01-27 14:41:15 +00005917 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005918'quoteescape' 'qe' string (default "\")
5919 local to buffer
5920 {not in Vi}
5921 The characters that are used to escape quotes in a string. Used for
5922 objects like a', a" and a` |a'|.
5923 When one of the characters in this option is found inside a string,
5924 the following character will be skipped. The default value makes the
5925 text "foo\"bar\\" considered to be one string.
5926
Bram Moolenaar071d4272004-06-13 20:20:40 +00005927 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5928'readonly' 'ro' boolean (default off)
5929 local to buffer
5930 If on, writes fail unless you use a '!'. Protects you from
5931 accidentally overwriting a file. Default on when Vim is started
5932 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005933 When using ":w!" the 'readonly' option is reset for the current
5934 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005935 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005936 set for the newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005937 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005938
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005939 *'redrawtime'* *'rdt'*
5940'redrawtime' 'rdt' number (default 2000)
5941 global
5942 {not in Vi}
5943 {only available when compiled with the |+reltime|
5944 feature}
5945 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005946 searching for patterns for 'hlsearch', |:match| highlighting an syntax
5947 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005948 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005949 matches will be highlighted.
5950 For syntax highlighting the time applies per window. When over the
5951 limit syntax highlighting is disabled until |CTRL-L| is used.
5952 This is used to avoid that Vim hangs when using a very complicated
5953 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005954
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02005955 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005956'regexpengine' 're' number (default 0)
5957 global
5958 {not in Vi}
5959 This selects the default regexp engine. |two-engines|
5960 The possible values are:
5961 0 automatic selection
5962 1 old engine
5963 2 NFA engine
5964 Note that when using the NFA engine and the pattern contains something
5965 that is not supported the pattern will not match. This is only useful
5966 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01005967 Using automatic selection enables Vim to switch the engine, if the
5968 default engine becomes too costly. E.g., when the NFA engine uses too
5969 many states. This should prevent Vim from hanging on a combination of
5970 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005971
Bram Moolenaar64486672010-05-16 15:46:46 +02005972 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5973'relativenumber' 'rnu' boolean (default off)
5974 local to window
5975 {not in Vi}
5976 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005977 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005978 precede some vertical motion commands (e.g. j k + -) with, without
5979 having to calculate it yourself. Especially useful in combination with
5980 other commands (e.g. y d c < > gq gw =).
5981 When the 'n' option is excluded from 'cpoptions' a wrapped
5982 line will not use the column of line numbers (this is the default when
5983 'compatible' isn't set).
5984 The 'numberwidth' option can be used to set the room used for the line
5985 number.
5986 When a long, wrapped line doesn't start with the first character, '-'
5987 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005988 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5989 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005990
5991 The number in front of the cursor line also depends on the value of
5992 'number', see |number_relativenumber| for all combinations of the two
5993 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02005994
Bram Moolenaar071d4272004-06-13 20:20:40 +00005995 *'remap'* *'noremap'*
5996'remap' boolean (default on)
5997 global
5998 Allows for mappings to work recursively. If you do not want this for
5999 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006000 NOTE: To avoid portability problems with Vim scripts, always keep
6001 this option at the default "on". Only switch it off when working with
6002 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006003
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006004 *'renderoptions'* *'rop'*
6005'renderoptions' 'rop' string (default: empty)
6006 global
6007 {not in Vi}
6008 {only available when compiled with GUI and DIRECTX on
6009 MS-Windows}
6010 Select a text renderer and set its options. The options depend on the
6011 renderer.
6012
6013 Syntax: >
6014 set rop=type:{renderer}(,{name}:{value})*
6015<
6016 Currently, only one optional renderer is available.
6017
6018 render behavior ~
6019 directx Vim will draw text using DirectX (DirectWrite). It makes
6020 drawn glyphs more beautiful than default GDI.
6021 It requires 'encoding' is "utf-8", and only works on
6022 MS-Windows Vista or newer version.
6023
6024 Options:
6025 name meaning type value ~
6026 gamma gamma float 1.0 - 2.2 (maybe)
6027 contrast enhancedContrast float (unknown)
6028 level clearTypeLevel float (unknown)
6029 geom pixelGeometry int 0 - 2 (see below)
6030 renmode renderingMode int 0 - 6 (see below)
6031 taamode textAntialiasMode int 0 - 3 (see below)
6032
6033 See this URL for detail:
6034 http://msdn.microsoft.com/en-us/library/dd368190.aspx
6035
6036 For geom: structure of a device pixel.
6037 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6038 1 - DWRITE_PIXEL_GEOMETRY_RGB
6039 2 - DWRITE_PIXEL_GEOMETRY_BGR
6040
6041 See this URL for detail:
6042 http://msdn.microsoft.com/en-us/library/dd368114.aspx
6043
6044 For renmode: method of rendering glyphs.
6045 0 - DWRITE_RENDERING_MODE_DEFAULT
6046 1 - DWRITE_RENDERING_MODE_ALIASED
6047 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6048 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6049 4 - DWRITE_RENDERING_MODE_NATURAL
6050 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6051 6 - DWRITE_RENDERING_MODE_OUTLINE
6052
6053 See this URL for detail:
6054 http://msdn.microsoft.com/en-us/library/dd368118.aspx
6055
6056 For taamode: antialiasing mode used for drawing text.
6057 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6058 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6059 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6060 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6061
6062 See this URL for detail:
6063 http://msdn.microsoft.com/en-us/library/dd368170.aspx
6064
6065 Example: >
6066 set encoding=utf-8
6067 set gfn=Ricty_Diminished:h12:cSHIFTJIS
6068 set rop=type:directx
6069<
6070 If select a raster font (Courier, Terminal or FixedSys) to
6071 'guifont', it fallbacks to be drawn by GDI automatically.
6072
6073 Other render types are currently not supported.
6074
Bram Moolenaar071d4272004-06-13 20:20:40 +00006075 *'report'*
6076'report' number (default 2)
6077 global
6078 Threshold for reporting number of lines changed. When the number of
6079 changed lines is more than 'report' a message will be given for most
6080 ":" commands. If you want it always, set 'report' to 0.
6081 For the ":substitute" command the number of substitutions is used
6082 instead of the number of lines.
6083
6084 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6085'restorescreen' 'rs' boolean (default on)
6086 global
6087 {not in Vi} {only in Windows 95/NT console version}
6088 When set, the screen contents is restored when exiting Vim. This also
6089 happens when executing external commands.
6090
6091 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6092 options in your .vimrc. To disable restoring:
6093 set t_ti= t_te=
6094 To enable restoring (for an xterm):
6095 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6096 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6097
6098 *'revins'* *'ri'* *'norevins'* *'nori'*
6099'revins' 'ri' boolean (default off)
6100 global
6101 {not in Vi}
6102 {only available when compiled with the |+rightleft|
6103 feature}
6104 Inserting characters in Insert mode will work backwards. See "typing
6105 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6106 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006107 NOTE: This option is reset when 'compatible' is set.
6108 This option is reset when 'paste' is set and restored when 'paste' is
6109 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006110
6111 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6112'rightleft' 'rl' boolean (default off)
6113 local to window
6114 {not in Vi}
6115 {only available when compiled with the |+rightleft|
6116 feature}
6117 When on, display orientation becomes right-to-left, i.e., characters
6118 that are stored in the file appear from the right to the left.
6119 Using this option, it is possible to edit files for languages that
6120 are written from the right to the left such as Hebrew and Arabic.
6121 This option is per window, so it is possible to edit mixed files
6122 simultaneously, or to view the same file in both ways (this is
6123 useful whenever you have a mixed text file with both right-to-left
6124 and left-to-right strings so that both sets are displayed properly
6125 in different windows). Also see |rileft.txt|.
6126
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006127 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006128'rightleftcmd' 'rlc' string (default "search")
6129 local to window
6130 {not in Vi}
6131 {only available when compiled with the |+rightleft|
6132 feature}
6133 Each word in this option enables the command line editing to work in
6134 right-to-left mode for a group of commands:
6135
6136 search "/" and "?" commands
6137
6138 This is useful for languages such as Hebrew, Arabic and Farsi.
6139 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6140
Bram Moolenaard94464e2015-11-02 15:28:18 +01006141 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006142'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006143 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006144 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01006145 {only available when compiled with the |+ruby/dyn|
6146 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006147 Specifies the name of the Ruby shared library. The default is
6148 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006149 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006150 This option cannot be set from a |modeline| or in the |sandbox|, for
6151 security reasons.
6152
Bram Moolenaar071d4272004-06-13 20:20:40 +00006153 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006154'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006155 global
6156 {not in Vi}
6157 {not available when compiled without the
6158 |+cmdline_info| feature}
6159 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006160 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006161 text in the file is shown on the far right:
6162 Top first line is visible
6163 Bot last line is visible
6164 All first and last line are visible
6165 45% relative position in the file
6166 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006167 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006168 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006169 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006170 this option takes precedence over 'ruler' and 'rulerformat'
6171 If the number of characters displayed is different from the number of
6172 bytes in the text (e.g., for a TAB or a multi-byte character), both
6173 the text column (byte number) and the screen column are shown,
6174 separated with a dash.
6175 For an empty line "0-1" is shown.
6176 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006177 This option is reset when 'paste' is set and restored when 'paste' is
6178 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006179 If you don't want to see the ruler all the time but want to know where
6180 you are, use "g CTRL-G" |g_CTRL-G|.
6181 NOTE: This option is reset when 'compatible' is set.
6182
6183 *'rulerformat'* *'ruf'*
6184'rulerformat' 'ruf' string (default empty)
6185 global
6186 {not in Vi}
6187 {not available when compiled without the |+statusline|
6188 feature}
6189 When this option is not empty, it determines the content of the ruler
6190 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006191 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006192 The default ruler width is 17 characters. To make the ruler 15
6193 characters wide, put "%15(" at the start and "%)" at the end.
6194 Example: >
6195 :set rulerformat=%15(%c%V\ %p%%%)
6196<
6197 *'runtimepath'* *'rtp'* *vimfiles*
6198'runtimepath' 'rtp' string (default:
6199 Unix: "$HOME/.vim,
6200 $VIM/vimfiles,
6201 $VIMRUNTIME,
6202 $VIM/vimfiles/after,
6203 $HOME/.vim/after"
6204 Amiga: "home:vimfiles,
6205 $VIM/vimfiles,
6206 $VIMRUNTIME,
6207 $VIM/vimfiles/after,
6208 home:vimfiles/after"
6209 PC, OS/2: "$HOME/vimfiles,
6210 $VIM/vimfiles,
6211 $VIMRUNTIME,
6212 $VIM/vimfiles/after,
6213 $HOME/vimfiles/after"
6214 Macintosh: "$VIM:vimfiles,
6215 $VIMRUNTIME,
6216 $VIM:vimfiles:after"
6217 RISC-OS: "Choices:vimfiles,
6218 $VIMRUNTIME,
6219 Choices:vimfiles/after"
6220 VMS: "sys$login:vimfiles,
6221 $VIM/vimfiles,
6222 $VIMRUNTIME,
6223 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006224 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006225 global
6226 {not in Vi}
6227 This is a list of directories which will be searched for runtime
6228 files:
6229 filetype.vim filetypes by file name |new-filetype|
6230 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006231 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006232 colors/ color scheme files |:colorscheme|
6233 compiler/ compiler files |:compiler|
6234 doc/ documentation |write-local-help|
6235 ftplugin/ filetype plugins |write-filetype-plugin|
6236 indent/ indent scripts |indent-expression|
6237 keymap/ key mapping files |mbyte-keymap|
6238 lang/ menu translations |:menutrans|
6239 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006240 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006241 plugin/ plugin scripts |write-plugin|
6242 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006243 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006244 syntax/ syntax files |mysyntaxfile|
6245 tutor/ files for vimtutor |tutor|
6246
6247 And any other file searched for with the |:runtime| command.
6248
6249 The defaults for most systems are setup to search five locations:
6250 1. In your home directory, for your personal preferences.
6251 2. In a system-wide Vim directory, for preferences from the system
6252 administrator.
6253 3. In $VIMRUNTIME, for files distributed with Vim.
6254 *after-directory*
6255 4. In the "after" directory in the system-wide Vim directory. This is
6256 for the system administrator to overrule or add to the distributed
6257 defaults (rarely needed)
6258 5. In the "after" directory in your home directory. This is for
6259 personal preferences to overrule or add to the distributed defaults
6260 or system-wide settings (rarely needed).
6261
Bram Moolenaard0796902016-09-16 20:02:31 +02006262 More entries are added when using |packages|. If it gets very long
6263 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6264 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006265
Bram Moolenaar071d4272004-06-13 20:20:40 +00006266 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6267 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006268 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006269 wildcards.
6270 See |:runtime|.
6271 Example: >
6272 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6273< This will use the directory "~/vimruntime" first (containing your
6274 personal Vim runtime files), then "/mygroup/vim" (shared between a
6275 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6276 files).
6277 You probably should always include $VIMRUNTIME somewhere, to use the
6278 distributed runtime files. You can put a directory before $VIMRUNTIME
6279 to find files which replace a distributed runtime files. You can put
6280 a directory after $VIMRUNTIME to find files which add to distributed
6281 runtime files.
6282 This option cannot be set from a |modeline| or in the |sandbox|, for
6283 security reasons.
6284
6285 *'scroll'* *'scr'*
6286'scroll' 'scr' number (default: half the window height)
6287 local to window
6288 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6289 set to half the number of lines in the window when the window size
6290 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006291 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006292 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
6293 the number of screen lines instead of file lines, makes a difference
6294 when lines wrap}
6295
6296 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6297'scrollbind' 'scb' boolean (default off)
6298 local to window
6299 {not in Vi}
6300 {not available when compiled without the |+scrollbind|
6301 feature}
6302 See also |scroll-binding|. When this option is set, the current
6303 window scrolls as other scrollbind windows (windows that also have
6304 this option set) scroll. This option is useful for viewing the
6305 differences between two versions of a file, see 'diff'.
6306 See |'scrollopt'| for options that determine how this option should be
6307 interpreted.
6308 This option is mostly reset when splitting a window to edit another
6309 file. This means that ":split | edit file" results in two windows
6310 with scroll-binding, but ":split file" does not.
6311
6312 *'scrolljump'* *'sj'*
6313'scrolljump' 'sj' number (default 1)
6314 global
6315 {not in Vi}
6316 Minimal number of lines to scroll when the cursor gets off the
6317 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6318 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006319 When set to a negative number from -1 to -100 this is used as the
6320 percentage of the window height. Thus -50 scrolls half the window
6321 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006322 NOTE: This option is set to 1 when 'compatible' is set.
6323
6324 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006325'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006326 global
6327 {not in Vi}
6328 Minimal number of screen lines to keep above and below the cursor.
6329 This will make some context visible around where you are working. If
6330 you set it to a very large value (999) the cursor line will always be
6331 in the middle of the window (except at the start or end of the file or
6332 when long lines wrap).
6333 For scrolling horizontally see 'sidescrolloff'.
6334 NOTE: This option is set to 0 when 'compatible' is set.
6335
6336 *'scrollopt'* *'sbo'*
6337'scrollopt' 'sbo' string (default "ver,jump")
6338 global
6339 {not available when compiled without the |+scrollbind|
6340 feature}
6341 {not in Vi}
6342 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006343 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6344 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006345 The following words are available:
6346 ver Bind vertical scrolling for 'scrollbind' windows
6347 hor Bind horizontal scrolling for 'scrollbind' windows
6348 jump Applies to the offset between two windows for vertical
6349 scrolling. This offset is the difference in the first
6350 displayed line of the bound windows. When moving
6351 around in a window, another 'scrollbind' window may
6352 reach a position before the start or after the end of
6353 the buffer. The offset is not changed though, when
6354 moving back the 'scrollbind' window will try to scroll
6355 to the desired position when possible.
6356 When now making that window the current one, two
6357 things can be done with the relative offset:
6358 1. When "jump" is not included, the relative offset is
6359 adjusted for the scroll position in the new current
6360 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006361 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006362 2. When "jump" is included, the other windows are
6363 scrolled to keep the same relative offset. When
6364 going back to the other window, it still uses the
6365 same relative offset.
6366 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006367 When 'diff' mode is active there always is vertical scroll binding,
6368 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006369
6370 *'sections'* *'sect'*
6371'sections' 'sect' string (default "SHNHH HUnhsh")
6372 global
6373 Specifies the nroff macros that separate sections. These are pairs of
6374 two letters (See |object-motions|). The default makes a section start
6375 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6376
6377 *'secure'* *'nosecure'* *E523*
6378'secure' boolean (default off)
6379 global
6380 {not in Vi}
6381 When on, ":autocmd", shell and write commands are not allowed in
6382 ".vimrc" and ".exrc" in the current directory and map commands are
6383 displayed. Switch it off only if you know that you will not run into
6384 problems, or when the 'exrc' option is off. On Unix this option is
6385 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006386 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006387 'secure' at the end of your ~/.vimrc then.
6388 This option cannot be set from a |modeline| or in the |sandbox|, for
6389 security reasons.
6390
6391 *'selection'* *'sel'*
6392'selection' 'sel' string (default "inclusive")
6393 global
6394 {not in Vi}
6395 This option defines the behavior of the selection. It is only used
6396 in Visual and Select mode.
6397 Possible values:
6398 value past line inclusive ~
6399 old no yes
6400 inclusive yes yes
6401 exclusive yes no
6402 "past line" means that the cursor is allowed to be positioned one
6403 character past the line.
6404 "inclusive" means that the last character of the selection is included
6405 in an operation. For example, when "x" is used to delete the
6406 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006407 When "old" is used and 'virtualedit' allows the cursor to move past
6408 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006409 Note that when "exclusive" is used and selecting from the end
6410 backwards, you cannot include the last character of a line, when
6411 starting in Normal mode and 'virtualedit' empty.
6412
6413 The 'selection' option is set by the |:behave| command.
6414
6415 *'selectmode'* *'slm'*
6416'selectmode' 'slm' string (default "")
6417 global
6418 {not in Vi}
6419 This is a comma separated list of words, which specifies when to start
6420 Select mode instead of Visual mode, when a selection is started.
6421 Possible values:
6422 mouse when using the mouse
6423 key when using shifted special keys
6424 cmd when using "v", "V" or CTRL-V
6425 See |Select-mode|.
6426 The 'selectmode' option is set by the |:behave| command.
6427
6428 *'sessionoptions'* *'ssop'*
6429'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00006430 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006431 global
6432 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006433 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006434 feature}
6435 Changes the effect of the |:mksession| command. It is a comma
6436 separated list of words. Each word enables saving and restoring
6437 something:
6438 word save and restore ~
6439 blank empty windows
6440 buffers hidden and unloaded buffers, not just those in windows
6441 curdir the current directory
6442 folds manually created folds, opened/closed folds and local
6443 fold options
6444 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006445 and contain at least one lowercase letter. Only
6446 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006447 help the help window
6448 localoptions options and mappings local to a window or buffer (not
6449 global values for local options)
6450 options all options and mappings (also global values for local
6451 options)
6452 resize size of the Vim window: 'lines' and 'columns'
6453 sesdir the directory in which the session file is located
6454 will become the current directory (useful with
6455 projects accessed over a network from different
6456 systems)
6457 slash backslashes in file names replaced with forward
6458 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006459 tabpages all tab pages; without this only the current tab page
6460 is restored, so that you can make a session for each
6461 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00006462 unix with Unix end-of-line format (single <NL>), even when
6463 on Windows or DOS
6464 winpos position of the whole Vim window
6465 winsize window sizes
6466
6467 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006468 When neither "curdir" nor "sesdir" is included, file names are stored
6469 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006470 "slash" and "unix" are useful on Windows when sharing session files
6471 with Unix. The Unix version of Vim cannot source dos format scripts,
6472 but the Windows version of Vim can source unix format scripts.
6473
6474 *'shell'* *'sh'* *E91*
6475'shell' 'sh' string (default $SHELL or "sh",
6476 MS-DOS and Win32: "command.com" or
6477 "cmd.exe", OS/2: "cmd")
6478 global
6479 Name of the shell to use for ! and :! commands. When changing the
6480 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6481 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006482 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006483 See |option-backslash| about including spaces and backslashes.
6484 Environment variables are expanded |:set_env|.
6485 If the name of the shell contains a space, you might need to enclose
6486 it in quotes. Example: >
6487 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6488< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006489 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006490 "-f" is not inside the quotes, because it is not part of the command
6491 name. And Vim automagically recognizes the backslashes that are path
6492 separators.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006493 Under MS-Windows, when the executable ends in ".com" it must be
6494 included. Thus setting the shell to "command.com" or "4dos.com"
6495 works, but "command" and "4dos" do not work for all commands (e.g.,
6496 filtering).
6497 For unknown reasons, when using "4dos.com" the current directory is
6498 changed to "C:\". To avoid this set 'shell' like this: >
6499 :set shell=command.com\ /c\ 4dos
6500< This option cannot be set from a |modeline| or in the |sandbox|, for
6501 security reasons.
6502
6503 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006504'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006505 MS-DOS and Win32, when 'shell' does not
6506 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006507 global
6508 {not in Vi}
6509 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6510 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6511 systems, the default is set according to the value of 'shell', to
Bram Moolenaare0720cb2017-03-29 13:48:40 +02006512 reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006513 On Unix it can have more than one flag. Each white space separated
6514 part is passed as an argument to the shell command.
6515 See |option-backslash| about including spaces and backslashes.
6516 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006517 This option cannot be set from a |modeline| or in the |sandbox|, for
6518 security reasons.
6519
6520 *'shellpipe'* *'sp'*
6521'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6522 global
6523 {not in Vi}
6524 {not available when compiled without the |+quickfix|
6525 feature}
6526 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006527 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006528 including spaces and backslashes.
6529 The name of the temporary file can be represented by "%s" if necessary
6530 (the file name is appended automatically if no %s appears in the value
6531 of this option).
6532 For the Amiga and MS-DOS the default is ">". The output is directly
6533 saved in a file and not echoed to the screen.
6534 For Unix the default it "| tee". The stdout of the compiler is saved
6535 in a file and echoed to the screen. If the 'shell' option is "csh" or
6536 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02006537 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
6538 default becomes "2>&1| tee". This means that stderr is also included.
6539 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
6540 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006541 The initialization of this option is done after reading the ".vimrc"
6542 and the other initializations, so that when the 'shell' option is set
6543 there, the 'shellpipe' option changes automatically, unless it was
6544 explicitly set before.
6545 When 'shellpipe' is set to an empty string, no redirection of the
6546 ":make" output will be done. This is useful if you use a 'makeprg'
6547 that writes to 'makeef' by itself. If you want no piping, but do
6548 want to include the 'makeef', set 'shellpipe' to a single space.
6549 Don't forget to precede the space with a backslash: ":set sp=\ ".
6550 In the future pipes may be used for filtering and this option will
6551 become obsolete (at least for Unix).
6552 This option cannot be set from a |modeline| or in the |sandbox|, for
6553 security reasons.
6554
6555 *'shellquote'* *'shq'*
6556'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6557 contains "sh" somewhere: "\"")
6558 global
6559 {not in Vi}
6560 Quoting character(s), put around the command passed to the shell, for
6561 the "!" and ":!" commands. The redirection is kept outside of the
6562 quoting. See 'shellxquote' to include the redirection. It's
6563 probably not useful to set both options.
6564 This is an empty string by default. Only known to be useful for
6565 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6566 or bash, where it should be "\"". The default is adjusted according
6567 the value of 'shell', to reduce the need to set this option by the
6568 user. See |dos-shell|.
6569 This option cannot be set from a |modeline| or in the |sandbox|, for
6570 security reasons.
6571
6572 *'shellredir'* *'srr'*
6573'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6574 global
6575 {not in Vi}
6576 String to be used to put the output of a filter command in a temporary
6577 file. See also |:!|. See |option-backslash| about including spaces
6578 and backslashes.
6579 The name of the temporary file can be represented by "%s" if necessary
6580 (the file name is appended automatically if no %s appears in the value
6581 of this option).
6582 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6583 or "zsh" during initializations, the default becomes ">&". If the
6584 'shell' option is "sh", "ksh" or "bash" the default becomes
6585 ">%s 2>&1". This means that stderr is also included.
6586 For Win32, the Unix checks are done and additionally "cmd" is checked
6587 for, which makes the default ">%s 2>&1". Also, the same names with
6588 ".exe" appended are checked for.
6589 The initialization of this option is done after reading the ".vimrc"
6590 and the other initializations, so that when the 'shell' option is set
6591 there, the 'shellredir' option changes automatically unless it was
6592 explicitly set before.
6593 In the future pipes may be used for filtering and this option will
6594 become obsolete (at least for Unix).
6595 This option cannot be set from a |modeline| or in the |sandbox|, for
6596 security reasons.
6597
6598 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6599'shellslash' 'ssl' boolean (default off)
6600 global
6601 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
6602 When set, a forward slash is used when expanding file names. This is
6603 useful when a Unix-like shell is used instead of command.com or
6604 cmd.exe. Backward slashes can still be typed, but they are changed to
6605 forward slashes by Vim.
6606 Note that setting or resetting this option has no effect for some
6607 existing file names, thus this option needs to be set before opening
6608 any file for best results. This might change in the future.
6609 'shellslash' only works when a backslash can be used as a path
6610 separator. To test if this is so use: >
6611 if exists('+shellslash')
6612<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006613 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6614'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6615 global
6616 {not in Vi}
6617 When on, use temp files for shell commands. When off use a pipe.
6618 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006619 Currently a pipe is only supported on Unix and MS-Windows 2K and
6620 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006621 :if has("filterpipe")
6622< The advantage of using a pipe is that nobody can read the temp file
6623 and the 'shell' command does not need to support redirection.
6624 The advantage of using a temp file is that the file type and encoding
6625 can be detected.
6626 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6627 |FilterWritePost| autocommands event are not triggered when
6628 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006629 The `system()` function does not respect this option and always uses
6630 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006631 NOTE: This option is set to the Vim default value when 'compatible'
6632 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006633
Bram Moolenaar071d4272004-06-13 20:20:40 +00006634 *'shelltype'* *'st'*
6635'shelltype' 'st' number (default 0)
6636 global
6637 {not in Vi} {only for the Amiga}
6638 On the Amiga this option influences the way how the commands work
6639 which use a shell.
6640 0 and 1: always use the shell
6641 2 and 3: use the shell only to filter lines
6642 4 and 5: use shell only for ':sh' command
6643 When not using the shell, the command is executed directly.
6644
6645 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6646 1 and 3: use "shell cmd" to start external commands
6647
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006648 *'shellxescape'* *'sxe'*
6649'shellxescape' 'sxe' string (default: "";
6650 for MS-DOS and MS-Windows: "\"&|<>()@^")
6651 global
6652 {not in Vi}
6653 When 'shellxquote' is set to "(" then the characters listed in this
6654 option will be escaped with a '^' character. This makes it possible
6655 to execute most external commands with cmd.exe.
6656
Bram Moolenaar071d4272004-06-13 20:20:40 +00006657 *'shellxquote'* *'sxq'*
6658'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006659 for Win32, when 'shell' is cmd.exe: "("
6660 for Win32, when 'shell' contains "sh"
6661 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006662 for Unix, when using system(): "\"")
6663 global
6664 {not in Vi}
6665 Quoting character(s), put around the command passed to the shell, for
6666 the "!" and ":!" commands. Includes the redirection. See
6667 'shellquote' to exclude the redirection. It's probably not useful
6668 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006669 When the value is '(' then ')' is appended. When the value is '"('
6670 then ')"' is appended.
6671 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006672 This is an empty string by default on most systems, but is known to be
6673 useful for on Win32 version, either for cmd.exe which automatically
6674 strips off the first and last quote on a command, or 3rd-party shells
6675 such as the MKS Korn Shell or bash, where it should be "\"". The
6676 default is adjusted according the value of 'shell', to reduce the need
6677 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006678 This option cannot be set from a |modeline| or in the |sandbox|, for
6679 security reasons.
6680
6681 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6682'shiftround' 'sr' boolean (default off)
6683 global
6684 {not in Vi}
6685 Round indent to multiple of 'shiftwidth'. Applies to > and <
6686 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6687 a multiple of 'shiftwidth' (this is Vi compatible).
6688 NOTE: This option is reset when 'compatible' is set.
6689
6690 *'shiftwidth'* *'sw'*
6691'shiftwidth' 'sw' number (default 8)
6692 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006693 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006694 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006695 When zero the 'ts' value will be used. Use the |shiftwidth()|
6696 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006697
6698 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006699'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6700 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006701 global
6702 {not in Vi}
6703 This option helps to avoid all the |hit-enter| prompts caused by file
6704 messages, for example with CTRL-G, and to avoid some other messages.
6705 It is a list of flags:
6706 flag meaning when present ~
6707 f use "(3 of 5)" instead of "(file 3 of 5)"
6708 i use "[noeol]" instead of "[Incomplete last line]"
6709 l use "999L, 888C" instead of "999 lines, 888 characters"
6710 m use "[+]" instead of "[Modified]"
6711 n use "[New]" instead of "[New File]"
6712 r use "[RO]" instead of "[readonly]"
6713 w use "[w]" instead of "written" for file write message
6714 and "[a]" instead of "appended" for ':w >> file' command
6715 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6716 "[unix format]" and "[mac]" instead of "[mac format]".
6717 a all of the above abbreviations
6718
6719 o overwrite message for writing a file with subsequent message
6720 for reading a file (useful for ":wn" or when 'autowrite' on)
6721 O message for reading a file overwrites any previous message.
6722 Also for quickfix message (e.g., ":cn").
6723 s don't give "search hit BOTTOM, continuing at TOP" or "search
6724 hit TOP, continuing at BOTTOM" messages
6725 t truncate file message at the start if it is too long to fit
6726 on the command-line, "<" will appear in the left most column.
6727 Ignored in Ex mode.
6728 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006729 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006730 Ignored in Ex mode.
6731 W don't give "written" or "[w]" when writing a file
6732 A don't give the "ATTENTION" message when an existing swap file
6733 is found.
6734 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006735 c don't give |ins-completion-menu| messages. For example,
6736 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6737 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006738 q use "recording" instead of "recording @a"
6739 F don't give the file info when editing a file, like `:silent`
6740 was used for the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00006741
6742 This gives you the opportunity to avoid that a change between buffers
6743 requires you to hit <Enter>, but still gives as useful a message as
6744 possible for the space available. To get the whole message that you
6745 would have got with 'shm' empty, use ":file!"
6746 Useful values:
6747 shm= No abbreviation of message.
6748 shm=a Abbreviation, but no loss of information.
6749 shm=at Abbreviation, and truncate message when necessary.
6750
6751 NOTE: This option is set to the Vi default value when 'compatible' is
6752 set and to the Vim default value when 'compatible' is reset.
6753
6754 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6755'shortname' 'sn' boolean (default off)
6756 local to buffer
6757 {not in Vi, not in MS-DOS versions}
6758 Filenames are assumed to be 8 characters plus one extension of 3
6759 characters. Multiple dots in file names are not allowed. When this
6760 option is on, dots in file names are replaced with underscores when
6761 adding an extension (".~" or ".swp"). This option is not available
6762 for MS-DOS, because then it would always be on. This option is useful
6763 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6764 or crossdos. When running the Win32 GUI version under Win32s, this
6765 option is always on by default.
6766
6767 *'showbreak'* *'sbr'* *E595*
6768'showbreak' 'sbr' string (default "")
6769 global
6770 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006771 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006772 feature}
6773 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006774 values are "> " or "+++ ": >
6775 :set showbreak=>\
6776< Note the backslash to escape the trailing space. It's easier like
6777 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006778 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006779< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006780 comma (in a future version the comma might be used to separate the
6781 part that is shown at the end and at the start of a line).
6782 The characters are highlighted according to the '@' flag in
6783 'highlight'.
6784 Note that tabs after the showbreak will be displayed differently.
6785 If you want the 'showbreak' to appear in between line numbers, add the
6786 "n" flag to 'cpoptions'.
6787
6788 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006789'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6790 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006791 global
6792 {not in Vi}
6793 {not available when compiled without the
6794 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006795 Show (partial) command in the last line of the screen. Set this
6796 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006797 In Visual mode the size of the selected area is shown:
6798 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006799 If the number of bytes is different it is also displayed: "2-6"
6800 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006801 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006802 - When selecting a block, the size in screen characters:
6803 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006804 NOTE: This option is set to the Vi default value when 'compatible' is
6805 set and to the Vim default value when 'compatible' is reset.
6806
6807 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6808'showfulltag' 'sft' boolean (default off)
6809 global
6810 {not in Vi}
6811 When completing a word in insert mode (see |ins-completion|) from the
6812 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006813 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006814 matched a C function, you can see a template for what arguments are
6815 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006816 Note that this doesn't work well together with having "longest" in
6817 'completeopt', because the completion from the search pattern may not
6818 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006819
6820 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6821'showmatch' 'sm' boolean (default off)
6822 global
6823 When a bracket is inserted, briefly jump to the matching one. The
6824 jump is only done if the match can be seen on the screen. The time to
6825 show the match can be set with 'matchtime'.
6826 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006827 seen or not).
6828 This option is reset when 'paste' is set and restored when 'paste' is
6829 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006830 When the 'm' flag is not included in 'cpoptions', typing a character
6831 will immediately move the cursor back to where it belongs.
6832 See the "sm" field in 'guicursor' for setting the cursor shape and
6833 blinking when showing the match.
6834 The 'matchpairs' option can be used to specify the characters to show
6835 matches for. 'rightleft' and 'revins' are used to look for opposite
6836 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006837 Also see the matchparen plugin for highlighting the match when moving
6838 around |pi_paren.txt|.
6839 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006840
6841 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6842'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6843 global
6844 If in Insert, Replace or Visual mode put a message on the last line.
6845 Use the 'M' flag in 'highlight' to set the type of highlighting for
6846 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006847 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006848 doesn't mean XIM is really active, especially when 'imactivatekey' is
6849 not set.
6850 NOTE: This option is set to the Vi default value when 'compatible' is
6851 set and to the Vim default value when 'compatible' is reset.
6852
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006853 *'showtabline'* *'stal'*
6854'showtabline' 'stal' number (default 1)
6855 global
6856 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006857 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006858 feature}
6859 The value of this option specifies when the line with tab page labels
6860 will be displayed:
6861 0: never
6862 1: only if there are at least two tab pages
6863 2: always
6864 This is both for the GUI and non-GUI implementation of the tab pages
6865 line.
6866 See |tab-page| for more information about tab pages.
6867
Bram Moolenaar071d4272004-06-13 20:20:40 +00006868 *'sidescroll'* *'ss'*
6869'sidescroll' 'ss' number (default 0)
6870 global
6871 {not in Vi}
6872 The minimal number of columns to scroll horizontally. Used only when
6873 the 'wrap' option is off and the cursor is moved off of the screen.
6874 When it is zero the cursor will be put in the middle of the screen.
6875 When using a slow terminal set it to a large number or 0. When using
6876 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6877 commands.
6878
6879 *'sidescrolloff'* *'siso'*
6880'sidescrolloff' 'siso' number (default 0)
6881 global
6882 {not in Vi}
6883 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006884 right of the cursor if 'nowrap' is set. Setting this option to a
6885 value greater than 0 while having |'sidescroll'| also at a non-zero
6886 value makes some context visible in the line you are scrolling in
6887 horizontally (except at beginning of the line). Setting this option
6888 to a large value (like 999) has the effect of keeping the cursor
6889 horizontally centered in the window, as long as one does not come too
6890 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006891 NOTE: This option is set to 0 when 'compatible' is set.
6892
6893 Example: Try this together with 'sidescroll' and 'listchars' as
6894 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006895 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006896
6897 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6898 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006899<
6900 *'signcolumn'* *'scl'*
6901'signcolumn' 'scl' string (default "auto")
6902 local to window
6903 {not in Vi}
6904 {not available when compiled without the |+signs|
6905 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02006906 Whether or not to draw the signcolumn. Valid values are:
6907 "auto" only when there is a sign to display
6908 "no" never
6909 "yes" always
Bram Moolenaar071d4272004-06-13 20:20:40 +00006910
6911
6912 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6913'smartcase' 'scs' boolean (default off)
6914 global
6915 {not in Vi}
6916 Override the 'ignorecase' option if the search pattern contains upper
6917 case characters. Only used when the search pattern is typed and
6918 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006919 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006920 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6921 recalling the search pattern from history and hitting <Enter>.
6922 NOTE: This option is reset when 'compatible' is set.
6923
6924 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6925'smartindent' 'si' boolean (default off)
6926 local to buffer
6927 {not in Vi}
6928 {not available when compiled without the
6929 |+smartindent| feature}
6930 Do smart autoindenting when starting a new line. Works for C-like
6931 programs, but can also be used for other languages. 'cindent' does
6932 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006933 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006934 setting 'si' has no effect. 'indentexpr' is a more advanced
6935 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006936 Normally 'autoindent' should also be on when using 'smartindent'.
6937 An indent is automatically inserted:
6938 - After a line ending in '{'.
6939 - After a line starting with a keyword from 'cinwords'.
6940 - Before a line starting with '}' (only with the "O" command).
6941 When typing '}' as the first character in a new line, that line is
6942 given the same indent as the matching '{'.
6943 When typing '#' as the first character in a new line, the indent for
6944 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006945 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006946 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6947 When using the ">>" command, lines starting with '#' are not shifted
6948 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006949 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006950 This option is reset when 'paste' is set and restored when 'paste' is
6951 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006952
6953 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6954'smarttab' 'sta' boolean (default off)
6955 global
6956 {not in Vi}
6957 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006958 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6959 <BS> will delete a 'shiftwidth' worth of space at the start of the
6960 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006961 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006962 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6963 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006964 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006965 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006966 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02006967 This option is reset when 'paste' is set and restored when 'paste' is
6968 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006969 NOTE: This option is reset when 'compatible' is set.
6970
6971 *'softtabstop'* *'sts'*
6972'softtabstop' 'sts' number (default 0)
6973 local to buffer
6974 {not in Vi}
6975 Number of spaces that a <Tab> counts for while performing editing
6976 operations, like inserting a <Tab> or using <BS>. It "feels" like
6977 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6978 used. This is useful to keep the 'ts' setting at its standard value
6979 of 8, while being able to edit like it is set to 'sts'. However,
6980 commands like "x" still work on the actual characters.
6981 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006982 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02006983 'softtabstop' is set to 0 when the 'paste' option is set and restored
6984 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006985 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6986 spaces is minimized by using <Tab>s.
6987 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6988 set.
6989 NOTE: This option is set to 0 when 'compatible' is set.
6990
Bram Moolenaar217ad922005-03-20 22:37:15 +00006991 *'spell'* *'nospell'*
6992'spell' boolean (default off)
6993 local to window
6994 {not in Vi}
6995 {not available when compiled without the |+syntax|
6996 feature}
6997 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006998 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006999
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007000 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007001'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007002 local to buffer
7003 {not in Vi}
7004 {not available when compiled without the |+syntax|
7005 feature}
7006 Pattern to locate the end of a sentence. The following word will be
7007 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007008 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007009 When this check is not wanted make this option empty.
7010 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007011 Be careful with special characters, see |option-backslash| about
7012 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007013 To set this option automatically depending on the language, see
7014 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007015
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007016 *'spellfile'* *'spf'*
7017'spellfile' 'spf' string (default empty)
7018 local to buffer
7019 {not in Vi}
7020 {not available when compiled without the |+syntax|
7021 feature}
7022 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007023 commands. It must end in ".{encoding}.add". You need to include the
7024 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007025 *E765*
7026 It may also be a comma separated list of names. A count before the
7027 |zg| and |zw| commands can be used to access each. This allows using
7028 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007029 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007030 you: Using the first directory in 'runtimepath' that is writable. If
7031 there is no "spell" directory yet it will be created. For the file
7032 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007033 ignoring the region.
7034 The resulting ".spl" file will be used for spell checking, it does not
7035 have to appear in 'spelllang'.
7036 Normally one file is used for all regions, but you can add the region
7037 name if you want to. However, it will then only be used when
7038 'spellfile' is set to it, for entries in 'spelllang' only files
7039 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007040 This option cannot be set from a |modeline| or in the |sandbox|, for
7041 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007042
Bram Moolenaar217ad922005-03-20 22:37:15 +00007043 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007044'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007045 local to buffer
7046 {not in Vi}
7047 {not available when compiled without the |+syntax|
7048 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007049 A comma separated list of word list names. When the 'spell' option is
7050 on spellchecking will be done for these languages. Example: >
7051 set spelllang=en_us,nl,medical
7052< This means US English, Dutch and medical words are recognized. Words
7053 that are not recognized will be highlighted.
7054 The word list name must not include a comma or dot. Using a dash is
7055 recommended to separate the two letter language name from a
7056 specification. Thus "en-rare" is used for rare English words.
7057 A region name must come last and have the form "_xx", where "xx" is
7058 the two-letter, lower case region name. You can use more than one
7059 region by listing them: "en_us,en_ca" supports both US and Canadian
7060 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007061 Britain. (Note: currently en_au and en_nz dictionaries are older than
7062 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007063 If the name "cjk" is included East Asian characters are excluded from
7064 spell checking. This is useful when editing text that also has Asian
7065 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007066 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007067 As a special case the name of a .spl file can be given as-is. The
7068 first "_xx" in the name is removed and used as the region name
7069 (_xx is an underscore, two letters and followed by a non-letter).
7070 This is mainly for testing purposes. You must make sure the correct
7071 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007072 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007073 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7074 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007075 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007076
Bram Moolenaar98692072006-02-04 00:57:42 +00007077 If the |spellfile.vim| plugin is active and you use a language name
7078 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7079 will ask you if you want to download the file.
7080
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007081 After this option has been set successfully, Vim will source the files
7082 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007083 up to the first comma, dot or underscore.
7084 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007085
7086
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007087 *'spellsuggest'* *'sps'*
7088'spellsuggest' 'sps' string (default "best")
7089 global
7090 {not in Vi}
7091 {not available when compiled without the |+syntax|
7092 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007093 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007094 the |spellsuggest()| function. This is a comma-separated list of
7095 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007096
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007097 best Internal method that works best for English. Finds
7098 changes like "fast" and uses a bit of sound-a-like
7099 scoring to improve the ordering.
7100
7101 double Internal method that uses two methods and mixes the
7102 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007103 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007104 word. That only works when the language specifies
7105 sound folding. Can be slow and doesn't always give
7106 better results.
7107
7108 fast Internal method that only checks for simple changes:
7109 character inserts/deletes/swaps. Works well for
7110 simple typing mistakes.
7111
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007112 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007113 Not used for |spellsuggest()|. The number of
7114 suggestions is never more than the value of 'lines'
7115 minus two.
7116
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007117 file:{filename} Read file {filename}, which must have two columns,
7118 separated by a slash. The first column contains the
7119 bad word, the second column the suggested good word.
7120 Example:
7121 theribal/terrible ~
7122 Use this for common mistakes that do not appear at the
7123 top of the suggestion list with the internal methods.
7124 Lines without a slash are ignored, use this for
7125 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007126 The word in the second column must be correct,
7127 otherwise it will not be used. Add the word to an
7128 ".add" file if it is currently flagged as a spelling
7129 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007130 The file is used for all languages.
7131
7132 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7133 trouble with spaces. |v:val| holds the badly spelled
7134 word. The expression must evaluate to a List of
7135 Lists, each with a suggestion and a score.
7136 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007137 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007138 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007139 internal methods use. A lower score is better.
7140 This may invoke |spellsuggest()| if you temporarily
7141 set 'spellsuggest' to exclude the "expr:" part.
7142 Errors are silently ignored, unless you set the
7143 'verbose' option to a non-zero value.
7144
7145 Only one of "best", "double" or "fast" may be used. The others may
7146 appear several times in any order. Example: >
7147 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7148<
7149 This option cannot be set from a |modeline| or in the |sandbox|, for
7150 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007151
7152
Bram Moolenaar071d4272004-06-13 20:20:40 +00007153 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7154'splitbelow' 'sb' boolean (default off)
7155 global
7156 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007157 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007158 feature}
7159 When on, splitting a window will put the new window below the current
7160 one. |:split|
7161
7162 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7163'splitright' 'spr' boolean (default off)
7164 global
7165 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007166 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007167 feature}
7168 When on, splitting a window will put the new window right of the
7169 current one. |:vsplit|
7170
7171 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7172'startofline' 'sol' boolean (default on)
7173 global
7174 {not in Vi}
7175 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007176 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007177 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007178 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007179 with a linewise operator, with "%" with a count and to buffer changing
7180 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7181 only has a line number, e.g., ":25" or ":+".
7182 In case of buffer changing commands the cursor is placed at the column
7183 where it was the last time the buffer was edited.
7184 NOTE: This option is set when 'compatible' is set.
7185
Bram Moolenaar00654022011-02-25 14:42:19 +01007186 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007187'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007188 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007189 {not in Vi}
7190 {not available when compiled without the |+statusline|
7191 feature}
7192 When nonempty, this option determines the content of the status line.
7193 Also see |status-line|.
7194
7195 The option consists of printf style '%' items interspersed with
7196 normal text. Each status line item is of the form:
7197 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007198 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01007199 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007200
Bram Moolenaar238a5642006-02-21 22:12:05 +00007201 When the option starts with "%!" then it is used as an expression,
7202 evaluated and the result is used as the option value. Example: >
7203 :set statusline=%!MyStatusLine()
7204< The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007205 Note that the "%!" expression is evaluated in the context of the
7206 current window and buffer, while %{} items are evaluated in the
7207 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007208
7209 When there is error while evaluating the option then it will be made
7210 empty to avoid further errors. Otherwise screen updating would loop.
7211
Bram Moolenaar071d4272004-06-13 20:20:40 +00007212 Note that the only effect of 'ruler' when this option is set (and
7213 'laststatus' is 2) is controlling the output of |CTRL-G|.
7214
7215 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007216 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007217 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007218 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007219 minwid Minimum width of the item, padding as set by '-' & '0'.
7220 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007221 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007222 on the left for text items. Numeric items will be
7223 shifted down to maxwid-2 digits followed by '>'number
7224 where number is the amount of missing digits, much like
7225 an exponential notation.
7226 item A one letter code as described below.
7227
7228 Following is a description of the possible statusline items. The
7229 second character in "item" is the type:
7230 N for number
7231 S for string
7232 F for flags as described below
7233 - not applicable
7234
7235 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007236 f S Path to the file in the buffer, as typed or relative to current
7237 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007238 F S Full path to the file in the buffer.
7239 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007240 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007241 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007242 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007243 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007244 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007245 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007246 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007247 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007248 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007249 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
7250 {not available when compiled without |+autocmd| feature}
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007251 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007252 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7253 being used: "<keymap>"
7254 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007255 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007256 B N As above, in hexadecimal.
7257 o N Byte number in file of byte under cursor, first byte is 1.
7258 Mnemonic: Offset from start of file (with one added)
7259 {not available when compiled without |+byte_offset| feature}
7260 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007261 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007262 l N Line number.
7263 L N Number of lines in buffer.
7264 c N Column number.
7265 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007266 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007267 p N Percentage through file in lines as in |CTRL-G|.
7268 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007269 percentage described for 'ruler'. Always 3 in length, unless
7270 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007271 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007272 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007273 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00007274 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007275 ( - Start of item group. Can be used for setting the width and
7276 alignment of a section. Must be followed by %) somewhere.
7277 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007278 T N For 'tabline': start of tab page N label. Use %T after the last
7279 label. This information is used for mouse clicks.
7280 X N For 'tabline': start of close tab N label. Use %X after the
7281 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7282 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007283 < - Where to truncate line if too long. Default is at the start.
7284 No width fields allowed.
7285 = - Separation point between left and right aligned items.
7286 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007287 # - Set highlight group. The name must follow and then a # again.
7288 Thus use %#HLname# for highlight group HLname. The same
7289 highlighting is used, also for the statusline of non-current
7290 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007291 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007292 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007293 The difference between User{N} and StatusLine will be applied
7294 to StatusLineNC for the statusline of non-current windows.
7295 The number N must be between 1 and 9. See |hl-User1..9|
7296
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007297 When displaying a flag, Vim removes the leading comma, if any, when
7298 that flag comes right after plaintext. This will make a nice display
7299 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007300
Bram Moolenaar582fd852005-03-28 20:58:01 +00007301 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007302 not set) and a minwid is not set for the group, the whole group will
7303 become empty. This will make a group like the following disappear
7304 completely from the statusline when none of the flags are set. >
7305 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaare392eb42015-11-19 20:38:09 +01007306< *g:actual_curbuf*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007307 Beware that an expression is evaluated each and every time the status
7308 line is displayed. The current buffer and current window will be set
7309 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007310 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007311 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007312 real current buffer.
7313
Bram Moolenaar30b65812012-07-12 22:01:11 +02007314 The 'statusline' option will be evaluated in the |sandbox| if set from
7315 a modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007316
7317 It is not allowed to change text or jump to another window while
7318 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007319
7320 If the statusline is not updated when you want it (e.g., after setting
7321 a variable that's used in an expression), you can force an update by
7322 setting an option without changing its value. Example: >
7323 :let &ro = &ro
7324
7325< A result of all digits is regarded a number for display purposes.
7326 Otherwise the result is taken as flag text and applied to the rules
7327 described above.
7328
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007329 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007330 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007331 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007332
7333 Examples:
7334 Emulate standard status line with 'ruler' set >
7335 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7336< Similar, but add ASCII value of char under the cursor (like "ga") >
7337 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7338< Display byte count and byte value, modified flag in red. >
7339 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7340 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7341< Display a ,GZ flag if a compressed file is loaded >
7342 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7343< In the |:autocmd|'s: >
7344 :let b:gzflag = 1
7345< And: >
7346 :unlet b:gzflag
7347< And define this function: >
7348 :function VarExists(var, val)
7349 : if exists(a:var) | return a:val | else | return '' | endif
7350 :endfunction
7351<
7352 *'suffixes'* *'su'*
7353'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7354 global
7355 {not in Vi}
7356 Files with these suffixes get a lower priority when multiple files
7357 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007358 suffixes. Spaces after the comma are ignored. A dot is also seen as
7359 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007360 separator, precede it with a backslash (see |option-backslash| about
7361 including spaces and backslashes).
7362 See 'wildignore' for completely ignoring files.
7363 The use of |:set+=| and |:set-=| is preferred when adding or removing
7364 suffixes from the list. This avoids problems when a future version
7365 uses another default.
7366
7367 *'suffixesadd'* *'sua'*
7368'suffixesadd' 'sua' string (default "")
7369 local to buffer
7370 {not in Vi}
7371 {not available when compiled without the
7372 |+file_in_path| feature}
7373 Comma separated list of suffixes, which are used when searching for a
7374 file for the "gf", "[I", etc. commands. Example: >
7375 :set suffixesadd=.java
7376<
7377 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7378'swapfile' 'swf' boolean (default on)
7379 local to buffer
7380 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007381 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007382 swapfile is not wanted for a specific buffer. For example, with
7383 confidential information that even root must not be able to access.
7384 Careful: All text will be in memory:
7385 - Don't use this for big files.
7386 - Recovery will be impossible!
7387 A swapfile will only be present when |'updatecount'| is non-zero and
7388 'swapfile' is set.
7389 When 'swapfile' is reset, the swap file for the current buffer is
7390 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7391 non-zero, a swap file is immediately created.
7392 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007393 If you want to open a new buffer without creating a swap file for it,
7394 use the |:noswapfile| modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007395
7396 This option is used together with 'bufhidden' and 'buftype' to
7397 specify special kinds of buffers. See |special-buffers|.
7398
7399 *'swapsync'* *'sws'*
7400'swapsync' 'sws' string (default "fsync")
7401 global
7402 {not in Vi}
7403 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007404 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007405 When this option is empty parts of the swap file may be in memory and
7406 not written to disk. When the system crashes you may lose more work.
7407 On Unix the system does a sync now and then without Vim asking for it,
7408 so the disadvantage of setting this option off is small. On some
7409 systems the swap file will not be written at all. For a unix system
7410 setting it to "sync" will use the sync() call instead of the default
7411 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007412 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007413
7414 *'switchbuf'* *'swb'*
7415'switchbuf' 'swb' string (default "")
7416 global
7417 {not in Vi}
7418 This option controls the behavior when switching between buffers.
7419 Possible values (comma separated list):
7420 useopen If included, jump to the first open window that
7421 contains the specified buffer (if there is one).
7422 Otherwise: Do not examine other windows.
7423 This setting is checked with |quickfix| commands, when
7424 jumping to errors (":cc", ":cn", "cp", etc.). It is
7425 also used in all buffer related split commands, for
7426 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007427 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007428 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007429 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007430 a buffer for a |quickfix| command that display errors.
7431 Otherwise: do not split, use current window.
Bram Moolenaara594d772015-06-19 14:41:49 +02007432 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007433 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007434 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007435
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007436 *'synmaxcol'* *'smc'*
7437'synmaxcol' 'smc' number (default 3000)
7438 local to buffer
7439 {not in Vi}
7440 {not available when compiled without the |+syntax|
7441 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007442 Maximum column in which to search for syntax items. In long lines the
7443 text after this column is not highlighted and following lines may not
7444 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007445 This helps to avoid very slow redrawing for an XML file that is one
7446 long line.
7447 Set to zero to remove the limit.
7448
Bram Moolenaar071d4272004-06-13 20:20:40 +00007449 *'syntax'* *'syn'*
7450'syntax' 'syn' string (default empty)
7451 local to buffer
7452 {not in Vi}
7453 {not available when compiled without the |+syntax|
7454 feature}
7455 When this option is set, the syntax with this name is loaded, unless
7456 syntax highlighting has been switched off with ":syntax off".
7457 Otherwise this option does not always reflect the current syntax (the
7458 b:current_syntax variable does).
7459 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007460 not automatically recognized. Example, in an IDL file:
7461 /* vim: set syntax=idl : */ ~
7462 When a dot appears in the value then this separates two filetype
7463 names. Example:
7464 /* vim: set syntax=c.doxygen : */ ~
7465 This will use the "c" syntax first, then the "doxygen" syntax.
7466 Note that the second one must be prepared to be loaded as an addition,
7467 otherwise it will be skipped. More than one dot may appear.
7468 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007469 :set syntax=OFF
7470< To switch syntax highlighting on according to the current value of the
7471 'filetype' option: >
7472 :set syntax=ON
7473< What actually happens when setting the 'syntax' option is that the
7474 Syntax autocommand event is triggered with the value as argument.
7475 This option is not copied to another buffer, independent of the 's' or
7476 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007477 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007478
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007479 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007480'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007481 global
7482 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007483 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007484 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007485 When nonempty, this option determines the content of the tab pages
7486 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007487 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007488
7489 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007490 option and only when there is no GUI tab line. When 'e' is in
7491 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007492 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007493
7494 The value is evaluated like with 'statusline'. You can use
7495 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007496 the text to be displayed. Use "%1T" for the first label, "%2T" for
7497 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007498
7499 Keep in mind that only one of the tab pages is the current one, others
7500 are invisible and you can't jump to their windows.
7501
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007502
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007503 *'tabpagemax'* *'tpm'*
7504'tabpagemax' 'tpm' number (default 10)
7505 global
7506 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007507 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007508 feature}
7509 Maximum number of tab pages to be opened by the |-p| command line
7510 argument or the ":tab all" command. |tabpage|
7511
7512
7513 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007514'tabstop' 'ts' number (default 8)
7515 local to buffer
7516 Number of spaces that a <Tab> in the file counts for. Also see
7517 |:retab| command, and 'softtabstop' option.
7518
7519 Note: Setting 'tabstop' to any other value than 8 can make your file
7520 appear wrong in many places (e.g., when printing it).
7521
7522 There are four main ways to use tabs in Vim:
7523 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7524 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007525 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007526 behave like a tab appears every 4 (or 3) characters.
7527 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7528 'expandtab'. This way you will always insert spaces. The
7529 formatting will never be messed up when 'tabstop' is changed.
7530 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007531 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007532 works when using Vim to edit the file.
7533 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7534 'noexpandtab'. This should then work (for initial indents only)
7535 for any tabstop setting that people use. It might be nice to have
7536 tabs after the first non-blank inserted as spaces if you do this
7537 though. Otherwise aligned comments will be wrong when 'tabstop' is
7538 changed.
7539
7540 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7541'tagbsearch' 'tbs' boolean (default on)
7542 global
7543 {not in Vi}
7544 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007545 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007546 searching makes searching for a tag a LOT faster, but a linear search
7547 will find more tags if the tags file wasn't properly sorted.
7548 Vim normally assumes that your tags files are sorted, or indicate that
7549 they are not sorted. Only when this is not the case does the
7550 'tagbsearch' option need to be switched off.
7551
7552 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007553 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007554 certain files, or retry all files with a linear search. When
7555 'tagbsearch' is off, only a linear search is done.
7556
7557 Linear searching is done anyway, for one file, when Vim finds a line
7558 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007559 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007560< [The whitespace before and after the '0' must be a single <Tab>]
7561
7562 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007563 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007564 instead of a normal tag name, a retry is done with a linear search.
7565 Tags in unsorted tags files, and matches with different case will only
7566 be found in the retry.
7567
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007568 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007569 linear search can be avoided when case is ignored. Use a value of '2'
7570 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7571 sorted with the -f switch to "sort" in most unices, as in the command:
7572 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7573 (at least 5.5) the --sort=foldcase switch can be used for this as
7574 well. Note that case must be folded to uppercase for this to work.
7575
7576 By default, tag searches are case-sensitive. Case is ignored when
7577 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7578 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007579 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7580 'tagcase' is "smart", and the pattern contains only lowercase
7581 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007582
7583 When 'tagbsearch' is off, tags searching is slower when a full match
7584 exists, but faster when no full match exists. Tags in unsorted tags
7585 files may only be found with 'tagbsearch' off.
7586 When the tags file is not sorted, or sorted in a wrong way (not on
7587 ASCII byte value), 'tagbsearch' should be off, or the line given above
7588 must be included in the tags file.
7589 This option doesn't affect commands that find all matching tags (e.g.,
7590 command-line completion and ":help").
7591 {Vi: always uses binary search in some versions}
7592
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007593 *'tagcase'* *'tc'*
7594'tagcase' 'tc' string (default "followic")
7595 global or local to buffer |global-local|
7596 {not in Vi}
7597 This option specifies how case is handled when searching the tags
7598 file:
7599 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007600 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007601 ignore Ignore case
7602 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007603 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007604 NOTE: This option is set to the Vi default value when 'compatible' is
7605 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007606
Bram Moolenaar071d4272004-06-13 20:20:40 +00007607 *'taglength'* *'tl'*
7608'taglength' 'tl' number (default 0)
7609 global
7610 If non-zero, tags are significant up to this number of characters.
7611
7612 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7613'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7614 global
7615 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007616 If on and using a tags file in another directory, file names in that
7617 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007618 NOTE: This option is set to the Vi default value when 'compatible' is
7619 set and to the Vim default value when 'compatible' is reset.
7620
7621 *'tags'* *'tag'* *E433*
7622'tags' 'tag' string (default "./tags,tags", when compiled with
7623 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7624 global or local to buffer |global-local|
7625 Filenames for the tag command, separated by spaces or commas. To
7626 include a space or comma in a file name, precede it with a backslash
7627 (see |option-backslash| about including spaces and backslashes).
7628 When a file name starts with "./", the '.' is replaced with the path
7629 of the current file. But only when the 'd' flag is not included in
7630 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7631 |tags-option|.
7632 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007633 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7634 find all files named "tags" below "/lib". The filename itself cannot
7635 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7636 files called "tags?". {not available when compiled without the
7637 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007638 The |tagfiles()| function can be used to get a list of the file names
7639 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007640 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7641 files are also supported. They are automatically recognized. The
7642 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7643 differences are ignored (MS-Windows). |emacs-tags|
7644 The use of |:set+=| and |:set-=| is preferred when adding or removing
7645 file names from the list. This avoids problems when a future version
7646 uses another default.
7647 {Vi: default is "tags /usr/lib/tags"}
7648
7649 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7650'tagstack' 'tgst' boolean (default on)
7651 global
7652 {not in all versions of Vi}
7653 When on, the |tagstack| is used normally. When off, a ":tag" or
7654 ":tselect" command with an argument will not push the tag onto the
7655 tagstack. A following ":tag" without an argument, a ":pop" command or
7656 any other command that uses the tagstack will use the unmodified
7657 tagstack, but does change the pointer to the active entry.
7658 Resetting this option is useful when using a ":tag" command in a
7659 mapping which should not change the tagstack.
7660
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007661 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007662'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007663 global
7664 {not in Vi}
7665 {only available when compiled with the |+tcl/dyn|
7666 feature}
7667 Specifies the name of the Tcl shared library. The default is
7668 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007669 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007670 This option cannot be set from a |modeline| or in the |sandbox|, for
7671 security reasons.
7672
Bram Moolenaar071d4272004-06-13 20:20:40 +00007673 *'term'* *E529* *E530* *E531*
7674'term' string (default is $TERM, if that fails:
7675 in the GUI: "builtin_gui"
7676 on Amiga: "amiga"
7677 on BeOS: "beos-ansi"
7678 on Mac: "mac-ansi"
7679 on MiNT: "vt52"
7680 on MS-DOS: "pcterm"
7681 on OS/2: "os2ansi"
7682 on Unix: "ansi"
7683 on VMS: "ansi"
7684 on Win 32: "win32")
7685 global
7686 Name of the terminal. Used for choosing the terminal control
7687 characters. Environment variables are expanded |:set_env|.
7688 For example: >
7689 :set term=$TERM
7690< See |termcap|.
7691
7692 *'termbidi'* *'tbidi'*
7693 *'notermbidi'* *'notbidi'*
7694'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7695 global
7696 {not in Vi}
7697 {only available when compiled with the |+arabic|
7698 feature}
7699 The terminal is in charge of Bi-directionality of text (as specified
7700 by Unicode). The terminal is also expected to do the required shaping
7701 that some languages (such as Arabic) require.
7702 Setting this option implies that 'rightleft' will not be set when
7703 'arabic' is set and the value of 'arabicshape' will be ignored.
7704 Note that setting 'termbidi' has the immediate effect that
7705 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7706 This option is reset when the GUI is started.
7707 For further details see |arabic.txt|.
7708
7709 *'termencoding'* *'tenc'*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007710'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8"; with
Bram Moolenaar071d4272004-06-13 20:20:40 +00007711 Macintosh GUI: "macroman")
7712 global
7713 {only available when compiled with the |+multi_byte|
7714 feature}
7715 {not in Vi}
7716 Encoding used for the terminal. This specifies what character
7717 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007718 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007719 display). Except for the Mac when 'macatsui' is off, then
7720 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007721 *E617*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007722 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007723 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7724 Any attempts to set a different value will be rejected, and an error
7725 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007726 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007727 because the Win32 system always passes Unicode characters.
7728 When empty, the same encoding is used as for the 'encoding' option.
7729 This is the normal value.
7730 Not all combinations for 'termencoding' and 'encoding' are valid. See
7731 |encoding-table|.
7732 The value for this option must be supported by internal conversions or
7733 iconv(). When this is not possible no conversion will be done and you
7734 will probably experience problems with non-ASCII characters.
7735 Example: You are working with the locale set to euc-jp (Japanese) and
7736 want to edit a UTF-8 file: >
7737 :let &termencoding = &encoding
7738 :set encoding=utf-8
7739< You need to do this when your system has no locale support for UTF-8.
7740
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007741 *'termguicolors'* *'tgc'*
7742'termguicolors' 'tgc' boolean (default off)
7743 global
7744 {not in Vi}
7745 {not available when compiled without the
7746 |+termguicolors| feature}
7747 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
7748 the terminal (thus using 24-bit color). Requires a ISO-8613-3
7749 compatible terminal.
7750 If setting this option does not work (produces a colorless UI)
7751 reading |xterm-true-color| might help.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007752 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007753 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007754
Bram Moolenaar74675a62017-07-15 13:53:23 +02007755 *'termkey'* *'tk'*
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007756'termkey' 'tk' string (default "CTRL-W")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007757 local to window
7758 {not in Vi}
7759 The key that precedes a Vim command in a terminal window. Other keys
7760 are sent to the job running in the window.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007761 The string must be one key stroke but can be multiple bytes.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007762 NOT IMPLEMENTED YET
7763
7764
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007765 *'termsize'* *'tms'*
Bram Moolenaar74675a62017-07-15 13:53:23 +02007766'termsize' 'tms' string (default "")
7767 local to window
7768 {not in Vi}
7769 Size of the |terminal| window. Format: {rows}x{columns}.
7770 - When empty the terminal gets the size from the window.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007771 - When set (e.g., "24x80") the terminal size is not adjusted to the
7772 window size. If the window is smaller only the top-left part is
7773 displayed.
7774 When rows is zero then use the height of the window.
7775 When columns is zero then use the width of the window.
7776 For example: "30x0" uses 30 rows with the current window width.
7777 Using "0x0" is the same as empty.
7778 Note that the command running in the terminal window may still change
7779 the size of the terminal. In that case the Vim window will be
7780 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007781
Bram Moolenaar071d4272004-06-13 20:20:40 +00007782 *'terse'* *'noterse'*
7783'terse' boolean (default off)
7784 global
7785 When set: Add 's' flag to 'shortmess' option (this makes the message
7786 for a search that hits the start or end of the file not being
7787 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7788 shortens a lot of messages}
7789
7790 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7791'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7792 global
7793 {not in Vi}
7794 This option is obsolete. Use 'fileformats'.
7795 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7796 set to the default value for the current system. When 'textauto' is
7797 reset, 'fileformats' is made empty.
7798 NOTE: This option is set to the Vi default value when 'compatible' is
7799 set and to the Vim default value when 'compatible' is reset.
7800
7801 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7802'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7803 others: default off)
7804 local to buffer
7805 {not in Vi}
7806 This option is obsolete. Use 'fileformat'.
7807 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7808 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7809 "unix".
7810
7811 *'textwidth'* *'tw'*
7812'textwidth' 'tw' number (default 0)
7813 local to buffer
7814 {not in Vi}
7815 Maximum width of text that is being inserted. A longer line will be
7816 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02007817 this.
7818 'textwidth' is set to 0 when the 'paste' option is set and restored
7819 when 'paste' is reset.
7820 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007821 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007822 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007823 NOTE: This option is set to 0 when 'compatible' is set.
7824
7825 *'thesaurus'* *'tsr'*
7826'thesaurus' 'tsr' string (default "")
7827 global or local to buffer |global-local|
7828 {not in Vi}
7829 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007830 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00007831 the file should contain words with similar meaning, separated by
7832 non-keyword characters (white space is preferred). Maximum line
7833 length is 510 bytes.
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02007834 To obtain a file to be used here, check out this ftp site:
Bram Moolenaar38a55632016-02-15 22:07:32 +01007835 [Sorry this link doesn't work anymore, do you know the right one?]
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02007836 ftp://ftp.ox.ac.uk/pub/wordlists/ First get the README file.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007837 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007838 after a comma are ignored, otherwise spaces are included in the file
7839 name. See |option-backslash| about using backslashes.
7840 The use of |:set+=| and |:set-=| is preferred when adding or removing
7841 directories from the list. This avoids problems when a future version
7842 uses another default.
7843 Backticks cannot be used in this option for security reasons.
7844
7845 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7846'tildeop' 'top' boolean (default off)
7847 global
7848 {not in Vi}
7849 When on: The tilde command "~" behaves like an operator.
7850 NOTE: This option is reset when 'compatible' is set.
7851
7852 *'timeout'* *'to'* *'notimeout'* *'noto'*
7853'timeout' 'to' boolean (default on)
7854 global
7855 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007856'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007857 global
7858 {not in Vi}
7859 These two options together determine the behavior when part of a
7860 mapped key sequence or keyboard code has been received:
7861
7862 'timeout' 'ttimeout' action ~
7863 off off do not time out
7864 on on or off time out on :mappings and key codes
7865 off on time out on key codes
7866
7867 If both options are off, Vim will wait until either the complete
7868 mapping or key sequence has been received, or it is clear that there
7869 is no mapping or key sequence for the received characters. For
7870 example: if you have mapped "vl" and Vim has received 'v', the next
7871 character is needed to see if the 'v' is followed by an 'l'.
7872 When one of the options is on, Vim will wait for about 1 second for
7873 the next character to arrive. After that the already received
7874 characters are interpreted as single characters. The waiting time can
7875 be changed with the 'timeoutlen' option.
7876 On slow terminals or very busy systems timing out may cause
7877 malfunctioning cursor keys. If both options are off, Vim waits
7878 forever after an entered <Esc> if there are key codes that start
7879 with <Esc>. You will have to type <Esc> twice. If you do not have
7880 problems with key codes, but would like to have :mapped key
7881 sequences not timing out in 1 second, set the 'ttimeout' option and
7882 reset the 'timeout' option.
7883
7884 NOTE: 'ttimeout' is reset when 'compatible' is set.
7885
7886 *'timeoutlen'* *'tm'*
7887'timeoutlen' 'tm' number (default 1000)
7888 global
7889 {not in all versions of Vi}
7890 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007891'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007892 global
7893 {not in Vi}
7894 The time in milliseconds that is waited for a key code or mapped key
7895 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7896 when part of a command has been typed.
7897 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7898 different timeout value for key codes is desired set 'ttimeoutlen' to
7899 a non-negative number.
7900
7901 ttimeoutlen mapping delay key code delay ~
7902 < 0 'timeoutlen' 'timeoutlen'
7903 >= 0 'timeoutlen' 'ttimeoutlen'
7904
7905 The timeout only happens when the 'timeout' and 'ttimeout' options
7906 tell so. A useful setting would be >
7907 :set timeout timeoutlen=3000 ttimeoutlen=100
7908< (time out on mapping after three seconds, time out on key codes after
7909 a tenth of a second).
7910
7911 *'title'* *'notitle'*
7912'title' boolean (default off, on when title can be restored)
7913 global
7914 {not in Vi}
7915 {not available when compiled without the |+title|
7916 feature}
7917 When on, the title of the window will be set to the value of
7918 'titlestring' (if it is not empty), or to:
7919 filename [+=-] (path) - VIM
7920 Where:
7921 filename the name of the file being edited
7922 - indicates the file cannot be modified, 'ma' off
7923 + indicates the file was modified
7924 = indicates the file is read-only
7925 =+ indicates the file is read-only and modified
7926 (path) is the path of the file being edited
7927 - VIM the server name |v:servername| or "VIM"
7928 Only works if the terminal supports setting window titles
7929 (currently Amiga console, Win32 console, all GUI versions and
7930 terminals with a non- empty 't_ts' option - these are Unix xterm and
7931 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7932 *X11*
7933 When Vim was compiled with HAVE_X11 defined, the original title will
7934 be restored if possible. The output of ":version" will include "+X11"
7935 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7936 works for the icon name |'icon'|.
7937 But: When Vim was started with the |-X| argument, restoring the title
7938 will not work (except in the GUI).
7939 If the title cannot be restored, it is set to the value of 'titleold'.
7940 You might want to restore the title outside of Vim then.
7941 When using an xterm from a remote machine you can use this command:
7942 rsh machine_name xterm -display $DISPLAY &
7943 then the WINDOWID environment variable should be inherited and the
7944 title of the window should change back to what it should be after
7945 exiting Vim.
7946
7947 *'titlelen'*
7948'titlelen' number (default 85)
7949 global
7950 {not in Vi}
7951 {not available when compiled without the |+title|
7952 feature}
7953 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007954 title. When the title is longer, only the end of the path name is
7955 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007956 Using a percentage makes this adapt to the width of the window. But
7957 it won't work perfectly, because the actual number of characters
7958 available also depends on the font used and other things in the title
7959 bar. When 'titlelen' is zero the full path is used. Otherwise,
7960 values from 1 to 30000 percent can be used.
7961 'titlelen' is also used for the 'titlestring' option.
7962
7963 *'titleold'*
7964'titleold' string (default "Thanks for flying Vim")
7965 global
7966 {not in Vi}
7967 {only available when compiled with the |+title|
7968 feature}
7969 This option will be used for the window title when exiting Vim if the
7970 original title cannot be restored. Only happens if 'title' is on or
7971 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007972 This option cannot be set from a |modeline| or in the |sandbox|, for
7973 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007974 *'titlestring'*
7975'titlestring' string (default "")
7976 global
7977 {not in Vi}
7978 {not available when compiled without the |+title|
7979 feature}
7980 When this option is not empty, it will be used for the title of the
7981 window. This happens only when the 'title' option is on.
7982 Only works if the terminal supports setting window titles (currently
7983 Amiga console, Win32 console, all GUI versions and terminals with a
7984 non-empty 't_ts' option).
7985 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01007986 be restored if possible, see |X11|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007987 When this option contains printf-style '%' items, they will be
7988 expanded according to the rules used for 'statusline'.
7989 Example: >
7990 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7991 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7992< The value of 'titlelen' is used to align items in the middle or right
7993 of the available space.
7994 Some people prefer to have the file name first: >
7995 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7996< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007997 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007998 separating space only when needed.
7999 NOTE: Use of special characters in 'titlestring' may cause the display
8000 to be garbled (e.g., when it contains a CR or NL character).
8001 {not available when compiled without the |+statusline| feature}
8002
8003 *'toolbar'* *'tb'*
8004'toolbar' 'tb' string (default "icons,tooltips")
8005 global
8006 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8007 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008008 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008009 possible values are:
8010 icons Toolbar buttons are shown with icons.
8011 text Toolbar buttons shown with text.
8012 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008013 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008014 tooltips Tooltips are active for toolbar buttons.
8015 Tooltips refer to the popup help text which appears after the mouse
8016 cursor is placed over a toolbar button for a brief moment.
8017
8018 If you want the toolbar to be shown with icons as well as text, do the
8019 following: >
8020 :set tb=icons,text
8021< Motif and Athena cannot display icons and text at the same time. They
8022 will show icons if both are requested.
8023
8024 If none of the strings specified in 'toolbar' are valid or if
8025 'toolbar' is empty, this option is ignored. If you want to disable
8026 the toolbar, you need to set the 'guioptions' option. For example: >
8027 :set guioptions-=T
8028< Also see |gui-toolbar|.
8029
8030 *'toolbariconsize'* *'tbis'*
8031'toolbariconsize' 'tbis' string (default "small")
8032 global
8033 {not in Vi}
Bram Moolenaar3df01732017-02-17 22:47:16 +01008034 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008035 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008036 tiny Use tiny icons.
8037 small Use small icons (default).
8038 medium Use medium-sized icons.
8039 large Use large icons.
8040 huge Use even larger icons.
8041 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008042 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008043 the current theme. Common dimensions are giant=48x48, huge=32x32,
8044 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008045
8046 If 'toolbariconsize' is empty, the global default size as determined
8047 by user preferences or the current theme is used.
8048
8049 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8050'ttybuiltin' 'tbi' boolean (default on)
8051 global
8052 {not in Vi}
8053 When on, the builtin termcaps are searched before the external ones.
8054 When off the builtin termcaps are searched after the external ones.
8055 When this option is changed, you should set the 'term' option next for
8056 the change to take effect, for example: >
8057 :set notbi term=$TERM
8058< See also |termcap|.
8059 Rationale: The default for this option is "on", because the builtin
8060 termcap entries are generally better (many systems contain faulty
8061 xterm entries...).
8062
8063 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8064'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8065 sun-cmd, screen, rxvt, dtterm or
8066 iris-ansi; also on when running Vim in
8067 a DOS console)
8068 global
8069 {not in Vi}
8070 Indicates a fast terminal connection. More characters will be sent to
8071 the screen for redrawing, instead of using insert/delete line
8072 commands. Improves smoothness of redrawing when there are multiple
8073 windows and the terminal does not support a scrolling region.
8074 Also enables the extra writing of characters at the end of each screen
8075 line for lines that wrap. This helps when using copy/paste with the
8076 mouse in an xterm and other terminals.
8077
8078 *'ttymouse'* *'ttym'*
8079'ttymouse' 'ttym' string (default depends on 'term')
8080 global
8081 {not in Vi}
8082 {only in Unix and VMS, doesn't work in the GUI; not
8083 available when compiled without |+mouse|}
8084 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008085 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008086 *xterm-mouse*
8087 xterm xterm-like mouse handling. The mouse generates
8088 "<Esc>[Mscr", where "scr" is three bytes:
8089 "s" = button state
8090 "c" = column plus 33
8091 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008092 This only works up to 223 columns! See "dec",
8093 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008094 xterm2 Works like "xterm", but with the xterm reporting the
8095 mouse position while the mouse is dragged. This works
8096 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008097 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008098 work. See below for how Vim detects this
8099 automatically.
8100 *netterm-mouse*
8101 netterm NetTerm mouse handling. The mouse generates
8102 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
8103 for the row and column.
8104 *dec-mouse*
8105 dec DEC terminal mouse handling. The mouse generates a
8106 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008107 This is also available for an Xterm, if it was
8108 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008109 *jsbterm-mouse*
8110 jsbterm JSB term mouse handling.
8111 *pterm-mouse*
8112 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008113 *urxvt-mouse*
8114 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008115 The mouse works only if the terminal supports this
8116 encoding style, but it does not have 223 columns limit
8117 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008118 *sgr-mouse*
8119 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008120 mouse reporting. The mouse works even in columns
8121 beyond 223. This option is backward compatible with
8122 "xterm2" because it can also decode "xterm2" style
8123 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008124
8125 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008126 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8127 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008128 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8129 recognized, if enabled at compile time. DEC terminal mouse codes
8130 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008131 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8132 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008133 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008134 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8135 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8136 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008137 Additionally, if vim is compiled with the |+termresponse| feature and
8138 |t_RV| is set to the escape sequence to request the xterm version
8139 number, more intelligent detection process runs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008140 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaare968e362014-05-13 20:23:24 +02008141 from 95 to 276. The "sgr" value will be set if the xterm version is
8142 277 or highter.
8143 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8144 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008145 :set t_RV=
8146<
8147 *'ttyscroll'* *'tsl'*
8148'ttyscroll' 'tsl' number (default 999)
8149 global
8150 Maximum number of lines to scroll the screen. If there are more lines
8151 to scroll the window is redrawn. For terminals where scrolling is
8152 very slow and redrawing is not slow this can be set to a small number,
8153 e.g., 3, to speed up displaying.
8154
8155 *'ttytype'* *'tty'*
8156'ttytype' 'tty' string (default from $TERM)
8157 global
8158 Alias for 'term', see above.
8159
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008160 *'undodir'* *'udir'*
8161'undodir' 'udir' string (default ".")
8162 global
8163 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008164 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008165 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008166 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008167 "." means using the directory of the file. The undo file name for
8168 "file.txt" is ".file.txt.un~".
8169 For other directories the file name is the full path of the edited
8170 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008171 When writing: The first directory that exists is used. "." always
8172 works, no directories after "." will be used for writing.
8173 When reading all entries are tried to find an undo file. The first
8174 undo file that exists is used. When it cannot be read an error is
8175 given, no further entry is used.
8176 See |undo-persistence|.
8177
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008178 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008179'undofile' 'udf' boolean (default off)
8180 local to buffer
8181 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008182 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008183 When on, Vim automatically saves undo history to an undo file when
8184 writing a buffer to a file, and restores undo history from the same
8185 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008186 The directory where the undo file is stored is specified by 'undodir'.
8187 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008188 The undo file is not read when 'undoreload' causes the buffer from
8189 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008190 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008191 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008192
Bram Moolenaar071d4272004-06-13 20:20:40 +00008193 *'undolevels'* *'ul'*
8194'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
8195 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008196 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008197 {not in Vi}
8198 Maximum number of changes that can be undone. Since undo information
8199 is kept in memory, higher numbers will cause more memory to be used
8200 (nevertheless, a single change can use an unlimited amount of memory).
8201 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8202 itself: >
8203 set ul=0
8204< But you can also get Vi compatibility by including the 'u' flag in
8205 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008206 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008207 Set to -1 for no undo at all. You might want to do this only for the
8208 current buffer: >
8209 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008210< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008211
8212 The local value is set to -123456 when the global value is to be used.
8213
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008214 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008215
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008216 *'undoreload'* *'ur'*
8217'undoreload' 'ur' number (default 10000)
8218 global
8219 {not in Vi}
8220 Save the whole buffer for undo when reloading it. This applies to the
8221 ":e!" command and reloading for when the buffer changed outside of
8222 Vim. |FileChangedShell|
8223 The save only happens when this options is negative or when the number
8224 of lines is smaller than the value of this option.
8225 Set this option to zero to disable undo for a reload.
8226
8227 When saving undo for a reload, any undo file is not read.
8228
8229 Note that this causes the whole buffer to be stored in memory. Set
8230 this option to a lower value if you run out of memory.
8231
Bram Moolenaar071d4272004-06-13 20:20:40 +00008232 *'updatecount'* *'uc'*
8233'updatecount' 'uc' number (default: 200)
8234 global
8235 {not in Vi}
8236 After typing this many characters the swap file will be written to
8237 disk. When zero, no swap file will be created at all (see chapter on
8238 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8239 Vim with the "-n" option, see |startup|. When editing in readonly
8240 mode this option will be initialized to 10000.
8241 The swapfile can be disabled per buffer with |'swapfile'|.
8242 When 'updatecount' is set from zero to non-zero, swap files are
8243 created for all buffers that have 'swapfile' set. When 'updatecount'
8244 is set to zero, existing swap files are not deleted.
8245 Also see |'swapsync'|.
8246 This option has no meaning in buffers where |'buftype'| is "nofile"
8247 or "nowrite".
8248
8249 *'updatetime'* *'ut'*
8250'updatetime' 'ut' number (default 4000)
8251 global
8252 {not in Vi}
8253 If this many milliseconds nothing is typed the swap file will be
8254 written to disk (see |crash-recovery|). Also used for the
8255 |CursorHold| autocommand event.
8256
8257 *'verbose'* *'vbs'*
8258'verbose' 'vbs' number (default 0)
8259 global
8260 {not in Vi, although some versions have a boolean
8261 verbose option}
8262 When bigger than zero, Vim will give messages about what it is doing.
8263 Currently, these messages are given:
8264 >= 1 When the viminfo file is read or written.
8265 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008266 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008267 >= 8 Files for which a group of autocommands is executed.
8268 >= 9 Every executed autocommand.
8269 >= 12 Every executed function.
8270 >= 13 When an exception is thrown, caught, finished, or discarded.
8271 >= 14 Anything pending in a ":finally" clause.
8272 >= 15 Every executed Ex command (truncated at 200 characters).
8273
8274 This option can also be set with the "-V" argument. See |-V|.
8275 This option is also set by the |:verbose| command.
8276
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008277 When the 'verbosefile' option is set then the verbose messages are not
8278 displayed.
8279
8280 *'verbosefile'* *'vfile'*
8281'verbosefile' 'vfile' string (default empty)
8282 global
8283 {not in Vi}
8284 When not empty all messages are written in a file with this name.
8285 When the file exists messages are appended.
8286 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008287 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008288 Setting 'verbosefile' to a new value is like making it empty first.
8289 The difference with |:redir| is that verbose messages are not
8290 displayed when 'verbosefile' is set.
8291
Bram Moolenaar071d4272004-06-13 20:20:40 +00008292 *'viewdir'* *'vdir'*
8293'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
8294 "$VIM/vimfiles/view",
8295 for Unix: "~/.vim/view",
8296 for Macintosh: "$VIM:vimfiles:view"
8297 for VMS: "sys$login:vimfiles/view"
8298 for RiscOS: "Choices:vimfiles/view")
8299 global
8300 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008301 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008302 feature}
8303 Name of the directory where to store files for |:mkview|.
8304 This option cannot be set from a |modeline| or in the |sandbox|, for
8305 security reasons.
8306
8307 *'viewoptions'* *'vop'*
8308'viewoptions' 'vop' string (default: "folds,options,cursor")
8309 global
8310 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008311 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008312 feature}
8313 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008314 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008315 word save and restore ~
8316 cursor cursor position in file and in window
8317 folds manually created folds, opened/closed folds and local
8318 fold options
8319 options options and mappings local to a window or buffer (not
8320 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008321 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008322 slash backslashes in file names replaced with forward
8323 slashes
8324 unix with Unix end-of-line format (single <NL>), even when
8325 on Windows or DOS
8326
8327 "slash" and "unix" are useful on Windows when sharing view files
8328 with Unix. The Unix version of Vim cannot source dos format scripts,
8329 but the Windows version of Vim can source unix format scripts.
8330
8331 *'viminfo'* *'vi'* *E526* *E527* *E528*
8332'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008333 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
8334 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8335 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008336 global
8337 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008338 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008339 feature}
8340 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008341 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8342 "NONE".
8343 The string should be a comma separated list of parameters, each
8344 consisting of a single character identifying the particular parameter,
8345 followed by a number or string which specifies the value of that
8346 parameter. If a particular character is left out, then the default
8347 value is used for that parameter. The following is a list of the
8348 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008349 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008350 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008351 ! When included, save and restore global variables that start
8352 with an uppercase letter, and don't contain a lowercase
8353 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008354 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008355 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008356 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008357 " Maximum number of lines saved for each register. Old name of
8358 the '<' item, with the disadvantage that you need to put a
8359 backslash before the ", otherwise it will be recognized as the
8360 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008361 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008362 % When included, save and restore the buffer list. If Vim is
8363 started with a file name argument, the buffer list is not
8364 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008365 buffer list is restored from the viminfo file. Quickfix
8366 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8367 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008368 When followed by a number, the number specifies the maximum
8369 number of buffers that are stored. Without a number all
8370 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008371 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008372 ' Maximum number of previously edited files for which the marks
8373 are remembered. This parameter must always be included when
8374 'viminfo' is non-empty.
8375 Including this item also means that the |jumplist| and the
8376 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008377 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008378 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008379 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008380 patterns are also saved. When not included, the value of
8381 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008382 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008383 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008384 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008385 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008386 < Maximum number of lines saved for each register. If zero then
8387 registers are not saved. When not included, all lines are
8388 saved. '"' is the old name for this item.
8389 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008390 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008391 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008392 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008393 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008394 c When included, convert the text in the viminfo file from the
8395 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008396 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008397 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008398 f Whether file marks need to be stored. If zero, file marks ('0
8399 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008400 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008401 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008402 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008403 h Disable the effect of 'hlsearch' when loading the viminfo
8404 file. When not included, it depends on whether ":nohlsearch"
8405 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008406 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008407 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008408 the 'n'. Must be at the end of the option! If the
8409 'viminfofile' option is set, that file name overrides the one
8410 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008411 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008412 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008413 r Removable media. The argument is a string (up to the next
8414 ','). This parameter can be given several times. Each
8415 specifies the start of a path for which no marks will be
8416 stored. This is to avoid removable media. For MS-DOS you
8417 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8418 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8419 ignored. Maximum length of each 'r' argument is 50
8420 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008421 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008422 s Maximum size of an item in Kbyte. If zero then registers are
8423 not saved. Currently only applies to registers. The default
8424 "s10" will exclude registers with more than 10 Kbyte of text.
8425 Also see the '<' item above: line count limit.
8426
8427 Example: >
8428 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8429<
8430 '50 Marks will be remembered for the last 50 files you
8431 edited.
8432 <1000 Contents of registers (up to 1000 lines each) will be
8433 remembered.
8434 s100 Registers with more than 100 Kbyte text are skipped.
8435 :0 Command-line history will not be saved.
8436 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8437 no / Since '/' is not specified, the default will be used,
8438 that is, save all of the search history, and also the
8439 previous search and substitute patterns.
8440 no % The buffer list will not be saved nor read back.
8441 no h 'hlsearch' highlighting will be restored.
8442
8443 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8444 load the contents of the file, this is not done automatically.
8445
8446 This option cannot be set from a |modeline| or in the |sandbox|, for
8447 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008448 NOTE: This option is set to the Vim default value when 'compatible'
8449 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008450
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008451 *'viminfofile'* *'vif'*
8452'viminfofile' 'vif' string (default: "")
8453 global
8454 {not in Vi}
8455 {not available when compiled without the |+viminfo|
8456 feature}
8457 When non-empty, overrides the file name used for viminfo.
8458 When equal to "NONE" no viminfo file will be read or written.
8459 This option can be set with the |-i| command line flag. The |--clean|
8460 command line flag sets it to "NONE".
8461
Bram Moolenaar071d4272004-06-13 20:20:40 +00008462 *'virtualedit'* *'ve'*
8463'virtualedit' 've' string (default "")
8464 global
8465 {not in Vi}
8466 {not available when compiled without the
8467 |+virtualedit| feature}
8468 A comma separated list of these words:
8469 block Allow virtual editing in Visual block mode.
8470 insert Allow virtual editing in Insert mode.
8471 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008472 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008473
Bram Moolenaar071d4272004-06-13 20:20:40 +00008474 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008475 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008476 of the line. Useful for selecting a rectangle in Visual mode and
8477 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008478 "onemore" is not the same, it will only allow moving the cursor just
8479 after the last character of the line. This makes some commands more
8480 consistent. Previously the cursor was always past the end of the line
8481 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008482 break some plugins or Vim scripts. For example because |l| can move
8483 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008484 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008485 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008486 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008487 It doesn't make sense to combine "all" with "onemore", but you will
8488 not get a warning for it.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008489 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008490
8491 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8492'visualbell' 'vb' boolean (default off)
8493 global
8494 {not in Vi}
Bram Moolenaar74675a62017-07-15 13:53:23 +02008495 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008496 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008497 use: >
8498 :set vb t_vb=
8499< If you want a short flash, you can use this on many terminals: >
8500 :set vb t_vb=[?5h$<100>[?5l
8501< Here $<100> specifies the time, you can use a smaller or bigger value
8502 to get a shorter or longer flash.
8503
8504 Note: Vim will limit the bell to once per half a second. This avoids
8505 having to wait for the flashing to finish when there are lots of
8506 bells, e.g. on key repeat. This also happens without 'visualbell'
8507 set.
8508
Bram Moolenaar071d4272004-06-13 20:20:40 +00008509 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8510 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8511 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008512
8513 Note: When the GUI starts, 't_vb' is reset to its default value. You
8514 might want to set it again in your |gvimrc|.
8515
Bram Moolenaar071d4272004-06-13 20:20:40 +00008516 Does not work on the Amiga, you always get a screen flash.
8517 Also see 'errorbells'.
8518
8519 *'warn'* *'nowarn'*
8520'warn' boolean (default on)
8521 global
8522 Give a warning message when a shell command is used while the buffer
8523 has been changed.
8524
8525 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8526'weirdinvert' 'wiv' boolean (default off)
8527 global
8528 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008529 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008530 It is provided for backwards compatibility with version 4.x.
8531 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8532 vice versa. Has no effect when the GUI is running.
8533
8534 *'whichwrap'* *'ww'*
8535'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8536 global
8537 {not in Vi}
8538 Allow specified keys that move the cursor left/right to move to the
8539 previous/next line when the cursor is on the first/last character in
8540 the line. Concatenate characters to allow this for these keys:
8541 char key mode ~
8542 b <BS> Normal and Visual
8543 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008544 h "h" Normal and Visual (not recommended)
8545 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008546 < <Left> Normal and Visual
8547 > <Right> Normal and Visual
8548 ~ "~" Normal
8549 [ <Left> Insert and Replace
8550 ] <Right> Insert and Replace
8551 For example: >
8552 :set ww=<,>,[,]
8553< allows wrap only when cursor keys are used.
8554 When the movement keys are used in combination with a delete or change
8555 operator, the <EOL> also counts for a character. This makes "3h"
8556 different from "3dh" when the cursor crosses the end of a line. This
8557 is also true for "x" and "X", because they do the same as "dl" and
8558 "dh". If you use this, you may also want to use the mapping
8559 ":map <BS> X" to make backspace delete the character in front of the
8560 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008561 When 'l' is included and it is used after an operator at the end of a
8562 line then it will not move to the next line. This makes "dl", "cl",
8563 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008564 NOTE: This option is set to the Vi default value when 'compatible' is
8565 set and to the Vim default value when 'compatible' is reset.
8566
8567 *'wildchar'* *'wc'*
8568'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8569 global
8570 {not in Vi}
8571 Character you have to type to start wildcard expansion in the
8572 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008573 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008574 The character is not recognized when used inside a macro. See
8575 'wildcharm' for that.
8576 Although 'wc' is a number option, you can set it to a special key: >
8577 :set wc=<Esc>
8578< NOTE: This option is set to the Vi default value when 'compatible' is
8579 set and to the Vim default value when 'compatible' is reset.
8580
8581 *'wildcharm'* *'wcm'*
8582'wildcharm' 'wcm' number (default: none (0))
8583 global
8584 {not in Vi}
8585 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008586 recognized when used inside a macro. You can find "spare" command-line
8587 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008588 you'll never actually type 'wildcharm', just use it in mappings that
8589 automatically invoke completion mode, e.g.: >
8590 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008591 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008592< Then after typing :ss you can use CTRL-P & CTRL-N.
8593
8594 *'wildignore'* *'wig'*
8595'wildignore' 'wig' string (default "")
8596 global
8597 {not in Vi}
8598 {not available when compiled without the |+wildignore|
8599 feature}
8600 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008601 patterns is ignored when expanding |wildcards|, completing file or
8602 directory names, and influences the result of |expand()|, |glob()| and
8603 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008604 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8605 Also see 'suffixes'.
8606 Example: >
8607 :set wildignore=*.o,*.obj
8608< The use of |:set+=| and |:set-=| is preferred when adding or removing
8609 a pattern from the list. This avoids problems when a future version
8610 uses another default.
8611
Bram Moolenaar94950a92010-12-02 16:01:29 +01008612
Bram Moolenaar81af9252010-12-10 20:35:50 +01008613 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008614'wildignorecase' 'wic' boolean (default off)
8615 global
8616 {not in Vi}
8617 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008618 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008619 Does not apply when the shell is used to expand wildcards, which
8620 happens when there are special characters.
8621
8622
Bram Moolenaar071d4272004-06-13 20:20:40 +00008623 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008624'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008625 global
8626 {not in Vi}
8627 {not available if compiled without the |+wildmenu|
8628 feature}
8629 When 'wildmenu' is on, command-line completion operates in an enhanced
8630 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8631 the possible matches are shown just above the command line, with the
8632 first match highlighted (overwriting the status line, if there is
8633 one). Keys that show the previous/next match, such as <Tab> or
8634 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8635 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8636 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008637 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008638 If there are more matches than can fit in the line, a ">" is shown on
8639 the right and/or a "<" is shown on the left. The status line scrolls
8640 as needed.
8641 The "wildmenu" mode is abandoned when a key is hit that is not used
8642 for selecting a completion.
8643 While the "wildmenu" is active the following keys have special
8644 meanings:
8645
8646 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8647 <Down> - in filename/menu name completion: move into a
8648 subdirectory or submenu.
8649 <CR> - in menu completion, when the cursor is just after a
8650 dot: move into a submenu.
8651 <Up> - in filename/menu name completion: move up into
8652 parent directory or parent menu.
8653
8654 This makes the menus accessible from the console |console-menus|.
8655
8656 If you prefer the <Left> and <Right> keys to move the cursor instead
8657 of selecting a different match, use this: >
8658 :cnoremap <Left> <Space><BS><Left>
8659 :cnoremap <Right> <Space><BS><Right>
8660<
8661 The "WildMenu" highlighting is used for displaying the current match
8662 |hl-WildMenu|.
8663
8664 *'wildmode'* *'wim'*
8665'wildmode' 'wim' string (Vim default: "full")
8666 global
8667 {not in Vi}
8668 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008669 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008670 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008671 first part specifies the behavior for the first use of 'wildchar',
8672 The second part for the second use, etc.
8673 These are the possible values for each part:
8674 "" Complete only the first match.
8675 "full" Complete the next full match. After the last match,
8676 the original string is used and then the first match
8677 again.
8678 "longest" Complete till longest common string. If this doesn't
8679 result in a longer string, use the next part.
8680 "longest:full" Like "longest", but also start 'wildmenu' if it is
8681 enabled.
8682 "list" When more than one match, list all matches.
8683 "list:full" When more than one match, list all matches and
8684 complete first match.
8685 "list:longest" When more than one match, list all matches and
8686 complete till longest common string.
8687 When there is only a single match, it is fully completed in all cases.
8688
8689 Examples: >
8690 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008691< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008692 :set wildmode=longest,full
8693< Complete longest common string, then each full match >
8694 :set wildmode=list:full
8695< List all matches and complete each full match >
8696 :set wildmode=list,full
8697< List all matches without completing, then each full match >
8698 :set wildmode=longest,list
8699< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008700 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008701
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008702 *'wildoptions'* *'wop'*
8703'wildoptions' 'wop' string (default "")
8704 global
8705 {not in Vi}
8706 {not available when compiled without the |+wildignore|
8707 feature}
8708 A list of words that change how command line completion is done.
8709 Currently only one word is allowed:
8710 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008711 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008712 is displayed per line. Often used tag kinds are:
8713 d #define
8714 f function
8715 Also see |cmdline-completion|.
8716
Bram Moolenaar071d4272004-06-13 20:20:40 +00008717 *'winaltkeys'* *'wak'*
8718'winaltkeys' 'wak' string (default "menu")
8719 global
8720 {not in Vi}
8721 {only used in Win32, Motif, GTK and Photon GUI}
8722 Some GUI versions allow the access to menu entries by using the ALT
8723 key in combination with a character that appears underlined in the
8724 menu. This conflicts with the use of the ALT key for mappings and
8725 entering special characters. This option tells what to do:
8726 no Don't use ALT keys for menus. ALT key combinations can be
8727 mapped, but there is no automatic handling. This can then be
8728 done with the |:simalt| command.
8729 yes ALT key handling is done by the windowing system. ALT key
8730 combinations cannot be mapped.
8731 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008732 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008733 keys can be mapped.
8734 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8735 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008736 This option is not used for <F10>; on Win32 and with GTK <F10> will
8737 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008738
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008739 *'window'* *'wi'*
8740'window' 'wi' number (default screen height - 1)
8741 global
8742 Window height. Do not confuse this with the height of the Vim window,
8743 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008744 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8745 value is smaller than 'lines' minus one. The screen will scroll
8746 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008747 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8748 in a much smarter way, taking care of wrapping lines.
8749 When resizing the Vim window, the value is smaller than 1 or more than
8750 or equal to 'lines' it will be set to 'lines' minus 1.
8751 {Vi also uses the option to specify the number of displayed lines}
8752
Bram Moolenaar071d4272004-06-13 20:20:40 +00008753 *'winheight'* *'wh'* *E591*
8754'winheight' 'wh' number (default 1)
8755 global
8756 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008757 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008758 feature}
8759 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008760 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008761 focus goes to a window that is smaller, its size is increased, at the
8762 cost of the height of other windows.
8763 Set 'winheight' to a small number for normal editing.
8764 Set it to 999 to make the current window fill most of the screen.
8765 Other windows will be only 'winminheight' high. This has the drawback
8766 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8767 to create only two windows, set the option after startup is done,
8768 using the |VimEnter| event: >
8769 au VimEnter * set winheight=999
8770< Minimum value is 1.
8771 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008772 height of the current window.
8773 'winheight' applies to the current window. Use 'winminheight' to set
8774 the minimal height for other windows.
8775
8776 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8777'winfixheight' 'wfh' boolean (default off)
8778 local to window
8779 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008780 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008781 feature}
8782 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008783 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8784 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008785 The height may be changed anyway when running out of room.
8786
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008787 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8788'winfixwidth' 'wfw' boolean (default off)
8789 local to window
8790 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008791 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008792 feature}
8793 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008794 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008795 The width may be changed anyway when running out of room.
8796
Bram Moolenaar071d4272004-06-13 20:20:40 +00008797 *'winminheight'* *'wmh'*
8798'winminheight' 'wmh' number (default 1)
8799 global
8800 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008801 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008802 feature}
8803 The minimal height of a window, when it's not the current window.
8804 This is a hard minimum, windows will never become smaller.
8805 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8806 status bar) if necessary. They will return to at least one line when
8807 they become active (since the cursor has to have somewhere to go.)
8808 Use 'winheight' to set the minimal height of the current window.
8809 This option is only checked when making a window smaller. Don't use a
8810 large number, it will cause errors when opening more than a few
8811 windows. A value of 0 to 3 is reasonable.
8812
8813 *'winminwidth'* *'wmw'*
8814'winminwidth' 'wmw' number (default 1)
8815 global
8816 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008817 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008818 feature}
8819 The minimal width of a window, when it's not the current window.
8820 This is a hard minimum, windows will never become smaller.
8821 When set to zero, windows may be "squashed" to zero columns (i.e. just
8822 a vertical separator) if necessary. They will return to at least one
8823 line when they become active (since the cursor has to have somewhere
8824 to go.)
8825 Use 'winwidth' to set the minimal width of the current window.
8826 This option is only checked when making a window smaller. Don't use a
8827 large number, it will cause errors when opening more than a few
8828 windows. A value of 0 to 12 is reasonable.
8829
8830 *'winwidth'* *'wiw'* *E592*
8831'winwidth' 'wiw' number (default 20)
8832 global
8833 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008834 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008835 feature}
8836 Minimal number of columns for the current window. This is not a hard
8837 minimum, Vim will use fewer columns if there is not enough room. If
8838 the current window is smaller, its size is increased, at the cost of
8839 the width of other windows. Set it to 999 to make the current window
8840 always fill the screen. Set it to a small number for normal editing.
8841 The width is not adjusted after one of the commands to change the
8842 width of the current window.
8843 'winwidth' applies to the current window. Use 'winminwidth' to set
8844 the minimal width for other windows.
8845
8846 *'wrap'* *'nowrap'*
8847'wrap' boolean (default on)
8848 local to window
8849 {not in Vi}
8850 This option changes how text is displayed. It doesn't change the text
8851 in the buffer, see 'textwidth' for that.
8852 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008853 displaying continues on the next line. When off lines will not wrap
8854 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008855 moved to a part that is not shown, the screen will scroll
8856 horizontally.
8857 The line will be broken in the middle of a word if necessary. See
8858 'linebreak' to get the break at a word boundary.
8859 To make scrolling horizontally a bit more useful, try this: >
8860 :set sidescroll=5
8861 :set listchars+=precedes:<,extends:>
8862< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008863 This option can't be set from a |modeline| when the 'diff' option is
8864 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008865
8866 *'wrapmargin'* *'wm'*
8867'wrapmargin' 'wm' number (default 0)
8868 local to buffer
8869 Number of characters from the right window border where wrapping
8870 starts. When typing text beyond this limit, an <EOL> will be inserted
8871 and inserting continues on the next line.
8872 Options that add a margin, such as 'number' and 'foldcolumn', cause
8873 the text width to be further reduced. This is Vi compatible.
8874 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02008875 This option is set to 0 when 'paste' is set and restored when 'paste'
8876 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008877 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
8878 and less usefully}
8879
8880 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8881'wrapscan' 'ws' boolean (default on) *E384* *E385*
8882 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008883 Searches wrap around the end of the file. Also applies to |]s| and
8884 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008885
8886 *'write'* *'nowrite'*
8887'write' boolean (default on)
8888 global
8889 {not in Vi}
8890 Allows writing files. When not set, writing a file is not allowed.
8891 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008892 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008893 argument. Filtering text is still possible, even though this requires
8894 writing a temporary file.
8895
8896 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8897'writeany' 'wa' boolean (default off)
8898 global
8899 Allows writing to any file with no need for "!" override.
8900
8901 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8902'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8903 otherwise)
8904 global
8905 {not in Vi}
8906 Make a backup before overwriting a file. The backup is removed after
8907 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008908 also on.
8909 WARNING: Switching this option off means that when Vim fails to write
8910 your buffer correctly and then, for whatever reason, Vim exits, you
8911 lose both the original file and what you were writing. Only reset
8912 this option if your file system is almost full and it makes the write
8913 fail (and make sure not to exit Vim until the write was successful).
8914 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008915 When the 'backupskip' pattern matches, a backup is not made anyway.
8916 NOTE: This option is set to the default value when 'compatible' is
8917 set.
8918
8919 *'writedelay'* *'wd'*
8920'writedelay' 'wd' number (default 0)
8921 global
8922 {not in Vi}
Bram Moolenaar802a0d92016-06-26 16:17:58 +02008923 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008924 screen. When non-zero, characters are sent to the terminal one by
8925 one. For MS-DOS pcterm this does not work. For debugging purposes.
8926
8927 vim:tw=78:ts=8:ft=help:norl: